One Logo Pool Ball
Contacts · IOS API REFERENCE

CNContact

class · iOS 9.0+ · SDK 27.1

class CNContact

Members (47)

get · iOS 9.0+

debugDescription

TypeScript
get debugDescription(): string
Swift declaration
override dynamic var debugDescription: String { get }
get · iOS 9.0+

description

TypeScript
get description(): string
Swift declaration
override dynamic var description: String { get }
get · iOS 17.0+

id

TypeScript
get id(): string
Swift declaration
@objc dynamic var id: UUID { get }

The stable identity of the entity associated with this instance.

get · iOS 9.0+

shortDebugDescription

TypeScript
get shortDebugDescription(): string
Swift declaration
@objc dynamic var shortDebugDescription: String { get }
static · iOS 9.0+

comparator

TypeScript
static comparator(sortOrder: CNContactSortOrder): ((arg0: unknown, arg1: unknown) => Promise<_Foundation_ComparisonResult>)
Swift declaration
class func comparator(forNameSortOrder sortOrder: CNContactSortOrder) -> Comparator
static · iOS 9.0+

descriptorForAllComparatorKeys

TypeScript
static descriptorForAllComparatorKeys(): SDKHandle
Swift declaration
class func descriptorForAllComparatorKeys() -> any CNKeyDescriptor
static · iOS 9.0+

localizedString

TypeScript
static localizedString(key: string): string
Swift declaration
class func localizedString(forKey key: String) -> String
static

predicateForContactsInContainer

TypeScript
static predicateForContactsInContainer(containerIdentifier: string): _Foundation_NSPredicate
Swift declaration
class func predicateForContactsInContainer(withIdentifier containerIdentifier: String) -> NSPredicate
static

predicateForContactsInGroup

TypeScript
static predicateForContactsInGroup(groupIdentifier: string): _Foundation_NSPredicate
Swift declaration
class func predicateForContactsInGroup(withIdentifier groupIdentifier: String) -> NSPredicate
static · iOS 11.0+

predicateForContacts

TypeScript
static predicateForContactsMatchingEmailAddress(emailAddress: string): _Foundation_NSPredicate
Swift declaration
class func predicateForContacts(matchingEmailAddress emailAddress: String) -> NSPredicate
static

predicateForContacts

TypeScript
static predicateForContactsMatchingName(name: string): _Foundation_NSPredicate
Swift declaration
class func predicateForContacts(matchingName name: String) -> NSPredicate
static · iOS 11.0+

predicateForContacts

TypeScript
static predicateForContactsMatching(phoneNumber: CNPhoneNumber): _Foundation_NSPredicate
Swift declaration
class func predicateForContacts(matching phoneNumber: CNPhoneNumber) -> NSPredicate
static

predicateForContacts

TypeScript
static predicateForContactsWithIdentifiers(identifiers: Array<string>): _Foundation_NSPredicate
Swift declaration
class func predicateForContacts(withIdentifiers identifiers: [String]) -> NSPredicate
method · iOS 9.0+

areKeysAvailable

TypeScript
areKeysAvailable(keyDescriptors: Array<SDKHandle>): boolean
Swift declaration
func areKeysAvailable(_ keyDescriptors: [any CNKeyDescriptor]) -> Bool
init

init

TypeScript
static init(): CNContact
Swift declaration
init()
method · iOS 9.0+

isKeyAvailable

TypeScript
isKeyAvailable(key: string): boolean
Swift declaration
func isKeyAvailable(_ key: String) -> Bool
method · iOS 9.0+

isUnifiedWithContact

TypeScript
isUnifiedWithContact(contactIdentifier: string): boolean
Swift declaration
func isUnifiedWithContact(withIdentifier contactIdentifier: String) -> Bool
get · iOS 9.0+

birthday

TypeScript
get birthday(): (_Foundation_DateComponents) | null
Swift declaration
var birthday: DateComponents? { get }
get · iOS 9.0+

contactRelations

TypeScript
get contactRelations(): Array<CNLabeledValue<CNContactRelation>>
Swift declaration
var contactRelations: [CNLabeledValue<CNContactRelation>] { get }
get · iOS 9.0+

contactType

TypeScript
get contactType(): CNContactType
Swift declaration
var contactType: CNContactType { get }
get · iOS 9.0+

dates

TypeScript
get dates(): Array<CNLabeledValue<_Foundation_NSDateComponents>>
Swift declaration
var dates: [CNLabeledValue<NSDateComponents>] { get }
get · iOS 9.0+

