Class ChannelsListRequest.ChannelsListRequestBuilder
java.lang.Object
com.slack.api.methods.request.channels.ChannelsListRequest.ChannelsListRequestBuilder
- Enclosing class:
- ChannelsListRequest
public static class ChannelsListRequest.ChannelsListRequestBuilder extends Object
-
Method Summary
Modifier and Type Method Description ChannelsListRequest
build()
ChannelsListRequest.ChannelsListRequestBuilder
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`.ChannelsListRequest.ChannelsListRequestBuilder
excludeArchived(boolean excludeArchived)
Exclude archived channels from the listChannelsListRequest.ChannelsListRequestBuilder
excludeMembers(boolean excludeMembers)
Exclude the `members` collection from each `channel`ChannelsListRequest.ChannelsListRequestBuilder
limit(Integer limit)
The maximum number of items to return.ChannelsListRequest.ChannelsListRequestBuilder
teamId(String teamId)
Required for org-wide apps.ChannelsListRequest.ChannelsListRequestBuilder
token(String token)
Authentication token.String
toString()
-
Method Details
-
token
Authentication token. Requires scope: `channels:read`- Returns:
this
.
-
excludeMembers
Exclude the `members` collection from each `channel`- 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
.
-
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
.
-
excludeArchived
Exclude archived channels from the list- Returns:
this
.
-
teamId
Required for org-wide apps.- Returns:
this
.
-
build
-
toString
-