Work with Messages

Use the Message classes to work with messages in a channel or conversation.

Represents a message in a channel or conversation.

Message Methods

The following are methods for Message.

getBotId()

Signature

Return Value

Type: String

getBotLink()

Signature

Return Value

Type: String

getBotProfile()

Signature

Return Value

Type: Slack.BotProfile

getChannel()

Signature

Return Value

Type: String

getClientMsgId()

Signature

Return Value

Type: String

getComment()

Signature

Return Value

Type: Slack.Message.MessageItem

getEdited()

Signature

Return Value

Type: Slack.Message.Edited

getFile()

Signature

Return Value

Type: Slack.File

getFiles()

Signature

Return Value

Type: List<Slack.File>

getIcons()

Signature

Return Value

Type: Slack.Message.Icons

getInviter()

Signature

Return Value

Type: String

getItem()

Signature

Return Value

Type: Slack.Message.MessageItem

getItemType()

Signature

Return Value

Type: String

getLastRead()

Signature

Return Value

Type: String

getLatestReply()

Signature

Return Value

Type: String

getParentUserId()

Signature

Return Value

Type: String

getPinnedTo()

Signature

Return Value

Type: List<String>

getPurpose()

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

getRoot()

Signature

Return Value

Type: Slack.Message.MessageRoot

getSubtype()

Signature

Return Value

Type: String

getTeam()

Signature

Return Value

Type: String

getText()

Signature

Return Value

Type: String

getThreadTs()

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

getUsername()

Signature

Return Value

Type: String

getXFiles()

Signature

Return Value

Type: List<String>

isDisplayAsBot()

Signature

Return Value

Type: Boolean

isHidden()

Signature

Return Value

Type: Boolean

isIntro()

Signature

Return Value

Type: Boolean

isLocked()

Signature

Return Value

Type: Boolean

isStarred()

Signature

Return Value

Type: Boolean

isSubscribed()

Signature

Return Value

Type: Boolean

isThreadBroadcast()

Signature

Return Value

Type: Boolean

isUnfurlLinks()

Signature

Return Value

Type: Boolean

isUnfurlMedia()

Signature

Return Value

Type: Boolean

isUpload()

Signature

Return Value

Type: Boolean

isWibblr()

Signature

Return Value

Type: Boolean

setBotId(botId)

Signature

Parameters

botId

Type: String

Return Value

Type: void

setBotLink(botLink)

Signature

Parameters

botLink

Type: String

Return Value

Type: void

setBotProfile(botProfile)

Signature

Parameters

botProfile

Type: Slack.BotProfile

Return Value

Type: void

setChannel(channel)

Signature

Parameters

channel

Type: String

Return Value

Type: void

setClientMsgId(clientMsgId)

Signature

Parameters

clientMsgId

Type: String

Return Value

Type: void

setComment(comment)

Signature

Parameters

comment

Type: Slack.Message.MessageItem

Return Value

Type: void

setDisplayAsBot(displayAsBot)

Signature

Parameters

displayAsBot

Type: Boolean

Return Value

Type: void

setEdited(edited)

Signature

Parameters

edited

Type: Slack.Message.Edited

Return Value

Type: void

setFile(file)

Signature

Parameters

file

Type: Slack.File

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

setIcons(icons)

Signature

Parameters

icons

Type: Slack.Message.Icons

Return Value

Type: void

setIntro(intro)

Signature

Parameters

intro

Type: Boolean

Return Value

Type: void

setInviter(inviter)

Signature

Parameters

inviter

Type: String

Return Value

Type: void

setItem(item)

Signature

Parameters

item

Type: Slack.Message.MessageItem

Return Value

Type: void

setItemType(itemType)

Signature

Parameters

itemType

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: Booleean

Return Value

Type: void

setParentUserId(parentUserId)

Signature

Parameters

parentUserId

Type: String

Return Value

Type: void

setPinnedTo(pinnedTo)

Signature

Parameters

pinnedTo

Type: List<String>

Return Value

Type: void

setPurpose(purpose)

Signature

Parameters

purpose

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

setRoot(root)

Signature

Parameters

root

