ServiceBusSessionReceiver interface

セッション ID。

sessionId: string

プロパティ値

セッションがロックされるまでの UTC 時間。 renewSessionLock()が呼び出されるたびに、この時刻は現在の時刻に加えて、キュー/サブスクリプションの作成時に指定されたロック期間に更新されます。

AMQP レシーバー リンクがセッションに対して正常に設定されるまで undefined を返します。

sessionLockedUntilUtc: Date

プロパティ値

レシーバーが作成されたエンティティのパス。

entityPath: string

プロパティ値

ServiceBusReceiver.entityPathから継承

受信者を識別するために使用される名前。 これは、ログと例外を関連付けるために使用できます。 指定しない場合、または空の場合は、ランダムな一意のものが生成されます。

identifier: string

プロパティ値

ServiceBusReceiver.identifierから継承

true受信側または受信側を作成したクライアントが閉じられている場合は を返します。

isClosed: boolean

プロパティ値

ServiceBusReceiver.isClosedから継承

受信側の作成に使用される受信モード。

receiveMode: "peekLock" | "receiveAndDelete"

プロパティ値

ServiceBusReceiver.receiveModeから継承

セッションの状態を取得します。 セッション状態の詳細については、「セッションの状態」を参照してください。

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

パラメーター

戻り値

そのセッションの状態

セッションのロックを更新します。

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

パラメーター

戻り値

セッションの状態を設定します。 セッション状態の詳細については、「セッションの状態」を参照してください。

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

パラメーター

戻り値

メッセージをメッセージ ハンドラーにストリーミングします。

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

パラメーター

戻り値

閉じることができるオブジェクト。残りのメッセージを handlers 送信し、新しいメッセージの到着を停止します。

受信側によってメッセージに保持されているロックは解除され、別の受信操作のために Service Bus でメッセージを再び使用できるようになります。

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

パラメーター

戻り値

ServiceBusReceiver.abandonMessageから継承

レシーバーを閉じます。 いったん閉じると、レシーバーはそれ以上の操作には使用できません。 createReceiver() ServiceBusClient の メソッドを使用して、新しい Receiver を作成します。

function close(): Promise<void>

戻り値

ServiceBusReceiver.closeから継承

Service Bus からメッセージを削除します。

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

パラメーター

戻り値

ServiceBusReceiver.completeMessageから継承

メッセージを配信不能サブキューに移動します。 配信不能メッセージを受信するには、配信不能サブキューのパスを使用して、新しい QueueClient/SubscriptionClient を作成します。

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

パラメーター

戻り値

ServiceBusReceiver.deadLetterMessageから継承

メッセージの処理を延期します。 メッセージの を sequenceNumber 保存し、 メソッドを使用して receiveDeferredMessage メッセージを今後再び受信します。

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

パラメーター

戻り値

ServiceBusReceiver.deferMessageから継承

Service Bus からメッセージを受信するために使用できる反復子を返します。

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

パラメーター

戻り値

ServiceBusReceiver.getMessageIteratorから継承

キューまたはサブスクリプション上のアクティブ メッセージの次のバッチ (遅延メッセージを含むが、配信不能ではないメッセージを含む) を変更せずにピークします。

• を最初に呼び出すと peekMessages() 、最初のアクティブ メッセージがフェッチされます。 後続の呼び出しごとに、後続のメッセージがフェッチされます。
• "受信" メッセージとは異なり、"ピーク" メッセージはメッセージの読み取り専用バージョンです。 Completed/Abandoned/Deferred/Deadlettered にすることはできません。

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

パラメーター

戻り値

ServiceBusReceiver.peekMessagesから継承

指定 sequenceNumbersした によって識別される遅延メッセージの配列に解決される promise を返します。

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

パラメーター

戻り値

指定された sequenceNumbers によって識別されるメッセージの一覧。メッセージが見つからない場合は空のリスト。

ServiceBusReceiver.receiveDeferredMessagesから継承

Service Bus から受信したメッセージの配列に解決される promise を返します。

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

パラメーター

戻り値

メッセージの配列で解決される promise。

ServiceBusReceiver.receiveMessagesから継承

キュー/サブスクリプションの作成時に指定した期間、メッセージのロックを更新します。

• メッセージの lockedUntilUtc プロパティで、ロックの有効期限が切れる時刻を確認します。
• (ロックの有効期限が切れる前に、 defer() または deadletter()を使用してcomplete()) メッセージが解決されない場合、メッセージは次の受信操作のためにキュー/サブスクリプションに戻ります。

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

パラメーター

戻り値

新しいロック トークンの有効期限の日付と時刻 (UTC 形式)。

ServiceBusReceiver.renewMessageLockから継承