ServiceBusReceiver interface

已为其创建接收器的实体的路径。

entityPath: string

属性值

用于标识接收方的名称。 这可用于关联日志和异常。 如果未指定或为空，将生成随机唯一值。

identifier: string

属性值

如果创建接收方或创建的客户端已关闭，则返回 true。

isClosed: boolean

属性值

用于创建接收方的接收模式。

receiveMode: "peekLock" | "receiveAndDelete"

属性值

接收方在消息上保留的锁会松开，使消息在服务总线中再次可用，以便执行另一个接收作。

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

参数

返回

关闭接收方。 关闭后，接收器不能用于任何进一步的作。 使用 ServiceBusClient 上的 createReceiver() 方法创建新的接收方。

function close(): Promise<void>

返回

从服务总线中删除消息。

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

参数

返回

将消息移动到死信子队列。 若要接收死信消息，请使用死信子队列的路径创建新的 QueueClient/SubscriptionClient。

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

参数

返回

延迟消息的处理。 保存消息 sequenceNumber，以便将来使用 receiveDeferredMessage 方法再次接收消息。

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

参数

返回

返回可用于从服务总线接收消息的迭代器。

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

参数

返回

在队列或订阅上查看下一批活动消息（包括延迟但未死信的消息），而无需修改它们。

• 第一次调用 peekMessages() 提取第一条活动消息。 每个后续调用都会提取后续消息。
• 与“接收”消息不同，“速览”消息是消息的只读版本。 它不能 Completed/Abandoned/Deferred/Deadlettered。

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

参数

返回

返回一个承诺，该承诺解析为由给定 sequenceNumbers标识的延迟消息数组。

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

参数

返回

给定 sequenceNumbers 标识的消息列表，如果未找到任何消息，则为空列表。

返回一个承诺，该承诺解析为从服务总线接收的消息数组。

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

参数

返回

使用消息数组解析的承诺。

在创建队列/订阅期间指定的持续时间内续订消息上的锁。

• 检查消息上的 lockedUntilUtc 属性，了解锁过期的时间。
• 如果消息未解决（在锁定过期之前使用 complete()、defer() 或 deadletter()，则消息会返回到队列/订阅中，以便执行下一次接收作。

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

参数

返回

采用 UTC 格式的新锁定令牌到期日期和时间。

将消息流式传输到消息处理程序。

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

参数

返回

可以关闭的对象，将任何剩余的消息发送到 handlers 并停止新消息到达。