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

Class ConversationsListRequest

java.lang.Object
com.slack.api.methods.request.conversations.ConversationsListRequest
All Implemented Interfaces:
SlackApiRequest
public class ConversationsListRequest extends Object implements SlackApiRequest
https://docs.slack.dev/reference/methods/conversations.list

  • Method Details

    • builder

      public static ConversationsListRequest.ConversationsListRequestBuilder builder()

    • getToken

      public String getToken()
      Authentication token. Requires scope: `conversations:read`
      Specified by:
      getToken in interface SlackApiRequest
      Returns:
      token string value or null

    • 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.

    • isExcludeArchived

      public boolean isExcludeArchived()
      Set to `true` to exclude archived channels from the list

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

    • getTypes

      public List<ConversationType> getTypes()
      Mix and match channel types by providing a comma-separated list of any combination of `public_channel`, `private_channel`, `mpim`, `im`

    • getTeamId

      public String getTeamId()
      Required for org-wide apps.

    • setToken

      public void setToken(String token)
      Authentication token. Requires scope: `conversations:read`
      Specified by:
      setToken in interface SlackApiRequest

    • 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.

    • setExcludeArchived

      public void setExcludeArchived(boolean excludeArchived)
      Set to `true` to exclude archived channels from the list

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

    • setTypes

      public void setTypes(List<ConversationType> types)
      Mix and match channel types by providing a comma-separated list of any combination of `public_channel`, `private_channel`, `mpim`, `im`

    • setTeamId

      public void setTeamId(String teamId)
      Required for org-wide apps.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object