Classes

ButtonTemplate ⇐ BaseTemplate

Helps with creating of button template Instance of button template is returned by {Responder}

GenericTemplate ⇐ ButtonTemplate

Generic template utility

ReceiptTemplate ⇐ BaseTemplate

Provides fluent interface to make nice Receipts Instance of button template is returned by {Responder}

Functions

encodePayload(payload) ⇒ EncodedPayload

Encodes different types of payloads from designer snapshot to payload for chat Content is Base64 encoded.

Typedefs

MarkdownPayload

Payload : MarkdownPayload

Designer payload type

EncodedPayload

ButtonTemplate ⇐ BaseTemplate

Helps with creating of button template Instance of button template is returned by {Responder}

Kind: global class
Extends: BaseTemplate

• ButtonTemplate ⇐ BaseTemplate
  • .urlButton(title, linkUrl, hasExtension, [webviewHeight], [onCloseAction], [onCloseData]) ⇒ this
  • .postBackButton(title, action, [data], [setState]) ⇒ this
  • .attachmentButton(title, payload) ⇒ this
  • .shareButton() ⇒ this

buttonTemplate.urlButton(title, linkUrl, hasExtension, [webviewHeight], [onCloseAction], [onCloseData]) ⇒ this

Adds button. When hasExtension is set to true, url will contain hash like: #token=foo&senderId=23344

Kind: instance method of ButtonTemplate

buttonTemplate.postBackButton(title, action, [data], [setState]) ⇒ this

Adds button, which makes another action

Kind: instance method of ButtonTemplate

buttonTemplate.attachmentButton(title, payload) ⇒ this

Adds button, which opens a popup with content on click.

Kind: instance method of ButtonTemplate

Example

res.button('text')
 .attachmentButton('button title', {
     content: '# Heading 1',
     contentType: 'text/markdown',
     className: 'my-class-for-markdown'
  })
 .send();

buttonTemplate.shareButton() ⇒ this

Kind: instance method of ButtonTemplate

GenericTemplate ⇐ ButtonTemplate

Generic template utility

Kind: global class
Extends: ButtonTemplate

• GenericTemplate ⇐ ButtonTemplate
  • .addElement(title, [subtitle], [dontTranslate]) ⇒ this
  • .setElementActionShare() ⇒ this
  • .setElementActionPostback(action, [data], [setState]) ⇒ this
  • .setElementImage(image) ⇒ this
  • .setElementAction(url, hasExtension, [webviewHeight])
  • .urlButton(title, linkUrl, hasExtension, [webviewHeight], [onCloseAction], [onCloseData]) ⇒ this
  • .postBackButton(title, action, [data], [setState]) ⇒ this
  • .attachmentButton(title, payload) ⇒ this
  • .shareButton() ⇒ this

genericTemplate.addElement(title, [subtitle], [dontTranslate]) ⇒ this

Adds element to generic template

Kind: instance method of GenericTemplate

genericTemplate.setElementActionShare() ⇒ this

Sets url of recently added element

Kind: instance method of GenericTemplate

genericTemplate.setElementActionPostback(action, [data], [setState]) ⇒ this

Sets url of recently added element

Kind: instance method of GenericTemplate

genericTemplate.setElementImage(image) ⇒ this

Sets image of recently added element

Kind: instance method of GenericTemplate

genericTemplate.setElementAction(url, hasExtension, [webviewHeight])

Sets default action of recently added element

Kind: instance method of GenericTemplate

genericTemplate.urlButton(title, linkUrl, hasExtension, [webviewHeight], [onCloseAction], [onCloseData]) ⇒ this

Adds button. When hasExtension is set to true, url will contain hash like: #token=foo&senderId=23344

Kind: instance method of GenericTemplate
Overrides: urlButton

genericTemplate.postBackButton(title, action, [data], [setState]) ⇒ this

Adds button, which makes another action

Kind: instance method of GenericTemplate
Overrides: postBackButton

genericTemplate.attachmentButton(title, payload) ⇒ this

Adds button, which opens a popup with content on click.

Kind: instance method of GenericTemplate
Overrides: attachmentButton

Example

res.button('text')
 .attachmentButton('button title', {
     content: '# Heading 1',
     contentType: 'text/markdown',
     className: 'my-class-for-markdown'
  })
 .send();

genericTemplate.shareButton() ⇒ this

Kind: instance method of GenericTemplate
Overrides: shareButton

ReceiptTemplate ⇐ BaseTemplate

Provides fluent interface to make nice Receipts Instance of button template is returned by {Responder}

Kind: global class
Extends: BaseTemplate

receiptTemplate.addElement(title, [price], [quantity], [image], [subtitle]) ⇒ this

Adds item to receipt

Kind: instance method of ReceiptTemplate

encodePayload(payload) ⇒ EncodedPayload

Encodes different types of payloads from designer snapshot to payload for chat Content is Base64 encoded.

Kind: global function

MarkdownPayload

Kind: global typedef
Properties

Payload : MarkdownPayload

Designer payload type

Kind: global typedef

EncodedPayload

Kind: global typedef
Properties