botnaut
Version:
Facebook Messenger Chatbot Framework
1,274 lines (705 loc) • 40.3 kB
HTML
<html lang="" >
<head>
<meta charset="UTF-8">
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
<title>Request · Botnaut</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="description" content="">
<meta name="generator" content="GitBook 3.2.3">
<meta name="author" content="David Menger">
<link rel="stylesheet" href="../gitbook/style.css">
<link rel="stylesheet" href="../gitbook/gitbook-plugin-anchors/plugin.css">
<link rel="stylesheet" href="../gitbook/gitbook-plugin-highlight/website.css">
<link rel="stylesheet" href="../gitbook/gitbook-plugin-search/search.css">
<link rel="stylesheet" href="../gitbook/gitbook-plugin-fontsettings/website.css">
<meta name="HandheldFriendly" content="true"/>
<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
<meta name="apple-mobile-web-app-capable" content="yes">
<meta name="apple-mobile-web-app-status-bar-style" content="black">
<link rel="apple-touch-icon-precomposed" sizes="152x152" href="../gitbook/images/apple-touch-icon-precomposed-152.png">
<link rel="shortcut icon" href="../gitbook/images/favicon.ico" type="image/x-icon">
<link rel="next" href="Responder.html" />
<link rel="prev" href="../tutorial/usingWithWingbot.html" />
</head>
<body>
<div class="book">
<div class="book-summary">
<div id="book-search-input" role="search">
<input type="text" placeholder="Type to search" />
</div>
<nav role="navigation">
<ul class="summary">
<li class="header">Building a chat bot</li>
<li class="chapter " data-level="1.1" data-path="../">
<a href="../">
Getting Started
</a>
</li>
<li class="chapter " data-level="1.2" data-path="../tutorial/buildingConversation.html">
<a href="../tutorial/buildingConversation.html">
Building a Conversation
</a>
<ul class="articles">
<li class="chapter " data-level="1.2.1" data-path="../tutorial/buildingConversation.html">
<a href="../tutorial/buildingConversation.html#asking-a-question">
Asking a question
</a>
</li>
<li class="chapter " data-level="1.2.2" data-path="../tutorial/buildingConversation.html">
<a href="../tutorial/buildingConversation.html#using-quick-replies-for-controlling-conversation">
Using quick replies
</a>
</li>
<li class="chapter " data-level="1.2.3" data-path="../tutorial/buildingConversation.html">
<a href="../tutorial/buildingConversation.html#post-back-is-also-an-action">
Postbacks
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.3" data-path="../tutorial/conversationState.html">
<a href="../tutorial/conversationState.html">
Conversation State
</a>
<ul class="articles">
<li class="chapter " data-level="1.3.1" data-path="../tutorial/conversationState.html">
<a href="../tutorial/conversationState.html#accessing-user-profile">
User profile
</a>
</li>
<li class="chapter " data-level="1.3.2" data-path="../tutorial/conversationState.html">
<a href="../tutorial/conversationState.html#using-the-state-in-navigation">
Using state in navigation
</a>
</li>
<li class="chapter " data-level="1.3.3" data-path="../tutorial/conversationState.html">
<a href="../tutorial/conversationState.html#reading-and-modifiing-user-state">
Reading and writing state
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.4" data-path="../tutorial/asyncActions.html">
<a href="../tutorial/asyncActions.html">
Asynchronous Actions
</a>
<ul class="articles">
<li class="chapter " data-level="1.4.1" data-path="../tutorial/asyncActions.html">
<a href="../tutorial/asyncActions.html#blocking-asynchronous-actions">
Blocking Actions
</a>
</li>
<li class="chapter " data-level="1.4.2" data-path="../tutorial/asyncActions.html">
<a href="../tutorial/asyncActions.html#non-blocking-asynchronous-actions">
Non Blocking Actions
</a>
</li>
<li class="chapter " data-level="1.4.3" data-path="../tutorial/asyncActions.html">
<a href="../tutorial/asyncActions.html#loading-attachments-to-buffer">
Loading Attachments
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.5" data-path="../tutorial/advancedRouting.html">
<a href="../tutorial/advancedRouting.html">
Advanced Routing
</a>
<ul class="articles">
<li class="chapter " data-level="1.5.1" data-path="../tutorial/advancedRouting.html">
<a href="../tutorial/advancedRouting.html#resolving-actions">
Resolving Actions
</a>
</li>
<li class="chapter " data-level="1.5.2" data-path="../tutorial/advancedRouting.html">
<a href="../tutorial/advancedRouting.html#simple-text-actions">
Text Actions
</a>
</li>
<li class="chapter " data-level="1.5.3" data-path="../tutorial/advancedRouting.html">
<a href="../tutorial/advancedRouting.html#integrating-with-ai-prediction">
Integrating AI
</a>
</li>
<li class="chapter " data-level="1.5.4" data-path="../tutorial/advancedRouting.html">
<a href="../tutorial/advancedRouting.html#redirecting-flow-with-post-back">
Redirecting with Postback
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.6" data-path="../tutorial/nestingRouters.html">
<a href="../tutorial/nestingRouters.html">
Nesting - Reusable Blocks
</a>
<ul class="articles">
<li class="chapter " data-level="1.6.1" data-path="../tutorial/nestingRouters.html">
<a href="../tutorial/nestingRouters.html#basic-concept">
Concept
</a>
</li>
<li class="chapter " data-level="1.6.2" data-path="../tutorial/nestingRouters.html">
<a href="../tutorial/nestingRouters.html#example">
Example
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.7" data-path="../tutorial/templates.html">
<a href="../tutorial/templates.html">
Sending Templates
</a>
<ul class="articles">
<li class="chapter " data-level="1.7.1" data-path="../tutorial/templates.html">
<a href="../tutorial/templates.html#button-template">
Button Template
</a>
</li>
<li class="chapter " data-level="1.7.2" data-path="../tutorial/templates.html">
<a href="../tutorial/templates.html#generic-template">
Generic Template
</a>
</li>
<li class="chapter " data-level="1.7.3" data-path="../tutorial/templates.html">
<a href="../tutorial/templates.html#receipt-template">
Receipt Template
</a>
</li>
<li class="chapter " data-level="1.7.4" data-path="../tutorial/templates.html">
<a href="../tutorial/templates.html#working-with-webviews">
Webviews
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.8" data-path="../tutorial/testing.html">
<a href="../tutorial/testing.html">
Testing
</a>
</li>
<li class="chapter " data-level="1.9" data-path="../tutorial/analytics.html">
<a href="../tutorial/analytics.html">
Analytics
</a>
</li>
<li class="chapter " data-level="1.10" data-path="../tutorial/usingWithWingbot.html">
<a href="../tutorial/usingWithWingbot.html">
Using with Wingbot.ai
</a>
<ul class="articles">
<li class="chapter " data-level="1.10.1" data-path="../tutorial/usingWithWingbot.html">
<a href="../tutorial/usingWithWingbot.html#bot-configuration">
Bot configuration
</a>
</li>
<li class="chapter " data-level="1.10.2" data-path="../tutorial/usingWithWingbot.html">
<a href="../tutorial/usingWithWingbot.html#express-mongodb">
Express Mongodb
</a>
</li>
<li class="chapter " data-level="1.10.3" data-path="../tutorial/usingWithWingbot.html">
<a href="../tutorial/usingWithWingbot.html#serverless-aws-lambda">
Serverless AWS Lambda
</a>
</li>
</ul>
</li>
<li class="header">API</li>
<li class="chapter active" data-level="2.1" data-path="Request.html">
<a href="Request.html">
Request
</a>
</li>
<li class="chapter " data-level="2.2" data-path="Responder.html">
<a href="Responder.html">
Responder
</a>
</li>
<li class="chapter " data-level="2.3" data-path="Router.html">
<a href="Router.html">
Router
</a>
</li>
<li class="chapter " data-level="2.4" data-path="Tester.html">
<a href="Tester.html">
Tester
</a>
</li>
<li class="chapter " data-level="2.5" data-path="ButtonTemplate.html">
<a href="ButtonTemplate.html">
Template Builders
</a>
<ul class="articles">
<li class="chapter " data-level="2.5.1" data-path="ButtonTemplate.html">
<a href="ButtonTemplate.html#ButtonTemplate">
ButtonTemplate
</a>
</li>
<li class="chapter " data-level="2.5.2" data-path="ButtonTemplate.html">
<a href="ButtonTemplate.html#GenericTemplate">
GenericTemplate
</a>
</li>
<li class="chapter " data-level="2.5.3" data-path="ButtonTemplate.html">
<a href="ButtonTemplate.html#ReceiptTemplate">
ReceiptTemplate
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="2.6" data-path="Settings.html">
<a href="Settings.html">
Bot Settings
</a>
</li>
<li class="chapter " data-level="2.7" data-path="express.html">
<a href="express.html">
Express/MongoDb tools
</a>
</li>
<li class="chapter " data-level="2.8" data-path="bufferloader.html">
<a href="bufferloader.html">
Utils
</a>
</li>
<li class="chapter " data-level="2.9" data-path="Ai.html">
<a href="Ai.html">
Ai
</a>
</li>
<li class="chapter " data-level="2.10" data-path="serverlessAWS.html">
<a href="serverlessAWS.html">
Serverless
</a>
</li>
<li class="chapter " data-level="2.11" data-path="BuildRouter.html">
<a href="BuildRouter.html">
Wingbot.ai
</a>
</li>
<li class="chapter " data-level="2.12" data-path="callback.html">
<a href="callback.html">
Middlewares
</a>
</li>
<li class="divider"></li>
<li>
<a href="https://www.gitbook.com" target="blank" class="gitbook-link">
Published with GitBook
</a>
</li>
</ul>
</nav>
</div>
<div class="book-body">
<div class="body-inner">
<div class="book-header" role="navigation">
<!-- Title -->
<h1>
<i class="fa fa-circle-o-notch fa-spin"></i>
<a href=".." >Request</a>
</h1>
</div>
<div class="page-wrapper" tabindex="-1" role="main">
<div class="page-inner">
<div id="book-search-results">
<div class="search-noresults">
<section class="normal markdown-section">
<div id="Request"> </div>
<h2 id="request"><a name="request" class="plugin-anchor" href="#request"><i class="fa fa-link" aria-hidden="true"></i></a>Request</h2>
<p><strong>Kind</strong>: global class </p>
<ul>
<li><a href="#Request">Request</a><ul>
<li><a href="#new_Request_new">new Request()</a></li>
<li><a href="#Request_timestamp">.timestamp</a></li>
<li><a href="#Request_senderId">.senderId</a></li>
<li><a href="#Request_recipientId">.recipientId</a></li>
<li><a href="#Request_pageId">.pageId</a></li>
<li><a href="#Request_state">.state</a></li>
<li><a href="#Request_isAttachment">.isAttachment()</a> ⇒ <code>boolean</code></li>
<li><a href="#Request_isImage">.isImage([attachmentIndex])</a> ⇒ <code>boolean</code></li>
<li><a href="#Request_isFile">.isFile([attachmentIndex])</a> ⇒ <code>boolean</code></li>
<li><a href="#Request_attachment">.attachment([attachmentIndex])</a> ⇒ <code>object</code> | <code>null</code></li>
<li><a href="#Request_attachmentUrl">.attachmentUrl([attachmentIndex])</a> ⇒ <code>string</code> | <code>null</code></li>
<li><a href="#Request_isMessage">.isMessage()</a> ⇒ <code>boolean</code></li>
<li><a href="#Request_isQuickReply">.isQuickReply()</a> ⇒ <code>boolean</code></li>
<li><a href="#Request_isText">.isText()</a> ⇒ <code>boolean</code></li>
<li><a href="#Request_text">.text([tokenized])</a> ⇒ <code>string</code></li>
<li><a href="#Request_expected">.expected()</a> ⇒ <code>string</code> | <code>null</code></li>
<li><a href="#Request_quickReply">.quickReply([getData])</a> ⇒ <code>null</code> | <code>string</code> | <code>object</code></li>
<li><a href="#Request_isPostBack">.isPostBack()</a> ⇒ <code>boolean</code></li>
<li><a href="#Request_isReferral">.isReferral()</a> ⇒ <code>boolean</code></li>
<li><a href="#Request_isPassThread">.isPassThread()</a> ⇒ <code>boolean</code></li>
<li><a href="#Request_isOptin">.isOptin()</a> ⇒ <code>boolean</code></li>
<li><a href="#Request_action">.action([getData])</a> ⇒ <code>null</code> | <code>string</code> | <code>object</code></li>
<li><a href="#Request_postBack">.postBack([getData])</a> ⇒ <code>null</code> | <code>string</code> | <code>object</code></li>
</ul>
</li>
</ul>
<div id="new_Request_new"> </div>
<h3 id="new-request"><a name="new-request" class="plugin-anchor" href="#new-request"><i class="fa fa-link" aria-hidden="true"></i></a>new Request()</h3>
<p>Instance of {Request} class is passed as first parameter of handler (req)</p>
<div id="Request_timestamp"> </div>
<h3 id="requesttimestamp"><a name="requesttimestamp" class="plugin-anchor" href="#requesttimestamp"><i class="fa fa-link" aria-hidden="true"></i></a>request.timestamp</h3>
<p><strong>Kind</strong>: instance property of <a href="#Request"><code>Request</code></a><br><strong>Properties</strong></p>
<table>
<thead>
<tr>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>number</code> \</td>
<td><code>null</code></td>
</tr>
</tbody>
</table>
<div id="Request_senderId"> </div>
<h3 id="requestsenderid"><a name="requestsenderid" class="plugin-anchor" href="#requestsenderid"><i class="fa fa-link" aria-hidden="true"></i></a>request.senderId</h3>
<p><strong>Kind</strong>: instance property of <a href="#Request"><code>Request</code></a><br><strong>Properties</strong></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>senderId</td>
<td><code>string</code></td>
<td>sender.id from the event</td>
</tr>
</tbody>
</table>
<div id="Request_recipientId"> </div>
<h3 id="requestrecipientid"><a name="requestrecipientid" class="plugin-anchor" href="#requestrecipientid"><i class="fa fa-link" aria-hidden="true"></i></a>request.recipientId</h3>
<p><strong>Kind</strong>: instance property of <a href="#Request"><code>Request</code></a><br><strong>Properties</strong></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>recipientId</td>
<td><code>string</code></td>
<td>recipient.id from the event</td>
</tr>
</tbody>
</table>
<div id="Request_pageId"> </div>
<h3 id="requestpageid"><a name="requestpageid" class="plugin-anchor" href="#requestpageid"><i class="fa fa-link" aria-hidden="true"></i></a>request.pageId</h3>
<p><strong>Kind</strong>: instance property of <a href="#Request"><code>Request</code></a><br><strong>Properties</strong></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>pageId</td>
<td><code>string</code></td>
<td>page identifier from the event</td>
</tr>
</tbody>
</table>
<div id="Request_state"> </div>
<h3 id="requeststate"><a name="requeststate" class="plugin-anchor" href="#requeststate"><i class="fa fa-link" aria-hidden="true"></i></a>request.state</h3>
<p><strong>Kind</strong>: instance property of <a href="#Request"><code>Request</code></a><br><strong>Properties</strong></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>state</td>
<td><code>object</code></td>
<td>current state of the conversation</td>
</tr>
</tbody>
</table>
<div id="Request_isAttachment"> </div>
<h3 id="requestisattachment-⇒-boolean"><a name="requestisattachment-⇒-boolean" class="plugin-anchor" href="#requestisattachment-⇒-boolean"><i class="fa fa-link" aria-hidden="true"></i></a>request.isAttachment() ⇒ <code>boolean</code></h3>
<p>Checks, when message contains an attachment (file, image or location)</p>
<p><strong>Kind</strong>: instance method of <a href="#Request"><code>Request</code></a> </p>
<div id="Request_isImage"> </div>
<h3 id="requestisimageattachmentindex-⇒-boolean"><a name="requestisimageattachmentindex-⇒-boolean" class="plugin-anchor" href="#requestisimageattachmentindex-⇒-boolean"><i class="fa fa-link" aria-hidden="true"></i></a>request.isImage([attachmentIndex]) ⇒ <code>boolean</code></h3>
<p>Checks, when the attachment is an image</p>
<p><strong>Kind</strong>: instance method of <a href="#Request"><code>Request</code></a> </p>
<table>
<thead>
<tr>
<th>Param</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>[attachmentIndex]</td>
<td><code>number</code></td>
<td><code>0</code></td>
<td>use, when user sends more then one attachment</td>
</tr>
</tbody>
</table>
<div id="Request_isFile"> </div>
<h3 id="requestisfileattachmentindex-⇒-boolean"><a name="requestisfileattachmentindex-⇒-boolean" class="plugin-anchor" href="#requestisfileattachmentindex-⇒-boolean"><i class="fa fa-link" aria-hidden="true"></i></a>request.isFile([attachmentIndex]) ⇒ <code>boolean</code></h3>
<p>Checks, when the attachment is a file</p>
<p><strong>Kind</strong>: instance method of <a href="#Request"><code>Request</code></a> </p>
<table>
<thead>
<tr>
<th>Param</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>[attachmentIndex]</td>
<td><code>number</code></td>
<td><code>0</code></td>
<td>use, when user sends more then one attachment</td>
</tr>
</tbody>
</table>
<div id="Request_attachment"> </div>
<h3 id="requestattachmentattachmentindex-⇒-object--null"><a name="requestattachmentattachmentindex-⇒-object--null" class="plugin-anchor" href="#requestattachmentattachmentindex-⇒-object--null"><i class="fa fa-link" aria-hidden="true"></i></a>request.attachment([attachmentIndex]) ⇒ <code>object</code> | <code>null</code></h3>
<p>Returns whole attachment or null</p>
<p><strong>Kind</strong>: instance method of <a href="#Request"><code>Request</code></a> </p>
<table>
<thead>
<tr>
<th>Param</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>[attachmentIndex]</td>
<td><code>number</code></td>
<td><code>0</code></td>
<td>use, when user sends more then one attachment</td>
</tr>
</tbody>
</table>
<div id="Request_attachmentUrl"> </div>
<h3 id="requestattachmenturlattachmentindex-⇒-string--null"><a name="requestattachmenturlattachmentindex-⇒-string--null" class="plugin-anchor" href="#requestattachmenturlattachmentindex-⇒-string--null"><i class="fa fa-link" aria-hidden="true"></i></a>request.attachmentUrl([attachmentIndex]) ⇒ <code>string</code> | <code>null</code></h3>
<p>Returns attachment URL</p>
<p><strong>Kind</strong>: instance method of <a href="#Request"><code>Request</code></a> </p>
<table>
<thead>
<tr>
<th>Param</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>[attachmentIndex]</td>
<td><code>number</code></td>
<td><code>0</code></td>
<td>use, when user sends more then one attachment</td>
</tr>
</tbody>
</table>
<div id="Request_isMessage"> </div>
<h3 id="requestismessage-⇒-boolean"><a name="requestismessage-⇒-boolean" class="plugin-anchor" href="#requestismessage-⇒-boolean"><i class="fa fa-link" aria-hidden="true"></i></a>request.isMessage() ⇒ <code>boolean</code></h3>
<p>Returns true, when the request is text message, quick reply or attachment</p>
<p><strong>Kind</strong>: instance method of <a href="#Request"><code>Request</code></a> </p>
<div id="Request_isQuickReply"> </div>
<h3 id="requestisquickreply-⇒-boolean"><a name="requestisquickreply-⇒-boolean" class="plugin-anchor" href="#requestisquickreply-⇒-boolean"><i class="fa fa-link" aria-hidden="true"></i></a>request.isQuickReply() ⇒ <code>boolean</code></h3>
<p>Check, that message is a quick reply</p>
<p><strong>Kind</strong>: instance method of <a href="#Request"><code>Request</code></a> </p>
<div id="Request_isText"> </div>
<h3 id="requestistext-⇒-boolean"><a name="requestistext-⇒-boolean" class="plugin-anchor" href="#requestistext-⇒-boolean"><i class="fa fa-link" aria-hidden="true"></i></a>request.isText() ⇒ <code>boolean</code></h3>
<p>Check, that message is PURE text</p>
<p><strong>Kind</strong>: instance method of <a href="#Request"><code>Request</code></a> </p>
<div id="Request_text"> </div>
<h3 id="requesttexttokenized-⇒-string"><a name="requesttexttokenized-⇒-string" class="plugin-anchor" href="#requesttexttokenized-⇒-string"><i class="fa fa-link" aria-hidden="true"></i></a>request.text([tokenized]) ⇒ <code>string</code></h3>
<p>Returns text of the message</p>
<p><strong>Kind</strong>: instance method of <a href="#Request"><code>Request</code></a> </p>
<table>
<thead>
<tr>
<th>Param</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>[tokenized]</td>
<td><code>boolean</code></td>
<td><code>false</code></td>
<td>when true, message is normalized to lowercase with <code>-</code></td>
</tr>
</tbody>
</table>
<p><strong>Example</strong> </p>
<pre><code class="lang-javascript"><span class="hljs-built_in">console</span>.log(req.text(<span class="hljs-literal">true</span>)) <span class="hljs-comment">// "can-you-help-me"</span>
</code></pre>
<div id="Request_expected"> </div>
<h3 id="requestexpected-⇒-string--null"><a name="requestexpected-⇒-string--null" class="plugin-anchor" href="#requestexpected-⇒-string--null"><i class="fa fa-link" aria-hidden="true"></i></a>request.expected() ⇒ <code>string</code> | <code>null</code></h3>
<p>Returns the request expected handler in case have been set last response</p>
<p><strong>Kind</strong>: instance method of <a href="#Request"><code>Request</code></a> </p>
<div id="Request_quickReply"> </div>
<h3 id="requestquickreplygetdata-⇒-null--string--object"><a name="requestquickreplygetdata-⇒-null--string--object" class="plugin-anchor" href="#requestquickreplygetdata-⇒-null--string--object"><i class="fa fa-link" aria-hidden="true"></i></a>request.quickReply([getData]) ⇒ <code>null</code> | <code>string</code> | <code>object</code></h3>
<p>Returns action or data of quick reply
When <code>getData</code> is <code>true</code>, object will be returned. Otherwise string or null.</p>
<p><strong>Kind</strong>: instance method of <a href="#Request"><code>Request</code></a> </p>
<table>
<thead>
<tr>
<th>Param</th>
<th>Type</th>
<th>Default</th>
</tr>
</thead>
<tbody>
<tr>
<td>[getData]</td>
<td><code>boolean</code></td>
<td><code>false</code></td>
</tr>
</tbody>
</table>
<p><strong>Example</strong> </p>
<pre><code class="lang-javascript"><span class="hljs-keyword">typeof</span> res.quickReply() === <span class="hljs-string">'string'</span> || res.quickReply() === <span class="hljs-literal">null</span>;
<span class="hljs-keyword">typeof</span> res.quickReply(<span class="hljs-literal">true</span>) === <span class="hljs-string">'object'</span>;
</code></pre>
<div id="Request_isPostBack"> </div>
<h3 id="requestispostback-⇒-boolean"><a name="requestispostback-⇒-boolean" class="plugin-anchor" href="#requestispostback-⇒-boolean"><i class="fa fa-link" aria-hidden="true"></i></a>request.isPostBack() ⇒ <code>boolean</code></h3>
<p>Returns true, if request is the postback</p>
<p><strong>Kind</strong>: instance method of <a href="#Request"><code>Request</code></a> </p>
<div id="Request_isReferral"> </div>
<h3 id="requestisreferral-⇒-boolean"><a name="requestisreferral-⇒-boolean" class="plugin-anchor" href="#requestisreferral-⇒-boolean"><i class="fa fa-link" aria-hidden="true"></i></a>request.isReferral() ⇒ <code>boolean</code></h3>
<p>Returns true, if request is the referral</p>
<p><strong>Kind</strong>: instance method of <a href="#Request"><code>Request</code></a> </p>
<div id="Request_isPassThread"> </div>
<h3 id="requestispassthread-⇒-boolean"><a name="requestispassthread-⇒-boolean" class="plugin-anchor" href="#requestispassthread-⇒-boolean"><i class="fa fa-link" aria-hidden="true"></i></a>request.isPassThread() ⇒ <code>boolean</code></h3>
<p>Returns true, if request pass thread control</p>
<p><strong>Kind</strong>: instance method of <a href="#Request"><code>Request</code></a> </p>
<div id="Request_isOptin"> </div>
<h3 id="requestisoptin-⇒-boolean"><a name="requestisoptin-⇒-boolean" class="plugin-anchor" href="#requestisoptin-⇒-boolean"><i class="fa fa-link" aria-hidden="true"></i></a>request.isOptin() ⇒ <code>boolean</code></h3>
<p>Returns true, if request is the optin</p>
<p><strong>Kind</strong>: instance method of <a href="#Request"><code>Request</code></a> </p>
<div id="Request_action"> </div>
<h3 id="requestactiongetdata-⇒-null--string--object"><a name="requestactiongetdata-⇒-null--string--object" class="plugin-anchor" href="#requestactiongetdata-⇒-null--string--object"><i class="fa fa-link" aria-hidden="true"></i></a>request.action([getData]) ⇒ <code>null</code> | <code>string</code> | <code>object</code></h3>
<p>Returns action of the postback or quickreply
When <code>getData</code> is <code>true</code>, object will be returned. Otherwise string or null.</p>
<ol>
<li>the postback is checked</li>
<li>the referral is checked</li>
<li>the quick reply is checked</li>
<li>expected keywords are checked</li>
<li>expected state is checked</li>
</ol>
<p><strong>Kind</strong>: instance method of <a href="#Request"><code>Request</code></a> </p>
<table>
<thead>
<tr>
<th>Param</th>
<th>Type</th>
<th>Default</th>
</tr>
</thead>
<tbody>
<tr>
<td>[getData]</td>
<td><code>boolean</code></td>
<td><code>false</code></td>
</tr>
</tbody>
</table>
<p><strong>Example</strong> </p>
<pre><code class="lang-javascript"><span class="hljs-keyword">typeof</span> res.action() === <span class="hljs-string">'string'</span> || res.action() === <span class="hljs-literal">null</span>;
<span class="hljs-keyword">typeof</span> res.action(<span class="hljs-literal">true</span>) === <span class="hljs-string">'object'</span>;
</code></pre>
<div id="Request_postBack"> </div>
<h3 id="requestpostbackgetdata-⇒-null--string--object"><a name="requestpostbackgetdata-⇒-null--string--object" class="plugin-anchor" href="#requestpostbackgetdata-⇒-null--string--object"><i class="fa fa-link" aria-hidden="true"></i></a>request.postBack([getData]) ⇒ <code>null</code> | <code>string</code> | <code>object</code></h3>
<p>Returns action or data of postback
When <code>getData</code> is <code>true</code>, object will be returned. Otherwise string or null.</p>
<p><strong>Kind</strong>: instance method of <a href="#Request"><code>Request</code></a> </p>
<table>
<thead>
<tr>
<th>Param</th>
<th>Type</th>
<th>Default</th>
</tr>
</thead>
<tbody>
<tr>
<td>[getData]</td>
<td><code>boolean</code></td>
<td><code>false</code></td>
</tr>
</tbody>
</table>
<p><strong>Example</strong> </p>
<pre><code class="lang-javascript"><span class="hljs-keyword">typeof</span> res.postBack() === <span class="hljs-string">'string'</span> || res.postBack() === <span class="hljs-literal">null</span>;
<span class="hljs-keyword">typeof</span> res.postBack(<span class="hljs-literal">true</span>) === <span class="hljs-string">'object'</span>;
</code></pre>
</section>
</div>
<div class="search-results">
<div class="has-results">
<h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
<ul class="search-results-list"></ul>
</div>
<div class="no-results">
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
</div>
</div>
</div>
</div>
</div>
</div>
<a href="../tutorial/usingWithWingbot.html#serverless-aws-lambda" class="navigation navigation-prev " aria-label="Previous page: Serverless AWS Lambda">
<i class="fa fa-angle-left"></i>
</a>
<a href="Responder.html" class="navigation navigation-next " aria-label="Next page: Responder">
<i class="fa fa-angle-right"></i>
</a>
</div>
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Request","level":"2.1","depth":1,"next":{"title":"Responder","level":"2.2","depth":1,"path":"api/Responder.md","ref":"api/Responder.md","articles":[]},"previous":{"title":"Serverless AWS Lambda","level":"1.10.3","depth":2,"anchor":"#serverless-aws-lambda","path":"tutorial/usingWithWingbot.md","ref":"tutorial/usingWithWingbot.md#serverless-aws-lambda","articles":[]},"dir":"ltr"},"config":{"plugins":["theme-default","collapsible-menu","anchors"],"styles":{"ebook":"styles/ebook.css","epub":"styles/epub.css","mobi":"styles/mobi.css","pdf":"styles/pdf.css","print":"styles/print.css","website":"styles/website.css"},"pluginsConfig":{"collapsible-menu":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"highlight":{},"theme-api":{"theme":"dark","languages":[{"lang":"js","name":"JavaScript","default":true}]},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"showLevel":false,"styles":{"ebook":"styles/ebook.css","epub":"styles/epub.css","mobi":"styles/mobi.css","pdf":"styles/pdf.css","print":"styles/print.css","website":"styles/website.css"}},"anchors":{}},"theme":"default","author":"David Menger","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{"twitter":"https://twitter.com/davidmenger"},"title":"Botnaut","gitbook":"*","description":"Facebook Messenger framework for Node.js"},"file":{"path":"api/Request.md","mtime":"2018-05-23T15:31:55.009Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-05-23T15:31:59.833Z"},"basePath":"..","book":{"language":""}});
});
</script>
</div>
<script src="../gitbook/gitbook.js"></script>
<script src="../gitbook/theme.js"></script>
<script src="../gitbook/gitbook-plugin-collapsible-menu/plugin.js"></script>
<script src="../gitbook/gitbook-plugin-search/search-engine.js"></script>
<script src="../gitbook/gitbook-plugin-search/search.js"></script>
<script src="../gitbook/gitbook-plugin-lunr/lunr.min.js"></script>
<script src="../gitbook/gitbook-plugin-lunr/search-lunr.js"></script>
<script src="../gitbook/gitbook-plugin-sharing/buttons.js"></script>
<script src="../gitbook/gitbook-plugin-fontsettings/fontsettings.js"></script>
</body>
</html>