Work with Events

The following are Apex classes for the Slack event types.

Represents a Slack event.

Event Methods

The following are methods for Event.

getSubtype()

Signature

Return Value

Type: String

getType()

Signature

Type: String

The Slack.EventDispatcher class enables you to invoke an event handler such as in response to a user opening the app home in Slack.

Usage

Extend the EventDispatcher class and override the invoke() method.

Examples

This example shows an EventDispatcher that handles a user opening the app home.

EventDispatcher Method

EventDispatcher has the following method.

invoke(parameters, context)

Invokes the event handler.

Signature

Parameters

parameters

Type: Slack.EventParameters

The event parameters for the handler.

context

Type: Slack.RequestContext

Describes the context in which a Slack event is invoked.


Represents Slack event parameters.

EventParameters Constructors

The following are constructors for EventParameters.

EventParameters(event, eventId, eventTime)

Creates an instance of the Slack.EventParameters class with the specified event, event ID, and event time.

Signature

Parameters

event

Type: Object

The event object, including the event type, timestamp, and triggering user. See Slack API: Event type structure.

eventId

Type: String

eventTime

Type: Integer

EventParameters Methods

The following are methods for EventParameters.

getEvent()

Signature

Return Value

Type: Object

getEventId()

Signature

Return Value

Type: String

getEventTime()

Signature

Return Value

Type: Integer

Represents the app_home_opened event. This event notifies your app when a user has entered your app home.

Usage

Use the app_home_opened event for an onboarding flow from your app home. See Onboarding with App Home.

This event is only sent to your app when a user has already clicked on your app. It's sent each time a user enters your app home.

Your Slack app must have a bot user configured and installed to use this event.

AppHomeOpenedEvent Methods

The following are methods for AppHomeOpenedEvent.

getChannel()

Signature

Return Value

Type: String

getEventTs()

Gets the event timestamp.

Signature

Return Value

Type: String

getSubtype()

Signature

Return Value

Type: String

getTab()

Gets the name of the tab, for example, home.

Signature

Return Value

Type: String

getType()

Gets the type of event, for example, app_home_opened.

Signature

Return Value

Type: String

getUser()

Gets the user who triggered the event.

Signature

Return Value

Type: String

setChannel(channel)

Signature

Parameters

channel

Type: String

Return Value

Type: void

setEventTs(eventTs)

Sets the event timestamp.

Signature

Parameters

eventTs

Type: String

Return Value

Type: void

setTab(tab)

Sets the name of the tab.

Signature

Parameters

tab

Type: String

Return Value

Type: void

setUser(user)

Sets the user who triggers the event.

Signature

Parameters

user

Type: String

Return Value

Type: void

Represents the app_mention event. This event allows your app to subscribe to message events that directly mention your app or bot.

AppMentionEvent Methods

The following are methods for AppMentionEvent.

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

Represents the emoji_changed event. This event notifies your app when a custom emoji has been added or changed.

EmojiChangedEvent Methods

The following are methods for EmojiChangedEvent.

getEventTs()

Signature

Return Value

Type: String

getName()

Signature

Return Value

Type: String

getNames()

Signature

Return Value

Type: List

getNewName()

Signature

Return Value

Type: String

getOldName()

Signature

Return Value

Type: String

getSubtype()

Signature

Return Value

Type: String

getType()

Signature

Return Value

Type: String

getValue()

Signature

Return Value

Type: String

setEventTs(eventTs)

Signature

Parameters

eventTs

Type: String

Return Value

Type: void

setName(name)

Signature

Parameters

name

Type: String

Return Value

Type: void

setNames(names)

Signature

Parameters

names

Type: List

Return Value

Type: void

setNewName(newName)

Signature

Parameters

newName

Type: String

Return Value

Type: void

setOldName(oldName)

Signature

Parameters

oldName

Type: String

Return Value

Type: void

setSubtype(subtype)

Signature

Parameters

subtype

Type: String

Return Value

Type: void

setValue(value)

Signature

Parameters

value

Type: String

Return Value

Type: void

Represents the bot_message event. This event notifies your app when a message was sent to a channel by a bot.

MessageBotEvent Methods

The following are methods for MessageBotEvent.

getBotId()

Signature

Return Value

Type: String

getChannel()

Signature

Return Value

Type: String

getChannelType()

Signature

Return Value

Type: String

getEventTs()

Signature

Return Value

Type: String

getSubtype()

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

getUsername()

Signature

Return Value

Type: String

setBotId(botId)

Signature

Parameters

botId

Type: String

Return Value

Type: void

setChannel(channel)

Signature

Parameters

channel

Type: String

Return Value

Type: void

setChannelType(channelType)

Signature

Parameters

channelType

Type: String

Return Value

Type: void

setEventTs(eventTs)

Signature

Parameters

eventTs

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

setUsername(username)

Signature

Parameters

username

Type: String

Return Value

Type: void

Represents the message_changed event. This event notifies your app when a message in a channel is edited.

MessageChangedEvent Methods

The following are methods for MessageChangedEvent.

getChannel()

Signature

Return Value

Type: String

getChannelType()

Signature

Return Value

Type: String

getEventTs()

Signature

Return Value

Type: String

getMessage()

Signature

Return Value

Type: Slack.MessageChangedEvent.Message

getPreviousMessage()

Signature

Return Value

Type: Slack.MessageChangedEvent.PreviousMessage

getSubtype()

Signature

Return Value

Type: String

getTs()

Signature

Return Value

Type: String

getType()

Signature

Return Value

Type: String

isHidden()

Signature

Return Value

Type: Boolean

setChannel(channel)

Signature

Parameters

channel

Type: String

Return Value

Type: void

setChannelType(channelType)

Signature

Parameters

channelType

Type: String

Return Value

Type: void

setEventTs(eventTs)

Signature

Parameters

eventTs

Type: String

Return Value

Type: void

setHidden(hidden)

Signature

Parameters

hidden

Type: Boolean

Return Value

Type: void

setMessage(message)

Signature

Parameters

message

Type: Slack.MessageChangedEvent.Message

Return Value

Type: void

setPreviousMessage(previousMessage)

Signature

Parameters

previousMessage

Type: Slack.MessageChangedEvent.PreviousMessage

Return Value

Type: void

setTs(ts)

Signature

Parameters

ts

Type: String

Return Value

Type: void

MessageChangedEvent.Edited Methods

The following are methods for MessageChangedEvent.Edited.

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

MessageChangedEvent.Message Methods

The following are methods for MessageChangedEvent.Message.

getBotId()

Signature

Return Value

Type: String

getBotProfile()

Signature

Return Value

Type: Slack.BotProfile

getClientMsgId()

Signature

Return Value

Type: String

getDisplayAsBot()

Signature

Return Value

Type: Boolean

getFiles()

Signature

Return Value

Type: List<Slack.File>

getHidden()

Signature

Return Value

Type: Boolean

getIsLocked()

Signature

Return Value

Type: Boolean

getLastRead()

Signature

Return Value

Type: String

getLatestReply()

Signature

Return Value

Type: String

getParentUserId()

Signature

Return Value

Type: String

getPinnedTo()

Signature

Return Value

Type: List

getReactions()

