Class UsersListRequest
java.lang.Object
com.slack.api.methods.request.users.UsersListRequest
- All Implemented Interfaces:
SlackApiRequest
https://api.slack.com/methods/users.list
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
protected boolean
boolean
Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`.getLimit()
The maximum number of items to return.Required for org-wide apps.getToken()
Authentication token.int
hashCode()
boolean
Set this to `true` to receive the locale for users.boolean
Deprecated.void
Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`.void
setIncludeLocale
(boolean includeLocale) Set this to `true` to receive the locale for users.void
The maximum number of items to return.void
setPresence
(boolean presence) Deprecated.void
Required for org-wide apps.void
Authentication token.toString()
-
Method Details
-
builder
-
getToken
Authentication token. Requires scope: `users:read`- Specified by:
getToken
in interfaceSlackApiRequest
- Returns:
- token string value or null
-
getCursor
Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first \"page\" of the collection. See [pagination](/docs/pagination) for more detail. -
getLimit
The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached. -
isIncludeLocale
public boolean isIncludeLocale()Set this to `true` to receive the locale for users. Defaults to `false` -
isPresence
Deprecated.Deprecated. Whether to include presence data in the output. Defaults to `false`. Setting this to `true` reduces performance, especially with large teams. -
getTeamId
Required for org-wide apps. -
setToken
Authentication token. Requires scope: `users:read`- Specified by:
setToken
in interfaceSlackApiRequest
-
setCursor
Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first \"page\" of the collection. See [pagination](/docs/pagination) for more detail. -
setLimit
The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached. -
setIncludeLocale
public void setIncludeLocale(boolean includeLocale) Set this to `true` to receive the locale for users. Defaults to `false` -
setPresence
Deprecated.Deprecated. Whether to include presence data in the output. Defaults to `false`. Setting this to `true` reduces performance, especially with large teams. -
setTeamId
Required for org-wide apps. -
equals
-
canEqual
-
hashCode
public int hashCode() -
toString
-