Message.yml

### YamlMime:TSType
name: Message
uid: azure-iot-device.Message
package: azure-iot-device
summary: >-
  The <xref:azure-iot-common.Message> object is used for telemetry
  (device-to-cloud) and commands (cloud-to-device) asynchronous

  messaging between the device and the IoT Hub service. It is
  transport-agnostic, meaning it works the same way over AMQP, MQTT and HTTP.
fullName: Message
remarks: ''
isDeprecated: false
type: class
constructors:
  - name: Message(BufferConvertible)
    uid: azure-iot-device.Message.constructor
    package: azure-iot-device
    summary: Creates a new <xref:azure-iot-common.Message> object
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'new Message(data: BufferConvertible)'
      parameters:
        - id: data
          type: <xref uid="azure-iot-device.Message.BufferConvertible" />
          description: >-
            a Node
            [Buffer](https://nodejs.org/api/globals.html#globals_class_buffer)
                        object or anything that can be passed to the [Buffer](https://nodejs.org/api/globals.html#globals_class_buffer) constructor
                        to construct a [Buffer](https://nodejs.org/api/globals.html#globals_class_buffer) from.
properties:
  - name: ack
    uid: azure-iot-device.Message.ack
    package: azure-iot-device
    summary: Type of feedback requested (in case of cloud-to-device command)
    fullName: ack
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'ack: string'
      return:
        description: ''
        type: string
  - name: contentEncoding
    uid: azure-iot-device.Message.contentEncoding
    package: azure-iot-device
    summary: >-
      Content encoding of the message body. can be 'utf-8', 'utf-16' or
      'utf-32'.
    fullName: contentEncoding
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'contentEncoding: undefined | "utf-8" | "utf-16" | "utf-32"'
      return:
        description: ''
        type: undefined | "utf-8" | "utf-16" | "utf-32"
  - name: contentType
    uid: azure-iot-device.Message.contentType
    package: azure-iot-device
    summary: >-
      Content type property used to routes with the message body. Should be
      'application/json'.
    fullName: contentType
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'contentType: undefined | "application/json"'
      return:
        description: ''
        type: undefined | "application/json"
  - name: correlationId
    uid: azure-iot-device.Message.correlationId
    package: azure-iot-device
    summary: Used in message responses and feedback
    fullName: correlationId
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'correlationId: string'
      return:
        description: ''
        type: string
  - name: data
    uid: azure-iot-device.Message.data
    package: azure-iot-device
    summary: ''
    fullName: data
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'data: any'
      return:
        description: ''
        type: any
  - name: expiryTimeUtc
    uid: azure-iot-device.Message.expiryTimeUtc
    package: azure-iot-device
    summary: >-
      Expiry time in UTC interpreted by hub on C2D messages. Ignored in other
      cases.
    fullName: expiryTimeUtc
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'expiryTimeUtc: any'
      return:
        description: ''
        type: any
  - name: interfaceId
    uid: azure-iot-device.Message.interfaceId
    package: azure-iot-device
    summary: Is this message a security message
    fullName: interfaceId
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'interfaceId: string'
      return:
        description: ''
        type: string
  - name: lockToken
    uid: azure-iot-device.Message.lockToken
    package: azure-iot-device
    summary: Used to Abandon, Reject or Accept the message
    fullName: lockToken
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'lockToken: string'
      return:
        description: ''
        type: string
  - name: messageId
    uid: azure-iot-device.Message.messageId
    package: azure-iot-device
    summary: >-
      Used to correlate two-way communication. Format: A case-sensitive string
      (up to 128 char long) of ASCII 7-bit alphanumeric chars and the following
      special symbols: <br/>`- : . + % _ # * ? ! ( ) , = @ ; $ '`.
    fullName: messageId
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'messageId: string'
      return:
        description: ''
        type: string
  - name: properties
    uid: azure-iot-device.Message.properties
    package: azure-iot-device
    summary: >-
      A map containing string keys and values for storing custom message
      properties.
    fullName: properties
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'properties: Properties'
      return:
        description: ''
        type: Properties
  - name: to
    uid: azure-iot-device.Message.to
    package: azure-iot-device
    summary: Destination of the message.
    fullName: to
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'to: string'
      return:
        description: ''
        type: string
  - name: userId
    uid: azure-iot-device.Message.userId
    package: azure-iot-device
    summary: Used to specify the entity creating the message
    fullName: userId
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'userId: string'
      return:
        description: ''
        type: string
methods:
  - name: getBytes()
    uid: azure-iot-device.Message.getBytes
    package: azure-iot-device
    summary: >-
      Gets the data passed to the constructor as a
      [Buffer](https://nodejs.org/api/globals.html#globals_class_buffer)
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'function getBytes(): Buffer'
      return:
        description: ''
        type: Buffer
  - name: getData()
    uid: azure-iot-device.Message.getData
    package: azure-iot-device
    summary: Gets the content (body) of the <xref:azure-iot-common.Message>.
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'function getData(): BufferConvertible'
      return:
        description: The content of the <xref:azure-iot-common.Message>.
        type: <xref uid="azure-iot-device.Message.BufferConvertible" />
  - name: isBufferConvertible(any)
    uid: azure-iot-device.Message.isBufferConvertible
    package: azure-iot-device
    summary: >-
      Returns true if the given object is of type
      [BufferConvertible](xref:azure-iot-device.Message.BufferConvertible). 
      Objects of type
      [BufferConvertible](xref:azure-iot-device.Message.BufferConvertible) can
      be passed into the [Message](xref:azure-iot-device.Message) constructor.
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'static function isBufferConvertible(obj: any): boolean'
      parameters:
        - id: obj
          type: any
          description: object instance to check
      return:
        description: >-
          True if the object is of type
          [BufferConvertible](xref:azure-iot-device.Message.BufferConvertible)
        type: boolean
  - name: setAsSecurityMessage()
    uid: azure-iot-device.Message.setAsSecurityMessage
    package: azure-iot-device
    summary: Sets this message as a security message
    remarks: ''
    isDeprecated: false
    syntax:
      content: function setAsSecurityMessage()