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 java.lang.Object
implements SlackApiRequest

  • Nested Class Summary

    Nested Classes 
    Modifier and Type Class Description
    static class  ConversationsListRequest.ConversationsListRequestBuilder  

  • Method Summary

    Modifier and Type Method Description
    static ConversationsListRequest.ConversationsListRequestBuilder builder()  
    protected boolean canEqual​(java.lang.Object other)  
    boolean equals​(java.lang.Object o)  
    java.lang.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`.
    java.lang.Integer getLimit()
    The maximum number of items to return.
    java.lang.String getTeamId()
    Required for org-wide apps.
    java.lang.String getToken()
    Authentication token.
    java.util.List<ConversationType> getTypes()
    Mix and match channel types by providing a comma-separated list of any combination of `public_channel`, `private_channel`, `mpim`, `im`
    int hashCode()  
    boolean isExcludeArchived()
    Set to `true` to exclude archived channels from the list
    void setCursor​(java.lang.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`.
    void setExcludeArchived​(boolean excludeArchived)
    Set to `true` to exclude archived channels from the list
    void setLimit​(java.lang.Integer limit)
    The maximum number of items to return.
    void setTeamId​(java.lang.String teamId)
    Required for org-wide apps.
    void setToken​(java.lang.String token)
    Authentication token.
    void setTypes​(java.util.List<ConversationType> types)
    Mix and match channel types by providing a comma-separated list of any combination of `public_channel`, `private_channel`, `mpim`, `im`
    java.lang.String toString()  

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Method Details

    • builder

      public static ConversationsListRequest.ConversationsListRequestBuilder builder()

    • getToken

      public java.lang.String getToken()
      Authentication token. Requires scope: `conversations:read`
      Specified by:
      getToken in interface SlackApiRequest

    • getCursor

      public java.lang.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 java.lang.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 java.util.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 java.lang.String getTeamId()
      Required for org-wide apps.

    • setToken

      public void setToken​(java.lang.String token)
      Authentication token. Requires scope: `conversations:read`

    • setCursor

      public void setCursor​(java.lang.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​(java.lang.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​(java.util.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​(java.lang.String teamId)
      Required for org-wide apps.

    • equals

      public boolean equals​(java.lang.Object o)
      Overrides:
      equals in class java.lang.Object

    • canEqual

      protected boolean canEqual​(java.lang.Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class java.lang.Object

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Object