Message class

  • 참조
패키지:
azure-iot-device

개체는 Message 디바이스와 IoT Hub 서비스 간의 원격 분석(디바이스-클라우드) 및 명령(클라우드-디바이스) 비동기 메시징에 사용됩니다. 전송에 구애받지 않으므로 AMQP, MQTT 및 HTTP에서 동일한 방식으로 작동합니다.

생성자

Message(BufferConvertible)

새 개체를 만듭니다.Message

속성

ack

요청된 피드백 유형(클라우드-디바이스 명령의 경우)
contentEncoding

메시지 본문의 콘텐츠 인코딩입니다. 는 'utf-8', 'utf-16' 또는 'utf-32'일 수 있습니다.
contentType

메시지 본문을 사용하여 라우팅하는 데 사용되는 콘텐츠 형식 속성입니다. 'application/json'이어야 합니다.
correlationId

메시지 응답 및 피드백에 사용됨
data
expiryTimeUtc

허브가 C2D 메시지에서 해석한 UTC의 만료 시간입니다. 다른 경우에는 무시됩니다.
interfaceId

이 메시지가 보안 메시지인가요?
lockToken

메시지를 중단, 거부 또는 수락하는 데 사용됨
messageId

양방향 통신의 상관 관계를 지정하는 데 사용됩니다. 형식: ASCII 7비트 영숫자 문자 및 다음 특수 기호의 대/소문자를 구분하는 문자열(최대 128자 길이)입니다.
- : . + % _ # * ? ! ( ) , = @ ; $ '.
properties

사용자 지정 메시지 속성을 저장하기 위한 문자열 키 및 값이 포함된 맵입니다.
to

메시지의 대상입니다.
userId

메시지를 만드는 엔터티를 지정하는 데 사용됩니다.

메서드

getBytes()

버퍼로 생성자에 전달된 데이터를 가져옵니다.
getData()

의 콘텐츠(본문)를 가져옵니다 Message.
isBufferConvertible(any)

지정된 개체가 BufferConvertible 형식이면 true를 반환합니다. BufferConvertible 형식의 개체를 메시지 생성자로 전달할 수 있습니다.
setAsSecurityMessage()

이 메시지를 보안 메시지로 설정

생성자 세부 정보

Message(BufferConvertible)

새 개체를 만듭니다.Message

new Message(data: BufferConvertible)

매개 변수

data
BufferConvertible

Node Buffer 개체 또는 버퍼 생성자에 전달하여 버퍼 를 생성할 수 있는 모든 항목입니다.

속성 세부 정보

ack

요청된 피드백 유형(클라우드-디바이스 명령의 경우)

ack: string

속성 값

string

contentEncoding

메시지 본문의 콘텐츠 인코딩입니다. 는 'utf-8', 'utf-16' 또는 'utf-32'일 수 있습니다.

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

속성 값

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

contentType

메시지 본문을 사용하여 라우팅하는 데 사용되는 콘텐츠 형식 속성입니다. 'application/json'이어야 합니다.

contentType: undefined | "application/json"

속성 값

undefined | "application/json"

correlationId

메시지 응답 및 피드백에 사용됨

correlationId: string

속성 값

string

data 

data: any

속성 값

any

expiryTimeUtc

허브가 C2D 메시지에서 해석한 UTC의 만료 시간입니다. 다른 경우에는 무시됩니다.

expiryTimeUtc: any

속성 값

any

interfaceId

이 메시지가 보안 메시지인가요?

interfaceId: string

속성 값

string

lockToken

메시지를 중단, 거부 또는 수락하는 데 사용됨

lockToken: string

속성 값

string

messageId

양방향 통신의 상관 관계를 지정하는 데 사용됩니다. 형식: ASCII 7비트 영숫자 문자 및 다음 특수 기호의 대/소문자를 구분하는 문자열(최대 128자 길이)입니다.
- : . + % _ # * ? ! ( ) , = @ ; $ '.

messageId: string

속성 값

string

properties

사용자 지정 메시지 속성을 저장하기 위한 문자열 키 및 값이 포함된 맵입니다.

properties: Properties

속성 값

Properties

to

메시지의 대상입니다.

to: string

속성 값

string

userId

메시지를 만드는 엔터티를 지정하는 데 사용됩니다.

userId: string

속성 값

string

메서드 세부 정보

getBytes()

버퍼로 생성자에 전달된 데이터를 가져옵니다.

function getBytes(): Buffer

반환

Buffer

getData()

의 콘텐츠(본문)를 가져옵니다 Message.

function getData(): BufferConvertible

반환

BufferConvertible

의 콘텐츠입니다 Message.

isBufferConvertible(any)

지정된 개체가 BufferConvertible 형식이면 true를 반환합니다. BufferConvertible 형식의 개체를 메시지 생성자로 전달할 수 있습니다.

static function isBufferConvertible(obj: any): boolean

매개 변수

obj

any

확인할 개체 인스턴스

반환

boolean

개체가 BufferConvertible 형식이면 True입니다.

setAsSecurityMessage()

이 메시지를 보안 메시지로 설정

function setAsSecurityMessage()