Schema Name |
|
Declared in |
|
Data Classes |
|
Availability | Available in Mac OS X v10.4 and later. |
The Contacts schema is used to represent a database of contact information—information about people and companies—where contacts can be grouped hierarchically. These entities are used by many Apple Applications including Address Book, Mail, and iChat. Address Book is the primary end-user application used to author contacts, so caution should be taken when modifying contact records from other applications.
Figure 1 illustrates the entities, attributes, and relationships contained in the Contacts schema.
Entity name |
|
Data class |
|
Availability | Available in Mac OS X v10.5 and later. |
A protocol-independent location for a user's calendar.
Attribute | Type | Description |
---|---|---|
|
| The type of URI. Possible values are Available in Mac OS X v10.5 and later. |
|
| The label used to display this attribute. Available in Mac OS X v10.5 and later. |
|
| The protocol-independent location for this calendar—for example, Available in Mac OS X v10.5 and later. |
Relationship | Targets | Description |
---|---|---|
| Contact | The contact that this record belongs to. Available in Mac OS X v10.5 and later. |
Entity name |
|
Data class |
|
Availability | Available in Mac OS X v10.4 and later. |
A Contact contains information about a person or company including its name, phone numbers, email addresses, street address, instant message accounts, important dates, and an image used for display. Below are the attributes and relationships of a Contact record.
Attribute | Type | Description |
---|---|---|
|
| This contact’s birthday. Available in Mac OS X v10.4 and later. |
|
| This contact’s company or organization name, if applicable. Available in Mac OS X v10.4 and later. |
|
| A phonetic representation of this contact’s company or organization name. Available in Mac OS X v10.4 and later. |
|
| This contact’s department name within a company, if applicable. Available in Mac OS X v10.4 and later. |
|
| Specifies how to display this contact. Possible values are Available in Mac OS X v10.4 and later. |
|
| Specifies the order of the first and last names. Possible values are Available in Mac OS X v10.4 and later. |
|
| This contact’s first name. Available in Mac OS X v10.4 and later. |
|
| A phonetic representation of this contact’s first name. Available in Mac OS X v10.4 and later. |
|
| This contact’s hobby. Available in Mac OS X v10.4 and later. |
|
| An image representing this contact. Available in Mac OS X v10.4 and later. |
|
| This contact’s job title, if applicable. Available in Mac OS X v10.4 and later. |
|
| This contact’s last name. Available in Mac OS X v10.4 and later. |
|
| A phonetic representation of this contact’s last name. Available in Mac OS X v10.4 and later. |
|
| This contact’s maiden name, if applicable. Available in Mac OS X v10.4 and later. |
|
| This contact’s middle name. Available in Mac OS X v10.4 and later. |
|
| A phonetic representation of this contact’s middle name. Available in Mac OS X v10.4 and later. |
|
| This contact’s nickname if applicable. Available in Mac OS X v10.4 and later. |
|
| Miscellaneous notes about this contact. Available in Mac OS X v10.4 and later. |
|
| This contact’s short name. Can be any string—for example, a login name. Available in Mac OS X v10.4 and later. |
|
| Suffix appended to this contact’s name, such as “Sr.,” “Jr.,” “III,” or “Esq.” Available in Mac OS X v10.4 and later. |
|
| A company’s ticker symbol—for example, AAPL for Apple Computer. Available in Mac OS X v10.4 and later. |
|
| Title in front of this contact’s name, such as “Mr.,” “Mrs.,” “General,” “Cardinal,” or “Lord.” Available in Mac OS X v10.4 and later. |
Relationship | Targets | Description |
---|---|---|
| Calendar URI | One or more calendars belonging to this contact. Available in Mac OS X v10.5 and later. |
| Custom Field | Custom fields associated with this contact. Available in Mac OS X v10.4 and later. |
| Date | Miscellaneous dates associated with this contact, such as a spouse’s birthday or a wedding anniversary. Available in Mac OS X v10.4 and later. |
| Email Address | Email addresses for this contact. Available in Mac OS X v10.4 and later. |
| IM | This contact’s instant message accounts. Available in Mac OS X v10.4 and later. |
| Group | Groups that contain this contact. Available in Mac OS X v10.4 and later. |
| Phone Number | Phone numbers for this contact. Available in Mac OS X v10.4 and later. |
| CalendarURI | The primary calendar belonging to this contact. Available in Mac OS X v10.5 and later. |
| Custom Field | The primary custom field associated with this contact. Available in Mac OS X v10.4 and later. |
| Date | The primary date associated with this contact—for example, a birthday. Available in Mac OS X v10.4 and later. |
| Email Address | This contact’s primary email address. Available in Mac OS X v10.4 and later. |
| IM | This contact’s primary instant message account. Available in Mac OS X v10.4 and later. |
| Phone Number | This contact’s primary phone number. Available in Mac OS X v10.4 and later. |
| Related Name | The primary person this contact is related to—for example, a spouse. Available in Mac OS X v10.4 and later. |
| Street Address | The primary mailing address for this contact. Available in Mac OS X v10.4 and later. |
| Primary URL | The primary URL associated with this contact. Available in Mac OS X v10.4 and later. |
| Related Name | Names of people related to this contact. Available in Mac OS X v10.4 and later. |
| Street Address | Mailing addresses for this contact. Available in Mac OS X v10.4 and later. |
| URL | URLs associated with this contact. Available in Mac OS X v10.4 and later. |
Entity name |
|
Data class |
|
Availability | Available in Mac OS X v10.4 and later. |
A custom field about a contact. Simply a key-value pair where both the key and the value are strings. Below are the attributes and relationships of a Custom Field record.
Attribute | Type | Description |
---|---|---|
|
| The label used to display this attribute. Available in Mac OS X v10.4 and later. |
|
| The value of this attribute. Available in Mac OS X v10.4 and later. |
Relationship | Targets | Description |
---|---|---|
| Contact | The contact that this record belongs to. Available in Mac OS X v10.4 and later. |
Entity name |
|
Data class |
|
Availability | Available in Mac OS X v10.4 and later. |
Represents an important date, other than a birthday, associated with a contact. Below are the attributes and relationships of a Date record.
Attribute | Type | Description |
---|---|---|
|
| A label used to display this attribute when the Available in Mac OS X v10.4 and later. |
|
| The type of date. Possible values are Available in Mac OS X v10.4 and later. |
|
| The date of the event. Available in Mac OS X v10.4 and later. |
Relationship | Targets | Description |
---|---|---|
| Contact | The contact that this record belongs to. Available in Mac OS X v10.4 and later. |
Entity name |
|
Data class |
|
Availability | Available in Mac OS X v10.4 and later. |
Represents a contact’s email address. Below are the attributes and relationships of a Email Address record.
Attribute | Type | Description |
---|---|---|
|
| A label used to display this attribute when the Available in Mac OS X v10.4 and later. |
|
| The type of email address. Possible values are Available in Mac OS X v10.4 and later. |
|
| The email address. Available in Mac OS X v10.4 and later. |
Relationship | Targets | Description |
---|---|---|
| Contact | The contact that this record belongs to. Available in Mac OS X v10.4 and later. |
Entity name |
|
Data class |
|
Availability | Available in Mac OS X v10.4 and later. |
A collection of contacts and/or groups. Allows nonstrict hierarchical organization of contacts—contacts and groups can belong to multiple groups. Also supports phone, email, and street address distribution lists. Below are the attributes and relationships of a Group record.
Attribute | Type | Description |
---|---|---|
|
| The name of this group. Available in Mac OS X v10.4 and later. |
Relationship | Targets | Description |
---|---|---|
| Email Address | Email addresses for this group used as a distribution list. Available in Mac OS X v10.4 and later. |
| Phone Number | Phone numbers for this group used as a distribution list. Available in Mac OS X v10.4 and later. |
| Street Address | Street addresses for this group used as a distribution list. Available in Mac OS X v10.4 and later. |
| Contact, Group | Contacts and subgroups belonging to this group. Available in Mac OS X v10.4 and later. |
| Group | Groups that contain this group. Available in Mac OS X v10.4 and later. |
Entity name |
|
Data class |
|
Availability | Available in Mac OS X v10.4 and later. |
A contact’s instant message account. Below are the attributes and relationships of an IM record.
Attribute | Type | Description |
---|---|---|
|
| A label used to display this attribute when the Available in Mac OS X v10.4 and later. |
|
| The type of instant message services. Possible values are Available in Mac OS X v10.4 and later. |
|
| The type of account. Possible values are Available in Mac OS X v10.4 and later. |
|
| The instant message account name. Available in Mac OS X v10.4 and later. |
Relationship | Targets | Description |
---|---|---|
| Contact | The contact that this record belongs to. Available in Mac OS X v10.4 and later. |
Entity name |
|
Data class |
|
Availability | Available in Mac OS X v10.4 and later. |
Represents a contact’s phone number. Below are the attributes and relationships of a Phone Number record.
Attribute | Type | Description |
---|---|---|
|
| A label used to display this attribute when Available in Mac OS X v10.4 and later. |
|
| Specifies the type of phone number. Possible values are Available in Mac OS X v10.4 and later. |
|
| The phone number. Available in Mac OS X v10.4 and later. |
Relationship | Targets | Description |
---|---|---|
| Contact | The contact that this record belongs to. Available in Mac OS X v10.4 and later. |
Entity name |
|
Data class |
|
Availability | Available in Mac OS X v10.4 and later. |
A name of a person that is related to a contact such as the name of a spouse or children. Below are the attributes and relationships of a Related Name record.
Attribute | Type | Description |
---|---|---|
|
| A label used to display this attribute when the Available in Mac OS X v10.4 and later. |
|
| The type of this related name. Possible values are Available in Mac OS X v10.4 and later. |
|
| The name of the related person. Available in Mac OS X v10.4 and later. |
Relationship | Targets | Description |
---|---|---|
| Contact | The contact that this record belongs to. Available in Mac OS X v10.4 and later. |
Entity name |
|
Data class |
|
Availability | Available in Mac OS X v10.4 and later. |
Represents a contact’s mailing address. Below are the attributes and relationships of a Street Address record.
Attribute | Type | Description |
---|---|---|
|
| The city part of this address. Available in Mac OS X v10.4 and later. |
|
| The country part of this address Available in Mac OS X v10.4 and later. |
|
| The code for the country. Available in Mac OS X v10.4 and later. |
|
| A label used to display this attribute when the Available in Mac OS X v10.4 and later. |
|
| The zip code part of this address. Available in Mac OS X v10.4 and later. |
|
| The state part of this address. Available in Mac OS X v10.4 and later. |
|
| The street part of this address. Available in Mac OS X v10.4 and later. |
|
| The type of address. Possible values are Available in Mac OS X v10.4 and later. |
Relationship | Targets | Description |
---|---|---|
| Contact | The contact that this record belongs to. Available in Mac OS X v10.4 and later. |
Entity name |
|
Data class |
|
Availability | Available in Mac OS X v10.4 and later. |
Link to a website about or associated with a contact. Below are the attributes and relationships of a URL record.
Attribute | Type | Description |
---|---|---|
|
| A label used to display this attribute when the Available in Mac OS X v10.4 and later. |
|
| The type of URL. Possible values are Available in Mac OS X v10.4 and later. |
|
| The URL for this attribute. Available in Mac OS X v10.4 and later. |
Relationship | Targets | Description |
---|---|---|
| Contact | The contact that this record belongs to. Available in Mac OS X v10.4 and later. |
Last updated: 2009-07-07