DurableEntityContext interface

Paket:: durable-functions

Stellt Funktionen für den Anwendungscode bereit, der einen Entitätsvorgang implementiert.

Eigenschaften

entityId	Ruft die ID der derzeit ausgeführten Entität ab.
entityKey	Ruft den Schlüssel der derzeit ausgeführten Entität ab.
entityName	Ruft den Namen der derzeit ausgeführten Entität ab.
isNewlyConstructed	Gibt an, ob diese Entität neu erstellt wurde, d. h. vor dem Aufruf dieses Vorgangs nicht vorhanden.
operationName	Ruft den Namen des aufgerufenen Vorgangs ab. Ein Vorgangsaufruf für eine Entität enthält einen Vorgangsnamen, der angibt, welcher Vorgang ausgeführt werden soll, und optional eine Vorgangseingabe.

Methoden

destructOnExit()	Löscht diese Entität nach Abschluss dieses Vorgangs.
getInput<TInput>()	Ruft die Eingabe für diesen Vorgang ab. Ein Vorgangsaufruf für eine Entität enthält einen Vorgangsnamen, der angibt, welcher Vorgang ausgeführt werden soll, und optional eine Vorgangseingabe.
getState(() => TState)	Ruft den aktuellen Status dieser Entität zum Lesen und/oder Schreiben ab.
return<TResult>(TResult)	Gibt das angegebene Ergebnis an den Aufrufer dieses Vorgangs zurück.
setState(TState)	Legt den aktuellen Status dieser Entität fest.
signalEntity(EntityId, string, unknown)	Signalisiert eine Entität zum Ausführen eines Vorgangs, ohne auf eine Antwort zu warten. Alle Ergebnisse oder Ausnahmen werden ignoriert (Feuer und Vergessen).

Details zur Eigenschaft

entityId

Ruft die ID der derzeit ausgeführten Entität ab.

entityId: EntityId

Eigenschaftswert

EntityId

entityKey

Ruft den Schlüssel der derzeit ausgeführten Entität ab.

entityKey: string

Eigenschaftswert

string

entityName

Ruft den Namen der derzeit ausgeführten Entität ab.

entityName: string

Eigenschaftswert

string

isNewlyConstructed

Gibt an, ob diese Entität neu erstellt wurde, d. h. vor dem Aufruf dieses Vorgangs nicht vorhanden.

isNewlyConstructed: boolean

Eigenschaftswert

boolean

operationName

Ruft den Namen des aufgerufenen Vorgangs ab.

Ein Vorgangsaufruf für eine Entität enthält einen Vorgangsnamen, der angibt, welcher Vorgang ausgeführt werden soll, und optional eine Vorgangseingabe.

operationName: undefined | string

Eigenschaftswert

undefined | string

Details zur Methode

destructOnExit()

Löscht diese Entität nach Abschluss dieses Vorgangs.

function destructOnExit()

getInput<TInput>()

Ruft die Eingabe für diesen Vorgang ab.

Ein Vorgangsaufruf für eine Entität enthält einen Vorgangsnamen, der angibt, welcher Vorgang ausgeführt werden soll, und optional eine Vorgangseingabe.

function getInput<TInput>(): undefined | TInput

Gibt zurück

undefined | TInput

Die Vorgangseingabe oder nicht definiert, wenn keine.

getState(() => TState)

Ruft den aktuellen Status dieser Entität zum Lesen und/oder Schreiben ab.

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

Parameter

initializer: () => TState

Stellt einen Anfangswert bereit, der für den Zustand verwendet werden soll, anstelle der Standardeinstellung von TState.

Gibt zurück

undefined | TState

Der aktuelle Status dieser Entität oder nicht definiert, wenn noch keine festgelegt wurde.

return<TResult>(TResult)

Gibt das angegebene Ergebnis an den Aufrufer dieses Vorgangs zurück.

function return<TResult>(result: TResult)

Parameter

result: TResult

Das ergebnis, das zurückgegeben werden soll.

setState(TState)

Legt den aktuellen Status dieser Entität fest.

function setState(state: TState)

Parameter

state: TState

Der Status der Entität.

signalEntity(EntityId, string, unknown)

Signalisiert eine Entität zum Ausführen eines Vorgangs, ohne auf eine Antwort zu warten. Alle Ergebnisse oder Ausnahmen werden ignoriert (Feuer und Vergessen).

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

Parameter

entity: EntityId

Die Zielentität.

operationName: string

Der Name des Vorgangs.

operationInput: unknown

Die Vorgangseingabe.