ServiceBusMessageBatch interface
Partia komunikatów, które można utworzyć przy użyciu metody <xref:createBatch>.
Właściwości
| count | Liczba komunikatów dodanych do partii. |
| max |
Maksymalny rozmiar partii w bajtach. Funkcja |
| size |
Rozmiar partii w bajtach po dodaniu zdarzeń do niego został zakodowany w jednym komunikacie protokołu AMQP. |
Metody
| try |
Dodaje komunikat do partii, jeśli jest dozwolony przez limit rozmiaru partii. UWAGA: zawsze pamiętaj, aby sprawdzić wartość zwracaną tej metody, zanim wywołaj ją ponownie dla następnego zdarzenia. |
Szczegóły właściwości
count
Liczba komunikatów dodanych do partii.
count: number
Wartość właściwości
number
maxSizeInBytes
Maksymalny rozmiar partii w bajtach. Funkcja tryAddMessage w partii zwróci false, jeśli dodawany komunikat spowoduje przekroczenie tego limitu rozmiaru partii. Użyj metody createMessageBatch() w Sender, aby ustawić wartość maxSizeInBytes.
maxSizeInBytes: number
Wartość właściwości
number
sizeInBytes
Rozmiar partii w bajtach po dodaniu zdarzeń do niego został zakodowany w jednym komunikacie protokołu AMQP.
sizeInBytes: number
Wartość właściwości
number
Szczegóły metody
tryAddMessage(ServiceBusMessage | AmqpAnnotatedMessage, TryAddOptions)
Dodaje komunikat do partii, jeśli jest dozwolony przez limit rozmiaru partii. UWAGA: zawsze pamiętaj, aby sprawdzić wartość zwracaną tej metody, zanim wywołaj ją ponownie dla następnego zdarzenia.
function tryAddMessage(message: ServiceBusMessage | AmqpAnnotatedMessage, options?: TryAddOptions): boolean
Parametry
- message
Komunikat do dodania do partii.
- options
- TryAddOptions
Zwraca
boolean
Wartość logiczna wskazująca, czy komunikat został dodany do partii, czy nie.