ServiceBusReceiver interface

Paket:

@azure/service-bus

Oturumları işlemeyen bir alıcı.

Özellikler

entityPath	Alıcının oluşturulduğu varlığın yolu.
identifier	Alıcıyı tanımlamak için kullanılan ad. Bu, günlükleri ve özel durumları ilişkilendirmek için kullanılabilir. Belirtilmezse veya boşsa rastgele benzersiz bir tane oluşturulur.
isClosed	Alıcı veya onu oluşturan istemci kapatılmışsa true döndürür.
receiveMode	Alıcıyı oluşturmak için kullanılan alma modu.

Yöntemler

abandonMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})	Alıcı tarafından iletide tutulan kilit serbest bırakılarak iletiyi Service Bus'ta başka bir alma işlemi için yeniden kullanılabilir hale getirir.
close()	Alıcıyı kapatır. Kapatıldıktan sonra alıcı başka bir işlem için kullanılamaz. Yeni bir Alıcı oluşturmak için ServiceBusClient'da createReceiver() yöntemini kullanın.
completeMessage(ServiceBusReceivedMessage)	Service Bus'tan iletiyi kaldırır.
deadLetterMessage(ServiceBusReceivedMessage, DeadLetterOptions & {[key: string]: number | boolean | string | Date | null})	İletiyi yeniden düzenleme alt kuyruğuna taşır. Geçersiz bir ileti almak için, yeni bir QueueClient/SubscriptionClient oluşturun ve bu iletinin yeniden kullanıma hazır alt kuyruğunun yolunu kullanın.
deferMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})	İletinin işlenmesini geçersiz hale getirerek. gelecekte sequenceNumber yöntemini kullanarak iletiyi yeniden almak için iletinin receiveDeferredMessage kaydedin.
getMessageIterator(GetMessageIteratorOptions)	Service Bus'tan ileti almak için kullanılabilecek bir yineleyici döndürür.
peekMessages(number, PeekMessagesOptions)	Değiştirmeden kuyrukta veya abonelikte bir sonraki etkin ileti toplu işlemine (ertelenmiş ancak geçersiz iletiler dahil) göz atın. İlk peekMessages() çağrısı ilk etkin iletiyi getirir. Sonraki her çağrı, sonraki iletiyi getirir. "Alındı" iletisinden farklı olarak, "göz atılan" ileti iletinin salt okunur bir sürümüdür. Completed/Abandoned/Deferred/Deadletteredolamaz.
receiveDeferredMessages(Long | Long[], OperationOptionsBase)	Verilen sequenceNumberstarafından tanımlanan ertelenen iletiler dizisine çözümlenen bir söz döndürür.
receiveMessages(number, ReceiveMessagesOptions)	Service Bus'tan alınan bir dizi iletiye çözümleyen bir söz döndürür.
renewMessageLock(ServiceBusReceivedMessage)	Kuyruk/Abonelik oluşturma sırasında belirtilen süre boyunca iletideki kilidi yeniler. Kilidin süresinin dolduğunda iletideki lockedUntilUtc özelliğini denetleyin. bir ileti kapatılmazsa (complete(), defer() veya deadletter()kullanılarak), kilidin süresi dolmadan önce ileti sonraki alma işlemi için Kuyruk/Abonelik'e geri döner.
subscribe(MessageHandlers, SubscribeOptions)	İletileri ileti işleyicilerine akışla aktarın.

Özellik Ayrıntıları

entityPath

Alıcının oluşturulduğu varlığın yolu.

entityPath: string

Özellik Değeri

string

identifier

Alıcıyı tanımlamak için kullanılan ad. Bu, günlükleri ve özel durumları ilişkilendirmek için kullanılabilir. Belirtilmezse veya boşsa rastgele benzersiz bir tane oluşturulur.

identifier: string

Özellik Değeri

string

isClosed

Alıcı veya onu oluşturan istemci kapatılmışsa true döndürür.

isClosed: boolean

Özellik Değeri

boolean

receiveMode

Alıcıyı oluşturmak için kullanılan alma modu.

receiveMode: "peekLock" | "receiveAndDelete"

Özellik Değeri

"peekLock" | "receiveAndDelete"

Yöntem Ayrıntıları

abandonMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})

Alıcı tarafından iletide tutulan kilit serbest bırakılarak iletiyi Service Bus'ta başka bir alma işlemi için yeniden kullanılabilir hale getirir.

function abandonMessage(message: ServiceBusReceivedMessage, propertiesToModify?: {[key: string]: number | boolean | string | Date | null}): Promise<void>

Parametreler

message

ServiceBusReceivedMessage

propertiesToModify

{[key: string]: number | boolean | string | Date | null}

İletiyi bırakırken değiştirebileceğiniz iletinin özellikleri.

Döndürülenler

Promise<void>

close()

Alıcıyı kapatır. Kapatıldıktan sonra alıcı başka bir işlem için kullanılamaz. Yeni bir Alıcı oluşturmak için ServiceBusClient'da createReceiver() yöntemini kullanın.

function close(): Promise<void>

Döndürülenler

Promise<void>

completeMessage(ServiceBusReceivedMessage)

Service Bus'tan iletiyi kaldırır.

function completeMessage(message: ServiceBusReceivedMessage): Promise<void>

Parametreler

message

ServiceBusReceivedMessage

Döndürülenler

Promise<void>

deadLetterMessage(ServiceBusReceivedMessage, DeadLetterOptions & {[key: string]: number | boolean | string | Date | null})

İletiyi yeniden düzenleme alt kuyruğuna taşır. Geçersiz bir ileti almak için, yeni bir QueueClient/SubscriptionClient oluşturun ve bu iletinin yeniden kullanıma hazır alt kuyruğunun yolunu kullanın.

