利用“信息”提升协作体验

了解如何利用“信息”中的“协作”功能帮助优化 App 的通信和协作。学习如何将文档绑定到“信息”的对话，实现轻松共享和讨论。探索如何让对话中的所有人都能掌握文档中的最新活动。另外，我们还将介绍如何在您的 App 中添加可自定的 UI，以管理协作详情并将文档关联到“信息”对话和 FaceTime 通话。要进一步了解 SharedWithYou 框架，我们建议您观看“在您的 App 中添加‘与您共享'功能”。如需有关为具有自定义协作基础结构的 App 添加协作 API 的更多信息，请观看“集成您的自定义协作 App 到‘信息'”。 (注：即将发布的 Beta 版将提供 API。)

资源

- 高清视频
- 标清视频

相关视频

WWDC22

WWDC21

CloudKit 中的新功能

下载

♪ 柔和乐器演奏的嘻哈音乐 ♪ ♪ Miranda Zhou：嗨我是 Miranda 我是“共享”团队的工程师 Elana Stettin：我是 Elana 我是一名 “信息”团队的工程师 Miranda：在这个视频中 Elana 和我将深入探讨如何在您的 App 中提升与“信息”的协作我将首先介绍这项功能您将学习如何为采用这一功能做准备以及如何将“信息”绑定到流程中以开始协作 Elana 将解释如何通过“信息”UI 为您的 App 添加协作最后她将探讨如何随时与协作更新保持同步首先让我来介绍一下与“信息”的协作！在 iOS 16 和 macOS Ventura 中我们新增了一种简单方法来改善协作者之间的沟通协作者能够借助“信息”的共享功能将文档结合到对话中协作活动会出现在“信息”对话和正在进行的 FaceTime 通话中可定制的“协作”弹出框也提供给您的 App 用于管理协作细节和连接到“信息”对话这建立在您已使用的技术之上例如共享表格和拖放接下来我将介绍我们支持的协作基础架构类型以及如何将其中的每一种与“信息”协作结合起来我们支持三种类型的协作基础架构： CloudKit、iCloud Drive 和其他任何您现在可能使用的协作基础架构！在这个视频中我将集中讲解使用 CloudKit 和 iCloud Drive 的案例如果您使用的是自定义基础架构请观看“将您的自定义协作 App 与‘信息’进行集成” 这一视频获取更多信息如果您使用基于 CloudKit 的协作我们提供了一个新 API 用于创建一个系统可识别的协作对象前提是 macOS Sierra API 用于启动或管理 NSSharingService 的共享一旦有了协作对象就请确定在 App 中显示 UI 的位置开启或管理共享您需要升级到新的 API 以增强与“信息”的协作因为我们将弃用现有的 AppKit API 新的协作对象 API 使用 NSItemProvider 系统服务使用 NSItemProvider 将您 App 的数据传输到系统上的其他进程提供者需要协作项目的 CKShare 或者需要准备处理器在协作开始时创建 CKShare 您 App 的 CKContainer 也是必需的最后请提供一个 CKAllowedSharingOptions 对象代表协作的访问和权限选项选项的值与 NSCloudKitSharingServiceOptions 相一致这是此前从 NSCloudSharingServiceDelegate 方法中请求的这是创建 CloudKit 协作对象过程的简要概述如果协作正在启动并且您传入了一个准备处理器您需要同时创建共享并将其保存到处理器的服务器中如果协作已经启动则只需传入关联的共享正在注册的 CKAllowedSharingOptions 实例使用静态标准属性它将返回默认的允许选项集 CloudKit 采用者可以使用它或为一组受限的允许选项创建自定义的类实例

