DurableEntityContext interface

Pacchetto:

durable-functions

Fornisce funzionalità per il codice dell'applicazione che implementa un'operazione di entità.

Proprietà

entityId	Ottiene l'ID dell'entità attualmente in esecuzione.
entityKey	Ottiene la chiave dell'entità attualmente in esecuzione.
entityName	Ottiene il nome dell'entità attualmente in esecuzione.
isNewlyConstructed	Indica se questa entità è appena costruita, ovvero non esisteva prima della chiamata a questa operazione.
operationName	Ottiene il nome dell'operazione chiamata. Una chiamata a un'operazione in un'entità include un nome di operazione, che indica l'operazione da eseguire e, facoltativamente, un input dell'operazione.

Metodi

destructOnExit()	Elimina questa entità al termine dell'operazione.
getInput<TInput>()	Ottiene l'input per questa operazione. Una chiamata a un'operazione in un'entità include un nome di operazione, che indica l'operazione da eseguire e, facoltativamente, un input dell'operazione.
getState(() => TState)	Ottiene lo stato corrente dell'entità per la lettura e/o la scrittura.
return<TResult>(TResult)	Restituisce il risultato specificato al chiamante di questa operazione.
setState(TState)	Imposta lo stato corrente di questa entità.
signalEntity(EntityId, string, unknown)	Segnala a un'entità di eseguire un'operazione, senza attendere una risposta. Qualsiasi risultato o eccezione viene ignorato (genera e dimentica).

Dettagli proprietà

entityId

Ottiene l'ID dell'entità attualmente in esecuzione.

entityId: EntityId

Valore della proprietà

EntityId

entityKey

Ottiene la chiave dell'entità attualmente in esecuzione.

entityKey: string

Valore della proprietà

string

entityName

Ottiene il nome dell'entità attualmente in esecuzione.

entityName: string

Valore della proprietà

string

isNewlyConstructed

Indica se questa entità è appena costruita, ovvero non esisteva prima della chiamata a questa operazione.

isNewlyConstructed: boolean

Valore della proprietà

boolean

operationName

Ottiene il nome dell'operazione chiamata.

Una chiamata a un'operazione in un'entità include un nome di operazione, che indica l'operazione da eseguire e, facoltativamente, un input dell'operazione.

operationName: undefined | string

Valore della proprietà

undefined | string

Dettagli metodo

destructOnExit()

Elimina questa entità al termine dell'operazione.

function destructOnExit()

getInput<TInput>()

Ottiene l'input per questa operazione.

Una chiamata a un'operazione in un'entità include un nome di operazione, che indica l'operazione da eseguire e, facoltativamente, un input dell'operazione.

function getInput<TInput>(): undefined | TInput

Restituisce

undefined | TInput

Input dell'operazione o non definito se nessuno.

getState(() => TState)

Ottiene lo stato corrente dell'entità per la lettura e/o la scrittura.

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

Parametri

initializer

() => TState

Fornisce un valore iniziale da usare per lo stato, anziché l'impostazione predefinita di TState.

Restituisce

undefined | TState

Stato corrente di questa entità o non definito se non è ancora stato impostato nessuno.

return<TResult>(TResult)

Restituisce il risultato specificato al chiamante di questa operazione.

function return<TResult>(result: TResult)

Parametri

result

TResult

Risultato da restituire.

setState(TState)

Imposta lo stato corrente di questa entità.

function setState(state: TState)

Parametri

state

TState

Stato dell'entità.

signalEntity(EntityId, string, unknown)

Segnala a un'entità di eseguire un'operazione, senza attendere una risposta. Qualsiasi risultato o eccezione viene ignorato (genera e dimentica).

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

Parametri

entity

EntityId

Entità di destinazione.

operationName

string

Nome dell'operazione.

operationInput

unknown

Input dell'operazione.