CloudKit共有の最大限の活用

CloudKit共有の最大限の活用

AppでCloudKitを使ってユーザー間でレコードを共有する方法を確認します。Appを使ったユーザー間のコラボレーションを促進する方法や、Appleのフレームワークを使って共同作業をサポートする方法を確認します。共有を作成して管理する方法、パブリックアクセスの権限といった共有オプション、iOS 15やmacOS Montereyでゾーン共有を使ってデータのレコードゾーン全体を共有する方法を紹介します。このセッションを十分理解できるよう、事前にCloudKitおよびレコードとデータのタイプの基礎的な情報を確認しておくことをお勧めします。

リソース
- CloudKit Samples: Sharing
- - HDビデオ
  - SDビデオ
関連ビデオ

WWDC23
- CKSyncEngineでiCloudに同期
WWDC21
- CloudKitとCore Dataでデータを共有するAppの構築
- CloudKitの新機能
ダウンロード

Simon Manningです CloudKitチームでエンジニアをしていますこれから CloudKitを使って Appのユーザー間のデータ共有をサポートする方法について紹介しますまず GitHubで公開されているサンプルのSharing Appを紹介します次に Appで共有を作成したりその共有に他のユーザーを招待したりできるようにする方法を説明しますまた Appで参加ユーザーの代わりに共有したり招待を受けたりする方法共有レコードを取得する方法カスタマイズされた共有体験を Appで提供する方法そして最後にCloudKitで利用できるゾーンベースの共有モデルについて説明しますまずはサンプルのSharing Appです CloudKitは AppがiCloud上のデータベースにアクセスするためのフレームワークですこれは複数のCKDatabaseが格納された CKContainerにアクセスできる APIです各コンテナにはすべてのユーザーがレコードを読み書きできるパブリックデータベースが 1つ存在しますデバイスがiCloudアカウントにログインしている場合 Appはそのユーザーのデータが含まれるプライベートデータベースにもアクセスできますまた Appが共有をサポートしている場合現在のiCloudユーザーと共有されているデータは共有CKDatabaseで Appも利用することができますここではレコードの所有者であるユーザーが共有を開始する方法と参加者として共有への招待を受ける方法の両方を説明するために AppleのGitHubアカウントで公開されているサンプルAppを参考にします連絡先Appは共有の最小限の例です連絡先Appではユーザーのプライベートデータベースに新しい連絡先レコードを作成すること個々の連絡先を他のユーザーの Appと共有すること他のユーザーから現在のユーザーに共有されたすべての連絡先を表示することがサポートされています Sharingリポジトリには Swiftの並行処理を使った実装と完了ハンドラを使った実装がありそれぞれ別個のブランチで提供されています共有を開始するにはまず新しい連絡先レコードを作成し所有者のプライベートデータベースに保存します addContact関数は Sharingの Add New Contact UIから呼び出されますこれにより recordTypeが ContactであるCKRecordが新規作成され名前と電話番号が保存されますその後そのレコードはプライベートデータベースに保存されます他のユーザーのSharing Appと連絡先レコードを共有するにはまず共有を作成します CloudKitでの共有は CKShareと呼ばれる特別な種類のレコードに依存していますユーザーがレコードを他の人と共有する場合はユーザーに代わってCKShareを作成しそれをプライベートデータベースに保存しますこのユーザーは共有するすべてのレコードを所有しているため共有レコード自体の所有者でもありますこの共有レコードは共有されるデータ共有している相手共有参加者に与えられているアクセス権を定義する信頼できる情報源となります共有アクセス権とは共有の所有者が共有レコードへのアクセスをコントロールする方法です publicPermissionプロパティはその共有へのリンクを持つユーザーのアクセス権レベルを定義しますデフォルトでは URLだけを持つユーザーはアクセスできませんこのプロパティのアクセス権の範囲を拡大すると共有のURLを持つすべてのユーザーが参加できるようになりますまた招待された各参加者のアクセス権レベルは共有の所有者によって決定されます参加者オブジェクトはユーザーの識別情報や招待の受け入れ状況などを含む特定のユーザーの共有への参加を定義したものですアクセス権は参加者オブジェクトごとに個別に設定され各参加者はCKShareの参加者配列に追加されますユーザーのプライベートデータベースからレコードの共有を開始するにはまず共有のルートレコードを決定しますこの共有にはルートレコードとその子レコードがすべて含まれますその後 CKShareレコードを作成しルートレコードとCKShareの両方を現在のユーザーのプライベートデータベースに保存します Sharing Appでは createShare関数により共有する連絡先レコードで CKShareが初期化されます CKShareとルートレコードが所有者のプライベートデータベースに保存され CKShareは招待プロセスを開始するUIに戻されます CKShareとルートレコードの両方を同じ操作で一緒に保存する必要があります CKShareだけを保存すると CloudKitにルートレコードがすでに存在していてもエラーになりますルートレコードを共有するとその子レコードも共有されますここまでで Appで共有を作成する方法を説明しましたこれから共有に参加するためのユーザー招待の設定および送信方法について説明しますサンプルAppではUICloudSharing ControllerというUIKitが提供するビューコントローラを使用していますこのコントローラをAppに実装することでユーザーは簡単にCKShareに参加者を招待したりアクセス権を設定したり参加者を閲覧および管理したりレコードの共有を中止したりすることができますこれは新しい連絡先レコードを共有する際に UICloudSharing ControllerがサンプルのSharing Appに表示される様子ですユーザーは共有招待の送信方法を選択できアクセス権は「Share Options」セクションで設定できますコントローラのデリゲートプロトコルを実装して共有に関する追加情報を提供したり共有イベントやエラーに関する通知を受け取ったりできますここで紹介した方法以外にも共有招待に表示するアイテムタイトルアイテムタイプサムネイル画像を設定する方法があります共有の所有者が招待を送信したら Appは招待された参加者に代わってその共有を処理し受け入れる必要があります AppのInfo.plistで CKSharingSupportedブール値を有効にしますこれにより Appが共有をサポートしていることをシステムに知らせますそして招待URLを処理して関連するデリゲート関数を呼び出す必要があります共有招待が開かれ受け入れられると Appはデリゲートメソッドのコールバックを通じて CKShare.Metadataオブジェクトを受け取ります Appはこのメタデータを使用して現在のユーザーがこの共有を受け入れて参加していることをコンテナのaccept関数または CKAcceptSharesOperation を通じて CloudKitに通知します applicationDelegateのライフサイクルではシステムがAppを起動し userDidAccept CloudKitShareWith: shareMetadataのデリゲートメソッドを呼び出します shareMetadataオブジェクトで提供された識別子を使って CKContainerオブジェクトを初期化します次に CKContainerで acceptを呼び出し shareMetadataオブジェクトを渡して現在のユーザーが共有を受け入れたことを CloudKitに知らせますここまででプライベートレコードを共有するための招待の送信とその招待の処理と受け入れについて説明しました次にユーザーが参加している共有レコードを Appで取得および変更する方法を説明します現在のiCloudユーザーと共有されているレコードは Appコンテナの sharedCloudDatabase内で利用できます共有データベースでは同じCloudKit APIを使用してプライベートデータベースやパブリックデータベース内のデータの取得クエリ実行操作をすることができますサンプルAppでは共有レコードは fetchSharedContacts関数で取得されています recordZoneChanges操作を使用して変更が徐々に取得および処理されますこの操作が完了するたびに取得すべき変更点がまだあるかどうかを表す moreComingブール値のプロパティが返されますまたゾーンの履歴における特定の変更を指す changeTokenも返されますこのchangeTokenを使うとその時点以降に発生した変更のみを取得することができます最初に取得する場合やゾーンの履歴にあるすべての変更を再取得する場合は changeTokenをnilに設定しますアクティブな共有の管理は現在のユーザーによって異なります共有の所有者の場合は所有者のプライベートデータベースから CKShareレコードを削除することで共有を中止することができます所有者は共有ルートレコードを完全に削除することもできます CKShareレコードオブジェクトの removeParticipant関数では参加者を個々に削除することができますこれはParticipantプロパティで確認できますそして最後に UICloudSharing Controller UIでは所有者がすべての参加者との共有を中止することができます共有に参加しているユーザーの場合ユーザーの共有データベースからルートCKRecordを削除するか UICloudSharing Controller UIを使用することで参加を中止することができますなおユーザーの共有データベースからルートCKRecordを削除しても参加者の共有への参加が中止されるだけで元のルートレコードは所有者のプライベートデータベースにそのまま残りますサンプルのSharing Appでは UICloudSharing Controllerを使用して参加者の検索と招待を処理していますがこの機能をCloudKit APIで実装することにより共有の所有者と参加者のユーザー体験をカスタマイズすることもできますまず CKShareに招待する参加者を検索するには該当するCKContainerの CKFetchShare ParticipantsOperationや shareParticipants関数を使いますパラメータとして電話番号 EメールユーザーレコードIDを使用できます次にこの参加者に特定のアクセス権レベルを設定し addParticipant関数を使用して参加者をCKShareに追加します変更したCKShareは必ずプライベートデータベースに戻して保存してください保存されたCKShareレコードには urlプロパティがありますこのプロパティを招待する参加者に送信しその参加者が処理および受け入れを行います招待URLを使用して共有の CKShare.Metadataを取得し Appのコンテナの accept(shareMetadata) 関数で参加を確認できます Sharing Appにおける CloudKitの共有ではルートレコードとして 1つのレコードが共有されその子レコードも共有されるという階層型の共有モデルが使用されていますゾーン共有は iOS 15で導入された新しいモデルでレコードのゾーン全体を共有することができますゾーンを共有する場合 1つのレコードの階層だけでなくゾーン内のすべてのレコードが共有されますゾーン共有はレコードゾーン内のすべてのレコードに影響を与えるためこのタイプの共有を同じレコードゾーン内の階層型共有と共存させることはできませんつまり 1つのゾーン内に 1つ以上の階層型共有を設置するか 1つのゾーン全体を共有するかのどちらかですゾーン共有と階層型共有にはそれぞれメリットがありユースケースに応じて使い分ける必要がありますサンプルのSharing Appの場合連絡先のグループが別々のレコードゾーンで構成されていればゾーン共有が便利ですゾーン共有を使えばそれらの連絡先グループを他のユーザーと共有することができますゾーン共有について詳しくは WWDC21の「CloudKitの新機能」をご覧くださいゾーン全体の共有を新しく作成するには共有するカスタムレコードゾーンのIDで初期化しプライベートデータベースに保存します共有の招待を受け入れて共有データベースからレコードを取得するプロセスは以前と同じですある共有がゾーン全体の共有であるかどうかはそのrecordIDの recordNameプロパティを確認します値がCKRecordNameZone WideShareの場合は共有レコードゾーンが管理されていますそうでない場合は共有レコード階層が管理されていることになりますこのセッションでは Appで共有をサポートする方法を説明しました CKShareレコードを作成してユーザー同士のコラボレーションをサポートしましょう UICloudSharing Controllerを使用して共有UIを作成したりニーズに合わせて実装をカスタマイズしたりできます従来のFetch APIや Modify APIを使用して共有クラウドデータベースから共有レコードにアクセスできますそしてゾーン共有を導入することでメリットが得られる Appの共有の新しいユースケースを探ってみましょうご視聴ありがとうございました

// Create a new Contact record

func addContact(name: String, phoneNumber: String) async throws {
    let id = CKRecord.ID(zoneID: recordZone.zoneID)
    let contactRecord = CKRecord(recordType: "Contact", recordID: id)
    contactRecord["name"] = name
    contactRecord["phoneNumber"] = phoneNumber
    try await privateCloudDatabase.save(contactRecord)
}

4:09 - Preparing a CKShare

// Preparing a CKShare

func createShare(contactRecord: CKRecord) async throws -> CKShare {
    let share = CKShare(rootRecord: contactRecord)
    
    try await privateCloudDatabase.modifyRecords(
        saving: [contactRecord, share], 
        deleting: []
    )

    return share
}

5:25 - UICloudSharingControllerDelegate

// UICloudSharingControllerDelegate

public protocol UICloudSharingControllerDelegate {

    // ...

    // Called after the CloudKit sharing controller failed to save the share record.
    func cloudSharingController(UICloudSharingController, failedToSaveShareWithError: Error)

    // Called after the CloudKit sharing controller saves the share record.
    func cloudSharingControllerDidSaveShare(UICloudSharingController)

    // Called after the user decided to stop sharing the record.
    func cloudSharingControllerDidStopSharing(UICloudSharingController)

}

6:27 - Processing an accepted share invitation

