TeamFoundationIdentity Class

Client implementation of TeamFoundationIdentity. Augments proxy generated class

Inheritance Hierarchy

System.Object
Microsoft.TeamFoundation.Framework.Client.TeamFoundationIdentity

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

Syntax

'Declaration
Public NotInheritable Class TeamFoundationIdentity
public sealed class TeamFoundationIdentity
public ref class TeamFoundationIdentity sealed
[<Sealed>]
type TeamFoundationIdentity =  class end
public final class TeamFoundationIdentity

The TeamFoundationIdentity type exposes the following members.

Properties

Name Description
Public property Descriptor The identity descriptor for this identity. The unique identifier for the identity's provider. Clients send identification to the server when they authenticate with TFS. Used for many identity management tasks such as AddMemberToApplicationGroup and ReadIdentity. TFS artifacts are either associated with this identifier or the identity's TeamFoundationId.
Public property DisplayName Full name of the identity for display purposes. The display name can come from the identity provider (Active Directory, ACS) or may have been set as a custom display name within TFS.
Public property IsActive Indicates that the identity is "current" with the provider (that is either read from source or being synced). It does not mean that it is a member of TFS Valid Users group (the "IsMember" query should be used to answer that).
Public property IsContainer Indicates that the identity is a group, possibly containing other identities as members.
Public property MemberOf IdentityDescriptors for groups containing this identity.
Public property Members IdentityDescriptors for members of this identity.
Public property TeamFoundationId Identifier assigned within TFS - unique throughout a host. TFS artifacts are either associated with this identifier or the identity's Descriptor.
Public property UniqueName
Public property UniqueUserId This represents the ID to distinguish deleted accounts from each other (for example: joe:1 vs. joe:3).

Top

Methods

Name Description
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public method GetAttribute Attribute accessor. Will return the caller supplied default value if attribute is not present (will not throw).
Public method GetHashCode Serves as the default hash function. (Inherited from Object.)
Public method GetProperties() Property bag. This could be useful, for example if consumer has to iterate through current properties and modify / remove some based on pattern matching property names.
Public method GetProperties(IdentityPropertyScope) Property bag. This could be useful, for example if consumer has to iterate through current properties and modify / remove some based on pattern matching property names.
Public method GetProperty(String) Property accessor. Will throw if not found.
Public method GetProperty(IdentityPropertyScope, String) Property accessor. Will throw if not found.
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method RemoveProperty(String) Remove property, if it exists.
Public method RemoveProperty(IdentityPropertyScope, String) Remove property, if it exists.
Public method SetProperty(String, Object) Sets a property, will overwrite if already set.
Public method SetProperty(IdentityPropertyScope, String, Object) Sets a property, will overwrite if already set.
Public method ToString (Overrides Object.ToString().)
Public method TryGetProperty(String, Object%) Property accessor. Will return null if not found.
Public method TryGetProperty(IdentityPropertyScope, String, Object%) Property accessor. Will return null if not found.

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