Class UsersConversationsRequest.UsersConversationsRequestBuilder
java.lang.Object
com.slack.api.methods.request.users.UsersConversationsRequest.UsersConversationsRequestBuilder
- Enclosing class:
- UsersConversationsRequest
public static class UsersConversationsRequest.UsersConversationsRequestBuilder extends Object
-
Method Summary
Modifier and Type Method Description UsersConversationsRequest
build()
UsersConversationsRequest.UsersConversationsRequestBuilder
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`.UsersConversationsRequest.UsersConversationsRequestBuilder
excludeArchived(boolean excludeArchived)
Set to `true` to exclude archived channels from the listUsersConversationsRequest.UsersConversationsRequestBuilder
limit(Integer limit)
The maximum number of items to return.UsersConversationsRequest.UsersConversationsRequestBuilder
teamId(String teamId)
Required for org-wide apps.UsersConversationsRequest.UsersConversationsRequestBuilder
token(String token)
Authentication token.String
toString()
UsersConversationsRequest.UsersConversationsRequestBuilder
types(List<ConversationType> types)
Mix and match channel types by providing a comma-separated list of any combination of `public_channel`, `private_channel`, `mpim`, `im`UsersConversationsRequest.UsersConversationsRequestBuilder
user(String user)
Browse conversations by a specific user ID's membership.
-
Method Details
-
token
Authentication token. Requires scope: `conversations:read`- Returns:
this
.
-
user
Browse conversations by a specific user ID's membership. Non-public channels are restricted to those where the calling user shares membership."- Returns:
this
.
-
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
.
-
excludeArchived
public UsersConversationsRequest.UsersConversationsRequestBuilder excludeArchived(boolean excludeArchived)Set to `true` to exclude archived channels from the list- Returns:
this
.
-
limit
The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached. Must be an integer no larger than 1000.- Returns:
this
.
-
types
public UsersConversationsRequest.UsersConversationsRequestBuilder types(List<ConversationType> types)Mix and match channel types by providing a comma-separated list of any combination of `public_channel`, `private_channel`, `mpim`, `im`- Returns:
this
.
-
teamId
Required for org-wide apps.- Returns:
this
.
-
build
-
toString
-