ServiceBusSessionReceiver interface

Balíček:

@azure/service-bus

Příjemce, který zpracovává relace, včetně obnovení zámku relace.

Extends

ServiceBusReceiver

Vlastnosti

sessionId	ID relace.
sessionLockedUntilUtc	Čas ve standardu UTC, do kterého je relace uzamčena. Při každém volání renewSessionLock() se tento čas aktualizuje na aktuální čas a dobu trvání uzamčení zadanou během vytváření fronty nebo předplatného. Vrátí nedefinované, dokud se pro relaci úspěšně nenastaví odkaz příjemce AMQP.

Zděděné vlastnosti

entityPath	Cesta entity, pro kterou byl příjemce vytvořen.
identifier	Název použitý k identifikaci příjemce. Dá se použít ke korelaci protokolů a výjimek. Pokud není zadaný nebo prázdný, vygeneruje se náhodný jedinečný.
isClosed	Vrátí true, pokud byl uzavřen příjemce nebo klient, který ho vytvořil.
receiveMode	Režim příjmu použitý k vytvoření příjemce.

Metody

getSessionState(OperationOptionsBase)	Získá stav relace. Další informace o stavech relací najdete v tématu stav relace
renewSessionLock(OperationOptionsBase)	Obnoví zámek relace.
setSessionState(any, OperationOptionsBase)	Nastaví stav relace. Další informace o stavech relací najdete v tématu stav relace
subscribe(MessageHandlers, SubscribeOptions)	Streamuje zprávy do obslužných rutin zpráv.

Zděděné metody

abandonMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})	Zámek uložený na zprávě příjemcem se nechejte, aby byla zpráva opět dostupná ve službě Service Bus pro jinou operaci příjmu.
close()	Zavře přijímač. Po zavření nelze přijímač použít pro žádné další operace. K vytvoření nového příjemce použijte metodu createReceiver() na ServiceBusClient.
completeMessage(ServiceBusReceivedMessage)	Odebere zprávu ze služby Service Bus.
deadLetterMessage(ServiceBusReceivedMessage, DeadLetterOptions & {[key: string]: number | boolean | string | Date | null})	Přesune zprávu do dílčí fronty deadletter. Pokud chcete obdržet zprávu s nedoručeným obsahem, vytvořte novou frontu QueueClient/SubscriptionClient pomocí cesty pro dílčí frontu deadletter.
deferMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})	Odmažuje zpracování zprávy. Pomocí metody sequenceNumber uložte receiveDeferredMessage zprávy, abyste ji mohli v budoucnu znovu přijmout.
getMessageIterator(GetMessageIteratorOptions)	Vrátí iterátor, který lze použít k příjmu zpráv ze služby Service Bus.
peekMessages(number, PeekMessagesOptions)	Prohlédněte si další dávku aktivních zpráv (včetně odložených zpráv, ale ne zpráv mrtvých) ve frontě nebo odběru, aniž byste je museli upravovat. První volání peekMessages() načte první aktivní zprávu. Každé následné volání načte následující zprávu. Na rozdíl od přijaté zprávy je "náhledem" zpráva verze zprávy určená jen pro čtení. Nemůže být Completed/Abandoned/Deferred/Deadlettered.
receiveDeferredMessages(Long | Long[], OperationOptionsBase)	Vrátí příslib, který se přeloží na pole odložených zpráv identifikovaných danou sequenceNumbers.
receiveMessages(number, ReceiveMessagesOptions)	Vrátí příslib, který se přeloží na pole zpráv přijatých ze služby Service Bus.
renewMessageLock(ServiceBusReceivedMessage)	Prodlouží zámek zprávy po dobu trvání uvedenou při vytváření fronty nebo odběru. Zkontrolujte vlastnost lockedUntilUtc zprávy v době, kdy vyprší platnost zámku. Pokud zpráva není vyřešená (pomocí complete(), defer() nebo deadletter(), před vypršením jeho zámku se zpráva vrátí do fronty nebo odběru pro další operaci přijetí.

Podrobnosti vlastnosti

sessionId

ID relace.

sessionId: string

Hodnota vlastnosti

string

sessionLockedUntilUtc

Čas ve standardu UTC, do kterého je relace uzamčena. Při každém volání renewSessionLock() se tento čas aktualizuje na aktuální čas a dobu trvání uzamčení zadanou během vytváření fronty nebo předplatného.

Vrátí nedefinované, dokud se pro relaci úspěšně nenastaví odkaz příjemce AMQP.

sessionLockedUntilUtc: Date

Hodnota vlastnosti

Date

Podrobnosti zděděných vlastností

entityPath

Cesta entity, pro kterou byl příjemce vytvořen.

entityPath: string

Hodnota vlastnosti

string

zděděno zServiceBusReceiver.entityPath

identifier

Název použitý k identifikaci příjemce. Dá se použít ke korelaci protokolů a výjimek. Pokud není zadaný nebo prázdný, vygeneruje se náhodný jedinečný.

identifier: string

Hodnota vlastnosti

string

zděděno zServiceBusReceiver.identifier

isClosed

Vrátí true, pokud byl uzavřen příjemce nebo klient, který ho vytvořil.

isClosed: boolean

Hodnota vlastnosti

boolean

zděděný zServiceBusReceiver.isClosed

receiveMode

Režim příjmu použitý k vytvoření příjemce.

receiveMode: "peekLock" | "receiveAndDelete"

Hodnota vlastnosti

"peekLock" | "receiveAndDelete"

zděděno zServiceBusReceiver.receiveMode

Podrobnosti metody

getSessionState(OperationOptionsBase)

Získá stav relace. Další informace o stavech relací najdete v tématu stav relace

function getSessionState(options?: OperationOptionsBase): Promise<any>

Parametry

options

OperationOptionsBase

Taška možností pro předání přerušeného signálu nebo trasování možností.

Návraty

Promise<any>

Stav této relace

renewSessionLock(OperationOptionsBase)

Obnoví zámek relace.

function renewSessionLock(options?: OperationOptionsBase): Promise<Date>

Parametry

options

OperationOptionsBase

Návraty

Promise<Date>

setSessionState(any, OperationOptionsBase)

Nastaví stav relace. Další informace o stavech relací najdete v tématu stav relace

function setSessionState(state: any, options?: OperationOptionsBase): Promise<void>

Parametry

state

any

Stav, který je potřeba nastavit.

options

OperationOptionsBase

Taška možností pro předání přerušeného signálu nebo trasování možností.

Návraty

Promise<void>

subscribe(MessageHandlers, SubscribeOptions)

Streamuje zprávy do obslužných rutin zpráv.

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

Parametry

handlers

MessageHandlers

Obslužná rutina, která se volá pro zprávy a chyby.

options

SubscribeOptions

Možnosti přihlášení k odběru

Návraty

{ close() => Promise<void> }

Objekt, který lze zavřít, odeslat všechny zbývající zprávy do handlers a zastavit příchod nových zpráv.

Podrobnosti zděděných metod

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

Zámek uložený na zprávě příjemcem se nechejte, aby byla zpráva opět dostupná ve službě Service Bus pro jinou operaci příjmu.

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

Parametry

message

ServiceBusReceivedMessage

propertiesToModify

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

Vlastnosti zprávy, kterou chcete změnit při opuštění zprávy.

Návraty

Promise<void>

zděděné zServiceBusReceiver.abandonMessage

close()

Zavře přijímač. Po zavření nelze přijímač použít pro žádné další operace. K vytvoření nového příjemce použijte metodu createReceiver() na ServiceBusClient.

function close(): Promise<void>

Návraty

Promise<void>

zděděno zServiceBusReceiver.close

completeMessage(ServiceBusReceivedMessage)

Odebere zprávu ze služby Service Bus.

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

Parametry

message

ServiceBusReceivedMessage

Návraty

Promise<void>

zděděno zServiceBusReceiver.completeMessage

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

Přesune zprávu do dílčí fronty deadletter. Pokud chcete obdržet zprávu s nedoručeným obsahem, vytvořte novou frontu QueueClient/SubscriptionClient pomocí cesty pro dílčí frontu deadletter.

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

Parametry

message

ServiceBusReceivedMessage

options

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

Možnosti DeadLetter, které lze zadat při odmítnutí zprávy.

Návraty

Promise<void>

zděděno zServiceBusReceiver.deadLetterMessage

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

Odmažuje zpracování zprávy. Pomocí metody sequenceNumber uložte receiveDeferredMessage zprávy, abyste ji mohli v budoucnu znovu přijmout.

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

Parametry

message

ServiceBusReceivedMessage

propertiesToModify

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

Vlastnosti zprávy, které se mají upravit při odložení zprávy

Návraty

Promise<void>

zděděno zServiceBusReceiver.deferMessage

getMessageIterator(GetMessageIteratorOptions)

Vrátí iterátor, který lze použít k příjmu zpráv ze služby Service Bus.

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

Parametry

options

GetMessageIteratorOptions

Sada možností pro řízení operace příjmu.

• abortSignal: Signál, který se má použít k přerušení probíhající operace.

Návraty

AsyncIterableIterator<ServiceBusReceivedMessage>

zděděno zServiceBusReceiver.getMessageIterator

peekMessages(number, PeekMessagesOptions)

Prohlédněte si další dávku aktivních zpráv (včetně odložených zpráv, ale ne zpráv mrtvých) ve frontě nebo odběru, aniž byste je museli upravovat.

• První volání peekMessages() načte první aktivní zprávu. Každé následné volání načte následující zprávu.
• Na rozdíl od přijaté zprávy je "náhledem" zpráva verze zprávy určená jen pro čtení. Nemůže být Completed/Abandoned/Deferred/Deadlettered.

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

Parametry

maxMessageCount

number

Maximální počet zpráv, které se mají prohlédnout.

options

PeekMessagesOptions

Možnosti, které umožňují zadat maximální počet zpráv k náhledu, sequenceNumber pro zahájení náhledu z nebo abortSignal přerušit operaci.

Návraty

Promise<ServiceBusReceivedMessage[]>

zděděno zServiceBusReceiver.peekMessages

receiveDeferredMessages(Long | Long[], OperationOptionsBase)

Vrátí příslib, který se přeloží na pole odložených zpráv identifikovaných danou sequenceNumbers.

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

Parametry

sequenceNumbers

Long | Long[]

Pořadové číslo nebo matice pořadových čísel pro zprávy, které je potřeba přijímat.

options

OperationOptionsBase

Taška možností pro předání přerušeného signálu nebo trasování možností.

Návraty

Promise<ServiceBusReceivedMessage[]>

Seznam zpráv identifikovaných daným pořadovým číslem nebo prázdným seznamem, pokud nejsou nalezeny žádné zprávy.

zděděné zServiceBusReceiver.receiveDeferredMessages

receiveMessages(number, ReceiveMessagesOptions)

Vrátí příslib, který se přeloží na pole zpráv přijatých ze služby Service Bus.

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

Parametry

maxMessageCount

number

Maximální počet přijatých zpráv.

options

ReceiveMessagesOptions

Sada možností pro řízení operace příjmu.

• maxWaitTimeInMs: Maximální doba čekání na první zprávu před vrácením prázdného pole, pokud nejsou k dispozici žádné zprávy.
• abortSignal: Signál, který se má použít k přerušení probíhající operace.

Návraty

Promise<ServiceBusReceivedMessage[]>

Slib, který se vyřeší pomocí pole zpráv.

zděděno zServiceBusReceiver.receiveMessages

renewMessageLock(ServiceBusReceivedMessage)

Prodlouží zámek zprávy po dobu trvání uvedenou při vytváření fronty nebo odběru.

• Zkontrolujte vlastnost lockedUntilUtc zprávy v době, kdy vyprší platnost zámku.
• Pokud zpráva není vyřešená (pomocí complete(), defer() nebo deadletter(), před vypršením jeho zámku se zpráva vrátí do fronty nebo odběru pro další operaci přijetí.

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

Parametry

message

ServiceBusReceivedMessage

Návraty

Promise<Date>

Nové datum a čas vypršení platnosti tokenu zámku ve formátu UTC

zděděno zServiceBusReceiver.renewMessageLock