Partilhar via

Device class

  • Referência
Pacote:
azure-iothub

Aviso

Esta API foi preterida.

Cria uma representação de um dispositivo para uso com o registro de identidade de dispositivo APIs.

Essa classe foi preterida porque o de registro de identidade de dispositivo pode trabalhar diretamente com objetos JSON contendo 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 propriedade symmetricKey (era com caixa de pascal em vez de caixa de camelo). O SDK está mantendo essa classe para não quebrar o código existente, mas isso será removido em uma futura atualização de versão principal e os clientes devem, em vez disso, usar objetos JSON simples.

Construtores

Device(any)

Instanciar um novo objeto Device.

Propriedades

authentication

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

Contém as capacidades deste dispositivo.
cloudToDeviceMessageCount

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

Se o dispositivo está "ligado" ou "desligado". No entanto, não é recomendável usar essa propriedade para determinar se o dispositivo está realmente conectado agora, uma vez que a conexão do dispositivo pode ter expirado e o hub IoT pode não tê-lo detetado, ou se o dispositivo está usando HTTPS para se conectar. Se você precisar monitorar conexões de dispositivos, a maneira recomendada é usar o recurso de monitoramento 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 dispositivo do hub IoT do Azure.
etag

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

Usado para desambiguar dispositivos que foram excluídos/recriados com a mesma deviceId
lastActivityTime

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

'habilitado' (dispositivo autorizado a se conectar, pode enviar/receber mensagens) ou 'desativado'.
statusReason

Conjunto de cadeias de caracteres de 128 caracteres 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 objeto Device.

new Device(jsonData?: any)

Parâmetros

jsonData

any

Uma representação JSON opcional do dispositivo, que será mapeada para propriedades no objeto. Se nenhum argumento for fornecido, as propriedades do dispositivo receberão valores padrão.

Detalhes de Propriedade

authentication

Contém as chaves simétricas usadas 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 aguardando por entregues no dispositivo.

cloudToDeviceMessageCount?: string

Valor de Propriedade

string

connectionState

Se o dispositivo está "ligado" ou "desligado". No entanto, não é recomendável usar essa propriedade para determinar se o dispositivo está realmente conectado agora, uma vez que a conexão do dispositivo pode ter expirado e o hub IoT pode não tê-lo detetado, ou se o dispositivo está usando HTTPS para se conectar. Se você precisar monitorar conexões de dispositivos, a maneira recomendada é usar o recurso de monitoramento 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 dispositivo do hub IoT do Azure.

deviceId: string

Valor de Propriedade

string

etag

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

etag?: string

Valor de Propriedade

string

generationId

Usado para desambiguar dispositivos que foram excluídos/recriados com a mesma deviceId

generationId?: string

Valor de Propriedade

string

lastActivityTime

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

lastActivityTime?: string

Valor de Propriedade

string

status

'habilitado' (dispositivo autorizado a se conectar, pode enviar/receber mensagens) ou 'desativado'.

status?: DeviceStatus

Valor de Propriedade

DeviceStatus

statusReason

Conjunto de cadeias de caracteres de 128 caracteres 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