Jo Shields a575963da9 Imported Upstream version 3.6.0
Former-commit-id: da6be194a6b1221998fc28233f2503bd61dd9d14
2014-08-13 10:39:27 +01:00

255 lines
12 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<Type Name="DiscoveryReference" FullName="System.Web.Services.Discovery.DiscoveryReference">
<TypeSignature Language="C#" Value="public abstract class DiscoveryReference" Maintainer="auto" />
<AssemblyInfo>
<AssemblyName>System.Web.Services</AssemblyName>
<AssemblyPublicKey>
</AssemblyPublicKey>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<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>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>
<see cref="T:System.Web.Services.Discovery.ContractReference" />, <see cref="T:System.Web.Services.Discovery.SchemaReference" />, and <see cref="T:System.Web.Services.Discovery.DiscoveryDocumentReference" /> all inherit from <see cref="T:System.Web.Services.Discovery.DiscoveryReference" />, and represent the three types of documents discoverable through XML Web services discovery: Service Descriptions, XML Schema Definition (XSD) schemas, and discovery documents, respectively.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The base class for discoverable references using XML Web services discovery.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected DiscoveryReference ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Web.Services.Discovery.DiscoveryReference" /> class. </para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ClientProtocol">
<MemberSignature Language="C#" Value="public System.Web.Services.Discovery.DiscoveryClientProtocol ClientProtocol { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Web.Services.Discovery.DiscoveryClientProtocol</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<value>To be added: an object of type 'DiscoveryClientProtocol'</value>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the instance of <see cref="T:System.Web.Services.Discovery.DiscoveryClientProtocol" /> used in a discovery process.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Xml.Serialization.XmlIgnore</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="DefaultFilename">
<MemberSignature Language="C#" Value="public virtual string DefaultFilename { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added: an object of type 'string'</value>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the name of the default file to use when saving the referenced discovery document, XSD schema, or Service Description.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Xml.Serialization.XmlIgnore</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="FilenameFromUrl">
<MemberSignature Language="C#" Value="public static string FilenameFromUrl (string url);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="url" Type="System.String" />
</Parameters>
<Docs>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Returns a file name based on the passed URL.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Name of the file based on the passed URL.</para>
</returns>
<param name="url">
<attribution license="cc4" from="Microsoft" modified="false" />The URL on which the name of the file is based. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ReadDocument">
<MemberSignature Language="C#" Value="public abstract object ReadDocument (System.IO.Stream stream);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="stream" Type="System.IO.Stream" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The return value is always an <see cref="T:System.Object" />. However, the underlying type varies, depending on the type of document referenced. For instance, a <see cref="T:System.IO.Stream" /> passed into <see cref="M:System.Web.Services.Discovery.SchemaReference.ReadDocument(System.IO.Stream)" /> returns an instance of <see cref="T:System.Xml.Schema.XmlSchema" />.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Reads the passed <see cref="T:System.IO.Stream" /> and returns an instance of the class representing the type of referenced document.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>An <see cref="T:System.Object" /> with an underlying type matching the type of referenced document.</para>
</returns>
<param name="stream">
<attribution license="cc4" from="Microsoft" modified="false" />
<see cref="T:System.IO.Stream" /> containing the reference document. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Resolve">
<MemberSignature Language="C#" Value="public void Resolve ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Downloads the referenced document and then invokes the overloaded <see cref="M:System.Web.Services.Discovery.DiscoveryReference.Resolve" /> member that takes a MIME type and a <see cref="T:System.IO.Stream" />. If the MIME type and the contents of <paramref name="stream" /> match those expected by the reference type, 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>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Downloads the referenced document at <see cref="P:System.Web.Services.Discovery.DiscoveryReference.Url" /> to resolve whether the referenced document is valid.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Resolve">
<MemberSignature Language="C#" Value="protected abstract void Resolve (string contentType, System.IO.Stream stream);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="contentType" Type="System.String" />
<Parameter Name="stream" Type="System.IO.Stream" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>If the MIME type and the contents of <paramref name="stream" /> match those expected by the reference type, 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>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Resolves whether the referenced document is valid.</para>
</summary>
<param name="contentType">
<attribution license="cc4" from="Microsoft" modified="false" />The MIME type of <paramref name="stream" />. </param>
<param name="stream">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.IO.Stream" /> containing the referenced document. </param>
</Docs>
</Member>
<Member MemberName="Url">
<MemberSignature Language="C#" Value="public abstract string Url { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<value>To be added: an object of type 'string'</value>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the URL of the referenced document.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Xml.Serialization.XmlIgnore</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="WriteDocument">
<MemberSignature Language="C#" Value="public abstract void WriteDocument (object document, System.IO.Stream stream);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="document" Type="System.Object" />
<Parameter Name="stream" Type="System.IO.Stream" />
</Parameters>
<Docs>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>When overridden in a derived class, writes the document to a <see cref="T:System.IO.Stream" />.</para>
</summary>
<param name="document">
<attribution license="cc4" from="Microsoft" modified="false" />The document to write into a <see cref="T:System.IO.Stream" />. </param>
<param name="stream">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.IO.Stream" /> into which the <paramref name="document" /> is written. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>