Class: ShowSignatureCaptureRequest

timapi.ShowSignatureCaptureRequest()

Ecr show signature capture request. Used by timapi.Terminal#showSignatureCaptureAsync.

Overview

Members-Overview

backgroundColor	:timapi.Color
brandBar	:Array.<timapi.constants.BrandBarBrand>
brandMode	:timapi.constants.BrandMode
imageFileFormat	:timapi.constants.ImageFileFormat
imageFileHeight	:Number
imageFileWidth	:Number
language	:String
resourceId	:timapi.constants.ResourceId
signatureColor	:timapi.Color
theme	:timapi.constants.Theme
timeout	:Number
watermarkColor	:timapi.constants.Color
watermarkItems	:Array.<String>

Methods-Overview

toString() → {String}
copy(showSignatureCaptureRequest) → {timapi.ShowSignatureCaptureRequest}

Constructor

new ShowSignatureCaptureRequest()

Create empty show signature capture request

Member-List

backgroundColor :timapi.Color

Background color.

Default Value:

White -> ( new timapi.Color(255,255,255) )

brandBar :Array.<timapi.constants.BrandBarBrand>

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

brandMode :timapi.constants.BrandMode

Brand mode.

Default Value:

all

imageFileFormat :timapi.constants.ImageFileFormat

Image file format to use.

Default Value:

png

imageFileHeight :Number

Image file height in pixels.

Default Value:

150

imageFileWidth :Number

Image file width in pixels.

Default Value:

200

language :String

Language.

resourceId :timapi.constants.ResourceId

Resource identifier.

Default Value:

welcomeCard

signatureColor :timapi.Color

Signature color.

Default Value:

Black -> ( new timapi.Color(0,0,0) )

theme :timapi.constants.Theme

Theme.

Default Value:

six

timeout :Number

Timeout in seconds.

Default Value:

60

watermarkColor :timapi.constants.Color

Watermark color.

Default Value:

Black -> ( new timapi.Color(0,0,0) )

watermarkItems :Array.<String>

List of watermark items.

Methods

toString() → {String}

String representation for debugging purpose.

Returns:

String representation

Type: String

(static) copy(showSignatureCaptureRequest) → {timapi.ShowSignatureCaptureRequest}

Creates a copy of a timapi.ShowSignatureCaptureRequest object.

Parameters:

Name	Type	Description
`showSignatureCaptureRequest`	timapi.ShowSignatureCaptureRequest	Original

Returns:

Copy of original

Type: timapi.ShowSignatureCaptureRequest