DurableEntityContext interface

Paket:

durable-functions

Tillhandahåller funktioner för programkod som implementerar en entitetsåtgärd.

Egenskaper

entityId	Hämtar ID:t för den entitet som körs just nu.
entityKey	Hämtar nyckeln för den entitet som körs just nu.
entityName	Hämtar namnet på den entitet som körs just nu.
isNewlyConstructed	Om den här entiteten är nykonstruerad, dvs. fanns inte innan den här åtgärden anropades.
operationName	Hämtar namnet på den åtgärd som anropades. Ett åtgärdsanrop på en entitet innehåller ett åtgärdsnamn, som anger vilken åtgärd som ska utföras och eventuellt en åtgärdsinmatning.

Metoder

destructOnExit()	Tar bort den här entiteten när den här åtgärden har slutförts.
getInput<TInput>()	Hämtar indata för den här åtgärden. Ett åtgärdsanrop på en entitet innehåller ett åtgärdsnamn, som anger vilken åtgärd som ska utföras och eventuellt en åtgärdsinmatning.
getState(() => TState)	Hämtar den här entitetens aktuella tillstånd för läsning och/eller skrivning.
return<TResult>(TResult)	Returnerar det angivna resultatet till anroparen för den här åtgärden.
setState(TState)	Anger aktuellt tillstånd för den här entiteten.
signalEntity(EntityId, string, unknown)	Signalerar en entitet att utföra en åtgärd, utan att vänta på ett svar. Resultat eller undantag ignoreras (brand och glöm).

Egenskapsinformation

entityId

Hämtar ID:t för den entitet som körs just nu.

entityId: EntityId

Egenskapsvärde

EntityId

entityKey

Hämtar nyckeln för den entitet som körs just nu.

entityKey: string

Egenskapsvärde

string

entityName

Hämtar namnet på den entitet som körs just nu.

entityName: string

Egenskapsvärde

string

isNewlyConstructed

Om den här entiteten är nykonstruerad, dvs. fanns inte innan den här åtgärden anropades.

isNewlyConstructed: boolean

Egenskapsvärde

boolean

operationName

Hämtar namnet på den åtgärd som anropades.

Ett åtgärdsanrop på en entitet innehåller ett åtgärdsnamn, som anger vilken åtgärd som ska utföras och eventuellt en åtgärdsinmatning.

operationName: undefined | string

Egenskapsvärde

undefined | string

Metodinformation

destructOnExit()

Tar bort den här entiteten när den här åtgärden har slutförts.

function destructOnExit()

getInput<TInput>()

Hämtar indata för den här åtgärden.

Ett åtgärdsanrop på en entitet innehåller ett åtgärdsnamn, som anger vilken åtgärd som ska utföras och eventuellt en åtgärdsinmatning.

function getInput<TInput>(): undefined | TInput

Returer

undefined | TInput

Åtgärdens indata eller odefinierade om inga.

getState(() => TState)

Hämtar den här entitetens aktuella tillstånd för läsning och/eller skrivning.

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

Parametrar

initializer

() => TState

Ger ett initialt värde som ska användas för tillståndet i stället för TStates standardvärde.

Returer

undefined | TState

Aktuellt tillstånd för den här entiteten eller odefinierat om ingen har angetts ännu.

return<TResult>(TResult)

Returnerar det angivna resultatet till anroparen för den här åtgärden.

function return<TResult>(result: TResult)

Parametrar

result

TResult

Resultatet som ska returneras.

setState(TState)

Anger aktuellt tillstånd för den här entiteten.

function setState(state: TState)

Parametrar

state

TState

Tillståndet för entiteten.

signalEntity(EntityId, string, unknown)

Signalerar en entitet att utföra en åtgärd, utan att vänta på ett svar. Resultat eller undantag ignoreras (brand och glöm).

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

Parametrar

entity

EntityId

Målentiteten.

operationName

string

Namnet på åtgärden.

operationInput

unknown

Åtgärdens indata.