MessageSystemPropertyNames Class

  • Reference

Definition

Namespace:
Microsoft.Azure.Devices
Assembly:
Microsoft.Azure.Devices.dll
Package:
Microsoft.Azure.Devices v1.38.1

The names of the system properties in the Message class.

public static class MessageSystemPropertyNames
type MessageSystemPropertyNames = class
Public Class MessageSystemPropertyNames
Inheritance
Object
MessageSystemPropertyNames

Fields

Ack

A feedback message generator. This property is used in cloud-to-device messages to request IoT hub to generate feedback messages as a result of the consumption of the message by the device.
ConnectionAuthMethod

The connection authentication method value is ignored for cloud-to-device messages.
ConnectionDeviceGenerationId

The device generation Id of the target device of the cloud-to-device message. DeviceGenerationId is an IoT hub generated, case-sensitive string. This value is used to distinguish devices with the same device Id when they have been deleted and re-created.
ConnectionDeviceId

Specifies the device Id from which this message was sent, if there is one.
ContentEncoding

Used to specify the content encoding type of the message. Possible values are: utf-8, utf-16, utf-32.
ContentType

Used to specify the content type of the message. Possible values are: application/json, application/json-patch+json.
CorrelationId

A string property in a response message that typically contains the MessageId of the request, in request-reply patterns.
CreationTimeUtc

Custom date property set by the originator of the message.
DeliveryCount

The number of times a message can transition between the Enqueued and Invisible states. After the maximum number of transitions, the IoT hub sets the state of the message to dead-lettered. For more information, see https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messages-c2d#the-cloud-to-device-message-life-cycle
EnqueuedTime

Date and time when the message was received by the server in UTC.
ExpiryTimeUtc

Date and time of message expiration in UTC.
LockToken

Lock token of the received message. A unique identifier for a cloud-to-device message used to complete, reject or abandon the message. This value is provided to resolve race conditions when completing, rejecting, or abandoning messages.
MessageId

A user-settable identifier for the messages. If this value is not supplied by the user, the service client will set this to a new GUID only if you set SdkAssignsMessageId property in ServiceClientOptions.
MessageSchema

The message schema is set internally by IoTHub when it generates Twin Change notification message.
Operation

IoT hub operation
SequenceNumber

A number (unique per device-queue) assigned by IoT hub to each cloud-to-device message.
To

A destination specified in cloud-to-device messages.
UserId

An Id used to specify the origin of messages. When messages are generated by IoT hub, it is set to name of the IoT hub.

Applies to