Sdílet prostřednictvím

Message class

  • Reference
Balíček:
azure-iot-common

Objekt Message slouží k telemetrii (zařízení-cloud) a příkazům (cloud-zařízení) asynchronního zasílání zpráv mezi zařízením a službou IoT Hub. Je nezávislá na přenosu, což znamená, že funguje stejně přes AMQP, MQTT a HTTP.

Konstruktory

Message(BufferConvertible)

Vytvoří nový objekt Message.

Vlastnosti

ack

Typ požadované zpětné vazby (v případě příkazu cloud-to-device)
contentEncoding

Kódování obsahu textu zprávy může být utf-8, utf-16 nebo utf-32.
contentType

Vlastnost typu obsahu použitá pro trasy s textem zprávy. Měla by být application/json.
correlationId

Používá se v odpovědích zpráv a zpětné vazbě.
data
expiryTimeUtc

Doba vypršení platnosti ve standardu UTC interpretovaná centrem ve zprávách C2D Ignorováno v jiných případech.
interfaceId

Je tato zpráva zprávou zabezpečení.
lockToken

Slouží k opuštění, odmítnutí nebo přijetí zprávy.
messageId

Používá se ke korelaci obousměrné komunikace. Formát: Řetězec rozlišující malá a velká písmena (až 128 znaků dlouhý) 7bitové alfanumerické znaky ASCII a následující speciální symboly:
- : . + % _ # * ? ! ( ) , = @ ; $ '.
properties

Mapa obsahující řetězcové klíče a hodnoty pro ukládání vlastních vlastností zpráv
to

Cíl zprávy.
userId

Slouží k zadání entity, která vytváří zprávu.

Metody

getBytes()

Získá data předaná konstruktoru jako vyrovnávací paměti
getData()

Získá obsah (tělo) Message.
isBufferConvertible(any)

Vrátí hodnotu true, pokud daný objekt je typu BufferConvertible. Objekty typu BufferConvertible lze předat do konstruktoru Message.
setAsSecurityMessage()

Nastaví tuto zprávu jako zprávu zabezpečení.

Podrobnosti konstruktoru

Message(BufferConvertible)

Vytvoří nový objekt Message.

new Message(data: BufferConvertible)

Parametry

data
BufferConvertible

objekt vyrovnávací paměti uzlu objekt nebo cokoli, co lze předat konstruktoru vyrovnávací paměti pro vytvoření vyrovnávací paměti z.

Podrobnosti vlastnosti

ack

Typ požadované zpětné vazby (v případě příkazu cloud-to-device)

ack: string

Hodnota vlastnosti

string

contentEncoding

Kódování obsahu textu zprávy může být utf-8, utf-16 nebo utf-32.

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

Hodnota vlastnosti

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

contentType

Vlastnost typu obsahu použitá pro trasy s textem zprávy. Měla by být application/json.

contentType: undefined | "application/json"

Hodnota vlastnosti

undefined | "application/json"

correlationId

Používá se v odpovědích zpráv a zpětné vazbě.

correlationId: string

Hodnota vlastnosti

string

data 

data: any

Hodnota vlastnosti

any

expiryTimeUtc

Doba vypršení platnosti ve standardu UTC interpretovaná centrem ve zprávách C2D Ignorováno v jiných případech.

expiryTimeUtc: any

Hodnota vlastnosti

any

interfaceId

Je tato zpráva zprávou zabezpečení.

interfaceId: string

Hodnota vlastnosti

string

lockToken

Slouží k opuštění, odmítnutí nebo přijetí zprávy.

lockToken: string

Hodnota vlastnosti

string

messageId

Používá se ke korelaci obousměrné komunikace. Formát: Řetězec rozlišující malá a velká písmena (až 128 znaků dlouhý) 7bitové alfanumerické znaky ASCII a následující speciální symboly:
- : . + % _ # * ? ! ( ) , = @ ; $ '.

messageId: string

Hodnota vlastnosti

string

properties

Mapa obsahující řetězcové klíče a hodnoty pro ukládání vlastních vlastností zpráv

properties: Properties

Hodnota vlastnosti

Properties

to

Cíl zprávy.

to: string

Hodnota vlastnosti

string

userId

Slouží k zadání entity, která vytváří zprávu.

userId: string

Hodnota vlastnosti

string

Podrobnosti metody

getBytes()

Získá data předaná konstruktoru jako vyrovnávací paměti

function getBytes(): Buffer

Návraty

Buffer

getData()

Získá obsah (tělo) Message.

function getData(): BufferConvertible

Návraty

BufferConvertible

Obsah Message.

isBufferConvertible(any)

Vrátí hodnotu true, pokud daný objekt je typu BufferConvertible. Objekty typu BufferConvertible lze předat do konstruktoru Message.

static function isBufferConvertible(obj: any): boolean

Parametry

obj

any

instance objektu ke kontrole

Návraty

boolean

True, pokud je objekt typu BufferConvertible

setAsSecurityMessage()

Nastaví tuto zprávu jako zprávu zabezpečení.

function setAsSecurityMessage()