IConfirmationHandle

Represents a confirmation request in progress with a client

Properties

int ButtonChoice {get;}

The button choice the user finally made.

AutoString[] Buttons {get;}

A list of translatable button choices to be offered to the user.

Guid ConfirmationID {get;}

The ID of the Confirmation Request

int DefaultButton {get;}

The zero based index of the button choice to use as a default

AutoString Description {get;}

The translatable description for the request. Prefix with @ for a litteral.

IConnectionIdentity Identity {get;}

The connection with which this request is associated

bool IsCompleted {get;}

True if the request was completed or cancelled

int ReplyTimeout {get;}

The time to wait for the users' reply in milliseconds

bool Success {get;}

True if the request completed successfully (the user clicked a button)

int TimeRemaining {get;}

The zero based index of the button choice to use as a default

AutoString Title {get;}

The translatable title of the request. Prefix with @ for a litteral.

Events

Cancelled(EventHandler)

Fires when the request is cancelled for some reason (timeout, disconnect, script cancellation etc)

Completed(EventHandler)

Fires when the request is completed, successfully or not.

Methods

void Cancel()

Cancels this request

void Complete(int buttonChoice)

Simulates completing this request