ServiceBusReceiver interface

Pacote:

@azure/service-bus

Um recetor que não processa sessões.

Propriedades

entityPath	Caminho da entidade para a qual o recetor foi criado.
identifier	Um nome utilizado para identificar o recetor. Isto pode ser utilizado para correlacionar registos e exceções. Se não for especificado ou vazio, será gerado um exclusivo aleatório.
isClosed	Devolve true se o recetor ou o cliente que o criou tiver sido fechado.
receiveMode	O modo de receção utilizado para criar o recetor.

Métodos

abandonMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})	O bloqueio mantido na mensagem pelo recetor é libertado, tornando a mensagem novamente disponível no Service Bus para outra operação de receção.
close()	Fecha o recetor. Depois de fechado, o recetor não pode ser utilizado para mais operações. Utilize o createReceiver() método no ServiceBusClient para criar um novo Recetor.
completeMessage(ServiceBusReceivedMessage)	Remove a mensagem do Service Bus.
deadLetterMessage(ServiceBusReceivedMessage, DeadLetterOptions & {[key: string]: number | boolean | string | Date | null})	Move a mensagem para a sub-fila deadletter. Para receber uma mensagem deadletted, crie uma nova QueueClient/SubscriptionClient com o caminho para a sub-fila deadletter.
deferMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})	Adia o processamento da mensagem. Guarde a sequenceNumber mensagem para receber novamente a mensagem no futuro com o receiveDeferredMessage método .
getMessageIterator(GetMessageIteratorOptions)	Devolve um iterador que pode ser utilizado para receber mensagens do Service Bus.
peekMessages(number, PeekMessagesOptions)	Pré-visualizar o próximo lote de mensagens ativas (incluindo mensagens diferidas, mas não inativas) na fila ou subscrição sem as modificar. A primeira chamada para peekMessages() obter a primeira mensagem ativa. Cada chamada subsequente obtém a mensagem subsequente. Ao contrário de uma mensagem "recebida", a mensagem "pré-visualizada" é uma versão só de leitura da mensagem. Não pode ser Completed/Abandoned/Deferred/Deadlettered.
receiveDeferredMessages(Long | Long[], OperationOptionsBase)	Devolve uma promessa que resolve para uma matriz de mensagens diferidas identificadas por determinadas sequenceNumbers.
receiveMessages(number, ReceiveMessagesOptions)	Devolve uma promessa que resolve para uma matriz de mensagens recebidas do Service Bus.
renewMessageLock(ServiceBusReceivedMessage)	Renova o bloqueio na mensagem durante a duração, conforme especificado durante a criação da Fila/Subscrição. Verifique a lockedUntilUtc propriedade na mensagem relativamente à hora em que o bloqueio expira. Se uma mensagem não estiver resolvida (utilizando complete(), defer() ou deadletter(), antes de o bloqueio expirar, a mensagem é reativada na Fila/Subscrição para a próxima operação de receção.
subscribe(MessageHandlers, SubscribeOptions)	Transmite mensagens para processadores de mensagens.

Detalhes de Propriedade

entityPath

Caminho da entidade para a qual o recetor foi criado.

entityPath: string

Valor de Propriedade

string

identifier

Um nome utilizado para identificar o recetor. Isto pode ser utilizado para correlacionar registos e exceções. Se não for especificado ou vazio, será gerado um exclusivo aleatório.

identifier: string

Valor de Propriedade

string

isClosed

Devolve true se o recetor ou o cliente que o criou tiver sido fechado.

isClosed: boolean

Valor de Propriedade

boolean

receiveMode

O modo de receção utilizado para criar o recetor.

receiveMode: "peekLock" | "receiveAndDelete"

Valor de Propriedade

"peekLock" | "receiveAndDelete"

Detalhes de Método

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

O bloqueio mantido na mensagem pelo recetor é libertado, tornando a mensagem novamente disponível no Service Bus para outra operação de receção.

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

Parâmetros

message

ServiceBusReceivedMessage

propertiesToModify

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

As propriedades da mensagem a modificar ao abandonar a mensagem.

Devoluções

Promise<void>

close()

Fecha o recetor. Depois de fechado, o recetor não pode ser utilizado para mais operações. Utilize o createReceiver() método no ServiceBusClient para criar um novo Recetor.

function close(): Promise<void>

Devoluções

Promise<void>

completeMessage(ServiceBusReceivedMessage)

Remove a mensagem do Service Bus.

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

Parâmetros

message

ServiceBusReceivedMessage

Devoluções

Promise<void>

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

Move a mensagem para a sub-fila deadletter. Para receber uma mensagem deadletted, crie uma nova QueueClient/SubscriptionClient com o caminho para a sub-fila deadletter.

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

Parâmetros

message

ServiceBusReceivedMessage

options

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

As opções DeadLetter que podem ser fornecidas ao rejeitar a mensagem.

Devoluções

Promise<void>

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

Adia o processamento da mensagem. Guarde a sequenceNumber mensagem para receber novamente a mensagem no futuro com o receiveDeferredMessage método .

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

Parâmetros

message

ServiceBusReceivedMessage

propertiesToModify

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

As propriedades da mensagem a modificar ao diferir a mensagem

Devoluções

Promise<void>

getMessageIterator(GetMessageIteratorOptions)

Devolve um iterador que pode ser utilizado para receber mensagens do Service Bus.

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

Parâmetros

options

GetMessageIteratorOptions

Um conjunto de opções para controlar a operação de receção.

• abortSignal: o sinal a utilizar para abortar a operação em curso.

Devoluções

AsyncIterableIterator<ServiceBusReceivedMessage>

peekMessages(number, PeekMessagesOptions)

Pré-visualizar o próximo lote de mensagens ativas (incluindo mensagens diferidas, mas não inativas) na fila ou subscrição sem as modificar.

• A primeira chamada para peekMessages() obter a primeira mensagem ativa. Cada chamada subsequente obtém a mensagem subsequente.
• Ao contrário de uma mensagem "recebida", a mensagem "pré-visualizada" é uma versão só de leitura da mensagem. Não pode ser Completed/Abandoned/Deferred/Deadlettered.

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

Parâmetros

maxMessageCount

number

O número máximo de mensagens a pré-visualizar.

options

PeekMessagesOptions

Opções que permitem especificar o número máximo de mensagens a pré-visualizar, a sequênciaNumber para começar a espreitar ou um abortAlal para abortar a operação.

Devoluções

Promise<ServiceBusReceivedMessage[]>

receiveDeferredMessages(Long | Long[], OperationOptionsBase)

Devolve uma promessa que resolve para uma matriz de mensagens diferidas identificadas por determinadas sequenceNumbers.

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

Parâmetros

sequenceNumbers

Long | Long[]

O número de sequência ou uma matriz de números de sequência para as mensagens que precisam de ser recebidas.

options

OperationOptionsBase

Saco de opções para transmitir um sinal de abortar ou opções de rastreio.

Devoluções

Promise<ServiceBusReceivedMessage[]>

Uma lista de mensagens identificadas pelo sequenceNumbers especificado ou uma lista vazia se não forem encontradas mensagens.

receiveMessages(number, ReceiveMessagesOptions)

Devolve uma promessa que resolve para uma matriz de mensagens recebidas do Service Bus.

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

Parâmetros

maxMessageCount

number

O número máximo de mensagens a receber.

options

ReceiveMessagesOptions

Um conjunto de opções para controlar a operação de receção.

• maxWaitTimeInMs: o tempo máximo para aguardar a primeira mensagem antes de devolver uma matriz vazia se não existirem mensagens disponíveis.
• abortSignal: o sinal a utilizar para abortar a operação em curso.

Devoluções

Promise<ServiceBusReceivedMessage[]>

Uma promessa que resolve com uma matriz de mensagens.

renewMessageLock(ServiceBusReceivedMessage)

Renova o bloqueio na mensagem durante a duração, conforme especificado durante a criação da Fila/Subscrição.

• Verifique a lockedUntilUtc propriedade na mensagem relativamente à hora em que o bloqueio expira.
• Se uma mensagem não estiver resolvida (utilizando complete(), defer() ou deadletter(), antes de o bloqueio expirar, a mensagem é reativada na Fila/Subscrição para a próxima operação de receção.

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

Parâmetros

message

ServiceBusReceivedMessage

Devoluções

Promise<Date>

Nova data e hora de expiração do token de bloqueio no formato UTC.

subscribe(MessageHandlers, SubscribeOptions)

Transmite mensagens para processadores de mensagens.

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

Parâmetros

handlers

MessageHandlers

Um processador que é chamado para mensagens e erros.

options

SubscribeOptions

Opções para subscrever.

Devoluções

{ close() => Promise<void> }

Um objeto que pode ser fechado, enviando quaisquer mensagens restantes para handlers e impedindo a chegada de novas mensagens.