<CSContact> Protocol Reference

Protocol used as a common interface for read-only and editable contacts. More...

#import <CSContactProtocol.h>

Inherits <NSObject>.

Inherited by CSContact, and CSEditableContact.

Instance Methods
(BOOL)	- canAddPhoneNumberOfType:

Properties
NSString *	uniqueAddressForMatching
	The matching/merging address. More...
CSContactStringField *	asciiLastName
	The non-localized last name. More...
CSContactStringField *	asciiFirstName
	The non-localized first name. More...
CSContactStringField *	asciiDisplayName
	The non-localized display name. More...
CSContactStringField *	asciiAlias
	The non-localized alias. More...
CSContactStringField *	firstName
	The native first name. More...
CSContactStringField *	lastName
	The native last name. More...
CSContactStringField *	displayName
	The native display name. More...
CSContactStringField *	alias
	The native alias. More...
CSContactStringField *	streetAddress
	The street address. More...
CSContactStringField *	city
	The city. More...
CSContactStringField *	state
	The state. More...
CSContactStringField *	country
	The country. More...
CSContactStringField *	postalCode
	The postal code. More...
CSContactStringField *	manager
	The name of a person who is a supervisor. More...
CSContactStringField *	title
	The title or company role. More...
CSContactStringField *	language
	The language is per contact record. More...
CSContactStringField *	company
	The company. More...
CSContactStringField *	department
	The department. More...
CSContactStringField *	notes
	The notes field. More...
CSContactDoubleField *	rank
	The rank field defining the contact sorting order. More...
CSContactStringFieldList *	custom1
	The list of custom1 values. More...
CSContactStringFieldList *	custom2
	The list of custom2 values. More...
CSContactStringFieldList *	custom3
	The list of custom3 values. More...
CSContactStringField *	location
	The location. More...
CSContactPhoneFieldList *	phoneNumbers
	The list of phone numbers. More...
CSContactEmailFieldList *	emailAddresses
	The list of email addresses. More...
CSContactIMAddressFieldList *	IMAddresses
	Contact's list of instant messaging addresses. More...
CSContactBoolField *	favorite
	The favorite flag. More...
CSContactBoolField *	isBuddy
	The buddy flag. More...
CSContactBoolField *	isVIP
	The VIP flag. More...
CSContactBoolField *	videoCapable
BOOL	isExtendedContactDetailsAvailable
BOOL	canAddEmailAddress
BOOL	canAddIMAddress
NSDictionary *	extraFields
	The list extra fields used for local contacts. More...

Detailed Description

Protocol used as a common interface for read-only and editable contacts.

Method Documentation

- (BOOL) canAddPhoneNumberOfType:

(CSContactPhoneNumberType)

type

Reimplemented in CSContact, and CSEditableContact.

Property Documentation

- (CSContactStringField*) alias

readnonatomicassign

The native alias.

Returns

Contact string field containing the native alias.

- (CSContactStringField*) asciiAlias

readnonatomicassign

The non-localized alias.

Returns

Contact string field containing a non-localized alias.

- (CSContactStringField*) asciiDisplayName

readnonatomicassign

The non-localized display name.

Returns

Contact string field containing non-localized display name.

- (CSContactStringField*) asciiFirstName

readnonatomicassign

The non-localized first name.

Returns

Contact string field containing non-localized first name.

- (CSContactStringField*) asciiLastName

readnonatomicassign

The non-localized last name.

Returns

Contact string field containing non-localized last name.

- (BOOL) canAddEmailAddress

readnonatomicassign

- (BOOL) canAddIMAddress

readnonatomicassign

- (CSContactStringField*) city

readnonatomicassign

The city.

Returns

Contact string field containing the city.

- (CSContactStringField*) company

readnonatomicassign

The company.

Returns

Contact string field containing the company.

- (CSContactStringField*) country

readnonatomicassign

The country.

Returns

Contact string field containing the country.

- (CSContactStringFieldList*) custom1

readnonatomicassign

The list of custom1 values.

Returns

list of custom1 values.

- (CSContactStringFieldList*) custom2

readnonatomicassign

The list of custom2 values.

Returns

list of custom2 values.

- (CSContactStringFieldList*) custom3

readnonatomicassign

The list of custom3 values.

Returns

list of custom3 values.

- (CSContactStringField*) department

readnonatomicassign

The department.

Returns

Contact string field containing the department.

- (CSContactStringField*) displayName

readnonatomicassign

The native display name.

Returns

Contact string field containing the native display name.

- (CSContactEmailFieldList*) emailAddresses

readnonatomicassign

The list of email addresses.

Returns

Contact multi value field containing list of email addresses.

- (NSDictionary*) extraFields

readnonatomicassign

The list extra fields used for local contacts.

Returns empty NSDictionary if underlying object is CSEditableContact.

- (CSContactBoolField*) favorite

readnonatomicassign

The favorite flag.

Returns

Contact bool field containing the favorite flag.

- (CSContactStringField*) firstName

readnonatomicassign

The native first name.

Returns

Contact string field containing the native first name.

- (CSContactIMAddressFieldList*) IMAddresses

readnonatomicassign

Contact's list of instant messaging addresses.

Returns

Contact multi value field containing list of instant messaging addresses..

- (CSContactBoolField*) isBuddy

readnonatomicassign

The buddy flag.

Used for presence feature purpose.

Returns

Contact bool field containing the buddy flag.

- (BOOL) isExtendedContactDetailsAvailable

readnonatomicassign

- (CSContactBoolField*) isVIP

readnonatomicassign

The VIP flag.

Returns

Contact bool field containing the VIP flag.

- (CSContactStringField*) language

readnonatomicassign

The language is per contact record.

Returns

Contact string field containing the language is per contact record.

- (CSContactStringField*) lastName

readnonatomicassign

The native last name.

Returns

Contact string field containing the native last name.

- (CSContactStringField*) location

readnonatomicassign

The location.

Returns

Contact string field containing the location.

- (CSContactStringField*) manager

readnonatomicassign

The name of a person who is a supervisor.

Returns

Contact string field containing the name of a person who is a supervisor.

- (CSContactStringField*) notes

readnonatomicassign

The notes field.

Returns

Contact string field containing the notes field.

- (CSContactPhoneFieldList*) phoneNumbers

readnonatomicassign

The list of phone numbers.

Returns

Contact multi value field containing list of phone numbers.

- (CSContactStringField*) postalCode

readnonatomicassign

The postal code.

Returns

Contact string field containing the postal code.

- (CSContactDoubleField*) rank

readnonatomicassign

The rank field defining the contact sorting order.

Returns

Non-negative double value. 0.0 value means "No rank".

- (CSContactStringField*) state

readnonatomicassign

The state.

Returns

Contact string field containing the state.

- (CSContactStringField*) streetAddress

readnonatomicassign

The street address.

Returns

Contact string field containing the street address.

- (CSContactStringField*) title

readnonatomicassign

The title or company role.

Returns

Contact string field containing the title or company role.

- (NSString*) uniqueAddressForMatching

readrequirednonatomicassign

The matching/merging address.

That parameter can be used as a record’s unique id.

Returns

Contact string field containing the matching/merging address.

- (CSContactBoolField*) videoCapable

readnonatomicassign

---

The documentation for this protocol was generated from the following file:

• CSContactProtocol.h