Sdílet prostřednictvím

Message class

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

Objekt se Message používá pro telemetrii (zařízení-cloud) a příkazy (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ě jako AMQP, MQTT a HTTP.

Konstruktory

Message(BufferConvertible)

Vytvoří nový Message objekt.

Vlastnosti

ack

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

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

Vlastnost typu obsahu používaná ke směrování s textem zprávy. Mělo by to být application/json.
correlationId

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

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

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

Používá se 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í velká a malá písmena (až 128 znaků) se 7bitovými alfanumerickými znaky ASCII a následujícími speciálními symboly:
- : . + % _ # * ? ! ( ) , = @ ; $ '.
properties

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

Cíl zprávy.
userId

Slouží k určení entity vytvářející zprávu.

Metody

getBytes()

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

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

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

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

Podrobnosti konstruktoru

Message(BufferConvertible)

Vytvoří nový Message objekt.

new Message(data: BufferConvertible)

Parametry

data
BufferConvertible

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

Podrobnosti vlastnosti

ack

Typ požadované zpětné vazby (v případě příkazu typu cloud-zařízení)

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žívaná ke směrování s textem zprávy. Mělo by to být application/json.

contentType: undefined | "application/json"

Hodnota vlastnosti

undefined | "application/json"

correlationId

Používá se v odpovědích na zprávy 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. V jiných případech ignorováno.

expiryTimeUtc: any

Hodnota vlastnosti

any

interfaceId

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

interfaceId: string

Hodnota vlastnosti

string

lockToken

Používá se 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í velká a malá písmena (až 128 znaků) se 7bitovými alfanumerickými znaky ASCII a následujícími speciálními symboly:
- : . + % _ # * ? ! ( ) , = @ ; $ '.

messageId: string

Hodnota vlastnosti

string

properties

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

properties: Properties

Hodnota vlastnosti

Properties

to

Cíl zprávy.

to: string

Hodnota vlastnosti

string

userId

Slouží k určení entity vytvářející zprávu.

userId: string

Hodnota vlastnosti

string

Podrobnosti metody

getBytes()

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

function getBytes(): Buffer

Návraty

Buffer

getData()

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

function getData(): BufferConvertible

Návraty

BufferConvertible

Obsah souboru Message.

isBufferConvertible(any)

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

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()