Repository Class
Inheritance Hierarchy
System.Object
System.ComponentModel.MarshalByValueComponent
System.Web.Services.WebService
Microsoft.TeamFoundation.Server.Core.WebServices.TeamFoundationWebService
Microsoft.TeamFoundation.VersionControl.Server.VersionControlWebService
Microsoft.TeamFoundation.VersionControl.Server.Repository
Namespace: Microsoft.TeamFoundation.VersionControl.Server
Assembly: Microsoft.TeamFoundation.VersionControl.Server (in Microsoft.TeamFoundation.VersionControl.Server.dll)
Syntax
'Declaration
<WebServiceAttribute(Namespace := "https://schemas.microsoft.com/TeamFoundation/2005/06/VersionControl/ClientServices/03", _
Description := "Team Foundation VersionControl ClientServices web service")> _
<ProxyParentClassAttribute("VersionControlClientProxy")> _
<ClientServiceAttribute(ServiceName := "ISCCProvider", CollectionServiceIdentifier := "b2b178f5-bef9-460d-a5cf-35bcc0281cc4")> _
Public Class Repository _
Inherits VersionControlWebService
[WebServiceAttribute(Namespace = "https://schemas.microsoft.com/TeamFoundation/2005/06/VersionControl/ClientServices/03",
Description = "Team Foundation VersionControl ClientServices web service")]
[ProxyParentClassAttribute("VersionControlClientProxy")]
[ClientServiceAttribute(ServiceName = "ISCCProvider", CollectionServiceIdentifier = "b2b178f5-bef9-460d-a5cf-35bcc0281cc4")]
public class Repository : VersionControlWebService
[WebServiceAttribute(Namespace = L"https://schemas.microsoft.com/TeamFoundation/2005/06/VersionControl/ClientServices/03",
Description = L"Team Foundation VersionControl ClientServices web service")]
[ProxyParentClassAttribute(L"VersionControlClientProxy")]
[ClientServiceAttribute(ServiceName = L"ISCCProvider", CollectionServiceIdentifier = L"b2b178f5-bef9-460d-a5cf-35bcc0281cc4")]
public ref class Repository : public VersionControlWebService
[<WebServiceAttribute(Namespace = "https://schemas.microsoft.com/TeamFoundation/2005/06/VersionControl/ClientServices/03",
Description = "Team Foundation VersionControl ClientServices web service")>]
[<ProxyParentClassAttribute("VersionControlClientProxy")>]
[<ClientServiceAttribute(ServiceName = "ISCCProvider", CollectionServiceIdentifier = "b2b178f5-bef9-460d-a5cf-35bcc0281cc4")>]
type Repository =
class
inherit VersionControlWebService
end
public class Repository extends VersionControlWebService
The Repository type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
Repository |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
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.) |
.gif "Protected property") |
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 | |
|---|---|---|
|
AddConflict | |
.gif "Protected method") |
AddWebServiceResource | Adds IDisposable resources used by Web Service methods which should be disposed at the end of the request. (Inherited from TeamFoundationWebService.) |
|
CheckAuthentication | A "dummy" call that can be made on a connection to initialize the authentication. |
|
CheckIn | Commits a set of pending changes. Checkin is part of a larger call sequence to commit files. The sequence is: 1. Call CheckPendingChanges and pass in the list of files and folders to check in. 2. For each file, call UploadFile. 3. Call Checkin and pass the list of files and folders (should match the list in #1). CheckPendingChanges is not necessary, but it allows the caller to be alerted of conflicts before wasting time uploading files. serverItems must contain at least one item, no duplicates, and no wildcard characters. |
|
CheckPendingChanges | Checks a set of pending changes for checkin conflicts. This should be called as a preliminary check at the start of a checkin sequence. Any conflicts that exist at the point in time when the call was made will be returned to the client en masse. Checkin will repeat the same checks and if any conflicts have crept in since this call was made, it will fail. serverItems must contain at least one item and no wildcard characters. |
|
CreateAnnotation | |
|
CreateBranch | |
|
CreateCheckinNoteDefinition | |
|
CreateTeamProjectFolder | This is used to create a team project and all the infrastructure surrounding it. Permissions, checkin notes, users, etc. |
|
CreateWorkspace | This function creates a new workspace for a given user. The workspace must not already exist. |
|
DeleteAnnotation | |
|
DeleteLabel | Deletes the label with the given name and root item. |
|
DeleteShelveset | Deletes the specified shelveset. All associated shelved changes are removed also. |
|
DeleteWorkspace | Deletes the specified workspace. All pending changes are canceled and all LocalVersion entries are removed from the server. |
|
Destroy | Destroy the subtree represented by itemSpec. |
|
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 | (Inherited from VersionControlWebService.) |
|
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.) |
|
Get | Called by the client to synchronize the workspace with a given version. Returns a "to do" list of files for the client to download to update the user's local working copies. |
|
GetHashCode | Serves as the default hash function. (Inherited from Object.) |
|
GetRepositoryProperties | Returns basic information about the repository. This includes its name and GUID. |
|
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 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.) |
|
LabelItem | Creates or updates a label. Associates the given versions of the given items. |
|
LeaveMethod | (Inherited from VersionControlWebService.) |
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
Merge | Return the list of GetOperations for pending merges automatically resolved and conflicts for the ones that are not automatically resolved. |
|
PendChanges | Called to perform adds, checkouts, branches, renames, deletes, and so on. Changes submitted may contain wildcard characters and recursion flags. Wildcards and recursions will be expanded and the list of changes successfully pended will be returned. |
|
QueryAnnotation | Query annotation associated with the given item. |
|
QueryBranches | Find all of the relatives for each item spec.For example: Craig branches a.cs -> b.cs; Justin branches b.cs -> c.cs; and Amy branches b.cs -> d.cs. Then the following data should be returned when QueryBranches is called by using a.cs, b.cs, c.cs, or d.cs: BranchToItem: a.cs, BranchFromItem: NULL; BranchToItem: b.cs, BranchFromItem: a.cs; BranchToItem: c.cs, BranchFromItem: b.cs; BranchToItem: d.cs, BranchFromItem: b.cs. An additional complication is that the user asking for this data might not have Read permission on all of the branch relatives. When this occurs, the appropriate Item structure is set to NULL. The RelativeToItemId, and RelativeFromItemId are assigned based on ServerItem;Changeset so that the caller of this API can always determine the shape of the graph, even if all of the data is not visible to the user. |
|
QueryChangeset | Returns information about a single changeset. |
|
QueryChangesForChangeset | Queries changes throughout a given changeset (can be paged or non-pages.) |
|
QueryCheckinNoteDefinition | |
|
QueryCheckinNoteFieldNames | |
|
QueryConflicts | Return the conflicts filtered by the optional list of ItemSpecs. |
|
QueryEffectiveGlobalPermissions | Computes the global permissions for a user. Applies the allow and deny lists, inheritance, and group membership rules to produce a simple list of permissions the user has. |
|
QueryEffectiveItemPermissions | Computes the permissions for a user against a particular item. Applies the allow and deny lists, inheritance, and group membership rules to produce a simple list of permissions the user has. |
|
QueryFileTypes | Returns the list of per-file-extension configuration information. |
|
QueryGlobalPermissions | |
|
QueryHistory | Returns changeset information about an item and its children. The maxCount newest changesets will be returned that involve the specified item and are in the range of versionFrom->versionTo. |
|
QueryItemPermissions | Returns permission information for given items. |
|
QueryItems | Returns information about a set of items specified by the items array. The "items" parameter supports wildcard characters and all recursion types. The version parameter specifies what versions of the items are to be received. A WorkspaceVersionSpec may be specified, in which case only items that appear in that workspace's LocalVersion table will be returned. |
|
QueryItemsById | Returns items, based on the given item identifiers and version. |
|
QueryItemsExtended | |
|
QueryLabels | Returns list of labels matching given fields. Null fields are not used as part of the comparison. |
|
QueryLocalVersions | Queries the local item information which a user has in their workspace. |
|
QueryMergeCandidates | Returns the set of changesets that must be merged from source to target. |
|
QueryMerges | Returns merge history. |
|
QueryMergesWithDetails | Returns merge with details history. |
|
QueryPendingChangesById | |
|
QueryPendingChangesForWorkspace | Returns a list of pending changes matching specified criteria. These results are limited by the value passed in for page size. The value of lastChange specifies where to begin paging from, or null for the first page. Children are returned according to the recursive option. If RecursionType.None is specified, only the serverItem is returned. If RecursionType.OneLevel is specified and serverItem represents a folder, that folder and its direct children are returned. If RecursionType.Full is specified and serverItem is a folder, all its descendants are returned. |
|
QueryPendingSets | Returns a list of pending changes matching specified criteria. If workspaceName is not null, ownerName must also be specified. Children are returned according to the recursive option. If RecursionType.None is specified, only the serverItem is returned. If RecursionType.OneLevel is specified and serverItem represents a folder, that folder and its direct children are returned. If RecursionType.Full is specified and serverItem is a folder, all its descendants are returned. This function returns an array of PendingSet objects, each of which represents a workspace. Within each PendingSet object is an array of PendingChanges that represent the changes that belong to that workspace. |
|
QueryShelvedChanges | Returns a list of pending changes matching specified criteria. If workspaceName is not null, ownerName must also be specified. Children are returned according to the recursive option. If RecursionType.None is specified, only the serverItem is returned. If RecursionType.OneLevel is specified and serverItem represents a folder, that folder and its direct children are returned. If RecursionType.Full is specified and serverItem is a folder, all its descendants are returned. This function returns an array of PendingSet objects, each of which represents a workspace. Within each PendingSet object is an array of PendingChanges that represent the changes that belong to that workspace. |
|
QueryShelvesets | Lists the known shelvesets in the system. Returns shelveset metadata. To retrieve the list of changes, use QueryPendingSets(). |
|
QueryWorkspace | Looks up a specific workspace. No wildcard characters or nulls are allowed. Throws an exception if workspace not found. |
|
QueryWorkspaces | Searches for a workspace with the given owner and computer. |
|
RefreshIdentityDisplayName | Update the table of identities to include an updated (renamed) user name. |
|
RemoveLocalConflict | |
|
Resolve | Resolve a specific conflict with a specific resolution. This is called for Get, Checkin, and Merge conflicts. |
|
SetFileTypes | Replaces the current set of file type definitions. |
|
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.) |
|
Shelve | Copies the pending changes to a shelveset. Changes will remain in the workspace also. |
|
ToString | Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from MarshalByValueComponent.) |
|
UndoPendingChanges | Undoes a set of pending changes. If a serverItem spec does not match anything, a Failure object is returned for it. This method returns an array of pending changes that were undone. For each file, the client should call DownloadFile() and specify the version returned in the UndonePendingChange object to retrieve the unmodified versions of the files. |
|
UnlabelItem | Removes the given item(s) from a named label. |
|
Unshelve | Copies shelved changes into a workspace. |
|
UpdateChangeset | UpdateChangeset is used to update the comment and referenced checkin note with for a changeset. |
|
UpdateCheckinNoteFieldName | |
|
UpdateGlobalSecurity | |
|
UpdateItemSecurity | Modifies an item's security information. |
|
UpdateLocalVersion | Called to update the local version of an item which is stored for a workspace. Clients should call this after successfully calling DownloadFile() based on instructions from Get(). |
|
UpdatePendingState | This is used to update the Conflict and Revert To information. It can be used if the client downloads files without using a Get to register conflicts and update revert to information. |
|
UpdateWorkspace | Modifies workspace properties and working folder mappings. Workspace owner may not be changed. |
Top
Events
| Name | Description | |
|---|---|---|
.gif "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.