Platforms to show: All Mac Windows Linux Cross-Platform

Back to CNContactMBS class.

CNContactMBS.available as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Contacts MBS Mac64bit Plugin 16.3 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Whether this class is available.

Should return true in a 64-bit Mac app on Mac OS X 10.11 or newer.

CNContactMBS.descriptorForAllComparatorKeys as CNKeyDescriptorMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Contacts MBS Mac64bit Plugin 16.3 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Fetches all the keys required for the contact sort comparator.

This method implements the CNKeyDescriptor protocol and can be used as an array element when fetching keys for contacts.

CNContactMBS.localizedStringForKey(key as String) as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Contacts MBS Mac64bit Plugin 16.3 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Returns a string containing the localized contact property name.

key: A string containing the contact property key.

Returns a localized string containing the contact property name.

This method returns a localized string for a contact property key. For example, the value of a Canadian CNContactPostalAddressesKey field would be “Postal Code”, while the value of a French one would be “Code Postal”.

CNContactMBS.predicateForContactsInContainerWithIdentifier(containerIdentifier as String) as NSPredicateMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Contacts MBS Mac64bit Plugin 16.3 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Returns a predicate to find the contacts in the specified container.

Returns a predicate that can be used to fetch contacts from CNContactStore.

CNContactMBS.predicateForContactsInGroupWithIdentifier(groupIdentifier as String) as NSPredicateMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Contacts MBS Mac64bit Plugin 16.3 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Returns a predicate to find the contacts that are members in the specified group.

Returns a predicate that can be used to fetch contacts from CNContactStore.

CNContactMBS.predicateForContactsMatchingEmailAddress(emailAddress as String) as NSPredicateMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Contacts MBS Mac64bit Plugin 20.5 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Returns a predicate to find the contacts whose email address matches the specified value.
Example
Var keysToFetch() As CNKeyDescriptorMBS
keysToFetch.append CNContactVCardSerializationMBS.descriptorForRequiredKeys

Var predicate As NSPredicateMBS = CNContactMBS.predicateForContactsMatchingEmailAddress("test@test.test")

Var error As NSErrorMBS
Var contacts() As CNContactMBS = m.unifiedContactsMatchingPredicate(predicate, keysToFetch, error)

If error <> Nil Then
List.AddRow "Error: "+error.LocalizedDescription
Else
List.AddRow Str(contacts.Ubound+1)+" contacts found"
End If

emailAddress: The email address to be matched.

Returns a predicate that you can use to fetch contacts from CNContactStoreMBS class.

Requires macOS 10.13 or newer.

CNContactMBS.predicateForContactsMatchingName(name as String) as NSPredicateMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Contacts MBS Mac64bit Plugin 16.3 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Returns a predicate to find the contacts matching the specified name.
Example
Var keysToFetch() As CNKeyDescriptorMBS
keysToFetch.append CNContactVCardSerializationMBS.descriptorForRequiredKeys

Var predicate As NSPredicateMBS = CNContactMBS.predicateForContactsMatchingName("Peter")

Var error As NSErrorMBS
Var contacts() As CNContactMBS = m.unifiedContactsMatchingPredicate(predicate, keysToFetch, error)

If error <> Nil Then
List.AddRow "Error: "+error.LocalizedDescription
Else
List.AddRow Str(contacts.Ubound+1)+" contacts found"
End If

The name can contain any number of words.
Returns a predicate that can be used to fetch contacts from CNContactStore.

Some examples using this method:

CNContactMBS.predicateForContactsMatchingPhoneNumber(phoneNumber as CNPhoneNumberMBS) as NSPredicateMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Contacts MBS Mac64bit Plugin 20.5 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Returns a predicate to find the contacts whose phone number matches the specified value.
Example
Var keysToFetch() As CNKeyDescriptorMBS
keysToFetch.append CNContactVCardSerializationMBS.descriptorForRequiredKeys

Var phone As New CNPhoneNumberMBS("123456789‬")
Var predicate As NSPredicateMBS = CNContactMBS.predicateForContactsMatchingPhoneNumber(phone)

Var error As NSErrorMBS
Var contacts() As CNContactMBS = m.unifiedContactsMatchingPredicate(predicate, keysToFetch, error)

If error <> Nil Then
List.AddRow "Error: "+error.LocalizedDescription
Else
List.AddRow Str(contacts.Ubound+1)+" contacts found"
End If

Returns a predicate that you can use to fetch contacts from CNContactStoreMBS.

Requires macOS 10.13 or newer.

CNContactMBS.predicateForContactsWithIdentifiers(Identifiers() as String) as NSPredicateMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Contacts MBS Mac64bit Plugin 16.3 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Returns a predicate to find the contacts matching the specified identifiers.

Returns a predicate that can be used to fetch contacts from CNContactStore.

The items on this page are in the following plugins: MBS Mac64bit Plugin.


The biggest plugin in space...