Export (0) Print
Expand All

Workspace Class

Describes the properties and methods of a workspace. For more information about how to use this type, see Team Foundation Build Activities.

System.Object
  Microsoft.TeamFoundation.VersionControl.Client.Workspace

Namespace:  Microsoft.TeamFoundation.VersionControl.Client
Assembly:  Microsoft.TeamFoundation.VersionControl.Client (in Microsoft.TeamFoundation.VersionControl.Client.dll)

public sealed class Workspace : IComparable, 
	IEqualityComparer<Workspace>

The Workspace type exposes the following members.

  NameDescription
Public propertyCommentGets the comment about the workspace.
Public propertyComputerGets the name of the computer on which this workspace exists.
Public propertyDisplayNameGets the formatted display name of the workspace.
Public propertyEffectivePermissionsGets the effective permissions that the AuthenticatedUser has on this workspace.
Public propertyFoldersGets the mappings for this workspace.
Public propertyHasAdministerPermissionGets a flag that indicates whether the AuthorizedUser has Administer permissions for this workspace.
Public propertyHasCheckInPermissionGets a flag that indicates whether the AuthorizedUser has CheckIn permissions for this workspace.
Public propertyHasReadPermissionGets a flag that indicates whether the AuthorizedUser has Read permissions for this workspace.
Public propertyHasUsePermissionGets a flag that indicates whether the AuthorizedUser has Use permissions for this workspace.
Public propertyIsDeletedGets a flag that indicates whether this workspace has been deleted.
Public propertyIsLocalGets a flag that indicates whether this workspace exists on the current machine.
Public propertyLastAccessDateGets the date when this workspace was most recently accessed.
Public propertyLastSavedCheckinGets or sets the metadata from the most recent unshelving or unsuccessful check-in.
Public propertyNameGets the name of this workspace.
Public propertyOwnerDescriptorGets the IdentityDescriptor for the workspace owner, if it is available.
Public propertyOwnerIdentifierGets or sets the identifier of the owner of this workspace.
Public propertyOwnerIdentityTypeGets or sets the identity type of the owner of this workspace.
Public propertyOwnerNameGets the owner of this workspace.
Public propertyPermissionsProfileGets the effective permissions that the AuthenticatedUser has on this workspace.
Public propertyStatic memberRepositoryComparerGets a comparer for repositories that is culture-sensitive and case-insensitive.
Public propertySecurityTokenGets the security token of this workspace for the workspace security namespace.
Public propertyVersionControlServerGets the VersionControlServer object that hosts this workspace.
Top

  NameDescription
Public methodCheckIn(WorkspaceCheckInParameters)Checks in the specified set of pending changes to the version-control repository.
Public methodCheckIn(PendingChange[], String)Checks in the specified set of pending changes to the version-control repository.
Public methodCheckIn(PendingChange[], String, CheckinNote, WorkItemCheckinInfo[], PolicyOverrideInfo)Checks in the specified set of pending changes to the version-control repository.
Public methodCheckIn(PendingChange[], String, String, CheckinNote, WorkItemCheckinInfo[], PolicyOverrideInfo)Checks in the specified set of pending changes to the version-control repository.
Public methodCheckIn(PendingChange[], String, String, CheckinNote, WorkItemCheckinInfo[], PolicyOverrideInfo, CheckinOptions)Checks in the specified set of pending changes to the version-control repository.
Public methodCloakMarks a file or folder in the version-control repository as being excluded from this workspace.
Public methodCreateMappingMaps the specified server path to a location on the local disk.
Public methodDeleteDelete this workspace.
Public methodDeleteMappingRemoves a working-folder mapping from the workspace.
Public methodEquals(Object)Compares this Workspace object to another Workspace object. (Overrides Object.Equals(Object).)
Public methodEquals(Workspace, Workspace)Compares two Workspace objects for equivalence.
Public methodEvaluateCheckinEvaluates the pending changes to verify whether they are ready for check-in.
Public methodEvaluateCheckin2(CheckinEvaluationOptions, IEnumerable<PendingChange>, String, CheckinNote, WorkItemCheckinInfo[])Evaluate the pending changes to verify whether they are ready to check in.
Public methodEvaluateCheckin2(CheckinEvaluationOptions, IEnumerable<PendingChange>, IEnumerable<PendingChange>, String, CheckinNote, WorkItemCheckinInfo[])Evaluate the pending changes to verify whether they are ready to check in.
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodFormatWorkspaceNameForExceptionFormats the conflicting workspace name for an exception when two names conflict.
Public methodGet()Request the server to update the current workspace with the most recent versions of all mapped items.
Public methodGet(GetRequest, GetOptions)Request that the server update the specified items.
Public methodGet(GetRequest[], GetOptions)Request that the server update the specified items.
Public methodGet(VersionSpec, GetOptions)Request that the server update the current workspace with the specified version of all mapped items.
Public methodGet(String[], VersionSpec, RecursionType, GetOptions)Request that the server update the specified items.
Public methodGet(GetRequest, GetOptions, GetFilterCallback, Object)Request that the server update the specified items.
Public methodGet(GetRequest[], GetOptions, GetFilterCallback, Object)Request that the server update the specified items.
Public methodGet(GetRequest[], GetOptions, GetFilterCallback, Object, String[])Request that the server update the specified items.
Public methodGetExtendedItems(ItemSpec[], DeletedState, ItemType)Gets an array of extended items in the version-control repository that match the criteria that are specified in each ItemSpec.
Public methodGetExtendedItems(ItemSpec[], DeletedState, ItemType, GetItemsOptions)Gets an array of extended items in the version-control repository that match the specified criteria, for each ItemSpec.
Public methodGetHashCode()Gets the hash code for this Workspace instance. (Overrides Object.GetHashCode().)
Public methodGetHashCode(Workspace)Gets the hash code for the specified Workspace instance.
Public methodGetLocalItemForServerItem(String)Gets the corresponding local item for the specified server item.
Public methodGetLocalItemForServerItem(String, Boolean)Gets the corresponding local item for the specified server item.
Public methodGetLocalVersionsGets local item information about items in a workspace.
Public methodGetPendingChanges()Gets the pending changes for this workspace.
Public methodGetPendingChanges(String)Gets the pending changes for the specified item in this workspace.
Public methodGetPendingChanges(String[])Gets the pending changes for the items in this workspace.
Public methodGetPendingChanges(ItemSpec[])Gets the pending changes for these items and sub-items in this workspace.
Public methodGetPendingChanges(String, RecursionType)Gets the pending changes for this item and sub-items in this workspace.
Public methodGetPendingChanges(String[], RecursionType)Gets the pending changes for the items and sub-items in this workspace.
Public methodGetPendingChanges(ItemSpec[], Boolean)Get the pending changes for specified items in this workspace.
Public methodGetPendingChanges(String, RecursionType, Boolean)Gets the pending changes for this item and sub-items in this workspace.
Public methodGetPendingChanges(String[], RecursionType, Boolean)Gets the pending changes for the items and sub-items in this workspace.
Public methodGetPendingChanges(ItemSpec[], Boolean, Int32, String)Gets the pending changes for the items and sub-items in this workspace.
Public methodGetPendingChanges(ItemSpec[], Boolean, Int32, String, Boolean)Gets the pending changes for the items and sub-items in this workspace.
Public methodGetPendingChangesEnumerable()Gets an enumerable collection of the pending changes for this workspace.
Public methodGetPendingChangesEnumerable(String)Gets an enumerable collection of the pending changes for the specified item in this workspace.
Public methodGetPendingChangesEnumerable(ItemSpec[])Gets an enumerable collection of the pending changes for the items and sub-items in this workspace.
Public methodGetPendingChangesEnumerable(String, RecursionType)Gets an enumerable collection of pending changes for this item and sub-items in this workspace.
Public methodGetServerItemForLocalItemGets the corresponding server item for the specified local item.
Public methodGetTeamProjectForLocalPathGets the TeamProject instance that contains the specified path.
Public methodGetTeamProjectsForLocalPathsGets the team projects on the version-control repository that have the specified paths.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodGetWorkingFolderForLocalItemGets a WorkingFolder instance that describes how the specified local item is mapped in the workspace.
Public methodGetWorkingFolderForServerItem(String)Gets a WorkingFolder instance that describes how the specified server item is mapped in the workspace.
Public methodStatic memberGetWorkingFolderForServerItem(String, WorkingFolder[])Gets a WorkingFolder instance that describes how the specified server item is mapped in the workspace.
Public methodHasWorkspacePermissionVerifies whether the AuthorizedUser object has the specified WorkspacePermissions objects for this workspace.
Public methodIsLocalPathMappedVerifies whether the specified local path is mapped and not cloaked.
Public methodIsServerPathMapped(String)Returns true if the server item is mapped and not cloaked. This method may return a false positive for implicitly cloaked server paths.
Public methodIsServerPathMapped(String, Boolean)Verifies whether the specified server item is mapped and not cloaked.
Public methodMapMaps the specified server path to a location on the local disk.
Public methodStatic memberMatchNameCompares two workspace names.
Public methodStatic memberMatchOwnerNameCompares the names of two workspace owners.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodMerge(String, String, VersionSpec, VersionSpec)Merges the source to the target.
Public methodMerge(ItemSpec, String, VersionSpec, VersionSpec, LockLevel, MergeOptionsEx)Merges the source to the target.
Public methodMerge(String, String, VersionSpec, VersionSpec, LockLevel, RecursionType, MergeOptions)Merges the source to the target.
Public methodMerge(String, String, VersionSpec, VersionSpec, LockLevel, RecursionType, MergeOptionsEx)Merges the source to the target.
Public methodMerge(ItemSpec, String, VersionSpec, VersionSpec, LockLevel, MergeOptionsEx, String[])Merges the source to the target.
Public methodMergeContentMerges content based on the requested conflict.
Public methodPendAdd(String)Queues files or a folder for addition to the version-control repository.
Public methodPendAdd(String[])Queues files or folders for addition to the version-control repository.
Public methodPendAdd(String, Boolean)Queues files, folders, and subitems for addition to the version-control repository.
Public methodPendAdd(String[], Boolean)Queues files or folders for addition to the version-control repository.
Public methodPendAdd(String[], Boolean, String, LockLevel)Queues files or folders for addition to the version-control repository.
Public methodPendAdd(String[], Boolean, String, LockLevel, Boolean)Queues files or folders for addition to the version-control repository.
Public methodPendAdd(String[], Boolean, String, LockLevel, Boolean, Boolean)Queues files or folders for addition to the version-control repository.
Public methodPendBranch(String, String, VersionSpec)Schedules a file or folder for branching.
Public methodPendBranch(String, String, VersionSpec, LockLevel, Boolean)Schedules a file or folder for branching.
Public methodPendBranch(String, String, VersionSpec, LockLevel, Boolean, Boolean)Schedules a file or folder for branching.
Public methodPendBranch(String, String, VersionSpec, LockLevel, Boolean, Boolean, Boolean)Schedules a file or folder for branching.
Public methodPendDelete(String)Queues files or folders for deletion from the version-control repository.
Public methodPendDelete(String[])Queues files or folders for deletion from the version-control repository.
Public methodPendDelete(String, RecursionType)Queues files or folders for deletion from the version-control repository.
Public methodPendDelete(String[], RecursionType)Queues files or folders for deletion from the version-control repository.
Public methodPendDelete(String[], RecursionType, LockLevel)Queues files or folders for deletion from the version-control repository.
Public methodPendDelete(String[], RecursionType, LockLevel, Boolean)Queues files or folders for deletion from the version-control repository.
Public methodPendDelete(String[], RecursionType, LockLevel, Boolean, Boolean)Queues files or folders for deletion from the version-control repository.
Public methodPendDelete(String[], RecursionType, LockLevel, Boolean, Boolean, String[])Queues files or folders for deletion from the version-control repository.
Public methodPendEdit(String)Checks out files for editing from the version-control repository.
Public methodPendEdit(String[])Checks out files for editing from the version-control repository.
Public methodPendEdit(String, RecursionType)Checks out files for editing from the version-control repository.
Public methodPendEdit(String[], RecursionType)Checks out files for editing from the version-control repository.
Public methodPendEdit(String[], RecursionType, String, LockLevel)Checks out files for editing from the version-control repository.
Public methodPendEdit(String[], RecursionType, String, LockLevel, Boolean)Checks out files for editing from the version-control repository.
Public methodPendEdit(String[], RecursionType, String, LockLevel, Boolean, PendChangesOptions)Checks out files for editing from the version-control repository.
Public methodPendEdit(String[], RecursionType, String, LockLevel, Boolean, PendChangesOptions, String[])Checks out files for editing from the version-control repository.
Public methodPendRename(String, String)Moves or renames a file or directory.
Public methodPendRename(String, String, LockLevel, Boolean, Boolean)Moves or renames a file or directory.
Public methodPendRename(String, String, LockLevel, Boolean, Boolean, Boolean)Moves or renames a file or directory.
Public methodPendRename(String, String, LockLevel, Boolean, Boolean, Boolean, String[])Moves or renames a file or directory.
Public methodPendUndelete(String, Int32)Queues deleted files or folders for restoration to the version-control repository.
Public methodPendUndelete(String, Int32, String)Queues deleted files or folders for restoration to the version-control repository.
Public methodPendUndelete(ItemSpec[], LockLevel, Boolean)Queues deleted files or folders for restoration to the version-control repository.
Public methodPendUndelete(ItemSpec[], LockLevel, Boolean, Boolean)Queues deleted files or folders for restoration from the version-control repository.
Public methodPendUndelete(String, Int32, String, LockLevel, Boolean)Queues deleted files or folders for restoration to the version-control repository.
Public methodPendUndelete(ItemSpec[], LockLevel, Boolean, Boolean, Boolean)Queues deleted files or folders for restoration to the version-control repository.
Public methodPendUndelete(String, Int32, String, LockLevel, Boolean, Boolean)Queues deleted files or folders for restoration to the version-control repository.
Public methodPendUndelete(String, Int32, String, LockLevel, Boolean, Boolean, Boolean)Queues deleted files or folders for restoration to the version-control repository.
Public methodPendUndelete(String, Int32, String, LockLevel, Boolean, Boolean, Boolean, String[])Queues deleted files or folders for restoration to the version-control repository.
Public methodQueryConflictsGets the array of conflicts that match the specified path filters.
Public methodQueryPendingSets(ItemSpec[], String, String, Boolean)Gets the pending changes for the specified query.
Public methodQueryPendingSets(String[], RecursionType, String, String, Boolean)Gets the pending changes for the specified query.
Public methodQueryShelvedChanges(String, String, ItemSpec[])Gets the shelved changes for the specified query.
Public methodQueryShelvedChanges(String, String, ItemSpec[], Boolean)Gets the shelved changes for the specified query.
Public methodRefreshRefreshes this Workspace instance from the server.
Public methodRefreshIfNeededRefreshes this Workspace instance from the server if properties that cannot be cached are stale or have not been loaded. Properties that cannot be cached include working folders and effective permissions.
Public methodRefreshMappings Obsolete. Gets the current set of mappings for this Workspace instance from the server.
Public methodRemoveLocalConflictRemoves a local conflict from the list of conflicts on the server for this workspace.
Public methodResolveConflict(Conflict)Attempt to resolve a conflict based on its Resolution property.
Public methodResolveConflict(Conflict, Conflict[])Attempt to resolve a conflict based on its Resolution property.
Public methodResolveConflict(Conflict, Conflict[], String[])Attempt to resolve a conflict based on its Resolution property.
Public methodRollback(VersionSpec, VersionSpec, LockLevel, RollbackOptions)Pends a rollback for all changes between the specified versions.
Public methodRollback(String[], RecursionType, VersionSpec, VersionSpec, VersionSpec, LockLevel, RollbackOptions, String[])Pends a rollback for changes on a certain path, within the specified versions.
Public methodSetLock(String, LockLevel)Applies the selected lock level to the specified path.
Public methodSetLock(String[], LockLevel)Applies the selected lock level to the specified paths.
Public methodSetLock(String, LockLevel, RecursionType)Applies the selected lock level to the specified path.
Public methodSetLock(String[], LockLevel, RecursionType)Applies the selected lock level to the specified paths.
Public methodSetLock(String[], LockLevel, RecursionType, Boolean)Applies the selected lock level to the specified paths.
Public methodSetLock(String[], LockLevel, RecursionType, Boolean, String[])Applies the selected lock level to the specified paths.
Public methodSetPendingChangePropertySets properties on existing pending changes.
Public methodShelveCollects a set of pending changes and shelves them to the server.
Public methodToStringCreates a user-readable string that describes the properties of this workspace. (Overrides Object.ToString().)
Public methodTryGetLocalItemForServerItem(String)Gets the corresponding local item for the specified server item.
Public methodTryGetLocalItemForServerItem(String, Boolean)Gets the corresponding local item for the specified server item.
Public methodTryGetServerItemForLocalItem(String)Gets the corresponding server item for the specified local item. Does not throw exceptions.
Public methodStatic memberTryGetServerItemForLocalItem(String, WorkingFolder[])Gets the corresponding server item for the specified local item.
Public methodTryGetWorkingFolderForLocalItemGets a WorkingFolder instance that describes how the local item is mapped in the workspace.
Public methodTryGetWorkingFolderForServerItem(String)Gets a WorkingFolder instance that describes how the specified WorkingFolder objects map the server item.
Public methodStatic memberTryGetWorkingFolderForServerItem(String, WorkingFolder[])Gets a WorkingFolder instance that describes how the specified WorkingFolder objects map the server item.
Public methodStatic memberTryGetWorkingFolderForServerItem(String, WorkingFolder[], Boolean)Gets a WorkingFolder instance that describes how the specified WorkingFolder objects map the server item.
Public methodUndo(String)Revert the pending changes for the specified item.
Public methodUndo(String[])Revert the pending changes for the specified items.
Public methodUndo(ItemSpec[])Revert the pending changes for the specified items.
Public methodUndo(PendingChange[])Revert the pending changes for the specified items.
Public methodUndo(String, RecursionType)Revert the pending changes for the specified items.
Public methodUndo(String[], RecursionType)Revert the pending changes for the specified items.
Public methodUndo(String[], Boolean)Revert the pending changes for the specified items.
Public methodUndo(ItemSpec[], Boolean)Revert the pending changes for the specified items.
Public methodUndo(String[], RecursionType, Boolean)Revert the pending changes for the specified items.
Public methodUndo(ItemSpec[], Boolean, String[])Revert the pending changes for the specified items.
Public methodUnshelve(String, String)Reproduces in this workspace a set of pending changes that have been previously shelved to the server.
Public methodUnshelve(String, String, ItemSpec[])Reproduces in this workspace a set of pending changes that have been previously shelved to the server.
Public methodUnshelve(String, String, ItemSpec[], PendingChange[])Reproduces in this workspace a set of pending changes that have been previously shelved to the server.
Public methodUnshelve(String, String, ItemSpec[], PendingChange[], String[])Reproduces in this workspace a set of pending changes that have been previously shelved to the server.
Public methodUpdate(String, String, WorkingFolder[])Updates the properties of a workspace.
Public methodUpdate(String, String, WorkingFolder[], Boolean)Update the properties of a workspace.
Public methodUpdate(String, String, String, WorkingFolder[], Boolean)Updates the properties of a workspace.
Public methodUpdate(String, String, String, String, WorkingFolder[], WorkspacePermissionProfile, Boolean)Updates the properties of a workspace.
Public methodUpdateComputerNameUpdates the name of the computer in the repository.
Public methodUpdateLastSavedCheckin(Shelveset)Updates the information from the most recent attempted check-in with the information from the shelveset.
Public methodUpdateLastSavedCheckin(Shelveset, PendingChange[])Updates the information from the most recent attempted check-in with the information from the shelveset and ensures that the specified set of pending changes have a checked state set.
Top

  NameDescription
Explicit interface implemetationPrivate methodIComparable.CompareToCompares two workspace objects, comparing first the repository URLs, then the workspace names, and finally the owners.
Top

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Community Additions

ADD
Show:
© 2014 Microsoft