Signature

Return Value

Type: List<Slack.Reaction>

getReplyCount()

Signature

Return Value

Type: Integer

getReplyUsers()

Signature

Return Value

Type: List

getReplyUsersCount()

Signature

Return Value

Type: Integer

getSourceTeam()

Signature

Return Value

Type: String

getSubscribed()

Signature

Return Value

Type: Boolean

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

getUpload()

Signature

Return Value

Type: Boolean

getUser()

Signature

Return Value

Type: String

getUserTeam()

Signature

Return Value

Type: String

getXFiles()

Signature

Return Value

Type: List

isStarred()

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

setHidden(hidden)

Signature

Parameters

hidden

Type: Boolean

Return Value

Type: void

setIsLocked(isLocked)

Signature

Parameters

isLocked

Type: Boolean

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

setParentUserId(parentUserId)

Signature

Parameters

parentUserId

Type: String

Return Value

Type: void

setPinnedTo(pinnedTo)

Signature

Parameters

pinnedTo

Type: List

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

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

setStarred(starred)

Signature

Parameters

starred

Type: Boolean

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

setUpload(upload)

Signature

Parameters

upload

Type: Boolean

Return Value

Type: void

setUser(user)

Signature

Parameters

user

Type: String

Return Value

Type: void

setUserTeam(userTeam)

Signature

Parameters

userTeam

Type: String

Return Value

Type: void

setXFiles(xFiles)

Signature

Parameters

xFiles

Type: List

Return Value

Type: void

MesssageChangedEvent.PreviousMessage Methods

The following are methods for MesssageChangedEvent.PreviousMessage.

getMessage()

Signature

Return Value

Type: Slack.MessageChangedEvent.Message

setMessage(message)

Signature

Parameters

message

Type: Slack.MessageChangedEvent.Message

Return Value

Type: void

Represents the channel_join event. This event notifies your app when a user joins a channel.

MessageChannelJoinEvent Methods

The following are methods for MessageChannelJoinEvent.

Represents the channel_posting_permissions event. This event notifies your app that the posting permissions for a channel have been modified by a user.

MessageChannelPostingPermissionsEvent Methods

The following are methods for MessageChannelPostingPermissionsEvent.

Represents the channel_topic event. This event notifies your app that the topic for a channel is changed.

MessageChannelTopicEvent Methods

The following are methods for MessageChannelTopicEvent.

Represents the message_deleted event. This event notifies your app when a message in a channel is deleted.

MessageDeletedEvent Methods

The following are methods for MessageDeletedEvent.

getChannel()

Signature

Return Value

Type: String

getChannelType()

Signature

Return Value

Type: String

getDeletedTs()

Signature

Return Value

Type: String

getEventTs()

Signature

Return Value

Type: String

getPreviousMessage()

Signature

Return Value

Type: Slack.MessageDeletedEvent.Message

getSubtype()

Signature

Return Value

Type: String

getTs()

Signature

Return Value

Type: String

getType()

Signature

Return Value

Type: String

isHidden()

Signature

Return Value

Type: Boolean

setChannel(channel)

Signature

Parameters

channel

Type: String

setChannelType(channelType)

Signature

Parameters

channel

Type: String

Return Value

Type: void

setDeletedTs(deletedTs)

Signature

Parameters

deletedTs

Type: String

Return Value

Type: void

setEventTs(eventTs)

Signature

Parameters

eventTs

Type: String

Return Value

Type: void

setHidden(hidden)

Signature

Parameters

hidden

Type: Boolean

Return Value

Type: void

setPreviousMessage(previousMessage)

Signature

Parameters

previousMessage

Type: Slack.MessageDeletedEvent.Message

Return Value

Type: void

setTs(ts)

Signature

Parameters

ts

Type: String

Return Value

Type: void

MessageDeletedEvent.Edited Methods

The following are methods for MessageDeletedEvent.Edited.

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

Represents the ekm_access_denied event. This event notifies your app when a piece of content is redacted by a workspace's administrators.

MessageEkmAccessDeniedEvent Methods

The following are methods for MessageEkmAccessDeniedEvent.

getChannel()

Signature

Return Value

Type: String

getChannelType()

Signature

Return Value

Type: String

getEventTs()

Signature

Return Value

Type: String

getSubtype()

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

isHidden()

Signature

Return Value

Type: Boolean

setChannel(channel)

Signature

Parameters

channel

Type: String

setChannelType(channelType)

Signature

Parameters

channelType

Type: String

Return Value

Type: void

setEventTs(eventTs)

Signature

Parameters

eventTs

Type: String

Return Value

Type: void

setHidden(hidden)

Signature

Parameters

hidden

Type: Boolean

Return Value

Type: void

setText(text)

Signature

Parameters

text

Type: String

Return Value

Type: void

setTs(ts)

Signature

Parameters

eventTs

Type: String

Return Value

Type: void

setUser(user)

Signature

Parameters

user

Type: String

Return Value

Type: void

MessageEvent Methods

The following are methods for MessageEvent.

getBotId()

Signature

Return Value

Type: String

getBotProfile()

Signature

Return Value

Type: Slack.BotProfile

getChannel()

Signature

Return Value

Type: String

getChannelType()

Signature

Return Value

Type: String

getClientMsgId()

Signature

Return Value

Type: String

getEdited()

Signature

Return Value

Type: Slack.MessageEvent.Edited

getEventTs()

Signature

Return Value

Type: String

getFiles()

Signature

Return Value

Type: List<Slack.File>

getParentUserId()

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

setBotId(botId)

Signature

Parameters

botId

Type: String

Return Value

Type: void

setBotProfile(botProfile)

Description?

Signature

Parameters

botProfilem

Type: setBotProfile

Return Value

Type: void

setChannel(channel)

Signature

Parameters

channel

Type: String

Return Value

Type: void

setChannelType(channelType)

Signature

Parameters

channelType

Type: String

Return Value

Type: void

setClientMsgId(clientMsgId)

Signature

Parameters

clientMsgId

Type: String

Return Value

Type: void

setEdited(edited)

Signature

Parameters

edited

Type: Slack.MessageEvent.Edited

Return Value

Type: void

setEventTs(eventTs)

Signature

Parameters

eventTs

Type: String

Return Value

Type: void

setFiles(files)

Signature

Parameters

files

Type: List<Slack.File>

Return Value

Type: void

setParentUserId(parentUserId)

Signature

Parameters

parentUserId

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

setUser(user)

Signature

Parameters

user

Type: String

Return Value

Type: void

MessageEvent.Edited Methods

The following are methods for MessageEvent.Edited.

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

Represents the file_share event. This event notifies your app when a file is shared in a channel.

MessageFileShareEvent Methods

The following are methods for MessageFileShareEvent.

getChannel()

Signature

Return Value

Type: String

getChannelType()

Signature

Return Value

Type: String

getDisplayAsBot()

Signature

Return Value

Type: Boolean

getEventTs()

Signature

Return Value

Type: String

getFiles()

Signature

Return Value

Type: List<Slack.File>

getParentUserId()

Signature

Return Value

Type: String

getSubtype()

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

getUpload()

Signature

Return Value

Type: Boolean

getUser()

