TeamFoundationSoapProxy Class

  • Article

Provides the protocol for Team Foundation object communication by using SOAP.

Inheritance Hierarchy

System.Object
  System.MarshalByRefObject
    System.ComponentModel.Component
      System.Web.Services.Protocols.WebClientProtocol
        System.Web.Services.Protocols.HttpWebClientProtocol
          System.Web.Services.Protocols.SoapHttpClientProtocol
            Microsoft.TeamFoundation.Client.TeamFoundationSoapProxy
              Microsoft.TeamFoundation.Client.ProxyStatistics
              Microsoft.TeamFoundation.WorkItemTracking.Proxy.ClientServiceProxy
              Microsoft.TeamFoundation.WorkItemTracking.Proxy.ConfigurationSettingsServiceProxy

Namespace:  Microsoft.TeamFoundation.Client
Assembly:  Microsoft.TeamFoundation.Client (in Microsoft.TeamFoundation.Client.dll)

Syntax

'Declaration
Public MustInherit Class TeamFoundationSoapProxy _
    Inherits SoapHttpClientProtocol

public abstract class TeamFoundationSoapProxy : SoapHttpClientProtocol

public ref class TeamFoundationSoapProxy abstract : public SoapHttpClientProtocol

[<AbstractClass>]
type TeamFoundationSoapProxy =  
    class
        inherit SoapHttpClientProtocol
    end

public abstract class TeamFoundationSoapProxy extends SoapHttpClientProtocol

The TeamFoundationSoapProxy type exposes the following members.

Constructors

  Name Description
Protected method TeamFoundationSoapProxy() Initializes a new TeamFoundationSoapProxy instance.
Protected method TeamFoundationSoapProxy(TfsConnection) Initializes a new TeamFoundationSoapProxy instance.

Top

Properties

  Name Description
Public property AllowAutoRedirect Gets or sets whether the client automatically follows server redirects. (Inherited from HttpWebClientProtocol.)
Protected property CanRaiseEvents Gets a value indicating whether the component can raise an event. (Inherited from Component.)
Public property ClientCertificates Gets the collection of client certificates. (Inherited from HttpWebClientProtocol.)
Public property ConnectionGroupName Gets or sets the name of the connection group for the request. (Inherited from WebClientProtocol.)
Public property Container Gets the IContainer that contains the Component. (Inherited from Component.)
Public property CookieContainer Gets or sets the collection of cookies. (Inherited from HttpWebClientProtocol.)
Public property Credentials Gets or sets security credentials for XML Web service client authentication. (Inherited from WebClientProtocol.)
Public propertyStatic member DefaultTimeout Gets the default time-out for SOAP requests.
Public propertyStatic member DefaultUserAgent Gets the default user agent string to use in all requests.
Protected property DesignMode Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component.)
Public property EnableDecompression Gets or sets a Boolean that indicates whether decompression is enabled for this HttpWebClientProtocol. (Inherited from HttpWebClientProtocol.)
Protected property Events Gets the list of event handlers that are attached to this Component. (Inherited from Component.)
Public property PreAuthenticate Gets or sets whether pre-authentication is enabled. (Inherited from WebClientProtocol.)
Public property Proxy Gets or sets proxy information for making an XML Web service request through a firewall. (Inherited from HttpWebClientProtocol.)
Public property RequestEncoding The Encoding used to make the client request to the XML Web service. (Inherited from WebClientProtocol.)
Public property Site Gets or sets the ISite of the Component. (Inherited from Component.)
Public property SoapVersion Gets or sets the version of the SOAP protocol used to make the SOAP request to the XML Web service. (Inherited from SoapHttpClientProtocol.)
Public property TeamFoundationServer Obsolete. (Obsolete) Gets or sets the TeamFoundationServer object that is associated with this proxy.
Public property TfsConnection Gets or sets the TfsConnection object that is associated with this proxy.
Public property Timeout Indicates the time an XML Web service client waits for the reply to a synchronous XML Web service request to arrive (in milliseconds). (Inherited from WebClientProtocol.)
Public property UnsafeAuthenticatedConnectionSharing Gets or sets a value that indicates whether connection sharing is enabled when the client uses NTLM authentication to connect to the Web server that hosts the XML Web service. (Inherited from HttpWebClientProtocol.)
Public property Url Gets or sets the base URL of the XML Web service the client is requesting. (Inherited from WebClientProtocol.)
Public property UseDefaultCredentials Gets or sets a value that indicates whether to set the Credentials property to the value of the CredentialCache.DefaultCredentials property. (Inherited from WebClientProtocol.)
Public property UserAgent Gets or sets the value for the user agent header that is sent with each request. (Inherited from HttpWebClientProtocol.)

Top

Methods

  Name Description
Public method Abort Cancels a request to an XML Web service method. (Inherited from WebClientProtocol.)
Protected method BeginInvoke Starts an asynchronous invocation of an XML Web service method using SOAP. (Inherited from SoapHttpClientProtocol.)
Protected method CancelAsync Cancels an asynchronous call to an XML Web service method, unless the call has already completed. (Inherited from HttpWebClientProtocol.)
Public method CreateObjRef Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
Public method Discover Dynamically binds to an XML Web service described in the discovery document at Url. (Inherited from SoapHttpClientProtocol.)
Public method Dispose() Releases all resources used by the Component. (Inherited from Component.)
Protected method Dispose(Boolean) Releases the unmanaged resources used by the Component and optionally releases the managed resources. (Inherited from Component.)
Protected method EndInvoke Ends an asynchronous invocation of an XML Web service method using SOAP. (Inherited from SoapHttpClientProtocol.)
Public method Equals Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection. (Inherited from Component.)
Public methodStatic member GetConnectionGroupName Gets the connection group name that is specified by a uniform resource identifier (URI) and credentials combination.
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetLifetimeService Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Protected method GetReaderForMessage Returns an XmlReader initialized with the Stream property of the SoapClientMessage parameter. (Inherited from SoapHttpClientProtocol.)
Protected method GetService Returns an object that represents a service provided by the Component or by its Container. (Inherited from Component.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method GetWebRequest (Overrides SoapHttpClientProtocol.GetWebRequest(Uri).)
Protected method GetWebResponse(WebRequest) (Overrides HttpWebClientProtocol.GetWebResponse(WebRequest).)
Protected method GetWebResponse(WebRequest, IAsyncResult) (Overrides HttpWebClientProtocol.GetWebResponse(WebRequest, IAsyncResult).)
Protected method GetWriterForMessage (Overrides SoapHttpClientProtocol.GetWriterForMessage(SoapClientMessage, Int32).)
Public method InitializeLifetimeService Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Protected method Invoke Invokes an XML Web service method synchronously using SOAP. (Inherited from SoapHttpClientProtocol.)
Protected method InvokeAsync(String, array<Object[], SendOrPostCallback) Invokes the specified method asynchronously. (Inherited from SoapHttpClientProtocol.)
Protected method InvokeAsync(String, array<Object[], SendOrPostCallback, Object) Invokes the specified method asynchronously. (Inherited from SoapHttpClientProtocol.)
Protected method MemberwiseClone() Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method MemberwiseClone(Boolean) Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
Protected method ThrowIfUnauthorized
Public method ToString Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component.)

Top

Events

  Name Description
Public event Disposed Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component.)

Top

Fields

  Name Description
Public fieldStatic member ProxyTracing Trace switch to control what gets logged – particularly web method calls.

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.TeamFoundation.Client Namespace