Avaya Client Services API Reference (Windows)
Avaya Client Services API Reference (Windows)
Avaya.ClientServices
Contact Class
Contact Properties
Contact Methods
Contact Events

Contact Class

Represents an immutable contact object which exposes all possible contact details. The contact object can also be used to subscribe for presence updates.
Inheritance Hierarchy
System
Object
Avaya.ClientServices
BaseContact
Avaya.ClientServices
Contact

Namespace: Avaya.ClientServices
Assembly: AvayaClientServices (in AvayaClientServices.dll) Version: 592.1.30.0
Syntax
C#
Copy

    public class Contact : BaseContact

The Contact type exposes the following members.

Properties

| Name | Description
--- | --- | ---
| AddToGroupCapability | Capability indicating whether this contact can be added to a group.
| Alias | The native alias.
| AsciiAlias | The non-localized alias.
| AsciiDisplayName | The non-localized display name.
| AsciiFirstName | The non-localized first name.
| AsciiLastName | The non-localized last name.
| AsciiMiddleName | The non-localized middle name.
| CanAddIMAddress | True if addition of IM address will not make contact invalid.
| City | The city.
| Company | The company.
| ContactSources | The contact sources
| Country | The country.
| Custom1 | The list of custom1 values.
| Custom2 | The list of custom2 values.
| Custom3 | The list of custom3 values.
| DeleteContactCapability | Capability indicating whether this contact can be deleted. See also ContactService.DeleteContact() method.
| Department | The department.
| DisplayName | The native display name.
| EmailAddresses | The list of email addresses.
| ExtendedContactDetailsAvailable | True if extended contact details are available.
| ExtraFields | The list extra fields used for local contacts.
| FirstName | The native first name.
| HasPicture | Indicating whether contact has a picture.
| IMAddresses | The list of IM addresses.
| IsBuddy | The buddy flag. Used for presence feature purpose.
| IsFavorite | The favorite flag.
| IsVip | The VIP flag.
| Language | The language is per contact record.
| LastName | The native last name.
| Location | The location.
| Manager | The name of a person who is a supervisor.
| MiddleName | The native middle name.
| Notes | The notes field.
| PhoneNumbers | The list of phone numbers.
| PictureData | The contact picture bytes. Picture data can be in jpeg or png format.
| PostalCode | The postal code.
| Presence | The presence state of this contact. Note that for this to be updated, StartPresence(AccessControlBehavior, Contact ContactPresenceCompletionHandler) must be invoked. If presence will no longer be needed use StopPresence(Contact ContactPresenceCompletionHandler) in order to stop presence subscription.
| Rank | The rank field with non-negative double value defining contact sorting order. 0.0 value means "No rank".
| State | The state.
| StreetAddress | The street address.
| Title | The title or company role.
| UniqueAddressForMatching | The matching/merging address. That parameter can be used as record unique id.
| UpdateContactCapability | Capability indicating whether this contact can be updated. See also ContactService.UpdateContact() method.
| VideoCapable | True if contact is video capable.

Top
Methods

| Name | Description
--- | --- | ---
| CanAddEmailAddressOfType | True if addition of email address of a specified type will not make contact invalid.
| CanAddPhoneNumberOfType | True if addition of phone number of a specified type will not make contact invalid.
| GetAlias | (Overrides BaseContact GetAlias .)
| GetAsciiAlias | (Overrides BaseContact GetAsciiAlias .)
| GetAsciiDisplayName | (Overrides BaseContact GetAsciiDisplayName .)
| GetAsciiFirstName | (Overrides BaseContact GetAsciiFirstName .)
| GetAsciiLastName | (Overrides BaseContact GetAsciiLastName .)
| GetAsciiMiddleName | (Overrides BaseContact GetAsciiMiddleName .)
| GetCity | (Overrides BaseContact GetCity .)
| GetCompany | (Overrides BaseContact GetCompany .)
| GetCountry | (Overrides BaseContact GetCountry .)
| GetCustom1 | (Overrides BaseContact GetCustom1 .)
| GetCustom2 | (Overrides BaseContact GetCustom2 .)
| GetCustom3 | (Overrides BaseContact GetCustom3 .)
| GetDepartment | (Overrides BaseContact GetDepartment .)
| GetDisplayName | (Overrides BaseContact GetDisplayName .)
| GetEmailAddresses | (Overrides BaseContact GetEmailAddresses .)
| GetExtraFields | (Overrides BaseContact GetExtraFields .)
| GetFirstName | (Overrides BaseContact GetFirstName .)
| GetIMAddresses | (Overrides BaseContact GetIMAddresses .)
| GetIsBuddy | (Overrides BaseContact GetIsBuddy .)
| GetIsFavorite | (Overrides BaseContact GetIsFavorite .)
| GetIsVideoCapable | (Overrides BaseContact GetIsVideoCapable .)
| GetIsVip | (Overrides BaseContact GetIsVip .)
| GetLanguage | (Overrides BaseContact GetLanguage .)
| GetLastName | (Overrides BaseContact GetLastName .)
| GetLocation | (Overrides BaseContact GetLocation .)
| GetManager | (Overrides BaseContact GetManager .)
| GetMiddleName | (Overrides BaseContact GetMiddleName .)
| GetNotes | (Overrides BaseContact GetNotes .)
| GetPhoneNumbers | (Overrides BaseContact GetPhoneNumbers .)
| GetPostalCode | (Overrides BaseContact GetPostalCode .)
| GetRank | (Overrides BaseContact GetRank .)
| GetState | (Overrides BaseContact GetState .)
| GetStreetAddress | (Overrides BaseContact GetStreetAddress .)
| GetTitle | (Overrides BaseContact GetTitle .)
| GetUniqueAddressForMatching | (Overrides BaseContact GetUniqueAddressForMatching .)
| RemovePictureFromCache | Removes contact's picture from cache. This method helps to manage the application memory. When the contact picture is not needed, it can be removed and downloaded again in the future.
| RetrievePicture | Retrieves the picture for contact. Check if picture is available using HasPicture flag.
| StartPresence | Begin monitoring presence for this contact. The Presence property will start being updated after this method is invoked. See also method StopPresence.
| StopPresence | Stop monitoring presence for this contact. The Presence property will be reset and will not update after this method is called.

Top
Events

| Name | Description
--- | --- | ---
| ContactChanged | Occurs when some field of the contact changes, either through local or remote actions.
| PresenceChanged | Occurs when the contact's presence information changes. Note, that StartPresence must be invoked in order to trigger receiving presence updates. When the last listener is removed, StopPresence is automatically invoked which stops receiving presence updates for the contact.

Top
Remarks

See also EditableContact class.

Contacts can be retrieved by using ContactService methods ContactService.GetContacts(ContactRetrievalWatcher ^,ContactSourceType) or ContactService.SearchContacts(SearchContactsWatcher ^,System::String ^,SearchScopeType,SearchSourceType,uint32_t,uint32_t). Both methods are returning data retrievals which are notifying about operation status and new record coming in.

This object can not be used to edit the contact record. In order to update contact use method ContactService.CreateEditableContact and then operate on EditableContact object which should be passed to ContactService.UpdateContact method.

See Also

#### Reference

Avaya.ClientServices Namespace

© 2017 Avaya LLC. All Rights Reserved.