mcs/class/System/Documentation/en/System.Net/ICredentials.xml

   1 <Type Name="ICredentials" FullName="System.Net.ICredentials" FullNameSP="System_Net_ICredentials" Maintainer="ecma">
   2   <TypeSignature Language="ILASM" Value=".class interface public abstract ICredentials" />
   3   <TypeSignature Language="C#" Value="public interface ICredentials" />
   4   <MemberOfLibrary>Networking</MemberOfLibrary>
   5   <AssemblyInfo>
   6     <AssemblyName>System</AssemblyName>
   7     <AssemblyPublicKey>[00 00 00 00 00 00 00 00 04 00 00 00 00 00 00 00 ]</AssemblyPublicKey>
   8     <AssemblyVersion>1.0.x.x</AssemblyVersion>
   9     <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  10     <AssemblyVersion>2.0.0.0</AssemblyVersion>
  11   </AssemblyInfo>
  12   <Interfaces />
  13   <Docs>
  14     <summary>
  15       <para> Implemented by types that supply network credentials used to authenticate clients.</para>
  16     </summary>
  17     <remarks>
  18       <para>The <see cref="T:System.Net.ICredentials" /> interface defines the <see cref="M:System.Net.ICredentials.GetCredential(System.Uri,System.String)" /> method, which
  19    is used to supply network credentials for client authentication.</para>
  20     </remarks>
  21   </Docs>
  22   <Members>
  23     <Member MemberName="GetCredential">
  24       <MemberSignature Language="ILASM" Value=".method public hidebysig virtual abstract class System.Net.NetworkCredential GetCredential(class System.Uri uri, string authType)" />
  25       <MemberSignature Language="C#" Value="public System.Net.NetworkCredential GetCredential (Uri uri, string authType);" />
  26       <MemberType>Method</MemberType>
  27       <ReturnValue>
  28         <ReturnType>System.Net.NetworkCredential</ReturnType>
  29       </ReturnValue>
  30       <Parameters>
  31         <Parameter Name="uri" Type="System.Uri" />
  32         <Parameter Name="authType" Type="System.String" />
  33       </Parameters>
  34       <Docs>
  35         <param name="uri">A <see cref="T:System.Uri" /> representing the URI for which the client is providing authentication.</param>
  36         <param name="authType">A <see cref="T:System.String" /> containing the type of authentication. This value is required to be identical to the <see cref="P:System.Net.IAuthenticationModule.AuthenticationType" qualify="true" /> of the authentication module that uses the credential returned by this method. </param>
  37         <summary>
  38           <para>Returns a <see cref="T:System.Net.NetworkCredential" /> object that is associated with a Uniform Resource Identifier (URI) and authentication type.</para>
  39         </summary>
  40         <returns>
  41           <para>A <see cref="T:System.Net.NetworkCredential" /> associated with the specified URI and authentication
  42    type, or <see langword="null" /> if the credentials cannot be provided.</para>
  43         </returns>
  44         <remarks>
  45           <para>
  46             <block subset="none" type="behaviors">As described above.</block>
  47           </para>
  48           <para>
  49             <block subset="none" type="overrides">Implement this method to return
  50       credentials information appropriate for the specified authentication
  51       type.</block>
  52           </para>
  53           <para>
  54             <block subset="none" type="usage">This method returns an object suitable for passing to the <see cref="M:System.Net.IAuthenticationModule.Authenticate(System.String,System.Net.WebRequest,System.Net.ICredentials)" /> method
  55    of the authorization module registered for the specified authentication type.
  56    For additional information, see <see cref="M:System.Net.AuthenticationManager.Register(System.Net.IAuthenticationModule)" />.</block>
  57           </para>
  58         </remarks>
  59       </Docs>
  60       <Excluded>0</Excluded>
  61       <AssemblyInfo>
  62         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  63         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  64       </AssemblyInfo>
  65     </Member>
  66   </Members>
  67   <TypeExcluded>0</TypeExcluded>
  68 </Type>