TeamFoundationIdentity Class

Client implementation of TeamFoundationIdentity. Augments proxy generated class

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

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

public sealed class TeamFoundationIdentity

The TeamFoundationIdentity type exposes the following members.

  NameDescription
Public propertyDescriptorThe 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 propertyDisplayNameFull 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 propertyIsActiveIndicates 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 propertyIsContainerIndicates that the identity is a group, possibly containing other identities as members.
Public propertyMemberOfIdentityDescriptors for groups containing this identity.
Public propertyMembersIdentityDescriptors for members of this identity.
Public propertyTeamFoundationIdIdentifier assigned within TFS - unique throughout a host. TFS artifacts are either associated with this identifier or the identity's Descriptor.
Public propertyUniqueName
Public propertyUniqueUserIdThis represents the ID to distinguish deleted accounts from each other (for example: joe:1 vs. joe:3).
Top

  NameDescription
Public methodEqualsDetermines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodGetAttributeAttribute accessor. Will return the caller supplied default value if attribute is not present (will not throw).
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetProperties()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 methodGetProperties(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 methodGetProperty(String)Property accessor. Will throw if not found.
Public methodGetProperty(IdentityPropertyScope, String)Property accessor. Will throw if not found.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodRemoveProperty(String)Remove property, if it exists.
Public methodRemoveProperty(IdentityPropertyScope, String)Remove property, if it exists.
Public methodSetProperty(String, Object)Sets a property, will overwrite if already set.
Public methodSetProperty(IdentityPropertyScope, String, Object)Sets a property, will overwrite if already set.
Public methodToString (Overrides Object.ToString().)
Public methodTryGetProperty(String, Object)Property accessor. Will return null if not found.
Public methodTryGetProperty(IdentityPropertyScope, String, Object)Property accessor. Will return null if not found.
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: