what’s new in cloudkit€¦ · cloudkit js and web services wwdc 2015 what's new in cloudkit...

© 2016 Apple Inc. All rights reserved. Redistribution or public display not permitted without written permission from Apple.

There's a lot we want to share

App Frameworks #WWDC16

Session 226

What’s New in CloudKit

Paul Seligman CloudKit EngineerJacob Farkas CloudKit EngineerVanessa Hong CloudKit Engineer

What are we talking about?Table of Contents


CloudKit Overview


CloudKit OverviewTelemetry


CloudKit OverviewTelemetryAPI Improvements


CloudKit OverviewTelemetryAPI ImprovementsSharing

What is CloudKit?CloudKit Overview

Data everywhere!CloudKit Overview


iCloud Database


iCloud DatabaseExtensive use inside Apple


iCloud DatabaseExtensive use inside AppleUbiquitous

Prior talksCloudKit Overview

Introducing CloudKit WWDC 2014


Advanced CloudKit WWDC 2014

CloudKit JS and Web Services WWDC 2015

What's New in CloudKit WWDC 2015

CloudKit Tips and Tricks WWDC 2015



Advanced CloudKit WWDC 2014

CloudKit JS and Web Services WWDC 2015

What's New in CloudKit WWDC 2015

CloudKit Tips and Tricks WWDC 2015

https://developer.apple.com/cloudkit


Core objectsCloudKit Overview

ContainerDatabaseRecordRecord Zone

CloudKit Overview


CloudKit Container

Core objects

CloudKit Overview


CloudKit Container

Public Database Private Database

Core objects

CloudKit Overview

CloudKit Container

Public Database Private Database Shared Database

NEW


Core objects



Key ValueTitle String

Body String

CreationDate Date

Folder Reference

Note

Core objects

Record Zone

CloudKit Overview


Database

Core objects

Record Zone

CloudKit Overview


Database

Record


RecordRecord

Database

CloudKit Overview

RecordRecordRecordRecordRecordRecordRecordRecord

Record Zone

RecordRecord

Core objects

Core objects

Database

CloudKit Overview

Default Zone Custom Zone


RecordRecord

RecordRecord

Record Record

Record Record

RecordRecordRecordRecord


Core objects

Private Database

CloudKit Overview

Public Database Shared Database

Default Zone Default Zone

Custom Zone

Custom Zone

Shared Zone

Shared Zone


ContainerDatabaseRecordRecord ZoneShare

NEW

Core objects

Private Database

CloudKit Overview

ContainerDatabaseRecordRecord ZoneShare

NEW

Database

Custom Zone

RecordRecordRecord

RecordRecord

Record

RecordRecord

RecordRecord

Share

Share

Apple usage

CloudKit Container

CloudKit Overview

Public Database Shared DatabasePrivate Database

CloudKit Is Now Available Everywhere

CloudKit Is Now Available Everywhere

CloudKit JS Web Services

CloudKit Is Now Available Everywhere NEW

CloudKit JS Web Services

macOS

No Mac App Store requirement

macOS

No Mac App Store requirement• Add iCloud Capabilities via your provisioning profile

Web

Server to server

Web

Server to server• Acts as admin user

Web

Server to server• Acts as admin user• Uses public/private key pair registered on CloudKit Dashboard

Web

Server to server• Acts as admin user• Uses public/private key pair registered on CloudKit Dashboard• Access to public database

watchOS 3

watchOS 3

Alternative to watch connectivity code

watchOS 3

Alternative to watch connectivity codeStandalone functionality

watchOS 3

Alternative to watch connectivity codeStandalone functionality• Can work without phone present (via wifi)

watchOS 3


Full* CloudKit API

*offer does not include CKSubscription

watchOS 3


Full* CloudKit APISimilar code on all Apple platforms


watchOS 3


Full* CloudKit APISimilar code on all Apple platformsLimited resources


Visualize your app's behavior on the CloudKit DashboardTelemetry

Visualize your app's behavior on the CloudKit DashboardTelemetry

NEW

Visualize your app's behaviorTelemetry

CloudKit Dashboard


CloudKit DashboardPublic DB


CloudKit DashboardPublic DBAggregated Private DBs


CloudKit DashboardPublic DBAggregated Private DBsHour/day/week/month


