Constructor
-
new EditableContact()
-
Mutable contact object which exposes all provided contact details.
EditableContact can be created by using either Contacts.createEditableContact() or Contacts.createEditableContactFromContact(). The second function needs a regular contact as a source of data.
EditableContact can be used in two contact service functions: Contacts.addContact() and Contacts.updateContact().
Methods
-
getAlias() → {AvayaClientServices.Services.Contacts.EditableContactStringField}
-
Returns the alias of the contact.
Returns:
-
getASCIIDisplayName() → {AvayaClientServices.Services.Contacts.EditableContactStringField}
-
Returns the non-localized display name of the contact.
If a contact has both localized and non-localized versions of display name specified, EditableContact.getDisplayName() returns the localized one and EditableContact.getASCIIDisplayName() returns the non-localized one.
If a contact has only one version of display name specified, EditableContact.getDisplayName() returns the specified display name and EditableContact.getASCIIDisplayName() returns empty string.
Returns:
-
getASCIIFirstName() → {AvayaClientServices.Services.Contacts.EditableContactStringField}
-
Returns the non-localized first name of the contact.
If a contact has both localized and non-localized versions of first name specified, EditableContact.getFirstName() returns the localized one and EditableContact.getASCIIFirstName() returns the non-localized one.
If a contact has only one version of first name specified, EditableContact.getFirstName() returns the specified given name and EditableContact.getASCIIFirstName() returns empty string.
Returns:
-
getASCIILastName() → {AvayaClientServices.Services.Contacts.EditableContactStringField}
-
Returns the non-localized surname of the contact.
If a contact has both localized and non-localized versions of surname specified, EditableContact.getLastName() returns the localized one and EditableContact.getASCIILastName() returns the non-localized one.
If a contact has only one version of surname specified, EditableContact.getLastName() returns the specified surname and EditableContact.getASCIILastName() returns empty string.
Returns:
-
getCity() → {AvayaClientServices.Services.Contacts.EditableContactStringField}
-
Returns the city.
Returns:
-
getCompany() → {AvayaClientServices.Services.Contacts.EditableContactStringField}
-
Returns the company.
Returns:
-
getCountry() → {AvayaClientServices.Services.Contacts.EditableContactStringField}
-
Returns the country.
Returns:
-
getCustom1() → {AvayaClientServices.Services.Contacts.ContactFieldList.<AvayaClientServices.Services.Contacts.EditableContactStringField>}
-
Returns the list of Custom 1 fields.
Returns:
-
getCustom2() → {AvayaClientServices.Services.Contacts.ContactFieldList.<AvayaClientServices.Services.Contacts.EditableContactStringField>}
-
Returns the list of Custom 2 fields.
Returns:
-
getCustom3() → {AvayaClientServices.Services.Contacts.ContactFieldList.<AvayaClientServices.Services.Contacts.EditableContactStringField>}
-
Returns the list of Custom 3 fields.
Returns:
-
getDepartment() → {AvayaClientServices.Services.Contacts.EditableContactStringField}
-
Returns the department.
Returns:
-
getDisplayName() → {AvayaClientServices.Services.Contacts.EditableContactStringField}
-
Returns display name of the contact.
If a contact has both localized and non-localized versions of display name specified, EditableContact.getDisplayName() returns the localized one and EditableContact.getASCIIDisplayName()} returns the non-localized one.
If a contact has only one version of display name specified, EditableContact.getDisplayName()} returns the specified display name and EditableContact.getASCIIDisplayName() returns empty string.
Returns:
-
getEmailAddresses() → {AvayaClientServices.Services.Contacts.ContactFieldList.<AvayaClientServices.Services.Contacts.EditableContactEmailAddressField>}
-
Returns the list of email addresses.
Returns:
-
getFirstName() → {AvayaClientServices.Services.Contacts.EditableContactStringField}
-
Returns first name of the contact.
If contact has both localized and non-localized versions of first name specified, EditableContact.getFirstName() returns the localized one and EditableContact.getASCIIFirstName() returns the non-localized one.
If a contact has only one version of first name specified, EditableContact.getFirstName() returns the specified given name and EditableContact.getASCIIFirstName() returns empty string.
Returns:
-
getIMAddresses() → {AvayaClientServices.Services.Contacts.ContactFieldList.<AvayaClientServices.Services.Contacts.EditableContactIMAddressField>}
-
Returns the list of handles.
Returns:
-
getLanguage() → {AvayaClientServices.Services.Contacts.EditableContactStringField}
-
Returns the preferred locale of the contact (for example, 'en_US').
Returns:
-
getLastName() → {AvayaClientServices.Services.Contacts.EditableContactStringField}
-
Returns last name of the contact.
If a contact has both localized and non-localized versions of last name specified, EditableContact.getLastName() returns the localized one and EditableContact.getASCIILastName() returns the non-localized one.
If a contact has only one version of surname specified, EditableContact.getLastName() returns the specified surname and EditableContact.getASCIILastName() returns empty string.
Returns:
-
getLocation() → {AvayaClientServices.Services.Contacts.EditableContactStringField}
-
Returns the location.
Returns:
-
getManager() → {AvayaClientServices.Services.Contacts.EditableContactStringField}
-
Returns the manager.
Returns:
-
getNotes() → {AvayaClientServices.Services.Contacts.EditableContactStringField}
-
Returns the notes of the contact.
Returns:
-
getPhoneNumbers() → {AvayaClientServices.Services.Contacts.ContactFieldList.<AvayaClientServices.Services.Contacts.EditableContactPhoneField>}
-
Returns the list of phone numbers.
Returns:
-
getPostalCode() → {AvayaClientServices.Services.Contacts.EditableContactStringField}
-
Returns the postal code.
Returns:
-
getRank() → {AvayaClientServices.Services.Contacts.EditableContactNumberField}
-
Returns the rank of the contact. This value may be used for sorting the contact list.
Can be any non-negative number (including fractional numbers).Returns:
-
getScopiaLoginId() → {AvayaClientServices.Services.Contacts.ContactStringField}
-
Returns Scopia Login ID.
This field will have an empty value in non-Scopia deployments or if this contact represents Scopia Terminal.Returns:
-
getScopiaUserId() → {AvayaClientServices.Services.Contacts.ContactStringField}
-
Returns Scopia User ID.
This field will have an empty value in non-Scopia deployments or if this contact represents Scopia Terminal.Returns:
-
getState() → {AvayaClientServices.Services.Contacts.EditableContactStringField}
-
Returns the state field.
Returns:
-
getStreetAddress() → {AvayaClientServices.Services.Contacts.EditableContactStringField}
-
Returns the street address.
Returns:
-
getUniqueAddressForMatching() → {string}
-
Returns the unique ID of the contact.
Returns:
{ string }The address used for matching/merging other contact records.
-
getWorkRoomNumber() → {AvayaClientServices.Services.Contacts.EditableContactStringField}
-
Returns the work room number.
Returns:
-
isBuddy() → {AvayaClientServices.Services.Contacts.EditableContactBooleanField}
-
Returns the buddy flag.
Returns:
-
isFavorite() → {AvayaClientServices.Services.Contacts.EditableContactBooleanField}
-
Returns the favorite flag.
Returns:
-
isVideoCapable() → {AvayaClientServices.Services.Contacts.EditableContactBooleanField}
-
Returns the video capable flag.
Returns:
Capabilities
-
getContactSavableCapability() → {AvayaClientServices.Base.Capability}
-
Returns the capability specifying if this contact contains all information required in order to add the contact to the contact list or to update the existing contact with this one.
This necessary information includes first name, last name and either phone number or email address.
Returns:
{ AvayaClientServices.Base.Capability }Capability object describing if this particular contact is savable.
-
getDeleteContactCapability() → {AvayaClientServices.Base.Capability}
-
Returns the capability indicating if this contact can be deleted from the contact list. See Contacts.deleteContact().
Returns:
{ AvayaClientServices.Base.Capability }Capability object describing whether this particular contact can be deleted or not.
-
getUpdateContactCapability() → {AvayaClientServices.Base.Capability}
-
Returns the capability indicating if this contact can be updated. See also Contacts.updateContact().
Returns:
{ AvayaClientServices.Base.Capability }Capability object describing whether this particular contact can be changed or not.