DurableEntityContext interface

Paket:

durable-functions

Bir varlık işlemi uygulayan uygulama kodu için işlevsellik sağlar.

Özellikler

entityId	Şu anda yürütülmekte olan varlığın kimliğini alır.
entityKey	Şu anda yürütülmekte olan varlığın anahtarını alır.
entityName	Yürütülmekte olan varlığın adını alır.
isNewlyConstructed	Bu varlığın yeni oluşturulmuş olup olmadığı, yani bu işlem çağrılmadan önce mevcut olmadığı.
operationName	Çağrılan işlemin adını alır. Bir varlıktaki işlem çağrısı, gerçekleştirilecek işlemi ve isteğe bağlı olarak bir işlem girişini bildiren bir işlem adı içerir.

Yöntemler

destructOnExit()	Bu işlem tamamlandıktan sonra bu varlığı siler.
getInput<TInput>()	Bu işlemin girişini alır. Bir varlıktaki işlem çağrısı, gerçekleştirilecek işlemi ve isteğe bağlı olarak bir işlem girişini bildiren bir işlem adı içerir.
getState(() => TState)	Okuma ve/veya yazma için bu varlığın geçerli durumunu alır.
return<TResult>(TResult)	Verilen sonucu bu işlemin çağıranı döndürür.
setState(TState)	Bu varlığın geçerli durumunu ayarlar.
signalEntity(EntityId, string, unknown)	Yanıt beklemeden bir varlığın işlem gerçekleştirmesi için sinyal gönderir. Herhangi bir sonuç veya özel durum yoksayılır (yangın ve unutma).

Özellik Ayrıntıları

entityId

Şu anda yürütülmekte olan varlığın kimliğini alır.

entityId: EntityId

Özellik Değeri

EntityId

entityKey

Şu anda yürütülmekte olan varlığın anahtarını alır.

entityKey: string

Özellik Değeri

string

entityName

Yürütülmekte olan varlığın adını alır.

entityName: string

Özellik Değeri

string

isNewlyConstructed

Bu varlığın yeni oluşturulmuş olup olmadığı, yani bu işlem çağrılmadan önce mevcut olmadığı.

isNewlyConstructed: boolean

Özellik Değeri

boolean

operationName

Çağrılan işlemin adını alır.

Bir varlıktaki işlem çağrısı, gerçekleştirilecek işlemi ve isteğe bağlı olarak bir işlem girişini bildiren bir işlem adı içerir.

operationName: undefined | string

Özellik Değeri

undefined | string

Yöntem Ayrıntıları

destructOnExit()

Bu işlem tamamlandıktan sonra bu varlığı siler.

function destructOnExit()

getInput<TInput>()

Bu işlemin girişini alır.

Bir varlıktaki işlem çağrısı, gerçekleştirilecek işlemi ve isteğe bağlı olarak bir işlem girişini bildiren bir işlem adı içerir.

function getInput<TInput>(): undefined | TInput

Döndürülenler

undefined | TInput

İşlem girişi veya yoksa tanımsız.

getState(() => TState)

Okuma ve/veya yazma için bu varlığın geçerli durumunu alır.

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

Parametreler

initializer

() => TState

TState'in varsayılan değeri yerine durum için kullanılacak bir başlangıç değeri sağlar.

Döndürülenler

undefined | TState

Bu varlığın geçerli durumu veya henüz ayarlanmamışsa tanımsız.

return<TResult>(TResult)

Verilen sonucu bu işlemin çağıranı döndürür.

function return<TResult>(result: TResult)

Parametreler

result

TResult

Döndürülecek sonuç.

setState(TState)

Bu varlığın geçerli durumunu ayarlar.

function setState(state: TState)

Parametreler

state

TState

Varlığın durumu.

signalEntity(EntityId, string, unknown)

Yanıt beklemeden bir varlığın işlem gerçekleştirmesi için sinyal gönderir. Herhangi bir sonuç veya özel durum yoksayılır (yangın ve unutma).

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

Parametreler

entity

EntityId

Hedef varlık.

operationName

string

İşlemin adı.

operationInput

unknown

İşlem girişi.