DurableTaskClientExtensions.xml

<Type Name="DurableTaskClientExtensions" FullName="Microsoft.Azure.Functions.Worker.DurableTaskClientExtensions">
  <TypeSignature Language="C#" Value="public static class DurableTaskClientExtensions" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit DurableTaskClientExtensions extends System.Object" />
  <TypeSignature Language="DocId" Value="T:Microsoft.Azure.Functions.Worker.DurableTaskClientExtensions" />
  <TypeSignature Language="VB.NET" Value="Public Module DurableTaskClientExtensions" />
  <TypeSignature Language="F#" Value="type DurableTaskClientExtensions = class" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.Azure.Functions.Worker.Extensions.DurableTask</AssemblyName>
    <AssemblyVersion>1.0.0.0</AssemblyVersion>
    <AssemblyVersion>1.0.2.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
            Extensions for <see cref="T:Microsoft.DurableTask.Client.DurableTaskClient" /></summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName="CreateCheckStatusResponse">
      <MemberSignature Language="C#" Value="public static Microsoft.Azure.Functions.Worker.Http.HttpResponseData CreateCheckStatusResponse (this Microsoft.DurableTask.Client.DurableTaskClient client, Microsoft.Azure.Functions.Worker.Http.HttpRequestData request, string instanceId, System.Threading.CancellationToken cancellation = default);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Azure.Functions.Worker.Http.HttpResponseData CreateCheckStatusResponse(class Microsoft.DurableTask.Client.DurableTaskClient client, class Microsoft.Azure.Functions.Worker.Http.HttpRequestData request, string instanceId, valuetype System.Threading.CancellationToken cancellation) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Functions.Worker.DurableTaskClientExtensions.CreateCheckStatusResponse(Microsoft.DurableTask.Client.DurableTaskClient,Microsoft.Azure.Functions.Worker.Http.HttpRequestData,System.String,System.Threading.CancellationToken)" />
      <MemberSignature Language="VB.NET" Value="&lt;Extension()&gt;&#xA;Public Function CreateCheckStatusResponse (client As DurableTaskClient, request As HttpRequestData, instanceId As String, Optional cancellation As CancellationToken = Nothing) As HttpResponseData" />
      <MemberSignature Language="F#" Value="static member CreateCheckStatusResponse : Microsoft.DurableTask.Client.DurableTaskClient * Microsoft.Azure.Functions.Worker.Http.HttpRequestData * string * System.Threading.CancellationToken -&gt; Microsoft.Azure.Functions.Worker.Http.HttpResponseData" Usage="Microsoft.Azure.Functions.Worker.DurableTaskClientExtensions.CreateCheckStatusResponse (client, request, instanceId, cancellation)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Functions.Worker.Extensions.DurableTask</AssemblyName>
        <AssemblyVersion>1.0.2.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Microsoft.Azure.Functions.Worker.Http.HttpResponseData</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="client" Type="Microsoft.DurableTask.Client.DurableTaskClient" RefType="this" />
        <Parameter Name="request" Type="Microsoft.Azure.Functions.Worker.Http.HttpRequestData" />
        <Parameter Name="instanceId" Type="System.String" />
        <Parameter Name="cancellation" Type="System.Threading.CancellationToken" />
      </Parameters>
      <Docs>
        <param name="client">The <see cref="T:Microsoft.DurableTask.Client.DurableTaskClient" />.</param>
        <param name="request">The HTTP request that this response is for.</param>
        <param name="instanceId">The ID of the orchestration instance to check.</param>
        <param name="cancellation">The cancellation token.</param>
        <summary>
            Creates an HTTP response that is useful for checking the status of the specified instance.
            </summary>
        <returns>An HTTP 202 response with a Location header and a payload containing instance control URLs.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="CreateCheckStatusResponse">
      <MemberSignature Language="C#" Value="public static Microsoft.Azure.Functions.Worker.Http.HttpResponseData CreateCheckStatusResponse (this Microsoft.DurableTask.Client.DurableTaskClient client, Microsoft.Azure.Functions.Worker.Http.HttpRequestData request, string instanceId, System.Net.HttpStatusCode statusCode, System.Threading.CancellationToken cancellation = default);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Azure.Functions.Worker.Http.HttpResponseData CreateCheckStatusResponse(class Microsoft.DurableTask.Client.DurableTaskClient client, class Microsoft.Azure.Functions.Worker.Http.HttpRequestData request, string instanceId, valuetype System.Net.HttpStatusCode statusCode, valuetype System.Threading.CancellationToken cancellation) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Functions.Worker.DurableTaskClientExtensions.CreateCheckStatusResponse(Microsoft.DurableTask.Client.DurableTaskClient,Microsoft.Azure.Functions.Worker.Http.HttpRequestData,System.String,System.Net.HttpStatusCode,System.Threading.CancellationToken)" />
      <MemberSignature Language="VB.NET" Value="&lt;Extension()&gt;&#xA;Public Function CreateCheckStatusResponse (client As DurableTaskClient, request As HttpRequestData, instanceId As String, statusCode As HttpStatusCode, Optional cancellation As CancellationToken = Nothing) As HttpResponseData" />
      <MemberSignature Language="F#" Value="static member CreateCheckStatusResponse : Microsoft.DurableTask.Client.DurableTaskClient * Microsoft.Azure.Functions.Worker.Http.HttpRequestData * string * System.Net.HttpStatusCode * System.Threading.CancellationToken -&gt; Microsoft.Azure.Functions.Worker.Http.HttpResponseData" Usage="Microsoft.Azure.Functions.Worker.DurableTaskClientExtensions.CreateCheckStatusResponse (client, request, instanceId, statusCode, cancellation)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Functions.Worker.Extensions.DurableTask</AssemblyName>
        <AssemblyVersion>1.0.2.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Microsoft.Azure.Functions.Worker.Http.HttpResponseData</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="client" Type="Microsoft.DurableTask.Client.DurableTaskClient" RefType="this" />
        <Parameter Name="request" Type="Microsoft.Azure.Functions.Worker.Http.HttpRequestData" />
        <Parameter Name="instanceId" Type="System.String" />
        <Parameter Name="statusCode" Type="System.Net.HttpStatusCode" />
        <Parameter Name="cancellation" Type="System.Threading.CancellationToken" />
      </Parameters>
      <Docs>
        <param name="client">The <see cref="T:Microsoft.DurableTask.Client.DurableTaskClient" />.</param>
        <param name="request">The HTTP request that this response is for.</param>
        <param name="instanceId">The ID of the orchestration instance to check.</param>
        <param name="statusCode">The status code.</param>
        <param name="cancellation">The cancellation token.</param>
        <summary>
            Creates an HTTP response that is useful for checking the status of the specified instance.
            </summary>
        <returns>An HTTP response with a Location header and a payload containing instance control URLs.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>