ServiceBusSessionReceiver interface

A ID da sessão.

sessionId: string

Valor da propriedade

A hora em UTC até a qual a sessão está bloqueada. Sempre que renewSessionLock() é chamado, essa hora é atualizada para a hora atual mais a duração do bloqueio, conforme especificado durante a criação da Fila/Assinatura.

Retornará indefinido até que um link de receptor AMQP tenha sido configurado com êxito para a sessão.

sessionLockedUntilUtc: Date

Valor da propriedade

Caminho da entidade para a qual o receptor foi criado.

entityPath: string

Valor da propriedade

Herdado deServiceBusReceiver.entityPath

Um nome usado para identificar o receptor. Isso pode ser usado para correlacionar logs e exceções. Se não for especificado ou vazio, um aleatório exclusivo será gerado.

identifier: string

Valor da propriedade

Herdado deServiceBusReceiver.identifier

Retornará true se o receptor ou o cliente que o criou tiver sido fechado.

isClosed: boolean

Valor da propriedade

Herdado deServiceBusReceiver.isClosed

O modo de recebimento usado para criar o receptor.

receiveMode: "peekLock" | "receiveAndDelete"

Valor da propriedade

Herdado deServiceBusReceiver.receiveMode

Obtém o estado da Sessão. Para obter mais informações sobre estados de sessão, consulte Estado da sessão

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

Parâmetros

Retornos

O estado dessa sessão

Renova o bloqueio na sessão.

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

Parâmetros

Retornos

Define o estado na Sessão. Para obter mais informações sobre estados de sessão, consulte Estado da sessão

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

Parâmetros

Retornos

Transmite mensagens para manipuladores de mensagens.

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

Parâmetros

Retornos

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

O bloqueio mantido na mensagem pelo receptor é solto, disponibilizando a mensagem novamente no Barramento de Serviço para outra operação de recebimento.

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

Parâmetros

Retornos

Herdado deServiceBusReceiver.abandonMessage

Fecha o receptor. Depois de fechado, o receptor não pode ser usado para operações adicionais. Use o createReceiver() método no ServiceBusClient para criar um novo Receptor.

function close(): Promise<void>

Retornos

Herdado deServiceBusReceiver.close

Remove a mensagem do Barramento de Serviço.

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

Parâmetros

Retornos

Herdado deServiceBusReceiver.completeMessage

Move a mensagem para a sub-fila de mensagens mortas. Para receber uma mensagem morta, crie um novo QueueClient/SubscriptionClient usando o caminho para a sub-fila de mensagens mortas.

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

Parâmetros

Retornos

Herdado deServiceBusReceiver.deadLetterMessage

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

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

Parâmetros

Retornos

Herdado deServiceBusReceiver.deferMessage

Retorna um iterador que pode ser usado para receber mensagens do Barramento de Serviço.

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

Parâmetros

Retornos

Herdado deServiceBusReceiver.getMessageIterator

Espie o próximo lote de mensagens ativas (incluindo mensagens adiadas, mas não mortas) na fila ou assinatura sem modificá-las.

• A primeira chamada para peekMessages() busca a primeira mensagem ativa. Cada chamada subsequente busca a mensagem subsequente.
• Ao contrário de uma mensagem "recebida", a mensagem "espiada" é uma versão somente leitura da mensagem. Não pode ser Completed/Abandoned/Deferred/Deadlettered.

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

Parâmetros

Retornos

Herdado deServiceBusReceiver.peekMessages

Retorna uma promessa que é resolvida para uma matriz de mensagens adiadas identificadas por determinado sequenceNumbers.

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

Parâmetros

Retornos

Uma lista de mensagens identificadas pelo sequenceNumbers especificado ou uma lista vazia se nenhuma mensagem for encontrada.

Herdado deServiceBusReceiver.receiveDeferredMessages

Retorna uma promessa que é resolvida para uma matriz de mensagens recebidas do Barramento de Serviço.

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

Parâmetros

Retornos

Uma promessa que é resolvida com uma matriz de mensagens.

Herdado deServiceBusReceiver.receiveMessages

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

• Verifique a lockedUntilUtc propriedade na mensagem para a hora em que o bloqueio expira.
• Se uma mensagem não for resolvida (usando complete(), defer() ou deadletter(), antes de seu bloqueio expirar, a mensagem retornará à Fila/Assinatura para a próxima operação de recebimento.

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

Parâmetros

Retornos

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

Herdado deServiceBusReceiver.renewMessageLock