Package com.slack.api.methods.request.users

Class UsersListRequest

java.lang.Object
com.slack.api.methods.request.users.UsersListRequest
All Implemented Interfaces:
SlackApiRequest
public class UsersListRequest
extends java.lang.Object
implements SlackApiRequest

  • Nested Class Summary

    Nested Classes 
    Modifier and Type Class Description
    static class  UsersListRequest.UsersListRequestBuilder  

  • Method Summary

    Modifier and Type Method Description
    static UsersListRequest.UsersListRequestBuilder 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.
    int hashCode()  
    boolean isIncludeLocale()
    Set this to `true` to receive the locale for users.
    boolean isPresence()
    Deprecated.
    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 setIncludeLocale​(boolean includeLocale)
    Set this to `true` to receive the locale for users.
    void setLimit​(java.lang.Integer limit)
    The maximum number of items to return.
    void setPresence​(boolean presence)
    Deprecated.
    void setTeamId​(java.lang.String teamId)
    Required for org-wide apps.
    void setToken​(java.lang.String token)
    Authentication token.
    java.lang.String toString()  

    Methods inherited from class java.lang.Object

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

  • Method Details

    • builder

      public static UsersListRequest.UsersListRequestBuilder builder()

    • getToken

      public java.lang.String getToken()
      Authentication token. Requires scope: `users: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.

    • 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 users list hasn't been reached.

    • isIncludeLocale

      public boolean isIncludeLocale()
      Set this to `true` to receive the locale for users. Defaults to `false`

    • isPresence

      @Deprecated public boolean isPresence()
      Deprecated.
      Deprecated. Whether to include presence data in the output. Defaults to `false`. Setting this to `true` reduces performance, especially with large teams.

    • getTeamId

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

    • setToken

      public void setToken​(java.lang.String token)
      Authentication token. Requires scope: `users: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.

    • 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 users list hasn't been reached.

    • setIncludeLocale

      public void setIncludeLocale​(boolean includeLocale)
      Set this to `true` to receive the locale for users. Defaults to `false`

    • setPresence

      @Deprecated public void setPresence​(boolean presence)
      Deprecated.
      Deprecated. Whether to include presence data in the output. Defaults to `false`. Setting this to `true` reduces performance, especially with large teams.

    • 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