Type: Slack.Message.MessageRoot

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

setThreadBroadcast(threadBroadcast)

Signature

Parameters

threadBroadcast

Type: Boolean

Return Value

Type: void

setThreadTs(threadTs)

Signature

Parameters

threadTs

Type: String

Return Value

Type: void

setTopic(topic)

Signature

Parameters

topic

Type: String

Return Value

Type: void

setTs(ts)

Signature

Parameters

ts

Type:

Return Value

Type: void

setType(type)

Signature

Parameters

type

Type:

Return Value

Type: void

setUnfurlLinks(unfurlLinks)

Signature

Parameters

unfurlLinks

Type:

Return Value

Type: void

setUnfurlMedia(unfurlMedia)

Signature

Parameters

unfurlMedia

Type: Boolean

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

setWibblr(wibblr)

Signature

Parameters

wibblr

Type:

Return Value

Type: void

setXFiles(xFiles)

Signature

Parameters

xFiles

Type: List<String>

Return Value

Type: void


Message.Edited Methods

The following are methods for Message.Edited.

getTs()

Signature

Return Value

Type: String

getUser()

Signature

Return Value

Type: String

setTs(ts)

Signature

Return Value

Type: String

setUser(user)

Signature

Parameters

user

Type: String

Return Value

Type: void


Message.Icons Methods

The following are methods for Message.Icons.

getEmoji()

Signature

Return Value

Type: String

getImage36()

Signature

Return Value

Type: String

getImage48()

Signature

Return Value

Type: String

getImage64()

Signature

Return Value

Type: String

getImage72()

Signature

Return Value

Type: String

setEmoji(emoji)

Signature

Parameters

emoji

Type: String

Return Value

Type: void

setImage36()

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


Message.MessageItem Methods

The following are methods for Message.MessageItem.

getComment()

Signature

Return Value

Type: String

getCreated()

Signature

Return Value

Type: String

getEditLink()

Signature

Return Value

Type: String

getExternalType()

Signature

Return Value

Type: String

getFiletype()

Signature

Return Value

Type: String

getId()

Signature

Return Value

Type: String

getLines()

Signature

Return Value

Type: Integer

getLinesMore()

Signature

Return Value

Type: Integer

getMimetype()

Signature

Return Value

Type: String

getMode()

Signature

Return Value

Type: String

getName()

Signature

Return Value

Type: String

getPermalink()

Signature

Return Value

Type: String

getPrettyType()

Signature

Return Value

Type: String

getPreview()

Signature

Return Value

Type: String

getPreviewHighlight()

Signature

Return Value

Type: String

getSize()

Signature

Return Value

Type: Integer

getTimestamp()

Signature

Return Value

Type: String

getTitle()

Signature

Return Value

Type: String

getUrlPrivate()

Signature

Return Value

Type: String

getUser()

Signature

Return Value

Type: String

getUsername()

Signature

Return Value

Type: String

isDisplayAsBot()

Signature

Return Value

Type: Boolean

isEditable()

Signature

Return Value

Type: Boolean

isExternal()

Signature

Return Value

Type: Boolean

isHasRichPreview()

Signature

Return Value

Type: Boolean

isIntro()

Signature

Return Value

Type: Boolean

isPermalinkPublic()

Signature

Return Value

Type: Boolean

isPreviewTruncated()

Signature

Return Value

Type: Boolean

ispublic()

Signature

Return Value

Type: Boolean

isPublicUrlShared()

Signature

Return Value

Type: Boolean

isStarred()

Signature

Return Value

Type: Boolean

isUrlPrivateDownload()

Signature

Return Value

Type: Boolean

setComment(comment)

Signature

Parameters

comment

Type: String

Return Value

Type: void

setCreated(created)

Signature

Parameters

created

Type: String

Return Value

Type: void

setDisplayAsBot(displayAsBot)

Signature

Parameters

displayAsBot

Type: Boolean

Return Value

Type: void

setEditable(editable)

Signature

Parameters

editable

Type: Boolean

Return Value

Type: void

setEditLink(editLink)

Signature

Parameters

editLink

Type: String

Return Value

Type: void

setExternal(external)

Signature

