DurableEntityContext interface

Pakket:

durable-functions

Biedt functionaliteit voor het implementeren van een entiteitsbewerking met toepassingscode.

Eigenschappen

entityId	Hiermee haalt u de id op van de entiteit die momenteel wordt uitgevoerd.
entityKey	Hiermee haalt u de sleutel op van de entiteit die momenteel wordt uitgevoerd.
entityName	Hiermee haalt u de naam op van de entiteit die momenteel wordt uitgevoerd.
isNewlyConstructed	Of deze entiteit nieuw is samengesteld, dat wil gezegd niet bestonden voordat deze bewerking werd aangeroepen.
operationName	Hiermee haalt u de naam op van de bewerking die is aangeroepen. Een aanroep van een bewerking op een entiteit bevat een bewerkingsnaam, die aangeeft welke bewerking moet worden uitgevoerd en eventueel een bewerkingsinvoer.

Methoden

destructOnExit()	Hiermee verwijdert u deze entiteit nadat deze bewerking is voltooid.
getInput<TInput>()	Hiermee haalt u de invoer voor deze bewerking op. Een aanroep van een bewerking op een entiteit bevat een bewerkingsnaam, die aangeeft welke bewerking moet worden uitgevoerd en eventueel een bewerkingsinvoer.
getState(() => TState)	Hiermee haalt u de huidige status van deze entiteit op voor lezen en/of schrijven.
return<TResult>(TResult)	Retourneert het opgegeven resultaat aan de aanroeper van deze bewerking.
setState(TState)	Hiermee stelt u de huidige status van deze entiteit in.
signalEntity(EntityId, string, unknown)	Geeft een entiteit aan om een bewerking uit te voeren, zonder te wachten op een reactie. Een resultaat of uitzondering wordt genegeerd (brand en vergeet).

Eigenschapdetails

entityId

Hiermee haalt u de id op van de entiteit die momenteel wordt uitgevoerd.

entityId: EntityId

Waarde van eigenschap

EntityId

entityKey

Hiermee haalt u de sleutel op van de entiteit die momenteel wordt uitgevoerd.

entityKey: string

Waarde van eigenschap

string

entityName

Hiermee haalt u de naam op van de entiteit die momenteel wordt uitgevoerd.

entityName: string

Waarde van eigenschap

string

isNewlyConstructed

Of deze entiteit nieuw is samengesteld, dat wil gezegd niet bestonden voordat deze bewerking werd aangeroepen.

isNewlyConstructed: boolean

Waarde van eigenschap

boolean

operationName

Hiermee haalt u de naam op van de bewerking die is aangeroepen.

Een aanroep van een bewerking op een entiteit bevat een bewerkingsnaam, die aangeeft welke bewerking moet worden uitgevoerd en eventueel een bewerkingsinvoer.

operationName: undefined | string

Waarde van eigenschap

undefined | string

Methodedetails

destructOnExit()

Hiermee verwijdert u deze entiteit nadat deze bewerking is voltooid.

function destructOnExit()

getInput<TInput>()

Hiermee haalt u de invoer voor deze bewerking op.

Een aanroep van een bewerking op een entiteit bevat een bewerkingsnaam, die aangeeft welke bewerking moet worden uitgevoerd en eventueel een bewerkingsinvoer.

function getInput<TInput>(): undefined | TInput

Retouren

undefined | TInput

De bewerkingsinvoer of niet gedefinieerd als er geen zijn.

getState(() => TState)

Hiermee haalt u de huidige status van deze entiteit op voor lezen en/of schrijven.

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

Parameters

initializer

() => TState

Biedt een initiële waarde die moet worden gebruikt voor de status, in plaats van de standaardwaarde van TState.

Retouren

undefined | TState

De huidige status van deze entiteit of niet gedefinieerd als er nog geen is ingesteld.

return<TResult>(TResult)

Retourneert het opgegeven resultaat aan de aanroeper van deze bewerking.

function return<TResult>(result: TResult)

Parameters

result

TResult

Het resultaat dat moet worden geretourneerd.

setState(TState)

Hiermee stelt u de huidige status van deze entiteit in.

function setState(state: TState)

Parameters

state

TState

De status van de entiteit.

signalEntity(EntityId, string, unknown)

Geeft een entiteit aan om een bewerking uit te voeren, zonder te wachten op een reactie. Een resultaat of uitzondering wordt genegeerd (brand en vergeet).

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

Parameters

entity

EntityId

De doelentiteit.

operationName

string

De naam van de bewerking.

operationInput

unknown

De invoer van de bewerking.