Responder

Kind: global class

• Responder
  • new Responder()
  • .data : object
  • .setMessgingType(messagingType, [tag]) ⇒ this
  • .isResponseType() ⇒ boolean
  • .setData(data) ⇒ this
  • .text(text, [quickReplies]) ⇒ this
  • .setState(object) ⇒ this
  • .addQuickReply(action, title, [data], [prepend])
  • .expected(action) ⇒ this
  • .toAbsoluteAction(action) ⇒ string
  • .image(imageUrl, [reusable]) ⇒ this
  • .video(videoUrl, [reusable]) ⇒ this
  • .file(fileUrl, [reusable]) ⇒ this
  • .wait([ms]) ⇒ this
  • .typingOn() ⇒ this
  • .typingOff() ⇒ this
  • .seen() ⇒ this
  • .passThread(targetAppId, [data]) ⇒ this
  • .receipt(recipientName, [paymentMethod], [currency], [uniqueCode]) ⇒ ReceiptTemplate
  • .button(text) ⇒ ButtonTemplate
  • .genericTemplate([shareable], [isSquare]) ⇒ GenericTemplate
  • .list([topElementStyle]) ⇒ ListTemplate

new Responder()

Instance of responder is passed as second parameter of handler (res)

responder.data : object

Kind: instance property of Responder

responder.setMessgingType(messagingType, [tag]) ⇒ this

Kind: instance method of Responder

responder.isResponseType() ⇒ boolean

Returns true, when responder is not sending an update (notification) message

Kind: instance method of Responder

responder.setData(data) ⇒ this

Set temporary data to responder, which are persisted through single event

Kind: instance method of Responder

Example

bot.use('foo', (req, res, postBack) => {
    res.setData({ a: 1 });
    postBack('bar');
});

bot.use('bar', (req, res) => {
    res.data.a; // === 1 from postback
});

responder.text(text, [quickReplies]) ⇒ this

Send text as a response

Kind: instance method of Responder

Example

// simply
res.text('Hello %s', name, {
    action: 'Quick reply',
    another: 'Another quick reply'
});

// complex
res.text('Hello %s', name, [
    { action: 'action', title: 'Quick reply' },
    {
        action: 'complexAction', // required
        title: 'Another quick reply', // required
        match: 'string' || /regexp/, // optional
        someData: 'Will be included in payload data' // optional
    }
]);

responder.setState(object) ⇒ this

Sets new attributes to state (with Object.assign())

Kind: instance method of Responder

Example

res.setState({ visited: true });

responder.addQuickReply(action, title, [data], [prepend])

Appends quick reply, to be sent with following text method

Kind: instance method of Responder

Example

bot.use((req, res) => {
    res.addQuickReply('barAction', 'last action');

    res.addQuickReply('theAction', 'first action', {}, true);

    res.text('Text', {
        fooAction: 'goto foo'
    }); // will be merged and sent with previously added quick replies
});

responder.expected(action) ⇒ this

When user writes some text as reply, it will be processed as action

Kind: instance method of Responder

responder.toAbsoluteAction(action) ⇒ string

Converts relative action to absolute action path

Kind: instance method of Responder
Returns: string - absolute action path

responder.image(imageUrl, [reusable]) ⇒ this

Sends image as response. Requires appUrl option to send images from server

Kind: instance method of Responder

Example

// image on same server (appUrl option)
res.image('/img/foo.png');

// image at url
res.image('https://google.com/img/foo.png');

responder.video(videoUrl, [reusable]) ⇒ this

Sends video as response. Requires appUrl option to send videos from server

Kind: instance method of Responder

Example

// file on same server (appUrl option)
res.video('/img/foo.mp4');

// file at url
res.video('https://google.com/img/foo.mp4');

responder.file(fileUrl, [reusable]) ⇒ this

Sends file as response. Requires appUrl option to send files from server

Kind: instance method of Responder

Example

// file on same server (appUrl option)
res.file('/img/foo.pdf');

// file at url
res.file('https://google.com/img/foo.pdf');

responder.wait([ms]) ⇒ this

Sets delay between two responses

Kind: instance method of Responder

responder.typingOn() ⇒ this

Sends "typing..." information

Kind: instance method of Responder

responder.typingOff() ⇒ this

Stops "typing..." information

Kind: instance method of Responder

responder.seen() ⇒ this

Reports last message from user as seen

Kind: instance method of Responder

responder.passThread(targetAppId, [data]) ⇒ this

Pass thread to another app

Kind: instance method of Responder

responder.receipt(recipientName, [paymentMethod], [currency], [uniqueCode]) ⇒ ReceiptTemplate

Sends Receipt template

Kind: instance method of Responder

Example

res.receipt('Name', 'Cash', 'CZK', '1')
    .addElement('Element name', 1, 2, '/inside.png', 'text')
    .send();

responder.button(text) ⇒ ButtonTemplate

Sends nice button template. It can redirect user to server with token in url

Kind: instance method of Responder

Example

res.button('Hello')
    .postBackButton('Text', 'action')
    .urlButton('Url button', '/internal', true) // opens webview with token
    .urlButton('Other button', 'https://goo.gl') // opens in internal browser
    .send();

responder.genericTemplate([shareable], [isSquare]) ⇒ GenericTemplate

Creates a generic template

Kind: instance method of Responder

Example

res.genericTemplate()
    .addElement('title', 'subtitle')
        .setElementImage('/local.png')
        .setElementUrl('https://www.seznam.cz')
        .postBackButton('Button title', 'action', { actionData: 1 })
    .addElement('another', 'subtitle')
        .setElementImage('https://goo.gl/image.png')
        .setElementAction('action', { actionData: 1 })
        .urlButton('Local link with extension', '/local/path', true, 'compact')
    .send();

responder.list([topElementStyle]) ⇒ ListTemplate

Creates a generic template

Kind: instance method of Responder

Example

res.list('compact')
    .postBackButton('Main button', 'action', { actionData: 1 })
    .addElement('title', 'subtitle')
        .setElementImage('/local.png')
        .setElementUrl('https://www.seznam.cz')
        .postBackButton('Button title', 'action', { actionData: 1 })
    .addElement('another', 'subtitle')
        .setElementImage('https://goo.gl/image.png')
        .setElementAction('action', { actionData: 1 })
        .urlButton('Local link with extension', '/local/path', true, 'compact')
    .send();