Namespace: Contacts

Classes

Contact

ContactBooleanField

ContactEmailAddressField

ContactField

ContactFieldList

ContactIMAddressField

ContactNumberField

ContactPhoneField

Contacts

ContactSearchRequest

ContactsError

ContactStringField

EditableContact

EditableContactBooleanField

EditableContactEmailAddressField

EditableContactIMAddressField

EditableContactNumberField

EditableContactPhoneField

EditableContactStringField

MatchedContactsWithMatchLevel

ResolveContactResult

ResolveContactsRequest

Terminal

Members

<static, readonly> ContactEmailAddressType :string

Enumeration defining possible types of the contact's email addresses.

Type:

• string

Properties:

Name	Type	Default	Description
EMAIL_ADDRESS_WORK	string	EMAIL_ADDRESS_WORK
EMAIL_ADDRESS_OTHER	string	EMAIL_ADDRESS_OTHER

<static, readonly> ContactIMAddressType :string

Enumeration defining possible types of contact's instant messaging addresses.

Type:

• string

Properties:

Name	Type	Default	Description
IM_ADDRESS_WORK	string	IM_ADDRESS_WORK
IM_ADDRESS_OTHER	string	IM_ADDRESS_OTHER

<static, readonly> ContactPhoneNumberType :string

Enumeration defining possible types of the contact's phone numbers.

Type:

• string

Properties:

Name	Type	Default	Description
PHONE_NUMBER_WORK	string	PHONE_NUMBER_WORK
PHONE_NUMBER_HANDLE	string	PHONE_NUMBER_HANDLE
PHONE_NUMBER_MOBILE	string	PHONE_NUMBER_MOBILE
PHONE_NUMBER_HOME	string	PHONE_NUMBER_HOME
PHONE_NUMBER_FAX	string	PHONE_NUMBER_FAX
PHONE_NUMBER_PAGER	string	PHONE_NUMBER_PAGER

<static, readonly> ContactPictureSize :string

Enumeration defining possible sizes of the contact's picture.

Type:

• string

Properties:

Name	Type	Default	Description
XSMALL	string	XSMALL
SMALL	string	SMALL
MEDIUM	string	MEDIUM
LARGE	string	LARGE
XLARGE	string	XLARGE
XXLARGE	string	XXLARGE

<static, readonly> ContactsErrorReason :string

Enumeration defining possible reasons of errors in the contacts module.

Type:

• string

Properties:

