azure-iot-common package

Classes

Message	O Message objeto é utilizado para mensagens assíncronas de telemetria (dispositivo para cloud) e comandos (cloud a dispositivo) entre o dispositivo e o serviço Hub IoT. É transport-agnostic, o que significa que funciona da mesma forma através de AMQP, MQTT e HTTP.
ArgumentError	Erro emitido quando um argumento é inválido.
ArgumentOutOfRangeError	Erro emitido quando um argumento tem um valor que está fora do intervalo admissível.
BadDeviceResponseError	Erro gerado quando um dispositivo envia uma resposta incorreta a uma chamada de método de dispositivo.
CloudToDeviceDetachedError	Erro gerado quando a funcionalidade c2d deixou de funcionar ao nível do transporte, exigindo que o cliente volte a iniciá-la.
DeviceAlreadyExistsError	Erro gerado quando o ID do dispositivo utilizado para a criação de dispositivos já existe no Registo de Identidade do Dispositivo.
DeviceMaximumQueueDepthExceededError	Erro emitido quando a fila de mensagens de um dispositivo está cheia.
DeviceMessageLockLostError	Erro gerado ao resolver uma mensagem falha porque o token de bloqueio associado à mensagem é perdido.
DeviceMethodsDetachedError	Erro gerado quando a funcionalidade métodos do dispositivo deixou de funcionar ao nível do transporte, exigindo que o cliente volte a iniciá-lo.
DeviceNotFoundError	Erro gerado quando não é possível encontrar um dispositivo no registo da instância Hub IoT.
DeviceRegistrationFailedError	Erro gerado quando uma operação de registo do DPS falha
DeviceTimeoutError	Erro emitido quando o dispositivo não processa a chamada do método a tempo.
FormatError	Erro emitido quando uma cadeia que é suposto ter uma formatação específica não está formatada corretamente.
GatewayTimeoutError	Erro gerado quando a instância Hub IoT não processa a chamada do método do dispositivo a tempo.
InternalServerError	Erro gerado quando ocorreu um erro interno do servidor. Pode ter encontrado um erro?
InvalidEtagError	Erro emitido quando o eTag especificado está formatado incorretamente ou desatualizado.
InvalidOperationError	Erro emitido quando uma operação é tentada, mas não é permitida.
IotHubNotFoundError	Erro gerado quando o hub IoT do Azure não foi encontrado.
IotHubQuotaExceededError	Erro ao lançar a quota do hub IoT do Azure foi excedida. As quotas são repostas periodicamente, esta operação terá de aguardar até lá. Para saber mais sobre quotas, veja Hub IoT do Azure quotas e limitação
IoTHubSuspendedError	Erro emitido quando Hub IoT foi suspensa.
JobNotFoundError	Erro gerado quando a tarefa com o identificador especificado não foi encontrada.
MessageTooLargeError	Erro emitido quando a mensagem enviada é demasiado grande: o tamanho máximo é de 256 Kb.
NotConnectedError	Erro emitido quando o dispositivo está desligado e a operação não pode ser concluída.
NotImplementedError	Erro gerado quando uma funcionalidade ainda não está implementada, mas o marcador de posição está presente.
OperationCancelledError	Erro gerado quando qualquer operação (local ou remota) é cancelada
PreconditionFailedError	Erro emitido quando uma condição que deveria ter sido cumprida para executar uma operação não foi.
SecurityDeviceError	Erro gerado quando um dispositivo/controlador de segurança de baixo nível falha.
ServiceUnavailableError	Erro emitido quando o serviço está indisponível. A operação deve ser repetida.
ThrottlingError	Erro emitido quando Hub IoT é limitado devido a atividade excessiva. Para saber mais sobre quotas, veja Hub IoT do Azure quotas e limitação
TimeoutError	Erro emitido quando ocorre um tempo limite
TooManyDevicesError	Erro emitido quando o número máximo de dispositivos num hub específico foi atingido.
TwinDetachedError	Erro gerado quando a funcionalidade twin deixou de funcionar ao nível do transporte, exigindo que o cliente volte a iniciá-la.
TwinRequestError	Erro genérico emitido quando um pedido duplo falha com um código de erro desconhecido.
UnauthorizedError	Erro gerado quando os parâmetros de ligação estão errados e o servidor recusou a ligação.
Connected	Resultado devolvido quando um transporte é ligado com êxito.
Disconnected	Resultado devolvido quando um transporte é desligado com êxito.
MessageAbandoned	Resultado devolvido quando uma mensagem foi abandonada com êxito.
MessageCompleted	Resultado devolvido quando uma mensagem foi rejeitada com êxito.
MessageEnqueued	Resultado devolvido quando uma mensagem foi colocada em fila com êxito.
MessageRejected	Resultado devolvido quando uma mensagem foi rejeitada com êxito.
SharedAccessSignatureUpdated	Resultado devolvido quando um token de SAS foi atualizado com êxito.
TransportConfigured	Resultado devolvido quando um transporte é configurado com êxito.
ConnectionString	Descreve os parâmetros que permitem que um dispositivo ou aplicação na cloud se ligue a um hub IoT do Azure.
ExponentialBackOffWithJitter	Implementa um Backoff Exponencial com a estratégia de repetição do Jitter. A função a calcular o intervalo seguinte é a seguinte (x é a xth retry): F(x) = min(Cmin+ (2^(x-1)-1) * rand(C * (1 – Jd), C*(1-Ju)), Cmax)
NoRetry	Política stub que bloqueia qualquer tentativa de repetição. As operações não são repetidas.
RetryOperation	Implementa a lógica necessária para repetir operações como ligar, receber mensagens C2D, enviar telemetria, atualizações de duplos, etc.
SharedAccessSignature	Os tokens de assinatura de acesso partilhado são utilizados para autenticar a ligação ao utilizar chaves simétricas (em oposição a certificados x509) para proteger a ligação com o hub IoT do Azure.

