Partager via

Message class

  • Référence
Paquet:
azure-iot-common

L’objet Message est utilisé pour la télémétrie (appareil à cloud) et les commandes (cloud-à-appareil) de messagerie asynchrone entre l’appareil et le service IoT Hub. Il est indépendant du transport, ce qui signifie qu’il fonctionne de la même façon sur AMQP, MQTT et HTTP.

Constructeurs

Message(BufferConvertible)

Crée un objet Message

Propriétés

ack

Type de commentaires demandé (en cas de commande cloud-à-appareil)
contentEncoding

Encodage de contenu du corps du message. peut être « utf-8 », « utf-16 » ou « utf-32 ».
contentType

Propriété de type de contenu utilisée pour acheminer le corps du message. Doit être « application/json ».
correlationId

Utilisé dans les réponses et commentaires des messages
data
expiryTimeUtc

Heure d’expiration en UTC interprétée par hub sur les messages C2D. Ignoré dans d’autres cas.
interfaceId

Ce message est-il un message de sécurité
lockToken

Utilisé pour abandonner, rejeter ou accepter le message
messageId

Utilisé pour mettre en corrélation la communication bidirectionnelle. Format : chaîne sensible à la casse (jusqu’à 128 caractères) de caractères alphanumériques ASCII 7 bits et symboles spéciaux suivants :
- : . + % _ # * ? ! ( ) , = @ ; $ '.
properties

Carte contenant des clés de chaîne et des valeurs pour le stockage des propriétés de message personnalisées.
to

Destination du message.
userId

Utilisé pour spécifier l’entité qui crée le message

Méthodes

getBytes()

Obtient les données transmises au constructeur en tant que tampon
getData()

Obtient le contenu (corps) du Message.
isBufferConvertible(any)

Retourne true si l’objet donné est de type BufferConvertible. Les objets de type BufferConvertible peuvent être passés dans le constructeur Message.
setAsSecurityMessage()

Définit ce message en tant que message de sécurité

Détails du constructeur

Message(BufferConvertible)

Crée un objet Message

new Message(data: BufferConvertible)

Paramètres

data
BufferConvertible

objet Buffer Node ou tout ce qui peut être passé au constructeur Buffer pour construire un tampon de.

Détails de la propriété

ack

Type de commentaires demandé (en cas de commande cloud-à-appareil)

ack: string

Valeur de propriété

string

contentEncoding

Encodage de contenu du corps du message. peut être « utf-8 », « utf-16 » ou « utf-32 ».

contentEncoding: undefined | "utf-8" | "utf-16" | "utf-32"

Valeur de propriété

undefined | "utf-8" | "utf-16" | "utf-32"

contentType

Propriété de type de contenu utilisée pour acheminer le corps du message. Doit être « application/json ».

contentType: undefined | "application/json"

Valeur de propriété

undefined | "application/json"

correlationId

Utilisé dans les réponses et commentaires des messages

correlationId: string

Valeur de propriété

string

data 

data: any

Valeur de propriété

any

expiryTimeUtc

Heure d’expiration en UTC interprétée par hub sur les messages C2D. Ignoré dans d’autres cas.

expiryTimeUtc: any

Valeur de propriété

any

interfaceId

Ce message est-il un message de sécurité

interfaceId: string

Valeur de propriété

string

lockToken

Utilisé pour abandonner, rejeter ou accepter le message

lockToken: string

Valeur de propriété

string

messageId

Utilisé pour mettre en corrélation la communication bidirectionnelle. Format : chaîne sensible à la casse (jusqu’à 128 caractères) de caractères alphanumériques ASCII 7 bits et symboles spéciaux suivants :
- : . + % _ # * ? ! ( ) , = @ ; $ '.

messageId: string

Valeur de propriété

string

properties

Carte contenant des clés de chaîne et des valeurs pour le stockage des propriétés de message personnalisées.

properties: Properties

Valeur de propriété

Properties

to

Destination du message.

to: string

Valeur de propriété

string

userId

Utilisé pour spécifier l’entité qui crée le message

userId: string

Valeur de propriété

string

Détails de la méthode

getBytes()

Obtient les données transmises au constructeur en tant que tampon

function getBytes(): Buffer

Retours

Buffer

getData()

Obtient le contenu (corps) du Message.

function getData(): BufferConvertible

Retours

BufferConvertible

Contenu du Message.

isBufferConvertible(any)

Retourne true si l’objet donné est de type BufferConvertible. Les objets de type BufferConvertible peuvent être passés dans le constructeur Message.

static function isBufferConvertible(obj: any): boolean

Paramètres

obj

any

instance d’objet à vérifier

Retours

boolean

True si l’objet est de type BufferConvertible

setAsSecurityMessage()

Définit ce message en tant que message de sécurité

function setAsSecurityMessage()