DurableEntityContext interface

Pacote:: durable-functions

Fornece funcionalidade para o código do aplicativo que implementa uma operação de entidade.

Propriedades

entityId	Obtém a ID da entidade em execução no momento.
entityKey	Obtém a chave da entidade em execução no momento.
entityName	Obtém o nome da entidade em execução no momento.
isNewlyConstructed	Se essa entidade foi recém-construída, ou seja, não existia antes dessa operação ser chamada.
operationName	Obtém o nome da operação que foi chamada. Uma invocação de operação em uma entidade inclui um nome de operação, que indica qual operação executar e, opcionalmente, uma entrada de operação.

Métodos

destructOnExit()	Exclui essa entidade após a conclusão desta operação.
getInput<TInput>()	Obtém a entrada para esta operação. Uma invocação de operação em uma entidade inclui um nome de operação, que indica qual operação executar e, opcionalmente, uma entrada de operação.
getState(() => TState)	Obtém o estado atual dessa entidade, para leitura e/ou gravação.
return<TResult>(TResult)	Retorna o resultado determinado para o chamador desta operação.
setState(TState)	Define o estado atual dessa entidade.
signalEntity(EntityId, string, unknown)	Sinaliza uma entidade para executar uma operação, sem aguardar uma resposta. Qualquer resultado ou exceção é ignorado (acionar e esquecer).

Detalhes da propriedade

entityId

Obtém a ID da entidade em execução no momento.

entityId: EntityId

Valor da propriedade

EntityId

entityKey

Obtém a chave da entidade em execução no momento.

entityKey: string

Valor da propriedade

string

entityName

Obtém o nome da entidade em execução no momento.

entityName: string

Valor da propriedade

string

isNewlyConstructed

Se essa entidade foi recém-construída, ou seja, não existia antes dessa operação ser chamada.

isNewlyConstructed: boolean

Valor da propriedade

boolean

operationName

Obtém o nome da operação que foi chamada.

Uma invocação de operação em uma entidade inclui um nome de operação, que indica qual operação executar e, opcionalmente, uma entrada de operação.

operationName: undefined | string

Valor da propriedade

undefined | string

Detalhes do método

destructOnExit()

Exclui essa entidade após a conclusão desta operação.

function destructOnExit()

getInput<TInput>()

Obtém a entrada para esta operação.

Uma invocação de operação em uma entidade inclui um nome de operação, que indica qual operação executar e, opcionalmente, uma entrada de operação.

function getInput<TInput>(): undefined | TInput

Retornos

undefined | TInput

A entrada da operação ou indefinida se nenhuma.

getState(() => TState)

Obtém o estado atual dessa entidade, para leitura e/ou gravação.

function getState(initializer?: () => TState): undefined | TState

Parâmetros

initializer: () => TState

Fornece um valor inicial a ser usado para o estado, em vez do padrão de TState.

Retornos

undefined | TState

O estado atual dessa entidade ou indefinido se nenhum foi definido ainda.

return<TResult>(TResult)

Retorna o resultado determinado para o chamador desta operação.

function return<TResult>(result: TResult)

Parâmetros

result: TResult

O resultado a ser retornado.

setState(TState)

Define o estado atual dessa entidade.

function setState(state: TState)

Parâmetros

state: TState

O estado da entidade.

signalEntity(EntityId, string, unknown)

Sinaliza uma entidade para executar uma operação, sem aguardar uma resposta. Qualquer resultado ou exceção é ignorado (acionar e esquecer).

function signalEntity(entity: EntityId, operationName: string, operationInput?: unknown)

Parâmetros

entity: EntityId

A entidade de destino.

operationName: string

O nome da operação.

operationInput: unknown

A entrada da operação.