-
Notifications
You must be signed in to change notification settings - Fork 493
/
PayloadConvention.cs
55 lines (51 loc) · 2.51 KB
/
PayloadConvention.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
// Copyright (c) Microsoft. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
namespace Microsoft.Azure.Devices.Client
{
/// <summary>
/// The payload convention class intended for serializing and deserializing JSON payloads.
/// </summary>
/// <remarks>
/// For binary payloads for operations that support them, the client app should instead use
/// <see cref="IncomingMessage.GetPayloadAsBytes"/> and <see cref="DirectMethodRequest.GetPayload"/>.
/// </remarks>
public abstract class PayloadConvention
{
/// <summary>
/// Used to specify what type of content will be in the payload.
/// </summary>
/// <remarks>
/// This can be free-form but should adhere to standard <see href="https://docs.w3cub.com/http/basics_of_http/mime_types.html">MIME types</see>,
/// for example: "application/json".
/// </remarks>
/// <value>A string representing the content type to use when sending a payload.</value>
public abstract string ContentType { get; }
/// <summary>
/// The encoding used for the payload.
/// </summary>
public abstract string ContentEncoding { get; }
/// <summary>
/// Returns the byte array for the convention-based serialized/encoded message.
/// </summary>
/// <remarks>
/// Used by the client to take an object provided by the user and serialize to bytes for transport for operations like telemetry,
/// direct method response, and reported properties.
/// </remarks>
/// <returns>The correctly encoded object for this convention.</returns>
public abstract byte[] GetObjectBytes(object objectToSendWithConvention);
/// <summary>
/// Returns the object as the specified type.
/// </summary>
/// <remarks>
/// Used by the client to deserialize the payload bytes from transport for operations like C2D messaging,
/// direct method requests, and twin properties.
/// <para>
/// Used by the client to parse the entire twin document over MQTT; required only for <see cref="DefaultPayloadConvention"/>.
/// </para>
/// </remarks>
/// <typeparam name="T">The type to convert to.</typeparam>
/// <param name="objectToConvert">The object to convert.</param>
/// <returns>The converted object.</returns>
public abstract T GetObject<T>(byte[] objectToConvert);
}
}