Signature

Return Value

Type: String

getXFiles()

Signature

Return Value

Type: List<String>

setChannel(channel)

Signature

Parameters

channel

Type: String

Return Value

Type: void

setChannelType(channelType)

Signature

Parameters

channelType

Type: String

Return Value

Type: void

setDisplayAsBot(displayAsBot)

Signature

Parameters

displayAsBot

Type: Boolean

Return Value

Type: void

setEventTs(eventTs)

Signature

Parameters

eventTs

Type: String

Return Value

Type: void

setFiles(files)

Signature

Parameters

files

Type: List<Slack.File>

Return Value

Type: void

setParentUserId(parentUserId)

Signature

Parameters

parentUserId

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

setUpload(upload)

Signature

Parameters

upload

Type: Boolean

Return Value

Type: void

setUser(user)

Signature

Parameters

user

Type: String

Return Value

Type: void

setXFiles(xFiles)

Signature

Parameters

xFiles

Type: List<String>

Return Value

Type: void

Represents the group_topic event. This event notifies your app when the topic for a private group is changed.

MessageGroupTopicEvent Methods

The following are methods for MessageGroupTopicEvent.

getChannel()

Signature

Return Value

Type: String

getChannelType()

Signature

Return Value

Type: String

getEventTs()

Signature

Return Value

Type: String

getSubtype()

Signature

Return Value

Type: String

getText()

Signature

Return Value

Type: String

getTopic()

Signature

Return Value

Type: String

getTs()

Signature

Return Value

Type: String

getType()

Signature

Return Value

Type: String

getUser()

Signature

Return Value

Type: String

setChannel(channel)

Signature

Parameters

channel

Type: String

Return Value

Type: void

setChannelType(channelType)

Signature

Parameters

channelType

Type: String

Return Value

Type: void

setEventTs(eventTs)

Signature

Parameters

eventTs

Type: String

Return Value

Type: void

setText(text)

Signature

Parameters

text

Type: String

Return Value

Type: void

setTopic(topic)

Signature

Parameters

topic

Type: String

Return Value

Type: void

setTs(ts)

Signature

Parameters

ts

Type: String

Return Value

Type: void

setUser(user)

Signature

Parameters

user

Type: String

Return Value

Type: void

Represents the me_message event. This event notifies your app when a channel member performs an action using the /me command.

MessageMeEvent Methods

The following are methods for MessageMeEvent.

getBotId()

Signature

Return Value

Type: String

getChannel()

Signature

Return Value

Type: String

getChannelType()

Signature

Return Value

Type: String

getEventTs()

Signature

Return Value

Type: String

getSubtype()

Signature

Return Value

Type: String

getText()

Signature

Return Value

Type: String

getTs()

Signature

Return Value

Type: String

getType()

Signature

Return Value

Type: String

getUsername()

Signature

Return Value

Type: String

setBotId(botId)

Signature

Parameters

botId

Type: String

Return Value

Type: void

setChannel(channel)

Signature

Parameters

channel

Type: String

Return Value

Type: void

setChannelType(channelType)

Signature

Parameters

channelType

Type: String

Return Value

Type: void

setEventTs(eventTs)

Signature

Parameters

eventTs

Type: String

Return Value

Type: void

setText(text)

Signature

Parameters

text

Type: String

Return Value

Type: void

setTs(ts)

Signature

Parameters

ts

Type: String

Return Value

Type: void

setUsername(username)

Signature

Parameters

username

Type: String

Return Value

Type: void

Represents the message_replied event. This event notifies your app when a channel's message is a reply to another message (its parent).

MessageRepliedEvent Methods

The following are methods for MessageRepliedEvent.

getChannel()

Signature

Return Value

Type: String

getEventTs()

Signature

Return Value

Type: String

getMessage()

Signature

Return Value

Type: Slack.MessageRepliedEvent.Message

getSubtype()

Signature

Return Value

Type: String

getTs()

Signature

Return Value

Type: String

getType()

Signature

Return Value

Type: String

isHidden()

Signature

Return Value

Type: Boolean

setChannel(channel)

Signature

Parameters

channel

Type: String

Return Value

Type: void

setEventTs(eventTs)

Signature

Parameters

eventTs

Type: String

Return Value

Type: void

setHidden(hidden)

Signature

Parameters

hidden

Type: Boolean

Return Value

Type: void

setMessage(message)

Signature

Parameters

param

Type: String

Return Value

Type: void

setTs(ts)

Signature

Parameters

ts

Type: String

Return Value

Type: void

MessageRepliedEvent.Edited Methods

The following are methods for MessageRepliedEvent.Edited.

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

MessageRepliedEvent.Message Methods

The following are methods for MessageRepliedEvent.Message.

getClientMsgId()

Signature

Return Value

Type: String

getPinnedTo()

Signature

Return Value

Type: List

getReactions()

Signature

Return Value

Type: List<Slack.Reaction>

getSourceTeam()

Signature

Return Value

Type: String

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

getUserTeam()

Signature

Return Value

Type: String

isStarred()

Signature

Return Value

Type: Boolean

setClientMsgId(clientMsgId)

Signature

Parameters

clientMsgId

Type: String

Return Value

Type: void

setPinnedTo(pinnedTo)

Signature

Parameters

pinnedTo

Type: List

Return Value

Type: void

setReactions(reactions)

Signature

Parameters

reactions

Type: List<Slack.Reaction>

Return Value

Type: void

setSourceTeam(sourceTeam)

Signature

Parameters

sourceTeam

Type: String

Return Value

Type: void

setStarred(starred)

Signature

Parameters

starred

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

setTs(ts)

Signature

Parameters

ts

Type: String

Return Value

Type: void

setUser(user)

Signature

Parameters

user

Type: String

Return Value

Type: void

setUserTeam(userTeam)

Signature

Parameters

userTeam

Type: String

Return Value

Type: void

Represents the thread_broadcast event. This event notifies your app when a user or bot user has indicated their reply should be broadcast to the whole channel.

MessageThreadBroadcastEvent Methods

The following are methods for MessageThreadBroadcastEvent.

getChannel()

Signature

Return Value

Type: String

getChannelType()

Signature

Return Value

Type: String

getClientMsgId()

Signature

Return Value

Type: String

getEventTs()

Signature

Return Value

Type: String

getSubtype()

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

setChannel(channel)

Signature

Parameters

channel

Type: String

Return Value

Type: void

setChannelType(channelType)

Signature

Parameters

channelType

Type: String

Return Value

Type: void

setClientMsgId(clientMsgId)

Signature

Parameters

clientMsgId

Type: String

Return Value

Type: void

setEventTs(eventTs)

Signature

Parameters

eventTs

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

setUser(user)

Signature

Parameters

user

Type: String

Return Value

Type: void

Represents the pin_added event. This event notifies your app when an item is pinned in a channel.

PinAddedEvent Methods

The following are methods for PinAddedEvent.

getChannelId()

Signature

Return Value

Type: String

getEventTs()

Signature

Return Value

Type: String

getItem()

Signature

Return Value

Type: Slack.PinAddedEvent.Item

getItemUser()

Signature

Return Value

Type: String

getPinCount()

Signature

Return Value

