xml/System.ClientModel/ClientResult.xml

<Type Name="ClientResult" FullName="System.ClientModel.ClientResult">
  <TypeSignature Language="C#" Value="public class ClientResult" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ClientResult extends System.Object" />
  <TypeSignature Language="DocId" Value="T:System.ClientModel.ClientResult" />
  <TypeSignature Language="VB.NET" Value="Public Class ClientResult" />
  <TypeSignature Language="F#" Value="type ClientResult = class" />
  <AssemblyInfo>
    <AssemblyName>System.ClientModel</AssemblyName>
    <AssemblyVersion>1.1.0.0</AssemblyVersion>
    <AssemblyVersion>1.2.0.0</AssemblyVersion>
    <AssemblyVersion>1.2.1.0</AssemblyVersion>
    <AssemblyVersion>1.3.0.0</AssemblyVersion>
    <AssemblyVersion>1.4.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
            Represents the result of a cloud service operation.
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="protected ClientResult (System.ClientModel.Primitives.PipelineResponse response);" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(class System.ClientModel.Primitives.PipelineResponse response) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.ClientModel.ClientResult.#ctor(System.ClientModel.Primitives.PipelineResponse)" />
      <MemberSignature Language="VB.NET" Value="Protected Sub New (response As PipelineResponse)" />
      <MemberSignature Language="F#" Value="new System.ClientModel.ClientResult : System.ClientModel.Primitives.PipelineResponse -&gt; System.ClientModel.ClientResult" Usage="new System.ClientModel.ClientResult response" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="response" Type="System.ClientModel.Primitives.PipelineResponse" />
      </Parameters>
      <Docs>
        <param name="response">The <see cref="T:System.ClientModel.Primitives.PipelineResponse" /> received
            from the service.</param>
        <summary>
            Creates a new instance of <see cref="T:System.ClientModel.ClientResult" /> from a service
            response.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="FromOptionalValue&lt;T&gt;">
      <MemberSignature Language="C#" Value="public static System.ClientModel.ClientResult&lt;T?&gt; FromOptionalValue&lt;T&gt; (T? value, System.ClientModel.Primitives.PipelineResponse response);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.ClientModel.ClientResult`1&lt;!!T&gt; FromOptionalValue&lt;T&gt;(!!T value, class System.ClientModel.Primitives.PipelineResponse response) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.ClientModel.ClientResult.FromOptionalValue``1(``0,System.ClientModel.Primitives.PipelineResponse)" />
      <MemberSignature Language="VB.NET" Value="Public Shared Function FromOptionalValue(Of T) (value As T, response As PipelineResponse) As ClientResult(Of T)" />
      <MemberSignature Language="F#" Value="static member FromOptionalValue : 'T * System.ClientModel.Primitives.PipelineResponse -&gt; System.ClientModel.ClientResult&lt;'T&gt;" Usage="System.ClientModel.ClientResult.FromOptionalValue (value, response)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.ClientModel.ClientResult&lt;T&gt;</ReturnType>
      </ReturnValue>
      <TypeParameters>
        <TypeParameter Name="T" />
      </TypeParameters>
      <Parameters>
        <Parameter Name="value" Type="T" />
        <Parameter Name="response" Type="System.ClientModel.Primitives.PipelineResponse" />
      </Parameters>
      <Docs>
        <typeparam name="T">The type of the value.</typeparam>
        <param name="value">The strongly-typed representation of the service
            response payload value.</param>
        <param name="response">The response received from the service.</param>
        <summary>
            Creates a new instance of <see cref="T:System.ClientModel.ClientResult`1" /> that holds the
            provided model value, if any, and the <see cref="T:System.ClientModel.Primitives.PipelineResponse" />
            received from the service. This method is used to create a return value
            for a service method representing a service operation that may or may not
            contain a payload. Callers of the client's service method must check
            whether <see cref="P:System.ClientModel.ClientResult`1.Value" /> is null to determine whether
            the service provided a value in its response. Nullable annotations
            indicate to the end-user the need to check whether
            <see cref="P:System.ClientModel.ClientResult`1.Value" /> is null.
            </summary>
        <returns>A new instance of <see cref="T:System.ClientModel.ClientResult`1" /> holding the
            provided <paramref name="value" /> and <paramref name="response" />.
            </returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="FromResponse">
      <MemberSignature Language="C#" Value="public static System.ClientModel.ClientResult FromResponse (System.ClientModel.Primitives.PipelineResponse response);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.ClientModel.ClientResult FromResponse(class System.ClientModel.Primitives.PipelineResponse response) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.ClientModel.ClientResult.FromResponse(System.ClientModel.Primitives.PipelineResponse)" />
      <MemberSignature Language="VB.NET" Value="Public Shared Function FromResponse (response As PipelineResponse) As ClientResult" />
      <MemberSignature Language="F#" Value="static member FromResponse : System.ClientModel.Primitives.PipelineResponse -&gt; System.ClientModel.ClientResult" Usage="System.ClientModel.ClientResult.FromResponse response" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.ClientModel.ClientResult</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="response" Type="System.ClientModel.Primitives.PipelineResponse" />
      </Parameters>
      <Docs>
        <param name="response">The response received from the service.</param>
        <summary>
            Creates a new instance of <see cref="T:System.ClientModel.ClientResult" /> that holds the
            <see cref="T:System.ClientModel.Primitives.PipelineResponse" /> received from the service.
            </summary>
        <returns>A new instance of <see cref="T:System.ClientModel.ClientResult`1" /> holding the
            provided <paramref name="response" />.
            </returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="FromValue&lt;T&gt;">
      <MemberSignature Language="C#" Value="public static System.ClientModel.ClientResult&lt;T&gt; FromValue&lt;T&gt; (T value, System.ClientModel.Primitives.PipelineResponse response);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.ClientModel.ClientResult`1&lt;!!T&gt; FromValue&lt;T&gt;(!!T value, class System.ClientModel.Primitives.PipelineResponse response) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.ClientModel.ClientResult.FromValue``1(``0,System.ClientModel.Primitives.PipelineResponse)" />
      <MemberSignature Language="VB.NET" Value="Public Shared Function FromValue(Of T) (value As T, response As PipelineResponse) As ClientResult(Of T)" />
      <MemberSignature Language="F#" Value="static member FromValue : 'T * System.ClientModel.Primitives.PipelineResponse -&gt; System.ClientModel.ClientResult&lt;'T&gt;" Usage="System.ClientModel.ClientResult.FromValue (value, response)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.ClientModel.ClientResult&lt;T&gt;</ReturnType>
      </ReturnValue>
      <TypeParameters>
        <TypeParameter Name="T" />
      </TypeParameters>
      <Parameters>
        <Parameter Name="value" Type="T" />
        <Parameter Name="response" Type="System.ClientModel.Primitives.PipelineResponse" />
      </Parameters>
      <Docs>
        <typeparam name="T">The type of the value.</typeparam>
        <param name="value">The strongly-typed representation of the service
            response payload value.</param>
        <param name="response">The response received from the service.</param>
        <summary>
            Creates a new instance of <see cref="T:System.ClientModel.ClientResult`1" /> that holds the
            provided model value and <see cref="T:System.ClientModel.Primitives.PipelineResponse" /> received from
            the service.
            </summary>
        <returns>A new instance of <see cref="T:System.ClientModel.ClientResult`1" /> holding the
            provided <paramref name="value" /> and <paramref name="response" />.
            </returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="GetRawResponse">
      <MemberSignature Language="C#" Value="public System.ClientModel.Primitives.PipelineResponse GetRawResponse ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.ClientModel.Primitives.PipelineResponse GetRawResponse() cil managed" />
      <MemberSignature Language="DocId" Value="M:System.ClientModel.ClientResult.GetRawResponse" />
      <MemberSignature Language="VB.NET" Value="Public Function GetRawResponse () As PipelineResponse" />
      <MemberSignature Language="F#" Value="member this.GetRawResponse : unit -&gt; System.ClientModel.Primitives.PipelineResponse" Usage="clientResult.GetRawResponse " />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.ClientModel.Primitives.PipelineResponse</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>
            Gets the <see cref="T:System.ClientModel.Primitives.PipelineResponse" /> received from the service.
            </summary>
        <returns>The <see cref="T:System.ClientModel.Primitives.PipelineResponse" /> received from the service.
            </returns>
        <remarks>To be added.</remarks>
        <exception cref="T:System.InvalidOperationException">No
            <see cref="T:System.ClientModel.Primitives.PipelineResponse" /> value is currently available for this
            <see cref="T:System.ClientModel.ClientResult" /> instance.  This can happen when the instance
            is a collection type like <see cref="T:System.ClientModel.AsyncCollectionResult`1" />
            that has not yet been enumerated.</exception>
      </Docs>
    </Member>
  </Members>
</Type>