DurableEntityContext interface

Pakiet:

durable-functions

Udostępnia funkcje kodu aplikacji implementowania operacji jednostki.

Właściwości

entityId	Pobiera identyfikator aktualnie wykonywanej jednostki.
entityKey	Pobiera klucz aktualnie wykonywanej jednostki.
entityName	Pobiera nazwę aktualnie wykonywanej jednostki.
isNewlyConstructed	Czy ta jednostka jest świeżo skonstruowana, tj. nie istniała przed wywołaniem tej operacji.
operationName	Pobiera nazwę operacji, która została wywołana. Wywołanie operacji w jednostce zawiera nazwę operacji, która określa, jaką operację wykonać, oraz opcjonalnie dane wejściowe operacji.

Metody

destructOnExit()	Usuwa tę jednostkę po zakończeniu tej operacji.
getInput<TInput>()	Pobiera dane wejściowe dla tej operacji. Wywołanie operacji w jednostce zawiera nazwę operacji, która określa, jaką operację wykonać, oraz opcjonalnie dane wejściowe operacji.
getState(() => TState)	Pobiera bieżący stan tej jednostki do odczytu i/lub zapisu.
return<TResult>(TResult)	Zwraca podany wynik do obiektu wywołującego tej operacji.
setState(TState)	Ustawia bieżący stan tej jednostki.
signalEntity(EntityId, string, unknown)	Sygnalizuje jednostkę do wykonania operacji bez oczekiwania na odpowiedź. Każdy wynik lub wyjątek jest ignorowany (uruchom i zapomnij).

Szczegóły właściwości

entityId

Pobiera identyfikator aktualnie wykonywanej jednostki.

entityId: EntityId

Wartość właściwości

EntityId

entityKey

Pobiera klucz aktualnie wykonywanej jednostki.

entityKey: string

Wartość właściwości

string

entityName

Pobiera nazwę aktualnie wykonywanej jednostki.

entityName: string

Wartość właściwości

string

isNewlyConstructed

Czy ta jednostka jest świeżo skonstruowana, tj. nie istniała przed wywołaniem tej operacji.

isNewlyConstructed: boolean

Wartość właściwości

boolean

operationName

Pobiera nazwę operacji, która została wywołana.

Wywołanie operacji w jednostce zawiera nazwę operacji, która określa, jaką operację wykonać, oraz opcjonalnie dane wejściowe operacji.

operationName: undefined | string

Wartość właściwości

undefined | string

Szczegóły metody

destructOnExit()

Usuwa tę jednostkę po zakończeniu tej operacji.

function destructOnExit()

getInput<TInput>()

Pobiera dane wejściowe dla tej operacji.

Wywołanie operacji w jednostce zawiera nazwę operacji, która określa, jaką operację wykonać, oraz opcjonalnie dane wejściowe operacji.

function getInput<TInput>(): undefined | TInput

Zwraca

undefined | TInput

Dane wejściowe operacji lub niezdefiniowane, jeśli nie.

getState(() => TState)

Pobiera bieżący stan tej jednostki do odczytu i/lub zapisu.

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

Parametry

initializer

() => TState

Udostępnia początkową wartość do użycia dla stanu zamiast wartości domyślnej TState.

Zwraca

undefined | TState

Bieżący stan tej jednostki lub niezdefiniowany, jeśli jeszcze nie został ustawiony.

return<TResult>(TResult)

Zwraca podany wynik do obiektu wywołującego tej operacji.

function return<TResult>(result: TResult)

Parametry

result

TResult

Wynik do zwrócenia.

setState(TState)

Ustawia bieżący stan tej jednostki.

function setState(state: TState)

Parametry

state

TState

Stan jednostki.

signalEntity(EntityId, string, unknown)

Sygnalizuje jednostkę do wykonania operacji bez oczekiwania na odpowiedź. Każdy wynik lub wyjątek jest ignorowany (uruchom i zapomnij).

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

Parametry

entity

EntityId

Jednostka docelowa.

operationName

string

Nazwa operacji.

operationInput

unknown

Dane wejściowe operacji.