Asynchronously executes the custom button action for the given button ID.
Namespace: ININ.IceLib.PeopleAssembly: ININ.IceLib.People (in ININ.IceLib.People.dll) Version: 0.0.0.0 (22.3.0.218)
Syntax
C# |
---|
public void ActivateButtonActionAsync( string buttonId, InteractionId interactionId, AsyncCompletedEventHandler completedCallback, Object userState ) |
Visual Basic |
---|
Public Sub ActivateButtonActionAsync ( _ buttonId As String, _ interactionId As InteractionId, _ completedCallback As AsyncCompletedEventHandler, _ userState As Object _ ) |
Parameters
- buttonId
- Type: System..::..String
The Id of the button to activate.
- interactionId
- Type: ININ.IceLib.Interactions..::..InteractionId
The InteractionId associated with this action.
- completedCallback
- Type: System.ComponentModel..::..AsyncCompletedEventHandler
The callback to invoke when the asynchronous operation completes.
- userState
- Type: System..::..Object
An optional object that contains state information for this request. This object is a way for the caller to store context information which will be provided to the AsyncCompleted event. If no context information is desired then nullNothingnullptra null reference (Nothing in Visual Basic) may be supplied.
Remarks
When completed, the completedCallback delegate is invoked on a thread appropriate to the application-model, such as the GUI thread in a UI application. The Error property of the AsyncCompletedEventArgs-derived object passed to the delegate will contain any exceptions thrown while executing the asynchronous task. See the synchronous version of this method for more detailed error information. For more information on async method calls, see How Async Calls Work.
Exceptions
Exception | Condition |
---|---|
System..::..ArgumentNullException | A parameter is nullNothingnullptra null reference (Nothing in Visual Basic). |
System..::..ArgumentException | The buttonId length is zero. |
Version Information
Supported for IC Server version 2015 R1 and beyond.
For 4.0, supported for IC Server version 4.0 GA and beyond.
For 4.0, supported for IC Server version 4.0 GA and beyond.