## WebhookClient This is the class that handles the communication with Dialogflow's webhook fulfillment API v1 & v2 with support for rich responses across 8 platforms and Dialogflow's simulator **Kind**: global class * [WebhookClient](#webhookclient) * [new WebhookClient(options)](#new_webhookclient_new) * [.agentVersion](#webhookclient_agentversion) : number * [.intent](#webhookclient_intent) : string * [.action](#webhookclient_action) : string * [.parameters](#webhookclient_parameters) : Object * ~~[.contexts](#webhookclient_contexts) : string~~ * [.context](#webhookclient_context) : Contexts * [.requestSource](#webhookclient_requestsource) : string * [.originalRequest](#webhookclient_originalrequest) : object * [.query](#webhookclient_query) : string * [.locale](#webhookclient_locale) : string * [.session](#webhookclient_session) : string * [.consoleMessages](#webhookclient_consolemessages) : [Array.<RichResponse>](#richresponse) * [.alternativeQueryResults](#webhookclient_alternativequeryresults) : object * [.add(responses)](#webhookclient_add) * [.end(responses)](#webhookclient_end) * [.addResponse_(response)](#webhookclient_addresponse_) * [.handleRequest(handler)](#webhookclient_handlerequest) ⇒ Promise * ~~[.setContext(context)](#webhookclient_setcontext) ⇒ [WebhookClient](#webhookclient)~~ * ~~[.clearOutgoingContexts()](#webhookclient_clearoutgoingcontexts) ⇒ [WebhookClient](#webhookclient)~~ * ~~[.clearContext(context)](#webhookclient_clearcontext) ⇒ [WebhookClient](#webhookclient)~~ * ~~[.getContext(contextName)](#webhookclient_getcontext) ⇒ Object~~ * [.setFollowupEvent(event)](#webhookclient_setfollowupevent) * [.conv()](#webhookclient_conv) ⇒ DialogflowConversation \| null ### new WebhookClient(options) Constructor for WebhookClient object To be used in the Dialogflow fulfillment webhook logic | Param | Type | Description | | --- | --- | --- | | options | Object | JSON configuration. | | options.request | Object | Express HTTP request object. | | options.response | Object | Express HTTP response object. | ### webhookClient.agentVersion : number The agent version (v1 or v2) based on Dialogflow webhook request https://dialogflow.com/docs/reference/v2-comparison **Kind**: instance property of [WebhookClient](#webhookclient) ### webhookClient.intent : string Dialogflow intent name or null if no value: https://dialogflow.com/docs/intents **Kind**: instance property of [WebhookClient](#webhookclient) ### webhookClient.action : string Dialogflow action or null if no value: https://dialogflow.com/docs/actions-and-parameters **Kind**: instance property of [WebhookClient](#webhookclient) ### webhookClient.parameters : Object Dialogflow parameters included in the request or null if no value https://dialogflow.com/docs/actions-and-parameters **Kind**: instance property of [WebhookClient](#webhookclient) ### ~~webhookClient.contexts : string~~ ***Deprecated*** Dialogflow contexts included in the request or null if no value https://dialogflow.com/docs/contexts **Kind**: instance property of [WebhookClient](#webhookclient) ### webhookClient.context : Contexts Instance of Dialogflow contexts class to provide an API to set/get/delete contexts **Kind**: instance property of [WebhookClient](#webhookclient) ### webhookClient.requestSource : string Dialogflow source included in the request or null if no value https://dialogflow.com/docs/reference/agent/query#query_parameters_and_json_fields **Kind**: instance property of [WebhookClient](#webhookclient) ### webhookClient.originalRequest : object Dialogflow original request object from detectIntent/query or platform integration (Google Assistant, Slack, etc.) in the request or null if no value https://dialogflow.com/docs/reference/agent/query#query_parameters_and_json_fields **Kind**: instance property of [WebhookClient](#webhookclient) ### webhookClient.query : string Original user query as indicated by Dialogflow or null if no value **Kind**: instance property of [WebhookClient](#webhookclient) ### webhookClient.locale : string Original request language code or locale (i.e. "en" or "en-US") **Kind**: instance property of [WebhookClient](#webhookclient) ### webhookClient.session : string Dialogflow input contexts included in the request or null if no value Dialogflow v2 API only https://dialogflow.com/docs/reference/api-v2/rest/v2beta1/WebhookRequest#FIELDS.session **Kind**: instance property of [WebhookClient](#webhookclient) ### webhookClient.consoleMessages : [Array.<RichResponse>](#richresponse) List of messages defined in Dialogflow's console for the matched intent https://dialogflow.com/docs/rich-messages **Kind**: instance property of [WebhookClient](#webhookclient) ### webhookClient.alternativeQueryResults : object List of alternative query results Query results can be from other Dialogflow intents or Knowledge Connectors https://cloud.google.com/dialogflow-enterprise/alpha/docs/knowledge-connectors Note:this feature only availbe in Dialogflow v2 **Kind**: instance property of [WebhookClient](#webhookclient) ### webhookClient.add(responses) Add a response or list of responses to be sent to Dialogflow **Kind**: instance method of [WebhookClient](#webhookclient) | Param | Type | Description | | --- | --- | --- | | responses | [RichResponse](#richresponse) \| string \| [Array.<RichResponse>](#richresponse) \| Array.<string> | (list) or single responses | ### webhookClient.end(responses) Add a response or list of responses to be sent to Dialogflow and end the conversation Note: Only supported on Dialogflow v2's telephony gateway, Google Assistant and Alexa integrations **Kind**: instance method of [WebhookClient](#webhookclient) | Param | Type | Description | | --- | --- | --- | | responses | [RichResponse](#richresponse) \| string \| [Array.<RichResponse>](#richresponse) \| Array.<string> | (list) or single responses | ### webhookClient.addResponse_(response) Add a response to be sent to Dialogflow Private method to add a response to be sent to Dialogflow **Kind**: instance method of [WebhookClient](#webhookclient) | Param | Type | Description | | --- | --- | --- | | response | [RichResponse](#richresponse) \| string | an object or string representing the rich response to be added | ### webhookClient.handleRequest(handler) ⇒ Promise Handles the incoming Dialogflow request using a handler or Map of handlers Each handler must be a function callback. **Kind**: instance method of [WebhookClient](#webhookclient) | Param | Type | Description | | --- | --- | --- | | handler | Map \| requestCallback | map of Dialogflow action name to handler function or function to handle all requests (regardless of Dialogflow action). | ### ~~webhookClient.setContext(context) ⇒ [WebhookClient](#webhookclient)~~ ***Deprecated*** Set a new Dialogflow outgoing context: https://dialogflow.com/docs/contexts **Kind**: instance method of [WebhookClient](#webhookclient) | Param | Type | Description | | --- | --- | --- | | context | string \| Object | name of context or an object representing a context | **Example** ```js const { WebhookClient } = require('dialogflow-webhook'); const agent = new WebhookClient({request: request, response: response}); agent.setContext('sample context name'); const context = {'name': 'weather', 'lifespan': 2, 'parameters': {'city': 'Rome'}}; agent.setContext(context); ``` ### ~~webhookClient.clearOutgoingContexts() ⇒ [WebhookClient](#webhookclient)~~ ***Deprecated*** Clear all existing outgoing contexts: https://dialogflow.com/docs/contexts **Kind**: instance method of [WebhookClient](#webhookclient) **Example** ```js const { WebhookClient } = require('dialogflow-webhook'); const agent = new WebhookClient({request: request, response: response}); agent.clearOutgoingContexts(); ``` ### ~~webhookClient.clearContext(context) ⇒ [WebhookClient](#webhookclient)~~ ***Deprecated*** Clear an existing outgoing context: https://dialogflow.com/docs/contexts **Kind**: instance method of [WebhookClient](#webhookclient) | Param | Type | Description | | --- | --- | --- | | context | string | name of an existing outgoing context | **Example** ```js const { WebhookClient } = require('dialogflow-webhook'); const agent = new WebhookClient({request: request, response: response}); agent.clearContext('sample context name'); ``` ### ~~webhookClient.getContext(contextName) ⇒ Object~~ ***Deprecated*** Get an context from the Dialogflow webhook request: https://dialogflow.com/docs/contexts **Kind**: instance method of [WebhookClient](#webhookclient) **Returns**: Object - context context object with the context name | Param | Type | Description | | --- | --- | --- | | contextName | string | name of an context present in the Dialogflow webhook request | **Example** ```js const { WebhookClient } = require('dialogflow-webhook'); const agent = new WebhookClient({request: request, response: response}); let context = agent.getContext('sample context name'); ``` ### webhookClient.setFollowupEvent(event) Set the followup event **Kind**: instance method of [WebhookClient](#webhookclient) | Param | Type | Description | | --- | --- | --- | | event | string \| Object | string with the name of the event or an event object | **Example** ```js const { WebhookClient } = require('dialogflow-webhook'); const agent = new WebhookClient({request: request, response: response}); let event = agent.setFollowupEvent('sample event name'); ``` ### webhookClient.conv() ⇒ DialogflowConversation \| null Get Actions on Google DialogflowConversation object **Kind**: instance method of [WebhookClient](#webhookclient) **Returns**: DialogflowConversation \| null - DialogflowConversation object or null **Example** ```js const { WebhookClient } = require('dialogflow-webhook'); const agent = new WebhookClient({request: request, response: response}); let conv = agent.conv(); conv.ask('Hi from the Actions on Google client library'); agent.add(conv); ``` ## V2Agent Class representing a v2 Dialogflow agent **Kind**: global class * [V2Agent](#v2agent) * [new V2Agent(agent)](#new_v2agent_new) * [.end_(responses)](#v2agent_end_) ### new V2Agent(agent) Constructor for V2Agent object To be used in with WebhookClient class | Param | Type | Description | | --- | --- | --- | | agent | Object | instance of WebhookClient class | ### v2Agent.end_(responses) Add a response or list of responses to be sent to Dialogflow and end the conversation Note: Only supported on Dialogflow v2's telephony gateway, Google Assistant and Alexa integrations **Kind**: instance method of [V2Agent](#v2agent) | Param | Type | Description | | --- | --- | --- | | responses | [RichResponse](#richresponse) \| string \| [Array.<RichResponse>](#richresponse) \| Array.<string> | (list) or single responses | ## V1Agent Class representing a v1 Dialogflow agent **Kind**: global class * [V1Agent](#v1agent) * [new V1Agent(agent)](#new_v1agent_new) * [.end_()](#v1agent_end_) ### new V1Agent(agent) Constructor for V1Agent object To be used in with WebhookClient class | Param | Type | Description | | --- | --- | --- | | agent | Object | instance of WebhookClient class | ### v1Agent.end_() Add a response or list of responses to be sent to Dialogflow and end the conversation Note: not support on v1 **Kind**: instance method of [V1Agent](#v1agent) ## Context This is the class that handles Dialogflow's contexts for the WebhookClient class **Kind**: global class * [Context](#context) * [new Context(inputContexts, session)](#new_context_new) * [.contexts](#context_contexts) : object * [.set(name, [lifespan], [params])](#context_set) * [.get(name)](#context_get) ⇒ Object \| null * [.delete(name)](#context_delete) * [.getV1OutputContextsArray()](#context_getv1outputcontextsarray) ⇒ Array.<Object> * [.getV2OutputContextsArray()](#context_getv2outputcontextsarray) ⇒ Array.<Object> ### new Context(inputContexts, session) Constructor for Context object To be used in by Dialogflow's webhook client class context objects take are formatted as follows: { "context-name": { "lifespan": 5, "parameters": { "param": "value" } } } | Param | Type | Description | | --- | --- | --- | | inputContexts | Object | input contexts of a v1 or v2 webhook request | | session | string | for a v2 webhook request & response | ### context.contexts : object Dialogflow contexts included in the request or empty object if no value https://dialogflow.com/docs/contexts **Kind**: instance property of [Context](#context) ### context.set(name, [lifespan], [params]) Set a new Dialogflow outgoing context: https://dialogflow.com/docs/contexts **Kind**: instance method of [Context](#context) | Param | Type | Default | Description | | --- | --- | --- | --- | | name | string \| Object | | of context or an object representing a context | | [lifespan] | number | 5 | lifespan of context, number with a value of 0 or greater | | [params] | Object | | parameters of context (can be arbitrary key-value pairs) | **Example** ```js const { WebhookClient } = require('dialogflow-webhook'); const agent = new WebhookClient({request: request, response: response}); agent.context.set('sample context name'); const context = {'name': 'weather', 'lifespan': 2, 'parameters': {'city': 'Rome'}}; ``` ### context.get(name) ⇒ Object \| null Get an context from the Dialogflow webhook request: https://dialogflow.com/docs/contexts **Kind**: instance method of [Context](#context) **Returns**: Object \| null - context object with lifespan and parameters (if defined) or null | Param | Type | Description | | --- | --- | --- | | name | string | of an context present in the Dialogflow webhook request | **Example** ```js const { WebhookClient } = require('dialogflow-webhook'); const agent = new WebhookClient({request: request, response: response}); let context = agent.context.get('sample context name'); ``` ### context.delete(name) Delete an context a Dialogflow session (set the lifespan to 0) **Kind**: instance method of [Context](#context) **Access**: public | Param | Type | Description | | --- | --- | --- | | name | string | of context to be deleted | **Example** ```js const { WebhookClient } = require('dialogflow-webhook'); const agent = new WebhookClient({request: request, response: response}); agent.context.delete('no-longer-relevant-context-name'); ``` ### context.getV1OutputContextsArray() ⇒ Array.<Object> Get array of context objects formatted for v1 webhook response **Kind**: instance method of [Context](#context) **Returns**: Array.<Object> - array of v1 context objects for webhook response ### context.getV2OutputContextsArray() ⇒ Array.<Object> Get array of context objects formatted for v2 webhook response **Kind**: instance method of [Context](#context) **Returns**: Array.<Object> - array of v2 context objects for webhook response