Type: Integer

getPinnedInfo()

Signature

Return Value

Type: Slack.PinAddedEvent.PinnedInfo

getSubtype()

Signature

Return Value

Type: String

getType()

Signature

Return Value

Type: String

getUser()

Signature

Return Value

Type: String

setChannelId(channelId)

Signature

Parameters

channelId

Type: String

Return Value

Type: void

setEventTs(eventTs)

Signature

Parameters

eventTs

Type: String

Return Value

Type: void

setItem(item)

Signature

Parameters

item

Type: Slack.PinAddedEvent.Item

Return Value

Type: void

setItemUser(itemUser)

Signature

Parameters

itemUser

Type: String

Return Value

Type: void

setPinCount(pinCount)

Signature

Parameters

pinCount

Type: Integer

Return Value

Type: void

setPinnedInfo(pinnedInfo)

Signature

Parameters

pinnedInfo

Type: Slack.PinAddedEvent.PinnedInfo

Return Value

Type: void

setUser(user)

Signature

Parameters

user

Type: String

Return Value

Type: void

PinAddedEvent.Item Methods

The following are methods for PinAddedEvent.Item.

getChannel()

Signature

Return Value

Type: String

getComment()

Signature

Return Value

Type: Slack.FileComment

getCreated()

Signature

Return Value

Type: Integer

getCreatedBy()

Signature

Return Value

Type: String

getFile()

Signature

Return Value

Type: Slack.File

getMessage()

Signature

Return Value

Type: Slack.PinAddedEvent.Message

getType()

Signature

Return Value

Type: String

setChannel(channel)

Signature

Parameters

channel

Type: String

Return Value

Type: void

setComment(comment)

Signature

Parameters

comment

Type: Slack.FileComment

Return Value

Type: void

setCreated(created)

Signature

Parameters

created

Type: Integer

Return Value

Type: void

setCreatedBy(createdBy)

Signature

Parameters

createdBy

Type: String

Return Value

Type: void

setFile(file)

Signature

Parameters

file

Type: Slack.File

Return Value

Type: void

setMessage(message)

Signature

Parameters

message

Type: Slack.PinAddedEvent.Message

Return Value

Type: void

setType(type)

Signature

Parameters

type

Type: String

Return Value

Type: void

PinAddedEvent.Message Methods

The following are methods for PinAddedEvent.Message.

getAppId()

Signature

Return Value

Type: String

getBotId()

Signature

Return Value

Type: String

getBotProfile()

Signature

Return Value

Type: Slack.BotProfile

getClientMsgId()

Signature

Return Value

Type: String

getPermalink()

Signature

Return Value

Type: String

getPinnedTo()

Signature

Return Value

Type: List

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

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

setPermalink(permalink)

Signature

Parameters

permalink

Type: String

Return Value

Type: void

setPinnedTo(pinnedTo)

Signature

Parameters

pinnedTo

Type: List

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

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

PinAddedEvent.PinnedInfo Methods

The following are methods for PinAddedEvent.PinnedInfo.

getChannel()

Signature

Return Value

Type: String

getPinnedBy()

Signature

Return Value

Type: String

getPinnedTs()

Signature

Return Value

Type: Long

setChannel(channel)

Signature

Parameters

channel

Type: String

Return Value

Type: void

setPinnedBy(pinnedBy)

Signature

Parameters

pinnedBy

Type: String

Return Value

Type: void

setPinnedTs(pinnedTs)

Signature

Parameters

pinnedTs

Type: Long

Return Value

Type: void

Represents the pin_removed event. This event notifies your app when a pin is removed from a channel.

PinRemovedEvent Methods

The following are methods for PinRemovedEvent.

getChannelId()

Signature

Return Value

Type: String

getEventTs()

Signature

Return Value

Type: String

getItem()

Signature

Return Value

Type: Slack.PinRemovedEvent.Item

getItemUser()

Signature

Return Value

Type: String

getPinCount()

Signature

Return Value

Type: Integer

getPinnedInfo()

Signature

Return Value

Type: Slack.PinRemovedEvent.PinnedInfo

getSubtype()

Signature

Return Value

Type: String

getType()

Signature

Return Value

Type: String

getUser()

Signature

Return Value

Type: String

isHasPins()

Signature

Return Value

Type: Boolean

setChannelId(channelId)

Signature

Parameters

channelId

Type: String

Return Value

Type: void

setEventTs(eventTs)

Signature

Parameters

eventTs

Type: String

Return Value

Type: void

setHasPins(hasPins)

Signature

Parameters

hasPins

Type: Boolean

Return Value

Type: void

setItem(item)

Signature

Parameters

item

Type: Slack.PinRemovedEvent.Item

Return Value

Type: void

setItemUser(itemUser)

Signature

Parameters

param

Type: String

Return Value

Type: void

setPinCount(pinCount)

Signature

Parameters

pinCount

Type: Integer

Return Value

Type: void

setUser(user)

Signature

Parameters

user

Type: String

Return Value

Type: void

PinRemovedEvent.Item Methods

The following are methods for PinRemovedEvent.Item.

getChannel()

Signature

Return Value

Type: String

getComment()

Signature

Return Value

Type: Slack.FileComment

getCreated()

Signature

Return Value

Type: Integer

getCreatedBy()

Signature

Return Value

Type: String

getFile()

Signature

Return Value

Type: Slack.File

getMessage()

Signature

Return Value

Type: Slack.PinRemovedEvent.Message

getType()

Signature

Return Value

Type: String

setChannel(channel)

Signature

Parameters

channel

Type: String

Return Value

Type: void

setComment(comment)

Signature

Parameters

comment

Type: Slack.FileComment

Return Value

Type: void

setCreated(created)

Signature

Parameters

created

Type: Integer

Return Value

Type: void

setCreatedBy(createdBy)

Signature

Parameters

createdBy

Type: String

Return Value

Type: void

setFile(file)

Signature

Parameters

file

Type: Slack.File

Return Value

Type: void

setMessage(message)

Signature

Parameters

message

Type: Slack.PinRemovedEvent.Message

Return Value

Type: void

setType(type)

Signature

Parameters

type

Type: String

Return Value

Type: void

PinRemovedEvent.Message Methods

The following are methods for PinRemovedEvent.Message.

getAppId()

Signature

Return Value

Type: String

getBotId()

Signature

Return Value

Type: String

getBotProfile()

Signature

Return Value

Type: Slack.BotProfile

getClientMsgId()

Signature

Return Value

Type: String

getPermalink()

Signature

Return Value

Type: String

getPinnedTo()

Signature

Return Value

Type: List

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

setAppId(appId)

Signature

Parameters

appId

Type: String

Return Value

Type: void

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

setPermalink(permalink)

Signature

Parameters

permalink

Type: String

Return Value

Type: void

setPinnedTo(pinnedTo)

Signature

Parameters

pinnedTo

Type: List

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

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

PinRemovedEvent.PinnedInfo Methods

The following are methods for PinRemovedEvent.PinnedInfo.

getChannel()

Signature

Return Value

Type: String

getPinnedBy()

Signature

Return Value

Type: String

getPinnedTs()

Signature

Return Value

Type: Long

