Work with Conversations
The following are Apex classes for the Slack conversations API methods.
Represents information about a channel, which can be a public channel, private channel, direct message (DM), or a multi-person direct message (Mpim).
Usage
See Slack's conversation object type.
The following are methods for Conversation.
Signature
Return Value
Type: List<String>
Signature
Return Value
Type: List<String>
Signature
Return Value
Type: String
Signature
Return Value
Type: String
Signature
Return Value
Type: String
Signature
Return Value
Type: Integer
Signature
Return Value
Type: String
Signature
Return Value
Type: String
Signature
Return Value
Type: List<String>
Signature
Return Value
Type: Integer
Signature
Return Value
Type: Boolean
Signature
Return Value
Type: String
Signature
Return Value
Type: Slack.Latest
Signature
Return Value
Type: String
Signature
Return Value
Type: String
Signature
Return Value
Type: String
Signature
Return Value
Type: Integer
Signature
Return Value
Type: String
Signature
Return Value
Type: List<String>
Signature
Return Value
Type: List<String>
Signature
Return Value
Type: List<String>
Signature
Return Value
Type: Double
Signature
Return Value
Type: Slack.Purpose
Signature
Return Value
Type: List<String>
Signature
Return Value
Type: Slack.Topic
Signature
Return Value
Type: Integer
Signature
Return Value
Type: Integer
Signature
Return Value
Type: Integer
Signature
Return Value
Type: String
Signature
Return Value
Type: Boolean
Signature
Return Value
Type: Boolean
Signature
Return Value
Type: Boolean
Signature
Return Value
Type: Boolean
Signature
Return Value
Type: Boolean
Signature
Return Value
Type: Boolean
Signature
Return Value
Type: Boolean
Signature
Return Value
Type: Boolean
Signature
Return Value
Type: Boolean
Signature
Return Value
Type: Boolean
Signature
Return Value
Type: Boolean
Signature
Return Value
Type: Boolean
Signature
Return Value
Type: Boolean
Signature
Return Value
Type
Signature
Return Value
Type: Boolean
Signature
Return Value
Type: Boolean
Signature
Return Value
Type: Boolean
Signature
Return Value
Type: Boolean
Signature
Return Value
Type: Boolean
Signature
Return Value
Type: Boolean
Signature
Parameters
isUserDeleted
Type: Boolean
Return Value
Type: void
Signature
Parameters
isArchived
Type: Boolean
Return Value
Type: void
Signature
Parameters
isChannel
Type: Boolean
Return Value
Type: void
Signature
Parameters
connectedLimitedTeamIds
Type: List<String>
Return Value
Type: void
Signature
Parameters
connectedTeamIds
Type: List<String>
Return Value
Type: void
Signature
Parameters
conversationHostId
Type: String
Return Value
Type: void
Signature
Parameters
created
Type: String
Return Value
Type: void
Signature
Parameters
creator
Type: String
Return Value
Type: void
Signature
Parameters
dateConnected
Type: Integer
Return Value
Type: void
Signature
Parameters
enterpriseId
Type: String
Return Value
Type: void
Signature
Parameters
isExtShared
Type: Boolean
Return Value
Type: void
Signature
Parameters
isGeneral
Type: Boolean
Return Value
Type: void
Signature
Parameters
globalShared
Type: Boolean
Return Value
Type: void
Signature
Parameters
isGroup
Type: Boolean
Return Value
Type: void
Signature
Parameters
id
Type: String
Return Value
Type: void
Signature
Parameters
isIm
Type: Boolean
Return Value
Type: void
Signature
Parameters
internalTeamIds
Type: List<String>
Return Value
Type: void
Signature
Parameters
isMoved
Type: Integer
Return Value
Type: void
Signature
Parameters
lastRead
Type: String
Return Value
Type: void
Signature
Parameters
latest
Type: Slack.Latest
Return Value
Type: void
Signature
Parameters
locale
Type: String
Return Value
Type: void
Signature
Parameters
isMember
Type: Boolean
Return Value
Type: void
Signature
Parameters
isMpim
Type: Boolean
Return Value
Type: void
Signature
Parameters
name
Type: String
Return Value
Type: void
Signature
Parameters
nameNormalized
Type: String
Return Value
Type: void
Signature
Parameters
isNonThreadable
Type: Boolean
Return Value
Type: void
Signature
Parameters
numOfMembers
Type: Integer
Return Value
Type: void
Signature
Parameters
open
Type: Boolean
Return Value
Type: void
Signature
Parameters
orgDefault
Type: Boolean
Return Value
Type: void
Signature
Parameters
orgMandatory
Type: Boolean
Return Value
Type: void
Signature
Parameters
isOrgShared
Type: Boolean
Return Value
Type: void
Signature
Parameters
parentConversation
Type: String
Return Value
Type: void
Signature
Parameters
pendingConnectedTeamIds
Type: List<String>
Return Value
Type: void
Signature
Parameters
isPendingExtShared
Type: Boolean
Return Value
Type: void
Signature
Parameters
pendingShared
Type: List<String>
Return Value
Type: void
Signature
Parameters
previousNames
Type: List<String>
Return Value
Type: void
Signature
Parameters
priority
Type: Double
Return Value
Type: void
Signature
Parameters
isPrivate
Type: Boolean
Return Value
Type: void
Signature
Parameters
purpose
Type: Slack.Purpose
Return Value
Type: void
Signature
Parameters
isReadOnly
Type: Boolean
Return Value
Type: void
Signature
Parameters
isShared
Type: Boolean
Return Value
Type: void
Signature
Parameters
sharedTeamIds
Type: List<String>
Return Value
Type: void
Signature
Parameters
isStarred
Type: Boolean
Return Value
Type: void
Signature
Parameters
isThreadOnly
Type: Boolean
Return Value
Type: void
Signature
Parameters
topic
Type: Slack.Topic
Return Value
Type
Signature
Parameters
unlinked
Type: Integer
Return Value
Type: void
Signature
Parameters
unreadCount
Type: Integer
Return Value
Type: void
Signature
Parameters
unreadCountDisplay
Type: Integer
Return Value
Type: void
Signature
Parameters
user
Type: String
Return Value
Type: void
Sends a request to archive a conversation.
Usage
See Slack’s conversations.archive method.
The following are methods for ConversationsArchiveRequest.
Builds a request object that's used when executing the API call.
Signature
Return Value
Type: Slack.ConversationsArchiveRequest.Builder
Contains methods to build an instance of the Slack.ConversationsArchiveRequest class.
A Builder object is obtained by invoking one of the ConversationsArchiveRequest.Builder methods defined by the ConversationsArchiveRequest class.
The following are methods for ConversationsArchiveRequest.Builder.
Required. Builds an instance of Slack.ConversationsArchiveRequest.
Signature
Return Value
Type: Slack.ConversationsArchiveRequest
Required. The ID of the conversation to archive.
Signature
Parameters
channel
Type: String
Return Value
Type: Slack.ConversationsArchiveRequest.Builder
Archives a conversation.
Usage
See Slack’s conversations.archive method.
This class contains standard response methods.
Sends a request to close a direct message or multi-person direct message.
Usage
See Slack’s conversations.close method.
Builds a request object that's used when executing the API call.
Signature
Return Value
Type: Slack.ConversationsCloseRequest.Builder
Contains methods to build an instance of the Slack.ConversationsCloseRequest class.
A Builder object is obtained by invoking one of the ConversationsCloseRequest.Builder methods defined by the ConversationsCloseRequest class.
The following are methods for ConversationsCloseRequest.Builder.
Required. Builds an instance of Slack.ConversationsCloseRequest.
Signature
Return Value
Type: Slack.ConversationsCloseRequest
Required. The ID of the conversation to close.
Signature
Parameters
channel
Type: String
Return Value
Type: Slack.ConversationsCloseRequest.Builder
Closes a direct message or multi-person direct message.
This class contains standard response methods.
The following are methods for ConversationsCloseResponse.
Specifies whether the conversation is already closed.
Signature
Return Value
Type: Boolean
Signature
Return Value
Type: Boolean
Signature
Parameters
alreadyClosed
Type: Boolean
Return Value
Type: void
Signature
Parameters
noOp
Type: Boolean
Return Value
Type: void
Sends a request to initiate a public or private channel-based conversation.
Usage
For example, you can enable users to create a channel by issuing a message by subscribing and handling the message event.
See Slack’s conversations.create method.
The following are methods for ConversationsCreateRequest.
Builds a request object that's used when executing the API call.
Signature
Return Value
Type: Slack.ConversationsCreateRequest.Builder
Contains methods to build an instance of the Slack.ConversationsCreateRequest class.
A Builder object is obtained by invoking one of the ConversationsCreateRequest.Builder methods defined by the ConversationsCreateRequest class.
The following are methods for ConversationsCreateRequest.Builder. These methods are optional unless specified otherwise.
Required. Builds an instance of Slack.ConversationsCreateRequest.
Signature
Return Value
Type: Slack.ConversationsCreateRequest
Signature
Parameters
isPrivate
Type: Boolean
Return Value
Type: Slack.ConversationsCreateRequest.Builder
Required. The name of the public or private channel to create.
Signature
Parameters
name
Type: String
Return Value
Type: Slack.ConversationsCreateRequest.Builder
Signature
Parameters
teamId
Type: String
Return Value
Type: Slack.ConversationsCreateRequest.Builder
Initiates a public or private channel-based conversation.
Usage
See Slack’s conversations.create method.
This class contains standard response methods.
The following are methods for ConversationsCreateResponse.
Signature
Return Value
Type: Slack.Conversation
Signature
Return Value
Type: String
Signature
Parameters
channel
Type: Slack.Conversation
Return Value
Type: void
Signature
Parameters
detail
Type: String
Return Value
Type: void
Sends a request to fetch a conversation’s history of messages and events.
Usage
See Slack’s conversations.history method.
The following are methods for ConversationsHistoryRequest.
Builds a request object that's used when executing the API call.
Signature
Return Value
Type: Slack.ConversationsHistoryRequest.Builder
Contains methods to build an instance of the Slack.ConversationsHistoryRequest class.
A Builder object is obtained by invoking one of the ConversationsHistoryRequest.Builder methods defined by the ConversationsHistoryRequest class.
The following are methods for ConversationsHistoryRequest.Builder. These methods are optional unless specified otherwise.
Required. Builds an instance of Slack.ConversationsHistoryRequest.
Signature
Return Value
Type: Slack.ConversationsHistoryRequest
Required. The ID of the conversation to fetch history for.
Signature
Parameters
channel
Type
Return Value
Type: Slack.ConversationsHistoryRequest.Builder
Signature
Parameters
cursor
Type: String
Return Value
Type: Slack.ConversationsHistoryRequest.Builder
Signature
Parameters
inclusive
Type: Boolean
Return Value
Type: Slack.ConversationsHistoryRequest.Builder
Signature
Parameters
latest
Type: String
Return Value
Type: Slack.ConversationsHistoryRequest.Builder
Signature
Parameters
limitValue
Type: Integer
Return Value
Type: Slack.ConversationsHistoryRequest.Builder
Signature
Parameters
oldest
Type: String
Return Value
Type: Slack.ConversationsHistoryRequest.Builder
Fetches a conversation’s history of messages and events.
Usage
See Slack’s conversations.history method.
This class contains standard response methods.
The following are methods for ConversationsHistoryResponse.
Signature
Return Value
Type: Integer
Signature
Return Value
Type: String
Signature
Return Value
Type: String
Signature
Return Value
Type: List<Slack.Message>
Signature
Return Value
Type: Integer
Signature
Return Value
Type: Slack.ResponseMetadata
Signature
Return Value
Type: Boolean
Signature
Parameters
channelActionsCount
Type: Integer
Return Value
Type: void
Signature
Parameters
channelActionsTs
Type: String
Return Value
Type: void
Signature
Parameters
hasMore
Type: Boolean
Return Value
Type: void
Signature
Parameters
latest
Type: String
Return Value
Type: void
Signature
Parameters
messages
Type: List<Slack.Message>
Return Value
Type: void
Signature
Parameters
pinCount
Type: Integer
Return Value
Type: void
Signature `
Parameters
responseMetadata
Type: Slack.ResponseMetadata
Return Value
Type: void
Sends a request to retrieve information about a conversation.
Usage
See Slack’s conversations.info method.
The following are methods for ConversationsInfoRequest.
Builds a request object that's used when executing the API call.
Signature
Return Value
Type: Slack.ConversationsInfoRequest.Builder
Contains methods to build an instance of the Slack.ConversationsInfoRequest class.
A Builder object is obtained by invoking one of the ConversationsInfoRequest.Builder methods defined by the ConversationsInfoRequest class.
The following are methods for ConversationsInfoRequest.Builder. These methods are optional unless specified otherwise.
Required. Builds an instance of Slack.ConversationsInfoRequest.
Signature
Return Value
Type: Slack.ConversationsInfoRequest
Required. The ID of the conversation to learn more about.
Signature
Parameters
channel
Type: String
Return Value
Type: Slack.ConversationsInfoRequest.Builder
Signature
Parameters
includeLocale
Type: Boolean
Return Value
Type: Slack.ConversationsInfoRequest.Builder
Signature
Parameters
includeNumMembers
Type: Boolean
Return Value
Type: Slack.ConversationsInfoRequest.Builder
Retrieves information about a conversation.
This class contains standard response methods.
The following are methods for ConversationsInfoResponse.
Signature
Return Value
Type: Slack.Conversation
Signature
Parameters
channel
Type: Slack.Conversation
Return Value
Type: void
Sends a request to invite users to a channel. The calling user must be a member of the channel.
Usage
See Slack’s conversations.invite method.
The following are methods for ConversationsInviteRequest.
Builds a request object that's used when executing the API call.
Signature
Return Value
Type: Slack.ConversationsInviteRequest.Builder
Contains methods to build an instance of the Slack.ConversationsInviteRequest class.
A Builder object is obtained by invoking one of the ConversationsInviteRequest.Builder methods defined by the ConversationsInviteRequest class.
The following are methods for ConversationsInviteRequest.Builder.
Required. Builds an instance of Slack.ConversationsInviteRequest.
Signature
Return Value
Type: Slack.ConversationsInviteRequest
Required. The ID of the public or private channel to invite users to.
Signature
Parameters
channel
Type: String
Return Value
Type: Slack.ConversationsInviteRequest.Builder
Required. A comma-separated list of user IDs. Up to 1000 users may be listed.
Signature
Parameters
users
Type: List<String>
Return Value
Type: Slack.ConversationsInviteRequest.Builder
Invites users to a channel.
Usage
See Slack’s conversations.invite method.
This class contains standard response methods.
The following are methods for ConversationsInviteResponse.
Signature
Return Value
Type: Slack.Conversation
Signature
Return Value
Type: List<Slack.ConversationsInviteResponse.Error>
Signature
Parameters
channel
Type: Slack.Conversation
Return Value
Type: void
Signature
Parameters
errors
Type: List<Slack.ConversationsInviteResponse.Error>
Return Value
Type: void
The following are methods for ConversationsInviteResponse.Error.
Gets the error on the response. See the conversations.invite method’s list of errors.
Signature
Return Value
Type: String
Specifies whether the users are invited to the channel successfully.
Signature
Return Value
Type: Boolean
Sets the error message in the response.
Signature
Parameters
error
Type: String
Return Value
Type: void
Specifies whether the users are invited to the channel successfully.
Signature
Parameters
ok
Type: Boolean
Return Value
Type: void
Sends a request to join an existing conversation
Usage
See Slack’s conversations.join method.
The following are methods for ConversationsJoinRequest.
Builds a request object that's used when executing the API call.
Signature
Return Value
Type: Slack.ConversationsJoinRequest.Builder
Contains methods to build an instance of the Slack.ConversationsJoinRequest class.
A Builder object is obtained by invoking one of the ConversationsJoinRequest.Builder methods defined by the ConversationsJoinRequest class.
The following are methods for ConversationsJoinRequest.Builder.
Required. Builds an instance of Slack.ConversationsJoinRequest.
Signature
Return Value
Type: Slack.ConversationsJoinRequest
Required. The ID of the conversation to join.
Signature
Parameters
channel
Type: String
Return Value
Type: Slack.ConversationsJoinRequest.Builder
Joins an existing conversation.
Usage
See Slack’s conversations.join method.
This class contains standard response methods.
The following are methods for ConversationsJoinResponse.
Signature `
Return Value
Type: Slack.Conversation
Signature
Return Value
Type: Slack.WarningResponseMetadata
Signature
Parameters
channel
Type: Slack.Conversation
Return Value
Type: void
Signature
Parameters
responseMetadata
Type: Slack.WarningResponseMetadata
Return Value
Type: void
Sends a request to remove a user from a conversation.
Usage
See Slack’s conversations.kick method.
The following are methods for ConversationsKickRequest.
Signature
Return Value
Type: Slack.ConversationsKickRequest.Builder
Contains methods to build an instance of the Slack.ConversationsKickRequest class.
A Builder object is obtained by invoking one of the ConversationsKickRequest.Builder methods defined by the ConversationsKickRequest class.
The following are methods for ConversationsKickRequest.Builder.
Required. Builds an instance of Slack.ConversationsKickRequest.
Signature
Return Value
Type: Slack.ConversationsKickRequest
Required. The ID of conversation to remove user from.
Signature
Parameters
channel
Type: String
Return Value
Type: Slack.ConversationsKickRequest.Builder
Required. The ID of the user to be removed.
Signature
Parameters
user
Type: String
Return Value
Type: Slack.ConversationsKickRequest.Builder
Removes a user from a conversation.
Usage
See Slack’s conversations.kick method.
This class contains standard response methods.
Sends a request to leave a conversation.
Usage
See Slack’s conversations.leave method.
The following are methods for ConversationsLeaveRequest.
Builds a request object that's used when executing the API call.
Signature
Return Value
Type: Slack.ConversationsLeaveRequest.Builder
Contains methods to build an instance of the Slack.ConversationsLeaveRequest class.
A Builder object is obtained by invoking one of the ConversationsLeaveRequest.Builder methods defined by the ConversationsLeaveRequest class.
The following are methods for ConversationsLeaveRequest.Builder.
Required. Builds an instance of Slack.ConversationsLeaveRequest.
Signature
Return Value
Type: Slack.ConversationsLeaveRequest
Required. The ID of the conversation to leave.
Signature
Parameters
channel
Type: String
Return Value
Type: Slack.ConversationsLeaveRequest.Builder
Leaves a conversation.
Usage
See Slack’s conversations.leave method.
This class contains standard response methods.
The following are methods for ConversationsLeaveResponse.
Signature
Return Value
Type: Boolean
Signature
Parameters
notInChannel
Type: Boolean
Return Value
Type: void
Sends a request to list all channels in a Slack team.
Usage
See Slack’s conversations.list method.
The following are methods for ConversationsListRequest.
Builds a request object that's used when executing the API call.
Signature
Return Value
Type: Slack.ConversationsListRequest.Builder
Contains methods to build an instance of the Slack.ConversationsListRequest class.
A Builder object is obtained by invoking one of the ConversationsListRequest.Builder methods defined by the ConversationsListRequest class.
The following are methods for ConversationsListRequest.Builder. These methods are optional unless specified otherwise.
Required. Builds an instance of Slack.ConversationsListRequest.
Signature
Return Value
Type: Slack.ConversationsListRequest
Signature
Parameters
cursor
Type: String
Return Value
Type: Slack.ConversationsListRequest.Builder
Signature
Parameters
excludeArchived
Type: Boolean
Return Value
Type: Slack.ConversationsListRequest.Builder
Signature
Parameters
limitValue
Type: Integer
Return Value
Type: Slack.ConversationsListRequest.Builder
Signature
Parameters
teamId
Type: String
Return Value
Type: Slack.ConversationsListRequest.Builder
Signature
Parameters
types
Type: List<Slack.ConversationType>
Return Value
Slack.ConversationsListRequest.Builder
Lists all channels in a Slack team.
Usage
See Slack’s conversations.list method.
This class contains standard response methods.
The following are methods for ConversationsListResponse.
Signature
Return Value
Type: List<Slack.Conversation>
Signature
Return Value
Type: Slack.ResponseMetadata
Signature
Parameters
channels
Type: List<Slack.Conversation>
Return Value
Type: void
Signature
Parameters
responseMetadata
Type: Slack.ResponseMetadata
Sends a request to set the read cursor in a channel.
Usage
See Slack’s conversations.mark method.
Builds a request object that's used when executing the API call.
Signature
Return Value
Type: Slack.ConversationsMarkRequest.Builder
Contains methods to build an instance of the Slack.ConversationsMarkRequest class.
A Builder object is obtained by invoking one of the ConversationsMarkRequest.Builder methods defined by the ConversationsMarkRequest class.
The following are methods for ConversationsMarkRequest.Builder.
Required. Builds an instance of Slack.ConversationsMarkRequest.
Signature
Return Value
Type: Slack.ConversationsMarkRequest
Required. The ID of the channel or conversation to set the read cursor for.
Signature
Parameters
channel
Type: String
Return Value
Type: Slack.ConversationsMarkRequest.Builder
Required. The timestamp that's used as a unique identifier of the message you want marked as most recently seen in this conversation.
Signature
Parameters
ts
Type: String
Return Value
Type: Slack.ConversationsMarkRequest.Builder
Sets the read cursor in a channel.
Usage
See Slack’s conversations.mark method.
This class contains standard response methods.
The following are methods for ConversationsMarkResponse.
Signature
Return Value
Type: Slack.ResponseMetadata
Signature
Parameters
responseMetadata
Type: Slack.ResponseMetadata
Return Value
Type: void
Sends a request to retrieve members of a conversation.
Usage
See Slack’s conversation.members method.
The following are methods for ConversationsMembersRequest.
Builds a request object that's used when executing the API call.
Signature
Return Value
Type: Slack.ConversationsMembersRequest.Builder
Contains methods to build an instance of the Slack.ConversationsMembersRequest class.
A Builder object is obtained by invoking one of the ConversationsMembersRequest.Builder methods defined by the ConversationsMembersRequest class.
The following are methods for ConversationsMembersRequest.Builder. These methods are optional unless specified otherwise.
Required. Builds an instance of Slack.ConversationsMembersRequest.
Signature
Return Value
Type: ConversationsMembersRequest
Required. The ID of the conversation to retrieve members for.
Signature
Parameters
channel
Type: String
Return Value
Type: Slack.ConversationsMembersRequest.Builder
Signature
Parameters
cursor
Type: String
Return Value
Type: Slack.ConversationsMembersRequest.Builder
Signature
Parameters
limitValue
Type: Integer
Return Value
Type: Slack.ConversationsMembersRequest.Builder
Retrieves members of a conversation.
Usage
See Slack’s conversation.members method.
This class contains standard response methods.
The following are methods for ConversationsMembersResponse.
Signature
Return Value
Type: List<String>
Signature
Return Value
Type: Slack.ResponseMetadata
Signature
Parameters
members
Type<String>
Return Value
Type: void
Signature
Parameters
responseMetadata
Type: Slack.ResponseMetadata
Return Value
Type: void
Sends a request to open or resume a direct message or multi-person direct message. For public or private channels, use ConversationsCreateRequest.
Usage
See Slack’s conversations.open method.
The following are methods for ConversationsOpenRequest.
Builds a request object that's used when executing the API call.
Signature
Return Value
Type: Slack.ConversationsOpenRequest.Builder
Contains methods to build an instance of the Slack.ConversationsOpenRequest class.
A Builder object is obtained by invoking one of the ConversationsOpenRequest.Builder methods defined by the ConversationsOpenRequest class.
The following are methods for ConversationsOpenRequest.Builder. These methods are optional unless specified otherwise.
Required. Builds an instance of Slack.ConversationsOpenRequest.
Signature
Return Value
Type: Slack.ConversationsOpenRequest
Signature
Parameters
channel
Type: String
Return Value
Type: Slack.ConversationsOpenRequest.Builder
Signature
Parameters
returnIm
Type: Boolean
Return Value
Type: Slack.ConversationsOpenRequest.Builder
Signature
Parameters
users
Type: List<String>
Return Value
Type: Slack.ConversationsOpenRequest.Builder
Opens or resumes a direct message or multi-person direct message.
Usage
See Slack’s conversations.open method.
This class contains standard response methods.
The following are methods for ConversationsOpenResponse.
Signature
Return Value
Type: Slack.Conversation
Signature
Return Value
Type: Boolean
Signature
Return Value
Type: Boolean
Signature
Parameters
alreadyOpen
Type: Boolean
Return Value
Type: void
Signature
Parameters
channel
Type: Slack.Conversation
Return Value
Type: void
Signature
Parameters
noOp
Type: Boolean
Return Value
Type: void
Sends a request to rename a conversation.
Usage
See Slack’s conversations.rename method.
The following are methods for ConversationsRenameRequest.
Builds a request object that's used when executing the API call.
Signature
Return Value
Type: Slack.ConversationsRenameRequest.Builder
Contains methods to build an instance of the Slack.ConversationsRenameRequest class.
A Builder object is obtained by invoking one of the ConversationsRenameRequest.Builder methods defined by the ConversationsRenameRequest class.
The following are methods for ConversationsRenameRequest.Builder.
Required. Builds an instance of Slack.ConversationsRenameRequest.
Signature
Return Value
Type: Slack.ConversationsRenameRequest
Required. The ID of conversation to rename.
Signature
Parameters
channel
Type: String
Required. New name for conversation.
Signature
Parameters
name
Type: String
Return Value
Type: Slack.ConversationsRenameRequest.Builder
Renames a conversation.
Usage
See Slack’s conversations.rename method.
This class contains standard response methods.
The following are methods for ConversationsRenameResponse.
Signature
Return Value
Type: Slack.Conversation
Signature
Parameters
channel
Type: Slack.Conversation
Return Value
Type: void
Sends a request to retrieve a thread of messages that’s posted to a conversation.
Usage
See Slack’s conversations.replies method.
The following are methods for ConversationsRepliesRequest.
Builds a request object that's used when executing the API call.
Signature
Return Value
Type: Slack.ConversationsRepliesRequest.BuilderAdd
Contains methods to build an instance of the Slack.ConversationsRepliesRequest class.
A Builder object is obtained by invoking one of the ConversationsRepliesRequest.Builder methods defined by the ConversationsRepliesRequest class.
The following are methods for ConversationsRepliesRequest.Builder. These methods are optional unless specified otherwise.
Required. Builds an instance of Slack.ConversationsRepliesRequest.
Signature
Return Value
Type: Slack.ConversationsRepliesRequest
Required. Conversation ID to fetch thread from.
Signature
Parameters
channel
Type: String
Return Value
Type: Slack.ConversationsRepliesRequest.Builder
Signature
Parameters
cursor
Type: String
Return Value
Type: Slack.ConversationsRepliesRequest.Builder
Signature
Parameters
inclusive
Type: Boolean
Return Value
Type: Slack.ConversationsRepliesRequest.Builder
Signature
Parameters
latest
Type: String
Return Value
Type: Slack.ConversationsRepliesRequest.Builder
Signature
Parameters
limitValue
Type: Integer
Return Value
Type: Slack.ConversationsRepliesRequest.Builder
Signature
Parameters
oldest
Type: String
Return Value
Type: Slack.ConversationsRepliesRequest.Builder
Required. The timestamp of an existing message with 0 or more replies. This timestamp is used as a unique identifier of either a thread’s parent message or a message in the thread. If there are no replies, a single unthreaded message that's referenced by the timestamp is returned.
Signature
Parameters
ts
Type: String
Return Value
Type: Slack.ConversationsRepliesRequest.Builder
Retrieves a thread of messages posted to a conversation.
Usage
See Slack’s conversations.replies method.
This class contains standard response methods.
The following are methods for ConversationsRepliesResponse.
Signature
Return Value
Type: List<Slack.Message>
Signature
Return Value
Type: Slack.ResponseMetadata
Signature
Return Value
Type: Boolean
Signature
Parameters
hasMore
Type: Boolean
Return Value
Type: void
Signature
Parameters
messages
Type: List<Slack.Message>
Return Value
Type: void
Signature
Parameters
responseMetadata
Type: Slack.ResponseMetadata
Return Value
Type: void
Sends a request to set the purpose for a conversation.
Usage
See Slack’s conversations.setPurpose method.
The following are methods for ConversationsSetPurposeRequest.
Builds a request object that's used when executing the API call.
Signature
Return Value
Type: Slack.ConversationsSetPurposeRequest.Builder
Contains methods to build an instance of the Slack.ConversationsSetPurposeRequest class.
A Builder object is obtained by invoking one of the ConversationsSetPurposeRequest.Builder methods defined by the ConversationsSetPurposeRequest class.
The following are methods for ConversationsSetPurposeRequest.Builder.
Signature
Return Value
Type: Slack.ConversationsSetPurposeRequest
Required. The ID of the conversation to set the purpose for.
Signature
Parameters
channel
Type: String
Return Value
Type: Slack.ConversationsSetPurposeRequest.Builder
Required. The purpose for the conversation.
Signature
Parameters
purpose
Type: String
Return Value
Type: Slack.ConversationsSetPurposeRequest.Builder
Sets the purpose for a conversation.
Usage
See Slack’s conversations.setPurpose method.
This class contains standard response methods.
The following are methods for ConversationsSetPurposeResponse.
Signature
Return Value
Type: Slack.Conversation
Signature
Parameters
channel
Type: Slack.Conversation
Return Value
Type: void
Sends a request to set the topic for a conversation.
Usage
See Slack’s conversations.setTopic method.
Builds a request object that's used when executing the API call.
Signature
Return Value
Type: Slack.ConversationsSetTopicRequest.Builder
Contains methods to build an instance of the Slack.ConversationsSetTopicRequest class.
A Builder object is obtained by invoking one of the ConversationsSetTopicRequest.Builder methods defined by the ConversationsSetTopicRequest class.
The following are methods for ConversationsSetTopicRequest.Builder.
Required. Builds an instance of Slack. ConversationsSetTopicRequest.
Signature
Return Value
Type: Slack.ConversationsSetTopicRequest
Required. The conversation to set the topic for.
Signature
Parameters
channel
Type: String
Return Value
Type: Slack.ConversationsSetTopicRequest.Builder
Required. The topic for the conversation.
Signature
Parameters
topic
Type: String
Return Value
Type: Slack.ConversationsSetTopicRequest.Builder
Sets the topic for a conversation.
Usage
See Slack’s conversations.setTopic method.
This class contains standard response methods.
The following are methods for ConversationsSetTopicResponse.
Signature
Return Value
Type: Slack.Conversation
Signature
Parameters
channel
Type: Slack.Conversation
Return Value
Type: void
Sends a request to reverse conversation archival.
Usage
See Slack’s conversations.unarchive method.
The following are methods for ConversationsUnarchiveRequest.
Builds a request object that's used when executing the API call.
Signature
Return Value
Type: Slack.ConversationsUnarchiveRequest.Builder
Contains methods to build an instance of the Slack.ConversationsUnarchiveRequest class.
A Builder object is obtained by invoking one of the ConversationsUnarchiveRequest.Builder methods defined by the ConversationsUnarchiveRequest class.
The following are methods for ConversationsUnarchiveRequest.Builder.
Required. Builds an instance of Slack.ConversationsUnarchiveRequest.
Signature
Return Value
Type: Slack.ConversationsUnarchiveRequest
Required. The ID of conversation to unarchive.
Signature
Parameters
channel
Type: String
Return Value
Type: Slack.ConversationsUnarchiveRequest.Builder
Reverses conversation archival.
Usage
See Slack’s conversations.unarchive method.
This class contains standard response methods.