CloudKit DashboardPublic DBAggregated Private DBsHour/day/week/monthPer Operation type/all Operations

Telemetry

Performance

Correctness

Correctness

Detect client changes with abnormally frequent errors

Correctness

Detect client changes with abnormally frequent errorsError handling is essential

API Improvements

API Improvements

NEW

API Improvements

Long Lived OperationsCKOperation TimeoutsHandling Many Record Zones Fetching Multiple Change Sets

API Improvements

Long Lived OperationsCKOperation TimeoutsHandling Many Record ZonesFetching Multiple Change Sets

Don’t repeat your workLong-Lived Operations


Operations keep running if your application exits


Operations keep running if your application exitsCallbacks saved by CloudKit


Operations keep running if your application exitsCallbacks saved by CloudKitOperation can be replayed later

API Improvements


How long do you want to wait?CKOperation Timeouts

QualityOfService Behavior on broken network

userInteractive

userInitiated

utility

background

default



userInteractive timeout after 60 seconds

userInitiated timeout after 60 seconds

utility

background

default



userInteractive timeout after 60 seconds

userInitiated timeout after 60 seconds

utility timeout after 7 days

background timeout after 7 days

default timeout after 7 days


Network inactivity• Use the timeoutIntervalForRequest property on CKOperation• Default value is 60 seconds


Network inactivity• Use the timeoutIntervalForRequest property on CKOperation• Default value is 60 seconds

Start-to-finish timeout• Use the timeoutIntervalForResource property on CKOperation• Default value is 7 days• CKOperation may stay around longer

API Improvements


CKFetchRecordZonesOperation • Poll for all record zones in a database

Reduce payloads and roundtripsHandling Many Record Zones



CKDatabaseSubscription• Receive a push for each change in a database

CKFetchDatabaseChangesOperation• Fetch ids of record zones with changes

CKFetchRecordChangesOperation • Track and fetch record changes on a

per-record-zone basis






CKFetchRecordZoneChangesOperation • Fetch record changes over multiple record

zones in a single operation






CKDatabaseSubscriptionHandling Many Record Zones

Record Zone

Record Zone

Record Zone

Record Zone

Record

Record

Record

Record

Database


Record Zone

Record Zone

Record Zone

Record Zone

Record

Record

Record

Record

Database

Record

Record


Record Zone

Record Zone

Record Zone

Record Zone

Push

Record

Record

Record

Record

Database

Record

Record

CKFetchDatabaseChangesOperationHandling Many Record Zones

Record Zone

Record Zone

Record Zone

Record Zone

Record

Record

Record

Record

Database

Record

Record

CKFetchRecordZoneChangesOperationHandling Many Record Zones

Database

Record Zone

Record Zone

Record Zone

Record Zone

Record

Record

Record

Record

Record

Record

API Improvements


Fetch Multiple Change Sets

public class CKFetchRecordChangesOperation : CKDatabaseOperation {

public var moreComing: Bool { get }

}

Remember this?




}

Remember this?

Client code responsible for fetching next batch




}

Remember this?

Client code responsible for fetching next batchCloudKit idle

Fetch Multiple Change SetsUse this instead

public class CKFetchRecordZoneChangesOperation : CKDatabaseOperation {

public var fetchAllChanges: Bool

}




}

CloudKit keeps pipeline full




}

// fetchAllChanges is true by default

CloudKit keeps pipeline full

Fetch Multiple Change SetsNew callback


public var recordZoneChangeTokensUpdatedBlock: ((CKRecordZoneID, CKServerChangeToken?,

Data?) -> Void)?

}




Data?) -> Void)?

}

Earlier record changes are safe to commit




Data?) -> Void)?

}

Earlier record changes are safe to commitNew server change token can be used on a new CKFetchRecordZoneChangesOperation

API Improvements


You and I are going to share some recordsSharing UI

Jacob Farkas

Sharing Records

public class CKShare : CKRecord

Sharing Records

What is shared? public class CKShare : CKRecord

Sharing Records

What is shared?Who is it shared with?

public class CKShare : CKRecord

Shared databaseSharing Overview

CloudKit Container

Public Database Shared DatabasePrivate Database

What is shared?Sharing Records

Private Database

What is shared?Sharing Records

Note

Private Database

What is shared?

Note

Sharing Records

Private Database

