Share via


LocationWebService Class

Inheritance Hierarchy

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

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

Syntax

'Declaration
<WebServiceAttribute(Namespace := "https://microsoft.com/webservices/")> _
<ClientServiceAttribute(ComponentName := "Framework", RegistrationName := "Framework",  _
    ServerConfiguration := ServerConfiguration.TfsConnection, ServiceName := "LocationService",  _
    CollectionServiceIdentifier := "bf9cf1d0-24ac-4d35-aeca-6cd18c69c1fe",  _
    ConfigurationServiceIdentifier := "bf9cf1d0-24ac-4d35-aeca-6cd18c69c1fe")> _
Public Class LocationWebService _
    Inherits FrameworkWebService
[WebServiceAttribute(Namespace = "https://microsoft.com/webservices/")]
[ClientServiceAttribute(ComponentName = "Framework", RegistrationName = "Framework", 
    ServerConfiguration = ServerConfiguration.TfsConnection, ServiceName = "LocationService", 
    CollectionServiceIdentifier = "bf9cf1d0-24ac-4d35-aeca-6cd18c69c1fe", 
    ConfigurationServiceIdentifier = "bf9cf1d0-24ac-4d35-aeca-6cd18c69c1fe")]
public class LocationWebService : FrameworkWebService
[WebServiceAttribute(Namespace = L"https://microsoft.com/webservices/")]
[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")]
public ref class LocationWebService : public FrameworkWebService
[<WebServiceAttribute(Namespace = "https://microsoft.com/webservices/")>]
[<ClientServiceAttribute(ComponentName = "Framework", RegistrationName = "Framework", 
    ServerConfiguration = ServerConfiguration.TfsConnection, ServiceName = "LocationService", 
    CollectionServiceIdentifier = "bf9cf1d0-24ac-4d35-aeca-6cd18c69c1fe", 
    ConfigurationServiceIdentifier = "bf9cf1d0-24ac-4d35-aeca-6cd18c69c1fe")>]
type LocationWebService =  
    class 
        inherit FrameworkWebService 
    end
public class LocationWebService extends FrameworkWebService

The LocationWebService type exposes the following members.

Constructors

  Name Description
Public method LocationWebService

Top

Properties

  Name Description
Public property Application Gets the application object for the current HTTP request. (Inherited from WebService.)
Public property Container Gets the container for the component. (Inherited from MarshalByValueComponent.)
Public property 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.)
Public property DesignMode Gets a value indicating whether the component is currently in design mode. (Inherited from MarshalByValueComponent.)
Protected property Events Gets the list of event handlers that are attached to this component. (Inherited from MarshalByValueComponent.)
Protected property RequestContext The RequestContext associated with this web service request. (Inherited from TeamFoundationWebService.)
Public property Server Gets the HttpServerUtility for the current request. (Inherited from WebService.)
Public property Session Gets the HttpSessionState instance for the current request. (Inherited from WebService.)
Public property Site Gets or sets the site of the component. (Inherited from MarshalByValueComponent.)
Public property SoapVersion Gets the version of the SOAP protocol used to make the SOAP request to the XML Web service. (Inherited from WebService.)
Public property 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
Protected method AddWebServiceResource Adds IDisposable resources used by Web Service methods which should be disposed at the end of the request. (Inherited from TeamFoundationWebService.)
Public method 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.
Public method Connect Provides the client with all of the information they need to 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 occured 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.
Public method Dispose() Releases all resources used by the MarshalByValueComponent. (Inherited from MarshalByValueComponent.)
Protected method Dispose(Boolean) Releases the unmanaged resources used by the MarshalByValueComponent and optionally releases the managed resources. (Inherited from MarshalByValueComponent.)
Protected method EnterMethod EnterMethod is used to note the beginning of the WebMethod execution. (Inherited from TeamFoundationWebService.)
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from MarshalByValueComponent.)
Public method GetHashCode Serves as the default hash function. (Inherited from Object.)
Public method GetService Gets the implementer of the IServiceProvider. (Inherited from MarshalByValueComponent.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method HandleException This basic WebService ExceptionHandler captures the exception and records it in the request Context for future logging. Services may choose 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.)
Protected method LeaveMethod LeaveMethod should be called as the last piece of code within the execution of the WebMethod's scope. (Inherited from TeamFoundationWebService.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method QueryServices Returns service definitions and access mapping information for the provided filters. If no changes have occured 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.
Public method RemoveAccessMapping Removes an access mapping and all of the locations that are mapped to it within service definitions.
Public method RemoveServiceDefinitions Unregisters the service definitions provided. All LocationMappings will also be deleted.
Public method 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.
Public method SetDefaultAccessMapping Sets the default access mapping to the mapping passed in.
Protected method SetMethodName Sets the method name (does NOT call EnterMethod) This is meant to be called with the same instance of methodInformation, but without the parameters so that the method is correctly logged in the activity log rather than just its URL. (Inherited from TeamFoundationWebService.)
Public method 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
Public event 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.

See Also

Reference

Microsoft.TeamFoundation.Server.Core.WebServices Namespace