如果您对采用 CloudKit 有兴趣的话 CloudKit 让您可以使用 iCloud 作为 App 的数据库而无需编写自己的服务器代码您还将获得内置的方法与其他 iCloud 用户共享部分数据如想了解更多信息请观看“CloudKit 的新功能”视频如果您使用的是 iCloud Drive 协作对象就是您的文件 URL 我们将尽全力来识别它！当这些完成后请确定您 App 中开启或管理协作的入口点并准备好用全新的改进后的版本进行替换如果是自定义协作基础架构协作对象名为 SWCollaborationMetadata 包装在新 NSItemProvider API 中请观看“将您的自定义协作 App 与‘信息’进行集成”视频了解更多关于如何使用此 API 更新协作 UI 的信息现在您已经万事俱备接下来开启协作有两种不同的方式：一是通过共享表的新协作模式二是拖放到“信息” 可以是从您的 App 也可以是从 iOS 上的“文件”App 或 macOS 上的访达新的共享表协作模式可以通过标题中的指示器来识别它也提供了进行协作和发送一份副本之间的选择要在共享表中进行协作请将之前准备的协作对象提供给共享表在 macOS 上这个协作指示器显示在美观的新共享弹出框中！共享弹出框还在标题中包含了名称和图像并加上了一行对话建议和我们已提供的所有传输工具如需了解有关此内容的更多信息请观看 WWDC 22 的 “AppKit 的新功能”视频在 iOS 和 Mac Catalyst 上请使用 UIActivityViewController 类来显示共享表在 macOS 上要显示共享弹出框请使用 NSSharingServicePicker 请将协作对象作为操作项目传递给 UIActivityViewController 在启用协作时对它进行展示同样地请将 NSSharingServicePicker 与协作对象一同初始化在启用协作时展示它 CloudKit 采用者需要额外的步骤来为标题提供名称和图像在 iOS 上可以使用现有的 API 例如 UIActivityItemsConfiguration 或者 UIActivityItemSource 来提供带有名称和 imageProvider 的 LPLinkMetadata 对象请使用您的协作对象创建配置然后设置元数据提供程序返回共享中项目的 LPLinkMetadata 对象最后对 UIActivityViewController 进行使用该配置的初始化操作在 macOS 上我们有一个新 API 名为 NSPreviewRepresentingActivityItem 用于提供标题元数据请参阅 NSPreviewRepresentingActivityItem 文件了解更多信息要使用 NSPreviewRepresentingActivityItem 请首先选择名称图像和图标图像代表共享中的项目而图标代表共享中项目的来源比如说一个 App 的图标使用您的协作对象名称图像和图标创建一个 NSPreviewRepresentingActivityItem 并用该预览项对 NSSharingServicePicker 进行初始化令人兴奋的消息是新的共享表 SwiftUI ShareLink API 也将支持协作模式！如需采用您共享的项目必须由 Transferable 进行表述它是用于共享和数据传输的新协议 CloudKit 采用者提供共享容器和通过由 Transferable 项返回的 CKShareTransferRepresentation 产出的选项如需了解详情请观看 “认识 Transferable”视频以及 WWDC 22 的 “SwiftUI 的新功能”视频这个例子将呈现 CloudKit 采用者比如“备忘录”是如何创建与 ShareLink 共享的可转移对象的 note 提供了 CKShareTransferRepresentation 它既可以被构造为具有现有的 CKShare CKContainer 和 CKAllowedSharingOptions 值的现有值或者构造为一个 prepareShare 值它具有 CKContainer CKAllowedSharingOptions 值以及用于协作对象创建和保存 CKShare 的准备处理器对于 iCloud Drive 采用者您的文件 URL 是您通过 ShareLink 共享的 Transferable 对象如果您使用自定义协作基础架构请观看“将您的自定义协作 App 与‘信息’进行集成”视频了解如何从可转移对象返回 SWCollaborationMetadata 对象一旦有了 Transferable 对象请将其作为分享项目传递给 ShareLink 初始化程序同时传入带有名称和图像的预览用于填写共享表标题共享表协作模式标题的一个值得注意的功能是访问和权限选项摘要轻点此摘要将打开一个视图协作者可以在这里对协作时使用的访问和权限选项进行选择对于 CloudKit 采用者来说这个视图显示的是在协作对象中注册的选项集 iCloud Drive 采用者则显示 iCloud Drive 标准选项集如果您使用自定义基础架构请观看“将您的自定义协作 App 与‘信息’进行集成”视频了解如何指定自定义选项并让它们出现在这个视图中另一种开启协作的方式是通过拖放来完成的协作者可以简单地将文档拖入“信息”中并在“信息”中获得新的可用于协作的富链接这个富链接提供的功能既可以用于协作和发送副本又可以用于选择协作选项如需采用请通过 iOS 16 和 macOS Ventura 上的 ShareLink 提供协作对象这就是您应当如何准备和开启使用“信息”的协作接下来我把时间交给 Elana 她将介绍如何让您的 App 协作体验达到新的高度 Elana：谢谢 Miranda！现在您已经知道该如何入手了我将谈谈如何进一步将我们的协作 UI 整合到您的 App 中我们添加了一些新功能来增强协作体验协作按钮位于您 App 的导航栏中并会显示关联的信息组的小组头像按钮右侧还有活跃参与者计数会在其他人加入文档时进行展示轻点协作按钮时新的协作弹出框就会出现可定制的弹出框展示了协作的概述它还允许用户发起与其他与其他参与者的通讯只需轻轻一点这使他们能够通过 “信息”和 FaceTime 通话进行实时协同工作

