Bagikan melalui

ServiceBusSender interface

Paket:
@azure/service-bus

Pengirim dapat digunakan untuk mengirim pesan, menjadwalkan pesan yang akan dikirim di lain waktu dan membatalkan pesan terjadwal tersebut. Gunakan fungsi createSender pada ServiceBusClient untuk membuat instans Pengirim. Kelas Pengirim adalah abstraksi atas tautan pengirim AMQP yang mendasar.

Properti

entityPath

Jalur entitas tempat pengirim telah dibuat.
identifier

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

Mengembalikan true jika pengirim atau klien yang membuatnya telah ditutup.

Metode

cancelScheduledMessages(Long | Long[], OperationOptionsBase)

Membatalkan beberapa pesan yang dijadwalkan untuk muncul di Antrean/Langganan ServiceBus.
close()

Menutup tautan pengirim AMQP yang mendasar. Setelah ditutup, pengirim tidak dapat digunakan untuk operasi lebih lanjut. Gunakan fungsi createSender pada QueueClient atau TopicClient untuk membuat instans Pengirim baru
createMessageBatch(CreateMessageBatchOptions)

Membuat instans ServiceBusMessageBatch yang dapat ditambahkan pesan hingga ukuran maksimum yang didukung tercapai. Batch dapat diteruskan ke metode <xref:send> untuk mengirim pesan ke Azure Service Bus.
scheduleMessages(ServiceBusMessage | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[], Date, OperationOptionsBase)

Menjadwalkan pesan yang diberikan untuk muncul di Antrean/Langganan Azure Service Bus di lain waktu.
sendMessages(ServiceBusMessage | ServiceBusMessageBatch | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[], OperationOptionsBase)

Mengirim pesan yang diberikan setelah membuat tautan Pengirim AMQP jika belum ada.

  • Untuk mengirim pesan ke session dan/atau partition mengaktifkan Antrean/Topik, atur properti sessionId dan/atau partitionKey masing-masing pada pesan.
  • Semua pesan yang diteruskan ke panggilan sendMessages() yang sama harus memiliki sessionId yang sama (jika menggunakan sesi) dan partitionKey yang sama (jika menggunakan partisi).

Catatan:

Jika Anda ingin mengirim pesan berukuran lebih besar dari 1MB, silakan kirim pesan individual alih-alih mengirim pesan batch atau array pesan seperti di bawah ini.

await sender.sendMessages(message);

Ini karena pesan yang di-batch belum mampu mengirim pesan yang lebih besar. Anda akan mengalami kesalahan force detached dalam kasus ini jika tidak. Baca service-bus-premium-messaging#large-messages-support. Info selengkapnya di #23014.

Detail Properti

entityPath

Jalur entitas tempat pengirim telah dibuat.

entityPath: string

Nilai Properti

string

identifier

Nama yang digunakan untuk mengidentifikasi pengirim. 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 pengirim atau klien yang membuatnya telah ditutup.

isClosed: boolean

Nilai Properti

boolean

Detail Metode

cancelScheduledMessages(Long | Long[], OperationOptionsBase)

Membatalkan beberapa pesan yang dijadwalkan untuk muncul di Antrean/Langganan ServiceBus.

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

Parameter

sequenceNumbers

Long | Long[]

Nomor urut atau array nomor urut pesan yang akan dibatalkan.

options
OperationOptionsBase

Tas opsi untuk meneruskan opsi sinyal atau pelacakan yang dibatalkan.

Mengembalikan

Promise<void>

close()

Menutup tautan pengirim AMQP yang mendasar. Setelah ditutup, pengirim tidak dapat digunakan untuk operasi lebih lanjut. Gunakan fungsi createSender pada QueueClient atau TopicClient untuk membuat instans Pengirim baru

function close(): Promise<void>

Mengembalikan

Promise<void>

createMessageBatch(CreateMessageBatchOptions)

Membuat instans ServiceBusMessageBatch yang dapat ditambahkan pesan hingga ukuran maksimum yang didukung tercapai. Batch dapat diteruskan ke metode <xref:send> untuk mengirim pesan ke Azure Service Bus.

function createMessageBatch(options?: CreateMessageBatchOptions): Promise<ServiceBusMessageBatch>

Parameter

options
CreateMessageBatchOptions

Mengonfigurasi perilaku batch.

  • maxSizeInBytes: Batas atas untuk ukuran batch. Fungsi tryAdd akan mengembalikan false setelah batas ini tercapai.

Mengembalikan

Promise<ServiceBusMessageBatch>

scheduleMessages(ServiceBusMessage | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[], Date, OperationOptionsBase)

Menjadwalkan pesan yang diberikan untuk muncul di Antrean/Langganan Azure Service Bus di lain waktu.

function scheduleMessages(messages: ServiceBusMessage | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[], scheduledEnqueueTimeUtc: Date, options?: OperationOptionsBase): Promise<Long[]>

Parameter

messages

ServiceBusMessage | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[]

Pesan atau array pesan yang perlu dijadwalkan.

scheduledEnqueueTimeUtc

Date

Waktu UTC di mana pesan harus diantrekan.

options
OperationOptionsBase

Tas opsi untuk meneruskan opsi sinyal atau pelacakan yang dibatalkan.

Mengembalikan

Promise<Long[]>

Jumlah urutan pesan yang dijadwalkan. Anda akan memerlukan nomor urut jika Ingin membatalkan penjadwalan pesan. Simpan jenis Long as-is di aplikasi Anda tanpa mengonversi ke angka. Karena JavaScript hanya mendukung angka 53 bit, mengonversi Long ke angka akan menyebabkan kehilangan presisi.

sendMessages(ServiceBusMessage | ServiceBusMessageBatch | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[], OperationOptionsBase)

Mengirim pesan yang diberikan setelah membuat tautan Pengirim AMQP jika belum ada.

  • Untuk mengirim pesan ke session dan/atau partition mengaktifkan Antrean/Topik, atur properti sessionId dan/atau partitionKey masing-masing pada pesan.
  • Semua pesan yang diteruskan ke panggilan sendMessages() yang sama harus memiliki sessionId yang sama (jika menggunakan sesi) dan partitionKey yang sama (jika menggunakan partisi).

Catatan:

Jika Anda ingin mengirim pesan berukuran lebih besar dari 1MB, silakan kirim pesan individual alih-alih mengirim pesan batch atau array pesan seperti di bawah ini.

await sender.sendMessages(message);

Ini karena pesan yang di-batch belum mampu mengirim pesan yang lebih besar. Anda akan mengalami kesalahan force detached dalam kasus ini jika tidak. Baca service-bus-premium-messaging#large-messages-support. Info selengkapnya di #23014.

function sendMessages(messages: ServiceBusMessage | ServiceBusMessageBatch | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[], options?: OperationOptionsBase): Promise<void>

Parameter

messages

ServiceBusMessage | ServiceBusMessageBatch | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[]

Satu pesan atau array pesan atau batch pesan yang dibuat melalui metode createBatch() untuk dikirim.

options
OperationOptionsBase

Tas opsi untuk meneruskan opsi sinyal atau pelacakan yang dibatalkan.

Mengembalikan

Promise<void>