IImageStoreProgressHandler.xml

<Type Name="IImageStoreProgressHandler" FullName="System.Fabric.IImageStoreProgressHandler">
  <TypeSignature Language="C#" Value="public interface IImageStoreProgressHandler" />
  <TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract IImageStoreProgressHandler" />
  <TypeSignature Language="DocId" Value="T:System.Fabric.IImageStoreProgressHandler" />
  <TypeSignature Language="VB.NET" Value="Public Interface IImageStoreProgressHandler" />
  <TypeSignature Language="F#" Value="type IImageStoreProgressHandler = interface" />
  <AssemblyInfo>
    <AssemblyName>System.Fabric</AssemblyName>
    <AssemblyVersion>8.0.0.0</AssemblyVersion>
    <AssemblyVersion>9.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Interfaces />
  <Docs>
    <summary>
      <para>Defines the behavior that a progress handler must implement to process progress information from Image Store operations</para>
    </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName="GetUpdateInterval">
      <MemberSignature Language="C#" Value="public TimeSpan GetUpdateInterval ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance valuetype System.TimeSpan GetUpdateInterval() cil managed" />
      <MemberSignature Language="DocId" Value="M:System.Fabric.IImageStoreProgressHandler.GetUpdateInterval" />
      <MemberSignature Language="VB.NET" Value="Public Function GetUpdateInterval () As TimeSpan" />
      <MemberSignature Language="F#" Value="abstract member GetUpdateInterval : unit -&gt; TimeSpan" Usage="iImageStoreProgressHandler.GetUpdateInterval " />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Fabric</AssemblyName>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.TimeSpan</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>
          <para>Retrieves the interval at which progress information is published for some details that use polling (such as application package upload and download progress). Returning zero will use the system default of 2 seconds.</para>
        </summary>
        <returns>
          <para>The <see cref="T:System.TimeSpan" /> representing the progress update interval.</para>
        </returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="UpdateProgress">
      <MemberSignature Language="C#" Value="public void UpdateProgress (long completedItems, long totalItems, System.Fabric.ProgressUnitType itemType);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void UpdateProgress(int64 completedItems, int64 totalItems, valuetype System.Fabric.ProgressUnitType itemType) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.Fabric.IImageStoreProgressHandler.UpdateProgress(System.Int64,System.Int64,System.Fabric.ProgressUnitType)" />
      <MemberSignature Language="VB.NET" Value="Public Sub UpdateProgress (completedItems As Long, totalItems As Long, itemType As ProgressUnitType)" />
      <MemberSignature Language="F#" Value="abstract member UpdateProgress : int64 * int64 * System.Fabric.ProgressUnitType -&gt; unit" Usage="iImageStoreProgressHandler.UpdateProgress (completedItems, totalItems, itemType)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Fabric</AssemblyName>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="completedItems" Type="System.Int64" />
        <Parameter Name="totalItems" Type="System.Int64" />
        <Parameter Name="itemType" Type="System.Fabric.ProgressUnitType" />
      </Parameters>
      <Docs>
        <param name="completedItems">The number of completed work items.</param>
        <param name="totalItems">The total number of work items.</param>
        <param name="itemType">The unit of measurement for each work item.</param>
        <summary>
          <para>Reports the progress of the current operation</para>
        </summary>
        <remarks>The total number of items is not always guaranteed to be known at the beginning of the operation. In some cases, this value can increase if more work is discovered during processing.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>