这些 UI 元素的支持都由一个类在 SharedWithYou 框架中提供： SWCollaborationView 它代表导航栏中的按钮视图您需要做的就是初始化 SWCollaborationView 我们会为您完成弹出窗口布局和展示要显示自定义内容您需要提供一个将被添加到弹出框的视图现在我将介绍创建 SWCollaborationView 的代码请在初始化 SWCollaborationView 时使用 itemProvider itemProvider 包含基于 CloudKit 的 App 所用的 CKShare 基于 iCloud Drive 的 App 所用的 fileURL 以及用于自定义协作基础架构的 SW 协作元数据

设置 activeParticipantCount 属性在 collaborationView 中来显示文档中的活跃参与者人数然后设置 contentView 属性在 collaborationView 中来提供带有自定义内容的弹出框 ContentView 是使弹出框完全可自定义的原因您可以在这里添加自己的内容为用户提供协作进程中的独特视图例如在 Pages 文稿中 ContentView 包含 “当前参与者”列表和“参与者光标”切换按钮现在让我们来看看“管理”按钮对于 CloudKit 和 iCloud Drive 采用者管理按钮将调出管理 UI 您可以在其中添加和删除参与者或更改共享设置稍后我会详细讨论这个问题如需自定义提供的按钮名称可以在 collaborationView 中设置 manageButtonTitle 属性如果您不设置此属性名称将默认为“管理共享” 如果您的 App 使用自定义协作基础架构请在 contentView 中包含您自己的管理按钮您将不会得到提供的按钮在 Mac 上请确保按钮背景透明以遵循 Apple 设计建议最后在 iOS 上创建 UIBarButtonItem 如此处所示使用 collaborationView 作为自定义视图在 Mac 上请使用 UIBarButtonItem 来初始化 NSToolbarItem 然后添加按钮栏项或工具栏项到 ViewController 的 navigationItem 正如我之前提到的 CloudKit 和 iCloud Drive 采用者会在协作弹出框中得到一个按钮这让您能以和过往相同的方式来对共享进行管理提供的管理 UI 变化是可观察的可以通过遵守已经用于观察变化的相同的委托协议来做到它们是： UICloudSharingControllerDelegate 和 NSCloudSharingServiceDelegate 现在您已经了解如何将新的协作 UI 集成到您的 App 中接下来我将介绍如何观察和处理协作的更新了解共享何时开始和停止至关重要我们为 CloudKit 采用者添加了名为 CKSystemSharing UIObserver 的新协议专门用于通知共享开始和停止使用此协议您可以获取与 CKShare 被保存或删除的时间相对应的回调而无需使用 CloudKit Sharing UI 我现在就带您浏览一些代码请使用 CKContainer 初始化观察器在观察器上请定义 CKShare 被保存时需要执行的闭包并将它分配到 systemSharingUI DidSaveShareBlock 在闭包中如果共享被正确保存您将收到“成功”结果表示共享已开始您还将得到供一起使用的关联 CKShare 如果保存不成功您将收到“失败”结果和相关错误说明这是文档所有者停止共享时闭包的实现在“成功”的情况下 CKShare 已被成功删除在“失败”的情况下您也会收到相关的错误说明开始和停止共享可能并不是您关心的唯一变化有些变化您甚至会想向用户传达我们添加让您可以发布通知总结协作更新的 API 通知就位于相关“信息”线程的顶部它为协作者展示了更新内容以及改变的发起者如需发布通知请检索 SWCollaborationHighlight 这是 SharedwithYou 中一个协作指定的亮点类型请使用它来创建一个 SWCollaborationHighlight 事件如想了解有关 SWHighlights 和 SharedWithYou API 的更多信息请观看“在您的 App 中添加 SharedwithYou”视频请在开始进行通知的采纳之前观看此视频我将以一个 CloudKit App 为例来介绍不同通知的发布如果您的 App 使用自定义协作基础架构请观看“将您的自定义协作 App 与‘信息’进行集成”视频获取详细说明为了表述通知我们引入了一个名为 SWHighlightEvent 的协议亮点事件的初始化是由从 SWHighlightCenter API 检索的 SWHighlights 进行的支持的事件类型包括更改事件用于内容更新或评论提及事件用于在协作中提及用户持续事件用于内容被移动重命名或删除时还有成员事件用于在文档中添加或删除参与者时这个例子展示了如何在协作被编辑时发布更改事件借助 highlightCenter API 使用 CKShare URL 检索协作亮点请记住这个 CKShare 是您在协作初始化时定义的因此您的 App 应该使它在进行内容更改时可用接下来创建 HighlightChangeEvent 实例初始化程序需要一个亮点和一个触发器枚举值在这种情况下我们将触发器类型设置为编辑最后发布该事件的通知到 highlightCenter 其他事件都遵循类似的格式唯一的例外是提及事件因为它需要更多信息来指示是哪个用户受到了提及发布此类事件的前提是您的 App 支持用户提及通过传入检索到的亮点和提及的 CKShare 参与者的句柄来创建 mentionEvent 此通知将仅显示给受到提及的用户持续事件类型用于内容发生移动重命名或删除时在这里使用了重命名的触发器类型来表明文档名称已更改最后来看一个成员事件对于 membershipEvent 则需要使用 addedCollaborator 或 removedCollaborator 触发器类型使用 mentionevents 就可以发布通知显示文档的协作成员发生了怎样的变更不过我们也保留了让协作者在您的共享文档上同步了解 “信息”群组成员变更的可能性对于 CloudKit 和 iCloud Drive 来说非常简单我们将替您完成这些工作添加新成员到存在协作的 “信息”群组时文档所有者从通知得到提示可以将其添加到共享中当成员被移除时也是这样

