Workspace Class

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

Inheritance Hierarchy

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

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

Syntax

'Declaration
Public NotInheritable Class Workspace _
    Implements IComparable, IEqualityComparer(Of Workspace)

public sealed class Workspace : IComparable, 
    IEqualityComparer<Workspace>

public ref class Workspace sealed : IComparable, 
    IEqualityComparer<Workspace^>

[<Sealed>]
type Workspace =  
    class
        interface IComparable
        interface IEqualityComparer<Workspace>
    end

public final class Workspace implements IComparable, IEqualityComparer<Workspace>

The Workspace type exposes the following members.

Properties

	Name	Description
	Comment	Gets the comment about the workspace.
	Computer	Gets the name of the computer on which this workspace exists.
	DisplayName	Gets the formatted display name of the workspace.
	EffectivePermissions	Gets the effective permissions that the AuthenticatedUser has on this workspace.
	Folders	Gets the mappings for this workspace.
	HasAdministerPermission	Gets a flag that indicates whether the AuthorizedUser has Administer permissions for this workspace.
	HasCheckInPermission	Gets a flag that indicates whether the AuthorizedUser has CheckIn permissions for this workspace.
	HasReadPermission	Gets a flag that indicates whether the AuthorizedUser has Read permissions for this workspace.
	HasUsePermission	Gets a flag that indicates whether the AuthorizedUser has Use permissions for this workspace.
	IsDeleted	Gets a flag that indicates whether this workspace has been deleted.
	IsLocal	Gets a flag that indicates whether this workspace exists on the current machine.
	LastAccessDate	Gets the date when this workspace was most recently accessed.
	LastSavedCheckin	Gets or sets the metadata from the most recent unshelving or unsuccessful check-in.
	Name	Gets the name of this workspace.
	OwnerDescriptor	Gets the IdentityDescriptor for the workspace owner, if it is available.
	OwnerIdentifier	Gets or sets the identifier of the owner of this workspace.
	OwnerIdentityType	Gets or sets the identity type of the owner of this workspace.
	OwnerName	Gets the owner of this workspace.
	PermissionsProfile	Gets the effective permissions that the AuthenticatedUser has on this workspace.
	RepositoryComparer	Gets a comparer for repositories that is culture-sensitive and case-insensitive.
	SecurityToken	Gets the security token of this workspace for the workspace security namespace.
	VersionControlServer	Gets the VersionControlServer object that hosts this workspace.

Top

