Contains the necessary information required to perform a user search.
Type Template
<...>
<community>xs:long</community>
<!-- List of ... -->
<filters>
<!-- Contents of ProfileSearchFilter -->
<filters>
<keywords>xs:string</keywords>
<searchEmail>xs:boolean</searchEmail>
<searchName>xs:boolean</searchName>
<searchProfile>xs:boolean</searchProfile>
<searchUsername>xs:boolean</searchUsername>
<sort>xs:int</sort>
<...>Note: Element descriptions are split into information that's
relevant when you're creating an instance of this type and information
relevant when you're receiving an instance of it. Occasionally these
will differ.
Elements
| Element |
Description |
| community
|
- Setting
- Sets the community ID the user wants to find an expert in.
- Getting
|
| filters
|
- Setting
-
Sets a list of
ProfileSearchFilter
s used to filter user results for this query.
- Getting
-
Gets a list of
ProfileSearchFilter
s used to filter user results for this query.
|
| keywords
|
- Setting
- Sets the keywords for the user search.
- Getting
- Gets the keywords for the user search.
|
| searchEmail
|
- Setting
-
True if the user's email field is to be searched, false otherwise.
Note: The user's email field will not be searchable regardless of this value if
is false.
- Getting
-
Returns true if the user's email field is to be searched, false otherwise.
Note: The user's email field will not be searchable regardless of this value if
is false.
|
| searchName
|
- Setting
-
True if the user's name field is to be searched, false otherwise.
Note: The user's name field will not be searchable regardless of this value if
is false.
- Getting
-
Returns true if the user's name field is to be searched, false otherwise.
Note: The user's name field will not be searchable regardless of this value if
is false.
|
| searchProfile
|
- Setting
-
True if the user's profile field values are to be searched, false otherwise.
Note: The user's profile field values will not be searchable regardless of this value if
ProfileField.isVisibleToUsers()
is false.
- Getting
-
Returns true if the user's profile field values are to be searched, false otherwise.
Note: The user's profile field values will not be searchable regardless of this value if
ProfileField.isVisibleToUsers()
is false.
|
| searchUsername
|
- Setting
- True if the user's username field is to be searched, false otherwise.
- Getting
- Returns true if the user's username field is to be searched, false otherwise.
|
| sort
|
- Setting
-
Sets the
Sort
used for this query.
- Getting
-
Gets the sort used for this query. Defaults to
1 (SORT_BY_RELEVANCE)
.
|