Twin class

Pacote:

azure-iothub

Um Dispositivo Gêmeo é um documento que descreve o estado de um dispositivo armazenado por um Hub IoT do Azure e está disponível mesmo que o dispositivo esteja offline. Ele é criado em torno de três seções:

• Marcas: pares chave/valor acessíveis somente do lado do serviço
• Propriedades desejadas: atualizadas por um serviço e recebidas pelo dispositivo
• Propriedades relatadas: atualizadas pelo dispositivo e recebidas pelo serviço.

Observe que, embora seja uma possibilidade, as propriedades desejadas e relatadas não precisam corresponder e que a lógica para sincronizar essas duas coleções, se necessário, é deixada para o usuário do SDK.

Para obter mais informações, consulte Noções básicas sobre dispositivos gêmeos.

A maneira recomendada de obter um Twin para um dispositivo específico é usar o getTwin(string, HttpResponseCallback<Twin>) método .

Construtores

Twin(string | DeviceIdentity, Registry)

Cria a instância de um novo Twin. A maneira recomendada de obter um novo Twin objeto é usar o getTwin(string, HttpResponseCallback<Twin>) método .

Propriedades

deviceId	Identificador exclusivo da identidade do dispositivo associada ao gêmeo, pois ele existe no registro de identidade do dispositivo.
etag	Marca usada em simultaneidade otimista para evitar várias edições paralelas do dispositivo gêmeo.
modelId	ID do modelo da identidade do dispositivo associada ao gêmeo, pois ela existe no registro de identidade do dispositivo.
moduleId	Identificador de módulo para o módulo associado ao gêmeo, pois ele existe no registro de identidade do dispositivo.
properties	As dictionnaries de propriedades desejadas e relatadas (respectivamente em properties.desired e properties.reported).
tags	Coleção de pares chave/valor que está disponível apenas no lado do serviço e pode ser usada em consultas para localizar dispositivos específicos.

Métodos

get()
get(IncomingMessageCallback<Twin>)	Obtém a versão mais recente deste dispositivo gêmeo do serviço Hub IoT.
toJSON()
update(any)
update(any, IncomingMessageCallback<Twin>)	Atualize o dispositivo gêmeo com o patch fornecido como argumento.

Detalhes do construtor

Twin(string | DeviceIdentity, Registry)

Cria a instância de um novo Twin. A maneira recomendada de obter um novo Twin objeto é usar o getTwin(string, HttpResponseCallback<Twin>) método .

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

Parâmetros

device

string | DeviceIdentity

Uma cadeia de caracteres de identificador de dispositivo ou um objeto que descreve o dispositivo. Se um Object, ele deverá conter uma propriedade deviceId.

registryClient

Registry

O cliente do registro HTTP usado para executar chamadas à API REST.

Detalhes da propriedade

deviceId

Identificador exclusivo da identidade do dispositivo associada ao gêmeo, pois ele existe no registro de identidade do dispositivo.

deviceId: string

Valor da propriedade

string

etag

Marca usada em simultaneidade otimista para evitar várias edições paralelas do dispositivo gêmeo.

etag: string

Valor da propriedade

string

modelId

ID do modelo da identidade do dispositivo associada ao gêmeo, pois ela existe no registro de identidade do dispositivo.

modelId?: string

Valor da propriedade

string

moduleId

Identificador de módulo para o módulo associado ao gêmeo, pois ele existe no registro de identidade do dispositivo.

moduleId?: string

Valor da propriedade

string

properties

As dictionnaries de propriedades desejadas e relatadas (respectivamente em properties.desired e properties.reported).

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

Valor da propriedade

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

tags

Coleção de pares chave/valor que está disponível apenas no lado do serviço e pode ser usada em consultas para localizar dispositivos específicos.

tags: {[key: string]: string}

Valor da propriedade

{[key: string]: string}

Detalhes do método

get()

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

Retornos

Promise<ResultWithIncomingMessage<Twin>>

get(IncomingMessageCallback<Twin>)

Obtém a versão mais recente deste dispositivo gêmeo do serviço Hub IoT.

function get(done?: IncomingMessageCallback<Twin>)

Parâmetros

done

IncomingMessageCallback<Twin>

A função opcional a ser chamada quando a operação for concluída. done será chamado com três argumentos: um objeto Error (pode ser nulo), um objeto Twin que representa a identidade do dispositivo criado e um objeto de resposta específico do transporte útil para registro em log ou depuração.

toJSON()

function toJSON(): object

Retornos

object

update(any)

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

Parâmetros

patch

any

Retornos

Promise<ResultWithIncomingMessage<Twin>>

update(any, IncomingMessageCallback<Twin>)

Atualize o dispositivo gêmeo com o patch fornecido como argumento.

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

Parâmetros

patch

any

Objeto que contém os novos valores a serem aplicados a este dispositivo gêmeo.

done

IncomingMessageCallback<Twin>

A função opcional a ser chamada quando a operação for concluída. done será chamado com três argumentos: um objeto Error (pode ser nulo), um objeto Twin que representa a identidade do dispositivo criado e um objeto de resposta específico do transporte útil para registro em log ou depuração.