What is shared?

Note

Sharing Records

Private Database

Share public class CKShare : CKRecord {

public init(rootRecord : CKRecord)

}

What is shared?

Note

Sharing Records

Private Database

Share

public class CKShare : CKRecord {


}

Note

What is shared?

Note

Sharing Records

Private Database

Share



}

public class CKRecord {

public var share: CKReference? { get }

}Note

Who is it shared with?

Note

Sharing Records

Private Database

Share

Note

Who is it shared with?Sharing Records

Share

Note

Private Database


Share

Note

Private Database

[email protected]


Share

Note

Private Database

Share

Note

Private Database

Sharing RecordsShare URLs

Share

Note

Private Database

Sharing Records

https://www.icloud.com/notes/000Y4qow0owP6NOxDzs4qgi8Q

Share URLs

Share

Note

Private Database

Sharing Records

Family Grocery list”icloud.com/notes

Share URLs

Sharing Records

Owner Other User

Share

Note

Private Database

Accepting a share

Sharing Records

Share

Note

Private Database

Owner Other User

Accepting a share

Share

Note

Shared Database

Sharing Records

Share

Note

Private Database

Owner Other User

Accepting a share

Share

Note

Private Database

Share

Note

Shared Database

Sharing Records

Owner Other User

Share

Note

Private Database

Share

Note

Shared Database

Sharing Records

Share

Note

Private Database

Owner Other User

DemoSystem Sharing UI

Where does it live?CloudKit Sharing UI NEW

CloudKit


CKRecord

CKShare

CKModifyRecordsOperation

…

CloudKit


CKRecord

CKShare

CKModifyRecordsOperation

…

CloudKit

NSSharingService

NSItemProvider

AppKit

UICloudSharingController

UIKit

UICloudSharingControlleriOS Sharing API

// Create a CloudKit share record

let share = CKShare(rootRecord: rootRecord)

share[CKShareTitleKey] = "Shopping List”

share[CKShareThumbnailImageDataKey] = shoppingListThumbnail

// Create a cloud sharing controller

