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.CNContactBirthdayKey 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
One of the keys for contact properties.

Birthday.

Some examples using this method:

CNContactMBS.CNContactDatesKey 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
One of the keys for contact properties.

Contact dates.

Some examples using this method:

CNContactMBS.CNContactDepartmentNameKey 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
One of the keys for contact properties.

Department name.

Some examples using this method:

CNContactMBS.CNContactEmailAddressesKey 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
One of the keys for contact properties.

Email address.

Some examples using this method:

CNContactMBS.CNContactFamilyNameKey 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
One of the keys for contact properties.

Family name.

Some examples using this method:

CNContactMBS.CNContactGivenNameKey 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
One of the keys for contact properties.

Given name.

Some examples using this method:

CNContactMBS.CNContactIdentifierKey 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
One of the keys for contact properties.

The identifier.

Some examples using this method:

CNContactMBS.CNContactImageDataAvailableKey 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
One of the keys for contact properties.

Image data availability.
Available in OS X 10.12 or newer.

Some examples using this method:

CNContactMBS.CNContactImageDataKey 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
One of the keys for contact properties.

Image data.

Some examples using this method:

CNContactMBS.CNContactInstantMessageAddressesKey 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
One of the keys for contact properties.

Instant messages.

Some examples using this method:

CNContactMBS.CNContactJobTitleKey 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
One of the keys for contact properties.

Job title.

Some examples using this method:

CNContactMBS.CNContactMiddleNameKey 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
One of the keys for contact properties.

Middle name.

Some examples using this method:

CNContactMBS.CNContactNamePrefixKey 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
One of the keys for contact properties.

Name prefix.

Some examples using this method:

CNContactMBS.CNContactNameSuffixKey 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
One of the keys for contact properties.

Name suffix.

Some examples using this method:

CNContactMBS.CNContactNicknameKey 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
One of the keys for contact properties.

Nickname.

Some examples using this method:

CNContactMBS.CNContactNonGregorianBirthdayKey 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
One of the keys for contact properties.

Non-Gregorian birthday.

Some examples using this method:

CNContactMBS.CNContactNoteKey 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
One of the keys for contact properties.

Note.

Some examples using this method:

CNContactMBS.CNContactOrganizationNameKey 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
One of the keys for contact properties.

Organization name.

Some examples using this method:

CNContactMBS.CNContactPhoneNumbersKey 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
One of the keys for contact properties.

Phone number.

Some examples using this method:

CNContactMBS.CNContactPhoneticFamilyNameKey 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
One of the keys for contact properties.

Phonetic family name.

Some examples using this method:

CNContactMBS.CNContactPhoneticGivenNameKey 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
One of the keys for contact properties.

Phonetic given name.

Some examples using this method:

CNContactMBS.CNContactPhoneticMiddleNameKey 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
One of the keys for contact properties.

Phonetic middle name.

Some examples using this method:

CNContactMBS.CNContactPhoneticOrganizationNameKey as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Contacts MBS Mac64bit Plugin 20.5 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
The phonetic spelling of the contact's organization name.

Requires macOS 10.12 or newer.

CNContactMBS.CNContactPostalAddressesKey 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
One of the keys for contact properties.

Postal address.

Some examples using this method:

CNContactMBS.CNContactPreviousFamilyNameKey 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
One of the keys for contact properties.

Previous family name.

Some examples using this method:

CNContactMBS.CNContactPropertyNotFetchedExceptionName 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
Exception thrown when an accessed property was not fetched.

The plugin throws a NSExceptionMBS where the name is this value in case a property is not available.

CNContactMBS.CNContactRelationsKey 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
One of the keys for contact properties.

Contact relations.

Some examples using this method:

CNContactMBS.CNContactSocialProfilesKey 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
One of the keys for contact properties.

Social profile.

Some examples using this method:

CNContactMBS.CNContactThumbnailImageDataKey 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
One of the keys for contact properties.

Thumbnail data.

Some examples using this method:

CNContactMBS.CNContactTypeKey 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
One of the keys for contact properties.

Contact type.

Some examples using this method:

CNContactMBS.CNContactUrlAddressesKey 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
One of the keys for contact properties.

URL Address.

Some examples using this method:

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
Dim keysToFetch() As CNKeyDescriptorMBS
keysToFetch.append CNContactVCardSerializationMBS.descriptorForRequiredKeys

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

Dim error As NSErrorMBS
Dim 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
Dim keysToFetch() As CNKeyDescriptorMBS
keysToFetch.append CNContactVCardSerializationMBS.descriptorForRequiredKeys

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

Dim error As NSErrorMBS
Dim 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
Dim keysToFetch() As CNKeyDescriptorMBS
keysToFetch.append CNContactVCardSerializationMBS.descriptorForRequiredKeys

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

Dim error As NSErrorMBS
Dim 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...