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

ContactService Class

The ContactService object is accessible from the User object, and it provides access to functionality associated with contacts.
Inheritance Hierarchy
System
Object
Avaya.ClientServices
ContactService

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

    public class ContactService

The ContactService type exposes the following members.

Properties

| Name | Description
--- | --- | ---
| AddContactCapability | Capability describing whether the Contact service supports adding contacts.
| ContactGroupsSupported | Indicates that Contact service supports Contacts Group functionality.
| ContactLimits | Provides supported limits for the current enterprise contact provider.
| CreateContactGroupCapability | Capability describing whether the Contact Service supports Contact Group creation or not.
| DeleteContactCapability | Capability describing whether the Contact service supports deleting contacts.
| DeleteContactGroupCapability | Capability describing whether the Contact Service supports Contact Group removal or not.
| FavoriteContactsCapability | Capability describing whether the Contact service supports favorite contacts.
| IsServiceAvailable | Returns true if the Contact service is available.
| MaxContactGroupNameLength | Maximum length of Contact Group name.
| MaxNumberOfContactGroups | Maximum number of Contact Groups allowed for usage.
| MaxNumberOfContactsPerGroup | Maximum number of Contacts allowed per Group.
| NetworkContactSearchByDepartmentCapability | Capability describing whether the Contact service supports contact search by department.
| NetworkContactSearchByLocationCapability | Capability describing whether the Contact service supports contact search by location.
| NetworkContactSearchByNameCapability | Capability describing whether the Contact service supports contact search by name.
| NetworkSearchContactCapability | Capability describing whether the Contact service supports searching contacts.
| NetworkSearchTerminalCapability | Capability describing whether the Contact service supports searching contacts.
| ResolveEnterpriseContactsCapability | Capability describing whether the Contact Service supports ResolveContacts(ResolveContactsRequest) functionality.
| UpdateContactCapability | Capability describing whether the Contact service supports updating contacts.

Top
Methods

| Name | Description
--- | --- | ---
| AddContact | Adds a new contact.
| ChangeSearchContactsRequest | Obsolete. Change the search contacts request with a given new query string. All other parameters are immutable.
| CreateContactGroup | Creates a Contact Group with specified group name and group members.
| CreateEditableContact | Creates a new EditableContact object with default values.
| CreateEditableContactFromContact | Creates a new editable contact object from a given existing contact.
| DeleteContact | Deletes an existing contact.
| DeleteContactGroup | Deletes Contact Group.
| GetAvailableContactSourceTypes | Returns the list of available and online ContactSourceType. If there is more than one source, the AllContacts source will be added into the online list.
| GetContactGroups | Get the contact groups list from the given source.
| GetContacts | Get the contact list from the given source.
| GetMatchingContactForDirectoryContact | Get matching contact (from cache) to the one from search results.
| GetSelfContact | Gets the contact information for the currently logged-in user..
| ResolveContacts | Search for the contacts with given request parameters. There can be only one search in progress with a particular string. If such a search already exists, a new one won't be started.
| SearchContacts(SearchContactsWatcher, ContactSearchRequest) | Extended search for the contacts with given request parameters. There can be only one search in progress with a particular request. If such a search already exists, a new one won't be started.
| SearchContacts(SearchContactsWatcher, String, SearchScopeType, SearchSourceType, UInt32, UInt32) | Search for the contacts with given request parameters. There can be only one search in progress with a particular string. If such a search already exists, a new one won't be started.
| SearchTerminals | Search for the terminals with given request parameters. There can be only one search in progress with a particular request. If such a search already exists, a new one won't be started.
| UpdateContact | Updates an existing contact.

Top
Events

| Name | Description
--- | --- | ---
| ContactGroupsLoadingFailed | Occurs when the loading of contact groups fails.
| ContactLoadingComplete | Occurs once all the contacts have been loaded from their underlying sources.
| ContactLoadingFailed | Occurs when the loading of contacts fails.
| ContactProviderFailed | Occurs when an underlying contact provider fails.
| ContactServiceAvailable | Occurs when the contact service becomes available for use.
| ContactServicesAvailableProviderListChanged | Occurs when the list of available contact provider changes. For example, if ACS provider has stopped working, an event will be triggered.
| ContactServicesCapabilitiesChanged | Occurs when any of the contact service's capabilities changes.
| ContactServiceSelfContactUpdated | Occurs when self contact is updated.
| ContactServiceUnavailable | Occurs when the contact service becomes unavailable for use.

Top
Remarks
The ContactService object provides a set of APIs that allow application developers to manage a user's contacts and perform searches for other users.

In general, the capabilities and the set of allowed operations are dependent on the state of the contact related servers and services.

The client application is notified about status updates reported by the contact services through event handlers that the application has registered on the ContactService object's events. These updates may be the result of local operations on the ContactService object as well as remote changes initiated by either the service/server or other users.

In order to retrieve a list of contacts, call GetContacts(ContactRetrievalWatcher, ContactSourceType) method. This should be done after ContactServiceAvailable event was received.

See Also

#### Reference

Avaya.ClientServices Namespace

© 2017 Avaya LLC. All Rights Reserved.