Package com.slack.api.methods.request.conversations

Class ConversationsListRequest.ConversationsListRequestBuilder

java.lang.Object

com.slack.api.methods.request.conversations.ConversationsListRequest.ConversationsListRequestBuilder

Enclosing class:

ConversationsListRequest

public static class ConversationsListRequest.ConversationsListRequestBuilder
extends Object

Method Summary

Modifier and Type	Method	Description
ConversationsListRequest	build()
ConversationsListRequest.ConversationsListRequestBuilder	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`.
ConversationsListRequest.ConversationsListRequestBuilder	excludeArchived(boolean excludeArchived)	Set to `true` to exclude archived channels from the list
ConversationsListRequest.ConversationsListRequestBuilder	limit(Integer limit)	The maximum number of items to return.
ConversationsListRequest.ConversationsListRequestBuilder	token(String token)	Authentication token.
String	toString()
ConversationsListRequest.ConversationsListRequestBuilder	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`

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

token

public ConversationsListRequest.ConversationsListRequestBuilder token(String token)

Authentication token. Requires scope: `conversations:read`

Returns:

this.

cursor

public ConversationsListRequest.ConversationsListRequestBuilder 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.

excludeArchived

public ConversationsListRequest.ConversationsListRequestBuilder excludeArchived(boolean excludeArchived)

Set to `true` to exclude archived channels from the list

Returns:

this.

limit

public ConversationsListRequest.ConversationsListRequestBuilder 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 list hasn't been reached. Must be an integer no larger than 1000.

Returns:

this.

types

public ConversationsListRequest.ConversationsListRequestBuilder 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.

build

public ConversationsListRequest build()

toString

public String toString()

Overrides:

toString in class Object