Workspace Class

System.Object
  Microsoft.TeamFoundation.VersionControl.Server.Workspace

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

[RequiredClientServiceAttribute("VersionControlServer")]
[CallOnDeserializationAttribute("AfterDeserialize")]
public class Workspace : IRecordable

The Workspace type exposes the following members.

  NameDescription
Public methodWorkspaceDefault constructor for marshaling.
Top

  NameDescription
Public propertyCommentComment describing the workspace. May be null or empty. NOTE: XML will normalize all line endings to LF (\n).
Public propertyComputerName of the computer which this workspace belongs to.
Public propertyEffectivePermissionsThis field is populated only when it sends this Workspace over the wire back to the client. It contains the effective WorkspacePermissions of the user who called the relevant webmethod: CreateWorkspace, UpdateWorkspace, QueryWorkspace, QueryWorkspaces. This field is populated by using the static method Workspace.PopulateEffectivePermissionsForUser. It should not be relied upon for security evaluation except immediately after populating the value with PopulateEffectivePermissionsForUser. Otherwise, use one of HasWorkspacePermission or CheckWorkspacePermission on the SecurityManager.
Public propertyFoldersArray of this workspace's working folder mappings. This property is not guaranteed to return folders that are up to date with the database. If up to date mappings are needed then GetUpToDateFolders should be called.
Public propertyIsLocalTrue if the workspace is a local workspace. False if the workspace is a server workspace (traditional workspace).
Public propertyLastAccessDateThis is the date to the day resolution of the last time the workspace has been accessed.
Public propertyNameWorkspace name. Must be unique for a given OwnerName.
Public propertyOptions
Public propertyOwnerAliases
Public propertyOwnerDisplayNameDisplay name of the user who owns this workspace.
Public propertyOwnerIdentifier
Public propertyOwnerIdentityTypeThis uses the Framework server class IdentityDescriptor to send back an IdentityDescriptor for use in the client.To not break Whidbey compatibility --- with regard to a Whidbey XML deserialization bug, this relies on IdentityDescriptor not having any sub-elements and not having an end element (short form). Thus, it should be of the form: "".
Public propertyOwnerNameIdentity name of the user who owns this workspace. Should be of the form DOMAIN\username.
Public propertyOwnerUniqueNameUnique name of the user who owns this workspace.
Public propertySecurityTokenSecurity token for the workspace namespace that uses the security service.
Top

  NameDescription
Public methodEqualsDetermines whether the specified object is equal to the current object. (Inherited from Object.)
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 methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodGetUpToDateFoldersArray of this workspace's working folder mappings that are guaranteed to be up to date with what is in the database.
Public methodLocalItemToWorkingFolderReturns a new WorkingFolder object which describes how a given local path is mapped in the workspace. The paths of the constructed WorkingFolder will match the given item exactly; that is, the WorkingFolder object is not necessarily a duplicate of one of the WorkingFolder objects in the Folders collection.
Public methodLocalToServerItemTranslates a local item to a server item based on the workspace's working folders. If honorCloaks is true, a cloaked item will give you an ItemCloakedException. If honorCloaks is false, a cloaked item will return null. An unmapped item will always give you an ItemNotMappedException.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodRecordInformationIRecordable.RecordInformation Record class information for logging.
Public methodServerItemToWorkingFolderReturns a new WorkingFolder object which describes how a given server path is mapped in the workspace. The paths of the constructed WorkingFolder will match the given item exactly; that is, the WorkingFolder object is not necessarily a duplicate of one of the WorkingFolder objects in the Folders collection.
Public methodServerToLocalItemTranslates a server item to a localitem item based on the workspace's working folders. If honorCloaks is true, a cloaked item will give you an ItemCloakedException. If honorCloaks is false, a cloaked item will return null. An unmapped item will always give you an ItemNotMappedException.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
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.
Show: