Introducing the Contacts Framework

Transcription

1 App Frameworks #WWDC15 Introducing the Contacts Framework For OS X, ios, and watchos Session 223 Bruce Stadnyk ios Contacts Engineer Dave Dribin OS X Contacts Engineer Julien Robert ios Contacts Engineer 2015 Apple Inc. All rights reserved. Redistribution or public display not permitted without written permission from Apple.

2 What is Contacts Framework?

3 What is Contacts Framework? Objective-C and Swift API

4 What is Contacts Framework? Objective-C and Swift API Optimized for thread-safe, read only usage

5 What is Contacts Framework? Objective-C and Swift API Optimized for thread-safe, read only usage One API, multiple platforms

6 What is Contacts Framework? Objective-C and Swift API Optimized for thread-safe, read only usage One API, multiple platforms AddressBook API being deprecated

7

8

9

10 What are Contacts?

11 What are Contacts? Everyone has Contacts

12 What are Contacts? Everyone has Contacts Phone, Mail, Messages,

13 What are Contacts? Everyone has Contacts Phone, Mail, Messages,

14 What are Contacts? Everyone has Contacts Phone, Mail, Messages, Central to the user experience

15 Contact Properties

16 Contact Properties John Appleseed (home) (work) (408) (iphone)

17 Contact Properties John Appleseed (home) (work) (408) (iphone)

18 Contact Properties John Appleseed (home) (work) (408) (iphone)

19 Contact Properties John Appleseed (home) (work) (408) (iphone)

20 Contact Properties John Appleseed (home) (work) (408) (iphone)

21 Contact Properties John Appleseed (home) (work) (408) (iphone)

22 Contact Properties John Appleseed (home) (work) (408) (iphone)

23 Contact Properties contact.imagedata John contact.givenname Appleseed contact.familyname (home) (work) contact. addresses (408) (iphone) contact.phonenumbers

24 Contact Properties contact.imagedata John contact.givenname Appleseed contact.familyname (home) (work) contact. addresses (408) (iphone) contact.phonenumbers

25 Contact Properties contact.imagedata John contact.givenname Appleseed contact.familyname (home) (work) contact. addresses (408) (iphone) contact.phonenumbers

26 Contact Properties contact.imagedata John contact.givenname Appleseed contact.familyname (home) (work) contact. addresses (408) (iphone) contact.phonenumbers

27 Contact Properties contact.imagedata John contact.givenname Appleseed contact.familyname (home) (work) contact. addresses (408) (iphone) contact.phonenumbers

28 Contact Properties contact.imagedata John contact.givenname Appleseed contact.familyname (home) (work) contact. addresses (408) (iphone) contact.phonenumbers

29 Contact Objects

30 Contact Objects CNContact

31 Contact Objects CNContact CNMutableContact

32 Contact Objects CNContact CNLabeledValue CNMutableContact

33 Creating a New Contact import Contacts

34 Creating a New Contact import Contacts // create mutable for adding to the contact let contact = CNMutableContact()

35 Creating a New Contact import Contacts // create mutable for adding to the contact let contact = CNMutableContact() contact.imagedata = // profile picture as NSData

36 Creating a New Contact import Contacts // create mutable for adding to the contact let contact = CNMutableContact() contact.imagedata = // profile picture as NSData

37 Creating a New Contact import Contacts // create mutable for adding to the contact let contact = CNMutableContact() contact.imagedata = // profile picture as NSData contact.givenname = "John" contact.familyname = "Appleseed"

38 Creating a New Contact Labeled Values let home = CNLabeledValue(label: CNLabelHome, value: "john@example.com") let work = CNLabeledValue(label: CNLabelWork, value: "j.appleseed@icloud.com")

39 Creating a New Contact Labeled Values let home = CNLabeledValue(label: CNLabelHome, value: "john@example.com") let work = CNLabeledValue(label: CNLabelWork, value: "j.appleseed@icloud.com") contact. addresses = [home , work ]

40 Creating a New Contact Labeled Values let home = CNLabeledValue(label: CNLabelHome, value: "john@example.com") let work = CNLabeledValue(label: CNLabelWork, value: "j.appleseed@icloud.com") contact. addresses = [home , work ] contact.phonenumbers = [CNLabeledValue( label: CNLabelPhoneNumberiPhone, value: CNPhoneNumber(stringValue: "(408) "))]

