Twin class

Пакет:

azure-iothub

Двойник устройства — это документ, описывающий состояние устройства, которое хранится в Центре Интернета вещей Azure и доступно, даже если устройство находится в автономном режиме. Он состоит из 3 разделов:

• Теги: пары "ключ-значение", доступные только на стороне службы
• Требуемые свойства: обновляется службой и получается устройством.
• Сообщаемые свойства: обновлены устройством и получены службой.

Обратите внимание, что хотя это и возможно, требуемые и сообщаемые свойства не обязательно должны совпадать и что логика синхронизации этих двух коллекций, если это необходимо, предоставляется пользователю пакета SDK.

Дополнительные сведения см. в разделе Общие сведения о двойниках устройств.

Рекомендуемый Twin способ получить для конкретного устройства — использовать getTwin(string, HttpResponseCallback<Twin>) метод .

Конструкторы

Twin(string | DeviceIdentity, Registry)

Создает новый объект Twin. Для получения нового Twin объекта рекомендуется использовать getTwin(string, HttpResponseCallback<Twin>) метод .

Свойства

deviceId	Уникальный идентификатор удостоверения устройства, связанного с двойником, так как он существует в реестре удостоверений устройств.
etag	Тег, используемый в оптимистичном параллелизме, чтобы избежать нескольких параллельных выпусков двойника устройства.
modelId	Идентификатор модели удостоверения устройства, связанного с двойником, так как он существует в реестре удостоверений устройств.
moduleId	Идентификатор модуля, связанного с двойником, так как он существует в реестре удостоверений устройств.
properties	Требуемые и сообщаемые свойства диктовки (соответственно в properties.desired и properties.reported).
tags	Коллекция пар "ключ-значение", которая доступна только на стороне службы и может использоваться в запросах для поиска определенных устройств.

Методы

get()
get(IncomingMessageCallback<Twin>)	Возвращает последнюю версию этого двойника устройства из службы Центр Интернета вещей.
toJSON()
update(any)
update(any, IncomingMessageCallback<Twin>)	Обновите двойник устройства, указав исправление, предоставленное в качестве аргумента.

Сведения о конструкторе

Twin(string | DeviceIdentity, Registry)

Создает новый объект Twin. Для получения нового Twin объекта рекомендуется использовать getTwin(string, HttpResponseCallback<Twin>) метод .

new Twin(device: string | DeviceIdentity, registryClient: Registry)

Параметры

device

string | DeviceIdentity

Строка идентификатора устройства или объект, описывающий устройство. Если объект объект, он должен содержать свойство deviceId.

registryClient

Registry

Клиент реестра HTTP, используемый для выполнения вызовов REST API.

Сведения о свойстве

deviceId

Уникальный идентификатор удостоверения устройства, связанного с двойником, так как он существует в реестре удостоверений устройств.

deviceId: string

Значение свойства

string

etag

Тег, используемый в оптимистичном параллелизме, чтобы избежать нескольких параллельных выпусков двойника устройства.

etag: string

Значение свойства

string

modelId

Идентификатор модели удостоверения устройства, связанного с двойником, так как он существует в реестре удостоверений устройств.

modelId?: string

Значение свойства

string

moduleId

Идентификатор модуля, связанного с двойником, так как он существует в реестре удостоверений устройств.

moduleId?: string

Значение свойства

string

properties

Требуемые и сообщаемые свойства диктовки (соответственно в properties.desired и properties.reported).

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>)

Возвращает последнюю версию этого двойника устройства из службы Центр Интернета вещей.

function get(done?: IncomingMessageCallback<Twin>)

Параметры

done

IncomingMessageCallback<Twin>

Необязательная функция, вызываемая после завершения операции. done будет вызываться с тремя аргументами: объект Error (может иметь значение NULL), объект Twin , представляющий созданное удостоверение устройства, и объект ответа для транспорта, полезный для ведения журнала или отладки.

toJSON()

function toJSON(): object

Возвращаемое значение

object

update(any)

function update(patch: any): Promise<ResultWithIncomingMessage<Twin>>

Параметры

patch

any

Возвращаемое значение

Promise<ResultWithIncomingMessage<Twin>>

update(any, IncomingMessageCallback<Twin>)

Обновите двойник устройства, указав исправление, предоставленное в качестве аргумента.

function update(patch: any, done?: IncomingMessageCallback<Twin>)

Параметры

patch

any

Объект , содержащий новые значения для применения к этому двойнику устройства.

done

IncomingMessageCallback<Twin>

Необязательная функция, вызываемая после завершения операции. done будет вызываться с тремя аргументами: объект Error (может иметь значение NULL), объект Twin , представляющий созданное удостоверение устройства, и объект ответа для транспорта, полезный для ведения журнала или отладки.