Facebook Messenger plugin for wingbot

Connector plugin for wingbot chatbot framework

Advanced features

$3

You can include a full JSON Action string to run a certain interaction in your bot using metadata in a handover event.

``json { "sender":{ "id":"" }, "recipient":{ "id":"" }, "timestamp":1458692752478, "pass_thread_control":{ "new_owner_app_id":"123456789", "metadata":"{\"action\":\"your-action\",\"data\":{}}" } }`

-----------------

`API`


Classes

Facebook


Settings


MenuComposer


Functions

userLoader(pageToken, [logger])

User loader middleware


Typedefs

AttachmentCache : object


Facebook

Kind: global class  
* Facebook
    * [new Facebook(processor, options, [senderLogger])](#new_Facebook_new)
    * .DEFAULT_EVENT_KEYS
    * .verifyWebhook(queryString) ⇒ string
    * .verifyRequest(body, headers) ⇒ Promise
    * .processMessage(message, senderId, pageId, data) ⇒ Promise.<{status:number}>
    * [.processEvent(body, [data])](#Facebook+processEvent) ⇒ Promise.<Array.<{message:object, pageId:string}>>
$3
| Param | Type | Description |
| --- | --- | --- |
| processor | Processor |  |
| options | object |  |
| options.pageToken | string | facebook page token |
| options.appId | string | facebook app id |
| [options.botToken] | string | botToken for webhook verification |
| [options.appSecret] | string | provide app secret to verify requests |
| [options.passThreadAction] | string | trigger this action for pass thread event |
| [options.takeThreadAction] | string | trigger this action for take thread event |
| [options.requestThreadAction] | string | trigger this action when thread request |
| [options.allowEventKeys] | Array.<string> | list of keys, allowed to process |
| [options.throwsExceptions] | boolean | allows processEvents method to thow exception |
| [options.apiUrl] | string | override Facebook API url |
| [options.attachmentStorage] | AttachmentCache | cache for reusing attachments |
| [options.requestLib] | function | request library replacement |
| [senderLogger] | console | optional console like chat logger |
$3

Kind: instance property of Facebook  
Properties
| Name | Type | Description |
| --- | --- | --- |
| Default | Array.<string> | keys allowed to process |
$3

Verifies Bots webhook against Facebook
Kind: instance method of Facebook  
Throws:
- Error when the request is invalid

| Param | Type |
| --- | --- |
| queryString | object | 
$3

Verify Facebook webhook event
Kind: instance method of Facebook  
Throws:
- Error when x-hub-signature does not match body signature

| Param | Type |
| --- | --- |
| body | Buffer \| string | 
| headers | object | 
$3

Kind: instance method of Facebook  
| 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 |
$3

Process Facebook request
Kind: instance method of Facebook  
Returns: Promise.<Array.<{message:object, pageId:string}>> - - unprocessed events  
| Param | Type | Description |
| --- | --- | --- |
| body | object | event body |
| [data] | object | event context data |
Settings

Kind: global class  
* Settings
    * new Settings()
    * _instance_
        * [.greeting([text])](#Settings+greeting) ⇒ Promise
        * [.getStartedButton([payload])](#Settings+getStartedButton) ⇒ Promise
        * .whitelistDomain(domains) ⇒ Promise
        * .noMenu() ⇒ Promise
        * [.menu([locale], [inputDisabled])](#Settings+menu) ⇒ MenuComposer
    * _static_
        * .Settings
            * [new Settings(token, [log], [req])](#new_Settings.Settings_new)
$3

Utility, which helps us to set up chatbot behavior
$3

Sets or clears bot's greeting
Kind: instance method of Settings  
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [text] | string | false | leave empty to clear |
$3

Sets up the Get Started Button
Kind: instance method of Settings  
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [payload] | string \| object | false | leave blank to remove button, or provide the action |

Example`javascript const settings = new Settings(config.facebook.pageToken); settings.getStartedButton('/start'); // just an action`

`$3`


Useful for using facebook extension in webviews
Kind: instance method of Settings  
| Param | Type |
| --- | --- |
| domains | string \| Array.<string> | 
$3

Drops the menu
Kind: instance method of Settings  
$3

Sets up the persistent menu
Kind: instance method of Settings  
| Param | Type | Default |
| --- | --- | --- |
| [locale] | string | "default" | 
| [inputDisabled] | boolean | false |

Example`javascript const { Settings } = require('wingbot');

const settings = new Settings('page-token-string');

settings .menu('fr_FR') .addNested('Nested Menu') .addUrl('Aller à google', 'https://google.com') .done() .addPostBack('Faire quelque chose', '/the/action') .menu() // the default menu .addNested('Nested Menu') .addUrl('Go to google', 'https://google.com') .done() .addPostBack('Do something', '/the/action') .done();`

`$3`


Kind: static class of Settings  
#### new Settings(token, [log], [req])
Creates an instance of Settings.

| Param | Type | Description |
| --- | --- | --- |
| token | string |  |
| [log] | Object |  |
| [req] | function | request library for resting purposes |
MenuComposer