41 Creating a New Contact Labeled Values let address = CNMutablePostalAddress() address.street = "774 Loma Vista Ave" address.city = "Los Gatos" address.state = "CA" address.postalcode = "95032"

42 Creating a New Contact Labeled Values let address = CNMutablePostalAddress() address.street = "774 Loma Vista Ave" address.city = "Los Gatos" address.state = "CA" address.postalcode = "95032" contact.postaladdresses = [CNLabeledValue(label: CNLabelHome, value: address)]

43 Creating a New Contact Dates let birthday = NSDateComponents() birthday.day = 1 birthday.month = 4 birthday.year = 1988 // can omit for a year-less birthday

44 Creating a New Contact Dates let birthday = NSDateComponents() birthday.day = 1 birthday.month = 4 birthday.year = 1988 // can omit for a year-less birthday contact.birthday = birthday

45 Formatting Contact Data

46 Formatting Contact Data let fullname = CNContactFormatter.stringFromContact(contact, style:.fullname)

47 Formatting Contact Data let fullname = CNContactFormatter.stringFromContact(contact, style:.fullname) print(fullname) // John Appleseed

48 Formatting Contact Data let fullname = CNContactFormatter.stringFromContact(contact, style:.fullname) print(fullname) // John Appleseed let postalstring = CNPostalAddressFormatter.stringFromPostalAddress(address)

49 Formatting Contact Data let fullname = CNContactFormatter.stringFromContact(contact, style:.fullname) print(fullname) // John Appleseed let postalstring = CNPostalAddressFormatter.stringFromPostalAddress(address) print(postalstring) // 774 Loma Vista Ave // Los Gatos, CA 95032

50 Using Contacts in Your App Dave Dribin OS X Contacts Engineer

51

52

53 Using Contacts in Your App CNContactStore

54 Fetching User's Contacts class CNContactStore : NSObject { func unifiedcontactsmatchingpredicate( predicate: NSPredicate, keystofetch: [CNKeyDescriptor]) -> [CNContact] throws... }

55 Predicates let predicate = CNContact.predicateForContactsMatchingName("Appleseed")

56 Predicates let predicate = CNContact.predicateForContactsMatchingName("Appleseed") John Jane Craig Appleseed Appleseed Bromley john@example.com (home) j.appleseed@icloud.com (work) (408) (iphone) April 1, 1988 (birthday) jane@example.com (home) (505) (home) (408) (work) cbromley@icloud.com (work) (465) (iphone) Jun 21 (birthday)

57 Predicates let predicate = CNContact.predicateForContactsMatchingName("Appleseed") John Jane Craig Appleseed Appleseed Bromley john@example.com (home) j.appleseed@icloud.com (work) (408) (iphone) April 1, 1988 (birthday) jane@example.com (home) (505) (home) (408) (work) cbromley@icloud.com (work) (465) (iphone) Jun 21 (birthday)

58 Keys to Fetch let keystofetch = ["givenname", "familyname"] imagedata John Jane givenname Appleseed john@example.com (home) j.appleseed@icloud.com (work) (408) (iphone) April 1, 1988 (birthday) Appleseed jane@example.com (home) (505) (home) (408) (work) familyname addresses phonenumbers birthday

59 Keys to Fetch let keystofetch = [CNContactGivenNameKey, CNContactFamilyNameKey] imagedata John Jane givenname Appleseed john@example.com (home) j.appleseed@icloud.com (work) (408) (iphone) April 1, 1988 (birthday) Appleseed jane@example.com (home) (505) (home) (408) (work) familyname addresses phonenumbers birthday

60 Keys to Fetch let keystofetch = [CNContactGivenNameKey, CNContactFamilyNameKey] imagedata John Jane givenname Appleseed john@example.com (home) j.appleseed@icloud.com (work) (408) (iphone) April 1, 1988 (birthday) Appleseed jane@example.com (home) (505) (home) (408) (work) familyname addresses phonenumbers birthday

61 How to Fetch let predicate = CNContact.predicateForContactsMatchingName("Appleseed") let keystofetch = [CNContactGivenNameKey, CNContactFamilyNameKey]