setChannel(channel)

Signature

Parameters

channel

Type: String

Return Value

Type: void

setPinnedBy(pinnedBy)

Signature

Parameters

pinnedBy

Type: String

Return Value

Type: void

setPinnedTs(pinnedTs)

Signature

Parameters

pinnedTs

Type: Long

Return Value

Type: void

Represents the reaction_added event. This event notifies your app when a reaction is added to an item.

ReactionAddedEvent Methods

The following are methods for ReactionAddedEvent.

getEventTs()

Signature

Return Value

Type: String

getItem()

Signature

Return Value

Type: Slack.ReactionAddedEvent.Item

getItemUser()

Signature

Return Value

Type: String

getReaction()

Signature

Return Value

Type: String

getSubtype()

Signature

Return Value

Type: String

getType()

Signature

Return Value

Type: String

getUser()

Signature

Return Value

Type: String

setEventTs(eventTs)

Signature

Parameters

eventTs

Type: String

Return Value

Type: void

setItem(item)

Signature

Parameters

item

Type: Slack.ReactionAddedEvent.Item

Return Value

Type: void

setItemUser(itemUser)

Signature

Parameters

itemUser

Type: String

Return Value

Type: void

setReaction(reaction)

Signature

Parameters

reaction

Type: String

Return Value

Type: void

setUser(user)

Sets the user who triggers the event.

Signature

Parameters

user

Type: String

Return Value

Type: void

ReactionAddedEvent.Item Methods

The following are methods for ReactionAddedEvent.Item.

getChannel()

Signature

Return Value

Type: String

getFile()

Signature

Return Value

Type: String

getFileComment()

Signature

Return Value

Type: String

getTs()

Signature

Return Value

Type: String

getType()

Signature

Return Value

Type: String

setChannel(channel)

Signature

Parameters

channel

Type: String

Return Value

Type: void

setFile(file)

Signature

Parameters

file

Type: String

Return Value

Type: void

setFileComment(fileComment)

Signature

Parameters

fileComment

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

Represents the reaction_removed event. This event notifies your app when a reaction is removed from an item.

ReactionRemovedEvent Methods

The following are methods for ReactionRemovedEvent.

getEventTs()

Signature

Return Value

Type: String

getItem()

Signature

Return Value

Type: Slack.ReactionRemovedEvent.Item

getItemUser()

Signature

Return Value

Type: String

getReaction()

Signature

Return Value

Type: String

getSubtype()

Signature

Return Value

Type: String

getType()

Signature

Return Value

Type: String

getUser()

Signature

Return Value

Type: String

setEventTs(eventTs)

Signature

Parameters

eventTs

Type: String

Return Value

Type: void

setItem(item)

Signature

Parameters

item

Type: Slack.ReactionRemovedEvent.Item

Return Value

Type: void

setItemUser(itemUser)

Signature

Parameters

itemUser

Type: String

Return Value

Type: void

setReaction(reaction)

Signature

Parameters

reaction

Type: String

Return Value

Type: void

setUser(user)

Sets the user who triggers the event.

Signature

Parameters

user

Type: String

Return Value

Type: void

ReactionRemovedEvent.Item Methods

The following are methods for ReactionRemovedEvent.Item.

getChannel()

Signature

Return Value

Type: String

getFile()

Signature

Return Value

Type: String

getFileComment()

Signature

Return Value

Type: String

getTs()

Signature

Return Value

Type: String

getType()

Signature

Return Value

Type: String

setChannel(channel)

Signature

Parameters

channel

Type: String

Return Value

Type: void

setFile(file)

Signature

Parameters

file

Type: String

Return Value

Type: void

setFileComment(fileComment)

Signature

Parameters

fileComment

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

Represents the star_added event. This event notifies your app when an item is starred.

StarAddedEvent Methods

The following are methods for StarAddedEvent.

getEventTs()

Signature

Return Value

Type: String

getItem()

Signature

Return Value

Type: Slack.StarAddedEvent.Item

getSubtype()

Signature

Return Value

Type: String

getType()

Signature

Return Value

Type: String

getUser()

Signature

Return Value

Type: String

setEventTs(eventTs)

Signature

Parameters

eventTs

Type: String

Return Value

Type: void

setItem(item)

Signature

Parameters

item

Type: Slack.StarAddedEvent.Item

Return Value

Type: void

setUser(user)

Signature

Parameters

user

Type: String

Return Value

Type: void

StarAddedEvent.Edited Methods

The following are methods for StarAddedEvent.Edited.

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

StarAddedEvent.Item Methods

The following are methods for StarAddedEvent.Item.

getChannel()

Signature

Return Value

Type: String

getComment()

Signature

Return Value

Type: Slack.FileComment

getCreatedBy()

Signature

Return Value

Type: String

getDateCreate()

Signature

Return Value

Type: Long

getFile()

Signature

Return Value

Type: Slack.File

getMessage()

Signature

Return Value

Type: Slack.StarAddedEvent.Messagering

getType()

Signature

Return Value

Type: String

setChannel(channel)

Signature

Parameters

channel

Type: String

Return Value

Type: void

setComment(comment)

Signature

Parameters

comment

Type: Slack.FileComment

Return Value

Type: void

setCreatedBy(createdBy)

Signature

Parameters

createdBy

Type: String

Return Value

Type: void

setDateCreate(dateCreate)

Signature

Parameters

dateCreate

Type: Long

Return Value

Type: void

setFile(file)

Signature

Parameters

file

Type: Slack.File

Return Value

Type: void

setMessage(message)

Signature

Parameters

message

Type: Slack.StarAddedEvent.Message

Return Value

Type: void

setType(type)

Signature

Parameters

type

Type: String

Return Value

Type: void

StarAddedEvent.Message Methods

The following are methods for StarAddedEvent.Message.

getAppId()

Signature

Return Value

Type: String

getBotId()

Signature

Return Value

Type: String

getBotProfile()

Signature

Return Value

Type: Slack.BotProfile

getClientMsgId()

Signature

Return Value

Type: String

getEdited()

Signature

Return Value

Type: Slack.StarAddedEvent.Edited

getPermalink()

Signature

Return Value

Type: String

getPinnedTo()

Signature

Return Value

Type: List

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

isStarred()

Signature

Return Value

Type: String

setAppId(appId)

Signature

Parameters

appId

Type: String

Return Value

Type: void

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

setEdited(edited)

Signature

Parameters

edited

Type: Slack.StarAddedEvent.Edited

Return Value

Type: void

setPermalink(permalink)

Signature

Parameters

permalink

Type: String

Return Value

Type: void

setPinnedTo(pinnedTo)

Signature

Parameters

pinnedTo

Type: List

Return Value

Type: void

setStarred(isStarred)

Signature

Parameters

isStarred

Type: Boolean

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

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

Represents the star_removed event. This event notifies your app when a star is removed from an item.

StarRemovedEvent Methods

The following are methods for StarRemovedEvent.

getEventTs()

Signature

Return Value

Type: String

getItem()

Signature

Return Value

Type: Slack.StarRemovedEvent.Item

getSubtype()

Signature

Return Value

Type: String

getType()

Signature

Return Value

Type: String

getUser()

Signature