对于使用自定义协作基础架构的 App 来说还需要多做一些工作您将需要采用 SWCollaborationActionHandler API 您可以在“将您的自定义协作 App 与‘信息’进行集成”视频中了解更多信息

您已经了解如何在“信息”中开启协作并将其集成到您的 App 中无论是使用 CloudKit iCloud Drive 还是您自己的协作基础设施通过采用新的共享表和拖放 API 来为您的 App 开启协作做好准备集成新的协作 UI 来为共享文档中的事件提供定制化的概览将它设置好之后再向前一步采用通知来显示 “信息”线程内对协作进行的更改 Miranda 和我都等不及想看看您的 App 如何使用 “信息”中的这些新协作功能了！两位：感谢收看！ ♪

4:08 - Create a CloudKit collaboration item provider

// CloudKit collaboration object

// Starting collaboration
let itemProvider = NSItemProvider()
itemProvider.registerCKShare(container: container, 
                             allowedSharingOptions: CKAllowedSharingOptions.standard, 
                             preparationHandler: {
    // Create your share and save to server, or throw error
    return savedShare
})

// Inviting to existing collaboration
let itemProvider = NSItemProvider()
itemProvider.registerCKShare(share, 
                             container: container, 
                             allowedSharingOptions: CKAllowedSharingOptions.standard)

7:35 - Set up Share Sheet on iOS and Mac Catalyst

// Setting up Share Sheet - iOS and Mac Catalyst

let activityViewController = UIActivityViewController(activityItems: [collaborationObject], applicationActivities: nil)

presentingViewController.present(activityViewController, animated: true)

7:47 - Set up Share Popover on macOS

// Setting up Share Popover - macOS

let sharingServicePicker = NSSharingServicePicker(items: [collaborationObject])

sharingServicePicker.show(relativeTo: view.bounds, of: view, preferredEdge: .minY)

8:22 - Provide metadata for CloudKit collaboration in Share Sheet (iOS, Mac Catalyst)

// Providing CloudKit metadata - iOS

let configuration = UIActivityItemsConfiguration(itemProviders: [collaborationItemProvider])
configuration.perItemMetadataProvider = { (_, key) in
    switch key {
    case .linkPresentationMetadata:
        // Create LPLinkMetadata with title and imageProvider
        return metadata
    default:
        return nil
    }
}

let activityViewController = UIActivityViewController(activityItemsConfiguration: configuration)

