TeamFoundationIdentity Class

Article
11/19/2013

Represents a user or group in Team Foundation Server.

Inheritance Hierarchy

System.Object
Microsoft.TeamFoundation.Framework.Server.TeamFoundationIdentity

Namespace: Microsoft.TeamFoundation.Framework.Server
Assembly: Microsoft.TeamFoundation.Framework.Server (in Microsoft.TeamFoundation.Framework.Server.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.

Constructors

	Name	Description
	TeamFoundationIdentity()	Parameterless constructor for marshaling.
	TeamFoundationIdentity(TeamFoundationIdentity)	Copy constructor.
	TeamFoundationIdentity(IdentityDescriptor, String, Boolean, ICollection<IdentityDescriptor>, ICollection<IdentityDescriptor>)	Constructor.

Top

Properties

	Name	Description
	AttributesSet	Property to marshal attributes.
	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].
	DisplayName	Full name of the identity for display purposes. The display name can come from the identity provider—like Active Directory or ACS—or may have been set as a custom display name within TFS.
	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. Use the [IsMember] query to answer that.
	IsContainer	Determines if this identity contains identities—that is, is it a group?
	LocalPropertiesSet
	MemberOf
	MemberOfSet	Identity descriptors for groups that contain this identity.
	Members
	MembersSet	Identity descriptors for members of this identity.
	PropertiesSet
	TeamFoundationId	Identifier assigned within TFS - unique throughout a host. TFS artifacts are either associated with this identifier or the identity's Descriptor.
	UniqueName
	UniqueUserId	This represents the ID to distinguish deleted accounts from each other (joe:1 versus joe:3).

Top

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	GetAttribute	Attribute accessor. Will return the caller-supplied default value if attribute is not present—will not throw.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	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.
	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.
	GetProperty(String)	Property accessor. Will throw if not found.
	GetProperty(IdentityPropertyScope, String)	Property accessor. Will throw if not found.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	PrepareForWebServiceSerialization	.NET XML serializer cannot handle dictionaries. Convert to array.
	RemoveProperty(String)	Remove property, if it exists.
	RemoveProperty(IdentityPropertyScope, String)	Remove property, if it exists.
	SetAttribute	Set an attribute. This method is obsolete; use [SetProperty] instead.
	SetProperty(String, Object)	Sets a property; will overwrite if a property is already set.
	SetProperty(IdentityPropertyScope, String, Object)	Sets a property; will overwrite if a property is already set.
	ToString	(Overrides Object.ToString().)
	TryGetProperty(String, Object%)	Property accessor. Will return null if not found.
	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.

Share via