botbuilder-dialogs/lib/memory/scopes/botStateMemoryScope.d.ts

A dialog stack based conversation manager for Microsoft BotBuilder.

import { MemoryScope } from './memoryScope';
import { DialogContext } from '../../dialogContext';
/**
 * Base class for memory scopes based on BotState.
 */
export declare class BotStateMemoryScope extends MemoryScope {
    protected stateKey: string;
    /**
     * Initializes a new instance of the [BotStateMemoryScope](xref:adaptive-expressions.BotStateMemoryScope) class.
     *
     * @param name name of the property.
     */
    constructor(name: string);
    /**
     * Get the backing memory for this scope.
     *
     * @param dc current dialog context.
     * @returns Memory for the scope.
     */
    getMemory(dc: DialogContext): object;
    /**
     * Changes the backing object for the memory scope.
     *
     * @param dc current dialog context
     * @param _memory memory
     */
    setMemory(dc: DialogContext, _memory: object): void;
    /**
     * Populates the state cache for this [BotState](xref:botbuilder-core.BotState) from the storage layer.
     *
     * @param dc The [DialogContext](xref:botbuilder-dialogs.DialogContext) object for this turn.
     * @param force Optional, `true` to overwrite any existing state cache;
     * or `false` to load state from storage only if the cache doesn't already exist.
     * @returns A Promise that represents the work queued to execute.
     */
    load(dc: DialogContext, force?: boolean): Promise<void>;
    /**
     * Writes the state cache for this [BotState](xref:botbuilder-core.BotState) to the storage layer.
     *
     * @param dc The [DialogContext](xref:botbuilder-dialogs.DialogContext) object for this turn.
     * @param force Optional, `true` to save the state cache to storage;
     * or `false` to save state to storage only if a property in the cache has changed.
     * @returns A Promise that represents the work queued to execute.
     */
    saveChanges(dc: DialogContext, force?: boolean): Promise<void>;
    /**
     * Deletes any state in storage and the cache for this [BotState](xref:botbuilder-core.BotState).
     *
     * @param _dc The [DialogContext](xref:botbuilder-dialogs.DialogContext) object for this turn.
     * @returns A Promise that represents the work queued to execute.
     */
    delete(_dc: DialogContext): Promise<void>;
}
//# sourceMappingURL=botStateMemoryScope.d.ts.map