Message Classe

Definição

A estrutura de dados representa a mensagem usada para interagir com o IotHub.

public sealed class Message : IDisposable, Microsoft.Azure.Devices.Client.IReadOnlyIndicator
type Message = class
    interface IReadOnlyIndicator
    interface IDisposable
Public NotInheritable Class Message
Implements IDisposable, IReadOnlyIndicator
Herança
Message
Implementações

Construtores

Message()

Construtor padrão sem dados de corpo

Message(Byte[])

Construtor que usa a matriz de bytes de entrada como o corpo.

Message(Stream)

Construtor que usa o fluxo de argumento como o fluxo do corpo.

Propriedades

BodyStream

O fluxo de corpo da instância de dados de evento atual

ComponentName

O nome do componente DTDL de onde a mensagem de telemetria foi originada. Isso é relevante apenas para dispositivos certificados de plug and play.

ConnectionDeviceId

Especifica a ID do dispositivo da qual essa mensagem foi enviada, se houver uma.

ConnectionModuleId

Especifica a ID do módulo da qual essa mensagem foi enviada, se houver uma.

ContentEncoding

Usado para especificar o tipo de codificação de conteúdo da mensagem.

ContentType

Usado para especificar o tipo de conteúdo da mensagem.

CorrelationId

Usado em respostas e comentários de mensagens

CreationTimeUtc

Propriedade de data personalizada definida pelo originador da mensagem.

DeliveryCount

Número de vezes que a mensagem foi entregue anteriormente

EnqueuedTimeUtc

Data e hora em que a mensagem do dispositivo para a nuvem foi recebida pelo servidor.

ExpiryTimeUtc

[Opcional] A hora em que essa mensagem é considerada expirada

InputName

Especifica o nome de entrada no qual a mensagem foi enviada, se houver um.

IsSecurityMessage

True se a mensagem estiver definida como uma mensagem de segurança

LockToken

[Obrigatório] LockToken da mensagem recebida

MessageId

[Necessário para solicitações bidirecionais] Usado para correlacionar a comunicação bidirecional. Formato: uma cadeia de caracteres que diferencia maiúsculas de minúsculas ( até 128 caracteres de comprimento) de caracteres alfanuméricos ASCII de 7 bits

  • {'-', ':', '/', '', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}. Caracteres não alfanuméricos são de URN RFC.
MessageSchema

Usado para especificar o esquema do conteúdo da mensagem.

Properties

Obtém o dicionário de propriedades de usuário que são definidas quando o usuário envia os dados.

SequenceNumber

[Obrigatório] SequenceNumber da mensagem recebida

To

[Obrigatório] Destino da mensagem

UserId

[Obrigatório em mensagens de comentários] Usado para especificar a origem das mensagens geradas pelo hub de dispositivos. Valor possível: "{nome do hub}/"

Métodos

CloneWithBody(Byte[])

Clona uma instância existente Message e define o corpo do conteúdo definido por byteArray nela.

Dispose()

Descartar a instância de dados de evento atual

GetBodyStream()

Retornar o fluxo de corpo da instância de dados de evento atual

GetBytes()

Esses métodos retornam o fluxo do corpo como uma matriz de bytes

SetAsSecurityMessage()

Define a mensagem como uma mensagem de segurança

Implantações explícitas de interface

IReadOnlyIndicator.IsReadOnly

A estrutura de dados representa a mensagem usada para interagir com o IotHub.

Aplica-se a