Class UsersListRequest.UsersListRequestBuilder
- java.lang.Object
-
- com.slack.api.methods.request.users.UsersListRequest.UsersListRequestBuilder
-
- Enclosing class:
- UsersListRequest
public static class UsersListRequest.UsersListRequestBuilder extends Object
-
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description UsersListRequest
build()
UsersListRequest.UsersListRequestBuilder
cursor(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`.UsersListRequest.UsersListRequestBuilder
includeLocale(boolean includeLocale)
Set this to `true` to receive the locale for users.UsersListRequest.UsersListRequestBuilder
limit(Integer limit)
The maximum number of items to return.UsersListRequest.UsersListRequestBuilder
presence(boolean presence)
Deprecated.UsersListRequest.UsersListRequestBuilder
teamId(String teamId)
Required for org-wide apps.UsersListRequest.UsersListRequestBuilder
token(String token)
Authentication token.String
toString()
-
-
-
Method Detail
-
token
public UsersListRequest.UsersListRequestBuilder token(String token)
Authentication token. Requires scope: `users:read`- Returns:
this
.
-
cursor
public UsersListRequest.UsersListRequestBuilder cursor(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.- Returns:
this
.
-
limit
public UsersListRequest.UsersListRequestBuilder limit(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.- Returns:
this
.
-
includeLocale
public UsersListRequest.UsersListRequestBuilder includeLocale(boolean includeLocale)
Set this to `true` to receive the locale for users. Defaults to `false`- Returns:
this
.
-
presence
@Deprecated public UsersListRequest.UsersListRequestBuilder presence(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.- Returns:
this
.
-
teamId
public UsersListRequest.UsersListRequestBuilder teamId(String teamId)
Required for org-wide apps.- Returns:
this
.
-
build
public UsersListRequest build()
-
-