Click or drag to resize

ButtonModuleService Class

The ButtonModuleService object is accessible from the User object, providing access to the button customization feature.
Inheritance Hierarchy
SystemObject
  Avaya.ClientServicesButtonModuleService

Namespace:  Avaya.ClientServices
Assembly:  AvayaClientServices (in AvayaClientServices.dll) Version: 550.0.60.0
Syntax
C#
public class ButtonModuleService

The ButtonModuleService type exposes the following members.

Properties
  NameDescription
Public propertyAvailableConsolidatedButtons
Returns a consolidated button list consisting of customized buttons and non-customized but configured features.
Public propertyAvailableCustomizedButtons
Returns the list of available customized buttons.
Public propertyIsServiceAvailable
Returns true if the button module service is available, false otherwise.
Top
Methods
  NameDescription
Public methodAddButton
Adds a customized button at location given by user.
Public methodMoveButton
Moves a customized button to a location given by user.
Public methodRemoveButton
Removes the customized button from the button module.
Public methodSetButtonLabel
Updates the customized button with personalized label given by user.
Top
Events
  NameDescription
Public eventButtonModuleServiceAvailable
Occurs when the button module service becomes available.
Public eventButtonModuleServiceUnavailable
Occurs when the button module service becomes unavailable.
Public eventConsolidatedButtonListUpdated
Occurs when the consolidated button list is updated. It is a list consisting of customized buttons and non-customized but configured features.
Public eventCustomizedButtonListUpdated
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