62 How to Fetch let predicate = CNContact.predicateForContactsMatchingName("Appleseed") let keystofetch = [CNContactGivenNameKey, CNContactFamilyNameKey] let store = CNContactStore() let contacts = try store.unifiedcontactsmatchingpredicate(predicate, keystofetch: keystofetch)

63 How to Fetch let predicate = CNContact.predicateForContactsMatchingName("Appleseed") let keystofetch = [CNContactGivenNameKey, CNContactFamilyNameKey] let store = CNContactStore() let contacts = try store.unifiedcontactsmatchingpredicate(predicate, keystofetch: keystofetch) for contact in contacts { } print("\(contact.givenname) \(contact.familyname)")

64 Keeping UI Responsive Main Queue Background Queue Fetch Contacts CNContact CNContact CNContact

65 Keeping UI Responsive Main Queue Background Queue Fetch Contacts CNContact CNContact CNContact CNContact CNContact CNContact

66 Data Privacy

67 Data Privacy class CNContactStore : NSObject { } func requestaccessforentitytype(..., completionhandler:) Privacy and Your App Pacific Heights Tuesday 2:30PM

68 Partial Contacts let keystofetch = [CNContactGivenNameKey, CNContactFamilyNameKey] John John givenname Appleseed john@example.com (home) j.appleseed@icloud.com (work) (408) (iphone) Appleseed john@example.com (home) j.appleseed@icloud.com (work) (408) (iphone) familyname April 1, 1988 (birthday) April 1, 1988 (birthday)

69 Partial Contacts let keystofetch = [CNContactGivenNameKey, CNContactFamilyNameKey] John John givenname Appleseed john@example.com (home) j.appleseed@icloud.com (work) (408) (iphone) Appleseed john@example.com (home) j.appleseed@icloud.com (work) (408) (iphone) familyname phonenumbers April 1, 1988 (birthday) April 1, 1988 (birthday)

70 Partial Contacts if (contact.iskeyavailable(cncontactphonenumberskey)) { } print("\(contact.phonenumbers)")

71 Partial Contacts if (contact.iskeyavailable(cncontactphonenumberskey)) { print("\(contact.phonenumbers)") } else { let keystofetch = [CNContactGivenNameKey, CNContactFamilyNameKey, CNContactPhoneNumbersKey] var refetchedcontact = try store.unifiedcontactwithidentifier( contact.identifier, keystofetch: keystofetch) print("\(refetchedcontact.phonenumbers)") }

72 Formatting Partial Contacts let keystofetch = [CNContactGivenNameKey, CNContactFamilyNameKey] Mr. John nameprefix givenname middlename Appleseed Sr. familyname namesuffix

73 Formatting Partial Contacts let keystofetch = [CNContactGivenNameKey, CNContactFamilyNameKey, CNContactNamePrefixKey, CNContactMiddleNameKey,...] Mr. John nameprefix givenname middlename Appleseed Sr. familyname namesuffix

74 Formatting Partial Contacts let keystofetch = [CNContactFormatter.descriptorForRequiredKeysForStyle(.FullName)] Mr. John nameprefix givenname middlename Appleseed Sr. familyname namesuffix + Any Others

75 Key Descriptors let predicate = CNContact.predicateForContactsMatchingName("Appleseed") let keystofetch = [ CNContactFormatter.descriptorForRequiredKeysForStyle(.FullName), CNContact AddressesKey]

76 Key Descriptors let predicate = CNContact.predicateForContactsMatchingName("Appleseed") let keystofetch = [ CNContactFormatter.descriptorForRequiredKeysForStyle(.FullName), CNContact AddressesKey] let contacts = try store.unifiedcontactsmatchingpredicate(predicate, keystofetch: keystofetch)

77 Key Descriptors let predicate = CNContact.predicateForContactsMatchingName("Appleseed") let keystofetch = [ CNContactFormatter.descriptorForRequiredKeysForStyle(.FullName), CNContact AddressesKey] let contacts = try store.unifiedcontactsmatchingpredicate(predicate, keystofetch: keystofetch) for contact in contacts { let fullname = CNContactFormatter.stringFromContact( contact, style:.fullname)?? "No Name" print("\(fullname): \(contact. addresses)") }

