addresses supporting byte[] in direct methods and making TwinProperties able to be directly converted to json

iothub/device/src/DirectMethod/EdgeModuleDirectMethodRequest.cs

@@ -27,7 +27,7 @@ public EdgeModuleDirectMethodRequest(string methodName)
         /// </summary>
         /// <param name="methodName">The method name to invoke.</param>
         /// <param name="payload">The direct method payload that will be serialized using <see cref="DefaultPayloadConvention"/>.</param>
-        public EdgeModuleDirectMethodRequest(string methodName, object payload)
+        public EdgeModuleDirectMethodRequest(string methodName, byte[] payload)
         {
             MethodName = methodName;
             Payload = payload;
@@ -80,7 +80,7 @@ public EdgeModuleDirectMethodRequest(string methodName, object payload)
         /// The direct method payload.
         /// </summary>
         [JsonProperty("payload", NullValueHandling = NullValueHandling.Include)]
-        internal object Payload { get; }
+        internal byte[] Payload { get; }
 
         /// <summary>
         /// Method timeout, in seconds.
@@ -97,5 +97,83 @@ public EdgeModuleDirectMethodRequest(string methodName, object payload)
         internal int? ConnectionTimeoutInSeconds => ConnectionTimeout.HasValue && ConnectionTimeout > TimeSpan.Zero
             ? (int)ConnectionTimeout.Value.TotalSeconds
             : null;
+
+        /// <summary>
+        /// The direct method request payload, deserialized to the specified type.
+        /// </summary>
+        /// <remarks>
+        /// Use this method when the payload type is known and it can be deserialized using the configured
+        /// <see cref="PayloadConvention"/>. If it is not JSON or the type is not known, use <see cref="GetPayloadAsBytes"/>.
+        /// </remarks>
+        /// <typeparam name="T">The type to deserialize the direct method request payload to.</typeparam>
+        /// <param name="payload">When this method returns true, this contains the value of the direct method request payload.
+        /// When this method returns false, this contains the default value of the type <c>T</c> passed in.</param>
+        /// <returns><c>true</c> if the direct method request payload can be deserialized to type <c>T</c>; otherwise, <c>false</c>.</returns>
+        /// <example>
+        /// <code language="csharp">
+        /// await client.SetDirectMethodCallbackAsync((edgeModuleDirectMethodRequest) =>
+        /// {
+        ///     if (edgeModuleDirectMethodRequest.TryGetPayload(out MyCustomType customTypePayload))
+        ///     {
+        ///         // do work
+        ///         // ...
+        ///         
+        ///         // Acknowlege the direct method call with the status code 200.  
+        ///         return Task.FromResult(new DirectMethodResponse(200));
+        ///     }
+        ///     else
+        ///     {
+        ///         // Acknowlege the direct method call the status code 400.
+        ///         return Task.FromResult(new DirectMethodResponse(400));
+        ///     }
+        ///     
+        ///     
+        ///     // ...
+        /// },
+        /// cancellationToken);
+        /// </code>
+        /// </example>
+        public bool TryGetPayload<T>(out T payload)
+        {
+            payload = default;
+
+            try
+            {
+                payload = PayloadConvention.GetObject<T>(Payload);
+                return true;
+            }
+            catch (Exception ex) when (Logging.IsEnabled)
+            {
+                Logging.Error(this, $"Unable to convert payload to {typeof(T)} due to {ex}", nameof(TryGetPayload));
+            }
+
+            return false;
+        }
+
+        /// <summary>
+        /// Get the raw payload bytes.
+        /// </summary>
+        /// <remarks>
+        /// Use this method when the payload is not JSON or the type is not known or the type cannot be deserialized
+        /// using the configured <see cref="PayloadConvention"/>. Otherwise, use <see cref="TryGetPayload{T}(out T)"/>.
+        /// </remarks>
+        /// <returns>A copy of the raw payload as a byte array.</returns>
+        /// <example>
+        /// <code language="csharp">
+        /// await client.SetDirectMethodCallbackAsync((edgeModuleDirectMethodRequest) =>
+        /// {
+        ///     byte[] arr = edgeModuleDirectMethodRequest.GetPayloadAsBytes();
+        ///     // deserialize as needed and do work...
+        ///     
+        ///     // Acknowlege the direct method call with the status code 200. 
+        ///     return Task.FromResult(new DirectMethodResponse(200));
+        /// },
+        /// cancellationToken);
+        /// </code>
+        /// </example>
+        public byte[] GetPayloadAsBytes()
+        {
+            return Payload == null || Payload.Length == 0 ? null : (byte[])Payload.Clone();
+        }
     }
 }

iothub/device/src/Twin/TwinProperties.cs

@@ -1,6 +1,8 @@
 // Copyright (c) Microsoft. All rights reserved.
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
+using Newtonsoft.Json;
+
 namespace Microsoft.Azure.Devices.Client
 {
     /// <summary>
@@ -23,11 +25,23 @@ protected internal TwinProperties(DesiredProperties requestsFromService, Reporte
         /// <summary>
         /// The collection of desired property update requests received from service.
         /// </summary>
+        [JsonProperty("desiredProperties")]
         public DesiredProperties Desired { get; }
 
         /// <summary>
         /// The collection of twin properties reported by the client.
         /// </summary>
+        [JsonProperty("reportedProperties")]
         public ReportedProperties Reported { get; }
+
+        /// <summary>
+        /// Gets the Twin as a JSON string
+        /// </summary>
+        /// <param name="formatting">Optional. Formatting for the output JSON string.</param>
+        /// <returns>JSON string</returns>
+        public string ToJson(Formatting formatting = Formatting.None)
+        {
+            return JsonConvert.SerializeObject(this, formatting);
+        }
     }
 }