mcs/class/System.Web.Services/Documentation/en/System.Web.Services.Discovery/DiscoveryDocumentReference.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <Type Name="DiscoveryDocumentReference" FullName="System.Web.Services.Discovery.DiscoveryDocumentReference">
   3   <TypeSignature Language="C#" Value="public sealed class DiscoveryDocumentReference : System.Web.Services.Discovery.DiscoveryReference" Maintainer="auto" />
   4   <AssemblyInfo>
   5     <AssemblyName>System.Web.Services</AssemblyName>
   6     <AssemblyPublicKey>
   7     </AssemblyPublicKey>
   8     <AssemblyVersion>1.0.5000.0</AssemblyVersion>
   9     <AssemblyVersion>2.0.0.0</AssemblyVersion>
  10   </AssemblyInfo>
  11   <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the &lt;link location="node:gtk-sharp/programming/threads"&gt;Gtk# Thread Programming&lt;/link&gt; for details.</ThreadSafetyStatement>
  12   <Base>
  13     <BaseTypeName>System.Web.Services.Discovery.DiscoveryReference</BaseTypeName>
  14   </Base>
  15   <Interfaces />
  16   <Attributes>
  17     <Attribute>
  18       <AttributeName>System.Xml.Serialization.XmlRoot("discoveryRef", Namespace="http://schemas.xmlsoap.org/disco/", IsNullable=true)</AttributeName>
  19     </Attribute>
  20   </Attributes>
  21   <Docs>
  22     <remarks>
  23       <attribution license="cc4" from="Microsoft" modified="false" />
  24       <para>XML Web services discovery involves discovering the available XML Web services given an URL. The URL typically points to a discovery document, which usually has a.disco file name extension. The discovery document contains references to information about the existence of XML Web services, such as Service Descriptions, XML Schema Definition language (XSD) schemas, or other discovery documents. This class represents a reference to a discovery document.</para>
  25     </remarks>
  26     <summary>
  27       <attribution license="cc4" from="Microsoft" modified="false" />
  28       <para>Represents a reference to a discovery document. This class cannot be inherited.</para>
  29     </summary>
  30   </Docs>
  31   <Members>
  32     <Member MemberName=".ctor">
  33       <MemberSignature Language="C#" Value="public DiscoveryDocumentReference ();" />
  34       <MemberType>Constructor</MemberType>
  35       <ReturnValue />
  36       <Parameters />
  37       <Docs>
  38         <remarks>To be added</remarks>
  39         <summary>
  40           <attribution license="cc4" from="Microsoft" modified="false" />
  41           <para>Initializes a new instance of the <see cref="T:System.Web.Services.Discovery.DiscoveryDocumentReference" /> class.</para>
  42         </summary>
  43       </Docs>
  44       <AssemblyInfo>
  45         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  46         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  47       </AssemblyInfo>
  48     </Member>
  49     <Member MemberName=".ctor">
  50       <MemberSignature Language="C#" Value="public DiscoveryDocumentReference (string href);" />
  51       <MemberType>Constructor</MemberType>
  52       <ReturnValue />
  53       <Parameters>
  54         <Parameter Name="href" Type="System.String" />
  55       </Parameters>
  56       <Docs>
  57         <remarks>To be added</remarks>
  58         <summary>
  59           <attribution license="cc4" from="Microsoft" modified="false" />
  60           <para>Initializes a new instance of the <see cref="T:System.Web.Services.Discovery.DiscoveryDocumentReference" /> class, setting the <see cref="P:System.Web.Services.Discovery.DiscoveryDocumentReference.Ref" /> property to the value of <paramref name="href" />.</para>
  61         </summary>
  62         <param name="href">
  63           <attribution license="cc4" from="Microsoft" modified="false" />Reference to a discovery document. The <see cref="P:System.Web.Services.Discovery.DiscoveryDocumentReference.Ref" /> property is set to the value of <paramref name="href" />. </param>
  64       </Docs>
  65       <AssemblyInfo>
  66         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  67         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  68       </AssemblyInfo>
  69     </Member>
  70     <Member MemberName="DefaultFilename">
  71       <MemberSignature Language="C#" Value="public override string DefaultFilename { get; }" />
  72       <MemberType>Property</MemberType>
  73       <ReturnValue>
  74         <ReturnType>System.String</ReturnType>
  75       </ReturnValue>
  76       <Parameters />
  77       <Docs>
  78         <value>a <see cref="T:System.String" /></value>
  79         <remarks>To be added</remarks>
  80         <summary>
  81           <attribution license="cc4" from="Microsoft" modified="false" />
  82           <para>Gets the name of the default file to use when saving the referenced discovery document.</para>
  83         </summary>
  84       </Docs>
  85       <AssemblyInfo>
  86         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  87         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  88       </AssemblyInfo>
  89       <Attributes>
  90         <Attribute>
  91           <AttributeName>System.Xml.Serialization.XmlIgnore</AttributeName>
  92         </Attribute>
  93       </Attributes>
  94     </Member>
  95     <Member MemberName="Document">
  96       <MemberSignature Language="C#" Value="public System.Web.Services.Discovery.DiscoveryDocument Document { get; }" />
  97       <MemberType>Property</MemberType>
  98       <ReturnValue>
  99         <ReturnType>System.Web.Services.Discovery.DiscoveryDocument</ReturnType>
 100       </ReturnValue>
 101       <Docs>
 102         <value>To be added: an object of type 'DiscoveryDocument'</value>
 103         <remarks>
 104           <attribution license="cc4" from="Microsoft" modified="false" />
 105           <para>If the discovery document has not been downloaded and added to the <see cref="P:System.Web.Services.Discovery.DiscoveryClientProtocol.Documents" /> property of <see cref="P:System.Web.Services.Discovery.DiscoveryReference.ClientProtocol" />, an attempt to download and resolve the document is made.</para>
 106         </remarks>
 107         <summary>
 108           <attribution license="cc4" from="Microsoft" modified="false" />
 109           <para>Gets the contents of the referenced discovery document as a <see cref="T:System.Web.Services.Discovery.DiscoveryDocument" /> object.</para>
 110         </summary>
 111       </Docs>
 112       <AssemblyInfo>
 113         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 114         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 115       </AssemblyInfo>
 116       <Attributes>
 117         <Attribute>
 118           <AttributeName>System.Xml.Serialization.XmlIgnore</AttributeName>
 119         </Attribute>
 120       </Attributes>
 121     </Member>
 122     <Member MemberName="ReadDocument">
 123       <MemberSignature Language="C#" Value="public override object ReadDocument (System.IO.Stream stream);" />
 124       <MemberType>Method</MemberType>
 125       <ReturnValue>
 126         <ReturnType>System.Object</ReturnType>
 127       </ReturnValue>
 128       <Parameters>
 129         <Parameter Name="stream" Type="System.IO.Stream" />
 130       </Parameters>
 131       <Docs>
 132         <remarks>To be added</remarks>
 133         <summary>
 134           <attribution license="cc4" from="Microsoft" modified="false" />
 135           <para>Reads and returns the discovery document from the passed <see cref="T:System.IO.Stream" />.</para>
 136         </summary>
 137         <returns>
 138           <attribution license="cc4" from="Microsoft" modified="false" />
 139           <para>A <see cref="T:System.Web.Services.Discovery.DiscoveryDocument" /> containing the contents of the referenced discovery document.</para>
 140         </returns>
 141         <param name="stream">
 142           <attribution license="cc4" from="Microsoft" modified="false" />
 143           <see cref="T:System.IO.Stream" /> containing the discovery document. </param>
 144       </Docs>
 145       <AssemblyInfo>
 146         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 147         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 148       </AssemblyInfo>
 149     </Member>
 150     <Member MemberName="Ref">
 151       <MemberSignature Language="C#" Value="public string Ref { set; get; }" />
 152       <MemberType>Property</MemberType>
 153       <ReturnValue>
 154         <ReturnType>System.String</ReturnType>
 155       </ReturnValue>
 156       <Parameters />
 157       <Docs>
 158         <value>To be added: an object of type 'string'</value>
 159         <remarks>
 160           <attribution license="cc4" from="Microsoft" modified="false" />
 161           <para>For most references, the <see cref="P:System.Web.Services.Discovery.DiscoveryDocumentReference.Ref" /> property is a URL, such as http://www.contoso.com/MyWebService.disco.</para>
 162         </remarks>
 163         <summary>
 164           <attribution license="cc4" from="Microsoft" modified="false" />
 165           <para>Gets or sets the reference to a discovery document.</para>
 166         </summary>
 167       </Docs>
 168       <AssemblyInfo>
 169         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 170         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 171       </AssemblyInfo>
 172       <Attributes>
 173         <Attribute>
 174           <AttributeName>System.Xml.Serialization.XmlAttribute("ref")</AttributeName>
 175         </Attribute>
 176       </Attributes>
 177     </Member>
 178     <Member MemberName="Resolve">
 179       <MemberSignature Language="C#" Value="protected override void Resolve (string contentType, System.IO.Stream stream);" />
 180       <MemberType>Method</MemberType>
 181       <AssemblyInfo>
 182         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 183         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 184       </AssemblyInfo>
 185       <ReturnValue>
 186         <ReturnType>System.Void</ReturnType>
 187       </ReturnValue>
 188       <Parameters>
 189         <Parameter Name="contentType" Type="System.String" />
 190         <Parameter Name="stream" Type="System.IO.Stream" />
 191       </Parameters>
 192       <Docs>
 193         <remarks>
 194           <attribution license="cc4" from="Microsoft" modified="false" />
 195           <para>If the MIME type is text/xml and the content of <paramref name="stream" /> is a discovery document, then the contents of <paramref name="stream" /> are added to the <see cref="P:System.Web.Services.Discovery.DiscoveryClientProtocol.References" /> and <see cref="P:System.Web.Services.Discovery.DiscoveryClientProtocol.Documents" /> properties of <see cref="P:System.Web.Services.Discovery.DiscoveryReference.ClientProtocol" />.</para>
 196           <para>Before invoking the <see cref="M:System.Web.Services.Discovery.DiscoveryDocumentReference.Resolve(System.String,System.IO.Stream)" /> method, the <see cref="P:System.Web.Services.Discovery.DiscoveryReference.ClientProtocol" /> property must be set to a valid instance of <see cref="T:System.Web.Services.Discovery.DiscoveryClientProtocol" />.</para>
 197         </remarks>
 198         <summary>
 199           <attribution license="cc4" from="Microsoft" modified="false" />
 200           <para>Resolves whether the referenced document is valid.</para>
 201         </summary>
 202         <param name="contentType">
 203           <attribution license="cc4" from="Microsoft" modified="false" />The MIME type of <paramref name="stream" />. </param>
 204         <param name="stream">
 205           <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.IO.Stream" /> containing the referenced document. </param>
 206       </Docs>
 207     </Member>
 208     <Member MemberName="ResolveAll">
 209       <MemberSignature Language="C#" Value="public void ResolveAll ();" />
 210       <MemberType>Method</MemberType>
 211       <ReturnValue>
 212         <ReturnType>System.Void</ReturnType>
 213       </ReturnValue>
 214       <Parameters />
 215       <Docs>
 216         <remarks>
 217           <attribution license="cc4" from="Microsoft" modified="false" />
 218           <para>Unless you specifically need to resolve the individual references of a <see cref="T:System.Web.Services.Discovery.DiscoveryDocumentReference" /> object, you should invoke the <see cref="M:System.Web.Services.Discovery.DiscoveryClientProtocol.ResolveAll" /> or <see cref="M:System.Web.Services.Discovery.DiscoveryClientProtocol.ResolveOneLevel" /> methods of <see cref="T:System.Web.Services.Discovery.DiscoveryClientProtocol" />.</para>
 219           <para>This method resolves all references to discovery documents, XSD schemas, and Service Descriptions in the <see cref="P:System.Web.Services.Discovery.DiscoveryClientProtocol.References" /> property of <see cref="P:System.Web.Services.Discovery.DiscoveryReference.ClientProtocol" /> and any references found in referring discovery documents.</para>
 220         </remarks>
 221         <summary>
 222           <attribution license="cc4" from="Microsoft" modified="false" />
 223           <para>Verifies that all referenced documents within the discovery document are valid.</para>
 224         </summary>
 225       </Docs>
 226       <AssemblyInfo>
 227         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 228         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 229       </AssemblyInfo>
 230     </Member>
 231     <Member MemberName="Url">
 232       <MemberSignature Language="C#" Value="public override string Url { set; get; }" />
 233       <MemberType>Property</MemberType>
 234       <ReturnValue>
 235         <ReturnType>System.String</ReturnType>
 236       </ReturnValue>
 237       <Parameters />
 238       <Docs>
 239         <value>a <see cref="T:System.String" /></value>
 240         <remarks>
 241           <attribution license="cc4" from="Microsoft" modified="false" />
 242           <para>Returns the value of the <see cref="P:System.Web.Services.Discovery.DiscoveryDocumentReference.Ref" /> property.</para>
 243         </remarks>
 244         <summary>
 245           <attribution license="cc4" from="Microsoft" modified="false" />
 246           <para>Gets or sets the URL of the referenced discovery document.</para>
 247         </summary>
 248       </Docs>
 249       <AssemblyInfo>
 250         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 251         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 252       </AssemblyInfo>
 253       <Attributes>
 254         <Attribute>
 255           <AttributeName>System.Xml.Serialization.XmlIgnore</AttributeName>
 256         </Attribute>
 257       </Attributes>
 258     </Member>
 259     <Member MemberName="WriteDocument">
 260       <MemberSignature Language="C#" Value="public override void WriteDocument (object document, System.IO.Stream stream);" />
 261       <MemberType>Method</MemberType>
 262       <ReturnValue>
 263         <ReturnType>System.Void</ReturnType>
 264       </ReturnValue>
 265       <Parameters>
 266         <Parameter Name="document" Type="System.Object" />
 267         <Parameter Name="stream" Type="System.IO.Stream" />
 268       </Parameters>
 269       <Docs>
 270         <remarks>To be added</remarks>
 271         <summary>
 272           <attribution license="cc4" from="Microsoft" modified="false" />
 273           <para>Writes the passed <see cref="T:System.Web.Services.Discovery.DiscoveryDocument" /> into the passed <see cref="T:System.IO.Stream" />.</para>
 274         </summary>
 275         <param name="document">
 276           <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.Services.Discovery.DiscoveryDocument" /> to write into <paramref name="stream" />. </param>
 277         <param name="stream">
 278           <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.IO.Stream" /> into which the serialized discovery document is written. </param>
 279       </Docs>
 280       <AssemblyInfo>
 281         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 282         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 283       </AssemblyInfo>
 284     </Member>
 285   </Members>
 286 </Type>