public List<Person> search(...) - search for members
on a given site.
Attention: These methods were introduced with SDK version 1.3.
search
public List<Person> search(String filter, ListingContext
listingContext) - returns a paged list of members that reflects the specified
filter. Note that the filter defaults to matching the beginning of firstName, lastName and
userName if no property is passed in.
Attention: This method was introduced with SDK version 1.3.
Parameters
- String filter
- A string representing the property to filter on.
- ListingContext listingContext
- The listing context to use to control paging of results. See ListingContext for further information.
Returns
Returns a paged list of members.
Exception
Throws an UnsupportedMethodException if the method is not supported by the platform.
Example
search
public List<Person> search(String keyword) - returns
a list of members that reflects the specified keyword.
Attention: This method was introduced with SDK version 1.3.
Parameters
- String keyword
- A string representing the keyword on which to base the search. Note, the REST service used for this method (service/api/people?filter="") also allows you to search against properties such as location. Simply use the keyword pattern "propertyName:Value".
Returns
Returns a list of members.
Exception
Throws an UnsupportedMethodException if the method is not supported by the platform.
Example
search
public List<Person> search(String keyword, ListingContext
listingContext) - returns a paged list of members that reflects the specified
keyword.
Attention: This method was introduced with SDK version 1.3.
Parameters
- String keyword
- A string representing the keyword on which to base the search. Note, the REST service used for this method (service/api/people?filter="") also allows you to search against properties such as location. Simply use the keyword pattern "propertyName:Value".
- ListingContext listingContext
- The listing context to use to control paging of results. See ListingContext for further information.
Returns
Returns a paged list of members.
Exception
Throws an UnsupportedMethodException if the method is not supported by the platform.
Example