Device class

  • Referência
Pacote:
azure-iothub

Aviso

Esta API foi preterida.

Cria uma representação de um dispositivo para utilização com as APIs do registo de identidade do dispositivo .

Esta classe foi preterida porque o registo de identidade do dispositivo pode funcionar diretamente com objetos JSON que contêm uma descrição parcial do dispositivo, não necessariamente o objeto completo. Além disso, inicialmente, esta classe foi enviada com um erro de digitação no nome da symmetricKey propriedade (foi pascal-cased em vez de camel-cased). O SDK está a manter esta classe por perto para não quebrar o código existente, mas este será removido numa futura atualização de versão principal e os clientes devem, em vez disso, utilizar objetos JSON simples.

Construtores

Device(any)

Instanciar um novo Device objeto.

Propriedades

authentication

Contém as chaves simétricas utilizadas para autenticar este dispositivo.
capabilities

Contém as capacidades deste dispositivo.
cloudToDeviceMessageCount

Número de mensagens c2d a aguardar por entregues no dispositivo.
connectionState

Quer o dispositivo esteja "ligado" ou "desligado". No entanto, não é recomendado utilizar esta propriedade para determinar se o dispositivo está realmente ligado neste momento, uma vez que a ligação do dispositivo pode ter excedido o tempo limite e o hub IoT pode não o ter detetado ou se o dispositivo está a utilizar HTTPS para ligar. Se precisar de monitorizar as ligações de dispositivos, a forma reiniciada é utilizar a funcionalidade de monitorização de operações do seu hub.
connectionStateUpdatedTime

Carimbo de data/hora que representa a última vez connectionState alterado.
deviceId

Identificador de dispositivo exclusivo tal como existe no registo de dispositivos do hub IoT do Azure.
etag

Etiqueta de entidade fraca atribuída a esta descrição da identidade do dispositivo
generationId

Utilizado para desambiguar dispositivos que foram eliminados/recriados com o mesmo deviceId
lastActivityTime

Carimbo de data/hora que representa a última vez que o dispositivo autenticou, enviou uma mensagem ou recebeu uma mensagem.
status

"ativado" (dispositivo autorizado a ligar, pode enviar/receber mensagens) ou "desativado".
statusReason

Cadeia de carateres de 128 carateres definida quando o dispositivo está desativado.
statusUpdatedTime

Carimbo de data/hora que representa a última vez status alterado.

Detalhes do Construtor

Device(any)

Instanciar um novo Device objeto.

new Device(jsonData?: any)

Parâmetros

jsonData

any

Uma representação JSON opcional do dispositivo, que será mapeada para propriedades no objeto. Se não for fornecido nenhum argumento, serão atribuídos valores predefinidos às propriedades do dispositivo.

Detalhes de Propriedade

authentication

Contém as chaves simétricas utilizadas para autenticar este dispositivo.

authentication?: Authentication

Valor de Propriedade

Authentication

capabilities

Contém as capacidades deste dispositivo.

capabilities?: Capabilities

Valor de Propriedade

Capabilities

cloudToDeviceMessageCount

Número de mensagens c2d a aguardar por entregues no dispositivo.

cloudToDeviceMessageCount?: string

Valor de Propriedade

string

connectionState

Quer o dispositivo esteja "ligado" ou "desligado". No entanto, não é recomendado utilizar esta propriedade para determinar se o dispositivo está realmente ligado neste momento, uma vez que a ligação do dispositivo pode ter excedido o tempo limite e o hub IoT pode não o ter detetado ou se o dispositivo está a utilizar HTTPS para ligar. Se precisar de monitorizar as ligações de dispositivos, a forma reiniciada é utilizar a funcionalidade de monitorização de operações do seu hub.

connectionState?: ConnectionState

Valor de Propriedade

ConnectionState

connectionStateUpdatedTime

Carimbo de data/hora que representa a última vez connectionState alterado.

connectionStateUpdatedTime?: string

Valor de Propriedade

string

deviceId

Identificador de dispositivo exclusivo tal como existe no registo de dispositivos do hub IoT do Azure.

deviceId: string

Valor de Propriedade

string

etag

Etiqueta de entidade fraca atribuída a esta descrição da identidade do dispositivo

etag?: string

Valor de Propriedade

string

generationId

Utilizado para desambiguar dispositivos que foram eliminados/recriados com o mesmo deviceId

generationId?: string

Valor de Propriedade

string

lastActivityTime

Carimbo de data/hora que representa a última vez que o dispositivo autenticou, enviou uma mensagem ou recebeu uma mensagem.

lastActivityTime?: string

Valor de Propriedade

string

status

"ativado" (dispositivo autorizado a ligar, pode enviar/receber mensagens) ou "desativado".

status?: DeviceStatus

Valor de Propriedade

DeviceStatus

statusReason

Cadeia de carateres de 128 carateres definida quando o dispositivo está desativado.

statusReason?: string

Valor de Propriedade

string

statusUpdatedTime

Carimbo de data/hora que representa a última vez status alterado.

statusUpdatedTime?: string

Valor de Propriedade

string