Skip to content

Commit

Permalink
Add comment explaining twin patch over edge isn't applied immediately (
Browse files Browse the repository at this point in the history
  • Loading branch information
abhipsaMisra authored May 10, 2023
1 parent 1027b82 commit cb63fb3
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions iothub/device/src/IotHubBaseClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -447,7 +447,14 @@ public async Task<TwinProperties> GetTwinPropertiesAsync(CancellationToken cance
/// Push reported property changes up to the service.
/// </summary>
/// <remarks>
/// <para>
/// The client instance must be already open.
/// </para>
/// <para>
/// For clients communicating with IoT hub via IoT Edge, since the patch isn't applied immediately an updated version number is not returned.
/// You can call <see cref="GetTwinPropertiesAsync(CancellationToken)"/> and verify <see cref="PropertyCollection.Version"/>
/// from <see cref="TwinProperties.Reported"/> to check if your patch is successfully applied.
/// </para>
/// </remarks>
/// <param name="reportedProperties">Reported properties to push</param>
/// <param name="cancellationToken">A cancellation token to cancel the operation.</param>
Expand Down

0 comments on commit cb63fb3

Please sign in to comment.