Return Value

Type: String

setEventTs(eventTs)

Signature

Parameters

eventTs

Type: String

Return Value

Type: void

setItem(item)

Signature

Parameters

item

Type: Slack.StarRemovedEvent.Item

Return Value

Type: void

setUser(user)

Signature

Parameters

user

Type: String

Return Value

Type: void

StarRemovedEvent.Edited Methods

The following are methods for StarRemovedEvent.Edited.

getEventTs()

Signature

Return Value

Type: String

getItem()

Signature

Return Value

Type: Slack.StarRemovedEvent.Item

getSubtype()

Signature

Return Value

Type: String

getType()

Signature

Return Value

Type: String

getUser()

Signature

Return Value

Type: String

setEventTs(eventTs)

Signature

Parameters

eventTs

Type: String

Return Value

Type: void

setItem(item)

Signature

Parameters

item

Type: Slack.StarRemovedEvent.Item

Return Value

Type: void

setUser(user)

Signature

Parameters

user

Type: String

Return Value

Type: void

StarRemovedEvent.Item Methods

The following are methods for StarRemovedEvent.Item.

getChannel()

Signature

Return Value

Type: String

getComment()

Signature

Return Value

Type: Slack.FileComment

getCreatedBy()

Signature

Return Value

Type: String

getDateCreate()

Signature

Return Value

Type: Long

getFile()

Signature

Return Value

Type: Slack.File

getMessage()

Signature

Return Value

Type: Slack.StarRemovedEvent.Message

getType()

Signature

Return Value

Type: String

setChannel(channel)

Signature

Parameters

channel

Type: String

Return Value

Type: void

setComment(comment)

Signature

Parameters

comment

Type: Slack.FileComment

Return Value

Type: void

setCreatedBy(createdBy)

Signature

Parameters

createdBy

Type: String

Return Value

Type: void

setDateCreate(dateCreate)

Signature

Parameters

dateCreate

Type: Long

Return Value

Type: void

setFile(file)

Signature

Parameters

file

Type: Slack.File

Return Value

Type: void

setMessage(message)

Signature

Parameters

message

Type: Slack.StarRemovedEvent.Message

Return Value

Type: void

setType(type)

Signature

Parameters

type

Type: String

Return Value

Type: void

StarRemovedEvent.Message Methods

The following are methods for StarRemovedEvent.Message.

getAppId()

Signature

Return Value

Type: String

getBotId()

Signature

Return Value

Type: String

getBotProfile()

Signature

Return Value

Type: Slack.BotProfile

getClientMsgId()

Signature

Return Value

Type: String

getEdited()

Signature

Return Value

Type: Slack.StarRemovedEvent.Edited

getPermalink()

Signature

Return Value

Type: String

getPinnedTo()

Signature

Return Value

Type: List

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

setAppId(appId)

Signature

Parameters

appId

Type: String

Return Value

Type: void

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

setEdited(edited)

Signature

Parameters

edited

Type: Slack.StarRemovedEvent.Edited

Return Value

Type: void

setPermalink(permalink)

Signature

Parameters

permalink

Type: String

Return Value

Type: void

setPinnedTo(pinnedTo)

Signature

Parameters

pinnedTo

Type: List

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

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

Represents the subteam_created event. This event notifies your app when a user group has been added to the workspace.

SubteamCreatedEvent Methods

The following are methods for SubteamCreatedEvent.

getEventTs()

Signature

Return Value

Type: String

getSubteam()

Signature

Return Value

Type: Slack.SubteamCreatedEvent.Subteam

getSubtype()

Signature

Return Value

Type: String

getType()

Signature

Return Value

Type: String

setEventTs(eventTs)

Signature

Parameters

eventTs

Type: String

Return Value

Type: void

setSubteam(subteam)

Signature

Parameters

subteam

Type: Slack.SubteamCreatedEvent.Subteam

Return Value

Type: void

SubteamCreatedEvent.Prefs Methods

The following are methods for SubteamCreatedEvent.Prefs.

getChannels()

Signature

Return Value

Type: List

getGroups()

Signature

Return Value

Type: List

setChannels(channels)

Signature

Parameters

channels

Type: List

Return Value

Type: void

setGroups(groups)

Signature

Parameters

groups

Type: List

Return Value

Type: void

SubteamCreatedEvent.Subteam Methods

The following are methods for SubteamCreatedEvent.Subteam.

getAutoType()

Signature

Return Value

Type: String

getChannelCount()

Signature

Return Value

Type: Integer

getCreatedBy()

Signature

Return Value

Type: String

getDateCreate()

Signature

Return Value

Type: Integer

getDateDelete()

Signature

Return Value

Type: Integer

getDateUpdate()

Signature

Return Value

Type: Integer

getDeletedBy()

Signature

Return Value

Type: String

getDescription()

Signature

Return Value

Type: String

getEnterpriseSubteamId()

Signature

Return Value

Type: String

getHandle()

Signature

Return Value

Type: String

getId()

Signature

Return Value

Type: String

getName()

Signature

Return Value

Type: String

getPrefs()

Signature

Return Value

Type: Slack.SubteamCreatedEvent.Prefs

getTeamId()

Signature

Return Value

Type: String

getUpdatedBy()

Signature

Return Value

Type: String

getUserCount()

Signature

Return Value

Type: Integer

getUsers()

Signature

Return Value

Type: List

isAutoProvision()

Signature

Return Value

Type: Boolean

isExternal()

Signature

Return Value

Type: Boolean

isSubteam()

Signature

Return Value

Type: Boolean

isUsergroup()

Signature

Return Value

Type: Boolean

setAutoProvision(autoProvision)

Signature

Parameters

autoProvision

Type: Boolean

Return Value

Type: void

setAutoType(autoType)

Signature

Parameters

autoType

Type: String

Return Value

Type: void

setChannelCount(channelCount)

Signature

Parameters

channelCount

Type: Integer

Return Value

Type: void

setCreatedBy(createdBy)

Signature

Parameters

createdBy

Type: String

Return Value

Type: void

setDateCreate(dateCreate)

Signature

Parameters

dateCreate

Type: Integer

Return Value

Type: void

setDateDelete(dateDelete)

Signature

Parameters

dateDelete

Type: Integer

Return Value

Type: void

setDateUpdate(dateUpdate)

Signature

Parameters

dateUpdate

Type: Integer

Return Value

Type: void

setDeletedBy(deletedBy)

Signature

Parameters

deletedBy

Type: String

Return Value

Type: void

setDescription(description)

Signature

Parameters

description

Type: String

Return Value

Type: void

setEnterpriseSubteamId(enterpriseSubteamId)

Signature

Parameters

enterpriseSubteamId

Type: String

Return Value

Type: void

setExternal(external)

Signature

Parameters

external

Type: Boolean

Return Value

Type: void

setHandle(handle)

Signature

Parameters

handle

Type: String

Return Value

Type: void

setId(id)

Signature

Parameters

id

Type: String

Return Value

Type: void

setName(name)

Signature

Parameters

name

Type: String

Return Value

Type: void

setPrefs(prefs)

Signature

Parameters

prefs

Type: Slack.SubteamCreatedEvent.Prefs

Return Value