let sharingController = UICloudSharingController(share: share) {

(controller: UICloudSharingController,

prepareCompletionHandler : (CKShare?, CKContainer?, NSError?) -> Void) in

// Save the share

let sharingController = UICloudSharingController(share: share) {

(controller: UICloudSharingController,

prepareCompletionHandler : (CKShare?, CKContainer?, NSError?) -> Void) in

let modifyOp = CKModifyRecordsOperation(recordsToSave: [rootRecord, share],

recordIDsToDelete: nil)

modifyOp.modifyRecordsCompletionBlock = { (_, _, error) in

prepareCompletionHandler(share, ckContainer, error)

}

self.container.privateCloudDatabase.add(modifyOp)

}

// Set sharing options

sharingController.availablePermissions = [.publicOnly, .readWrite]

sharingController.popoverPresentationController?.sourceView = myShareButton

sharingController.delegate = self

self.present(sharingController, animated:true, completion:nil)

NSSharingServicemacOS Sharing API

// Save the share

let itemProvider = NSItemProvider()

itemProvider.registerCloudKitShare { (prepareCompletionHandler :

(CKShare?, CKContainer?, NSError?) -> Void) in

// Save the share and root record

}

let sharingService = NSSharingService(named: NSSharingServiceNameCloudSharing)!

sharingService.delegate = self

sharingService.perform(withItems: [itemProvider])

// Define sharing options

func options(for: NSSharingService, share: NSItemProvider)-> NSCloudKitSharingServiceOptions

{

return [.allowPublic, .allowReadWrite]

}

// User clicked a share

public class NSApplication {

public func application(application: NSApplication,

userAcceptedCloudKitShareWith: CKShareMetadata)

}

// User clicked a share

public class NSApplication {

public func application(application: NSApplication,


}

public class UIApplication {

public func application(application: UIApplication,


}

// Add an Info.plist key for CloudKit Sharing

<key>CKSharingSupported</key>

<true/>

Web Sharing UICloudKit JS

Sharing In Depth

Vanessa Hong

Deep diveCommon Use Cases

Sharing multiple recordsZones in shared databaseCKShare internalsSharing APIsSpecial notes

A Note is not a single recordSharing Multiple Records

Note

A Note consists of many recordsSharing Multiple Records

Note

Asset

Media


Note

Asset

Media Links

Data


Note

Asset

Media Links

Data

Info

Participant should only see a subsetSharing Multiple Records

Note

Asset

Media Links

Data

Info

Tell us what should be sharedSharing Multiple Records

Note

Asset

Media Links

Data

Info

Records have a new propertypublic var parent: CKReference

Parent references define the hierarchy for sharingSharing Multiple Records

Note

Asset

Media Links

Data

Info

Parent Field


Descendants linked to root record via the parent fieldSharing Multiple Records

Note

Asset

Media Links

Data

Info

Parent Field


Create Share using CKShare(rootRecord:)Sharing Multiple Records

Note

Asset

Media Links

Data

Info

Share

Parent Field


Shared DB is only a View into the owner’s private DBSharing Multiple Records

Shared Database

Participant

Private Database

Owner

After accepting, Participant sees only records with parentSharing Multiple Records

Shared Database

ParticipantOwner

Private Database

readWrite Participant cannot add a dangling CKRecordSharing Multiple Records

Shared Database

Participant

Private Database

Owner


Shared Database

Participant

Private Database

Owner

NEW


Shared Database

Participant

Private Database

Owner

NEW

Error


Shared Database

Participant

Private Database

Owner

NEW

Error

NEW


Shared Database

Participant

Private Database

Owner

Error: No Parent

NEW

Error

NEW

readWrite Participant can add a new parented CKRecordSharing Multiple Records

Shared Database

Participant

Private Database

Owner

readWrite Participant can add a new parented CKRecordSharing Multiple Records

Shared Database

Participant

Private Database

Owner

NEWNEW

Two owners, two sharesZones in Shared Database

Shared Database

“ShoppingList” Share “Shopping

List” Share

Two owners, two shares, two zonesZones in Shared Database

Shared Database


List” Share

Record Zone Record Zone


Shared Database


List” Share

Record Zone Record Zone

public class CKRecordZoneID {

public var zoneName: String

public var ownerName: String

}





}

Shared Database


List” Share

zoneName: “Notes” zoneName: “Notes”





}

Shared Database


List” Share

zoneName: “Notes” zoneName: “Notes”ownerName: “_abcxyz” ownerName: “_1234567”

Two owners, three shares, three zonesZones in Shared Database


List” Share


“Recipe” Share

zoneName: “OtherZone”ownerName: “_abcxyz”

Shared Database

Two owners, four shares, three zonesZones in Shared Database


List” Share


“Recipe” Share

zoneName: “OtherZone”ownerName: “_abcxyz” “Great

Hiking Trails”

Share

Shared Database

Two owners, four shares, three zonesZones in Shared Database

“ShoppingList” Share


“Recipe” Share

zoneName: “OtherZone”ownerName: “_abcxyz”

Shared Database

“ShoppingList” Share

“Great Hiking Trails”

Share

Prerequisite—Owner has existing Record(s) to shareCKShare

“Shopping List”


“Shopping List”

What to Share


“Shopping List”

What to Share

Share

How to Share

Is a CKRecord containing access controls for shared dataCKShare

Every CKShare has additional properties beyond a basic CKRecord

Is a CKRecord containing access controls for shared dataCKShare

Every CKShare has additional properties beyond a basic CKRecord


public var participants: [CKShareParticipant]

}

Share

public class CKShareParticipantParticipantParticipantParticipantParticipant

Owner sets up the ShareCKShare Lifecycle—Invite-Only

Share


1. Create a Share

Share


1. Create a Share2. publicPermission=none

publicPermission: none

Share


Participant #1

acceptanceStatus: invited

permission: readWrite

Participant #2


permission: readOnly

1. Create a Share2. publicPermission=none3. Add Participant

1. acceptanceStatus=invited2. Owner determines each

participant’s permission

publicPermission: noneparticipants:

Share


Participant #1



Participant #2






4. Save the Share

publicPermission: noneparticipants:

Share


Participant #1



Participant #2






4. Save the Share5. Owner gets URL


“Shopping List”icloud.com/notes

url:

participants:

Participant joins the ShareCKShare Lifecycle—Invite-Only

Share



url:

participants:

Participant #1



Participant #2



Participant joins the ShareCKShare Lifecycle—Invite-Only