// Processing a user’s acceptance of a share invitation

func application(
    _ application: UIApplication,
    userDidAcceptCloudKitShareWith shareMetadata: CKShare.Metadata
) {
    let container = CKContainer(identifier: shareMetadata.containerIdentifier)

    Task {
        do {
            try await container.accept(shareMetadata)
        } catch {
            // Handle errors that may occur
        }
    }
}

7:24 - Fetching shared records

// Fetching records shared with the current iCloud user

func fetchSharedContacts(in zone: CKRecordZone) async throws {
    var changeToken: CKServerChangeToken? = nil
    var moreChangesComing = true
    
    while moreChangesComing {
        let changes = try await sharedCloudDatabase.recordZoneChanges(
            inZoneWith: zone.zoneID, 
            since: changeToken
        )

        // Process changes as needed (modifications and deletions)
        processChanges(changes)
          
        moreChangesComing = changes.moreComing
        changeToken = changes.changeToken
    }
}

9:16 - Search: Phone Number

// Search by phone number

let phoneNumber = "417-555-9311"
let participant = try await container.shareParticipant(forPhoneNumber: phoneNumber)

9:16 - Search: Email Address

// Search by email address

let emailAddress = "dave_knox@icloud.com"
let participant = try await container.shareParticipant(forEmailAddress: emailAddress)

