BotApp

Classes

BotApp: Adapter for Wingbot flight director
Processor: Messaging event processor

Functions

afterProcessMessage(req, res)

Typedefs

Options : object
ApiResponse : object
AutoTypingConfig : object
Plugin : object
TrackingEvent : object
TrackingObject : object
InteractionEvent : object
IInteractionHandler ⇒ Promise | void
ILogger : object
ProcessorOptions : object
IntentAction : object
IStateStorage : object
Preloader ⇒ Promise.<void>

Adapter for Wingbot flight director

Kind: global class

BotApp
- new BotApp(bot, options)
- instance
  - ._eventHandlers : Array.<OnEventHandler>
  - .processor ⇒ Processor
  - .registerAnalyticsStorage(analyticsStorage, [options]) ⇒ this
  - .trackEvent(pageId, senderId, event, [ts], [nonInteractive])
  - ._processSenderResponses(sender, senderId, pageId, headers)
  - .createSender(senderId, pageId, [message], [secret], appId) ⇒ Promise.<BotAppSender>
  - .processMessage(message, senderId, pageId, data) ⇒ Promise.<{status:number}>
  - .request(rawBody, rawHeaders) ⇒ Promise.<ApiResponse>
- static
  - .signBody(body, secret, appId) ⇒ Promise.<string>
  - .plugin() ⇒ Plugin
  - .sendContext(req, res)

new BotApp(bot, options)

Param	Type
bot	`Router`
options	`Options`

botApp._eventHandlers : `Array.<OnEventHandler>`

Kind: instance property of BotApp

botApp.processor ⇒ `Processor`

Get the processor instance

Kind: instance property of BotApp

botApp.registerAnalyticsStorage(analyticsStorage, [options]) ⇒ `this`

Kind: instance method of BotApp

Param	Type
analyticsStorage	`IAnalyticsStorage`
[options]	`HandlerConfig`

Example

const { GA4 } = require('wingbot');

botApp.registerAnalyticsStorage(new GA4({
    measurementId: 'G-123456,
    apiSecret: 'apisecret'
}))

botApp.trackEvent(pageId, senderId, event, [ts], [nonInteractive])

Method for tracking special events

Kind: instance method of BotApp

Param	Type	Default
pageId	`string`
senderId	`string`
event	`Event`
[ts]	`number`
[nonInteractive]	`boolean`	`false`

botApp._processSenderResponses(sender, senderId, pageId, headers)

Kind: instance method of BotApp

Param	Type
sender	`ReturnSender`
senderId	`string`
pageId	`string`
headers	`object`

botApp.createSender(senderId, pageId, [message], [secret], appId) ⇒ `Promise.<BotAppSender>`

Creates a Sender to be able, for example, to upload files

Kind: instance method of BotApp

Param	Type
senderId	`string`
pageId	`string`
[message]	`object`
[secret]	`string` \| `Promise.<string>`
appId	`string`

botApp.processMessage(message, senderId, pageId, data) ⇒ `Promise.<{status:number}>`

Compatibility method for Notification engine

Kind: instance method of BotApp

Param	Type	Description
message	`object`	wingbot chat event
senderId	`string`	chat event sender identifier
pageId	`string`	channel/page identifier
data	`object`	contextual data (will be available in res.data)
[data.appId]	`string`	possibility to override appId

botApp.request(rawBody, rawHeaders) ⇒ `Promise.<ApiResponse>`

Process incomming API request from the orchestrator.

The response can be sent using an express, or you can directly return the response to

Kind: instance method of BotApp

Param	Type
rawBody	`string` \| `null`
rawHeaders	`object`

Example

const express = require('express');
const { Router, BotApp } = require('express');
const app = express();

const bot = new Router();

bot.use((req, res) => { res.text('hello!'); });

const botApp = new BotApp(bot, {
    apiUrl: 'https://<url to orchestrator>',
    secret: '<application secret in orchestrator>'
});

app.get('/bot', express.text(), (req, res) => {
   botApp.request(req.body, req.headers)
       .then((response) => {
           const { body, statusCode, headers } = response;

           res.status(statusCode)
               .set(headers)
               .send(body);
       })
});

BotApp.signBody(body, secret, appId) ⇒ `Promise.<string>`

Get authorization token for wingbot orchestrator

Kind: static method of BotApp

Param	Type
body	`string`
secret	`string`
appId	`string`

BotApp.plugin() ⇒ `Plugin`

Returns processor plugin, which updates thread context automatically

Kind: static method of BotApp

BotApp.sendContext(req, res)

Kind: static method of BotApp

Param	Type
req	`Request`
res	`Responder`