Class UsersConversationsRequest
- java.lang.Object
-
- com.slack.api.methods.request.users.UsersConversationsRequest
-
- All Implemented Interfaces:
SlackApiRequest
public class UsersConversationsRequest extends Object implements SlackApiRequest
List conversations the calling user may access.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classUsersConversationsRequest.UsersConversationsRequestBuilder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static UsersConversationsRequest.UsersConversationsRequestBuilderbuilder()protected booleancanEqual(Object other)booleanequals(Object o)StringgetCursor()Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`.IntegergetLimit()The maximum number of items to return.StringgetToken()Authentication token.List<ConversationType>getTypes()Mix and match channel types by providing a comma-separated list of any combination of `public_channel`, `private_channel`, `mpim`, `im`StringgetUser()Browse conversations by a specific user ID's membership.inthashCode()booleanisExcludeArchived()Set to `true` to exclude archived channels from the listvoidsetCursor(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`.voidsetExcludeArchived(boolean excludeArchived)Set to `true` to exclude archived channels from the listvoidsetLimit(Integer limit)The maximum number of items to return.voidsetToken(String token)Authentication token.voidsetTypes(List<ConversationType> types)Mix and match channel types by providing a comma-separated list of any combination of `public_channel`, `private_channel`, `mpim`, `im`voidsetUser(String user)Browse conversations by a specific user ID's membership.StringtoString()
-
-
-
Method Detail
-
builder
public static UsersConversationsRequest.UsersConversationsRequestBuilder builder()
-
getToken
public String getToken()
Authentication token. Requires scope: `conversations:read`- Specified by:
getTokenin interfaceSlackApiRequest
-
getUser
public String getUser()
Browse conversations by a specific user ID's membership. Non-public channels are restricted to those where the calling user shares membership."
-
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`
-
setToken
public void setToken(String token)
Authentication token. Requires scope: `conversations:read`
-
setUser
public void setUser(String user)
Browse conversations by a specific user ID's membership. Non-public channels are restricted to those where the calling user shares membership."
-
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`
-
canEqual
protected boolean canEqual(Object other)
-
-