DialogStateManager class

Pacote:

botbuilder-dialogs

O DialogStateManager gerencia escopos de memória e resolvedores de caminho.

Comentários

MemoryScopes são objetos de nível raiz nomeados, que podem existir no contexto da caixa de diálogo ou fora do estado de desativação. Os resolvedores de caminho permitem o comportamento de atalho para mapear coisas como $foo -> dialog.foo

Construtores

DialogStateManager(DialogContext, DialogStateManagerConfiguration)

Inicializa uma nova instância da classe DialogStateManager .

Propriedades

configuration

Obtém ou define os resolvedores de caminho configurados e os escopos de memória do gerenciador de estado da caixa de diálogo.

Métodos

anyPathChanged(number, string[])	Verifique se algum caminho foi alterado desde a marca d'água.
deleteScopesMemory(string)	Exclui toda a memória de backup de um determinado escopo.
deleteValue(string)	Excluir propriedade da memória
getMemorySnapshot()	Obtém todos os escopos de memória adequados para registro em log.
getValue<T>(string, T | () => T)	Obtenha o valor da memória usando a expressão de caminho.
loadAllScopes()	Garante que todos os escopos de memória tenham sido carregados para a curva atual.
parsePath(string, boolean)	Normaliza os segmentos de caminho de um caminho passado.
saveAllChanges()	Salva as alterações feitas nos escopos de memória.
setValue(string, any)	Defina memória como valor.
trackPaths(string[])	Acompanhe quando caminhos específicos são alterados.
transformPath(string)	Transforme o caminho usando os transformadores de caminho registrados.
version()	Obtém o número da versão.

Detalhes do construtor

DialogStateManager(DialogContext, DialogStateManagerConfiguration)

Inicializa uma nova instância da classe DialogStateManager .

new DialogStateManager(dc: DialogContext, configuration?: DialogStateManagerConfiguration)

Parâmetros

dc

DialogContext

O contexto da caixa de diálogo para a virada atual da conversa.

configuration

DialogStateManagerConfiguration

Configuração do gerenciador de estado da caixa de diálogo.

Detalhes da propriedade

configuration

Obtém ou define os resolvedores de caminho configurados e os escopos de memória do gerenciador de estado da caixa de diálogo.

configuration: DialogStateManagerConfiguration

Valor da propriedade

DialogStateManagerConfiguration

Comentários

Há um único conjunto de informações de configuração para uma determinada cadeia de contextos de diálogo. Atribuir uma nova configuração a qualquer DialogStateManager dentro da cadeia atualizará a configuração de toda a cadeia.

Detalhes do método

anyPathChanged(number, string[])

Verifique se algum caminho foi alterado desde a marca d'água.

function anyPathChanged(counter: number, paths: string[]): boolean

Parâmetros

counter

number

Contador de tempo ao qual comparar.

paths

string[]

Caminhos de trackPaths() para verificar.

Retornos

boolean

True se algum caminho foi alterado desde o contador.

deleteScopesMemory(string)

Exclui toda a memória de backup de um determinado escopo.

function deleteScopesMemory(name: string): Promise<void>

Parâmetros

name

string

Nome do escopo.

Retornos

Promise<void>

deleteValue(string)

Excluir propriedade da memória

function deleteValue(pathExpression: string)

Parâmetros

pathExpression

string

A propriedade folha a ser removida.

getMemorySnapshot()

Obtém todos os escopos de memória adequados para registro em log.

function getMemorySnapshot(): object

Retornos

object

Objeto que representa todos os escopos de memória.

getValue<T>(string, T | () => T)

Obtenha o valor da memória usando a expressão de caminho.

function getValue<T>(pathExpression: string, defaultValue?: T | () => T): T

Parâmetros

pathExpression

string

Expressão de caminho a ser usada.

defaultValue

T | () => T

(Opcional) valor padrão a ser usado se o caminho não for encontrado. Pode ser uma função que retorna o valor padrão a ser usado.

Retornos

T

O valor encontrado ou indefinido se não for encontrado e nenhum defaultValue especificado.

Comentários

Isso sempre retorna um CLONE da memória, qualquer modificação no resultado não afetará a memória.

loadAllScopes()

Garante que todos os escopos de memória tenham sido carregados para a curva atual.

function loadAllScopes(): Promise<void>

Retornos

Promise<void>

Comentários

Isso deve ser chamado no início da curva.

parsePath(string, boolean)

Normaliza os segmentos de caminho de um caminho passado.

function parsePath(pathExpression: string, allowNestedPaths?: boolean): string | number[]

Parâmetros

pathExpression

string

O caminho para normalizar.

allowNestedPaths

boolean

Opcional. Se false, a detecção de um caminho aninhado fará com que um caminho vazio seja retornado. O padrão é 'true'.

Retornos

string | number[]

O caminho normalizado.

Comentários

Um caminho de profile.address[0] será normalizado para profile.address.0.

saveAllChanges()

Salva as alterações feitas nos escopos de memória.

function saveAllChanges(): Promise<void>

Retornos

Promise<void>

Comentários

Isso deve ser chamado no final da curva.

setValue(string, any)

Defina memória como valor.

function setValue(pathExpression: string, value: any)

Parâmetros

pathExpression

string

Caminho para a memória.

value

any

Valor a ser definido.

trackPaths(string[])

Acompanhe quando caminhos específicos são alterados.

function trackPaths(paths: string[]): string[]

Parâmetros

paths

string[]

Caminhos a serem rastreados.

Retornos

string[]

Caminhos normalizados para passar para anyPathChanged().

transformPath(string)

Transforme o caminho usando os transformadores de caminho registrados.

function transformPath(pathExpression: string): string

Parâmetros

pathExpression

string

O caminho a ser transformado.

Retornos

string

O caminho transformado.

version()

Obtém o número da versão.

function version(): string

Retornos

string

Uma cadeia de caracteres com o número da versão.