Interface CNContact

An object that stores information about a single contact, such as the contact's first name, phone numbers, and addresses.

interface CNContact {
    contactType?: "Person" | "Organization";
    departmentName?: string;
    emailAddresses?: string[];
    givenName?: string;
    identifier?: string;
    jobTitle?: string;
    middleName?: string;
    namePrefix?: string;
    nameSuffix?: string;
    nickname?: string;
    note?: string;
    organizationName?: string;
    phoneNumbers?: string[];
    phoneticFamilyName?: string;
    phoneticGivenName?: string;
    phoneticMiddleName?: string;
    phoneticOrganizationName?: string;
    previousFamilyName?: string;
    urlAddresses?: string[];
}

Properties

contactType? departmentName? emailAddresses? givenName? identifier? jobTitle? middleName? namePrefix? nameSuffix? nickname? note? organizationName? phoneNumbers? phoneticFamilyName? phoneticGivenName? phoneticMiddleName? phoneticOrganizationName? previousFamilyName? urlAddresses?

Properties

Optional contactType

contactType?: "Person" | "Organization"

the contact type.

Optional departmentName

departmentName?: string

The name of the department associated with the contact.

Optional emailAddresses

emailAddresses?: string[]

An array of email addresses for the contact.

Optional givenName

givenName?: string

The given name of the contact.

The given name is often known as the first name of the contact.

Optional identifier

identifier?: string

A value that uniquely identifies a contact on the device.

It is recommended that you use the identifier when re-fetching the contact. An identifier can be persisted between the app launches. Note that this identifier only uniquely identifies the contact on the current device.

Optional jobTitle

jobTitle?: string

The contact’s job title.

Optional middleName

middleName?: string

The middle name of the contact.

Optional namePrefix

namePrefix?: string

The name prefix of the contact.

Optional nameSuffix

nameSuffix?: string

The name suffix of the contact.

Optional nickname

nickname?: string

Nickname

Optional note

note?: string

A string containing notes for the contact.

Optional organizationName

organizationName?: string

The name of the organization associated with the contact.

Optional phoneNumbers

phoneNumbers?: string[]

An array of phone numbers for a contact.

Optional phoneticFamilyName

phoneticFamilyName?: string

Optional phoneticGivenName

phoneticGivenName?: string

Optional phoneticMiddleName

phoneticMiddleName?: string

Optional phoneticOrganizationName

phoneticOrganizationName?: string

Optional previousFamilyName

previousFamilyName?: string

A string for the previous family name of the contact.

The previous family name is often known as the maiden name of the contact.

Optional urlAddresses

urlAddresses?: string[]

An array of URL addresses for a contact.

Settings

Member Visibility

Theme

On This Page

contactTypedepartmentNameemailAddressesgivenNameidentifierjobTitlemiddleNamenamePrefixnameSuffixnicknamenoteorganizationNamephoneNumbersphoneticFamilyNamephoneticGivenNamephoneticMiddleNamephoneticOrganizationNamepreviousFamilyNameurlAddresses