Class: ShowDialogRequest

timapi.ShowDialogRequest()

Contains configuration for show dialog request used by timapi.Terminal#showDialogAsync.

Overview

Members-Overview

Methods-Overview

Constructor

new ShowDialogRequest()

Create empty show dialog request

Member-List

brandBar :Array.<timapi.constants.BrandBarBrand>

Brand bar. Used if brand mode is timapi.constants.BrandMode.selected.

brandMode :timapi.constants.BrandMode

Brand mode.
Default Value:

language :String

Language.

placeholderItems :Map.<Number, String>

Map of placeholder items. Maps placeholder number to value.

For example if the dialog description states "%0 %1" with placeholder description "0: Currency, 1: Amount" then set map like this: 

let placeholders = new Map();
placeholders.set(0, timapi.constants.Currency.CHF.code); // CHF
placeholders.set(1, "2500"); // 25.--
request.placeholderItems = placeholders;

resourceId :timapi.constants.ResourceId

Resource identifier.
Default Value:
  • welcomeCard

resourceParameters :Map.<timapi.constants.ResourceParameterType, String>

Map of resource parameters. Maps resource parameter type to value.

theme :timapi.constants.Theme

Theme.
Default Value:

timeout :Number

Timeout in seconds.
Default Value:
  • 60

Methods

(static) copy(showDialogRequest) → {timapi.ShowDialogRequest}

Creates a copy of a timapi.ShowDialogRequest object.
Parameters:
Name Type Description
showDialogRequest timapi.ShowDialogRequest Original
Returns:
Copy of original

Type: timapi.ShowDialogRequest

toString() → {String}

String representation for debugging purpose.
Returns:
String representation

Type: String