departmentName

TypeScript
get departmentName(): string
Swift declaration
var departmentName: String { get }
get · iOS 9.0+

emailAddresses

TypeScript
get emailAddresses(): Array<CNLabeledValue<_Foundation_NSString>>
Swift declaration
var emailAddresses: [CNLabeledValue<NSString>] { get }
get · iOS 9.0+

familyName

TypeScript
get familyName(): string
Swift declaration
var familyName: String { get }
get · iOS 9.0+

givenName

TypeScript
get givenName(): string
Swift declaration
var givenName: String { get }
get · iOS 9.0+

identifier

TypeScript
get identifier(): string
Swift declaration
var identifier: String { get }
get · iOS 9.0+

imageData

TypeScript
get imageData(): (ArrayBuffer) | null
Swift declaration
var imageData: Data? { get }
get · iOS 9.0+

imageDataAvailable

TypeScript
get imageDataAvailable(): boolean
Swift declaration
var imageDataAvailable: Bool { get }
get · iOS 9.0+

instantMessageAddresses

TypeScript
get instantMessageAddresses(): Array<CNLabeledValue<CNInstantMessageAddress>>
Swift declaration
var instantMessageAddresses: [CNLabeledValue<CNInstantMessageAddress>] { get }
get · iOS 9.0+

jobTitle

TypeScript
get jobTitle(): string
Swift declaration
var jobTitle: String { get }
get · iOS 9.0+

middleName

TypeScript
get middleName(): string
Swift declaration
var middleName: String { get }
get · iOS 9.0+

namePrefix

TypeScript
get namePrefix(): string
Swift declaration
var namePrefix: String { get }
get · iOS 9.0+

nameSuffix

TypeScript
get nameSuffix(): string
Swift declaration
var nameSuffix: String { get }
get · iOS 9.0+

nickname

TypeScript
get nickname(): string
Swift declaration
var nickname: String { get }
get · iOS 9.0+

nonGregorianBirthday

TypeScript
get nonGregorianBirthday(): (_Foundation_DateComponents) | null
Swift declaration
var nonGregorianBirthday: DateComponents? { get }
get · iOS 9.0+

note

TypeScript
get note(): string
Swift declaration
var note: String { get }
get · iOS 9.0+

organizationName

TypeScript
get organizationName(): string
Swift declaration
var organizationName: String { get }
get · iOS 9.0+

phoneNumbers

TypeScript
get phoneNumbers(): Array<CNLabeledValue<CNPhoneNumber>>
Swift declaration
var phoneNumbers: [CNLabeledValue<CNPhoneNumber>] { get }
get · iOS 9.0+

phoneticFamilyName

TypeScript
get phoneticFamilyName(): string
Swift declaration
var phoneticFamilyName: String { get }
get · iOS 9.0+

phoneticGivenName

TypeScript
get phoneticGivenName(): string
Swift declaration
var phoneticGivenName: String { get }
get · iOS 9.0+

phoneticMiddleName

TypeScript
get phoneticMiddleName(): string
Swift declaration
var phoneticMiddleName: String { get }
get · iOS 10.0+

phoneticOrganizationName

TypeScript
get phoneticOrganizationName(): string
Swift declaration
var phoneticOrganizationName: String { get }
get · iOS 9.0+

postalAddresses

TypeScript
get postalAddresses(): Array<CNLabeledValue<CNPostalAddress>>
Swift declaration
var postalAddresses: [CNLabeledValue<CNPostalAddress>] { get }
get · iOS 9.0+

previousFamilyName

TypeScript
get previousFamilyName(): string
Swift declaration
var previousFamilyName: String { get }
get · iOS 9.0+

socialProfiles

TypeScript
get socialProfiles(): Array<CNLabeledValue<CNSocialProfile>>
Swift declaration
var socialProfiles: [CNLabeledValue<CNSocialProfile>] { get }
get · iOS 9.0+

thumbnailImageData

TypeScript
get thumbnailImageData(): (ArrayBuffer) | null
Swift declaration
var thumbnailImageData: Data? { get }
get · iOS 9.0+

urlAddresses

TypeScript
get urlAddresses(): Array<CNLabeledValue<_Foundation_NSString>>
Swift declaration
var urlAddresses: [CNLabeledValue<NSString>] { get }

Skipped declarations

No declarations were skipped in this snapshot.

All Contacts types →