Type: void

setSubteam(isSubteam)

Signature

Parameters

isSubteam

Type: Boolean

Return Value

Type: void

setTeamId(teamId)

Signature

Parameters

teamId

Type: String

Return Value

Type: void

setUpdatedBy(updatedBy)

Signature

Parameters

updatedBy

Type: String

Return Value

Type: void

setUserCount(userCount)

Signature

Parameters

userCount

Type: Integer

Return Value

Type: void

setUsergroup(isUsergroup)

Signature

Parameters

isUsergroup

Type: Boolean

Return Value

Type: void

setUsers(users)

Signature

Parameters

users

Type: List

Return Value

Type: void

Represents the subteam_members_changed event. This event notifies your app when the membership of an existing user group has changed.

SubteamMembersChangedEvent Methods

The following are methods for SubteamMembersChangedEvent.

getAddedUsers()

Signature

Return Value

Type: List<String>

getAddedUsersCount()

Signature

Return Value

Type: Integer

getDatePreviousUpdate()

Signature

Return Value

Type: Integer

getDateUpdate()

Signature

Return Value

Type: Integer

getEventTs()

Signature

Return Value

Type: String

getRemovedUsers()

Signature

Return Value

Type: List<String>

getRemovedUsersCount()

Signature

Return Value

Type: Integer

getSubteamId()

Signature

Return Value

Type: String

getSubtype()

Signature

Return Value

Type: String

getTeamId()

Signature

Return Value

Type: String

getType()

Signature

Return Value

Type: String

setAddedUsers(addedUsers)

Signature

Parameters

addedUsers

Type: List<String>

Return Value

Type: void

setAddedUsersCount(addedUsersCount)

Signature

Parameters

addedUsersCount

Type: Integer

Return Value

Type: void

setDatePreviousUpdate(datePreviousUpdate)

Signature

Parameters

datePreviousUpdate

Type: Integer

Return Value

Type: void

setDateUpdate(dateUpdate)

Signature

Parameters

dateUpdate

Type: Integer

Return Value

Type: void

setEventTs(eventTs)

Signature

Parameters

eventTs

Type: String

Return Value

Type: void

setRemovedUsers(removedUsers)

Signature

Parameters

removedUsers

Type: List<String>

Return Value

Type: void

setRemovedUsersCount(removedUsersCount)

Signature

Parameters

param

Type: String

Return Value

Type: void

setSubteamId(subteamId)

Signature

Parameters

subteamId

Type: String

Return Value

Type: void

setTeamId(teamId)

Signature

Parameters

teamId

Type: String

Return Value

Type: void

Represents the subteam_self_added event. This event notifies your app when you have been added to a user group.

SubteamSelfAddedEvent Methods

The following are methods for SubteamSelfAddedEvent.

getEventTs()

Signature

Return Value

Type: String

getSubteamId()

Signature

Return Value

Type: String

getSubtype()

Signature

Return Value

Type: String

getType()

Signature

Return Value

Type: String

setEventTs(eventTs)

Signature

Parameters

eventTs

Type: String

Return Value

Type: void

setSubteamId(subteamId)

Signature

Parameters

subteamId

Type: String

Return Value

Type: void

Represents the subteam_self_removed event. This event notifies your app when you have been removed from a user group.

SubteamSelfRemovedEvent Methods

The following are methods for SubteamSelfRemovedEvent.

getEventTs()

Signature

Return Value

Type: String

getSubteamId()

Signature

Return Value

Type: String

getSubtype()

Signature

Return Value

Type: String

getType()

Signature

Return Value

Type: String

setEventTs(eventTs)

Signature

Parameters

eventTs

Type: String

Return Value

Type: void

setSubteamId(subteamId)

Signature

Parameters

param

Type: String

Return Value

Type: void

Represents the subteam_updated event. This event notifies you when an existing user group has been updated or its members changed.

SubteamUpdatedEvent Methods

The following are methods for SubteamUpdatedEvent.

getEventTs()

Signature

Return Value

Type: String

getSubteam()

Signature

Return Value

Type: Slack.SubteamUpdatedEvent.Subteam

getSubtype()

Signature

Return Value

Type: String

getType()

Signature

Return Value

Type: String

setEventTs(eventTs)

Signature

Parameters

eventTs

Type: String

Return Value

Type: void

setSubteam(subteam)

Signature

Parameters

subteam

Type: Slack.SubteamUpdatedEvent.Subteam

Return Value

Type: void

SubteamUpdatedEvent Methods

The following are methods for SubteamUpdatedEvent.Prefs.

getChannels()

Signature

Return Value

Type: List

getGroups()

Signature

Return Value

Type: List

setChannels(channels)

Signature

Parameters

channels

Type: List

Return Value

Type: void

setGroups(groups)

Signature

Parameters

groups

Type: List

Return Value

Type: void

SubteamUpdatedEvent.Subteam Methods

The following are methods for SubteamUpdatedEvent.Subteam.

getAutoType()

Signature

Return Value

Type: String

getChannelCount()

Signature

Return Value

Type: Integer

getCreatedBy()

Signature

Return Value

Type: String

getDateCreate()

Signature

Return Value

Type: Integer

getDateDelete()

Signature

Return Value

Type: Integer

getDateUpdate()

Signature

Return Value

Type: Integer

getDeletedBy()

Signature

Return Value

Type: String

getDescription()

Signature

Return Value

Type: String

getEnterpriseSubteamId()

Signature

Return Value

Type: String

getHandle()

Signature

Return Value

Type: String

getId()

Signature

Return Value

Type: String

getName()

Signature

Return Value

Type: String

getPrefs()

Signature

Return Value

Type: Slack.SubteamUpdatedEvent.Prefs

getTeamId()

Signature

Return Value

Type: String

getUpdatedBy()

Signature

Return Value

Type: String

getUserCount()

Signature

Return Value

Type: Integer

getUsers()

Signature

Return Value

Type: List

isAutoProvision()

Signature

Return Value

Type: Boolean

isExternal()

Signature

Return Value

Type: Boolean

isSubteam()

Signature

Return Value

Type: Boolean

isUsergroup()

Signature

Return Value

Type: Boolean

setAutoProvision(autoProvision)

Signature

Parameters

autoProvision

Type: Boolean

Return Value

Type: void

setAutoType(autoType)

Signature

Parameters

autoType

Type: String

Return Value

Type: void

setChannelCount(channelCount)

Signature

Parameters

channelCount

Type: Integer

Return Value

Type: void

setCreatedBy(createdBy)

Signature

Parameters

createdBy

Type: String

Return Value

Type: void

setDateCreate(dateCreate)

Signature

Parameters

dateCreate

Type: Integer

Return Value

Type: void

setDateDelete(dateDelete)

Signature

Parameters

dateDelete

Type: Integer

Return Value

Type: void

setDateUpdate(dateUpdate)

Signature

Parameters

dateUpdate

Type: Integer

Return Value

Type: void

setDeletedBy(deletedBy)

Signature

Parameters

deletedBy

Type: String

Return Value

Type: void

setDescription(description)

Signature

Parameters

description

Type: String

Return Value

Type: void

setEnterpriseSubteamId(enterpriseSubteamId)

