Package com.mypurecloud.sdk.v2.model

Class UserSearchRequest

java.lang.Object

com.mypurecloud.sdk.v2.model.UserSearchRequest

All Implemented Interfaces:

Serializable

public class UserSearchRequest
extends Object
implements Serializable

UserSearchRequest

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	UserSearchRequest.IntegrationPresenceSourceEnum	Gets an integration presence for users instead of their defaults.
static enum	UserSearchRequest.SortOrderEnum	The sort order for results

Constructor Summary

Constructors

Constructor	Description
UserSearchRequest()
UserSearchRequest(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
UserSearchRequest	enforcePermissions(Boolean enforcePermissions)	This property only applies to api/v2/user/search; when set to true add additional search criteria to filter users by: directory:user:view
boolean	equals(Object o)
UserSearchRequest	expand(List<String> expand)	Provides more details about a specified resource
Boolean	getEnforcePermissions()
List<String>	getExpand()
UserSearchRequest.IntegrationPresenceSourceEnum	getIntegrationPresenceSource()
Integer	getPageNumber()
Integer	getPageSize()
List<UserSearchCriteria>	getQuery()
List<SearchSort>	getSort()
String	getSortBy()
UserSearchRequest.SortOrderEnum	getSortOrder()
int	hashCode()
UserSearchRequest	integrationPresenceSource(UserSearchRequest.IntegrationPresenceSourceEnum integrationPresenceSource)	Gets an integration presence for users instead of their defaults.
UserSearchRequest	pageNumber(Integer pageNumber)	The page of resources you want to retrieve
UserSearchRequest	pageSize(Integer pageSize)	The number of results per page
UserSearchRequest	query(List<UserSearchCriteria> query)
void	setEnforcePermissions(Boolean enforcePermissions)
void	setExpand(List<String> expand)
void	setIntegrationPresenceSource(UserSearchRequest.IntegrationPresenceSourceEnum integrationPresenceSource)
void	setPageNumber(Integer pageNumber)
void	setPageSize(Integer pageSize)
void	setQuery(List<UserSearchCriteria> query)
void	setSort(List<SearchSort> sort)
void	setSortBy(String sortBy)
void	setSortOrder(UserSearchRequest.SortOrderEnum sortOrder)
UserSearchRequest	sort(List<SearchSort> sort)	Multi-value sort order, list of multiple sort values
UserSearchRequest	sortBy(String sortBy)	The field in the resource that you want to sort the results by
UserSearchRequest	sortOrder(UserSearchRequest.SortOrderEnum sortOrder)	The sort order for results
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

UserSearchRequest

public UserSearchRequest()

UserSearchRequest

public UserSearchRequest(Boolean initWithEmptyList)

Method Details

sortOrder

public UserSearchRequest sortOrder(UserSearchRequest.SortOrderEnum sortOrder)

The sort order for results

getSortOrder

public UserSearchRequest.SortOrderEnum getSortOrder()

setSortOrder

public void setSortOrder(UserSearchRequest.SortOrderEnum sortOrder)

sortBy

public UserSearchRequest sortBy(String sortBy)

The field in the resource that you want to sort the results by

getSortBy

public String getSortBy()

setSortBy

public void setSortBy(String sortBy)

pageSize

public UserSearchRequest pageSize(Integer pageSize)

The number of results per page

getPageSize

public Integer getPageSize()

setPageSize

public void setPageSize(Integer pageSize)

pageNumber

public UserSearchRequest pageNumber(Integer pageNumber)

The page of resources you want to retrieve

getPageNumber

public Integer getPageNumber()

setPageNumber

public void setPageNumber(Integer pageNumber)

sort

public UserSearchRequest sort(List<SearchSort> sort)

Multi-value sort order, list of multiple sort values

getSort

public List<SearchSort> getSort()

setSort

public void setSort(List<SearchSort> sort)

expand

public UserSearchRequest expand(List<String> expand)

Provides more details about a specified resource

getExpand

public List<String> getExpand()

setExpand

public void setExpand(List<String> expand)

query

public UserSearchRequest query(List<UserSearchCriteria> query)

getQuery

public List<UserSearchCriteria> getQuery()

setQuery

public void setQuery(List<UserSearchCriteria> query)

integrationPresenceSource

public UserSearchRequest integrationPresenceSource(UserSearchRequest.IntegrationPresenceSourceEnum integrationPresenceSource)

Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an \"expand\". When using this parameter the maximum number of users that can be returned is 100.

getIntegrationPresenceSource

public UserSearchRequest.IntegrationPresenceSourceEnum getIntegrationPresenceSource()

setIntegrationPresenceSource

public void setIntegrationPresenceSource(UserSearchRequest.IntegrationPresenceSourceEnum integrationPresenceSource)

enforcePermissions

public UserSearchRequest enforcePermissions(Boolean enforcePermissions)

This property only applies to api/v2/user/search; when set to true add additional search criteria to filter users by: directory:user:view

getEnforcePermissions

public Boolean getEnforcePermissions()

setEnforcePermissions

public void setEnforcePermissions(Boolean enforcePermissions)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object