9:16 - Search: Record ID

// Search by user record ID

let participant = try await container.shareParticipant(forUserRecordID: recordID)

9:32 - Add participant to a share

// Add participant to existing CKShare record

func addParticipant(_ participant: CKShare.Participant, to share: CKShare) async throws {
    participant.permission = .readWrite
    share.addParticipant(participant)
    try await privateCloudDatabase.save(share)
}

9:47 - Confirm invitation acceptance

// Fetch CKShare.Metadata and confirm accepting share from a given URL

func confirmShareParticipation(from url: URL) async throws {
    let shareMetadata = try await container.shareMetadata(for: url)
    try await container.accept(shareMetadata)
}

11:14 - Share an entire record zone

// Create a CKShare sharing an entire record zone

func createAndSaveShare(for zone: CKRecordZone) async throws -> CKShare {
    let share = CKShare(recordZoneID: zone.zoneID)
    try await privateCloudDatabase.save(share)

    if share.recordID.recordName == CKRecordNameZoneWideShare {
        // This is managing a shared record zone
    }

    return share
}

特定のトピックをお探しの場合は、上にトピックを入力すると、関連するトピックにすばやく移動できます。

クエリの送信中にエラーが発生しました。インターネット接続を確認して、もう一度お試しください。

リソース

関連ビデオ

WWDC23

WWDC21