|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IIdentityManagementService2
Method Summary | |
---|---|
void |
addRecentUser(TeamFoundationIdentity identity)
Adds the specified identity to MRU list of users for the current user. |
void |
clearCustomDisplayName()
Clears the custom display name for the current user, returning to using the display name from the external identity provider (Active Directory, Live, etc). |
TeamFoundationIdentity[] |
getMostRecentlyUsedUsers()
Get the set of identities which have been recently accessed by the current user |
TeamFoundationIdentity[] |
listApplicationGroups(java.lang.String scopeId,
ReadIdentityOptions readOptions,
java.lang.String[] propertyNameFilters,
IdentityPropertyScope propertyScope)
Lists all TFS application groups within the specified scope |
FilteredIdentitiesList |
readFilteredIdentities(java.lang.String expression,
int suggestedPageSize,
java.lang.String lastSearchResult,
boolean lookForward,
int queryMembership)
ReadFilteredIdentities is used to retrieve a set of identities based on an expression. |
TeamFoundationIdentity[] |
readIdentities(com.microsoft.tfs.util.GUID[] teamFoundationIds,
MembershipQuery queryMembership,
ReadIdentityOptions readOptions,
java.lang.String[] propertyNameFilters,
IdentityPropertyScope propertyScope)
Read identities by Team Foundation Id. |
TeamFoundationIdentity[] |
readIdentities(IdentityDescriptor[] descriptors,
MembershipQuery queryMembership,
ReadIdentityOptions readOptions,
java.lang.String[] propertyNameFilters,
IdentityPropertyScope propertyScope)
Read identities for given descriptors. |
TeamFoundationIdentity[][] |
readIdentities(IdentitySearchFactor searchFactor,
java.lang.String[] searchFactorValues,
MembershipQuery queryMembership,
ReadIdentityOptions readOptions,
java.lang.String[] propertyNameFilters,
IdentityPropertyScope propertyScope)
Read identities based on search factor. |
TeamFoundationIdentity |
readIdentity(IdentityDescriptor descriptor,
MembershipQuery queryMembership,
ReadIdentityOptions readOptions,
java.lang.String[] propertyNameFilters,
IdentityPropertyScope propertyScope)
Overload that takes a single descriptor. |
TeamFoundationIdentity |
readIdentity(IdentitySearchFactor searchFactor,
java.lang.String searchFactorValue,
MembershipQuery queryMembership,
ReadIdentityOptions readOptions,
java.lang.String[] propertyNameFilters,
IdentityPropertyScope propertyScope)
Overload that takes a single search factor and returns match following this order. |
TeamFoundationIdentity |
readIdentity(java.lang.String generalSearchValue)
Read an identity using the General search factor. |
void |
setCustomDisplayName(java.lang.String customDisplayName)
Sets the display name for the current user in a sticky manner, overriding any display name returned by an external identity provider (Active Directory, Live, etc). |
void |
updateExtendedProperties(TeamFoundationIdentity identity)
Save changes to extended properties. |
Methods inherited from interface com.microsoft.tfs.core.clients.webservices.IIdentityManagementService |
---|
addMemberToApplicationGroup, createApplicationGroup, deleteApplicationGroup, getIdentityDomainScope, getScopeName, isMember, isOwnedWellKnownGroup, isOwner, listApplicationGroups, readIdentities, readIdentities, readIdentities, readIdentity, readIdentity, refreshIdentity, removeMemberFromApplicationGroup, updateApplicationGroup |
Method Detail |
---|
TeamFoundationIdentity[] getMostRecentlyUsedUsers()
void addRecentUser(TeamFoundationIdentity identity)
TeamFoundationIdentity readIdentity(java.lang.String generalSearchValue)
Equivalent to ReadIdentity(IdentitySearchFactor.General, generalSearchValue, MembershipQuery.None, ReadIdentityOptions.None).
You can use this to find an identity by one of the following properties:
generalSearchValue
- The search string
FilteredIdentitiesList readFilteredIdentities(java.lang.String expression, int suggestedPageSize, java.lang.String lastSearchResult, boolean lookForward, int queryMembership)
expression
- suggestedPageSize
- lastSearchResult
- lookForward
- queryMembership
-
void setCustomDisplayName(java.lang.String customDisplayName)
TFS 2010 would automatically disambiguate users with the same display name by appending the domain and account name. TFS 2012 does not disambiguate display names. SetCustomDisplayName can be used instead to make a display name unique.
"John Q. Smith, Sr."
"John Smith (Contoso, Human Resources)"
customDisplayName
- The new display namevoid clearCustomDisplayName()
void updateExtendedProperties(TeamFoundationIdentity identity)
identity
- Identity with extended property changesTeamFoundationIdentity[] readIdentities(IdentityDescriptor[] descriptors, MembershipQuery queryMembership, ReadIdentityOptions readOptions, java.lang.String[] propertyNameFilters, IdentityPropertyScope propertyScope)
descriptors
- descriptors (descriptor is identity type + identifier)queryMembership
- none, direct or expanded membership informationreadOptions
- read options, such as reading from sourcepropertyNameFilters
- propertyScope
-
TeamFoundationIdentity readIdentity(IdentityDescriptor descriptor, MembershipQuery queryMembership, ReadIdentityOptions readOptions, java.lang.String[] propertyNameFilters, IdentityPropertyScope propertyScope)
descriptor
- identity type + identifierqueryMembership
- none, direct or expanded membership informationreadOptions
- read options, such as reading from sourcepropertyNameFilters
- propertyScope
-
TeamFoundationIdentity[] readIdentities(com.microsoft.tfs.util.GUID[] teamFoundationIds, MembershipQuery queryMembership, ReadIdentityOptions readOptions, java.lang.String[] propertyNameFilters, IdentityPropertyScope propertyScope)
teamFoundationIds
- identity idsqueryMembership
- none, direct or expanded membership informationreadOptions
- propertyNameFilters
- propertyScope
-
TeamFoundationIdentity[][] readIdentities(IdentitySearchFactor searchFactor, java.lang.String[] searchFactorValues, MembershipQuery queryMembership, ReadIdentityOptions readOptions, java.lang.String[] propertyNameFilters, IdentityPropertyScope propertyScope)
searchFactor
- how search is specified (by account name, etc.)searchFactorValues
- actual search strings (account names, etc.)queryMembership
- none, direct or expanded membership informationreadOptions
- readOptions, such as reading from source
TeamFoundationIdentity readIdentity(IdentitySearchFactor searchFactor, java.lang.String searchFactorValue, MembershipQuery queryMembership, ReadIdentityOptions readOptions, java.lang.String[] propertyNameFilters, IdentityPropertyScope propertyScope)
searchFactor
- how search is specified (by account name, etc.)searchFactorValue
- actual search string (account name, etc.)queryMembership
- none, direct or expanded membership informationreadOptions
- readOptions, such as reading from source
TeamFoundationIdentity[] listApplicationGroups(java.lang.String scopeId, ReadIdentityOptions readOptions, java.lang.String[] propertyNameFilters, IdentityPropertyScope propertyScope)
scopeId
- Scope Uri, specifying whether group scope is project level or
global to this host. Null or empty value signifies global scopereadOptions
- read optionspropertyNameFilters
- extended properties to retrieve with application groupspropertyScope
- indicates where to read extended properties from
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |