Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(adt): add link to samples #12533

Merged
merged 1 commit into from
Jun 5, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
242 changes: 208 additions & 34 deletions sdk/digitaltwins/Azure.DigitalTwins.Core/src/DigitalTwinsClient.cs

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ namespace Azure.DigitalTwins.Core.Models
/// <summary>
/// The additional information to be used when processing a telemetry request.
/// </summary>
/// <remarks>
/// For more samples, see <see href="https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/digitaltwins/Azure.DigitalTwins.Core/samples">our repo samples</see>.
/// </remarks>
public class TelemetryOptions
{
/// <summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,9 @@ public static class QueryChargeHelper
/// <param name="page">The page that contains the query-charge header.</param>
/// <param name="queryCharge">The query charge extracted from the header.</param>
/// <returns>True if the header contains a query-charge field, otherwise false.</returns>
/// <remarks>
/// For more samples, see <see href="https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/digitaltwins/Azure.DigitalTwins.Core/samples">our repo samples</see>.
/// </remarks>
/// <code snippet="Snippet:DigitalTwinsSampleQueryTwinsWithQueryCharge">
/// // This code snippet demonstrates how you could extract the query charges incurred when calling
/// // the query API. It iterates over the response pages first to access to the query-charge header,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ namespace Azure.DigitalTwins.Core.Serialization
/// <summary>
/// An optional, helper class for deserializing a digital twin.
/// </summary>
/// <remarks>
/// For more samples, see <see href="https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/digitaltwins/Azure.DigitalTwins.Core/samples">our repo samples</see>.
/// </remarks>
/// <example>
/// Here's an example of how to use the BasicDigitalTwin helper class to serialize and create a digital twin.
///
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ namespace Azure.DigitalTwins.Core.Serialization
/// Although relationships have a user-defined schema, these properties should exist on every instance. This is
/// useful to use as a base class to ensure your custom relationships have the necessary properties.
/// </summary>
/// <remarks>
/// For more samples, see <see href="https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/digitaltwins/Azure.DigitalTwins.Core/samples">our repo samples</see>.
/// </remarks>
public class BasicRelationship
{
/// <summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ namespace Azure.DigitalTwins.Core.Serialization
/// An optional, helper class for deserializing a digital twin.
/// The $metadata class on a <see cref="BasicDigitalTwin"/> and <see cref="ModelProperties"/>.
/// </summary>
/// <remarks>
/// For more samples, see <see href="https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/digitaltwins/Azure.DigitalTwins.Core/samples">our repo samples</see>.
/// </remarks>
public class DigitalTwinMetadata
{
/// <summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ namespace Azure.DigitalTwins.Core.Serialization
/// <summary>
/// Properties on a digital twin that adhere to a specific model.
/// </summary>
/// <remarks>
/// For more samples, see <see href="https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/digitaltwins/Azure.DigitalTwins.Core/samples">our repo samples</see>.
/// </remarks>
public class ModelProperties
{
/// <summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ namespace Azure.DigitalTwins.Core.Serialization
/// <summary>
/// A utility to create the application/json-patch+json operations payload required for update operations.
/// </summary>
/// <remarks>
/// For more samples, see <see href="https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/digitaltwins/Azure.DigitalTwins.Core/samples">our repo samples</see>.
/// </remarks>
/// <example>
/// <code snippet="Snippet:DigitalTwinsSampleUpdateComponent">
/// // Update Component1 by replacing the property ComponentProp1 value
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,12 @@ namespace Azure.DigitalTwins.Core.Serialization
/// The ModelProperties dictionary on <see cref="DigitalTwinMetadata"/>.
/// </summary>
/// <remarks>
/// <para>
/// A writable property is one that the service may request a change for from the device.
/// </para>
drwill-ms marked this conversation as resolved.
Show resolved Hide resolved
/// <para>
/// For more samples, see <see href="https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/digitaltwins/Azure.DigitalTwins.Core/samples">our repo samples</see>.
/// </para>
/// </remarks>
public class WritableProperty
{
Expand Down