Mutable contact object which exposes all provided contact details. More...

#import <CSEditableContact.h>

Inherits NSObject, and <CSContact>.

Instance Methods
(BOOL)	- canAddPhoneNumberOfType:

(BOOL)	- canAddEmailAddressOfType:

Properties
NSString *	uniqueAddressForMatching
	The matching/merging address. More...

CSEditableContactStringField *	asciiLastName
	The non-localized last name. More...

CSEditableContactStringField *	asciiFirstName
	The non-localized first name. More...

CSEditableContactStringField *	asciiDisplayName
	The non-localized display name. More...

CSEditableContactStringField *	asciiAlias
	The non-localized alias. More...

CSEditableContactStringField *	firstName
	The native first name. More...

CSEditableContactStringField *	lastName
	The native last name. More...

CSEditableContactStringField *	displayName
	The native display name. More...

CSEditableContactStringField *	alias
	The native alias. More...

CSEditableContactStringField *	streetAddress
	The street address. More...

CSEditableContactStringField *	city
	The city. More...

CSEditableContactStringField *	state
	The state. More...

CSEditableContactStringField *	country
	The country. More...

CSEditableContactStringField *	postalCode
	The postal code. More...

CSEditableContactStringField *	manager
	The name of a person who is a supervisor. More...

CSEditableContactStringField *	title
	The title or company role. More...

CSEditableContactStringField *	language
	The language is per contact record. More...

CSEditableContactStringField *	company
	The company. More...

CSEditableContactStringField *	department
	The department. More...

CSEditableContactStringField *	notes
	The notes field. More...

CSEditableContactDoubleField *	rank
	The rank field defining the contact sorting order. More...

CSEditableContactStringFieldList *	custom1
	The list of custom1 values. More...

CSEditableContactStringFieldList *	custom2
	The list of custom2 values. More...

CSEditableContactStringFieldList *	custom3
	The list of custom3 values. More...

CSEditableContactStringField *	location
	The location. More...

CSEditableContactPhoneFieldList *	phoneNumbers
	The list of phone numbers. More...

CSEditableContactEmailFieldList *	emailAddresses
	The list of email addresses. More...

CSEditableContactIMAddressFieldList *	IMAddresses
	Contact's list of instant messaging addresses. More...

CSEditableContactBoolField *	favorite
	The favorite flag. More...

CSEditableContactBoolField *	isBuddy
	The buddy flag. More...

CSEditableContactBoolField *	isVIP
	The VIP flag. More...

CSContactBoolField *	videoCapable

BOOL	isContactSavable
	Returns Contact capabilities to save the current state of the contact. More...

BOOL	isExtendedContactDetailsAvailable

BOOL	canAddEmailAddress

BOOL	canAddIMAddress

NSDictionary *	extraFields
	The list extra fields used for local contacts. More...

Properties inherited from <CSContact>
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

Mutable contact object which exposes all provided contact details.

CSEditableContact can be created by using either createEditableContact (CSContactService) or createEditableContactFromContact: (CSContactService). Second method needs a regular contact as a source for data.

EditableContact can be used in two contact service methods - addContact:completionHandler: (CSContactService) and updateContact:completionHandler: (CSContactService).

Method Documentation

- (BOOL) canAddEmailAddressOfType: (CSContactEmailAddressType) type

- (BOOL) canAddPhoneNumberOfType: (CSContactPhoneNumberType) type

Reimplemented from <CSContact>.

Property Documentation

- (CSEditableContactStringField*) alias

readnonatomicassign

The native alias.

Returns: Contact string field containing the native alias.

- (CSEditableContactStringField*) asciiAlias

readnonatomicassign

The non-localized alias.

Returns: Contact string field containing a non-localized alias.

- (CSEditableContactStringField*) asciiDisplayName

readnonatomicassign

The non-localized display name.

Returns: Contact string field containing non-localized display name.

- (CSEditableContactStringField*) asciiFirstName

readnonatomicassign

The non-localized first name.

Returns: Contact string field containing non-localized first name.

- (CSEditableContactStringField*) asciiLastName

readnonatomicassign

The non-localized last name.

Returns: Contact string field containing non-localized last name.

- (BOOL) canAddEmailAddress

readnonatomicassign

- (BOOL) canAddIMAddress

readnonatomicassign

- (CSEditableContactStringField*) city

readnonatomicassign

The city.

Returns: Contact string field containing the city.

- (CSEditableContactStringField*) company

readnonatomicassign

The company.

Returns: Contact string field containing the company.

- (CSEditableContactStringField*) country

readnonatomicassign

The country.

Returns: Contact string field containing the country.

- (CSEditableContactStringFieldList*) custom1

readnonatomicassign

The list of custom1 values.

Returns: list of custom1 values.

- (CSEditableContactStringFieldList*) custom2

readnonatomicassign

The list of custom2 values.

Returns: list of custom2 values.

- (CSEditableContactStringFieldList*) custom3

readnonatomicassign

The list of custom3 values.

Returns: list of custom3 values.

- (CSEditableContactStringField*) department

readnonatomicassign

The department.

Returns: Contact string field containing the department.

- (CSEditableContactStringField*) displayName

readnonatomicassign

The native display name.

Returns: Contact string field containing the native display name.

- (CSEditableContactEmailFieldList*) 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.

- (CSEditableContactBoolField*) favorite

readnonatomicassign

The favorite flag.

Returns: Contact bool field containing the favorite flag.

- (CSEditableContactStringField*) firstName

readnonatomicassign

The native first name.

Returns: Contact string field containing the native first name.

- (CSEditableContactIMAddressFieldList*) IMAddresses

readnonatomicassign

Contact's list of instant messaging addresses.

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

- (CSEditableContactBoolField*) isBuddy

readnonatomicassign

The buddy flag.

Used for presence feature purpose.

Returns: Contact bool field containing the buddy flag.

- (BOOL) isContactSavable

readnonatomicassign

Returns Contact capabilities to save the current state of the contact.

A savable contact has 1 name (first, last), and at least 1 address (phone number, email).
Also cannot break any rules for the maximum number of phone numbers, email addresses etc. for a provider.
Returns
YES if it's possible to save Contact with current state of values, NO if not.

- (BOOL) isExtendedContactDetailsAvailable

readnonatomicassign

- (CSEditableContactBoolField*) isVIP

readnonatomicassign

The VIP flag.