Share 1. Participants accept via URLacceptanceStatus=accepted



url:

participants:

Participant #1



Participant #2



Participant #1

acceptanceStatus: accepted


Participant #2



Owner sets up the ShareCKShare Lifecycle—readOnly or readWrite

Share


1. Create a Share

Share


1. Create a Share2. publicPermission=readOnly

or readWritepublicPermission: readOnly or readWrite

Share



or readWrite3. Save the SharepublicPermission: readOnly or readWrite

Share



or readWrite3. Save the Share4. Owner gets URL


url:

publicPermission: readOnly or readWrite

Participant joins the ShareCKShare Lifecycle—readOnly or readWrite

Share

Participant #1


1. Anyone can join via URL. acceptanceStatus=accepted, permission is the same as the publicPermission


url:

publicPermission: readOnly or readWriteparticipants:

Lifecycle—end the share for a participantCKShare

Private DB

Owner

Shared DB

ParticipantParticipant leaves the Share by deleting the Share from their Shared DB

Lifecycle—end the share for a participantCKShare

Private DB

Owner

Shared DB

ParticipantParticipant leaves the Share by deleting the Share from their Shared DB

Owner can always remove any Participant

Lifecycle—End the share for everyoneCKShare

“Shopping List” Share

Owner deletes the Share from his private DB

Lifecycle—End the share for everyoneCKShare

“Shopping List”

Owner deletes the Share from his private DB

CKUserIdentityCKShareParticipant

Participant public class CKShareParticipant {

public var userIdentity: CKUserIdentity

…

}

public class CKUserIdentity {

public var lookupInfo: CKUserIdentityLookupInfo

public var nameComponents: PersonNameComponents

}

Mapped to iCloud accountsCKShareParticipant

Mapped to iCloud accounts

Participant #3

userIdentity.lookupInfo: <email>

Participant #4

userIdentity.lookupInfo: <phone>

Participant #2


Participant #1


CKShareParticipant

Mapped to iCloud accounts

Participant #3


Participant #4


Participant #2


Participant #1


CKShareParticipant

No iCloud account

Verification flow to prove email ownership

No iCloud account

Verification flow to prove phone ownership

If you want to create your own Custom UISharing APIs

On behalf of the owner• Setting up the Share

On behalf of the participant• Accept the Share

watchOS and tvOS• Shared records available, but no System UI

Adding participantsOwner Sets Up the Share


CKFetchShareParticipantsOperation• Can look up via

- Email- Phone- CloudKit User Record ID




• Returns CKShareParticipants





Pass CKShareParticipants to addParticipant





Pass CKShareParticipants to addParticipantCall CKModifyRecordsOperation to save the share

Fetch Share Metadata, then Accept the ShareParticipant Accepts a Share

CKFetchShareMetadataOperation• Converting a URL to CKShareMetadataPass CKShareMetadata to CKAcceptSharesOperation

LimitationsParticipant Accepts a Share

No nameComponents, for privacy reasonspublic class CKUserIdentity {

public var nameComponents: PersonNameComponents // empty

}

Verification flow only available via System UI:CKErrorParticipantMayNeedVerification

shareParticipant.userIdentity.lookupInfo.hasiCloudAccount

Invitees on older platformsSharing

Owner can invite anybody• Invitee may not have installed the latest operating system• Invitee may not have an Apple product

1280 x 800

Get your container ready for SharingSharing

CKRecordTypeShare• Behaves like any other Record Type in CloudKit• Can create custom fields• Can run queries

To trigger its creation• Share a record in a custom zone in any private database in the development environment• Deploy schema to productionNow, users in production can create Shares

What’s new is now oldSummary

CloudKit is available on all platformsTelemetry available on CloudKit DashboardAPI ImprovementsNew Feature—Sharing• Sharing System UI• Sharing APIs, Objects, and Lifecycle• Configure your fallback URL!

More Information

https://developer.apple.com/wwdc16/226

Related Sessions

CloudKit Best Practices Pacific Heights Friday 9:00AM

Labs

CloudKit and iCloud Lab Frameworks Lab D Thursday 4:00PM

CloudKit and iCloud Lab Frameworks Lab B Friday 12:00PM

what’s new in cloudkit€¦ · cloudkit js and web services wwdc 2015 what's new in cloudkit...

Documents