This documentation is archived and is not being maintained.

ILocationService Interface

Visual Studio 2013

The service responsible for providing a connection to a Team Foundation Server as well as the locations of other services that are available on it.

Namespace:  Microsoft.VisualStudio.Services.Location
Assembly:  Microsoft.VisualStudio.Services.Client (in Microsoft.VisualStudio.Services.Client.dll)

public interface ILocationService : IVssClientService

The ILocationService type exposes the following members.

  NameDescription
Public propertyClientAccessMappingThe AccessMapping for the current connection to the server. Note, it is possible that the current ClientAccessMapping is not a member of the ConfiguredAccessMappings if the access point this client used to connect to the server has not been configured on it. This will never be null.
Public propertyConfiguredAccessMappingsAll of the AccessMappings that this location service knows about. Because a given location service can inherit AccessMappings from its parent these AccessMappings may exist on this location service or its parent.
Public propertyDefaultAccessMappingThe default AccessMapping for this location service. This will never be null.
Top

  NameDescription
Public methodFindServiceDefinition
Public methodFindServiceDefinitions
Public methodGetAccessMapping
Public methodInitialize (Inherited from IVssClientService.)
Public methodLocationForAccessMapping(ServiceDefinition, AccessMapping)Returns the location for the ServiceDefinition for the provided AccessMapping. If this ServiceDefinition is FullyQualified and no LocationMapping exists for this AccessMapping then null will be returned.
Public methodLocationForAccessMapping(String, Guid, AccessMapping, Guid)
Public methodLocationForCurrentConnection(ServiceDefinition)Returns the location for the ServiceDefintion that should be used based on the current connection. This method will never return null or empty. If it succeeds it will return a targetable location for the provided ServiceDefinition. When determining what location to return for the ServiceDefinition and current connection the following rules will be applied: 1. Try to find a location for the ClientAccessMapping. 2. Try to find a location for the DefaultAccessMapping. 3. Use the first location in the LocationMappings list.
Public methodLocationForCurrentConnection(String, Guid, Guid)
Top
Show: