ConfirmationHandleExtended

Represents a user confirmation or notification request in progress

• This is a JavaScript visible object

Properties

int ButtonChoice {get;}

The zero-based index into Buttons which was chosen by the user

string Buttons {get;}

The list of button labels (eg: yes, no)

int DefaultButton {get;}

The zero-based index into Buttons which will be the default button

string Description {get;}

The text description of the confirmation displayed to the user

string ID {get;}

The unique ID of the confirmation handle

bool IsCompleted {get;}

True if this confirmation request was cancelled or completed

ParticipantExtended Participant {get;}

The participant to which this confirmation request was delivered

int ReplyTimeout {get;}

The time to wait for the users' reply in milliseconds. -1 to wait indefinitely.

bool Success {get;}

True if the user completed the confirmation request

int TimeRemaining {get;}

The time remaining of ReplyTimeout. This property will be -1 if ReplyTimeout is -1, and 0 if the time has expired.

string Title {get;}

The title of the confirmation displayed to the user

Events

Cancelled()

Fires when the confirmation request has been cancelled (usually because the user logs off or navigates)

Completed(int button)

Parameters:

button : The button choice

Fires when the confirmation request completes with success or failure

Methods

ReturnType Cancel()

Cancels the confirmation request

ReturnType Complete(int buttonChoice)

Simulates the completion of the confirmation request with a specified button choice.