public class CustomButtonList

Public Class CustomButtonList

This class maintains a list of custom buttons defined for a user session. The user defines custom buttons in Interaction Administator. The custom buttons are then sent from the IC server to the client provided it has the necessary permissions. Each button contains an icon, and localized text and description information based on the language setting of the user's session. The custom buttons are stored in a cache that is updated when there is a change to the list.

To start a watch, call the StartWatching()()()() or StartWatchingAsync(AsyncCompletedEventHandler, Object) methods. The completedCallback delegate is invoked when the asynchronous start watch operation completes. To stop a watch call the StopWatching()()()() or StopWatchingAsync(AsyncCompletedEventHandler, Object) methods. The StopWatchingCompleted delegate is invoked when the asynchronous stop watch operation completes. An InvalidOperationException is raised if StartWatching()()()() or StartWatchingAsync(AsyncCompletedEventHandler, Object) is called when a watch is already in place. The InvalidOperationException is also raised if StopWatching()()()() or StopWatchingAsync(AsyncCompletedEventHandler, Object) is called when a watch is not in place.

When this list of custom buttons changes, the WatchedObjectsChanged event is triggered.

If a watch is in place you can access the list of custom buttons by calling the GetList()()()() method. An InvalidOperationException is raised if a watch is not in place.

Note: The asynchronous methods are preferred since the start, change, and stop watch can be lengthy operations.

System..::..Object
  ININ.IceLib.People..::..CustomButtonList

Supported for IC Server version 2015 R1 and beyond.
For 4.0, supported for IC Server version 4.0 GA and beyond.
For 3.0, supported for IC Server version 3.0 GA and beyond.