ServiceBusReceivedMessage interface

死電訊息的錯誤描述。

deadLetterErrorDescription?: string

屬性值

扼殺訊息的原因。

deadLetterReason?: string

屬性值

此訊息加入佇列或訂用帳戶名稱，在訊息已失效之前。 只有在已寄不出的信件的訊息中設定，然後從寄不出的信件子佇列自動轉寄至另一個實體。 指出訊息已寄不出的實體。

deadLetterSource?: string

屬性值

已嘗試傳送此訊息的傳遞數目。 當訊息鎖定到期或訊息使用 abandon() 方法明確放棄訊息時，計數就會遞增。

deliveryCount?: number

屬性值

訊息的原始序號。 對於已自動轉送的訊息，這個屬性會反映已在其原始提交點指派給訊息的序號。

enqueuedSequenceNumber?: number

屬性值

訊息已接受並儲存在服務總線中的UTC瞬間。

enqueuedTimeUtc?: Date

屬性值

訊息標示為移除的UTC瞬間，由於到期而無法再從實體擷取。 這個屬性是從訊息上的 2 個其他屬性計算：enqueuedTimeUtc + timeToLive。

expiresAtUtc?: Date

屬性值

UTC立即，直到訊息鎖定在佇列/訂用帳戶中為止。 當鎖定過期時，deliveryCount 會遞增，而且訊息會再次可供擷取。

• 當訊息以 receiveAndDelete 接收模式接收時不適用。 模式。

lockedUntilUtc?: Date

屬性值

鎖定令牌是代理程式 peekLock 接收模式所持有鎖定的參考。 鎖定會在內部使用，如 產品檔中所述，更詳細地

• 當訊息以 receiveAndDelete 接收模式接收時不適用。 模式。

lockToken?: string

屬性值

服務總線指派給訊息的唯一號碼。 序號是指派給訊息的唯一 64 位整數，因為訊息被訊息代理程式接受並儲存為其 true 識別符。 對於分割實體，最上層的16位會反映分割區標識碼。 序號單調增加。 當 48-64 位範圍耗盡時，它們會變換至 0。

Javascript 目前支援的最大安全整數 為 2^53 - 1。 序號是AMQP Long 類型，長度可達64位。 為了表示我們使用名為 long.js的連結庫。 我們預期客戶會使用此連結庫所導出 Long 類型。

sequenceNumber?: Long

屬性值

訊息的狀態可以是作用中、延遲或排程。 延遲的訊息具有延後狀態、排程的訊息具有排程狀態、所有其他訊息都處於作用中狀態。

state: "active" | "deferred" | "scheduled"

屬性值

可用於自定義訊息元數據的應用程式特定屬性。

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

屬性值

繼承自ServiceBusMessage.applicationProperties

需要傳送或接收的訊息本文。 如果接收訊息的應用程式未使用此 SDK，請將本文承載轉換為位元組陣列或 Buffer，以取得更佳的跨語言相容性。

body: any

屬性值

繼承自ServiceBusMessage.body

訊息的內容類型。 選擇性地描述訊息的承載，其描述項會遵循第 5 節RFC2045的格式，例如“application/json”。

contentType?: string

屬性值

繼承自ServiceBusMessage.contentType

可讓應用程式針對相互關聯目的指定訊息內容的相互關聯標識符，例如反映正在回復之訊息的 MessageId。 請參閱 訊息路由和相互關聯。

correlationId?: string | number | Buffer

屬性值

繼承自ServiceBusMessage.correlationId

訊息標識碼是應用程式定義的值，可唯一識別訊息及其承載。

注意：不允許不是整數的數位。

messageId?: string | number | Buffer

屬性值

繼承自ServiceBusMessage.messageId

將訊息傳送至數據分割實體的數據分割索引鍵。 長度上限為 128 個字元。 針對 分割實體，設定此值可讓相關訊息指派給相同的內部分割區，以便正確記錄提交順序。 分割區是由哈希函式透過此值選擇，無法直接選擇。

• 對於會話感知實體，sessionId 屬性會覆寫此值。
• 針對非分割實體，將會忽略分割區索引鍵

partitionKey?: string

屬性值

繼承自ServiceBusMessage.partitionKey

要傳送回復之實體的位址。 這個選擇性和應用程式定義的值是向訊息接收者表示回復路徑的標準方式。 當傳送者預期回復時，它會將值設定為佇列或主題的絕對或相對路徑，其預期回復會傳送至該佇列或主題。 請參閱 訊息路由和相互關聯。

replyTo?: string

屬性值

繼承自ServiceBusMessage.replyTo

擴充 replyTo 位址的會話標識碼。 長度上限為 128 個字元。 此值會增強 ReplyTo 資訊，並指定傳送至回覆實體時，應該為回復設定哪些 SessionId。 請參閱 訊息路由和相互關聯。

replyToSessionId?: string

屬性值

繼承自ServiceBusMessage.replyToSessionId

以UTC為單位的日期和時間，訊息將加入佇列。 這個屬性會以UTC傳回時間;設定 屬性時，提供的 DateTime 值也必須為 UTC。 此值適用於延遲傳送的訊息。 它可用來延遲傳送至未來特定時間的訊息。 訊息加入佇列時間並不表示訊息會同時傳送。 它會加入佇列，但實際的傳送時間取決於佇列的工作負載及其狀態。

scheduledEnqueueTimeUtc?: Date

屬性值

繼承自ServiceBusMessage.scheduledEnqueueTimeUtc

會話感知實體的會話標識碼。 長度上限為 128 個字元。 對於會話感知實體，這個應用程式定義的值會指定訊息的會話關聯性。 具有相同會話標識碼的訊息受限於摘要鎖定，並啟用確切的順序處理和解構。 若為會話未察覺的實體，則會忽略此值。 訊息工作階段。

sessionId?: string

屬性值

繼承自ServiceBusMessage.sessionId

應用程式特定標籤。 這個屬性可讓應用程式在標準化中向接收者指出訊息的目的。 fashion，類似於電子郵件主旨行。 對應的AMQP屬性為 「subject」。。

subject?: string

屬性值

繼承自ServiceBusMessage.subject

訊息存留時間值。 這個值是訊息到期的相對持續時間，從訊息代理程式已接受並儲存的立即開始，如 enqueuedTimeUtc中所擷取。 如果未明確設定，假設的值是個別佇列或主題的 DefaultTimeToLive。 訊息層級 timeToLive 值不能超過實體的DefaultTimeToLive設定，而且會以無訊息方式調整。 請參閱 到期。

timeToLive?: number

屬性值

繼承自ServiceBusMessage.timeToLive

“to” 位址。 此屬性會保留供未來在路由案例中使用，且目前由訊息代理程式本身忽略。 應用程式可以在規則驅動 自動轉寄鏈結 案例中使用此值，以指出訊息的預期邏輯目的地。

to?: string

屬性值

繼承自ServiceBusMessage.to 的