xml/System.ClientModel/BinaryContent.xml

<Type Name="BinaryContent" FullName="System.ClientModel.BinaryContent">
  <TypeSignature Language="C#" Value="public abstract class BinaryContent : IDisposable" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit BinaryContent extends System.Object implements class System.IDisposable" />
  <TypeSignature Language="DocId" Value="T:System.ClientModel.BinaryContent" />
  <TypeSignature Language="VB.NET" Value="Public MustInherit Class BinaryContent&#xA;Implements IDisposable" />
  <TypeSignature Language="F#" Value="type BinaryContent = class&#xA;    interface IDisposable" />
  <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>
    <Interface>
      <InterfaceName>System.IDisposable</InterfaceName>
    </Interface>
  </Interfaces>
  <Docs>
    <summary>
            Represents binary content that can be sent to a cloud service as part of
            a <see cref="T:System.ClientModel.Primitives.PipelineRequest" />.
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="protected BinaryContent ();" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberSignature Language="DocId" Value="M:System.ClientModel.BinaryContent.#ctor" />
      <MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters />
      <Docs>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Create">
      <MemberSignature Language="C#" Value="public static System.ClientModel.BinaryContent Create (BinaryData value);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.ClientModel.BinaryContent Create(class System.BinaryData value) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.ClientModel.BinaryContent.Create(System.BinaryData)" />
      <MemberSignature Language="VB.NET" Value="Public Shared Function Create (value As BinaryData) As BinaryContent" />
      <MemberSignature Language="F#" Value="static member Create : BinaryData -&gt; System.ClientModel.BinaryContent" Usage="System.ClientModel.BinaryContent.Create value" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.ClientModel.BinaryContent</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="value" Type="System.BinaryData" />
      </Parameters>
      <Docs>
        <param name="value">The <see cref="T:System.BinaryData" /> containing the bytes
            this <see cref="T:System.ClientModel.BinaryContent" /> will hold.</param>
        <summary>
            Creates an instance of <see cref="T:System.ClientModel.BinaryContent" /> that contains the
            bytes held in the provided <see cref="T:System.BinaryData" /> instance.
            </summary>
        <returns>An an instance of <see cref="T:System.ClientModel.BinaryContent" /> that contains the
            bytes held in the provided <see cref="T:System.BinaryData" /> instance.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Create">
      <MemberSignature Language="C#" Value="public static System.ClientModel.BinaryContent Create (System.IO.Stream stream);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.ClientModel.BinaryContent Create(class System.IO.Stream stream) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.ClientModel.BinaryContent.Create(System.IO.Stream)" />
      <MemberSignature Language="VB.NET" Value="Public Shared Function Create (stream As Stream) As BinaryContent" />
      <MemberSignature Language="F#" Value="static member Create : System.IO.Stream -&gt; System.ClientModel.BinaryContent" Usage="System.ClientModel.BinaryContent.Create stream" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.ClientModel.BinaryContent</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="stream" Type="System.IO.Stream" />
      </Parameters>
      <Docs>
        <param name="stream">The <see cref="T:System.IO.Stream" /> containing the bytes
            this <see cref="T:System.ClientModel.BinaryContent" /> will hold.</param>
        <summary>
            Creates an instance of <see cref="T:System.ClientModel.BinaryContent" /> that contains the
            bytes held in the provided <see cref="T:System.IO.Stream" /> instance.
            </summary>
        <returns>An an instance of <see cref="T:System.ClientModel.BinaryContent" /> that contains the
            bytes held in the provided <see cref="T:System.IO.Stream" /> instance.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Create&lt;T&gt;">
      <MemberSignature Language="C#" Value="public static System.ClientModel.BinaryContent Create&lt;T&gt; (T model, System.ClientModel.Primitives.ModelReaderWriterOptions? options = default) where T : System.ClientModel.Primitives.IPersistableModel&lt;T&gt;;" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.ClientModel.BinaryContent Create&lt;(class System.ClientModel.Primitives.IPersistableModel`1&lt;!!T&gt;) T&gt;(!!T model, class System.ClientModel.Primitives.ModelReaderWriterOptions options) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.ClientModel.BinaryContent.Create``1(``0,System.ClientModel.Primitives.ModelReaderWriterOptions)" />
      <MemberSignature Language="VB.NET" Value="Public Shared Function Create(Of T As IPersistableModel(Of T)) (model As T, Optional options As ModelReaderWriterOptions = Nothing) As BinaryContent" />
      <MemberSignature Language="F#" Value="static member Create : 'T * System.ClientModel.Primitives.ModelReaderWriterOptions -&gt; System.ClientModel.BinaryContent (requires 'T :&gt; System.ClientModel.Primitives.IPersistableModel&lt;'T&gt;)" Usage="System.ClientModel.BinaryContent.Create (model, options)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.ClientModel.BinaryContent</ReturnType>
      </ReturnValue>
      <TypeParameters>
        <TypeParameter Name="T">
          <Constraints>
            <InterfaceName>System.ClientModel.Primitives.IPersistableModel&lt;T&gt;</InterfaceName>
          </Constraints>
        </TypeParameter>
      </TypeParameters>
      <Parameters>
        <Parameter Name="model" Type="T" />
        <Parameter Name="options" Type="System.ClientModel.Primitives.ModelReaderWriterOptions" />
      </Parameters>
      <Docs>
        <typeparam name="T">To be added.</typeparam>
        <param name="model">The <see cref="T:System.ClientModel.Primitives.IPersistableModel`1" /> to write.</param>
        <param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" />, if any,
            that indicates what format the <paramref name="model" /> will be written in.
            </param>
        <summary>
            Creates an instance of <see cref="T:System.ClientModel.BinaryContent" /> that contains the
            bytes resulting from writing the value of the provided
            <see cref="T:System.ClientModel.Primitives.IPersistableModel`1" />.
            </summary>
        <returns>An instance of <see cref="T:System.ClientModel.BinaryContent" /> that wraps a <see cref="T:System.ClientModel.Primitives.IPersistableModel`1" />.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Dispose">
      <MemberSignature Language="C#" Value="public abstract void Dispose ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Dispose() cil managed" />
      <MemberSignature Language="DocId" Value="M:System.ClientModel.BinaryContent.Dispose" />
      <MemberSignature Language="VB.NET" Value="Public MustOverride Sub Dispose ()" />
      <MemberSignature Language="F#" Value="abstract member Dispose : unit -&gt; unit" Usage="binaryContent.Dispose " />
      <MemberType>Method</MemberType>
      <Implements>
        <InterfaceMember>M:System.IDisposable.Dispose</InterfaceMember>
      </Implements>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="TryComputeLength">
      <MemberSignature Language="C#" Value="public abstract bool TryComputeLength (out long length);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool TryComputeLength([out] int64&amp; length) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.ClientModel.BinaryContent.TryComputeLength(System.Int64@)" />
      <MemberSignature Language="VB.NET" Value="Public MustOverride Function TryComputeLength (ByRef length As Long) As Boolean" />
      <MemberSignature Language="F#" Value="abstract member TryComputeLength : int64 -&gt; bool" Usage="binaryContent.TryComputeLength length" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="length" Type="System.Int64" RefType="out" />
      </Parameters>
      <Docs>
        <param name="length">The length of the underlying data.</param>
        <summary>
            Attempts to compute the length of the underlying body content, if available.
            </summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="WriteTo">
      <MemberSignature Language="C#" Value="public abstract void WriteTo (System.IO.Stream stream, System.Threading.CancellationToken cancellationToken = default);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void WriteTo(class System.IO.Stream stream, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.ClientModel.BinaryContent.WriteTo(System.IO.Stream,System.Threading.CancellationToken)" />
      <MemberSignature Language="VB.NET" Value="Public MustOverride Sub WriteTo (stream As Stream, Optional cancellationToken As CancellationToken = Nothing)" />
      <MemberSignature Language="F#" Value="abstract member WriteTo : System.IO.Stream * System.Threading.CancellationToken -&gt; unit" Usage="binaryContent.WriteTo (stream, cancellationToken)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="stream" Type="System.IO.Stream" />
        <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
      </Parameters>
      <Docs>
        <param name="stream">The stream to write the binary content to.</param>
        <param name="cancellationToken">To <see cref="T:System.Threading.CancellationToken" /> to
            use for the write operation.</param>
        <summary>
            Writes contents of this <see cref="T:System.ClientModel.BinaryContent" /> instance to the
            provided <see cref="T:System.IO.Stream" />.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="WriteToAsync">
      <MemberSignature Language="C#" Value="public abstract System.Threading.Tasks.Task WriteToAsync (System.IO.Stream stream, System.Threading.CancellationToken cancellationToken = default);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task WriteToAsync(class System.IO.Stream stream, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.ClientModel.BinaryContent.WriteToAsync(System.IO.Stream,System.Threading.CancellationToken)" />
      <MemberSignature Language="VB.NET" Value="Public MustOverride Function WriteToAsync (stream As Stream, Optional cancellationToken As CancellationToken = Nothing) As Task" />
      <MemberSignature Language="F#" Value="abstract member WriteToAsync : System.IO.Stream * System.Threading.CancellationToken -&gt; System.Threading.Tasks.Task" Usage="binaryContent.WriteToAsync (stream, cancellationToken)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Threading.Tasks.Task</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="stream" Type="System.IO.Stream" />
        <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
      </Parameters>
      <Docs>
        <param name="stream">The stream to write the binary content to.</param>
        <param name="cancellationToken">To <see cref="T:System.Threading.CancellationToken" /> to
            use for the write operation.</param>
        <summary>
            Writes contents of this <see cref="T:System.ClientModel.BinaryContent" /> instance to the
            provided <see cref="T:System.IO.Stream" />.
            </summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>