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. renewSessionLock() Při každém volání se tento čas aktualizuje na aktuální čas plus dobu trvání zámku, jak je uvedeno při 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í hodnotu true , pokud příjemce nebo klient, který ho vytvořil, byl uzavřen.
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)	Prodlouží 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, který příjemce drží na zprávě, se uvolní a zpráva se tak znovu zpřístupní ve službě Service Bus pro další operaci příjmu.
close()	Zavře příjemce. Po zavření nelze přijímač použít k dalším operacím. 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 pod fronty deadletter. Pokud chcete obdržet zprávu s nedoručenou zprávou, vytvořte nový QueueClient/SubscriptionClient pomocí cesty pro pod frontu deadletter.
deferMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})	Odmaví zpracování zprávy. sequenceNumber Uložte zprávu, abyste ji mohli v budoucnu znovu přijmout pomocí receiveDeferredMessage metody .
getMessageIterator(GetMessageIteratorOptions)	Vrátí iterátor, který se dá použít k příjmu zpráv ze služby Service Bus.
peekMessages(number, PeekMessagesOptions)	Nahlédněte do další dávky aktivních zpráv (včetně odložených zpráv, ale ne zpráv s nedorucenými zprávami) ve frontě nebo odběru, aniž byste je museli upravovat. První volání pro peekMessages() načtení první aktivní zprávy. Každé následné volání načte následující zprávu. Na rozdíl od "přijaté" zprávy je "náhled" verze zprávy jen pro čtení. Nemůže to 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 sequenceNumbersfunkcí .
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 na dobu uvedenou při vytváření fronty nebo odběru. lockedUntilUtc Zkontrolujte ve vlastnosti zprávy čas vypršení platnosti zámku. Pokud zpráva není vyřešena (pomocí complete(), defer() nebo deadletter(), před vypršením platnosti jejího zámku, zpráva se vrátí zpě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. renewSessionLock() Při každém volání se tento čas aktualizuje na aktuální čas plus dobu trvání zámku, jak je uvedeno při 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í hodnotu true , pokud příjemce nebo klient, který ho vytvořil, byl uzavřen.

isClosed: boolean

Hodnota vlastnosti

boolean

Zděděno zeServiceBusReceiver.isClosed

receiveMode

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

receiveMode: "peekLock" | "receiveAndDelete"

Hodnota vlastnosti

"peekLock" | "receiveAndDelete"

Zděděno zeServiceBusReceiver.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

Panel možností pro předání možností přerušení signálu nebo trasování.

Návraty

Promise<any>

Stav této relace

renewSessionLock(OperationOptionsBase)

Prodlouží 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

Panel možností pro předání možností přerušení signálu nebo trasování.

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á je volána pro zprávy a chyby.

options

SubscribeOptions

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

Návraty

{ close() => Promise<void> }

Objekt, který může být uzavřen, odesílání všech zbývajících zpráv a handlers zastavení příchozích nových zpráv.

Podrobnosti zděděných metod

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

Zámek, který příjemce drží na zprávě, se uvolní a zpráva se tak znovu zpřístupní ve službě Service Bus pro další 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, které se mají upravit při opuštění zprávy.

Návraty

Promise<void>

Zděděno zServiceBusReceiver.abandonMessage

close()

Zavře příjemce. Po zavření nelze přijímač použít k dalším operacím. 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 pod fronty deadletter. Pokud chcete obdržet zprávu s nedoručenou zprávou, vytvořte nový QueueClient/SubscriptionClient pomocí cesty pro pod 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}

The DeadLetter options that can be provided while rejecting the message.

Návraty

Promise<void>

Zděděno zServiceBusReceiver.deadLetterMessage

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

Odmaví zpracování zprávy. sequenceNumber Uložte zprávu, abyste ji mohli v budoucnu znovu přijmout pomocí receiveDeferredMessage metody .

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 má upravit při odložení zprávy

Návraty

Promise<void>

Zděděno zServiceBusReceiver.deferMessage

getMessageIterator(GetMessageIteratorOptions)

Vrátí iterátor, který se dá 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 zeServiceBusReceiver.getMessageIterator

peekMessages(number, PeekMessagesOptions)

Nahlédněte do další dávky aktivních zpráv (včetně odložených zpráv, ale ne zpráv s nedorucenými zprávami) ve frontě nebo odběru, aniž byste je museli upravovat.

• První volání pro peekMessages() načtení první aktivní zprávy. Každé následné volání načte následující zprávu.
• Na rozdíl od "přijaté" zprávy je "náhled" verze zprávy jen pro čtení. Nemůže to 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í zobrazit.

options

PeekMessagesOptions

Možnosti, které umožňují určit maximální počet zpráv, které se mají zobrazit, pořadové číslo, ze kterého se má spustit náhled, nebo abortSignal pro přerušení operace.

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 sequenceNumbersfunkcí .

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 třeba přijímat.

options

OperationOptionsBase

Panel možností pro předání možností přerušení signálu nebo trasování.

Návraty

Promise<ServiceBusReceivedMessage[]>

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

Zděděno 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 zpráv, které se mají přijmout.

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[]>

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

Zděděno zeServiceBusReceiver.receiveMessages

renewMessageLock(ServiceBusReceivedMessage)

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

• lockedUntilUtc Zkontrolujte ve vlastnosti zprávy čas vypršení platnosti zámku.
• Pokud zpráva není vyřešena (pomocí complete(), defer() nebo deadletter(), před vypršením platnosti jejího zámku, zpráva se vrátí zpět do fronty nebo odběru pro další operaci přijetí.

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

Parametry

message

ServiceBusReceivedMessage

Návraty

Promise<Date>

Datum a čas vypršení platnosti nového tokenu zámku ve formátu UTC.

Zděděno zeServiceBusReceiver.renewMessageLock