Twin class
Двойник устройства — это документ, описывающий состояние устройства, хранящегося центром Интернета вещей Azure, и доступен, даже если устройство находится в автономном режиме. Он построен около 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 |
Возвращает последнюю версию этого двойника устройства из службы Центра Интернета вещей. |
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
Клиент реестра 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, представляющий созданное удостоверение устройства, и объект ответа для конкретного транспорта, полезный для ведения журнала или отладки.