Package com.avaya.clientservices.contact
Interface EditableContact
-
- All Superinterfaces:
BaseContact
public interface EditableContact extends BaseContact
Mutable contact object which exposes all provided contact details.EditableContact can be created by using either
ContactService.createEditableContact()orContactService.createEditableContactFromContact(Contact). Second method needs a regular contact as a source for data.EditableContact can be used in two contact service methods -
ContactService.addContact(EditableContact, AddContactCompletionHandler)andContactService.updateContact(EditableContact, UpdateContactCompletionHandler).
-
-
Method Summary
-
Methods inherited from interface com.avaya.clientservices.contact.BaseContact
canAddEmailAddress, canAddEmailAddress, canAddIMAddress, canAddPhoneNumber, isExtendedContactDetailsAvailable
-
-
-
-
Method Detail
-
retrievePicture
void retrievePicture(ContactCompletionHandler handler)
-
removePictureFromCache
void removePictureFromCache()
-
getASCIILastName
EditableContactStringField getASCIILastName()
Description copied from interface:BaseContactThe non-localized last name.- Specified by:
getASCIILastNamein interfaceBaseContact- Returns:
- Contact string field containing non-localized last name.
-
getASCIIFirstName
EditableContactStringField getASCIIFirstName()
Description copied from interface:BaseContactThe non-localized first name.- Specified by:
getASCIIFirstNamein interfaceBaseContact- Returns:
- Contact string field containing non-localized first name.
-
getASCIIDisplayName
EditableContactStringField getASCIIDisplayName()
Description copied from interface:BaseContactThe non-localized display name.- Specified by:
getASCIIDisplayNamein interfaceBaseContact- Returns:
- Contact string field containing non-localized display name.
-
getASCIIAlias
EditableContactStringField getASCIIAlias()
Description copied from interface:BaseContactThe non-localized alias.- Specified by:
getASCIIAliasin interfaceBaseContact- Returns:
- Contact string field containing a non-localized alias.
-
getNativeLastName
EditableContactStringField getNativeLastName()
Description copied from interface:BaseContactThe native last name.- Specified by:
getNativeLastNamein interfaceBaseContact- Returns:
- Contact string field containing the native last name.
-
getNativeFirstName
EditableContactStringField getNativeFirstName()
Description copied from interface:BaseContactThe native first name.- Specified by:
getNativeFirstNamein interfaceBaseContact- Returns:
- Contact string field containing the native first name.
-
getNativeDisplayName
EditableContactStringField getNativeDisplayName()
Description copied from interface:BaseContactThe native display name.- Specified by:
getNativeDisplayNamein interfaceBaseContact- Returns:
- Contact string field containing the native display name.
-
getNativeAlias
EditableContactStringField getNativeAlias()
Description copied from interface:BaseContactThe native alias.- Specified by:
getNativeAliasin interfaceBaseContact- Returns:
- Contact string field containing the native alias.
-
getLocation
EditableContactStringField getLocation()
Description copied from interface:BaseContactThe location.- Specified by:
getLocationin interfaceBaseContact- Returns:
- Contact string field containing the location.
-
getStreetAddress
EditableContactStringField getStreetAddress()
Description copied from interface:BaseContactThe street address.- Specified by:
getStreetAddressin interfaceBaseContact- Returns:
- Contact string field containing the street address.
-
getCity
EditableContactStringField getCity()
Description copied from interface:BaseContactThe city.- Specified by:
getCityin interfaceBaseContact- Returns:
- Contact string field containing the city.
-
getState
EditableContactStringField getState()
Description copied from interface:BaseContactThe state.- Specified by:
getStatein interfaceBaseContact- Returns:
- Contact string field containing the state.
-
getCountry
EditableContactStringField getCountry()
Description copied from interface:BaseContactThe country.- Specified by:
getCountryin interfaceBaseContact- Returns:
- Contact string field containing the country.
-
getPostalCode
EditableContactStringField getPostalCode()
Description copied from interface:BaseContactThe postal code.- Specified by:
getPostalCodein interfaceBaseContact- Returns:
- Contact string field containing the postal code.
-
getCompany
EditableContactStringField getCompany()
Description copied from interface:BaseContactThe company.- Specified by:
getCompanyin interfaceBaseContact- Returns:
- Contact string field containing the company.
-
getDepartment
EditableContactStringField getDepartment()
Description copied from interface:BaseContactThe department.- Specified by:
getDepartmentin interfaceBaseContact- Returns:
- Contact string field containing the department.
-
getManager
EditableContactStringField getManager()
Description copied from interface:BaseContactThe name of a person who is a supervisor.- Specified by:
getManagerin interfaceBaseContact- Returns:
- Contact string field containing the name of a person who is a supervisor.
-
getTitle
EditableContactStringField getTitle()
Description copied from interface:BaseContactThe title or company role.- Specified by:
getTitlein interfaceBaseContact- Returns:
- Contact string field containing the title or company role.
-
getLanguage
EditableContactStringField getLanguage()
Description copied from interface:BaseContactThe language is per contact record.- Specified by:
getLanguagein interfaceBaseContact- Returns:
- Contact string field containing the language is per contact record.
-
getUniqueAddressForMatching
java.lang.String getUniqueAddressForMatching()
Description copied from interface:BaseContactThe matching/merging address. This parameter can be used as a record's unique id.- Specified by:
getUniqueAddressForMatchingin interfaceBaseContact- Returns:
- Contact string field containing the matching/merging address.
-
getEmailAddresses
EditableContactEmailAddressFieldList getEmailAddresses()
Description copied from interface:BaseContactThe list of email addresses.- Specified by:
getEmailAddressesin interfaceBaseContact- Returns:
- Contact multi value field containing list of email addresses.
-
getPhoneNumbers
EditableContactPhoneFieldList getPhoneNumbers()
Description copied from interface:BaseContactThe list of phone numbers.- Specified by:
getPhoneNumbersin interfaceBaseContact- Returns:
- Contact multi value field containing list of phone numbers.
-
getIMAddresses
EditableContactIMAddressFieldList getIMAddresses()
Description copied from interface:BaseContactThe list of IM addresses.- Specified by:
getIMAddressesin interfaceBaseContact- Returns:
- Contact multi value field containing list of IM addresses.
-
isBuddy
EditableContactBoolField isBuddy()
Description copied from interface:BaseContactThe buddy flag. Used for presence feature purpose.- Specified by:
isBuddyin interfaceBaseContact- Returns:
- Contact bool field containing the buddy flag.
-
isVIP
EditableContactBoolField isVIP()
Description copied from interface:BaseContactThe VIP flag.- Specified by:
isVIPin interfaceBaseContact- Returns:
- Contact bool field containing the VIP flag.
-
isFavorite
EditableContactBoolField isFavorite()
Description copied from interface:BaseContactThe favorite flag.- Specified by:
isFavoritein interfaceBaseContact- Returns:
- Contact bool field containing the favorite flag.
-
getPictureData
byte[] getPictureData()
The contact picture bytes. Picture data can be in jpeg or png format.- Returns:
- byte array containing the contact picture bytes.
-
hasPicture
boolean hasPicture()
Indicating whether contact has a picture.- Returns:
- true if contact has a picture.
-
getNotes
EditableContactStringField getNotes()
Description copied from interface:BaseContactThe notes field.- Specified by:
getNotesin interfaceBaseContact- Returns:
- Contact string field containing the notes field.
-
getRank
EditableContactDoubleField getRank()
Description copied from interface:BaseContactThe rank field defining the contact sorting order. 0.0 value means "No rank". Higher values are sorted toward top of the list.- Specified by:
getRankin interfaceBaseContact- Returns:
- Non-negative double value.
-
getCustom1
EditableContactMultiValueField<EditableContactStringField> getCustom1()
Description copied from interface:BaseContactThe list of custom1 values.- Specified by:
getCustom1in interfaceBaseContact- Returns:
- list of custom1 values.
-
getCustom2
EditableContactMultiValueField<EditableContactStringField> getCustom2()
Description copied from interface:BaseContactThe list of custom2 values.- Specified by:
getCustom2in interfaceBaseContact- Returns:
- list of custom2 values.
-
getCustom3
EditableContactMultiValueField<EditableContactStringField> getCustom3()
Description copied from interface:BaseContactThe list of custom3 values.- Specified by:
getCustom3in interfaceBaseContact- Returns:
- list of custom3 values.
-
getExtraFields
java.util.Map<java.lang.String,ContactField> getExtraFields()
Description copied from interface:BaseContactContact extra fields- Specified by:
getExtraFieldsin interfaceBaseContact- Returns:
- Map object containing contact extra fields as ContactField with String key.
Key values are in
ExtraFieldKeysclass.
-
getContactSources
java.util.Set<ContactSourceType> getContactSources()
Returns list of contact sources- Returns:
- list of contact sources
-
isContactSavable
boolean isContactSavable()
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:
- true if it's possible to save Contact with current state of values, false if not.
-
isVideoCapable
EditableContactBoolField isVideoCapable()
Description copied from interface:BaseContactReturns true if contact is video capable.- Specified by:
isVideoCapablein interfaceBaseContact- Returns:
- true if Contact is video capable.
-
-