Delen via

Message class

  • Referentie
Pakket:
azure-iot-device

Het Message object wordt gebruikt voor telemetrie (apparaat-naar-cloud) en opdrachten (cloud-naar-apparaat) asynchrone berichten tussen het apparaat en de IoT Hub-service. Het is transportagnostisch, wat betekent dat het op dezelfde manier werkt via AMQP, MQTT en HTTP.

Constructors

Message(BufferConvertible)

Hiermee maakt u een nieuw Message object

Eigenschappen

ack

Type feedback dat is aangevraagd (in het geval van een cloud-naar-apparaat-opdracht)
contentEncoding

Inhoudscodering van de berichttekst. kan 'utf-8', 'utf-16' of 'utf-32' zijn.
contentType

De eigenschap Inhoudstype die wordt gebruikt voor routes met de hoofdtekst van het bericht. Moet 'application/json' zijn.
correlationId

Gebruikt in berichtreacties en feedback
data
expiryTimeUtc

Verlooptijd in UTC geïnterpreteerd door hub in C2D-berichten. Genegeerd in andere gevallen.
interfaceId

Is dit bericht een beveiligingsbericht?
lockToken

Wordt gebruikt om het bericht af te wijzen, te weigeren of te accepteren
messageId

Wordt gebruikt om tweerichtingscommunicatie te correleren. Indeling: Een hoofdlettergevoelige tekenreeks (maximaal 128 tekens lang) met ASCII 7-bits alfanumerieke tekens en de volgende speciale symbolen:
- : . + % _ # * ? ! ( ) , = @ ; $ '.
properties

Een kaart met tekenreekssleutels en -waarden voor het opslaan van aangepaste berichteigenschappen.
to

Bestemming van het bericht.
userId

Wordt gebruikt om de entiteit op te geven die het bericht maakt

Methoden

getBytes()

Hiermee haalt u de gegevens op die als buffer worden doorgegeven aan de constructor
getData()

Hiermee haalt u de inhoud (hoofdtekst) van de Messageop.
isBufferConvertible(any)

Retourneert true als het opgegeven object van het type BufferConvertible is. Objecten van het type BufferConvertible kunnen worden doorgegeven aan de berichtconstructor .
setAsSecurityMessage()

Dit bericht instellen als een beveiligingsbericht

Constructordetails

Message(BufferConvertible)

Hiermee maakt u een nieuw Message object

new Message(data: BufferConvertible)

Parameters

data
BufferConvertible

een knooppuntbufferobject of iets dat kan worden doorgegeven aan de bufferconstructor om een buffer te maken.

Eigenschapdetails

ack

Type feedback dat is aangevraagd (in het geval van een cloud-naar-apparaat-opdracht)

ack: string

Waarde van eigenschap

string

contentEncoding

Inhoudscodering van de berichttekst. kan 'utf-8', 'utf-16' of 'utf-32' zijn.

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

Waarde van eigenschap

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

contentType

De eigenschap Inhoudstype die wordt gebruikt voor routes met de hoofdtekst van het bericht. Moet 'application/json' zijn.

contentType: undefined | "application/json"

Waarde van eigenschap

undefined | "application/json"

correlationId

Gebruikt in berichtreacties en feedback

correlationId: string

Waarde van eigenschap

string

data 

data: any

Waarde van eigenschap

any

expiryTimeUtc

Verlooptijd in UTC geïnterpreteerd door hub in C2D-berichten. Genegeerd in andere gevallen.

expiryTimeUtc: any

Waarde van eigenschap

any

interfaceId

Is dit bericht een beveiligingsbericht?

interfaceId: string

Waarde van eigenschap

string

lockToken

Wordt gebruikt om het bericht af te wijzen, te weigeren of te accepteren

lockToken: string

Waarde van eigenschap

string

messageId

Wordt gebruikt om tweerichtingscommunicatie te correleren. Indeling: Een hoofdlettergevoelige tekenreeks (maximaal 128 tekens lang) met ASCII 7-bits alfanumerieke tekens en de volgende speciale symbolen:
- : . + % _ # * ? ! ( ) , = @ ; $ '.

messageId: string

Waarde van eigenschap

string

properties

Een kaart met tekenreekssleutels en -waarden voor het opslaan van aangepaste berichteigenschappen.

properties: Properties

Waarde van eigenschap

Properties

to

Bestemming van het bericht.

to: string

Waarde van eigenschap

string

userId

Wordt gebruikt om de entiteit op te geven die het bericht maakt

userId: string

Waarde van eigenschap

string

Methodedetails

getBytes()

Hiermee haalt u de gegevens op die als buffer worden doorgegeven aan de constructor

function getBytes(): Buffer

Retouren

Buffer

getData()

Hiermee haalt u de inhoud (hoofdtekst) van de Messageop.

function getData(): BufferConvertible

Retouren

BufferConvertible

De inhoud van de Message.

isBufferConvertible(any)

Retourneert true als het opgegeven object van het type BufferConvertible is. Objecten van het type BufferConvertible kunnen worden doorgegeven aan de berichtconstructor .

static function isBufferConvertible(obj: any): boolean

Parameters

obj

any

objectexemplaar dat moet worden gecontroleerd

Retouren

boolean

True als het object van het type BufferConvertible is

setAsSecurityMessage()

Dit bericht instellen als een beveiligingsbericht

function setAsSecurityMessage()