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.
Conversation Methods
The following are methods for Conversation
.
getConnectedLimitedTeamIds()
Signature
Return Value
Type: List<String>
getConnectedTeamIds()
Signature
Return Value
Type: List<String>
getConversationHostId()
Signature
Return Value
Type: String
getCreated()
Signature
Return Value
Type: String
getCreator()
Signature
Return Value
Type: String
getDateConnected()
Signature
Return Value
Type: Integer
getEnterpriseId()
Signature
Return Value
Type: String
getId()
Signature
Return Value
Type: String
getInternalTeamIds()
Signature
Return Value
Type: List<String>
getIsMoved()
Signature
Return Value
Type: Integer
getIsUserDeleted()
Signature
Return Value
Type: Boolean
getLastRead()
Signature
Return Value
Type: String
getLatest()
Signature
Return Value
Type: Slack.Latest
getLocale()
Signature
Return Value
Type: String
getName()
Signature
Return Value
Type: String
getNameNormalized()
Signature
Return Value
Type: String
getNumOfMembers()
Signature
Return Value
Type: Integer
getParentConversation()
Signature
Return Value
Type: String
getPendingConnectedTeamIds()
Signature
Return Value
Type: List<String>
getPendingShared()
Signature
Return Value
Type: List<String>
getPreviousNames()
Signature
Return Value
Type: List<String>
getPriority()
Signature
Return Value
Type: Double
getPurpose()
Signature
Return Value
Type: Slack.Purpose
getSharedTeamIds()
Signature
Return Value
Type: List<String>
getTopic()
Signature
Return Value
Type: Slack.Topic
getUnlinked()
Signature
Return Value
Type: Integer
getUnreadCount()
Signature
Return Value
Type: Integer
getUnreadCountDisplay()
Signature
Return Value
Type: Integer
getUser()
Signature
Return Value
Type: String
isArchived()
Signature
Return Value
Type: Boolean
isChannel()
Signature
Return Value
Type: Boolean
isExtShared()
Signature
Return Value
Type: Boolean
isGeneral()
Signature
Return Value
Type: Boolean
isGlobalShared()
Signature
Return Value
Type: Boolean
isGroup()
Signature
Return Value
Type: Boolean
isIm()
Signature
Return Value
Type: Boolean
isMember()
Signature
Return Value
Type: Boolean
isMpim()
Signature
Return Value
Type: Boolean
isNonThreadable()
Signature
Return Value
Type: Boolean
isOpen()
Signature
Return Value
Type: Boolean
isOrgDefault()
Signature
Return Value
Type: Boolean
isOrgMandatory()
Signature
Return Value
Type: Boolean
isOrgShared()
Signature
Return Value
Type
isPendingExtShared()
Signature
Return Value
Type: Boolean
isPrivate()
Signature
Return Value
Type: Boolean
isReadOnly()
Signature
Return Value
Type: Boolean
isShared()
Signature
Return Value
Type: Boolean
isStarred()
Signature
Return Value
Type: Boolean
isThreadOnly()
Signature
Return Value
Type: Boolean
setIsUserDeleted(isUserDeleted)
Signature
Parameters
isUserDeleted
Type: Boolean
Return Value
Type: void
setArchived(isArchived)
Signature
Parameters
isArchived
Type: Boolean
Return Value
Type: void
setChannel(isChannel)
Signature
Parameters
isChannel
Type: Boolean
Return Value
Type: void
setConnectedLimitedTeamIds(connectedLimitedTeamIds)
Signature
Parameters
connectedLimitedTeamIds
Type: List<String>
Return Value
Type: void
setConnectedTeamIds(connectedTeamIds)
Signature
Parameters
connectedTeamIds
Type: List<String>
Return Value
Type: void
setConversationHostId(conversationHostId)
Signature
Parameters
conversationHostId
Type: String
Return Value
Type: void
setCreated(created)
Signature
Parameters
created
Type: String
Return Value
Type: void
setCreator(creator)
Signature
Parameters
creator
Type: String
Return Value
Type: void
setDateConnected(dateConnected)
Signature
Parameters
dateConnected
Type: Integer
Return Value
Type: void
setEnterpriseId()
Signature
Parameters
enterpriseId
Type: String
Return Value
Type: void
setExtShared(isExtShared)
Signature
Parameters
isExtShared
Type: Boolean
Return Value
Type: void
setGeneral(isGeneral)
Signature
Parameters
isGeneral
Type: Boolean
Return Value
Type: void
setGlobalShared(globalShared)
Signature
Parameters
globalShared
Type: Boolean
Return Value
Type: void
setGroup(isGroup)
Signature
Parameters
isGroup
Type: Boolean
Return Value
Type: void
setId(id)
Signature
Parameters
id
Type: String
Return Value
Type: void
setIm(isIm)
Signature
Parameters
isIm
Type: Boolean
Return Value
Type: void
setInternalTeamIds(internalTeamIds)
Signature
Parameters
internalTeamIds
Type: List<String>
Return Value
Type: void
setIsMoved(isMoved)
Signature
Parameters
isMoved
Type: Integer
Return Value
Type: void
setLastRead(lastRead)
Signature
Parameters
lastRead
Type: String
Return Value
Type: void
setLatest(latest)
Signature
Parameters
latest
Type: Slack.Latest
Return Value
Type: void
setLocale(locale)
Signature
Parameters
locale
Type: String
Return Value
Type: void
setMember(isMember)
Signature
Parameters
isMember
Type: Boolean
Return Value
Type: void
setMpim(isMpim)
Signature
Parameters
isMpim
Type: Boolean
Return Value
Type: void
setName(name)
Signature
Parameters
name
Type: String
Return Value
Type: void
setNameNormalized(nameNormalized)
Signature
Parameters
nameNormalized
Type: String
Return Value
Type: void
setNonThreadable(isNonThreadable)
Signature
Parameters
isNonThreadable
Type: Boolean
Return Value
Type: void
setNumOfMembers(numOfMembers)
Signature
Parameters
numOfMembers
Type: Integer
Return Value
Type: void
setOpen(open)
Signature
Parameters
open
Type: Boolean
Return Value
Type: void
setOrgDefault(orgDefault)
Signature
Parameters
orgDefault
Type: Boolean
Return Value
Type: void
setOrgMandatory(orgMandatory)
Signature
Parameters
orgMandatory
Type: Boolean
Return Value
Type: void
setOrgShared(isOrgShared)
Signature
Parameters
isOrgShared
Type: Boolean
Return Value
Type: void
setParentConversation(parentConversation)
Signature
Parameters
parentConversation
Type: String
Return Value
Type: void
setPendingConnectedTeamIds(pendingConnectedTeamIds)
Signature
Parameters
pendingConnectedTeamIds
Type: List<String>
Return Value
Type: void
setPendingExtShared(isPendingExtShared)
Signature
Parameters
isPendingExtShared
Type: Boolean
Return Value
Type: void
setPendingShared(pendingShared)
Signature
Parameters
pendingShared
Type: List<String>
Return Value
Type: void
setPreviousNames(previousNames)
Signature
Parameters
previousNames
Type: List<String>
Return Value
Type: void
setPriority(priority)
Signature
Parameters
priority
Type: Double
Return Value
Type: void
setPrivate(isPrivate)
Signature
Parameters
isPrivate
Type: Boolean
Return Value
Type: void
setPurpose(purpose)
Signature
Parameters
purpose
Type: Slack.Purpose
Return Value
Type: void
setReadOnly(isReadOnly)
Signature
Parameters
isReadOnly
Type: Boolean
Return Value
Type: void
setShared(isShared)
Signature
Parameters
isShared
Type: Boolean
Return Value
Type: void
setSharedTeamIds(sharedTeamIds)
Signature
Parameters
sharedTeamIds
Type: List<String>
Return Value
Type: void
setStarred(isStarred)
Signature
Parameters
isStarred
Type: Boolean
Return Value
Type: void
setThreadOnly(isThreadOnly)
Signature
Parameters
isThreadOnly
Type: Boolean
Return Value
Type: void
setTopic(topic)
Signature
Parameters
topic
Type: Slack.Topic
Return Value
Type
setUnlinked(unlinked)
Signature
Parameters
unlinked
Type: Integer
Return Value
Type: void
setUnreadCount(unreadCount)
Signature
Parameters
unreadCount
Type: Integer
Return Value
Type: void
setUnreadCountDisplay(unreadCountDisplay)
Signature
Parameters
unreadCountDisplay
Type: Integer
Return Value
Type: void
setUser(user)
Signature
Parameters
user
Type: String
Return Value
Type: void
Sends a request to archive a conversation.
Usage
See Slack’s conversations.archive method.
ConversationsArchiveRequest Methods
The following are methods for ConversationsArchiveRequest
.
builder()
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.
ConversationsArchiveRequest.Builder Methods
The following are methods for ConversationsArchiveRequest.Builder
.
build()
Required. Builds an instance of Slack.ConversationsArchiveRequest
.
Signature
Return Value
Type: Slack.ConversationsArchiveRequest
channel(channel)
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.
ConversationsArchiveResponse Methods
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.
ConversationsCloseRequest Methods
builder()
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.
ConversationsCloseRequest.Builder Methods
The following are methods for ConversationsCloseRequest.Builder
.
build()
Required. Builds an instance of Slack.ConversationsCloseRequest
.
Signature
Return Value
Type: Slack.ConversationsCloseRequest
channel(channel)
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.
ConversationsCloseResponse Methods
This class contains standard response methods.
The following are methods for ConversationsCloseResponse
.
getAlreadyClosed()
Specifies whether the conversation is already closed.
Signature
Return Value
Type: Boolean
getNoOp()
Signature
Return Value
Type: Boolean
setAlreadyClosed(alreadyClosed)
Signature
Parameters
alreadyClosed
Type: Boolean
Return Value
Type: void
setNoOp(noOp)
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.
ConversationsCreateRequest Methods
The following are methods for ConversationsCreateRequest
.
builder()
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.
ConversationsCreateRequest.Builder Methods
The following are methods for ConversationsCreateRequest.Builder
. These methods are optional unless specified otherwise.
build()
Required. Builds an instance of Slack.ConversationsCreateRequest
.
Signature
Return Value
Type: Slack.ConversationsCreateRequest
isPrivate(isPrivate)
Signature
Parameters
isPrivate
Type: Boolean
Return Value
Type: Slack.ConversationsCreateRequest.Builder
name(name)
Required. The name of the public or private channel to create.
Signature
Parameters
name
Type: String
Return Value
Type: Slack.ConversationsCreateRequest.Builder
teamId(teamId)
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.
ConversationsCreateResponse Methods
This class contains standard response methods.
The following are methods for ConversationsCreateResponse
.
getChannel()
Signature
Return Value
Type: Slack.Conversation
getDetail()
Signature
Return Value
Type: String
setChannel(channel)
Signature
Parameters
channel
Type: Slack.Conversation
Return Value
Type: void
setDetail(detail)
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.
ConversationsHistoryRequest Methods
The following are methods for ConversationsHistoryRequest
.
builder()
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.
ConversationsHistoryRequest.Builder Methods
The following are methods for ConversationsHistoryRequest.Builder
. These methods are optional unless specified otherwise.
build()
Required. Builds an instance of Slack.ConversationsHistoryRequest
.
Signature
Return Value
Type: Slack.ConversationsHistoryRequest
channel(channel)
Required. The ID of the conversation to fetch history for.
Signature
Parameters
channel
Type
Return Value
Type: Slack.ConversationsHistoryRequest.Builder
cursor(cursor)
Signature
Parameters
cursor
Type: String
Return Value
Type: Slack.ConversationsHistoryRequest.Builder
inclusive(inclusive)
Signature
Parameters
inclusive
Type: Boolean
Return Value
Type: Slack.ConversationsHistoryRequest.Builder
latest(latest)
Signature
Parameters
latest
Type: String
Return Value
Type: Slack.ConversationsHistoryRequest.Builder
limitValue(limitValue)
Signature
Parameters
limitValue
Type: Integer
Return Value
Type: Slack.ConversationsHistoryRequest.Builder
oldest(oldest)
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.
ConversationsHistoryResponse Methods
This class contains standard response methods.
The following are methods for ConversationsHistoryResponse
.
getChannelActionsCount()
Signature
Return Value
Type: Integer
getChannelActionsTs()
Signature
Return Value
Type: String
getLatest()
Signature
Return Value
Type: String
getMessages()
Signature
Return Value
Type: List<Slack.Message>
getPinCount()
Signature
Return Value
Type: Integer
getResponseMetadata()
Signature
Return Value
Type: Slack.ResponseMetadata
isHasMore()
Signature
Return Value
Type: Boolean
setChannelActionsCount(channelActionsCount)
Signature
Parameters
channelActionsCount
Type: Integer
Return Value
Type: void
setChannelActionsTs(channelActionsTs)
Signature
Parameters
channelActionsTs
Type: String
Return Value
Type: void
setHasMore(hasMore)
Signature
Parameters
hasMore
Type: Boolean
Return Value
Type: void
setLatest(latest)
Signature
Parameters
latest
Type: String
Return Value
Type: void
setMessages(messages)
Signature
Parameters
messages
Type: List<Slack.Message>
Return Value
Type: void
setPinCount(pinCount)
Signature
Parameters
pinCount
Type: Integer
Return Value
Type: void
setResponseMetadata(responseMetadata)
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.
ConversationsInfoRequest Methods
The following are methods for ConversationsInfoRequest
.
builder()
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.
ConversationsInfoRequest.Builder Methods
The following are methods for ConversationsInfoRequest.Builder
. These methods are optional unless specified otherwise.
build()
Required. Builds an instance of Slack.ConversationsInfoRequest
.
Signature
Return Value
Type: Slack.ConversationsInfoRequest
channel(channel)
Required. The ID of the conversation to learn more about.
Signature
Parameters
channel
Type: String
Return Value
Type: Slack.ConversationsInfoRequest.Builder
includeLocale(includeLocale)
Signature
Parameters
includeLocale
Type: Boolean
Return Value
Type: Slack.ConversationsInfoRequest.Builder
includeNumMembers(includeNumMembers)
Signature
Parameters
includeNumMembers
Type: Boolean
Return Value
Type: Slack.ConversationsInfoRequest.Builder
Retrieves information about a conversation.
ConversationsInfoResponse Methods
This class contains standard response methods.
The following are methods for ConversationsInfoResponse
.
getChannel()
Signature
Return Value
Type: Slack.Conversation
setChannel(channel)
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.
ConversationsInviteRequest Methods
The following are methods for ConversationsInviteRequest
.
builder()
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.
ConversationsInviteRequest.Builder Methods
The following are methods for ConversationsInviteRequest.Builder
.
build()
Required. Builds an instance of Slack.ConversationsInviteRequest
.
Signature
Return Value
Type: Slack.ConversationsInviteRequest
channel(channel)
Required. The ID of the public or private channel to invite users to.
Signature
Parameters
channel
Type: String
Return Value
Type: Slack.ConversationsInviteRequest.Builder
users(users)
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.
ConversationsInviteResponse Methods
This class contains standard response methods.
The following are methods for ConversationsInviteResponse
.
getChannel()
Signature
Return Value
Type: Slack.Conversation
getErrors()
Signature
Return Value
Type: List<Slack.ConversationsInviteResponse.Error>
setChannel(channel)
Signature
Parameters
channel
Type: Slack.Conversation
Return Value
Type: void
setErrors(errors)
Signature
Parameters
errors
Type: List<Slack.ConversationsInviteResponse.Error>
Return Value
Type: void
ConversationsInviteResponse.Error Methods
The following are methods for ConversationsInviteResponse.Error
.
getError()
Gets the error on the response. See the conversations.invite method’s list of errors.
Signature
Return Value
Type: String
isOk()
Specifies whether the users are invited to the channel successfully.
Signature
Return Value
Type: Boolean
setError(error)
Sets the error message in the response.
Signature
Parameters
error
Type: String
Return Value
Type: void
setOk(ok)
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.
ConversationsJoinRequest Methods
The following are methods for ConversationsJoinRequest
.
builder()
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.
ConversationsJoinRequest.Builder Methods
The following are methods for ConversationsJoinRequest.Builder
.
build()
Required. Builds an instance of Slack.ConversationsJoinRequest
.
Signature
Return Value
Type: Slack.ConversationsJoinRequest
channel(channel)
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.
ConversationsJoinResponse Methods
This class contains standard response methods.
The following are methods for ConversationsJoinResponse
.
getChannel()
Signature `
Return Value
Type: Slack.Conversation
getResponseMetadata()
Signature
Return Value
Type: Slack.WarningResponseMetadata
setChannel(channel)
Signature
Parameters
channel
Type: Slack.Conversation
Return Value
Type: void
setResponseMetadata(responseMetadata)
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.
ConversationsKickRequest Methods
The following are methods for ConversationsKickRequest
.
builder()
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.
ConversationsKickRequest.Builder Methods
The following are methods for ConversationsKickRequest.Builder
.
build()
Required. Builds an instance of Slack.ConversationsKickRequest
.
Signature
Return Value
Type: Slack.ConversationsKickRequest
channel(channel)
Required. The ID of conversation to remove user from.
Signature
Parameters
channel
Type: String
Return Value
Type: Slack.ConversationsKickRequest.Builder
user(user)
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.
ConversationsKickResponse Methods
This class contains standard response methods.
Sends a request to leave a conversation.
Usage
See Slack’s conversations.leave method.
ConversationsLeaveRequest Methods
The following are methods for ConversationsLeaveRequest
.
builder()
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.
ConversationsLeaveRequest.Builder Methods
The following are methods for ConversationsLeaveRequest.Builder
.
build()
Required. Builds an instance of Slack.ConversationsLeaveRequest
.
Signature
Return Value
Type: Slack.ConversationsLeaveRequest
channel(channel)
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.
ConversationsLeaveResponse Methods
This class contains standard response methods.
The following are methods for ConversationsLeaveResponse
.
isNotInChannel()
Signature
Return Value
Type: Boolean
setNotInChannel(notInChannel)
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.
ConversationsListRequest Methods
The following are methods for ConversationsListRequest
.
builder()
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.
ConversationsListRequest.Builder Methods
The following are methods for ConversationsListRequest.Builder
. These methods are optional unless specified otherwise.
build()
Required. Builds an instance of Slack.ConversationsListRequest
.
Signature
Return Value
Type: Slack.ConversationsListRequest
cursor(cursor)
Signature
Parameters
cursor
Type: String
Return Value
Type: Slack.ConversationsListRequest.Builder
excludeArchived(excludeArchived)
Signature
Parameters
excludeArchived
Type: Boolean
Return Value
Type: Slack.ConversationsListRequest.Builder
limitValue(limitValue)
Signature
Parameters
limitValue
Type: Integer
Return Value
Type: Slack.ConversationsListRequest.Builder
teamId(teamId)
Signature
Parameters
teamId
Type: String
Return Value
Type: Slack.ConversationsListRequest.Builder
types(types)
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.
ConversationsListResponse Methods
This class contains standard response methods.
The following are methods for ConversationsListResponse
.
getChannels()
Signature
Return Value
Type: List<Slack.Conversation>
getResponseMetadata()
Signature
Return Value
Type: Slack.ResponseMetadata
setChannels(channels)
Signature
Parameters
channels
Type: List<Slack.Conversation>
Return Value
Type: void
setResponseMetadata(responseMetadata)
Signature
Parameters
responseMetadata
Type: Slack.ResponseMetadata
Sends a request to set the read cursor in a channel.
Usage
See Slack’s conversations.mark method.
ConversationsMarkRequest Methods
builder()
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.
ConversationsMarkRequest.Builder Methods
The following are methods for ConversationsMarkRequest.Builder
.
build()
Required. Builds an instance of Slack.ConversationsMarkRequest
.
Signature
Return Value
Type: Slack.ConversationsMarkRequest
channel(channel)
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
ts(ts)
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.
ConversationsMarkResponse Methods
This class contains standard response methods.
The following are methods for ConversationsMarkResponse
.
getResponseMetadata()
Signature
Return Value
Type: Slack.ResponseMetadata
setResponseMetadata(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.
ConversationsMembersRequest Methods
The following are methods for ConversationsMembersRequest
.
builder()
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.
ConversationsMembersRequest.Builder Methods
The following are methods for ConversationsMembersRequest.Builder
. These methods are optional unless specified otherwise.
build()
Required. Builds an instance of Slack.ConversationsMembersRequest
.
Signature
Return Value
Type: ConversationsMembersRequest
channel(channel)
Required. The ID of the conversation to retrieve members for.
Signature
Parameters
channel
Type: String
Return Value
Type: Slack.ConversationsMembersRequest.Builder
cursor(cursor)
Signature
Parameters
cursor
Type: String
Return Value
Type: Slack.ConversationsMembersRequest.Builder
limitValue(limitValue)
Signature
Parameters
limitValue
Type: Integer
Return Value
Type: Slack.ConversationsMembersRequest.Builder
Retrieves members of a conversation.
Usage
See Slack’s conversation.members method.
ConversationsMembersResponse Methods
This class contains standard response methods.
The following are methods for ConversationsMembersResponse
.
getMembers()
Signature
Return Value
Type: List<String>
getResponseMetadata()
Signature
Return Value
Type: Slack.ResponseMetadata
setMembers(members)
Signature
Parameters
members
Type<String>
Return Value
Type: void
setResponseMetadata(responseMetadata)
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.
ConversationsOpenRequest Methods
The following are methods for ConversationsOpenRequest
.
builder()
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.
ConversationsOpenRequest.Builder Methods
The following are methods for ConversationsOpenRequest.Builder
. These methods are optional unless specified otherwise.
build()
Required. Builds an instance of Slack.ConversationsOpenRequest
.
Signature
Return Value
Type: Slack.ConversationsOpenRequest
channel(channel)
Signature
Parameters
channel
Type: String
Return Value
Type: Slack.ConversationsOpenRequest.Builder
returnIm(returnIm)
Signature
Parameters
returnIm
Type: Boolean
Return Value
Type: Slack.ConversationsOpenRequest.Builder
users(users)
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.
ConversationsOpenResponse Methods
This class contains standard response methods.
The following are methods for ConversationsOpenResponse
.
getChannel()
Signature
Return Value
Type: Slack.Conversation
isAlreadyOpen()
Signature
Return Value
Type: Boolean
isNoOp()
Signature
Return Value
Type: Boolean
setAlreadyOpen(alreadyOpen)
Signature
Parameters
alreadyOpen
Type: Boolean
Return Value
Type: void
setChannel(channel)
Signature
Parameters
channel
Type: Slack.Conversation
Return Value
Type: void
setNoOp(noOp)
Signature
Parameters
noOp
Type: Boolean
Return Value
Type: void
Sends a request to rename a conversation.
Usage
See Slack’s conversations.rename method.
ConversationsRenameRequest Methods
The following are methods for ConversationsRenameRequest
.
builder()
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.
ConversationsRenameRequest.Builder Methods
The following are methods for ConversationsRenameRequest.Builder
.
build()
Required. Builds an instance of Slack.ConversationsRenameRequest
.
Signature
Return Value
Type: Slack.ConversationsRenameRequest
channel(channel)
Required. The ID of conversation to rename.
Signature
Parameters
channel
Type: String
name(name)
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.
ConversationsRenameResponse Methods
This class contains standard response methods.
The following are methods for ConversationsRenameResponse
.
getChannel()
Signature
Return Value
Type: Slack.Conversation
setChannel(channel)
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.
ConversationsRepliesRequest Methods
The following are methods for ConversationsRepliesRequest
.
builder()
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.
ConversationsRepliesRequest.Builder Methods
The following are methods for ConversationsRepliesRequest.Builder
. These methods are optional unless specified otherwise.
build()
Required. Builds an instance of Slack.ConversationsRepliesRequest
.
Signature
Return Value
Type: Slack.ConversationsRepliesRequest
channel(channel)
Required. Conversation ID to fetch thread from.
Signature
Parameters
channel
Type: String
Return Value
Type: Slack.ConversationsRepliesRequest.Builder
cursor(cursor)
Signature
Parameters
cursor
Type: String
Return Value
Type: Slack.ConversationsRepliesRequest.Builder
inclusive(inclusive)
Signature
Parameters
inclusive
Type: Boolean
Return Value
Type: Slack.ConversationsRepliesRequest.Builder
latest(latest)
Signature
Parameters
latest
Type: String
Return Value
Type: Slack.ConversationsRepliesRequest.Builder
limitValue(limitValue)
Signature
Parameters
limitValue
Type: Integer
Return Value
Type: Slack.ConversationsRepliesRequest.Builder
oldest(oldest)
Signature
Parameters
oldest
Type: String
Return Value
Type: Slack.ConversationsRepliesRequest.Builder
ts(ts)
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.
ConversationsRepliesResponse Methods
This class contains standard response methods.
The following are methods for ConversationsRepliesResponse
.
getMessages()
Signature
Return Value
Type: List<Slack.Message>
getResponseMetadata()
Signature
Return Value
Type: Slack.ResponseMetadata
isHasMore()
Signature
Return Value
Type: Boolean
setHasMore(hasMore)
Signature
Parameters
hasMore
Type: Boolean
Return Value
Type: void
setMessages(messages)
Signature
Parameters
messages
Type: List<Slack.Message>
Return Value
Type: void
setResponseMetadata(responseMetadata)
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.
ConversationsSetPurposeRequest Methods
The following are methods for ConversationsSetPurposeRequest
.
builder()
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.
ConversationsSetPurposeRequest.Builder Methods
The following are methods for ConversationsSetPurposeRequest.Builder
.
build()
Signature
Return Value
Type: Slack.ConversationsSetPurposeRequest
channel(channel)
Required. The ID of the conversation to set the purpose for.
Signature
Parameters
channel
Type: String
Return Value
Type: Slack.ConversationsSetPurposeRequest.Builder
purpose(purpose)
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.
ConversationsSetPurposeResponse Methods
This class contains standard response methods.
The following are methods for ConversationsSetPurposeResponse
.
getChannel()
Signature
Return Value
Type: Slack.Conversation
setChannel(channel)
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.
ConversationsSetTopicRequest Methods
builder()
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.
ConversationsSetTopicRequest.Builder Methods
The following are methods for ConversationsSetTopicRequest.Builder
.
build()
Required. Builds an instance of Slack. ConversationsSetTopicRequest
.
Signature
Return Value
Type: Slack.ConversationsSetTopicRequest
channel(channel)
Required. The conversation to set the topic for.
Signature
Parameters
channel
Type: String
Return Value
Type: Slack.ConversationsSetTopicRequest.Builder
topic(topic)
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.
ConversationsSetTopicResponse Methods
This class contains standard response methods.
The following are methods for ConversationsSetTopicResponse
.
getChannel()
Signature
Return Value
Type: Slack.Conversation
setChannel(channel)
Signature
Parameters
channel
Type: Slack.Conversation
Return Value
Type: void
Sends a request to reverse conversation archival.
Usage
See Slack’s conversations.unarchive method.
ConversationsUnarchiveRequest Methods
The following are methods for ConversationsUnarchiveRequest
.
builder()
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.
ConversationsUnarchiveRequest.Builder Methods
The following are methods for ConversationsUnarchiveRequest.Builder
.
build()
Required. Builds an instance of Slack.ConversationsUnarchiveRequest
.
Signature
Return Value
Type: Slack.ConversationsUnarchiveRequest
channel(channel)
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.
ConversationsUnarchiveResponse Methods
This class contains standard response methods.