UNPKG

2.06 kBTypeScriptView Raw
1/**
2 * Copyright 2018 Google Inc. All Rights Reserved.
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16import * as Api from './api/v2';
17import { JsonObject } from '../../common';
18import { Conversation, ConversationBaseOptions, ConversationOptionsInit } from './conversation';
19/** @public */
20export interface ActionsSdkConversationOptions<TConvData, TUserStorage> extends ConversationBaseOptions<TConvData, TUserStorage> {
21 /** @public */
22 body?: Api.GoogleActionsV2AppRequest;
23}
24/** @public */
25export declare class ActionsSdkConversation<TConvData = JsonObject, TUserStorage = JsonObject> extends Conversation<TUserStorage> {
26 /** @public */
27 body: Api.GoogleActionsV2AppRequest;
28 /**
29 * Get the current Actions SDK intent.
30 *
31 * @example
32 * ```javascript
33 *
34 * app.intent('actions.intent.MAIN', conv => {
35 * const intent = conv.intent // will be 'actions.intent.MAIN'
36 * })
37 * ```
38 *
39 * @public
40 */
41 intent: string;
42 /**
43 * The session data in JSON format.
44 * Stored using conversationToken.
45 *
46 * @example
47 * ```javascript
48 *
49 * app.intent('actions.intent.MAIN', conv => {
50 * conv.data.someProperty = 'someValue'
51 * })
52 * ```
53 *
54 * @public
55 */
56 data: TConvData;
57 /** @hidden */
58 _init: ConversationOptionsInit<TConvData, TUserStorage>;
59 /** @public */
60 constructor(options?: ActionsSdkConversationOptions<TConvData, TUserStorage>);
61 /** @public */
62 serialize(): Api.GoogleActionsV2AppResponse;
63}