|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.microsoft.tfs.core.clients.webservices.IdentityManagementService
com.microsoft.tfs.core.clients.webservices.IdentityManagementService2
public class IdentityManagementService2
A client for the TFS 2012 IdentityManagementService2.
Constructor Summary | |
---|---|
IdentityManagementService2(TFSConnection connection)
|
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 |
boolean |
isSupported()
|
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 class com.microsoft.tfs.core.clients.webservices.IdentityManagementService |
---|
addMemberToApplicationGroup, createApplicationGroup, deleteApplicationGroup, getIdentityDomainScope, getIdentityDomainScope, getScopeName, isMember, isOwnedWellKnownGroup, isOwner, listApplicationGroups, readIdentities, readIdentities, readIdentities, readIdentity, readIdentity, refreshIdentity, removeMemberFromApplicationGroup, updateApplicationGroup |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
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 |
Constructor Detail |
---|
public IdentityManagementService2(TFSConnection connection)
Method Detail |
---|
public boolean isSupported()
public TeamFoundationIdentity[] getMostRecentlyUsedUsers()
IIdentityManagementService2
getMostRecentlyUsedUsers
in interface IIdentityManagementService2
public void addRecentUser(TeamFoundationIdentity identity)
IIdentityManagementService2
addRecentUser
in interface IIdentityManagementService2
public FilteredIdentitiesList readFilteredIdentities(java.lang.String expression, int suggestedPageSize, java.lang.String lastSearchResult, boolean lookForward, int queryMembership)
IIdentityManagementService2
readFilteredIdentities
in interface IIdentityManagementService2
public TeamFoundationIdentity readIdentity(java.lang.String generalSearchValue)
IIdentityManagementService2
Equivalent to ReadIdentity(IdentitySearchFactor.General, generalSearchValue, MembershipQuery.None, ReadIdentityOptions.None).
You can use this to find an identity by one of the following properties:
readIdentity
in interface IIdentityManagementService2
generalSearchValue
- The search string
public TeamFoundationIdentity[] listApplicationGroups(java.lang.String scopeId, ReadIdentityOptions readOptions, java.lang.String[] propertyNameFilters, IdentityPropertyScope propertyScope)
IIdentityManagementService2
listApplicationGroups
in interface IIdentityManagementService2
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
public void setCustomDisplayName(java.lang.String customDisplayName)
IIdentityManagementService2
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)"
setCustomDisplayName
in interface IIdentityManagementService2
customDisplayName
- The new display namepublic void clearCustomDisplayName()
IIdentityManagementService2
clearCustomDisplayName
in interface IIdentityManagementService2
public TeamFoundationIdentity[] readIdentities(IdentityDescriptor[] descriptors, MembershipQuery queryMembership, ReadIdentityOptions readOptions, java.lang.String[] propertyNameFilters, IdentityPropertyScope propertyScope)
IIdentityManagementService2
readIdentities
in interface IIdentityManagementService2
descriptors
- descriptors (descriptor is identity type + identifier)queryMembership
- none, direct or expanded membership informationreadOptions
- read options, such as reading from source
public TeamFoundationIdentity readIdentity(IdentityDescriptor descriptor, MembershipQuery queryMembership, ReadIdentityOptions readOptions, java.lang.String[] propertyNameFilters, IdentityPropertyScope propertyScope)
IIdentityManagementService2
readIdentity
in interface IIdentityManagementService2
descriptor
- identity type + identifierqueryMembership
- none, direct or expanded membership informationreadOptions
- read options, such as reading from source
public TeamFoundationIdentity[] readIdentities(com.microsoft.tfs.util.GUID[] teamFoundationIds, MembershipQuery queryMembership, ReadIdentityOptions readOptions, java.lang.String[] propertyNameFilters, IdentityPropertyScope propertyScope)
IIdentityManagementService2
readIdentities
in interface IIdentityManagementService2
teamFoundationIds
- identity idsqueryMembership
- none, direct or expanded membership information
public TeamFoundationIdentity[][] readIdentities(IdentitySearchFactor searchFactor, java.lang.String[] searchFactorValues, MembershipQuery queryMembership, ReadIdentityOptions readOptions, java.lang.String[] propertyNameFilters, IdentityPropertyScope propertyScope)
IIdentityManagementService2
readIdentities
in interface IIdentityManagementService2
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
public TeamFoundationIdentity readIdentity(IdentitySearchFactor searchFactor, java.lang.String searchFactorValue, MembershipQuery queryMembership, ReadIdentityOptions readOptions, java.lang.String[] propertyNameFilters, IdentityPropertyScope propertyScope)
IIdentityManagementService2
readIdentity
in interface IIdentityManagementService2
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
public void updateExtendedProperties(TeamFoundationIdentity identity)
IIdentityManagementService2
updateExtendedProperties
in interface IIdentityManagementService2
identity
- Identity with extended property changes
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |