Work with Reactions

The following are Apex classes for the Slack reactions API methods.

Represents a Reaction.

Reaction Methods

The following are methods for Reaction.

getCount()

Signature

Return Value

Type: Integer

getName()

Signature

Return Value

Type: String

getUrl()

Signature

Return Value

Type: String

getUsers()

Signature

Return Value

Type: List<String>

setCount(count)

Signature

Parameters

count

Type: Integer

Return Value

Type: void

setName(name)

Signature

Parameters

name

Type: String

Return Value

Type: void

setUrl(url)

Signature

Parameters

url

Type: String

Return Value

Type: void

setUsers(users)

Signature

Parameters

users

Type: List<String>

Return Value

Type: void

Sends a request to add a reaction to an item.

Usage

See Slack’s reactions.add method.

ReactionsAddRequest Methods

The following are methods for ReactionsAddRequest.

builder()

Builds a request object that's used when executing the API call.

Signature

Contains methods to build an instance of the Slack.ReactionsAddRequest class.

A Builder object is obtained by invoking one of the ReactionsAddRequest.builder methods defined by the ReactionsAddRequest class.

ReactionsAddRequest.Builder Methods

The following are methods for ReactionsAddRequest.Builder. These methods are optional unless specified otherwise.

build()

Required. Returns an instance of Slack.ReactionsAddRequest.

Signature

Return Value

Type: Slack.ReactionsAddRequest

channel(channel)

Required. The channel where the message to add reaction to was posted.

Signature

Parameters

channel

Type: String

Return Value

Type: Slack.ReactionsAddRequest.Builder

file(file)

Signature

Parameters

file

Type: String

Return Value

Type: Slack.ReactionsAddRequest.Builder

fileComment(fileComment)

Signature

Parameters

fileComment

Type: String

Return Value

Type: Slack.ReactionsAddRequest.Builder

name(name)

Required. The reaction (emoji) name.

Signature

Parameters

name

Type: String

Return Value

Type: Slack.ReactionsAddRequest.Builder

timestamp(timestamp)

Required. The timestamp of the message to add reaction to.

Signature

Parameters

timestamp

Type: String


Adds a reaction to an item.

Usage

See Slack’s reactions.add method.

ReactionsAddResponse Methods

This class contains standard response methods.


Sends a request to get reactions for an item.

Usage

See Slack’s reactions.get method.

In this example, the ReactionsGetShortcutDispatcher action runs when a user initiates your shortcut. It uses the ReactionsGetRequest class to parse the response in the view, displaying the message text and the number of reactions to it.

The message_reactions view looks like this.

See the sample app for more information.

ReactionsGetRequest Methods

The following are methods for ReactionsGetRequest.

builder()

Builds a request object that's used when executing the API call.

Signature

Return Value

Type: Slack.ReactionsGetRequest.Builder


Contains methods to build an instance of the Slack.ReactionsGetRequest class.

A Builder object is obtained by invoking one of the ReactionsGetRequest.builder methods defined by the ReactionsGetRequest class.

ReactionsGetRequest.Builder Methods

The following are methods for ReactionsGetRequest.Builder. These methods are optional unless specified otherwise.

build()

Required. Returns an instance of Slack.ReactionsGetRequest.

Signature

Return Value

Type: Slack.ReactionsGetRequest

channel(channel)

The channel where the message to get reactions for was posted.

Signature

Parameters

channel

Type: String

Return Value

Type: Slack.ReactionsGetRequest.Builder

file(file)

The file to get reactions for.

Signature

Parameters

file

Type: String

Return Value

Type: Slack.ReactionsGetRequest.Builder

fileComment(fileComment)

The file comment to get reactions for.

Signature

Parameters

fileComment

Type: String

Return Value

Type: Slack.ReactionsGetRequest.Builder

full(full)

Specifies whether to return the complete reaction list.

Signature

Parameters

full Type: Boolean If true, always return the complete reaction list.

Return Value

Type: Slack.ReactionsGetRequest.Builder

timestamp(timestamp)

Signature

Parameters

timestamp

Type: String

Return Value

Type: Slack.ReactionsGetRequest.Builder


Gets reactions for an item.

Usage

See Slack’s reactions.get method.

ReactionsGetResponse Methods

This class contains standard response methods.

The following are methods for ReactionsGetResponse.

getMessage()

Signature

Return Value

Type: Slack.ReactionsGetResponse.Message

getType()

Signature

Return Value

Type: String

setChannel(channel)

Sets the channel where the message to get reactions for was posted.

Signature

Parameters

channel

Type: String

Return Value

Type: void

setMessage(message)

Signature

Parameters

message

Type: Slack.ReactionsGetResponse.Message

setType(type)

Signature

Parameters

type

Type: String

Return Value

Type: void


ReactionsGetResponse.Message Methods

The following are methods for ReactionsGetResponse.Message.

getBotId()

Signature

Return Value

Type: String

getBotProfile()

Signature

Return Value

Type: Slack.BotProfile

getPermalink()

Signature

Return Value

Type: String

getReactions()

Signature

Return Value

Type: List<Slack.Reaction>

getSubtype()

Signature

Return Value

Type: String

getTeam()

Signature

Return Value

Type: String

getText()

Signature

Return Value

Type: String

getTs()

Signature

Return Value

Type: String

getType()

Signature

Return Value

Type: String

getUser()

Signature

Return Value

Type: String

getUsername()

Signature

Return Value

Type: String

setBotId(botId)

Signature

Parameters

botId

Type: String

Return Value

Type: void

setBotProfile(botProfile)

Signature

Parameters

botProfile

Type: Slack.BotProfile

Return Value

Type: void

setPermalink(permalink)

Signature

Parameters

permalink

Type: String

Return Value

Type: void

setReactions(reactions)

Signature

Parameters

reactions

Type: List<Slack.Reaction>

Return Value

Type: void

setSubtype(subtype)

Signature

Parameters

subtype

Type: String

Return Value

Type: void

setTeam(team)

Signature

Parameters

team

Type: String

setTs(ts)

Signature

Parameters

ts

Type: String

Return Value

Type: void

setType(type)

Signature

Parameters

type

Type: String

Return Value

Type: void

setUser(user)

Signature

Parameters

user Type String

Return Value

Type: void

setUsername(username)

Signature

Parameters

username

Type: String

Return Value

Type: void


Sends a request to list reactions made by a user.

Usage

See Slack's reactions.list method.

ReactionsListRequest Methods

The following are methods for ReactionsListRequest.

builder()

Builds a request object that's used when executing the API call.

Signature

Return Value

Type: Slack.ReactionsListRequest.Builder


Contains methods to build an instance of the Slack.ReactionsListRequest class.

A Builder object is obtained by invoking one of the ReactionsListRequest.builder methods defined by the ReactionsListRequest class.

ReactionsListRequest.Builder Methods

The following are methods for ReactionsListRequest.Builder. These methods are optional unless specified otherwise.

build()

Required. Returns an instance of Slack.ReactionsListRequest.

Signature

Return Value

Type: Slack.ReactionsListRequest

count(count)

Signature

Parameters

count

Type: Integer

Return Value

Type: Slack.ReactionsListRequest.Builder

full(full)

Signature

Parameters

full

Type: Boolean

Return Value

Type: Slack.ReactionsListRequest.Builder

limitValue(limitValue)

Signature

Parameters

limitValue

Type: Integer

Return Value

Type: Slack.ReactionsListRequest.Builder

page(page)

Signature

Parameters

page

Type: Integer

Return Value

Type: Slack.ReactionsListRequest.Builder

teamId(teamId)

Signature

Parameters

teamId

Type: String

Return Value

Type: Slack.ReactionsListRequest.Builder

user(user)

Signature

Parameters

user

Type: String

Return Value

Type: Slack.ReactionsListRequest.Builder


Lists reactions made by a user.

ReactionsListResponse Methods

This class contains standard response methods.

The following are methods for ReactionsListResponse.

getItems()

Signature

Return Value

Type: List<Slack.ReactionsListResponse.Item>

getPaging()

Signature

Return Value

Type: Slack.Paging

setItems(items)

Signature

Parameters

items

Type: List<Slack.ReactionsListResponse.Item>

Return Value

Type: void

setPaging(paging)

Signature

Parameters

paging

Type: Slack.Paging


ReactionsListReponse.Icons Methods

The following are methods for ReactionsListResponse.Icons.

getImage36()

Signature

Return Value

Type: String

getImage48()

Signature

Return Value

Type: String

getImage64()

Signature

Return Value

Type: String

getImage72()

Signature

Return Value

Type: String

setImage36(image36)

Signature

Parameters

image36

Type: String

Return Value

Type: void

setImage48(image48)

Signature

Parameters

image48

Type: String

Return Value

Type: void

setImage64(image64)

Signature

Parameters

image64

Type: String

Return Value

Type: void

setImage72(image72)

Signature

Parameters

image72

Type: String

Return Value

Type: void


ReactionsListReponse.Item Methods

The following are methods for ReactionsListResponse.Item.

getChannel()

Signature

Return Value

Type: String

getMessage()

Signature

Return Value

Type: Slack.ReactionsListResponse.Message

getType()

Signature

Return Value

Type: String

setChannel(channel)

Signature

Parameters

channel

Type: String

Return Value

Type: void

setMessage(message)

Signature

Parameters

message

Type: Slack.ReactionsListResponse.Message

Return Value

Type: void

setType(type)

Signature

Parameters

type

Type: String

Return Value

Type: void


Represents a message in the response, which contains the channel ID for the message.

Usage

See Slack's reactions.list method.

ReactionsListResponse.Message Methods

The following are methods for ReactionsListResponse.Message.

getBotId()

Signature

Return Value

Type: String

getBotProfile()

Signature

Return Value

Type: Slack.BotProfile

getClientMsgId()

Signature

Return Value

Type: String

getFiles()

Signature

Return Value

Type: List<Slack.File>

getIcons()

Signature

Return Value

Type: Slack.ReactionsListResponse.Icons

getInviter()

Signature

Return Value

Type: String

getLastRead()

Signature

Return Value

Type: String

getLatestReply()

Signature

Return Value

Type: String

getParentUserId()

Signature

Return Value

Type: String

getPermalink()

Signature

Return Value

Type: String

getReactions()

Signature

Return Value

Type: List<Slack.Reaction>

getReplyCount()

Signature

Return Value

Type: Integer

getReplyUsers()

Signature

Return Value

Type: List<String>

getReplyUsersCount()

Signature

Return Value

Type: Integer

getSourceTeam()

Signature

Return Value

Type: String

getSubtype()

Signature

Return Value

Type: String

getTeam()

Signature

Return Value

Type: String

getText()

Signature

Return Value

Type: String

getThreadTs()

Signature

Return Value

Type: String

getTs()

Signature

Return Value

Type: String

getType()

Signature

Return Value

Type: String

getUser()

Signature

Return Value

Type: String

getUsername()

Signature

Return Value

Type: String

getUserProfile()

Signature

Return Value

Type: Slack.ReactionsListResponse.UserProfile

getUserTeam()

Signature

Return Value

Type: String

isDisplayAsBot()

Signature

Return Value

Type: Boolean

isLocked()

Signature

Return Value

Type: Boolean

isSubscribed()

Signature

Return Value

Type: Boolean

isUpload()

Signature

Return Value

Type: Boolean

setBotId(botId)

Signature

Parameters

botId

Type: String

Return Value

Type: void

setBotProfile(botProfile)

Signature

Parameters

botProfile

Type: Slack.BotProfile

Return Value

Type: void

setClientMsgId(clientMsgId)

Signature

Parameters

clientMsgId

Type: String

Return Value

Type: void

setDisplayAsBot(displayAsBot)

Signature

Parameters

displayAsBot

Type: Boolean

Return Value

Type: void

setFiles(files)

Signature

Parameters

files

Type: List<Slack.File>

Return Value

Type: void

setIcons(icons)

Signature

Parameters

icons

Type: Slack.ReactionsListResponse.Icons

Return Value

Type: void

setInviter(inviter)

Signature

Parameters

inviter

Type: String

Return Value

Type: void

setLastRead(lastRead)

Signature

Parameters

lastRead

Type: String

Return Value

Type: void

setLatestReply(latestReply)

Signature

Parameters

latestReply

Type: String

Return Value

Type: void

setLocked(locked)

Signature

Parameters

locked

Type: Boolean

Return Value

Type: void

setParentUserId(parentUserId)

Signature

Parameters

parentUserId

Type: String

Return Value

Type: void

setPermalink(permalink)

Signature

Parameters

permalink

Type: String

Return Value

Type: void

setReactions(reactions)

Signature

Parameters

reactions

Type: List<Slack.Reaction>

Return Value

Type: void

setReplyCount(replyCount)

Signature

Parameters

replyCount

Type: Integer

Return Value

Type: void

setReplyUsers(replyUsers)

Signature

Parameters

replyUsers

Type: List<String>

Return Value

Type: void

setReplyUsersCount(replyUsersCount)

Signature

Parameters

replyUsersCount

Type: Integer

Return Value

Type: void

setSourceTeam(sourceTeam)

Signature

Parameters

sourceTeam

Type: String

Return Value

Type: void

setSubscribed(subscribed)

Signature

Parameters

subscribed

Type: Boolean

Return Value

Type: void

setSubtype(subtype)

Signature

Parameters

subtype

Type: String

Return Value

Type: void

setTeam(team)

Signature

Parameters

team

Type: String

Return Value

Type: void

setText(text)

Signature

Parameters

text

Type: String

Return Value

Type: void