78 Unified Contacts icloud Facebook John John Appleseed Appleseed (work) (home) (408) (iphone) April 1, 1988 (birthday)

79 Unified Contacts icloud Facebook Unified John John John Appleseed (work) (408) (iphone) Appleseed (home) Appleseed (work) (home) (408) (iphone) April 1, 1988 (birthday) April 1, 1988 (birthday)

80 Adding a New Contact let john = CNMutableContact() john.givenname = "John" john.familyname = "Appleseed"

81 Adding a New Contact let john = CNMutableContact() john.givenname = "John" john.familyname = "Appleseed" let saverequest = CNSaveRequest() saverequest.addcontact(john, tocontainerwithidentifier: nil) try store.executesaverequest(saverequest)

82 Updating an Existing Contact let updatedcontact = contact.mutablecopy() let new = CNLabeledValue(label: CNLabelHome, value: "john@example.com") updatedcontact. addresses.append(new )

83 Updating an Existing Contact let updatedcontact = contact.mutablecopy() let new = CNLabeledValue(label: CNLabelHome, value: "john@example.com") updatedcontact. addresses.append(new ) let saverequest = CNSaveRequest() saverequest.updatecontact(updatedcontact) try store.executesaverequest(saverequest)

84 Contacts in the UI Julien Robert ios Contacts Engineer

85 ContactsUI New framework

86 ContactsUI New framework ios OS X

87 ContactsUI New framework ios OS X CNContactPickerViewController CNContactPicker

88 ContactsUI New framework ios OS X CNContactPickerViewController CNContactPicker CNContactViewController CNContactViewController

89 Picking Contacts CNContactPickerViewController

90 Picking Contacts CNContactPickerViewController Modern replacement for ABPeoplePickerNavigationController

91 Picking Contacts CNContactPickerViewController Modern replacement for ABPeoplePickerNavigationController Must be presented, not pushed

92 Picking Contacts CNContactPickerViewController Modern replacement for ABPeoplePickerNavigationController Must be presented, not pushed Always out of process, no contacts access dialog

93 Picking Contacts CNContactPickerViewController Modern replacement for ABPeoplePickerNavigationController Must be presented, not pushed Always out of process, no contacts access dialog May return partial contacts

94 Picking Contacts CNContactPickerViewController Modern replacement for ABPeoplePickerNavigationController Must be presented, not pushed Always out of process, no contacts access dialog May return partial contacts Behavior based on delegate methods and predicates

95 Picking Contacts CNContactPickerViewController Modern replacement for ABPeoplePickerNavigationController Must be presented, not pushed Always out of process, no contacts access dialog May return partial contacts Behavior based on delegate methods and predicates Supports multi-selection

96 Picking Contacts Delegate methods

97 Picking Contacts Delegate methods Single contact

98 Picking Contacts Delegate methods Single contact contactpicker(picker, didselectcontact contact: CNContact)

99 Picking Contacts Delegate methods Single contact contactpicker(picker, didselectcontact contact: CNContact) Single property contactpicker(picker, didselectcontactproperty property: CNContactProperty)

100 Picking Contacts Delegate methods Single contact contactpicker(picker, didselectcontact contact: CNContact) Single property contactpicker(picker, didselectcontactproperty property: CNContactProperty) class CNContactProperty { var contact: CNContact var key: NSString var value: AnyObject? var identifier: NSString? }

101 Picking Contacts Delegate methods

102 Picking Contacts Delegate methods Multiple contacts

103 Picking Contacts Delegate methods Multiple contacts contactpicker(picker, didselectcontacts contacts: [CNContact])

104 Picking Contacts Delegate methods Multiple contacts contactpicker(picker, didselectcontacts contacts: [CNContact]) Multiple properties contactpicker(picker, didselectcontactproperties properties: [CNContactProperty])

105 Picking Contacts Predicates

106 Picking Contacts Predicates predicateforenablingcontact Which contacts are available Evaluated on CNContact

107 Picking Contacts Predicates predicateforenablingcontact Which contacts are available Evaluated on CNContact

108 Picking Contacts Predicates predicateforenablingcontact Which contacts are available Evaluated on CNContact let predicate = NSPredicate(format: "familyname LIKE[cd] 'parker'")