9:03 - Provide metadata for CloudKit collaboration in Share Popover (macOS)

// Providing CloudKit metadata - macOS

let title = “Shared Item”
let image = NSImage(contentsOfFile: “Shared_Item_Preview_Image.png”)
let icon = NSImage(contentsOfFile: “App_Icon.png”) // Shared item source

let previewRepresentingItem = NSPreviewRepresentingActivityItem(item: collaborationItemProvider, 
                                                                title: title, 
                                                                image: image, 
                                                                icon: icon)

let picker = NSSharingServicePicker(items: [previewRepresentingItem])

10:21 - Create Transferable object for CloudKit collaboration with ShareLink

// SwiftUI CloudKit Transferable

struct Note: Transferable {
    // Properties of the note e.g. name, preview image, content, ID, …
    var share: CKShare?
    func saveCKShareToServer() async throws -> CKShare { … }

    static var transferRepresentation: some TransferRepresentation {
        CKShareTransferRepresentation { note in
            if let share = note.share {
                return .existing(share, container: container, options: options)
            } else {
                return .prepareShare(container: container, options: options) {
                    return try await note.saveCKShareToServer()
                }
            }
        }
    }
}

11:34 - Adopt ShareLink in SwiftUI

// SwiftUI ShareLink adoption

struct ContentView: View {
    @State let item = ShareItem()

    var body: some View {
        ShareLink(item: item, preview: SharePreview(item.title, image: item.previewImage))
    }
}

14:58 - Initialize the collaborationView

// Collaboration View

let collaborationView = SWCollaborationView(itemProvider: itemProvider)

collaborationView.activeParticipantCount = myModel.activePeople.count

collaborationView.contentView = MyView(model: myModel)

collaborationView.manageButtonTitle = "Custom Manage Button"

18:11 - Observe when CKShare is saved with CKSystemSharingUIObserver

// Observing CKShare Changes

let observer = CKSystemSharingUIObserver(container: container)

observer.systemSharingUIDidSaveShareBlock = { _, result in
    switch result {
    case .success(let share):
        // Handle successfully starting share
    case .failure(let error):
        // Handle error
    }
}

18:47 - Observe when CKShare is removed with CKSystemSharingUIObserver

// Observing CKShare Changes

observer.systemSharingUIDidStopSharingBlock = { _, result in
    switch result {
    case .success(let share):
        // Handle successfully starting share
    case .failure(let error):
        // Handle error
    }
}

20:44 - Posting notice for edit SWHighlightChangeEvent

// Post an SWHighlightChangeEvent Notice

let highlightCenter: SWHighlightCenter = self.highlightCenter

let highlight = try highlightCenter.collaborationHighlight(forURL: ckShareURL, error: &error)

let editEvent = SWHighlightChangeEvent(highlight: highlight, trigger: .edit)

highlightCenter.postNotice(for: editEvent)

21:30 - Post an SWHighlightMentionEvent Notice

// Post an SWHighlightMentionEvent Notice

let highlightCenter: SWHighlightCenter = self.highlightCenter

let highlight = try highlightCenter.collaborationHighlight(forURL: ckShareURL, error: &error)

let mentionEvent = SWHighlightMentionEvent(highlight: highlight, 
           mentionedPersonCloudKitShareHandle: ckShareParticipantHandle)

highlightCenter.postNotice(for: mentionEvent)

21:58 - Post an SWHighlightPersistenceEvent Notice

// Post an SWHighlightPersistenceEvent Notice

let highlightCenter: SWHighlightCenter = self.highlightCenter

let highlight = try highlightCenter.collaborationHighlight(forURL: ckShareURL, error: &error)

let renamedEvent = SWHighlightPersistenceEvent(highlight: highlight, trigger: .renamed)

highlightCenter.postNotice(for: renamedEvent)

22:11 - Post an SWHighlightMembershipEvent Notice

// Post an SWHighlightMembershipEvent Notice

let highlightCenter: SWHighlightCenter = self.highlightCenter

let highlight = try highlightCenter.collaborationHighlight(forURL: ckShareURL, error: &error)

let membershipEvent = SWHighlightMembershipEvent(highlight: highlight, 
                                           trigger: .addedCollaborator)

highlightCenter.postNotice(for: membershipEvent)

正在查找特定内容？在上方输入一个主题，就能直接跳转到相应的精彩内容。