Kind: global class  
* MenuComposer
    * [new MenuComposer(onDone, [isTopLevel])](#new_MenuComposer_new)
    * [.addPostBack(title, action, [data])](#MenuComposer+addPostBack) ⇒ this
    * [.addUrl(title, url, [hasExtension], [webviewHeight])](#MenuComposer+addUrl) ⇒ this
    * .addNested(title) ⇒ MenuComposer
    * .done() ⇒ this \| Promise
    * [.menu([locale], [inputDisabled])](#MenuComposer+menu) ⇒ MenuComposer
$3
| Param | Type | Default |
| --- | --- | --- |
| onDone | function |  | 
| [isTopLevel] | boolean | true | 
$3

Add postback to menu
Kind: instance method of MenuComposer  
| Param | Type |
| --- | --- |
| title | string | 
| action | string | 
| [data] | object | 
$3

Add webview to menu
Kind: instance method of MenuComposer  
| Param | Type | Default |
| --- | --- | --- |
| title | string |  | 
| url | string |  | 
| [hasExtension] | boolean | false | 
| [webviewHeight] | string | null | 
$3

Add Nested menu component
Kind: instance method of MenuComposer  
| Param | Type |
| --- | --- |
| title | string | 
$3

Finish the menu
Last call of "done" returns a promise
Kind: instance method of MenuComposer  
$3

Finish the menu for the locale and starts a new menu
Kind: instance method of MenuComposer  
| Param | Type | Default |
| --- | --- | --- |
| [locale] | string | "default" | 
| [inputDisabled] | boolean | false | 
userLoader(pageToken, [logger])

User loader middleware
Kind: global function  
| Param | Type |
| --- | --- |
| pageToken | string | 
| [logger] | console |

Example`javascript const { userLoader } = require('wingbot-facebook');

bot.use(userLoader(''));

bot.use((req, res) => { const { firstName, lastName, profilePic, locale, gender } = req.state.user;

res.text(Hello ${firstName}!); });``

AttachmentCache : `object`

Kind: global typedef
Properties

| Name | Type |
| --- | --- |
| findAttachmentByUrl | function |
| saveAttachmentId | function |

Facebook Messenger plugin for wingbot

Connector plugin for wingbot chatbot framework

Advanced features

$3

You can include a full JSON Action string to run a certain interaction in your bot using metadata in a handover event.

``json { "sender":{ "id":"" }, "recipient":{ "id":"" }, "timestamp":1458692752478, "pass_thread_control":{ "new_owner_app_id":"123456789", "metadata":"{\"action\":\"your-action\",\"data\":{}}" } }`

-----------------

`API`


Classes

Facebook


Settings


MenuComposer


Functions

userLoader(pageToken, [logger])

User loader middleware


Typedefs

AttachmentCache : object


Facebook

Kind: global class  
* Facebook
    * [new Facebook(processor, options, [senderLogger])](#new_Facebook_new)
    * .DEFAULT_EVENT_KEYS
    * .verifyWebhook(queryString) ⇒ string
    * .verifyRequest(body, headers) ⇒ Promise
    * .processMessage(message, senderId, pageId, data) ⇒ Promise.<{status:number}>
    * [.processEvent(body, [data])](#Facebook+processEvent) ⇒ Promise.<Array.<{message:object, pageId:string}>>
$3
| Param | Type | Description |
| --- | --- | --- |
| processor | Processor |  |
| options | object |  |
| options.pageToken | string | facebook page token |
| options.appId | string | facebook app id |
| [options.botToken] | string | botToken for webhook verification |
| [options.appSecret] | string | provide app secret to verify requests |
| [options.passThreadAction] | string | trigger this action for pass thread event |
| [options.takeThreadAction] | string | trigger this action for take thread event |
| [options.requestThreadAction] | string | trigger this action when thread request |
| [options.allowEventKeys] | Array.<string> | list of keys, allowed to process |
| [options.throwsExceptions] | boolean | allows processEvents method to thow exception |
| [options.apiUrl] | string | override Facebook API url |
| [options.attachmentStorage] | AttachmentCache | cache for reusing attachments |
| [options.requestLib] | function | request library replacement |
| [senderLogger] | console | optional console like chat logger |
$3

Kind: instance property of Facebook  
Properties
| Name | Type | Description |
| --- | --- | --- |
| Default | Array.<string> | keys allowed to process |
$3

Verifies Bots webhook against Facebook
Kind: instance method of Facebook  
Throws:
- Error when the request is invalid

| Param | Type |
| --- | --- |
| queryString | object | 
$3

Verify Facebook webhook event
Kind: instance method of Facebook  
Throws:
- Error when x-hub-signature does not match body signature

| Param | Type |
| --- | --- |
| body | Buffer \| string | 
| headers | object | 
$3

Kind: instance method of Facebook  
| 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 |
$3

Process Facebook request
Kind: instance method of Facebook  
Returns: Promise.<Array.<{message:object, pageId:string}>> - - unprocessed events  
| Param | Type | Description |
| --- | --- | --- |
| body | object | event body |
| [data] | object | event context data |
Settings

Kind: global class  
* Settings
    * new Settings()
    * _instance_
        * [.greeting([text])](#Settings+greeting) ⇒ Promise
        * [.getStartedButton([payload])](#Settings+getStartedButton) ⇒ Promise
        * .whitelistDomain(domains) ⇒ Promise
        * .noMenu() ⇒ Promise
        * [.menu([locale], [inputDisabled])](#Settings+menu) ⇒ MenuComposer
    * _static_
        * .Settings
            * [new Settings(token, [log], [req])](#new_Settings.Settings_new)
$3

Utility, which helps us to set up chatbot behavior
$3

Sets or clears bot's greeting
Kind: instance method of Settings  
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [text] | string | false | leave empty to clear |
$3

Sets up the Get Started Button
Kind: instance method of Settings  
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [payload] | string \| object | false | leave blank to remove button, or provide the action |

Example`javascript const settings = new Settings(config.facebook.pageToken); settings.getStartedButton('/start'); // just an action`

`$3`


Useful for using facebook extension in webviews
Kind: instance method of Settings  
| Param | Type |
| --- | --- |
| domains | string \| Array.<string> | 
$3

Drops the menu
Kind: instance method of Settings  
$3

Sets up the persistent menu
Kind: instance method of Settings  
| Param | Type | Default |
| --- | --- | --- |
| [locale] | string | "default" | 
| [inputDisabled] | boolean | false |

Example`javascript const { Settings } = require('wingbot');

const settings = new Settings('page-token-string');

`$3`


Kind: static class of Settings  
#### new Settings(token, [log], [req])
Creates an instance of Settings.

| Param | Type | Description |
| --- | --- | --- |
| token | string |  |
| [log] | Object |  |
| [req] | function | request library for resting purposes |
MenuComposer

Kind: global class  
* MenuComposer
    * [new MenuComposer(onDone, [isTopLevel])](#new_MenuComposer_new)
    * [.addPostBack(title, action, [data])](#MenuComposer+addPostBack) ⇒ this
    * [.addUrl(title, url, [hasExtension], [webviewHeight])](#MenuComposer+addUrl) ⇒ this
    * .addNested(title) ⇒ MenuComposer
    * .done() ⇒ this \| Promise
    * [.menu([locale], [inputDisabled])](#MenuComposer+menu) ⇒ MenuComposer
$3
| Param | Type | Default |
| --- | --- | --- |
| onDone | function |  | 
| [isTopLevel] | boolean | true | 
$3

Add postback to menu
Kind: instance method of MenuComposer  
| Param | Type |
| --- | --- |
| title | string | 
| action | string | 
| [data] | object | 
$3

Add webview to menu
Kind: instance method of MenuComposer  
| Param | Type | Default |
| --- | --- | --- |
| title | string |  | 
| url | string |  | 
| [hasExtension] | boolean | false | 
| [webviewHeight] | string | null | 
$3

Add Nested menu component
Kind: instance method of MenuComposer  
| Param | Type |
| --- | --- |
| title | string | 
$3

Finish the menu
Last call of "done" returns a promise
Kind: instance method of MenuComposer  
$3

Finish the menu for the locale and starts a new menu
Kind: instance method of MenuComposer  
| Param | Type | Default |
| --- | --- | --- |
| [locale] | string | "default" | 
| [inputDisabled] | boolean | false | 
userLoader(pageToken, [logger])

User loader middleware
Kind: global function  
| Param | Type |
| --- | --- |
| pageToken | string | 
| [logger] | console |

Example`javascript const { userLoader } = require('wingbot-facebook');

bot.use(userLoader(''));

bot.use((req, res) => { const { firstName, lastName, profilePic, locale, gender } = req.state.user;

res.text(Hello ${firstName}!); });``

AttachmentCache : `object`

Kind: global typedef
Properties

| Name | Type |
| --- | --- |
| findAttachmentByUrl | function |
| saveAttachmentId | function |

@cs-chatbots/wingbot-facebook

Facebook Messenger plugin for wingbot

Advanced features

$3

API

Classes

Functions

Typedefs

Facebook

$3

$3

$3

$3

$3

$3

Settings

$3

$3

$3

$3

$3

$3

$3

MenuComposer

$3

$3

$3

$3

$3

$3

userLoader(pageToken, [logger])

AttachmentCache : object

@cs-chatbots/wingbot-facebook

Facebook Messenger plugin for wingbot

Advanced features

$3

API

Classes

Functions

Typedefs

Facebook

$3

$3

$3

$3

$3

$3

Settings

$3

$3

$3

$3

$3

$3

$3

MenuComposer

$3

$3

$3

$3

$3

$3

userLoader(pageToken, [logger])

AttachmentCache : object

`API`

`$3`

`$3`

AttachmentCache : `object`

`API`

`$3`

`$3`

AttachmentCache : `object`