DurableEntityContext interface

Balíček:: durable-functions

Poskytuje funkce pro kód aplikace, který implementuje operaci entity.

Vlastnosti

entityId	Získá ID aktuálně spuštěné entity.
entityKey	Získá klíč aktuálně spuštěné entity.
entityName	Získá název aktuálně spuštěné entity.
isNewlyConstructed	Zda je tato entita nově vytvořena, tj. před zavolání této operace neexistovala.
operationName	Získá název operace, která byla volána. Vyvolání operace u entity obsahuje název operace, která uvádí, jakou operaci provést, a volitelně vstup operace.

Metody

destructOnExit()	Odstraní tuto entitu po dokončení této operace.
getInput<TInput>()	Získá vstup pro tuto operaci. Vyvolání operace u entity obsahuje název operace, která uvádí, jakou operaci provést, a volitelně vstup operace.
getState(() => TState)	Získá aktuální stav této entity pro čtení nebo zápis.
return<TResult>(TResult)	Vrátí daný výsledek volajícímu této operace.
setState(TState)	Nastaví aktuální stav této entity.
signalEntity(EntityId, string, unknown)	Signalizuje entitu k provedení operace bez čekání na odpověď. Jakýkoli výsledek nebo výjimka se ignoruje (aktivuje se a zapomene).

Podrobnosti vlastnosti

entityId

Získá ID aktuálně spuštěné entity.

entityId: EntityId

Hodnota vlastnosti

EntityId

entityKey

Získá klíč aktuálně spuštěné entity.

entityKey: string

Hodnota vlastnosti

string

entityName

Získá název aktuálně spuštěné entity.

entityName: string

Hodnota vlastnosti

string

isNewlyConstructed

Zda je tato entita nově vytvořena, tj. před zavolání této operace neexistovala.

isNewlyConstructed: boolean

Hodnota vlastnosti

boolean

operationName

Získá název operace, která byla volána.

Vyvolání operace u entity obsahuje název operace, která uvádí, jakou operaci provést, a volitelně vstup operace.

operationName: undefined | string

Hodnota vlastnosti

undefined | string

Podrobnosti metody

destructOnExit()

Odstraní tuto entitu po dokončení této operace.

function destructOnExit()

getInput<TInput>()

Získá vstup pro tuto operaci.

Vyvolání operace u entity obsahuje název operace, která uvádí, jakou operaci provést, a volitelně vstup operace.

function getInput<TInput>(): undefined | TInput

Návraty

undefined | TInput

Vstup operace nebo nedefinovaný, pokud žádný.

getState(() => TState)

Získá aktuální stav této entity pro čtení nebo zápis.

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

Parametry

initializer: () => TState

Poskytuje počáteční hodnotu, která se má použít pro stav místo výchozí hodnoty TState.

Návraty

undefined | TState

Aktuální stav této entity nebo nedefinovaný, pokud ještě nebyla nastavena žádná.

return<TResult>(TResult)

Vrátí daný výsledek volajícímu této operace.

function return<TResult>(result: TResult)

Parametry

result: TResult

Výsledek, který se má vrátit.

setState(TState)

Nastaví aktuální stav této entity.

function setState(state: TState)

Parametry

state: TState

Stav entity.

signalEntity(EntityId, string, unknown)

Signalizuje entitu k provedení operace bez čekání na odpověď. Jakýkoli výsledek nebo výjimka se ignoruje (aktivuje se a zapomene).

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

Parametry

entity: EntityId

Cílová entita.

operationName: string

Název operace.

operationInput: unknown

Vstup operace.