Classes

MemoryStateStorage

Memory conversation state storage for testing purposes

ReturnSender

Functions

bufferloader(url, [limit], [limitJustByBody], [redirCount]) ⇒ Promise.<Buffer>

Downloads a file from url into a buffer. Supports size limits and redirects.

compileWithState(req, res, template) ⇒ string

Utility, which helps to render handlebars syntax with all variables within conversations state

makeExpectedKeyword(action, title, [matcher], [payloadData], [setState], [aiTitle]) ⇒ ExpectedKeyword

disambiguationQuickReply(title, likelyIntent, disambText, action, data)

Create a disambiguation quick reply

Typedefs

ExpectedKeyword : object

QuickReplyAction : object

State : object

StateCondition : object

GetInteractions ⇒ Promise.<Array.<object>>

ChatLogStorage : object

ReturnSenderOptions : object

UploadResult : object

DeferOperation ⇒ Promise.<any>

ErrorLogger : object

SendOptions : object

TextFilter ⇒ string

Text filter function

MemoryStateStorage

Memory conversation state storage for testing purposes

Kind: global class

• MemoryStateStorage
  • .getState(senderId, pageId) ⇒ Promise.<(State|null)>
  • .getOrCreateAndLock(senderId, pageId, defaultState, lockTimeout) ⇒ Promise.<State>
  • .saveState(state) ⇒ Promise
  • .getStates(condition, limit, lastKey) ⇒ Promise.<{Array.<data:State>, lastKey:string}>

memoryStateStorage.getState(senderId, pageId) ⇒ Promise.<(State|null)>

Kind: instance method of MemoryStateStorage

memoryStateStorage.getOrCreateAndLock(senderId, pageId, defaultState, lockTimeout) ⇒ Promise.<State>

Kind: instance method of MemoryStateStorage
Returns: Promise.<State> - - conversation state

memoryStateStorage.saveState(state) ⇒ Promise

Kind: instance method of MemoryStateStorage

memoryStateStorage.getStates(condition, limit, lastKey) ⇒ Promise.<{Array.<data:State>, lastKey:string}>

Kind: instance method of MemoryStateStorage

ReturnSender

Kind: global class

• ReturnSender
  • new ReturnSender(options, senderId, incommingMessage, logger)
  • .responses : Array.<object>
  • ._responseOptions : Array.<SendOptions>
  • .waits : boolean
  • .textFilter : TextFilter
  • .requestTexts ⇒ Array.<string>
  • .responseTexts ⇒ Array.<string>
  • .chatLogStorage ⇒ ChatLogStorage
  • .tracking ⇒ TrackingObject
  • .defer(operation, logger)
  • .upload(data, contentType, fileName) ⇒ Promise.<UploadResult>
  • .send(payload, options) ⇒ void
  • .modifyStateAfterLoad() ⇒ Promise.<(object|null)>
  • .modifyStateBeforeStore() ⇒ Promise.<(object|null)>
  • .finished([req], [res], [err], [reportError]) ⇒ Promise.<Object>

new ReturnSender(options, senderId, incommingMessage, logger)

returnSender.responses : Array.<object>

Kind: instance property of ReturnSender

returnSender._responseOptions : Array.<SendOptions>

Kind: instance property of ReturnSender

returnSender.waits : boolean

Kind: instance property of ReturnSender

returnSender.textFilter : TextFilter

Preprocess text for NLP For example to remove any confidential data

Kind: instance property of ReturnSender

returnSender.requestTexts ⇒ Array.<string>

Kind: instance property of ReturnSender

returnSender.responseTexts ⇒ Array.<string>

Kind: instance property of ReturnSender

returnSender.chatLogStorage ⇒ ChatLogStorage

Kind: instance property of ReturnSender

returnSender.tracking ⇒ TrackingObject

Kind: instance property of ReturnSender

returnSender.defer(operation, logger)

Kind: instance method of ReturnSender

returnSender.upload(data, contentType, fileName) ⇒ Promise.<UploadResult>

Kind: instance method of ReturnSender

returnSender.send(payload, options) ⇒ void

Kind: instance method of ReturnSender

returnSender.modifyStateAfterLoad() ⇒ Promise.<(object|null)>

Kind: instance method of ReturnSender

returnSender.modifyStateBeforeStore() ⇒ Promise.<(object|null)>

Kind: instance method of ReturnSender

returnSender.finished([req], [res], [err], [reportError]) ⇒ Promise.<Object>

Kind: instance method of ReturnSender

bufferloader(url, [limit], [limitJustByBody], [redirCount]) ⇒ Promise.<Buffer>

Downloads a file from url into a buffer. Supports size limits and redirects.

Kind: global function

Example

router.use('*', (req, res, postBack) => {
    if (req.isFile()) {
        bufferloader(req.attachmentUrl())
            .then(buffer => postBack('downloaded', { data: buffer }))
            .catch(err => postBack('donwloaded', { err }))
    }
});

compileWithState(req, res, template) ⇒ string

Utility, which helps to render handlebars syntax with all variables within conversations state

Kind: global function

Example

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

function myPluginFactory (params) {

    return (req, res) => {
        const text = compileWithState(req, res, params.text);
        res.text(text);
    };
}

makeExpectedKeyword(action, title, [matcher], [payloadData], [setState], [aiTitle]) ⇒ ExpectedKeyword

Kind: global function

disambiguationQuickReply(title, likelyIntent, disambText, action, data)

Deprecated

Create a disambiguation quick reply

Kind: global function

ExpectedKeyword : object

Kind: global typedef
Properties

QuickReplyAction : object

Kind: global typedef
Properties

State : object

Kind: global typedef
Properties

StateCondition : object

Kind: global typedef
Properties

GetInteractions ⇒ Promise.<Array.<object>>

Kind: global typedef

ChatLogStorage : object

Kind: global typedef
Properties

ReturnSenderOptions : object

Kind: global typedef
Properties

UploadResult : object

Kind: global typedef
Properties

DeferOperation ⇒ Promise.<any>

Kind: global typedef

ErrorLogger : object

Kind: global typedef
Properties

SendOptions : object

Kind: global typedef
Properties

TextFilter ⇒ string

Text filter function

Kind: global typedef
Returns: string - - filtered text