RefreshResponseInfo.xml

<Type Name="RefreshResponseInfo" FullName="System.ServiceModel.PeerResolvers.RefreshResponseInfo">
  <TypeSignature Language="C#" Value="public class RefreshResponseInfo" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit RefreshResponseInfo extends System.Object" />
  <TypeSignature Language="DocId" Value="T:System.ServiceModel.PeerResolvers.RefreshResponseInfo" />
  <TypeSignature Language="VB.NET" Value="Public Class RefreshResponseInfo" />
  <TypeSignature Language="F#" Value="type RefreshResponseInfo = class" />
  <TypeSignature Language="C++ CLI" Value="public ref class RefreshResponseInfo" />
  <AssemblyInfo>
    <AssemblyName>System.ServiceModel</AssemblyName>
    <AssemblyVersion>3.0.0.0</AssemblyVersion>
    <AssemblyVersion>4.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Attributes>
    <Attribute>
      <AttributeName Language="C#">[System.ServiceModel.MessageContract(IsWrapped=false)]</AttributeName>
      <AttributeName Language="F#">[&lt;System.ServiceModel.MessageContract(IsWrapped=false)&gt;]</AttributeName>
    </Attribute>
  </Attributes>
  <Docs>
    <summary>Contains response information returned as a result of a registration lookup table refresh operation on the peer resolver.</summary>
    <remarks>
      <format type="text/markdown"><![CDATA[  
  
## Remarks  
 When <xref:System.ServiceModel.PeerResolvers.CustomPeerResolverService.Refresh%28System.ServiceModel.PeerResolvers.RefreshInfo%29> or an implementation of  <xref:System.ServiceModel.PeerResolvers.CustomPeerResolverService.Refresh%28System.ServiceModel.PeerResolvers.RefreshInfo%29> is called, this object is returned to the client. It contains the refreshed registration entry with the new expiry timestamp, and is returned when a previous <xref:System.ServiceModel.PeerResolvers.RefreshInfo> instance is sent to the peer resolver as part of a request to update the expiry of a registration entry.  
  
 Instances of this class are primarily used to pass information from the resolver service to a network client of that service.  
  
 ]]></format>
    </remarks>
  </Docs>
  <Members>
    <MemberGroup MemberName=".ctor">
      <AssemblyInfo>
        <AssemblyName>System.ServiceModel</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Docs>
        <summary>Initializes a new instance of the <see cref="T:System.ServiceModel.PeerResolvers.RefreshResponseInfo" /> class.</summary>
      </Docs>
    </MemberGroup>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public RefreshResponseInfo ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberSignature Language="DocId" Value="M:System.ServiceModel.PeerResolvers.RefreshResponseInfo.#ctor" />
      <MemberSignature Language="VB.NET" Value="Public Sub New ()" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; RefreshResponseInfo();" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ServiceModel</AssemblyName>
        <AssemblyVersion>3.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters />
      <Docs>
        <summary>Initializes a new default instance of the <see cref="T:System.ServiceModel.PeerResolvers.RefreshResponseInfo" /> class.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public RefreshResponseInfo (TimeSpan registrationLifetime, System.ServiceModel.PeerResolvers.RefreshResult result);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype System.TimeSpan registrationLifetime, valuetype System.ServiceModel.PeerResolvers.RefreshResult result) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.ServiceModel.PeerResolvers.RefreshResponseInfo.#ctor(System.TimeSpan,System.ServiceModel.PeerResolvers.RefreshResult)" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (registrationLifetime As TimeSpan, result As RefreshResult)" />
      <MemberSignature Language="F#" Value="new System.ServiceModel.PeerResolvers.RefreshResponseInfo : TimeSpan * System.ServiceModel.PeerResolvers.RefreshResult -&gt; System.ServiceModel.PeerResolvers.RefreshResponseInfo" Usage="new System.ServiceModel.PeerResolvers.RefreshResponseInfo (registrationLifetime, result)" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; RefreshResponseInfo(TimeSpan registrationLifetime, System::ServiceModel::PeerResolvers::RefreshResult result);" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ServiceModel</AssemblyName>
        <AssemblyVersion>3.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="registrationLifetime" Type="System.TimeSpan" />
        <Parameter Name="result" Type="System.ServiceModel.PeerResolvers.RefreshResult" />
      </Parameters>
      <Docs>
        <param name="registrationLifetime">
          <see cref="T:System.TimeSpan" /> that specifies the new lifetime of the peer's registration.</param>
        <param name="result">
          <see cref="T:System.ServiceModel.PeerResolvers.RefreshResult" /> that specifies the result of the refresh.</param>
        <summary>Initializes a new instance of the <see cref="T:System.ServiceModel.PeerResolvers.RefreshResponseInfo" /> class with the provided registration lifetime and refresh results.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="HasBody">
      <MemberSignature Language="C#" Value="public bool HasBody ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool HasBody() cil managed" />
      <MemberSignature Language="DocId" Value="M:System.ServiceModel.PeerResolvers.RefreshResponseInfo.HasBody" />
      <MemberSignature Language="VB.NET" Value="Public Function HasBody () As Boolean" />
      <MemberSignature Language="F#" Value="member this.HasBody : unit -&gt; bool" Usage="refreshResponseInfo.HasBody " />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; bool HasBody();" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ServiceModel</AssemblyName>
        <AssemblyVersion>3.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Indicates whether the body of the message containing a serialized instance of this type is correctly formed.</summary>
        <returns>
          <see langword="true" /> if the refresh response information body is correctly-formed by the sender; false if it is not.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="RegistrationLifetime">
      <MemberSignature Language="C#" Value="public TimeSpan RegistrationLifetime { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan RegistrationLifetime" />
      <MemberSignature Language="DocId" Value="P:System.ServiceModel.PeerResolvers.RefreshResponseInfo.RegistrationLifetime" />
      <MemberSignature Language="VB.NET" Value="Public Property RegistrationLifetime As TimeSpan" />
      <MemberSignature Language="F#" Value="member this.RegistrationLifetime : TimeSpan with get, set" Usage="System.ServiceModel.PeerResolvers.RefreshResponseInfo.RegistrationLifetime" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property TimeSpan RegistrationLifetime { TimeSpan get(); void set(TimeSpan value); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ServiceModel</AssemblyName>
        <AssemblyVersion>3.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.TimeSpan</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets or sets amount of time before a registration expires and is removed by the resolver service.</summary>
        <value>
          <see cref="T:System.TimeSpan" /> that specifies the new amount of time before the registration entry expires and is removed by the resolver service.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Result">
      <MemberSignature Language="C#" Value="public System.ServiceModel.PeerResolvers.RefreshResult Result { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.ServiceModel.PeerResolvers.RefreshResult Result" />
      <MemberSignature Language="DocId" Value="P:System.ServiceModel.PeerResolvers.RefreshResponseInfo.Result" />
      <MemberSignature Language="VB.NET" Value="Public Property Result As RefreshResult" />
      <MemberSignature Language="F#" Value="member this.Result : System.ServiceModel.PeerResolvers.RefreshResult with get, set" Usage="System.ServiceModel.PeerResolvers.RefreshResponseInfo.Result" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property System::ServiceModel::PeerResolvers::RefreshResult Result { System::ServiceModel::PeerResolvers::RefreshResult get(); void set(System::ServiceModel::PeerResolvers::RefreshResult value); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ServiceModel</AssemblyName>
        <AssemblyVersion>3.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.ServiceModel.PeerResolvers.RefreshResult</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets or sets the result of a refresh operation.</summary>
        <value>
          <see cref="T:System.ServiceModel.PeerResolvers.RefreshResult" /> enumeration value that indicates the result of a refresh operation on the peer resolver.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>