setThreadTs(threadTs)

Signature

Parameters

threadTs

Type: String

Return Value

Type: void

setTs(ts)

Signature

Parameters

ts

Type: String

Return Value

Type: void

setType(type)

Signature

Parameters

type

Type: String

Return Value

Type: void

setUpload(upload)

Signature

Parameters

upload

Type: Boolean

Return Value

Type: void

setUser(user)

Signature

Parameters

user

Type: String

Return Value

Type: void

setUsername(username)

Signature

Parameters

username

Type: String

Return Value

Type: void

setUserProfile(userProfile)

Signature

Parameters

userProfile

Type: Slack.ReactionsListResponse.UserProfile

Return Value

Type: void

setUserTeam(userTeam)

Signature

Parameters

userTeam

Type: String

Return Value

Type: void


ReactionsListResponse.MessageRootReply Methods

The following are methods for ReactionsListResponse.MessageRootReply.

getTs()

Signature

Return Value

Type: String

getUser()

Signature

Return Value

Type: String

setTs(ts)

Signature

Parameters

ts

Type: String

Return Value

Type: void

setUser(user)

Signature

Parameters

user

Type: String

Return Value

Type: void


ReactionsListResponse.UserProfile Methods

The following are methods for ReactionsListResponse.UserProfile.

getAvatarHash()

Signature

Return Value

Type: String

getDisplayName()

Signature

Return Value

Type: String

getFirstName()

Signature

Return Value

Type: String

getImage72()

Signature

Return Value

Type: String

getName()

Signature

Return Value

Type: String

getRealName()

Signature

Return Value

Type: String

getTeam()

Signature

Return Value

Type: String

isRestricted()

Signature

Return Value

Type: Boolean

isUltraRestricted()

Signature

Return Value

Type: Boolean

setAvatarHash(avatarHash)

Signature

Parameters

avatarHash

Type: String

Return Value

Type: void

setDisplayName(displayName)

Signature

Parameters

displayName

Type: String

Return Value

Type: void

setFirstName(firstName)

Signature

Parameters

firstName

Type: String

Return Value

Type: void

setImage72(image72)

Signature

Parameters

image72

Type: String

Return Value

Type: void

setName(name)

Signature

Parameters

name

Type: String

Return Value

Type: void

setRealName(realName)

Signature

Parameters

realName

Type: String

Return Value

Type: void

setRestricted(restricted)

Signature

Parameters

restricted

Type: Boolean

Return Value

Type: void

setTeam(team)

Signature

Parameters

team

Type: String

Return Value

Type: void

setUltraRestricted(ultraRestricted)

Signature

Parameters

ultraRestricted

Type: Boolean

Return Value

Type: void


Sends a request to remove a reaction from an item.

Usage

See Slack’s reactions.remove method.

ReactionsRemoveRequest Methods

The following are methods for ReactionsRemoveRequest.

builder()

Builds a request object that's used when executing the API call.

Signature

Return Value

Type: Slack.ReactionsRemoveRequest.Builder


Contains methods to build an instance of the Slack.ReactionsRemoveRequest class.

A Builder object is obtained by invoking one of the ReactionsRemoveRequest.builder methods defined by the ReactionsRemoveRequest class.

ReactionsRemoveRequest.Builder Methods

The following are methods for ReactionsRemoveRequest.Builder. These methods are optional unless specified otherwise. One of file(file), fileComment(fileComment), or the combination of channel(channel) and timestamp(timestamp) must be specified.

build()

Required. Returns an instance of Slack.ReactionsRemoveRequest.

Signature

Return Value

Type: Slack.ReactionsRemoveRequest

channel(channel)

The channel where the message to remove reaction from was posted.

Signature

Parameters

channel

Type: String

Return Value

Type: Slack.ReactionsRemoveRequest.Builder

file(file)

The file to remove reaction from.

Signature

Parameters

file

Type: String

Return Value

Type: Slack.ReactionsRemoveRequest.Builder

fileComment(fileComment)

The file comment to get reactions for.

Signature

Parameters

fileComment

Type: String

Return Value

Type: Slack.ReactionsRemoveRequest.Builder

name(name)

Required. The reaction (emoji) name.

Signature

Parameters

name

Type: String

Return Value

Type: Slack.ReactionsRemoveRequest.Builder

timestamp(timestamp)

Timestamp of the message to remove reaction from.

Signature

Parameters

timestamp

Type: String

Return Value

Type: Slack.ReactionsRemoveRequest.Builder


Removes a reaction from an item.

Usage

See Slack’s reactions.remove method.

ReactionsRemoveResponse Methods

This class contains standard response methods.