LocationWebService Class

Article
09/28/2012

Inheritance Hierarchy

System.Object
  System.ComponentModel.MarshalByValueComponent
    System.Web.Services.WebService
      Microsoft.TeamFoundation.Framework.Server.WebServices.TeamFoundationWebService
        Microsoft.TeamFoundation.Framework.Server.WebServices.FrameworkWebService
          Microsoft.TeamFoundation.Framework.Server.WebServices.LocationWebService

Namespace: Microsoft.TeamFoundation.Framework.Server.WebServices
Assembly: Microsoft.TeamFoundation.Framework.Server (in Microsoft.TeamFoundation.Framework.Server.dll)

Syntax

'Declaration
<ClientServiceAttribute(ComponentName := "Framework", RegistrationName := "Framework",  _
    ServerConfiguration := ServerConfiguration.TfsConnection, ServiceName := "LocationService",  _
    CollectionServiceIdentifier := "bf9cf1d0-24ac-4d35-aeca-6cd18c69c1fe",  _
    ConfigurationServiceIdentifier := "bf9cf1d0-24ac-4d35-aeca-6cd18c69c1fe")> _
<WebServiceAttribute(Namespace := "https://microsoft.com/webservices/")> _
Public Class LocationWebService _
    Inherits FrameworkWebService

[ClientServiceAttribute(ComponentName = "Framework", RegistrationName = "Framework", 
    ServerConfiguration = ServerConfiguration.TfsConnection, ServiceName = "LocationService", 
    CollectionServiceIdentifier = "bf9cf1d0-24ac-4d35-aeca-6cd18c69c1fe", 
    ConfigurationServiceIdentifier = "bf9cf1d0-24ac-4d35-aeca-6cd18c69c1fe")]
[WebServiceAttribute(Namespace = "https://microsoft.com/webservices/")]
public class LocationWebService : FrameworkWebService

[ClientServiceAttribute(ComponentName = L"Framework", RegistrationName = L"Framework", 
    ServerConfiguration = ServerConfiguration::TfsConnection, ServiceName = L"LocationService", 
    CollectionServiceIdentifier = L"bf9cf1d0-24ac-4d35-aeca-6cd18c69c1fe", 
    ConfigurationServiceIdentifier = L"bf9cf1d0-24ac-4d35-aeca-6cd18c69c1fe")]
[WebServiceAttribute(Namespace = L"https://microsoft.com/webservices/")]
public ref class LocationWebService : public FrameworkWebService

[<ClientServiceAttribute(ComponentName = "Framework", RegistrationName = "Framework", 
    ServerConfiguration = ServerConfiguration.TfsConnection, ServiceName = "LocationService", 
    CollectionServiceIdentifier = "bf9cf1d0-24ac-4d35-aeca-6cd18c69c1fe", 
    ConfigurationServiceIdentifier = "bf9cf1d0-24ac-4d35-aeca-6cd18c69c1fe")>]
[<WebServiceAttribute(Namespace = "https://microsoft.com/webservices/")>]
type LocationWebService =  
    class 
        inherit FrameworkWebService 
    end

public class LocationWebService extends FrameworkWebService

The LocationWebService type exposes the following members.

Constructors

	Name	Description
	LocationWebService

Top

Properties

	Name	Description
	Application	Gets the application object for the current HTTP request. (Inherited from WebService.)
	Container	Gets the container for the component. (Inherited from MarshalByValueComponent.)
	Context	Gets the ASP.NET HttpContext for the current request, which encapsulates all HTTP-specific context used by the HTTP server to process Web requests. (Inherited from WebService.)
	DesignMode	Gets a value indicating whether the component is currently in design mode. (Inherited from MarshalByValueComponent.)
	Events	Gets the list of event handlers that are attached to this component. (Inherited from MarshalByValueComponent.)
	RequestContext	The RequestContext associated with this Web service request. (Inherited from TeamFoundationWebService.)
	Server	Gets the HttpServerUtility for the current request. (Inherited from WebService.)
	Session	Gets the HttpSessionState instance for the current request. (Inherited from WebService.)
	Site	Gets or sets the site of the component. (Inherited from MarshalByValueComponent.)
	SoapVersion	Gets the version of the SOAP protocol used to make the SOAP request to the XML Web service. (Inherited from WebService.)
	User	Gets the ASP.NET server User object. Can be used to authenticate whether a user is authorized to execute the request. (Inherited from WebService.)

Top

Methods

	Name	Description
	AddWebServiceResource	Adds IDisposable resources used by Web Service methods which should be disposed at the end of the request (Inherited from TeamFoundationWebService.)
	ConfigureAccessMapping	Adds or updates the access mapping with the provided accessMapping data. This function optionally generates or updates location mappings for all registered services that are relative to a given tier.
	Connect	Provides the client with all of the information that they must know in order to work with the TeamFoundationConnection object. Properties of ConnectionData that do not have a corresponding entries in connectOptions cost very little to calculate and will be returned every type. If no changes have occurred since lastChangeId, no service data will be returned. If this is the first time this method is being called or the caller wants all of the information returned then -1 should be passed for lastChangeId.
	Dispose()	Releases all resources used by the MarshalByValueComponent. (Inherited from MarshalByValueComponent.)
	Dispose(Boolean)	Releases the unmanaged resources used by the MarshalByValueComponent and optionally releases the managed resources. (Inherited from MarshalByValueComponent.)
	EnterMethod	EnterMethod is used to note the start of the WebMethod execution. (Inherited from TeamFoundationWebService.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from MarshalByValueComponent.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetService	Gets the implementer of the IServiceProvider. (Inherited from MarshalByValueComponent.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	HandleException	This basic WebService ExceptionHandler captures the exception and records it in the request Context for future logging. Services may decide to over-ride this method, perform some actions based on the exception, changing the exception, eating it or just letting it pass. (Inherited from TeamFoundationWebService.)
	LeaveMethod	LeaveMethod should be called as the last block of code in the execution of the WebMethod's scope. (Inherited from TeamFoundationWebService.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	QueryServices	Returns service definitions and access mapping information for the provided filters. If no changes have occurred since lastChangeId, no service data will be returned. If this is the first time this method is being called or the caller wants all of the information returned then -1 should be passed for lastChangeId.
	RemoveAccessMapping	Removes an access mapping and all of the locations that are mapped to it within service definitions.
	RemoveServiceDefinitions	Unregisters the service definitions provided. All LocationMappings will also be deleted.
	SaveServiceDefinitions	Registers the provided service with the location service. This operation will assign a unique identifier to the service definition for its service type and is included in the returned value. Any access mappings referenced in a service definition or one of its LocationMappings must already be registered with the LocationService.
	SetDefaultAccessMapping	Sets the default access mapping to the mapping passed in.
	ToString	Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from MarshalByValueComponent.)

Top

Events

	Name	Description
	Disposed	Adds an event handler to listen to the Disposed event on the component. (Inherited from MarshalByValueComponent.)

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.