ILocationService Interface
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)
Syntax
'Declaration
Public Interface ILocationService _
Inherits IVssClientService
public interface ILocationService : IVssClientService
public interface class ILocationService : IVssClientService
type ILocationService =
interface
interface IVssClientService
end
public interface ILocationService extends IVssClientService
The ILocationService type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
ClientAccessMapping | The 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. |
|
ConfiguredAccessMappings | All 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. |
|
DefaultAccessMapping | The default AccessMapping for this location service. This will never be null. |
Top
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
FindServiceDefinition | |
|
FindServiceDefinitions | |
|
GetAccessMapping | |
|
Initialize | (Inherited from IVssClientService.) |
|
LocationForAccessMapping(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. |
|
LocationForAccessMapping(String, Guid, AccessMapping, Guid) | |
|
LocationForCurrentConnection(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. |
|
LocationForCurrentConnection(String, Guid, Guid) |
Top