function deadLetterMessage(message: ServiceBusReceivedMessage, options?: DeadLetterOptions & {[key: string]: number | boolean | string | Date | null}): Promise<void>

Parametreler

message

ServiceBusReceivedMessage

options

DeadLetterOptions & {[key: string]: number | boolean | string | Date | null}

İleti reddederken sağlanabilir DeadLetter seçenekleri.

Döndürülenler

Promise<void>

deferMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})

İletinin işlenmesini geçersiz hale getirerek. gelecekte sequenceNumber yöntemini kullanarak iletiyi yeniden almak için iletinin receiveDeferredMessage kaydedin.

function deferMessage(message: ServiceBusReceivedMessage, propertiesToModify?: {[key: string]: number | boolean | string | Date | null}): Promise<void>

Parametreler

message

ServiceBusReceivedMessage

propertiesToModify

{[key: string]: number | boolean | string | Date | null}

İleti ertelenirken değiştirileceği iletinin özellikleri

Döndürülenler

Promise<void>

getMessageIterator(GetMessageIteratorOptions)

Service Bus'tan ileti almak için kullanılabilecek bir yineleyici döndürür.

function getMessageIterator(options?: GetMessageIteratorOptions): AsyncIterableIterator<ServiceBusReceivedMessage>

Parametreler

options

GetMessageIteratorOptions

Alma işlemini denetlemek için bir dizi seçenek.

• abortSignal: Devam eden işlemi durdurmak için kullanılacak sinyal.

Döndürülenler

AsyncIterableIterator<ServiceBusReceivedMessage>

peekMessages(number, PeekMessagesOptions)

Değiştirmeden kuyrukta veya abonelikte bir sonraki etkin ileti toplu işlemine (ertelenmiş ancak geçersiz iletiler dahil) göz atın.

• İlk peekMessages() çağrısı ilk etkin iletiyi getirir. Sonraki her çağrı, sonraki iletiyi getirir.
• "Alındı" iletisinden farklı olarak, "göz atılan" ileti iletinin salt okunur bir sürümüdür. Completed/Abandoned/Deferred/Deadletteredolamaz.

function peekMessages(maxMessageCount: number, options?: PeekMessagesOptions): Promise<ServiceBusReceivedMessage[]>

Parametreler

maxMessageCount

number

Göz atacak ileti sayısı üst sınırı.

options

PeekMessagesOptions

Göz atılacak en fazla ileti sayısını, göz atmaya başlamak için sequenceNumber'ı veya işlemi durdurmak için abortSignal'ı belirtmeye olanak sağlayan seçenekler.

Döndürülenler

Promise<ServiceBusReceivedMessage[]>

receiveDeferredMessages(Long | Long[], OperationOptionsBase)

Verilen sequenceNumberstarafından tanımlanan ertelenen iletiler dizisine çözümlenen bir söz döndürür.

function receiveDeferredMessages(sequenceNumbers: Long | Long[], options?: OperationOptionsBase): Promise<ServiceBusReceivedMessage[]>

Parametreler

sequenceNumbers

Long | Long[]

Alınması gereken iletiler için sıra numarası veya dizi numaraları dizisi.

options

OperationOptionsBase

Seçenekler, durdurma sinyali veya izleme seçeneklerini geçirmek için hazır.

Döndürülenler

Promise<ServiceBusReceivedMessage[]>

Verilen sequenceNumbers tarafından tanımlanan iletilerin listesi veya hiçbir ileti bulunamazsa boş bir liste.

receiveMessages(number, ReceiveMessagesOptions)

Service Bus'tan alınan bir dizi iletiye çözümleyen bir söz döndürür.

function receiveMessages(maxMessageCount: number, options?: ReceiveMessagesOptions): Promise<ServiceBusReceivedMessage[]>

Parametreler

maxMessageCount

number

Alınacak en fazla ileti sayısı.

options

ReceiveMessagesOptions

Alma işlemini denetlemek için bir dizi seçenek.

• maxWaitTimeInMs: Kullanılabilir ileti yoksa boş bir dizi döndürmeden önce ilk iletinin beklenebilecek maksimum süresi.
• abortSignal: Devam eden işlemi durdurmak için kullanılacak sinyal.

Döndürülenler

Promise<ServiceBusReceivedMessage[]>

Bir dizi iletiyle çözülen bir söz.

renewMessageLock(ServiceBusReceivedMessage)

Kuyruk/Abonelik oluşturma sırasında belirtilen süre boyunca iletideki kilidi yeniler.

• Kilidin süresinin dolduğunda iletideki lockedUntilUtc özelliğini denetleyin.
• bir ileti kapatılmazsa (complete(), defer() veya deadletter()kullanılarak), kilidin süresi dolmadan önce ileti sonraki alma işlemi için Kuyruk/Abonelik'e geri döner.

function renewMessageLock(message: ServiceBusReceivedMessage): Promise<Date>

Parametreler

message

ServiceBusReceivedMessage

Döndürülenler

Promise<Date>

Utc biçiminde yeni kilit belirteci süre sonu tarihi ve saati.

subscribe(MessageHandlers, SubscribeOptions)

İletileri ileti işleyicilerine akışla aktarın.

function subscribe(handlers: MessageHandlers, options?: SubscribeOptions): { close() => Promise<void> }

Parametreler

handlers

MessageHandlers

İletiler ve hatalar için çağrılan bir işleyici.

options

SubscribeOptions

Abone olma seçenekleri.

Döndürülenler

{ close() => Promise<void> }

Kapatılabilen, kalan iletileri handlers gönderen ve yeni iletilerin gelmesi durdurulabilen bir nesne.