Compartilhar via

BotStatePropertyAccessor class

  • Referência
Pacote:
botbuilder-core

Uma implementação BotState específica da interface StatePropertyAccessor.

Comentários

As propriedades podem ser definidas para uma determinada instância de BotState usando createProperty().

const dialogStateProperty = ConversationState.createProperty('dialogState');
const dialogs = new DialogSet(dialogStateProperty);

Construtores

BotStatePropertyAccessor(BotState, string)

Cria uma nova instância de BotStatePropertyAccessor.

Propriedades

name

Métodos

delete(TurnContext)

Exclui a propriedade persistente de seu objeto de armazenamento de backup.
get(TurnContext)

Lê uma propriedade persistente de seu objeto de armazenamento de backup.
get(TurnContext, T)
set(TurnContext, T)

Atribui um novo valor ao objeto de armazenamento de backup de propriedades.

Detalhes do construtor

BotStatePropertyAccessor(BotState, string)

Cria uma nova instância de BotStatePropertyAccessor.

new BotStatePropertyAccessor(state: BotState, name: string)

Parâmetros

state
BotState

Instância do BotState pai.

name

string

Nome exclusivo da propriedade para o BotState pai.

Detalhes da propriedade

name 

name: string

Valor da propriedade

string

Detalhes do método

delete(TurnContext)

Exclui a propriedade persistente de seu objeto de armazenamento de backup.

function delete(context: TurnContext): Promise<void>

Parâmetros

context
TurnContext

(xref:botbuilder-core. Objeto TurnContext) para esta curva.

Retornos

Promise<void>

get(TurnContext)

Lê uma propriedade persistente de seu objeto de armazenamento de backup.

function get(context: TurnContext): Promise<T | undefined>

Parâmetros

context
TurnContext

(xref:botbuilder-core. Objeto TurnContext) para esta curva.

Retornos

Promise<T | undefined>

Uma representação JSON do estado armazenado em cache.

get(TurnContext, T) 

function get(context: TurnContext, defaultValue: T): Promise<T>

Parâmetros

context
TurnContext
defaultValue

T

Retornos

Promise<T>

set(TurnContext, T)

Atribui um novo valor ao objeto de armazenamento de backup de propriedades.

function set(context: TurnContext, value: T): Promise<void>

Parâmetros

context
TurnContext

(xref:botbuilder-core. Objeto TurnContext) para esta curva.

value

T

Valor a ser definido na propriedade.

Retornos

Promise<void>