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

ButtonModuleService Class

The ButtonModuleService object is accessible from the User object, providing access to the button customization feature.
Inheritance Hierarchy
System
Object
Avaya.ClientServices
ButtonModuleService

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

    public class ButtonModuleService

The ButtonModuleService type exposes the following members.

Properties

| Name | Description
--- | --- | ---
| AvailableConsolidatedButtons | Returns a consolidated button list consisting of customized buttons and non-customized but configured features.
| AvailableCustomizedButtons | Returns the list of available customized buttons.
| IsServiceAvailable | Returns true if the button module service is available, false otherwise.

Top
Methods

| Name | Description
--- | --- | ---
| AddButton | Adds a customized button at location given by user.
| MoveButton | Moves a customized button to a location given by user.
| RemoveButton | Removes the customized button from the button module.
| SetButtonLabel | Updates the customized button with personalized label given by user.

Top
Events

| Name | Description
--- | --- | ---
| ButtonModuleServiceAvailable | Occurs when the button module service becomes available.
| ButtonModuleServiceUnavailable | Occurs when the button module service becomes unavailable.
| ConsolidatedButtonListUpdated | Occurs when the consolidated button list is updated. It is a list consisting of customized buttons and non-customized but configured features.
| CustomizedButtonListUpdated | Occurs when the customized button list is updated.

Top
Remarks
The ButtonModuleService object provides a set of APIs that allow application developers to implement button customization features.

The client application is notified about list updates on customized buttons reported by the button module service through event handlers that the application has registered on the ButtonModuleService object's events. These updates may be the result of local operations on the ButtonModuleService object as well as remote changes initiated by either the service/server or other end users.

In order to retrieve a list of customized buttons, call AvailableCustomizedButtons property. In order to retrieve a list of consolidated buttons, call AvailableConsolidatedButtons property. This should be done after ButtonModuleServiceAvailable event is received.

See Also

#### Reference

Avaya.ClientServices Namespace

© 2017 Avaya LLC. All Rights Reserved.