Twin class
裝置對應項檔描述 Azure IoT 中樞所儲存之裝置的狀態，即使裝置離線，仍可供使用。 其建置大約 3 個區段：
- 標籤：索引鍵/值組只能從服務端存取
- 所需屬性：由服務更新，並由裝置接收
- 報告屬性：由裝置更新，並由服務接收。
請注意，雖然這是可能的情況，但所需和報告的屬性不需要相符，而且視需要同步處理這兩個集合的邏輯會保留給 SDK 的使用者。
如需詳細資訊，請參閱 瞭解裝置對應項。
取得特定裝置的建議方法是 Twin 使用 getTwin(string, HttpResponseCallback<Twin>) 方法。
建構函式
| Twin(string | Device |
將新的 Twin 具現化。 取得新 Twin 物件的建議方法是使用 getTwin(string, HttpResponseCallback<Twin>) 方法。 |
屬性
| device |
與對應項相關聯的裝置身分識別的唯一識別碼，因為它存在於裝置身分識別登錄中。 |
| etag | 用於開放式平行存取的標籤，以避免裝置對應項的多個平行版本。 |
| model |
與對應項相關聯的裝置身分識別模型識別碼，因為它存在於裝置身分識別登錄中。 |
| module |
與對應項相關聯的模組模組識別碼，因為它存在於裝置身分識別登錄中。 |
| properties | 在 和 |
| tags | 只有服務端可用的索引鍵/值組集合，而且可用於查詢來尋找特定裝置。 |
方法
| get() | |
| get(Incoming |
從IoT 中樞服務取得此裝置對應項的最新版本。 |
| toJSON() | |
| update(any) | |
| update(any, Incoming |
使用提供作為引數的修補程式來更新裝置對應項。 |
建構函式詳細資料
Twin(string | DeviceIdentity, Registry)
將新的 Twin 具現化。 取得新 Twin 物件的建議方法是使用 getTwin(string, HttpResponseCallback<Twin>) 方法。
new Twin(device: string | DeviceIdentity, registryClient: Registry)參數
- device
-
string | DeviceIdentity
描述裝置的裝置識別碼字串或物件。 如果物件，它必須包含 deviceId 屬性。
- registryClient
- Registry
用來執行 REST API 呼叫的 HTTP 登錄用戶端。
屬性詳細資料
deviceId
與對應項相關聯的裝置身分識別的唯一識別碼，因為它存在於裝置身分識別登錄中。
deviceId: string屬性值
string
etag
用於開放式平行存取的標籤，以避免裝置對應項的多個平行版本。
etag: string屬性值
string
modelId
與對應項相關聯的裝置身分識別模型識別碼，因為它存在於裝置身分識別登錄中。
modelId?: string屬性值
string
moduleId
與對應項相關聯的模組模組識別碼，因為它存在於裝置身分識別登錄中。
moduleId?: string屬性值
string
properties
在 和 properties.reported) 中分別 properties.desired (所需的和報告屬性。
properties: { desired: {[key: string]: any}, reported: {[key: string]: any} }屬性值
{ desired: {[key: string]: any}, reported: {[key: string]: any} }
tags
只有服務端可用的索引鍵/值組集合，而且可用於查詢來尋找特定裝置。
tags: {[key: string]: string}屬性值
{[key: string]: string}
方法詳細資料
get()
function get(): Promise<ResultWithIncomingMessage<Twin>>傳回
Promise<ResultWithIncomingMessage<Twin>>
get(IncomingMessageCallback<Twin>)
從IoT 中樞服務取得此裝置對應項的最新版本。
function get(done?: IncomingMessageCallback<Twin>)參數
toJSON()
function toJSON(): object傳回
object
update(any)
function update(patch: any): Promise<ResultWithIncomingMessage<Twin>>參數
- patch
-
any
傳回
Promise<ResultWithIncomingMessage<Twin>>