109 Picking Contacts Predicates predicateforenablingcontact Which contacts are available Evaluated on CNContact let predicate = NSPredicate(format: "familyname LIKE[cd] 'parker'") contactpicker.predicateforenablingcontact = predicate

110 Picking Contacts Predicates

111 Picking Contacts Predicates predicateforselectionofcontact Which contacts are returned when tapped, others push the card

112 Picking Contacts Predicates predicateforselectionofcontact Which contacts are returned when tapped, others push the card predicateforselectionofproperty Which properties are returned when tapped, others perform the default action Evaluated on CNContactProperty

113 Picking Contacts Predicates predicateforselectionofcontact Which contacts are returned when tapped, others push the card predicateforselectionofproperty Which properties are returned when tapped, others perform the default action Evaluated on CNContactProperty Coherence between predicates and delegate methods

114 Viewing Contacts CNContactViewController

115 Viewing Contacts CNContactViewController One class to replace ABPersonViewController ABNewPersonViewController ABUnknownPersonViewController

116 Viewing Contacts CNContactViewController

117 Viewing Contacts CNContactViewController Use appropriate creation method

118 Viewing Contacts CNContactViewController Use appropriate creation method viewcontrollerforcontact:

119 Viewing Contacts CNContactViewController Use appropriate creation method viewcontrollerforcontact: viewcontrollerfornewcontact:

120 Viewing Contacts CNContactViewController Use appropriate creation method viewcontrollerforcontact: viewcontrollerfornewcontact: viewcontrollerforunknowncontact:

121 Viewing Contacts CNContactViewController Use appropriate creation method viewcontrollerforcontact: viewcontrollerfornewcontact: viewcontrollerforunknowncontact:

122 Viewing Contacts CNContactViewController Use appropriate creation method viewcontrollerforcontact: viewcontrollerfornewcontact: viewcontrollerforunknowncontact: Always out of process

123 Viewing Contacts CNContactViewController Use appropriate creation method viewcontrollerforcontact: viewcontrollerfornewcontact: viewcontrollerforunknowncontact: Always out of process Contact must be fetched with descriptorforrequiredkeys

124 Viewing Contacts Example let contact = try contactstore.unifiedcontactwithidentifier(identifier, keystofetch: [CNContactViewController.descriptorForRequiredKeys])

125 Viewing Contacts Example let contact = try contactstore.unifiedcontactwithidentifier(identifier, keystofetch: [CNContactViewController.descriptorForRequiredKeys]) let viewcontroller = CNContactViewController(forContact: contact)

126 Viewing Contacts Example let contact = try contactstore.unifiedcontactwithidentifier(identifier, keystofetch: [CNContactViewController.descriptorForRequiredKeys]) let viewcontroller = CNContactViewController(forContact: contact) viewcontroller.contactstore = self.contactstore viewcontroller.delegate = self

127 Viewing Contacts Example let contact = try contactstore.unifiedcontactwithidentifier(identifier, keystofetch: [CNContactViewController.descriptorForRequiredKeys]) let viewcontroller = CNContactViewController(forContact: contact) viewcontroller.contactstore = self.contactstore viewcontroller.delegate = self self.pushviewcontroller(viewcontroller)

128 Viewing Contacts Example let contact = try contactstore.unifiedcontactwithidentifier(identifier, keystofetch: [CNContactViewController.descriptorForRequiredKeys]) let viewcontroller = CNContactViewController(forContact: contact) viewcontroller.contactstore = self.contactstore viewcontroller.delegate = self self.pushviewcontroller(viewcontroller) func contactviewcontroller(vc, didcompletewithcontact: contact) { } // do something with the modified contact

129 Demo Picking and Viewing Contacts Meow

130 Summary A new modern Contacts API Common across all platforms Adopt now!

131 More Information Documentation Contacts Framework Reference ContactsUI Framework Reference Technical Support Apple Developer Forums General Inquiries Paul Marcos, App Frameworks Evangelist

132 Labs Contacts, Calendar and Reminders Lab Frameworks Lab A Thursday 4:30PM Contacts, Calendar and Reminders Lab Frameworks Lab A Friday 9:00AM

133