Class UsersListRequest
- java.lang.Object
-
- com.slack.api.methods.request.users.UsersListRequest
-
- All Implemented Interfaces:
SlackApiRequest
public class UsersListRequest extends Object implements SlackApiRequest
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
UsersListRequest.UsersListRequestBuilder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static UsersListRequest.UsersListRequestBuilder
builder()
protected boolean
canEqual(Object other)
boolean
equals(Object o)
String
getCursor()
Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`.Integer
getLimit()
The maximum number of items to return.String
getTeamId()
Required for org-wide apps.String
getToken()
Authentication token.int
hashCode()
boolean
isIncludeLocale()
Set this to `true` to receive the locale for users.boolean
isPresence()
Deprecated.void
setCursor(String cursor)
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
setLimit(Integer limit)
The maximum number of items to return.void
setPresence(boolean presence)
Deprecated.void
setTeamId(String teamId)
Required for org-wide apps.void
setToken(String token)
Authentication token.String
toString()
-
-
-
Method Detail
-
builder
public static UsersListRequest.UsersListRequestBuilder builder()
-
getToken
public String getToken()
Authentication token. Requires scope: `users:read`- Specified by:
getToken
in interfaceSlackApiRequest
-
getCursor
public String 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
public Integer 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 public boolean 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
public String getTeamId()
Required for org-wide apps.
-
setToken
public void setToken(String token)
Authentication token. Requires scope: `users:read`
-
setCursor
public void setCursor(String cursor)
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
public void setLimit(Integer limit)
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 public void setPresence(boolean presence)
Deprecated.Deprecated. Whether to include presence data in the output. Defaults to `false`. Setting this to `true` reduces performance, especially with large teams.
-
setTeamId
public void setTeamId(String teamId)
Required for org-wide apps.
-
canEqual
protected boolean canEqual(Object other)
-
-