Interfaces

AuthenticationProvider	Interface que tem de ser implementada por objetos que são utilizados para fornecer credenciais aos transportes utilizados pelo cliente do dispositivo para autenticar com uma instância do hub IoT do Azure.
Receiver
RetryPolicy	Interface que descreve um objeto de política de repetição. As políticas de repetição são compostas por 2 itens Um algoritmo que calcula a próxima vez que tentar novamente com base no número ou repetições atuais. Um filtro de erro que decide, com base no tipo de erro recebido, se deve ou não ocorrer uma repetição. Esses 2 componentes ocultam 2 chamadas de método descritas nesta interface.
TransportConfig	Estrutura de configuração utilizada por transportes e AuthenticationProvider objetos para armazenar e trocar credenciais.
X509	Objeto utilizado para armazenar um certificado X509 e uma chave para os transportes utilizarem. Esta ação é transmitida diretamente para os objetos de baixo nível utilizados pelo Node.js para ligar o socket TLS. https://nodejs.org/api/tls.html#tls_tls_connect_options_callback

Aliases de Tipo

BufferConvertible
ResultWithHttpResponse
Callback	Define o tipo que descreve a chamada de retorno regular com dois resultados: um é o Erro, o outro é o valor do resultado.
DoubleValueCallback	Define o tipo que descreve a chamada de retorno com dois resultados.
ErrorCallback	Define o tipo que descreve a chamada de retorno apenas com o valor do resultado do erro.
HttpResponseCallback	Define o tipo que descreve a chamada de retorno com três resultados : resposta, resposta HTTP não processada e um Erro.
NoErrorCallback	Define o tipo que descreve a chamada de retorno com um valor de resultado sem erro.
TripleValueCallback	Define o tipo que descreve a chamada de retorno regular com três resultados : o primeiro é Erro, os outros dois são os valores de resultado.

Enumerações

AuthenticationType

Designe o tipo de autenticação utilizado por um AuthenticationProvider.

Funções

anHourFromNow()	Devolve os segundos decorridos desde 1 de Janeiro de 1970 00:00:00 UTC até uma hora a partir de agora.
encodeUriComponentStrict(string)

Detalhes de Função

anHourFromNow()

Devolve os segundos decorridos desde 1 de Janeiro de 1970 00:00:00 UTC até uma hora a partir de agora.

function anHourFromNow(): number

Devoluções

number

encodeUriComponentStrict(string)

function encodeUriComponentStrict(str: string): string

Parâmetros

str

string

Devoluções

string