Avaya Client Services API Reference (OS X)
Instance Methods | Properties | List of all members
CSEditableContact Class Reference

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...
 
CSEditableContactStringFieldasciiLastName
 The non-localized last name. More...
 
CSEditableContactStringFieldasciiFirstName
 The non-localized first name. More...
 
CSEditableContactStringFieldasciiDisplayName
 The non-localized display name. More...
 
CSEditableContactStringFieldasciiAlias
 The non-localized alias. More...
 
CSEditableContactStringFieldfirstName
 The native first name. More...
 
CSEditableContactStringFieldlastName
 The native last name. More...
 
CSEditableContactStringFielddisplayName
 The native display name. More...
 
CSEditableContactStringFieldalias
 The native alias. More...
 
CSEditableContactStringFieldstreetAddress
 The street address. More...
 
CSEditableContactStringFieldcity
 The city. More...
 
CSEditableContactStringFieldstate
 The state. More...
 
CSEditableContactStringFieldcountry
 The country. More...
 
CSEditableContactStringFieldpostalCode
 The postal code. More...
 
CSEditableContactStringFieldmanager
 The name of a person who is a supervisor. More...
 
CSEditableContactStringFieldtitle
 The title or company role. More...
 
CSEditableContactStringFieldlanguage
 The language is per contact record. More...
 
CSEditableContactStringFieldcompany
 The company. More...
 
CSEditableContactStringFielddepartment
 The department. More...
 
CSEditableContactStringFieldnotes
 The notes field. More...
 
CSEditableContactDoubleFieldrank
 The rank field defining the contact sorting order. More...
 
CSEditableContactStringFieldListcustom1
 The list of custom1 values. More...
 
CSEditableContactStringFieldListcustom2
 The list of custom2 values. More...
 
CSEditableContactStringFieldListcustom3
 The list of custom3 values. More...
 
CSEditableContactStringFieldlocation
 The location. More...
 
CSEditableContactPhoneFieldListphoneNumbers
 The list of phone numbers. More...
 
CSEditableContactEmailFieldListemailAddresses
 The list of email addresses. More...
 
CSEditableContactIMAddressFieldListIMAddresses
 Contact's list of instant messaging addresses. More...
 
CSEditableContactBoolFieldfavorite
 The favorite flag. More...
 
CSEditableContactBoolFieldisBuddy
 The buddy flag. More...
 
CSEditableContactBoolFieldisVIP
 The VIP flag. More...
 
CSContactBoolFieldvideoCapable
 
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...
 
CSContactStringFieldasciiLastName
 The non-localized last name. More...
 
CSContactStringFieldasciiFirstName
 The non-localized first name. More...
 
CSContactStringFieldasciiDisplayName
 The non-localized display name. More...
 
CSContactStringFieldasciiAlias
 The non-localized alias. More...
 
CSContactStringFieldfirstName
 The native first name. More...
 
CSContactStringFieldlastName
 The native last name. More...
 
CSContactStringFielddisplayName
 The native display name. More...
 
CSContactStringFieldalias
 The native alias. More...
 
CSContactStringFieldstreetAddress
 The street address. More...
 
CSContactStringFieldcity
 The city. More...
 
CSContactStringFieldstate
 The state. More...
 
CSContactStringFieldcountry
 The country. More...
 
CSContactStringFieldpostalCode
 The postal code. More...
 
CSContactStringFieldmanager
 The name of a person who is a supervisor. More...
 
CSContactStringFieldtitle
 The title or company role. More...
 
CSContactStringFieldlanguage
 The language is per contact record. More...
 
CSContactStringFieldcompany
 The company. More...
 
CSContactStringFielddepartment
 The department. More...
 
CSContactStringFieldnotes
 The notes field. More...
 
CSContactDoubleFieldrank
 The rank field defining the contact sorting order. More...
 
CSContactStringFieldListcustom1
 The list of custom1 values. More...
 
CSContactStringFieldListcustom2
 The list of custom2 values. More...
 
CSContactStringFieldListcustom3
 The list of custom3 values. More...
 
CSContactStringFieldlocation
 The location. More...
 
CSContactPhoneFieldListphoneNumbers
 The list of phone numbers. More...
 
CSContactEmailFieldListemailAddresses
 The list of email addresses. More...
 
CSContactIMAddressFieldListIMAddresses
 Contact's list of instant messaging addresses. More...
 
CSContactBoolFieldfavorite
 The favorite flag. More...
 
CSContactBoolFieldisBuddy
 The buddy flag. More...
 
CSContactBoolFieldisVIP
 The VIP flag. More...
 
CSContactBoolFieldvideoCapable
 
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.

  1. A savable contact has 1 name (first, last), and at least 1 address (phone number, email).
  2. 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.

Returns
Contact bool field containing the VIP flag.
- (CSEditableContactStringField*) language
readnonatomicassign

The language is per contact record.

Returns
Contact string field containing the language is per contact record.
- (CSEditableContactStringField*) lastName
readnonatomicassign

The native last name.

Returns
Contact string field containing the native last name.
- (CSEditableContactStringField*) location
readnonatomicassign

The location.

Returns
Contact string field containing the location.
- (CSEditableContactStringField*) 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.
- (CSEditableContactStringField*) notes
readnonatomicassign

The notes field.

Returns
Contact string field containing the notes field.
- (CSEditableContactPhoneFieldList*) phoneNumbers
readnonatomicassign

The list of phone numbers.

Returns
Contact multi value field containing list of phone numbers.
- (CSEditableContactStringField*) postalCode
readnonatomicassign

The postal code.

Returns
Contact string field containing the postal code.
- (CSEditableContactDoubleField*) rank
readnonatomicassign

The rank field defining the contact sorting order.

Returns
Non-negative double value. 0.0 value means "No rank".
- (CSEditableContactStringField*) state
readnonatomicassign

The state.

Returns
Contact string field containing the state.
- (CSEditableContactStringField*) streetAddress
readnonatomicassign

The street address.

Returns
Contact string field containing the street address.
- (CSEditableContactStringField*) title
readnonatomicassign

The title or company role.

Returns
Contact string field containing the title or company role.
- (NSString*) uniqueAddressForMatching
readnonatomicassign

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 class was generated from the following file: