Classes
- ButtonTemplate ⇐
BaseTemplate - GenericTemplate ⇐
ButtonTemplate - ReceiptTemplate ⇐
BaseTemplate
ButtonTemplate ⇐ BaseTemplate
Kind: global class
Extends: BaseTemplate
- ButtonTemplate ⇐
BaseTemplate
new ButtonTemplate()
Helps with creating of button template Instance of button template is returned by {Responder}
buttonTemplate.urlButton(title, linkUrl, hasExtension, [webviewHeight]) ⇒ this
Adds button. When hasExtension is set to true, url will contain hash like:
#token=foo&senderId=23344
Kind: instance method of ButtonTemplate
| Param | Type | Default | Description | ||
|---|---|---|---|---|---|
| title | string |
button text | |||
| linkUrl | string |
button url | |||
| hasExtension | boolean |
false |
includes token in url | ||
| [webviewHeight] | string |
null |
compact | tall | full |
buttonTemplate.postBackButton(title, action, [data]) ⇒ this
Adds button, which makes another action
Kind: instance method of ButtonTemplate
| Param | Type | Default | Description |
|---|---|---|---|
| title | string |
Button title | |
| action | string |
Button action (can be absolute or relative) | |
| [data] | object |
{} |
Action data |
buttonTemplate.shareButton() ⇒ this
Kind: instance method of ButtonTemplate
GenericTemplate ⇐ ButtonTemplate
Kind: global class
Extends: ButtonTemplate
- GenericTemplate ⇐
ButtonTemplate- new GenericTemplate()
- .addElement(title, [subtitle], [dontTranslate]) ⇒
this - .setElementActionShare() ⇒
this - .setElementActionPostback(action, [data]) ⇒
this - .setElementImage(image) ⇒
this - .setElementAction(url, hasExtension, [webviewHeight])
- .urlButton(title, linkUrl, hasExtension, [webviewHeight]) ⇒
this - .postBackButton(title, action, [data]) ⇒
this - .shareButton() ⇒
this
new GenericTemplate()
Generic template utility
genericTemplate.addElement(title, [subtitle], [dontTranslate]) ⇒ this
Adds element to generic template
Kind: instance method of GenericTemplate
| Param | Type | Default |
|---|---|---|
| title | string |
|
| [subtitle] | string |
null |
| [dontTranslate] | boolean |
false |
genericTemplate.setElementActionShare() ⇒ this
Sets url of recently added element
Kind: instance method of GenericTemplate
genericTemplate.setElementActionPostback(action, [data]) ⇒ this
Sets url of recently added element
Kind: instance method of GenericTemplate
| Param | Type | Default | Description |
|---|---|---|---|
| action | string |
Button action (can be absolute or relative) | |
| [data] | object |
{} |
Action data |
genericTemplate.setElementImage(image) ⇒ this
Sets image of recently added element
Kind: instance method of GenericTemplate
| Param | Type |
|---|---|
| image | string |
genericTemplate.setElementAction(url, hasExtension, [webviewHeight])
Sets default action of recently added element
Kind: instance method of GenericTemplate
| Param | Type | Default | Description | ||
|---|---|---|---|---|---|
| url | string |
button url | |||
| hasExtension | boolean |
false |
includes token in url | ||
| [webviewHeight] | string |
null |
compact | tall | full |
genericTemplate.urlButton(title, linkUrl, hasExtension, [webviewHeight]) ⇒ this
Adds button. When hasExtension is set to true, url will contain hash like:
#token=foo&senderId=23344
Kind: instance method of GenericTemplate
| Param | Type | Default | Description | ||
|---|---|---|---|---|---|
| title | string |
button text | |||
| linkUrl | string |
button url | |||
| hasExtension | boolean |
false |
includes token in url | ||
| [webviewHeight] | string |
null |
compact | tall | full |
genericTemplate.postBackButton(title, action, [data]) ⇒ this
Adds button, which makes another action
Kind: instance method of GenericTemplate
| Param | Type | Default | Description |
|---|---|---|---|
| title | string |
Button title | |
| action | string |
Button action (can be absolute or relative) | |
| [data] | object |
{} |
Action data |
genericTemplate.shareButton() ⇒ this
Kind: instance method of GenericTemplate
ReceiptTemplate ⇐ BaseTemplate
Kind: global class
Extends: BaseTemplate
- ReceiptTemplate ⇐
BaseTemplate
new ReceiptTemplate()
Provides fluent interface to make nice Receipts Instance of button template is returned by {Responder}
receiptTemplate.addElement(title, [price], [quantity], [image], [subtitle]) ⇒ this
Adds item to receipt
Kind: instance method of ReceiptTemplate
| Param | Type | Default | Description |
|---|---|---|---|
| title | string |
||
| [price] | number |
0 |
a item price |
| [quantity] | number |
|
amount of items |
| [image] | string |
null |
image of item |
| [subtitle] | string |
null |
optional subtitle |