Class UserSearchRequest
- java.lang.Object
-
- com.atlassian.confluence.internal.user.SearchRequest
-
- com.atlassian.confluence.internal.user.UserSearchRequest
-
public class UserSearchRequest extends SearchRequest
Search for users.Supports simple search, with
getSearchTerm(), and advanced search, withgetUsernameTerm(),getEmailTerm()andgetFullnameTerm(). Note that emailTerm will only be used when searching ifisShowEmail()is enabled.All term fields support comma delimited strings with wildcard prefixes and suffixes.
- Since:
- 5.9
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static UserSearchRequestBuilderbuilder()StringgetEmailTerm()StringgetFullnameTerm()StringgetSearchTerm()StringgetUsernameTerm()booleanisShowEmail()booleanisSimpleSearch()-
Methods inherited from class com.atlassian.confluence.internal.user.SearchRequest
isShowUnlicensedUsers
-
-
-
-
Method Detail
-
isSimpleSearch
public boolean isSimpleSearch()
-
getSearchTerm
public String getSearchTerm()
-
getUsernameTerm
public String getUsernameTerm()
-
getEmailTerm
public String getEmailTerm()
-
getFullnameTerm
public String getFullnameTerm()
-
isShowEmail
public boolean isShowEmail()
-
builder
public static UserSearchRequestBuilder builder()
-
-