Methods

	Name	Description
	CheckIn(WorkspaceCheckInParameters)	Checks in the specified set of pending changes to the version-control repository.
	CheckIn(array<PendingChange[], String)	Checks in the specified set of pending changes to the version-control repository.
	CheckIn(array<PendingChange[], String, CheckinNote, array<WorkItemCheckinInfo[], PolicyOverrideInfo)	Checks in the specified set of pending changes to the version-control repository.
	CheckIn(array<PendingChange[], String, String, CheckinNote, array<WorkItemCheckinInfo[], PolicyOverrideInfo)	Checks in the specified set of pending changes to the version-control repository.
	CheckIn(array<PendingChange[], String, String, CheckinNote, array<WorkItemCheckinInfo[], PolicyOverrideInfo, CheckinOptions)	Checks in the specified set of pending changes to the version-control repository.
	Cloak	Marks a file or folder in the version-control repository as being excluded from this workspace.
	CreateMapping	Maps the specified server path to a location on the local disk.
	Delete	Delete this workspace.
	DeleteMapping	Removes a working-folder mapping from the workspace.
	Equals(Object)	Compares this Workspace object to another Workspace object. (Overrides Object.Equals(Object).)
	Equals(Workspace, Workspace)	Compares two Workspace objects for equivalence.
	EvaluateCheckin	Evaluates the pending changes to verify whether they are ready for check-in.
	EvaluateCheckin2(CheckinEvaluationOptions, IEnumerable<PendingChange>, String, CheckinNote, array<WorkItemCheckinInfo[])	Evaluate the pending changes to verify whether they are ready to check in.
	EvaluateCheckin2(CheckinEvaluationOptions, IEnumerable<PendingChange>, IEnumerable<PendingChange>, String, CheckinNote, array<WorkItemCheckinInfo[])	Evaluate the pending changes to verify whether they are ready to check in.
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	FormatWorkspaceNameForException	Formats the conflicting workspace name for an exception when two names conflict.
	Get()	Request the server to update the current workspace with the most recent versions of all mapped items.
	Get(GetRequest, GetOptions)	Request that the server update the specified items.
	Get(array<GetRequest[], GetOptions)	Request that the server update the specified items.
	Get(VersionSpec, GetOptions)	Request that the server update the current workspace with the specified version of all mapped items.
	Get(array<String[], VersionSpec, RecursionType, GetOptions)	Request that the server update the specified items.
	Get(GetRequest, GetOptions, GetFilterCallback, Object)	Request that the server update the specified items.
	Get(array<GetRequest[], GetOptions, GetFilterCallback, Object)	Request that the server update the specified items.
	Get(array<GetRequest[], GetOptions, GetFilterCallback, Object, array<String[])	Request that the server update the specified items.
	GetExtendedItems(array<ItemSpec[], DeletedState, ItemType)	Gets an array of extended items in the version-control repository that match the criteria that are specified in each ItemSpec.
	GetExtendedItems(array<ItemSpec[], DeletedState, ItemType, GetItemsOptions)	Gets an array of extended items in the version-control repository that match the specified criteria, for each ItemSpec.
	GetHashCode()	Gets the hash code for this Workspace instance. (Overrides Object.GetHashCode().)
	GetHashCode(Workspace)	Gets the hash code for the specified Workspace instance.
	GetLocalItemForServerItem(String)	Gets the corresponding local item for the specified server item.
	GetLocalItemForServerItem(String, Boolean)	Gets the corresponding local item for the specified server item.
	GetLocalVersions	Gets local item information about items in a workspace.
	GetPendingChanges()	Gets the pending changes for this workspace.
	GetPendingChanges(String)	Gets the pending changes for the specified item in this workspace.
	GetPendingChanges(array<String[])	Gets the pending changes for the items in this workspace.
	GetPendingChanges(array<ItemSpec[])	Gets the pending changes for these items and sub-items in this workspace.
	GetPendingChanges(String, RecursionType)	Gets the pending changes for this item and sub-items in this workspace.
	GetPendingChanges(array<String[], RecursionType)	Gets the pending changes for the items and sub-items in this workspace.
	GetPendingChanges(array<ItemSpec[], Boolean)	Get the pending changes for specified items in this workspace.
	GetPendingChanges(String, RecursionType, Boolean)	Gets the pending changes for this item and sub-items in this workspace.
	GetPendingChanges(array<String[], RecursionType, Boolean)	Gets the pending changes for the items and sub-items in this workspace.
	GetPendingChanges(array<ItemSpec[], Boolean, Int32, String)	Gets the pending changes for the items and sub-items in this workspace.
	GetPendingChanges(array<ItemSpec[], Boolean, Int32, String, Boolean)	Gets the pending changes for the items and sub-items in this workspace.
	GetPendingChangesEnumerable()	Gets an enumerable collection of the pending changes for this workspace.
	GetPendingChangesEnumerable(String)	Gets an enumerable collection of the pending changes for the specified item in this workspace.
	GetPendingChangesEnumerable(array<ItemSpec[])	Gets an enumerable collection of the pending changes for the items and sub-items in this workspace.
	GetPendingChangesEnumerable(String, RecursionType)	Gets an enumerable collection of pending changes for this item and sub-items in this workspace.
	GetServerItemForLocalItem	Gets the corresponding server item for the specified local item.
	GetTeamProjectForLocalPath	Gets the TeamProject instance that contains the specified path.
	GetTeamProjectsForLocalPaths	Gets the team projects on the version-control repository that have the specified paths.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetWorkingFolderForLocalItem	Gets a WorkingFolder instance that describes how the specified local item is mapped in the workspace.
	GetWorkingFolderForServerItem(String)	Gets a WorkingFolder instance that describes how the specified server item is mapped in the workspace.
	GetWorkingFolderForServerItem(String, array<WorkingFolder[])	Gets a WorkingFolder instance that describes how the specified server item is mapped in the workspace.
	HasWorkspacePermission	Verifies whether the AuthorizedUser object has the specified WorkspacePermissions objects for this workspace.
	IsLocalPathMapped	Verifies whether the specified local path is mapped and not cloaked.
	IsServerPathMapped(String)	Returns true if the server item is mapped and not cloaked. This method may return a false positive for implicitly cloaked server paths.
	IsServerPathMapped(String, Boolean)	Verifies whether the specified server item is mapped and not cloaked.
	Map	Maps the specified server path to a location on the local disk.
	MatchName	Compares two workspace names.
	MatchOwnerName	Compares the names of two workspace owners.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Merge(String, String, VersionSpec, VersionSpec)	Merges the source to the target.
	Merge(ItemSpec, String, VersionSpec, VersionSpec, LockLevel, MergeOptionsEx)	Merges the source to the target.
	Merge(String, String, VersionSpec, VersionSpec, LockLevel, RecursionType, MergeOptions)	Merges the source to the target.
	Merge(String, String, VersionSpec, VersionSpec, LockLevel, RecursionType, MergeOptionsEx)	Merges the source to the target.
	Merge(ItemSpec, String, VersionSpec, VersionSpec, LockLevel, MergeOptionsEx, array<String[])	Merges the source to the target.
	MergeContent	Merges content based on the requested conflict.
	PendAdd(String)	Queues files or a folder for addition to the version-control repository.
	PendAdd(array<String[])	Queues files or folders for addition to the version-control repository.
	PendAdd(String, Boolean)	Queues files, folders, and subitems for addition to the version-control repository.
	PendAdd(array<String[], Boolean)	Queues files or folders for addition to the version-control repository.
	PendAdd(array<String[], Boolean, String, LockLevel)	Queues files or folders for addition to the version-control repository.
	PendAdd(array<String[], Boolean, String, LockLevel, Boolean)	Queues files or folders for addition to the version-control repository.
	PendAdd(array<String[], Boolean, String, LockLevel, Boolean, Boolean)	Queues files or folders for addition to the version-control repository.
	PendBranch(String, String, VersionSpec)	Schedules a file or folder for branching.
	PendBranch(String, String, VersionSpec, LockLevel, Boolean)	Schedules a file or folder for branching.
	PendBranch(String, String, VersionSpec, LockLevel, Boolean, Boolean)	Schedules a file or folder for branching.
	PendBranch(String, String, VersionSpec, LockLevel, Boolean, Boolean, Boolean)	Schedules a file or folder for branching.
	PendDelete(String)	Queues files or folders for deletion from the version-control repository.
	PendDelete(array<String[])	Queues files or folders for deletion from the version-control repository.
	PendDelete(String, RecursionType)	Queues files or folders for deletion from the version-control repository.
	PendDelete(array<String[], RecursionType)	Queues files or folders for deletion from the version-control repository.
	PendDelete(array<String[], RecursionType, LockLevel)	Queues files or folders for deletion from the version-control repository.
	PendDelete(array<String[], RecursionType, LockLevel, Boolean)	Queues files or folders for deletion from the version-control repository.
	PendDelete(array<String[], RecursionType, LockLevel, Boolean, Boolean)	Queues files or folders for deletion from the version-control repository.
	PendDelete(array<String[], RecursionType, LockLevel, Boolean, Boolean, array<String[])	Queues files or folders for deletion from the version-control repository.
	PendEdit(String)	Checks out files for editing from the version-control repository.
	PendEdit(array<String[])	Checks out files for editing from the version-control repository.
	PendEdit(String, RecursionType)	Checks out files for editing from the version-control repository.
	PendEdit(array<String[], RecursionType)	Checks out files for editing from the version-control repository.
	PendEdit(array<String[], RecursionType, String, LockLevel)	Checks out files for editing from the version-control repository.
	PendEdit(array<String[], RecursionType, String, LockLevel, Boolean)	Checks out files for editing from the version-control repository.
	PendEdit(array<String[], RecursionType, String, LockLevel, Boolean, PendChangesOptions)	Checks out files for editing from the version-control repository.
	PendEdit(array<String[], RecursionType, String, LockLevel, Boolean, PendChangesOptions, array<String[])	Checks out files for editing from the version-control repository.
	PendRename(String, String)	Moves or renames a file or directory.
	PendRename(String, String, LockLevel, Boolean, Boolean)	Moves or renames a file or directory.
	PendRename(String, String, LockLevel, Boolean, Boolean, Boolean)	Moves or renames a file or directory.
	PendRename(String, String, LockLevel, Boolean, Boolean, Boolean, array<String[])	Moves or renames a file or directory.
	PendUndelete(String, Int32)	Queues deleted files or folders for restoration to the version-control repository.
	PendUndelete(String, Int32, String)	Queues deleted files or folders for restoration to the version-control repository.
	PendUndelete(array<ItemSpec[], LockLevel, Boolean)	Queues deleted files or folders for restoration to the version-control repository.
	PendUndelete(array<ItemSpec[], LockLevel, Boolean, Boolean)	Queues deleted files or folders for restoration from the version-control repository.
	PendUndelete(String, Int32, String, LockLevel, Boolean)	Queues deleted files or folders for restoration to the version-control repository.
	PendUndelete(array<ItemSpec[], LockLevel, Boolean, Boolean, Boolean)	Queues deleted files or folders for restoration to the version-control repository.
	PendUndelete(String, Int32, String, LockLevel, Boolean, Boolean)	Queues deleted files or folders for restoration to the version-control repository.
	PendUndelete(String, Int32, String, LockLevel, Boolean, Boolean, Boolean)	Queues deleted files or folders for restoration to the version-control repository.
	PendUndelete(String, Int32, String, LockLevel, Boolean, Boolean, Boolean, array<String[])	Queues deleted files or folders for restoration to the version-control repository.
	QueryConflicts	Gets the array of conflicts that match the specified path filters.
	QueryPendingSets(array<ItemSpec[], String, String, Boolean)	Gets the pending changes for the specified query.
	QueryPendingSets(array<String[], RecursionType, String, String, Boolean)	Gets the pending changes for the specified query.
	QueryShelvedChanges(String, String, array<ItemSpec[])	Gets the shelved changes for the specified query.
	QueryShelvedChanges(String, String, array<ItemSpec[], Boolean)	Gets the shelved changes for the specified query.
	Refresh	Refreshes this Workspace instance from the server.
	RefreshIfNeeded	Refreshes 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.
	RefreshMappings	Obsolete. Gets the current set of mappings for this Workspace instance from the server.
	RemoveLocalConflict	Removes a local conflict from the list of conflicts on the server for this workspace.
	ResolveConflict(Conflict)	Attempt to resolve a conflict based on its Resolution property.
	ResolveConflict(Conflict, array<Conflict[]%)	Attempt to resolve a conflict based on its Resolution property.
	ResolveConflict(Conflict, array<Conflict[]%, array<String[])	Attempt to resolve a conflict based on its Resolution property.
	Rollback(VersionSpec, VersionSpec, LockLevel, RollbackOptions)	Pends a rollback for all changes between the specified versions.
	Rollback(array<String[], RecursionType, VersionSpec, VersionSpec, VersionSpec, LockLevel, RollbackOptions, array<String[])	Pends a rollback for changes on a certain path, within the specified versions.
	SetLock(String, LockLevel)	Applies the selected lock level to the specified path.
	SetLock(array<String[], LockLevel)	Applies the selected lock level to the specified paths.
	SetLock(String, LockLevel, RecursionType)	Applies the selected lock level to the specified path.
	SetLock(array<String[], LockLevel, RecursionType)	Applies the selected lock level to the specified paths.
	SetLock(array<String[], LockLevel, RecursionType, Boolean)	Applies the selected lock level to the specified paths.
	SetLock(array<String[], LockLevel, RecursionType, Boolean, array<String[])	Applies the selected lock level to the specified paths.
	SetPendingChangeProperty	Sets properties on existing pending changes.
	Shelve	Collects a set of pending changes and shelves them to the server.
	ToString	Creates a user-readable string that describes the properties of this workspace. (Overrides Object.ToString().)
	TryGetLocalItemForServerItem(String)	Gets the corresponding local item for the specified server item.
	TryGetLocalItemForServerItem(String, Boolean)	Gets the corresponding local item for the specified server item.
	TryGetServerItemForLocalItem(String)	Gets the corresponding server item for the specified local item. Does not throw exceptions.
	TryGetServerItemForLocalItem(String, array<WorkingFolder[])	Gets the corresponding server item for the specified local item.
	TryGetWorkingFolderForLocalItem	Gets a WorkingFolder instance that describes how the local item is mapped in the workspace.
	TryGetWorkingFolderForServerItem(String)	Gets a WorkingFolder instance that describes how the specified WorkingFolder objects map the server item.
	TryGetWorkingFolderForServerItem(String, array<WorkingFolder[])	Gets a WorkingFolder instance that describes how the specified WorkingFolder objects map the server item.
	TryGetWorkingFolderForServerItem(String, array<WorkingFolder[], Boolean)	Gets a WorkingFolder instance that describes how the specified WorkingFolder objects map the server item.
	Undo(String)	Revert the pending changes for the specified item.
	Undo(array<String[])	Revert the pending changes for the specified items.
	Undo(array<ItemSpec[])	Revert the pending changes for the specified items.
	Undo(array<PendingChange[])	Revert the pending changes for the specified items.
	Undo(String, RecursionType)	Revert the pending changes for the specified items.
	Undo(array<String[], RecursionType)	Revert the pending changes for the specified items.
	Undo(array<String[], Boolean)	Revert the pending changes for the specified items.
	Undo(array<ItemSpec[], Boolean)	Revert the pending changes for the specified items.
	Undo(array<String[], RecursionType, Boolean)	Revert the pending changes for the specified items.
	Undo(array<ItemSpec[], Boolean, array<String[])	Revert the pending changes for the specified items.
	Unshelve(String, String)	Reproduces in this workspace a set of pending changes that have been previously shelved to the server.
	Unshelve(String, String, array<ItemSpec[])	Reproduces in this workspace a set of pending changes that have been previously shelved to the server.
	Unshelve(String, String, array<ItemSpec[], array<PendingChange[]%)	Reproduces in this workspace a set of pending changes that have been previously shelved to the server.
	Unshelve(String, String, array<ItemSpec[], array<PendingChange[]%, array<String[])	Reproduces in this workspace a set of pending changes that have been previously shelved to the server.
	Update(String, String, array<WorkingFolder[])	Updates the properties of a workspace.
	Update(String, String, array<WorkingFolder[], Boolean)	Update the properties of a workspace.
	Update(String, String, String, array<WorkingFolder[], Boolean)	Updates the properties of a workspace.
	Update(String, String, String, String, array<WorkingFolder[], WorkspacePermissionProfile, Boolean)	Updates the properties of a workspace.
	UpdateComputerName	Updates the name of the computer in the repository.
	UpdateLastSavedCheckin(Shelveset)	Updates the information from the most recent attempted check-in with the information from the shelveset.
	UpdateLastSavedCheckin(Shelveset, array<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

Explicit Interface Implementations

	Name	Description
	IComparable.CompareTo	Compares two workspace objects, comparing first the repository URLs, then the workspace names, and finally the owners.

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.VersionControl.Client Namespace