ServiceBusReceiver interface

Paket:

@azure/service-bus

Penerima yang tidak menangani sesi.

Properti

entityPath	Jalur entitas tempat penerima telah dibuat.
identifier	Nama yang digunakan untuk mengidentifikasi penerima. Ini dapat digunakan untuk menghubungkan log dan pengecualian. Jika tidak ditentukan atau kosong, yang unik acak akan dihasilkan.
isClosed	Mengembalikan true jika penerima atau klien yang membuatnya telah ditutup.
receiveMode	Mode terima yang digunakan untuk membuat penerima.

Metode

abandonMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})	Kunci yang disimpan pada pesan oleh penerima dilepaskan, membuat pesan tersedia lagi di Service Bus untuk operasi penerima lain.
close()	Menutup penerima. Setelah ditutup, penerima tidak dapat digunakan untuk operasi lebih lanjut. createReceiver() Gunakan metode pada ServiceBusClient untuk membuat Penerima baru.
completeMessage(ServiceBusReceivedMessage)	Menghapus pesan dari Azure Service Bus.
deadLetterMessage(ServiceBusReceivedMessage, DeadLetterOptions & {[key: string]: number | boolean | string | Date | null})	Memindahkan pesan ke sub-antrean deadletter. Untuk menerima pesan yang dihentikan, buat QueueClient/SubscriptionClient baru menggunakan jalur untuk sub-antrean deadletter.
deferMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})	Menangguhkan pemrosesan pesan. sequenceNumber Simpan pesan, untuk menerima pesan lagi di masa mendatang menggunakan receiveDeferredMessage metode .
getMessageIterator(GetMessageIteratorOptions)	Mengembalikan iterator yang dapat digunakan untuk menerima pesan dari Azure Service Bus.
peekMessages(number, PeekMessagesOptions)	Intip batch berikutnya dari pesan aktif (termasuk pesan yang ditangguhkan tetapi tidak dihentikan) pada antrean atau langganan tanpa memodifikasinya. Panggilan pertama untuk peekMessages() mengambil pesan aktif pertama. Setiap panggilan berikutnya mengambil pesan berikutnya. Tidak seperti pesan "diterima", pesan "mengintip" adalah versi pesan baca-saja. Tidak boleh Completed/Abandoned/Deferred/Deadlettered.
receiveDeferredMessages(Long | Long[], OperationOptionsBase)	Mengembalikan janji yang diselesaikan ke array pesan yang ditangguhkan yang diidentifikasi oleh .sequenceNumbers
receiveMessages(number, ReceiveMessagesOptions)	Mengembalikan janji yang diselesaikan ke array pesan yang diterima dari Azure Service Bus.
renewMessageLock(ServiceBusReceivedMessage)	Memperbarui kunci pada pesan selama durasi seperti yang ditentukan selama pembuatan Antrean/Langganan. lockedUntilUtc Periksa properti pada pesan untuk waktu ketika kunci kedaluwarsa. Jika pesan tidak diselesaikan (menggunakan complete(), defer() atau deadletter(), sebelum kuncinya kedaluwarsa, maka pesan akan kembali ke Antrean/Langganan untuk operasi penerimaan berikutnya.
subscribe(MessageHandlers, SubscribeOptions)	Mengalirkan pesan ke penangan pesan.

Detail Properti

entityPath

Jalur entitas tempat penerima telah dibuat.

entityPath: string

Nilai Properti

string

identifier

Nama yang digunakan untuk mengidentifikasi penerima. Ini dapat digunakan untuk menghubungkan log dan pengecualian. Jika tidak ditentukan atau kosong, yang unik acak akan dihasilkan.

identifier: string

Nilai Properti

string

isClosed

Mengembalikan true jika penerima atau klien yang membuatnya telah ditutup.

isClosed: boolean

Nilai Properti

boolean

receiveMode

Mode terima yang digunakan untuk membuat penerima.

receiveMode: "peekLock" | "receiveAndDelete"

Nilai Properti

"peekLock" | "receiveAndDelete"

Detail Metode

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

Kunci yang disimpan pada pesan oleh penerima dilepaskan, membuat pesan tersedia lagi di Service Bus untuk operasi penerima lain.

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

Parameter

message

ServiceBusReceivedMessage

propertiesToModify

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

Properti pesan yang akan diubah saat meninggalkan pesan.

Mengembalikan

Promise<void>

close()

Menutup penerima. Setelah ditutup, penerima tidak dapat digunakan untuk operasi lebih lanjut. createReceiver() Gunakan metode pada ServiceBusClient untuk membuat Penerima baru.

function close(): Promise<void>

Mengembalikan

Promise<void>

completeMessage(ServiceBusReceivedMessage)

Menghapus pesan dari Azure Service Bus.

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

Parameter

message

ServiceBusReceivedMessage

Mengembalikan

Promise<void>

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

Memindahkan pesan ke sub-antrean deadletter. Untuk menerima pesan yang dihentikan, buat QueueClient/SubscriptionClient baru menggunakan jalur untuk sub-antrean deadletter.

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

Parameter

message

ServiceBusReceivedMessage

options

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

Opsi DeadLetter yang dapat disediakan saat menolak pesan.

Mengembalikan

Promise<void>

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

Menangguhkan pemrosesan pesan. sequenceNumber Simpan pesan, untuk menerima pesan lagi di masa mendatang menggunakan receiveDeferredMessage metode .

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

Parameter

message

ServiceBusReceivedMessage

propertiesToModify

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

Properti pesan yang akan diubah saat menugaskan pesan

Mengembalikan

Promise<void>

getMessageIterator(GetMessageIteratorOptions)

Mengembalikan iterator yang dapat digunakan untuk menerima pesan dari Azure Service Bus.

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

Parameter

options

GetMessageIteratorOptions

Sekumpulan opsi untuk mengontrol operasi penerimaan.

• abortSignal: Sinyal yang digunakan untuk membatalkan operasi yang sedang berlangsung.

Mengembalikan

AsyncIterableIterator<ServiceBusReceivedMessage>

peekMessages(number, PeekMessagesOptions)

Intip batch berikutnya dari pesan aktif (termasuk pesan yang ditangguhkan tetapi tidak dihentikan) pada antrean atau langganan tanpa memodifikasinya.

• Panggilan pertama untuk peekMessages() mengambil pesan aktif pertama. Setiap panggilan berikutnya mengambil pesan berikutnya.
• Tidak seperti pesan "diterima", pesan "mengintip" adalah versi pesan baca-saja. Tidak boleh Completed/Abandoned/Deferred/Deadlettered.

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

Parameter

maxMessageCount

number

Jumlah maksimum pesan yang akan diintip.

options

PeekMessagesOptions

Opsi yang memungkinkan untuk menentukan jumlah maksimum pesan yang akan diintip, urutanNumber untuk mulai mengintip dari atau abortSignal untuk membatalkan operasi.

Mengembalikan

Promise<ServiceBusReceivedMessage[]>

receiveDeferredMessages(Long | Long[], OperationOptionsBase)

Mengembalikan janji yang diselesaikan ke array pesan yang ditangguhkan yang diidentifikasi oleh .sequenceNumbers

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

Parameter

sequenceNumbers

Long | Long[]

Nomor urut atau array nomor urut untuk pesan yang perlu diterima.

options

OperationOptionsBase

Opsi tas untuk meneruskan opsi batalkan sinyal atau pelacakan.

Mengembalikan

Promise<ServiceBusReceivedMessage[]>

Daftar pesan yang diidentifikasi oleh sequenceNumbers yang diberikan atau daftar kosong jika tidak ada pesan yang ditemukan.

receiveMessages(number, ReceiveMessagesOptions)

Mengembalikan janji yang diselesaikan ke array pesan yang diterima dari Azure Service Bus.

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

Parameter

maxMessageCount

number

Jumlah maksimum pesan yang akan diterima.

options

ReceiveMessagesOptions

Sekumpulan opsi untuk mengontrol operasi penerimaan.

• maxWaitTimeInMs: Waktu maksimum untuk menunggu pesan pertama sebelum mengembalikan array kosong jika tidak ada pesan yang tersedia.
• abortSignal: Sinyal yang digunakan untuk membatalkan operasi yang sedang berlangsung.

Mengembalikan

Promise<ServiceBusReceivedMessage[]>

Janji yang diselesaikan dengan array pesan.

renewMessageLock(ServiceBusReceivedMessage)

Memperbarui kunci pada pesan selama durasi seperti yang ditentukan selama pembuatan Antrean/Langganan.

• lockedUntilUtc Periksa properti pada pesan untuk waktu ketika kunci kedaluwarsa.
• Jika pesan tidak diselesaikan (menggunakan complete(), defer() atau deadletter(), sebelum kuncinya kedaluwarsa, maka pesan akan kembali ke Antrean/Langganan untuk operasi penerimaan berikutnya.

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

Parameter

message

ServiceBusReceivedMessage

Mengembalikan

Promise<Date>

Tanggal dan waktu kedaluwarsa token kunci baru dalam format UTC.

subscribe(MessageHandlers, SubscribeOptions)

Mengalirkan pesan ke penangan pesan.

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

Parameter

handlers

MessageHandlers

Handler yang dipanggil untuk pesan dan kesalahan.

options

SubscribeOptions

Opsi untuk berlangganan.

Mengembalikan

{ close() => Promise<void> }

Objek yang dapat ditutup, mengirim pesan yang tersisa ke handlers dan menghentikan pesan baru tiba.