Signature

Parameters

enterpriseSubteamId

Type: String

Return Value

Type: void

setExternal(isExternal)

Signature

Parameters

isExternal

Type: Boolean

Return Value

Type: void

setHandle(handle)

Signature

Parameters

handle

Type: String

Return Value

Type: void

setId(id)

Signature

Parameters

id

Type: String

Return Value

Type: void

setName(name)

Signature

Parameters

name

Type: String

Return Value

Type: void

setPrefs(prefs)

Signature

Parameters

prefs

Type: Slack.SubteamUpdatedEvent.Prefs

Return Value

Type: void

setSubteam(isSubteam)

Signature

Parameters

isSubteam

Type: Boolean

Return Value

Type: void

setTeamId(teamId)

Signature

Parameters

teamId

Type: String

Return Value

Type: void

setUpdatedBy(updatedBy)

Signature

Parameters

updatedBy

Type: String

Return Value

Type: void

setUserCount(userCount)

Signature

Parameters

userCount

Type: Integer

Return Value

Type: void

setUsergroup(isUsergroup)

Signature

Parameters

isUsergroup

Type: Boolean

Return Value

Type: void

setUsers(users)

Signature

Parameters

users

Type: List

Return Value

Type: void

Represents the team_access_granted event. This event notifies your app when access to a set of teams was granted to your org app.

TeamAccessGrantedEvent Methods

The following are methods for TeamAccessGrantedEvent.

getEventTs()

Signature

Return Value

Type: String

getSubtype()

Signature

Return Value

Type: String

getTeamIds()

Signature

Return Value

Type: List<String>

getType()

Signature

Return Value

Type: String

setEventTs(eventTs)

Signature

Parameters

eventTs

Type: String

Return Value

Type: void

setTeamIds(teamIds)

Signature

Parameters

teamIds

Type: List<String>

Return Value

Type: void

Represents the team_access_revoked event. This event notifies your app when access to a set of teams was revoked from your org app.

TeamAccessRevokedEvent Methods

The following are methods for TeamAccessRevokedEvent.

getEventTs()

Signature

Return Value

Type: String

getSubtype()

Signature

Return Value

Type: String

getTeamIds()

Signature

Return Value

Type: List<String>

getType()

Signature

Return Value

Type: String

setEventTs(eventTs)

Signature

Parameters

eventTs

Type: String

Return Value

Type: void

setTeamIds(teamIds)

Signature

Parameters

teamIds

Type: List<String>

Return Value

Type: void

Represents the team_domain_change event. This event notifies the app when the workspace domain has changed.

TeamDomainChangeEvent Methods

The following are methods for TeamDomainChangeEvent.

getDomain()

Signature

Return Value

Type: String

getSubtype()

Signature

Return Value

Type: String

getType()

Signature

Return Value

Type: String

getUrl()

Signature

Return Value

Type: String

setDomain(domain)

Signature

Parameters

domain

Type: String

Return Value

Type: void

setUrl(url)

Signature

Parameters

url

Type: String

Return Value

Type: void

Represents the team_join event. This event notifies your app when a new member has joined.

TeamJoinEvent Methods

The following are methods for TeamJoinEvent.

getSubtype()

Signature

Return Value

Type: String

getType()

Signature

Return Value

Type: String

getUser()

Signature

Return Value

Type: Slack.User

setUser(user)

Signature

Parameters

user

Type: Slack.User

Return Value

Type: void

Represents the team_rename event. This event notifies your app when the workspace name has changed.

TeamRenameEvent Methods

The following are methods for TeamRenameEvent.

getName()

Signature

Return Value

Type: String

getSubtype()

Signature

Return Value

Type: String

getType()

Signature

Return Value

Type: String

setName(name)

Signature

Parameters

name

Type: String

Return Value

Type: void

Represents the tokens_revoked event. This event notifies your app when the API tokens for your app were revoked.

TokensRevokedEvent Methods

The following are methods for TokensRevokedEvent.

getSubtype()

Signature

Return Value

Type: String

getTokens()

Signature

Return Value

Type: Slack.TokensRevokedEvent.Tokens

getType()

Signature

Return Value

Type: String

setTokens(tokens)

Signature

Parameters

tokens

Type: Slack.TokensRevokedEvent.Tokens

Return Value

Type: void

TokensRevokedEvent.Tokens Methods

The following are methods for TokensRevokedEvent.Tokens.

getBot()

Signature

Return Value

Type: List

getOauth()

Signature

Return Value

Type: List

setBot(bot)

Signature

Parameters

bot

Type: List

Return Value

Type: void

setOauth(oauth)

Signature

Parameters

oauth

Type: List

Return Value

Type: void

Represents the user_change event. This event notifies your app when a member's data has changed.

UserChangeEvent Methods

The following are methods for UserChangeEvent.

getCacheTs()

Signature

Return Value

Type: Integer

getSubtype()

Signature

Return Value

Type: String

getType()

Signature

Return Value

Type: String

getUser()

Signature

Return Value

Type: Slack.User

setCacheTs(cacheTs)

Signature

Parameters

cacheTs

Type: Integer

Return Value

Type: void

Represents the user_resource_denied event. This event notifies your app when a user resource was denied to your app.

UserResourceDeniedEvent Methods

The following are methods for UserResourceDeniedEvent.

getScopes()

Signature

Return Value

Type: List<String>

getSubtype()

Signature

Return Value

Type: String

getTriggerId()

Signature

Return Value

Type: String

getType()

Signature

Return Value

Type: String

getUser()

Signature

Return Value

Type: String

setScopes(scopes)

Signature

Parameters

scopes

Type: List<String>

Return Value

Type: void

setTriggerId(triggerId)

Signature

Parameters

triggerId

Type: String

Return Value

Type: void

setUser(user)

Signature

Parameters

user

Type: String

Return Value

Type: void

Deprecated. See Deprecated Events. Represents the user_resource_granted event. This event notifies your app when a user resource was granted to your app.

UserResourceGrantedEvent Methods

The following are methods for UserResourceGrantedEvent.

getScopes()

Signature

Return Value

Type: List<String>

getSubtype()

Signature

Return Value

Type: String

getTriggerId()

Signature

Return Value

Type: String

getType()

Signature

Return Value

Type: String

getUser()

Signature

Return Value

Type: String

setScopes(scopes)

Signature

Parameters

scopes

Type: List<String>

Return Value

Type: void

setTriggerId(triggerId)

Signature

Parameters

triggerId

Type: String

Return Value

Type: void

setUser(user)

Signature

Parameters

user

Type: String

Return Value

Type: void

Deprecated. See Deprecated Events. Represents the user_resource_removed event. This event notifies your app when a user resource was removed from your app.

UserResourceRemovedEvent Methods

The following are methods for UserResourceRemovedEvent.

getSubtype()

Signature

Return Value

Type: String

getTriggerId()

Signature

Return Value

Type: String

getType()

Signature

Return Value

Type: String

getUser()

Signature

Return Value

Type: String

setTriggerId(triggerId)

Signature

Parameters

triggerId

Type: String

Return Value

Type: void

setUser(user)

Signature

Parameters

user

Type: String

Return Value

Type: void