DurableEntityContext interface

Paquet:: durable-functions

Fournit des fonctionnalités pour le code d’application implémentant une opération d’entité.

Propriétés

entityId	Obtient l’ID de l’entité en cours d’exécution.
entityKey	Obtient la clé de l’entité en cours d’exécution.
entityName	Obtient le nom de l’entité en cours d’exécution.
isNewlyConstructed	Indique si cette entité est fraîchement construite, c’est-à-dire qu’elle n’existe pas avant l’appel de cette opération.
operationName	Obtient le nom de l’opération appelée. Un appel d’opération sur une entité inclut un nom d’opération, qui indique l’opération à effectuer et éventuellement une entrée d’opération.

Méthodes

destructOnExit()	Supprime cette entité une fois cette opération terminée.
getInput<TInput>()	Obtient l’entrée de cette opération. Un appel d’opération sur une entité inclut un nom d’opération, qui indique l’opération à effectuer et éventuellement une entrée d’opération.
getState(() => TState)	Obtient l’état actuel de cette entité, pour la lecture et/ou l’écriture.
return<TResult>(TResult)	Retourne le résultat donné à l’appelant de cette opération.
setState(TState)	Définit l’état actuel de cette entité.
signalEntity(EntityId, string, unknown)	Signale à une entité d’effectuer une opération, sans attendre une réponse. Tout résultat ou exception est ignoré (déclencher et oublier).

Détails de la propriété

entityId

Obtient l’ID de l’entité en cours d’exécution.

entityId: EntityId

Valeur de propriété

EntityId

entityKey

Obtient la clé de l’entité en cours d’exécution.

entityKey: string

Valeur de propriété

string

entityName

Obtient le nom de l’entité en cours d’exécution.

entityName: string

Valeur de propriété

string

isNewlyConstructed

Indique si cette entité est fraîchement construite, c’est-à-dire qu’elle n’existe pas avant l’appel de cette opération.

isNewlyConstructed: boolean

Valeur de propriété

boolean

operationName

Obtient le nom de l’opération appelée.

Un appel d’opération sur une entité inclut un nom d’opération, qui indique l’opération à effectuer et éventuellement une entrée d’opération.

operationName: undefined | string

Valeur de propriété

undefined | string

Détails de la méthode

destructOnExit()

Supprime cette entité une fois cette opération terminée.

function destructOnExit()

getInput<TInput>()

Obtient l’entrée de cette opération.

Un appel d’opération sur une entité inclut un nom d’opération, qui indique l’opération à effectuer et éventuellement une entrée d’opération.

function getInput<TInput>(): undefined | TInput

Retours

undefined | TInput

Entrée de l’opération ou non définie si aucune.

getState(() => TState)

Obtient l’état actuel de cette entité, pour la lecture et/ou l’écriture.

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

Paramètres

initializer: () => TState

Fournit une valeur initiale à utiliser pour l’état, au lieu de la valeur par défaut de TState.

Retours

undefined | TState

État actuel de cette entité, ou non défini si aucun n’a encore été défini.

return<TResult>(TResult)

Retourne le résultat donné à l’appelant de cette opération.

function return<TResult>(result: TResult)

Paramètres

result: TResult

Résultat à retourner.

setState(TState)

Définit l’état actuel de cette entité.

function setState(state: TState)

Paramètres

state: TState

État de l’entité.

signalEntity(EntityId, string, unknown)

Signale à une entité d’effectuer une opération, sans attendre une réponse. Tout résultat ou exception est ignoré (déclencher et oublier).

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

Paramètres

entity: EntityId

Entité cible.

operationName: string

Nom de l’opération.

operationInput: unknown

Entrée de l’opération.