actions-on-google/dist/service/dialogflow/context.d.ts

Actions on Google Client Library for Node.js

/**
 * Copyright 2018 Google Inc. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
import * as Api from './api/v2';
import * as ApiV1 from './api/v1';
/** @public */
export interface Parameters {
    /** @public */
    [parameter: string]: string | Object | undefined;
}
/** @public */
export interface Contexts {
    /** @public */
    [context: string]: Context<Parameters> | undefined;
}
/** @public */
export interface OutputContexts {
    /** @public */
    [context: string]: OutputContext<Parameters> | undefined;
}
/** @public */
export interface Context<TParameters extends Parameters> extends OutputContext<TParameters> {
    /**
     * Full name of the context.
     * @public
     */
    name: string;
    /**
     * Remaining number of intents
     * @public
     */
    lifespan: number;
    /**
     * The context parameters from the current intent.
     * Context parameters include parameters collected in previous intents
     * during the lifespan of the given context.
     *
     * See {@link https://dialogflow.com/docs/concept-actions#section-extracting-values-from-contexts|
     *     here}.
     *
     * @example
     * ```javascript
     *
     * app.intent('Tell Greeting', conv => {
     *   const context1 = conv.contexts.get('context1')
     *   const parameters = context1.parameters
     *   const color = parameters.color
     *   const num = parameters.num
     * })
     *
     * // Using destructuring
     * app.intent('Tell Greeting', conv => {
     *   const context1 = conv.contexts.get('context1')
     *   const { color, num } = context1.parameters
     * })
     * ```
     *
     * @public
     */
    parameters: TParameters;
}
/** @public */
export interface OutputContext<TParameters extends Parameters> {
    /** @public */
    lifespan: number;
    /** @public */
    parameters?: TParameters;
}
export declare class ContextValues<TContexts extends Contexts> {
    private _session?;
    /** @public */
    input: TContexts;
    /** @public */
    output: OutputContexts;
    /** @hidden */
    constructor(outputContexts?: Api.GoogleCloudDialogflowV2Context[] | ApiV1.DialogflowV1Context[], _session?: string);
    /** @hidden */
    _serialize(): Api.GoogleCloudDialogflowV2Context[];
    /** @hidden */
    _serializeV1(): ApiV1.DialogflowV1Context[];
    /**
     * Returns the incoming context by name for this intent.
     *
     * @example
     * ```javascript
     *
     * const AppContexts = {
     *   NUMBER: 'number',
     * }
     *
     * const app = dialogflow()
     *
     * app.intent('Default Welcome Intent', conv => {
     *   conv.contexts.set(AppContexts.NUMBER, 1)
     *   conv.ask('Welcome to action snippets! Say a number.')
     * })
     *
     * // Create intent with 'number' context as requirement
     * app.intent('Number Input', conv => {
     *   const context = conv.contexts.get(AppContexts.NUMBER)
     * })
     * ```
     *
     * @param name The name of the Context to retrieve.
     * @return Context value matching name or undefined if no matching context.
     * @public
     */
    get(name: keyof TContexts): TContexts[keyof TContexts];
    /**
     * Set a new context for the current intent.
     *
     * @example
     * ```javascript
     *
     * const AppContexts = {
     *   NUMBER: 'number',
     * }
     *
     * const app = dialogflow()
     *
     * app.intent('Default Welcome Intent', conv => {
     *   conv.contexts.set(AppContexts.NUMBER, 1)
     *   conv.ask('Welcome to action snippets! Say a number.')
     * })
     *
     * // Create intent with 'number' context as requirement
     * app.intent('Number Input', conv => {
     *   const context = conv.contexts.get(AppContexts.NUMBER)
     * })
     * ```
     *
     * @param name Name of the context. Dialogflow converts to lowercase.
     * @param lifespan Context lifespan.
     * @param parameters Context parameters.
     * @public
     */
    set(name: string, lifespan: number, parameters?: Parameters): void;
    /** @public */
    delete(name: string): void;
    /**
     * Returns the incoming contexts for this intent as an iterator.
     *
     * @example
     * ```javascript
     *
     * const AppContexts = {
     *   NUMBER: 'number',
     * }
     *
     * const app = dialogflow()
     *
     * app.intent('Default Welcome Intent', conv => {
     *   conv.contexts.set(AppContexts.NUMBER, 1)
     *   conv.ask('Welcome to action snippets! Say a number.')
     * })
     *
     * // Create intent with 'number' context as requirement
     * app.intent('Number Input', conv => {
     *   for (const context of conv.contexts) {
     *     // do something with the contexts
     *   }
     * })
     * ```
     *
     * @public
     */
    [Symbol.iterator](): IterableIterator<Context<Parameters>>;
}