Name	Type	Default	Description
UNKNOWN_REASON	string	UNKNOWN_REASON	An unknown error. If this error code is received, there is a bug.
INTERNAL_ERROR	string	INTERNAL_ERROR	Unexpected exception in processing the request.
RETRY	string	RETRY	Service is busy, retry the request later.
SERVER_UNAVAILABLE	string	SERVER_UNAVAILABLE	Failed to connect to contact server.
INVALID_SERVER_RESPONSE	string	INVALID_SERVER_RESPONSE	Server has returned data in invalid or unexpected format.
AUTHENTICATION_FAILED	string	AUTHENTICATION_FAILED	Authentication failed.
AUTHENTICATION_CANCELLED	string	AUTHENTICATION_CANCELLED	Authentication cancelled.
AUTHORIZATION_FAILED	string	AUTHORIZATION_FAILED	Authorization failed.
REQUEST_TIMEOUT	string	REQUEST_TIMEOUT	Request to server is timed out.
REQUEST_CANCELED	string	REQUEST_CANCELED	Request has been cancelled.
DUPLICATE_CONTACT	string	DUPLICATE_CONTACT	Contact already exists.
INVALID_CONTACT	string	INVALID_CONTACT	Contact is invalid.
REQUIRED_DATA_MISSING	string	REQUIRED_DATA_MISSING	Required fields of the contact are missing.
DELETE_CONTACT_NOT_AVAILABLE	string	DELETE_CONTACT_NOT_AVAILABLE	Deleting a contact operation is not available.
ADD_CONTACT_NOT_AVAILABLE	string	ADD_CONTACT_NOT_AVAILABLE	Adding a contact operation is not available.
UPDATE_CONTACT_NOT_AVAILABLE	string	UPDATE_CONTACT_NOT_AVAILABLE	Updating a contact operation is not available.
SEARCH_CONTACTS_NOT_AVAILABLE	string	SEARCH_CONTACTS_NOT_AVAILABLE	Searching for a contact operation is not available.
SEARCH_TERMINALS_NOT_AVAILABLE	string	SEARCH_TERMINALS_NOT_AVAILABLE	Searching for a terminal operation is not available.
GET_CONTACTS_NOT_AVAILABLE	string	GET_CONTACTS_NOT_AVAILABLE	Getting contacts operation is not available.
CONTACT_NOT_FOUND	string	CONTACT_NOT_FOUND	Contact wasn't found.
INVALID_SEARCH_REQUEST	string	INVALID_SEARCH_REQUEST	Provided search request is invalid or not provided.
INVALID_SEARCH_STRING	string	INVALID_SEARCH_STRING	Search string is invalid or not provided.
INVALID_SEARCH_STRINGS	string	INVALID_SEARCH_STRINGS	Search strings is invalid or not provided.
INVALID_SEARCH_SOURCE	string	INVALID_SEARCH_SOURCE	Search source is invalid.
INVALID_SEARCH_FIELD	string	INVALID_SEARCH_FIELD	Search field is invalid.
SEARCH_REQUEST_NOT_FOUND	string	SEARCH_REQUEST_NOT_FOUND	Contact search request is not found.
SEARCH_STRINGS_TOO_LARGE	string	SEARCH_STRINGS_TOO_LARGE	Match criteria in contact search request is too large.
EDIT_TERMINAL_NOT_SUPPORTED	string	EDIT_TERMINAL_NOT_SUPPORTED	Editing terminal is not supported.
CONTACTS_NOTIFICATIONS_CHANNEL_FAILED	string	CONTACTS_NOTIFICATIONS_CHANNEL_FAILED	Start notification channel failed.
INCOMPATIBLE_SERVER_VERSION	string	INCOMPATIBLE_SERVER_VERSION	Incompatible server version. The server doesn't support the protocol version used by the client.

<static, readonly> ResolveContactsFieldType :string

Enumeration defining possible types of the contact's properties the contact resolution should be done against.

Type:

• string

Properties:

Name	Type	Default	Description
HANDLE	string	HANDLE	Search for a contact with the matching email address or IM address.
PHONE_NUMBER	string	PHONE_NUMBER	Search for a contact with the matching phone number.

<static, readonly> SearchFieldType :string

Enumeration defining possible types of the contact's property the search should be done against.

Type:

• string

Properties:

Name	Type	Default	Description
NAME	string	NAME	Search for a contact with the matching name.
HANDLE	string	HANDLE	Search for a contact with the matching email address or IM address.
LOGIN_ID	string	LOGIN_ID	Search for contact with matching login ID
TERMINAL	string	TERMINAL	Search for a contact with the matching terminal name.
ALL	string	ALL	Search for a contact with any match

<static, readonly> SearchNetworkSource :string

Specifies where to search users (iView only, anywhere).

Type:

• string

Properties:

Name	Type	Default	Description
CONFERENCE_ONLY	string	CONFERENCE_ONLY	Search users only in conference.
ANYWHERE	string	ANYWHERE	Search users anywhere.

<static, readonly> SearchSourceType :string

Specifies whether the search should be done in local cache, network or both.

Type:

• string

Properties:

Name	Type	Default	Description
LOCAL	string	LOCAL	Search a contact in local cache.
NETWORK	string	NETWORK	Search a contact in network.
ALL	string	ALL	Search contact first in local cache, then in network if nothing found.