Parameters

external

Type: Boolean

Return Value

Type: void

setExternalType(externalType)

Signature

Parameters

externalType

Type: String

Return Value

Type: void

setFiletype(filetype)

Signature

Parameters

filetype

Type: String

Return Value

Type: void

setHasRichPreview(hasRichPreview)

Signature

Parameters

hasRichPreview

Type: Boolean

Return Value

Type: void

setId(id)

Signature

Parameters

id

Type: String

Return Value

Type: void

setIntro(intro)

Signature

Parameters

intro

Type: Boolean

Return Value

Type: void

setLines(lines)

Signature

Parameters

lines

Type: Integer

Return Value

Type: void

setLinesMore(linesMore)

Signature

Parameters

linesMore

Type: Integer

Return Value

Type: void

setMimetype(mimetype)

Signature

Parameters

mimetype

Type: String

Return Value

Type: void

setMode(mode)

Signature

Parameters

mode

Type: String

Return Value

Type: void

setName()

Signature

Parameters

name

Type: String

Return Value

Type: void

setPermalink(permalink)

Signature

Parameters

permalink

Type: String

Return Value

Type: void

setPermalinkPublic(permalinkPublic)

Signature

Parameters

permalinkPublic

Type: Boolean

Return Value

Type: void

setPrettyType(prettyType)

Signature

Parameters

prettyType

Type: String

Return Value

Type: void

setPreview(preview)

Signature

Parameters

preview

Type: String

Return Value

Type: void

setPreviewHighlight(previewHighlight)

Signature

Parameters

previewHighlight

Type: String

Return Value

Type: void

setPreviewTruncated(previewTruncated)

Signature

Parameters

previewTruncated

Type: Boolean

Return Value

Type: void

setpublic(_public)

Signature

Parameters

_public

Type: Boolean

Return Value

Type: void

setPublicUrlShared(publicUrlShared)

Signature

Parameters

publicUrlShared

Type: Boolean

Return Value

Type: void

setSize(size)

Signature

Parameters

size

Type: Integer

Return Value

Type: void

setStarred(starred)

Signature

Parameters

starred

Type: Boolean

Return Value

Type: void

setTimestamp(timestamp)

Signature

Parameters

timestamp

Type: String

Return Value

Type: void

setTitle(title)

Signature

Parameters

title

Type: String

Return Value

Type: void

setUrlPrivate(urlPrivate)

Signature

Parameters

urlPrivate

Type: String

Return Value

Type: void

setUrlPrivateDownload(urlPrivateDownload)

Signature

Parameters

urlPrivateDownload

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


Message.MessageRoot Methods

The following are methods for Message.MessageRoot.

getBotId()

Signature

Return Value

Type: String

getBotProfile()

Signature

Return Value

Type: Slack.BotProfile

getEdited()

Signature

Return Value

Type: Slack.Message.Edited

getIcons()

Signature

Return Value

Type: Slack.Message.Icons

getLastRead()

Signature

Return Value

Type: String

getLatestReply()

Signature

Return Value

Type: String

getParentUserId()

Signature

Return Value

Type: String

getReplyCount()

Signature

Return Value

Type: Integer

getReplyUsers()

Signature

Return Value

Type: List<String>

getReplyUsersCount()

Signature

Return Value

Type: Integer

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

getUnreadCount()

Signature

Return Value

Type: Integer

getUser()

Signature

Return Value

Type: String

getUsername()

Signature

Return Value

Type: String

isMrkdwn()

Signature

Return Value

Type: Boolean

isSubscribed()

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

setEdited(edited)

Signature

Parameters

edited

Type: Slack.Message.Edited

Return Value

Type: void

setIcons(icons)

Signature

Parameters

icons

Type: Slack.Message.Icons

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

setMrkdwn(mrkdwn)

Signature

Parameters

mrkdwn

Type: Boolean

Return Value

Type: void

setParentUserId(parentUserId)

Signature

Parameters

parentUserId

Type: String

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

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

setUnreadCount(unreadCount)

Signature

Parameters

unreadCount

Type: Integer

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

Message.MessageRootReply Methods

The following are methods for Message.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