Twin class

  • Referencia
Paquete:
azure-iothub

Un dispositivo gemelo está documentando el estado de un dispositivo almacenado por una instancia de Azure IoT Hub y está disponible incluso si el dispositivo está sin conexión. Se construye alrededor de 3 secciones:

  • Etiquetas: pares clave-valor solo accesibles desde el lado del servicio
  • Propiedades deseadas: actualizadas por un servicio y recibidas por el dispositivo
  • Propiedades notificadas: actualizadas por el dispositivo y recibidas por el servicio.

Tenga en cuenta que, aunque es una posibilidad, las propiedades deseadas y notificadas no tienen que coincidir y que la lógica para sincronizar estas dos colecciones, si es necesario, se deja al usuario del SDK.

Para más información, consulte Descripción de los dispositivos gemelos.

La manera recomendada de obtener un Twin para un dispositivo específico es usar el getTwin(string, HttpResponseCallback<Twin>) método .

Constructores

Twin(string | DeviceIdentity, Registry)

Crea una instancia de un nuevo objeto Twin. La manera recomendada de obtener un nuevo Twin objeto es usar el getTwin(string, HttpResponseCallback<Twin>) método .

Propiedades

deviceId

Identificador único de la identidad del dispositivo asociada al gemelo, ya que existe en el registro de identidades del dispositivo.
etag

Etiqueta usada en simultaneidad optimista para evitar varias ediciones paralelas del dispositivo gemelo.
modelId

Id. de modelo de la identidad del dispositivo asociada al gemelo, ya que existe en el registro de identidad del dispositivo.
moduleId

Identificador de módulo del módulo asociado al gemelo, ya que existe en el registro de identidades del dispositivo.
properties

Las dicciones de propiedades deseadas y notificadas (respectivamente en properties.desired y properties.reported).
tags

Colección de pares clave-valor que solo está disponible en el lado del servicio y se puede usar en consultas para buscar dispositivos específicos.

Métodos

get()
get(IncomingMessageCallback<Twin>)

Obtiene la versión más reciente de este dispositivo gemelo del servicio IoT Hub.
toJSON()
update(any)
update(any, IncomingMessageCallback<Twin>)

Actualice el dispositivo gemelo con la revisión proporcionada como argumento.

Detalles del constructor

Twin(string | DeviceIdentity, Registry)

Crea una instancia de un nuevo objeto Twin. La manera recomendada de obtener un nuevo Twin objeto es usar el getTwin(string, HttpResponseCallback<Twin>) método .

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

Parámetros

device

string | DeviceIdentity

Una cadena de identificador de dispositivo o un objeto que describe el dispositivo. Si es object, debe contener una propiedad deviceId.

registryClient
Registry

El cliente del Registro HTTP que se usa para ejecutar llamadas API REST.

Detalles de las propiedades

deviceId

Identificador único de la identidad del dispositivo asociada al gemelo, ya que existe en el registro de identidades del dispositivo.

deviceId: string

Valor de propiedad

string

etag

Etiqueta usada en simultaneidad optimista para evitar varias ediciones paralelas del dispositivo gemelo.

etag: string

Valor de propiedad

string

modelId

Id. de modelo de la identidad del dispositivo asociada al gemelo, ya que existe en el registro de identidad del dispositivo.

modelId?: string

Valor de propiedad

string

moduleId

Identificador de módulo del módulo asociado al gemelo, ya que existe en el registro de identidades del dispositivo.

moduleId?: string

Valor de propiedad

string

properties

Las dicciones de propiedades deseadas y notificadas (respectivamente en properties.desired y properties.reported).

properties: { desired: {[key: string]: any}, reported: {[key: string]: any} }

Valor de propiedad

{ desired: {[key: string]: any}, reported: {[key: string]: any} }

tags

Colección de pares clave-valor que solo está disponible en el lado del servicio y se puede usar en consultas para buscar dispositivos específicos.

tags: {[key: string]: string}

Valor de propiedad

{[key: string]: string}

Detalles del método

get() 

function get(): Promise<ResultWithIncomingMessage<Twin>>

Devoluciones

Promise<ResultWithIncomingMessage<Twin>>

get(IncomingMessageCallback<Twin>)

Obtiene la versión más reciente de este dispositivo gemelo del servicio IoT Hub.

function get(done?: IncomingMessageCallback<Twin>)

Parámetros

done

IncomingMessageCallback<Twin>

Función opcional a la que se llamará cuando se complete la operación. done se llamará con tres argumentos: un objeto Error (puede ser NULL), un objeto Twin que representa la identidad del dispositivo creado y un objeto de respuesta específico del transporte útil para el registro o la depuración.

toJSON() 

function toJSON(): object

Devoluciones

object

update(any) 

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

Parámetros

patch

any

Devoluciones

Promise<ResultWithIncomingMessage<Twin>>

update(any, IncomingMessageCallback<Twin>)

Actualice el dispositivo gemelo con la revisión proporcionada como argumento.

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

Parámetros

patch

any

Objeto que contiene los nuevos valores que se van a aplicar a este dispositivo gemelo.

done

IncomingMessageCallback<Twin>

Función opcional a la que se llamará cuando se complete la operación. done se llamará con tres argumentos: un objeto Error (puede ser NULL), un objeto Twin que representa la identidad del dispositivo creado y un objeto de respuesta específico del transporte útil para el registro o la depuración.