EventGridReceiverClient class
Klien Namespace Event Grid
Konstruktor
| Event |
Klien Azure Messaging EventGrid |
Metode
| acknowledge |
Mengakui batch Peristiwa Cloud. Server merespons dengan kode status HTTP 200 jika setidaknya satu peristiwa berhasil diakui. Isi respons akan mencakup kumpulan lockToken yang berhasil diakui, bersama dengan lockTokens lain yang gagal dengan informasi kesalahan yang sesuai. Peristiwa yang berhasil diakui tidak akan lagi tersedia untuk konsumen mana pun. |
| receive |
Terima Batch Peristiwa Cloud dari Langganan Peristiwa. |
| reject |
Tolak batch Peristiwa Cloud. |
| release |
Rilis batch Peristiwa Cloud. Server merespons dengan kode status HTTP 200 jika setidaknya satu peristiwa berhasil dirilis. Isi respons akan mencakup kumpulan lockToken yang berhasil dirilis, bersama dengan lockTokens lain yang gagal dengan informasi kesalahan yang sesuai. |
| renew |
Perbarui kunci untuk batch Peristiwa Cloud. |
Detail Konstruktor
EventGridReceiverClient(string, AzureKeyCredential | TokenCredential, string, string, EventGridReceiverClientOptions)
Klien Azure Messaging EventGrid
new EventGridReceiverClient(endpoint: string, credential: AzureKeyCredential | TokenCredential, topicName: string, subscriptionName: string, options?: EventGridReceiverClientOptions)
Parameter
- endpoint
-
string
- credential
- topicName
-
string
- subscriptionName
-
string
- options
- EventGridReceiverClientOptions
Detail Metode
acknowledgeEvents(string[], AcknowledgeEventsOptions)
Mengakui batch Peristiwa Cloud. Server merespons dengan kode status HTTP 200 jika setidaknya satu peristiwa berhasil diakui. Isi respons akan mencakup kumpulan lockToken yang berhasil diakui, bersama dengan lockTokens lain yang gagal dengan informasi kesalahan yang sesuai. Peristiwa yang berhasil diakui tidak akan lagi tersedia untuk konsumen mana pun.
function acknowledgeEvents(lockTokens: string[], options?: AcknowledgeEventsOptions): Promise<AcknowledgeResult>
Parameter
- lockTokens
-
string[]
Kunci Token
- options
- AcknowledgeEventsOptions
Opsi untuk Mengakui
Mengembalikan
Promise<AcknowledgeResult>
receiveEvents<T>(ReceiveEventsOptions)
Terima Batch Peristiwa Cloud dari Langganan Peristiwa.
function receiveEvents<T>(options?: ReceiveEventsOptions): Promise<ReceiveResult<T>>
Parameter
- options
- ReceiveEventsOptions
Opsi untuk menerima
Mengembalikan
Promise<ReceiveResult<T>>
rejectEvents(string[], RejectEventsOptions)
Tolak batch Peristiwa Cloud.
function rejectEvents(lockTokens: string[], options?: RejectEventsOptions): Promise<RejectResult>
Parameter
- lockTokens
-
string[]
Kunci Token
- options
- RejectEventsOptions
Opsi untuk ditolak
Mengembalikan
Promise<RejectResult>
releaseEvents(string[], ReleaseEventsOptions)
Rilis batch Peristiwa Cloud. Server merespons dengan kode status HTTP 200 jika setidaknya satu peristiwa berhasil dirilis. Isi respons akan mencakup kumpulan lockToken yang berhasil dirilis, bersama dengan lockTokens lain yang gagal dengan informasi kesalahan yang sesuai.
function releaseEvents(lockTokens: string[], options?: ReleaseEventsOptions): Promise<ReleaseResult>
Parameter
- lockTokens
-
string[]
Kunci Token
- options
- ReleaseEventsOptions
Opsi untuk merilis
Mengembalikan
Promise<ReleaseResult>
renewEventLocks(string[], RenewEventLocksOptions)
Perbarui kunci untuk batch Peristiwa Cloud.
function renewEventLocks(lockTokens: string[], options?: RenewEventLocksOptions): Promise<RenewLocksResult>
Parameter
- lockTokens
-
string[]
Kunci Token
- options
- RenewEventLocksOptions
Opsi untuk memperbarui
Mengembalikan
Promise<RenewLocksResult>