Work with Search

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

MatchedItem Class

Represents an item that matches a search query.

MatchedItem Methods

The following are methods for MatchedItem.

getBotId()

Signature

public String getBotId()

Return Value

Type: String

getCc()

Signature

public List<Slack.MatchedItem.Address> getCc()

Return Value

Type: List<Slack.MatchedItem.Address>

getChannel()

Signature

public Slack.Channel getChannel()

Return Value

Type: Slack.Channel

getChannelActionsCount()

Signature

public Integer getChannelActionsCount()

Return Value

Type: Integer

getChannelActionsTs()

Signature

public String getChannelActionsTs()

Return Value

Type: String

getChannels()

Signature

public List<String> getChannels()

Return Value

Type: List<String>

getComment()

Signature

public String getComment()

Return Value

Type: String

getCreated()

Signature

public String getCreated()

Return Value

Type: String

getDeanimateGif()

Signature

public String getDeanimateGif()

Return Value

Type: String

getEditLink()

Signature

public String getEditLink()

Return Value

Type: String

getEditor()

Signature

public String getEditor()

Return Value

Type: String

getExternalId()

Signature

public String getExternalId()

Return Value

Type: String

getExternalType()

Signature

public String getExternalType()

Return Value

Type: String

getExternalUrl()

Signature

public String getExternalUrl()

Return Value

Type: String

getFileId()

Signature

public String getFileId()

Return Value

Type: String

getFiletype()

Signature

public String getFiletype()

Return Value

Type: String

getFrom()

Signature

public List<Slack.MatchedItem.Address> getFrom()

Return Value

Type: List<Slack.MatchedItem.Address>

getGroups()

Signature

public List<String> getGroups()

Return Value

Type: List<String>

getId()

The ID of the matching file item.

Signature

public String getId()

Return Value

Type: String

getIid()

Gets the ID of the matching message item.

Signature

public String getIid()

Return Value

Type: String

getImageExifRotation()

Signature

public Integer getImageExifRotation()

Return Value

Type: Integer

getIms()

Signature

public List<String> getIms()

Return Value

Type: List<String>

getLastEditor()

Signature

public String getLastEditor()

Return Value

Type: String

getLines()

Signature

public Integer getLines()

Return Value

Type: Integer

getLinesMore()

Signature

public Integer getLinesMore()

Return Value

Type: Integer

getMimetype()

Signature

public String getMimetype()

Return Value

Type: String

getMode()

Signature

public String getMode()

Return Value

Type: String

getName()

Signature

public String getName()

Return Value

Type: String

getNext()

Signature

public Slack.MatchedItem.OtherItem getNext()

Return Value

Type: Slack.MatchedItem.OtherItem

getNext2()

Signature

public Slack.MatchedItem.OtherItem getNext2()

Return Value

Type: Slack.MatchedItem.OtherItem

getOriginalHeight()

Signature

public String getOriginalHeight()

Return Value

Type: String

getOriginalWidth()

Signature

public String getOriginalWidth()

Return Value

Type: String

getPermalink()

Signature

public String getPermalink()

Return Value

Type: String

getPlainText()

Signature

public String getPlainText()

Return Value

Type: String

getPrettyType()

Signature

public String getPrettyType()

Return Value

Type: String

getPreview()

Signature

public String getPreview()

Return Value

Type: String

getPreviewHighlight()

Signature

public String getPreviewHighlight()

Return Value

Type: String

getPreviewPlainText()

Signature

public String getPreviewPlainText()

Return Value

Type: String

getPrevious()

Signature

public Slack.MatchedItem.OtherItem getPrevious()

Return Value

Type: Slack.MatchedItem.OtherItem

getPrevious2()

Signature

public Slack.MatchedItem.OtherItem getPrevious2()

Return Value

Type: Slack.MatchedItem.OtherItem

getScore()

Signature

public String getScore()

Return Value

Type: String

getSize()

Signature

public Integer getSize()

Return Value

Type: Integer

getSourceTeam()

Signature

public String getSourceTeam()

Return Value

Type: String

getSubject()

Signature

public String getSubject()

Return Value

Type: String

getTeam()

Signature

public String getTeam()

Return Value

Type: String

getText()

Signature

public String getText()

Return Value

Type: String

getThumb64()

Signature

public String getThumb64()

Return Value

Type: String

getThumb64Gif()

Signature

public String getThumb64Gif()

Return Value

Type: String

getThumb64Height()

Signature

public String getThumb64Height()

Return Value

Type: String

getThumb64Width()

Signature

public String getThumb64Width()

Return Value

Type: String

getThumb80()

Signature

public String getThumb80()

Return Value

Type: String

getThumb80Gif()

Signature

public String getThumb80Gif()

Return Value

Type: String

getThumb80Height()

Signature

public String getThumb80Height()

Return Value

Type: String

getThumb80Width()

Signature

public String getThumb80Width()

Return Value

Type: String

getThumb160()

Signature

public String getThumb160()

Return Value

Type: String

getThumb160Gif()

Signature

public String getThumb160Gif()

Return Value

Type: String

getThumb160Height()

Signature

public String getThumb160Height()

Return Value

Type: String

getThumb160Width()

Signature

public String getThumb160Width()

Return Value

Type: String

getThumb360()

Signature

public String getThumb360()

Return Value

Type: String

getThumb360Gif()

Signature

public String getThumb360Gif()

Return Value

Type: String

getThumb360Height()

Signature

public String getThumb360Height()

Return Value

Type: String

getThumb360Width()

Signature

public String getThumb360Width()

Return Value

Type: String

getThumb480()

Signature

public String getThumb480()

Return Value

Type: String

getThumb480Gif()

Signature

public String getThumb480Gif()

Return Value

Type: String

getThumb480Height()

Signature

public String getThumb480Height()

Return Value

Type: String

getThumb480Width()

Signature

public String getThumb480Width()

Return Value

Type: String

getThumb720()

Signature

public String getThumb720()

Return Value

Type: String

getThumb720Gif()

Signature

public String getThumb720Gif()

Return Value

Type: String

getThumb720Height()

Signature

public String getThumb720Height()

Return Value

Type: String

getThumb720Width()

Signature

public String getThumb720Width()

Return Value

Type: String

getThumb800()

Signature

public String getThumb800()

Return Value

Type: String

getThumb800Gif()

Signature

public String getThumb800Gif()

Return Value

Type: String

getThumb800Height()

Signature

public String getThumb800Height()

Return Value

getThumb800Width()

Signature

public String getThumb800Width()

Return Value

Type: String

getThumb960()

Signature

public String getThumb960()

Return Value

Type: String

getThumb960Gif()

Signature

public String getThumb960Gif()

Return Value

Type: String

getThumb960Height()

Signature

public String getThumb960Height()

Return Value

Type: String

getThumb960Width()

Signature

public String getThumb960Width()

Return Value

Type: String

getThumb1024()

Signature

public String getThumb1024()

Return Value

Type: String

getThumb1024Gif()

Signature

public String getThumb1024Gif()

Return Value

Type: String

getThumb1024Height()

Signature

public String getThumb1024Height()

Return Value

Type: String

getThumb1024Width()

Signature

public String getThumb1024Width()

Return Value

Type: String

getThumbPdf()

Signature

public String getThumbPdf()

Return Value

Type: String

getThumbPdfHeight()

Signature

public String getThumbPdfHeight()

Return Value

Type: String

getThumbPdfWidth()

Signature

public String getThumbPdfWidth()

Return Value

Type: String

getThumbTiny()

Signature

public String getThumbTiny()

Return Value

Type: String

getTimestamp()

Signature

public String getTimestamp()

Return Value

Type: String

getTitle()

Signature

public String getTitle()

Return Value

Type: String

getTo()

Signature

public List<Slack.MatchedItem.Address> getTo()

Return Value

Type: List<Slack.MatchedItem.Address>

getTs()

Signature

public String getTs()

Return Value

Type: String

getType()

Signature

public String getType()

Return Value

Type: String

getUpdated()

Signature

public Integer getUpdated()

Return Value

Type: Integer

getUrlPrivate()

Signature

public String getUrlPrivate()

Return Value

Type: String

getUser()

Signature

public String getUser()

Return Value

Type: String

getUserTeam()

Signature

public String getUsername()

Return Value

Type: String

getUsername()

Signature

public String getUserTeam()

Return Value

Type: String

isDisplayAsBot()

Signature

public Boolean isDisplayAsBot()

Return Value

Type: Boolean

isEditable()

Signature

public Boolean isEditable()

Return Value

Type: Boolean

isExternal()

Signature

public Boolean isExternal()

Return Value

Type: Boolean

isHasMore()

Signature

public Boolean isHasMore()

Return Value

Type: Booolean

isHasRichPreview()

Signature

public Boolean isHasRichPreview()

Return Value

Type: Boolean

isMpim()

Signature

public Boolean isMpim()

Return Value

Type: Boolean

isNonOwnerEditable()

Signature

public Boolean isNonOwnerEditable()

Return Value

Type: Boolean

isNoReactions()

Signature

public Boolean isNoReactions()

Return Value

Type: Boolean

isPermalinkPublic()

Signature

public Boolean isPermalinkPublic()

Return Value

Type: Boolean

isPreviewTruncated()

Signature

public Boolean isPreviewTruncated()

Return Value

Type: Boolean

ispublic()

Signature

public Boolean ispublic()

Return Value

Type: Boolean

isPublicUrlShared()

Signature

public Boolean isPublicUrlShared()

Return Value

Type: Boolean

isSentToSelf()

Signature

public Boolean isSentToSelf()

Return Value

Type: Boolean

isStarred()

Signature

public Boolean isStarred()

Return Value

Type: Boolean

isTopFile()

Signature

public Boolean isTopFile()

Return Value

Type: Boolean

isUrlPrivateDownload()

Signature

public Boolean isUrlPrivateDownload()

Return Value

Type: Boolean

setBotId(botId)

Signature

public void setBotId(String botId)

Parameters

botId

Type: String

Return Value

Type: void

setCc(cc)

Signature

public void setCc(List<Slack.MatchedItem.Address> cc)

Parameters

cc

Type: List<Slack.MatchedItem.Address>

Return Value

Type: void

setChannel(channel)

Signature

public void setChannel(Slack.Channel channel)

Parameters

channel

Type: Slack.Channel

Return Value

Type: void

setChannelActionsCount(channelActionsCount)

Signature

public void setChannelActionsCount(Integer channelActionsCount)

Parameters

channelActionsCount

Type: Integer

Return Value

Type: void

setChannelActionsTs(channelActionsTs)

Signature

public void setChannelActionsTs(String channelActionsTs)

Parameters

channelActionsTs

Type: String

Return Value

Type: void

setChannels(channels)

Signature

public void setChannels(List<String> channels)

Parameters

channels

Type: List<String>

Return Value

Type: void

setComment(comment)

Signature

public void setComment(String comment)

Parameters

comment

Type: String

Return Value

Type: void

setCreated(created)

Signature

public void setCreated(String created)

Parameters

created

Type: String

Return Value

Type: void

setDeanimateGif(deanimateGif)

Signature

public void setDeanimateGif(String deanimateGif)

Parameters

deanimateGif

Type: String

Return Value

Type: void

setDisplayAsBot(displayAsBot)

Signature

public void setDisplayAsBot(Boolean displayAsBot)

Parameters

displayAsBot

Type: Boolean

Return Value

Type: void

setEditable(editable)

Signature

public void setEditable(Boolean editable)

Parameters

editable

Type: Boolean

Return Value

Type: void

setEditLink(editLink)

Signature

public void setEditLink(String editLink)

Parameters

editLink

Type: String

Return Value

Type: void

setEditor(editor)

Signature

public void setEditor(String editor)

Parameters

editor

Type: String

Return Value

Type: void

setExternal(external)

Signature

public void setExternal(Boolean external)

Parameters

external

Type: Boolean

Return Value

Type: void

setExternalId(externalId)

Signature

public void setExternalId(String externalId)

Parameters

externalId

Type: String

Return Value

Type: void

setExternalType(externalType)

Signature

public void setExternalType(String externalType)

Parameters

externalType

Type: String

Return Value

Type: void

setExternalUrl(externalUrl)

Signature

public void setExternalUrl(String externalUrl)

Parameters

externalUrl

Type: String

Return Value

Type: void

setFileId(fileId)

Signature

public void setFileId(String fileId)

Parameters

fileId

Type: String

Return Value

Type: void

setFiletype(filetype)

Signature

public void setFiletype(String filetype)

Parameters

filetype

Type: String

Return Value

Type: void

setFrom(fromValue)

Signature

public void setFrom(List<Slack.MatchedItem.Address> fromValue)

Parameters

fromValue

Type: List<Slack.MatchedItem.Address>

Return Value

Type: void

setGroups(groups)

Signature

public void setGroups(List<String> groups)

Parameters

groups

Type: List<String>

Return Value

Type: void

setHasMore(hasMore)

Signature

public void setHasMore(Boolean hasMore)

Parameters

hasMore

Type: Boolean

Return Value

Type: void

setHasRichPreview(hasRichPreview)

Signature

public void setHasRichPreview(Boolean hasRichPreview)

Parameters

hasRichPreview

Type: Boolean

Return Value

Type: void

setId(id)

Signature

public void setId(String id)

Parameters

id

Type: String

Return Value

Type: void

setIid(iid)

Signature

public void setIid(String iid)

Parameters

iid

Type: String

Return Value

Type: void

setImageExifRotation(imageExifRotation)

Signature

public void setImageExifRotation(Integer imageExifRotation)

Parameters

imageExifRotation

Type: Integer

Return Value

Type: void

setIms(ims)

Signature

public void setIms(List<String> ims)

Parameters

ims

Type: List<String>

Return Value

Type: void

setLastEditor(lastEditor)

Signature

public void setLastEditor(String lastEditor)

Parameters

lastEditor

Type: String

Return Value

Type: void

setLines(lines)

Signature

public void setLines(Integer lines)

Parameters

lines

Type: Integer

Return Value

Type: void

setLinesMore(linesMore)

Signature

public void setLinesMore(Integer linesMore)

Parameters

linesMore

Type: Integer

Return Value

Type: void

setMimetype(mimetype)

Signature

public void setMimetype(String mimetype)

Parameters

mimetype

Type: mimetype

Return Value

Type: void

setMode(mode)

Signature

public void setMode(String mode)

Parameters

mode

Type: String

Return Value

Type: void

setMpim(mpim)

Signature

public void setMpim(Boolean mpim)

Parameters

mpim

Type: Boolean

Return Value

Type: void

setName(name)

Signature

public void setName(String name)

Parameters

name

Type: String

Return Value

Type: void

setNext(next)

Signature

public void setNext(Slack.MatchedItem.OtherItem next)

Parameters

next

Type: Slack.MatchedItem.OtherItem

Return Value

Type: void

setNext2(next2)

Signature

public void setNext2(Slack.MatchedItem.OtherItem next2)

Parameters

next2

Type: Slack.MatchedItem.OtherItem

Return Value

Type: void

setNonOwnerEditable(nonOwnerEditable)

Signature

public void setNonOwnerEditable(Boolean nonOwnerEditable)

Parameters

nonOwnerEditable

Type: Boolean

Return Value

Type: void

setNoReactions(noReactions)

Signature

public void setNoReactions(Boolean noReactions)

Parameters

noReactions

Type: Boolean

Return Value

Type: void

setOriginalHeight(originalHeight)

Signature

public void setOriginalHeight(String originalHeight)

Parameters

originalHeight

Type: String

Return Value

Type: void

setOriginalWidth(originalWidth)

Signature

public void setOriginalWidth(String originalWidth)

Parameters

originalWidth

Type: String

Return Value

Type: void

setPermalink(permalink)

Signature

public void setPermalink(String permalink)

Parameters

permalink

Type: String

Return Value

Type: void

setPermalinkPublic(permalinkPublic)

Signature

public void setPermalinkPublic(Boolean permalinkPublic)

Parameters

permalinkPublic

Type: Boolean

Return Value

Type: void

setPlainText(plainText)

Signature

public void setPlainText(String plainText)

Parameters

plainText

Type: String

Return Value

Type: void

setPrettyType(prettyType)

Signature

public void setPrettyType(String prettyType)

Parameters

prettyType

Type: String

Return Value

Type: void

setPreview(preview)

Signature

public void setPreview(String preview)

Parameters

preview

Type: String

Return Value

Type: void

setPreviewHighlight(previewHighlight)

Signature

public void setPreviewHighlight(String previewHighlight)

Parameters

previewHighlight

Type: String

Return Value

Type: void

setPreviewPlainText(previewPlainText)

Signature

public void setPreviewPlainText(String previewPlainText)

Parameters

previewPlainText

Type: String

Return Value

Type: void

setPreviewTruncated(previewTruncated)

Signature

public void setPreviewTruncated(Boolean previewTruncated)

Parameters

previewTruncated

Type: Boolean

Return Value

Type: void

setPrevious(previous)

Signature

public void setPrevious(Slack.MatchedItem.OtherItem previous)

Parameters

previous

Type: Slack.MatchedItem.OtherItem

Return Value

Type: void

setPrevious2(previous2)

Signature

public void setPrevious2(Slack.MatchedItem.OtherItem previous2)

Parameters

previous

Type: Slack.MatchedItem.OtherItem

Return Value

Type: void

setpublic(_public)

Signature

public void setpublic(Boolean _public)

Parameters

_public

Type: Boolean

Return Value

Type: void

setPublicUrlShared(publicUrlShared)

Signature

public void setPublicUrlShared(Boolean publicUrlShared)

Parameters

publicUrlShared

Type: Boolean

Return Value

Type: void

setScore(score)

Signature

public void setScore(String score)

Parameters

score

Type: String

Return Value

Type: void

setSentToSelf(sentToSelf)

Signature

public void setSentToSelf(Boolean sentToSelf)

Parameters

sentToSelf

Type: Boolean

Return Value

Type: void

setSize(size)

Signature

public void setSize(Integer size)

Parameters

size

Type: Integer

Return Value

Type: void

setSourceTeam(sourceTeam)

Signature

public void setSourceTeam(String sourceTeam)

Parameters

sourceTeam

Type: String

Return Value

Type: void

setStarred(starred)

Signature

public void setStarred(Boolean starred)

Parameters

starred

Type: Boolean

Return Value

Type: void

setSubject(subject)

Signature

public void setSubject(String subject)

Parameters

subject

Type: String

Return Value

Type: void

setTeam(team)

Signature

public void setTeam(String team)

Parameters

team

Type: String

Return Value

Type: void

setText(text)

Signature

public void setText(String text)

Parameters

Type: String

Return Value

Type: void

setThumb64(thumb64)

Signature

public void setThumb64(String thumb64)

Parameters

thumb64

Type: String

Return Value

Type: void

setThumb64Gif(thumb64Gif)

Signature

public void setThumb64Gif(String thumb64Gif)

Parameters

thumb64Gif

Type: String

Return Value

Type: void

setThumb64Height(thumb64Height)

Signature

public void setThumb64Height(String thumb64Height)

Parameters

thumb64Height

Type: String

Return Value

Type: void

setThumb64Width(thumb64Width)

Signature

public void setThumb64Width(String thumb64Width)

Parameters

thumb64Width

Type: String

Return Value

Type: void

setThumb80(thumb80)

Signature

public void setThumb80(String thumb80)

Parameters

thumb80

Type: String

Return Value

Type: void

setThumb80Gif(thumb80Gif)

Signature

public void setThumb80Gif(String thumb80Gif)

Parameters

thumb80Gif

Type: String

Return Value

Type: void

setThumb80Height(thumb80Height)

Signature

public void setThumb80Height(String thumb80Height)

Parameters

thumb80Height

Type: String

Return Value

Type: void

setThumb80Width(thumb80Width)

Signature

public void setThumb80Width(String thumb80Width)

Parameters

thumb80Width

Type: String

Return Value

Type: void

setThumb160(thumb160)

Signature

public void setThumb160(String thumb160)

Parameters

thumb160

Type: String

Return Value

Type: void

setThumb160Gif(thumb160Gif)

Signature

public void setThumb160Gif(String thumb160Gif)

Parameters

thumb160Gif

Type: String

Return Value

Type: void

setThumb160Height(thumb160Height)

Signature

public void setThumb160Height(String thumb160Height)

Parameters

thumb160Height

Type: String

Return Value

Type: void

setThumb160Width(thumb160Width)

Signature

public void setThumb160Width(String thumb160Width)

Parameters

thumb160Width

Type: String

Return Value

Type: void

setThumb360(thumb360)

Signature

public void setThumb360(String thumb360)

Parameters

thumb360

Type: String

Return Value

Type: void

setThumb360Gif(thumb360Gif)

Signature

public void setThumb360Gif(String thumb360Gif)

Parameters

thumb360Gif

Type: String

Return Value

Type: void

setThumb360Height(thumb360Height)

Signature

public void setThumb360Height(String thumb360Height)

Parameters

thumb360Height

Type: String

Return Value

Type: void

setThumb360Width(thumb360Width)

Signature

public void setThumb360Width(String thumb360Width)

Parameters

thumb360Width

Type: String

Return Value

Type: void

setThumb480(thumb480)

Signature

public void setThumb480(String thumb480)

Parameters

thumb480

Type: String

Return Value

Type: void

setThumb480Gif(thumb480Gif)

Signature

public void setThumb480Gif(String thumb480Gif)

Parameters

thumb480Gif

Type: String

Return Value

Type: void

setThumb480Height(thumb480Height)

Signature

public void setThumb480Height(String thumb480Height)

Parameters

thumb480Height

Type: String

Return Value

Type: void

setThumb480Width(thumb480Width)

Signature

public void setThumb480Width(String thumb480Width)

Parameters

thumb480Width

Type: String

Return Value

Type: void

setThumb720(thumb720)

Signature

public void setThumb720(String thumb720)

Parameters

thumb720

Type: String

Return Value

Type: void

setThumb720Gif(thumb720Gif)

Signature

public void setThumb720Gif(String thumb720Gif)

Parameters

thumb720Gif

Type: String

Return Value

Type: void

setThumb720Height(thumb720Height)

Signature

public void setThumb720Height(String thumb720Height)

Parameters

thumb720Height

Type: String

Return Value

Type: void

setThumb720Width(thumb720Width)

Signature

public void setThumb720Width(String thumb720Width)

Parameters

thumb720Width

Type: String

Return Value

Type: void

setThumb800(thumb800)

Signature

public void setThumb800(String thumb800)

Parameters

thumb800

Type: String

Return Value

Type: void

setThumb800Gif(thumb800Gif)

Signature

public void setThumb800Gif(String thumb800Gif)

Parameters

thumb800Gif

Type: String

Return Value

Type: void

setThumb800Height(thumb800Height)

Signature

public void setThumb800Height(String thumb800Height)

Parameters

thumb800Height

Type: String

Return Value

Type: void

setThumb800Width(thumb800Width)

Signature

public void setThumb800Width(String thumb800Width)

Parameters

thumb800Width

Type: String

Return Value

Type: void

setThumb960(thumb960)

Signature

public void setThumb960(String thumb960)

Parameters

thumb960

Type: String

Return Value

Type: void

setThumb960Gif(thumb960Gif)

Signature

public void setThumb960Gif(String thumb960Gif)

Parameters

thumb960Gif

Type: String

Return Value

Type: void

setThumb960Height(thumb960Height)

Signature

public void setThumb960Height(String thumb960Height)

Parameters

thumb960Height

Type: String

Return Value

Type: void

setThumb960Width(thumb960Width)

Signature

public void setThumb960Width(String thumb960Width)

Parameters

thumb960Width

Type: String

Return Value

Type: void

setThumb1024(thumb1024)

Signature

public void setThumb1024(String thumb1024)

Parameters

thumb1024

Type: String

Return Value

Type: void

setThumb1024Gif(thumb1024Gif)

Signature

public void setThumb1024Gif(String thumb1024Gif)

Parameters

thumb1024Gif

Type: String

Return Value

Type: void

setThumb1024Height(thumb1024Height)

Signature

public void setThumb1024Height(String thumb1024Height)

Parameters

thumb1024Height

Type: String

Return Value

Type: void

setThumb1024Width(thumb1024Width)

Signature

public void setThumb1024Width(String thumb1024Width)

Parameters

thumb1024Width

Type: String

Return Value

Type: void

setThumbPdf(thumbPdf)

Signature

public void setThumbPdf(String thumbPdf)

Parameters

thumbPdf

Type: String

Return Value

Type: void

setThumbPdfHeight(thumbPdfHeight)

Signature

public void setThumbPdfHeight(String thumbPdfHeight)

Parameters

thumbPdfHeight

Type: String

Return Value

Type: void

setThumbPdfWidth(thumbPdfWidth)

Signature

public void setThumbPdfWidth(String thumbPdfWidth)

Parameters

thumbPdfWidth

Type: String

Return Value

Type: void

setThumbTiny(thumbTiny)

Signature

public void setThumbTiny(String thumbTiny)

Parameters

thumbTiny

Type: String

Return Value

Type: void

setTimestamp(timestamp)

Signature

public void setTimestamp(String timestamp)

Parameters

timestamp

Type: String

Return Value

Type: void

setTitle(title)

Signature

public void setTitle(String title)

Parameters

title

Type: String

Return Value

Type: void

setTo(to)

Signature

public void setTo(List<Slack.MatchedItem.Address> to)

Parameters

to

Type: List<Slack.MatchedItem.Address>

Return Value

Type: void

setTopFile(topFile)

Signature

public void setTopFile(Boolean topFile)

Parameters

topFile

Type: Boolean

Return Value

Type: void

setTs(ts)

Signature

public void setTs(String ts)

Parameters

ts

Type: String

Return Value

Type: void

setType(type)

Signature

public void setType(String type)

Parameters

type

Type: String

Return Value

Type: void

setUpdated(updated)

Signature

public void setUpdated(Integer updated)

Parameters

updated

Type: Integer

Return Value

Type: void

setUrlPrivate(urlPrivate)

Signature

public void setUrlPrivate(String urlPrivate)

Parameters

urlPrivate

Type: String

Return Value

Type: void

setUrlPrivateDownload(urlPrivateDownload)

Signature

public void setUrlPrivateDownload(Boolean urlPrivateDownload)

Parameters

urlPrivateDownload

Type: Boolean

Return Value

Type: void

setUser(user)

Signature

public void setUser(String user)

Parameters

user

Type: String

Return Value

Type: void

setUsername(username)

Signature

public void setUsername(String username)

Parameters

username

Type: String

Return Value

Type: void

setUserTeam(userTeam)

Signature

public void setUserTeam(String userTeam)

Parameters

userTeam

Type: String

Return Value

Type: void

MatchedItem.Address Class

MatchedItem.Address Methods

The following are methods for MatchedItem.Address.

getAddress()

Signature

public String getAddress()

Return Value

Type: String

getName()

Signature

public String getName()

Return Value

Type: String

getOriginal()

Signature

public String getOriginal()

Return Value

Type: String

setAddress(address)

Signature

public void setAddress(String address)

Parameters

address

Type: String

Return Value

Type: void

setName(name)

Signature

public void setName(String name)

Parameters

name

Type: String

Return Value

Type: void

setOriginal(original)

Signature

public void setOriginal(String original)

Parameters

original

Type: String

Return Value

Type: void

MatchedItem.OtherItem Class

MatchedItem.OtherItem Methods

The following are methods for MatchedItem.OtherItem.

getIid()

Signature

public String getIid()

Return Value

Type: String

getPermalink()

Signature

public String getPermalink()

Return Value

Type: String

getText()

Signature

public String getText()

Return Value

Type: String

getTs()

Signature

public String getTs()

Return Value

Type: String

getType()

Signature

public String getType()

Return Value

Type: String

getUser()

Signature

public String getUser()

Return Value

Type: String

getUsername()

Signature

public String getUsername()

Return Value

Type: String

setIid(iid)

Signature

public void setIid(String iid)

Parameters

iid

Type: String

Return Value

Type: void

setPermalink(permalink)

Signature

public void setPermalink(String permalink)

Parameters

permalink

Type: String

Return Value

Type: void

setText(text)

Signature

public void setText(String text)

Parameters

text

Type: String

Return Value

Type: void

setTs(ts)

Signature

public void setTs(String ts)

Parameters

ts

Type: String

Return Value

Type: void

setType(type)

Signature

public void setType(String type)

Parameters

type

Type: String

Return Value

Type: void

setUser(user)

Signature

public void setUser(String user)

Parameters

user

Type: String

Return Value

Type: void

setUsername(username)

Signature

public void setUsername(String username)

Parameters

username

Type: String

Return Value

Type: void

SearchResult Class

Represents search result for a query. Use SearchResult with Paging to work with results returned from a search query. See Slack's search.all method.

SearchResult Methods

The following are methods for SearchResult.

getMatches()

Signature

public List<Slack.MatchedItem> getMatches()

Return Value

Type: List<Slack.MatchedItem>

getPagination()

Signature

public Slack.SearchResult.Pagination getPagination()

Return Value

Type: Slack.SearchResult.Pagination

getPaging()

Signature

public Slack.Paging getPaging()

Return Value

Type: Slack.Paging

getRefinements()

Signature

public List<String> getRefinements()

Return Value

Type: List<String>

getTotal()

Signature

public Integer getTotal()

Return Value

Type: Integer

setMatches(matches)

Signature

public void setMatches(List<Slack.MatchedItem> matches)

Parameters

matches

Type: List<Slack.MatchedItem>

Return Value

Type: void

setPagination(pagination)

Signature

public void setPagination(Slack.SearchResult.Pagination pagination)

Parameters

pagination

Type: Slack.SearchResult.Pagination

Return Value

Type: void

setPaging(paging)

Signature

public void setPaging(Slack.Paging paging)

Parameters

pagination

Type: Slack.Paging

Return Value

Type: void

setRefinements(refinements)

Signature

public void setRefinements(List<String> refinements)

Parameters

refinements

Type: List<String>

Return Value

Type: void

setTotal(total)

Signature

public void setTotal(Integer total)

Parameters

total

Type: Integer

Return Value

Type: void

SearchResult.Pagination Class

SearchResult.Pagination Methods

The following are methods for SearchResult.Pagination.

getFirst()

Signature

public Integer getFirst()

Return Value

Type: Integer

getLast()

Signature

public Integer getLast()

Return Value

Type: Integer

getPage()

Signature

public Integer getPage()

Return Value

Type: Integer

getPageCount()

Signature

public Integer getPageCount()

Return Value

Type: Integer

getPerPage()

Signature

public Integer getPerPage()

Return Value

Type: Integer

getTotalCount()

Signature

public Integer getTotalCount()

Return Value

Type: Integer

setFirst(first)

Signature

public void setFirst(Integer first)

Parameters

first

Type: Integer

Return Value

Type: void

setLast(last)

Signature

public void setLast(Integer last)

Parameters

last

Type: Integer

Return Value

Type: void

setPage(page)

Signature

public void setPage(Integer page)

Parameters

page

Type: Integer

Return Value

Type: void

setPageCount(pageCount)

Signature

public void setPageCount(Integer pageCount)

Parameters

pageCount

Type: Integer

Return Value

Type: void

setPerPage(perPage)

Signature

public void setPerPage(Integer perPage)

Parameters

perPage

Type: Integer

Return Value

Type: void

setTotalCount(totalCount)

Signature

public void setTotalCount(Integer totalCount)

Parameters

totalCount

Type: Integer

Return Value

Type: void

SearchAllRequest Class

Sends a request to search for messages and files matching a query.

Usage

See Slack’s search.all method.

SearchAllRequest Methods

The following are methods for SearchAllRequest.

builder()

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

Signature

 static Slack.SearchAllRequest.Builder builder()

Return Value

Type: Slack.SearchAllRequest.Builder

SearchAllRequest.Builder Class

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

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

SearchAllRequest.Builder Methods

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

build()

Required. Returns an instance of Slack.SearchAllRequest.

Signature

 Slack.SearchAllRequest build()

Return Value

Type: Slack.SearchAllRequest

count(count)

Number of items to return per page. The default is 20.

Signature

 Slack.SearchAllRequest.Builder count(Integer count)

Parameters

count

Type: Integer

Return Value

Type: Slack.SearchAllRequest.Builder

highlight(highlight)

Specifies whether to enable query highlight markers.

Signature

 Slack.SearchAllRequest.Builder highlight(Boolean highlight)

Parameters

highlight

Type: Boolean

Return Value

Type: Slack.SearchAllRequest.Builder

page(page)

Page number of results to return. The default is 1.

Signature

 Slack.SearchAllRequest.Builder page(Integer page)

Parameters

page

Type: Integer

Return Value

Type: Slack.SearchAllRequest.Builder

query(query)

Required. The search query, which can contain booleans.

Signature

 Slack.SearchAllRequest.Builder query(String query)

Parameters

query

Type: String

Return Value

Type: Slack.SearchAllRequest.Builder

sortDir(sortDir)

Changes sort direction. Valid values are: asc (ascending), and desc (descending). The default is desc.

Signature

 Slack.SearchAllRequest.Builder sortDir(String sortDir)

Parameters

sortDir

Type: String

sortValue(sortValue)

Signature

 Slack.SearchAllRequest.Builder sortValue(String sortValue)

Parameters

sortType

Type: String

Return Value

Type: Slack.SearchAllRequest.Builder

teamId(teamId)

Signature

 Slack.SearchAllRequest.Builder teamId(String teamId)

Parameters

teamId

Type: String

Return Value

Type: Slack.SearchAllRequest.Builder

SearchAllResponse Class

Searches for messages and files matching a query.

Usage See Slack’s search.all method.

SearchAllResponse Methods

This class contains standard response methods.

The following are methods for SearchAllResponse.

getFiles()

Signature

public Slack.SearchResult getFiles()

Return Value

Type: Slack.SearchResult

getMessages()

Signature

public Slack.SearchResult getMessages()

Return Value

Type: Slack.SearchResult

getPosts()

Signature

 Slack.SearchAllResponse.Posts getPosts()

Return Value

Type: Slack.SearchAllResponse.Posts

getQuery()

Signature

 String getQuery()

Return Value

Type: String

setFiles(files)

Signature

public void setFiles(Slack.SearchResult files)

Parameters

files

Type: Slack.SearchResult

Return Value

Type: void

setMessages(messages)

Signature

public void setMessages(Slack.SearchResult messages)

Parameters

messages

Type: Slack.SearchResult

Return Value

Type: void

setPosts(posts)

Signature

 void setPosts(Slack.SearchAllResponse.Posts posts)

Parameters

posts

Type: Slack.SearchAllResponse.Posts

Return Value

Type: void

setQuery(query)

Signature

 void setQuery(String query)

Parameters

query

Type: String

Return Value

Type: void

SearchAllResponse.Posts Class

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

A Posts object is obtained by invoking one of the SearchAllRequest.Posts methods defined by the SearchAllRequest class.

SearchAllResponse.Posts Methods

The following are methods for SearchAllResponse.Posts.

getMatches()

Signature

 List<String> getMatches()

Return Value

Type: List<String>

getTotal()

Signature

 Integer getTotal()

Return Value

Type: Integer

setMatches(matches)

Signature

 void setMatches(List<String> matches)

Parameters

matches

Type: List<String>

Return Value

Type: void

setTotal(total)

Signature

 void setTotal(Integer total)

Parameters

total

Type: Integer

Return Value

Type: void

SearchFilesRequest Class

Sends a request to search for files matching a query.

Usage See Slack’s search.files method.

SearchFilesRequest Methods

The following are methods for SearchFilesRequest.

builder()

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

Signature

 static Slack.SearchFilesRequest.Builder builder()

Return Value

Type: Slack.SearchFilesRequest.Builder

SearchFilesRequest.Builder Class

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

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

SearchFilesRequest.Buider Methods

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

build()

Required. Returns an instance of Slack.SearchFilesRequest.

Signature

 Slack.SearchFilesRequest build()

Return Value

Type: Slack.SearchFilesRequest

count(count)

Number of items to return per page. The default is 20.

Signature

 Slack.SearchFilesRequest.Builder count(Integer count)

Parameters

count

Type: Integer

Return Value

Type: Slack.SearchFilesRequest.Builder

highlight(highlight)

Specifies whether to enable query highlight markers.

Signature

 Slack.SearchFilesRequest.Builder highlight(Boolean highlight)

Parameters

highlight

Type: Boolean

Return Value

Type: Slack.SearchFilesRequest.Builder

page(page)

The page number of the results to return. The default is 1.

Signature

 Slack.SearchFilesRequest.Builder page(Integer page)

Parameters

page

Type: Integer

Return Value

Type: Slack.SearchFilesRequest.Builder

query(query)

Required. The search query.

Signature

 Slack.SearchFilesRequest.Builder query(String query)

Parameters

query

Type: String

Return Value

Type: Slack.SearchFilesRequest.Builder

sortDir(sortDir)

Changes sort direction. Valid values are asc (ascending) and desc (descending). The default is desc.

Signature

 Slack.SearchFilesRequest.Builder sortDir(String sortDir)

Parameters

sortDir

Type: String

Return Value

Type: Slack.SearchFilesRequest.Builder

sortValue(sortValue)

Returns martches sorted by score or timestamp. The default is score.

Signature

 Slack.SearchFilesRequest.Builder sortValue(String sortValue)

Parameters

sortValue

Type: String

Return Value

Type: Slack.SearchFilesRequest.Builder

teamId(teamId)

The encoded team ID to search in, which is required if org token is used.

Signature

 Slack.SearchFilesRequest.Builder teamId(String teamId)

Parameters

teamId

Type: String

Return Value

Type: Slack.SearchFilesRequest.Builder

SearchFilesResponse Class

Searches for files matching a query.

Usage See Slack’s search.files method.

SearchFilesResponse Methods

This class contains standard response methods.

The following are methods for SearchFilesResponse.

getFiles()

Signature

public Slack.SearchResult getFiles()

Return Value

Type: Slack.SearchResult

getQuery()

Signature

 String getQuery()

Return Value

Type: String

setFiles(files)

Signature

public void setFiles(Slack.SearchResult files)

Parameters

files

Type: Slack.SearchResult

Return Value

Type: void

setQuery(query)

Signature

 void setQuery(String query)

Parameters

query

Type: String

Return Value

Type: void

SearchMessagesRequest Class

Sends a request to search for messages matching a query.

Usage See Slack’s search.messages method.

SearchMessagesRequest Methods

The following are methods for SearchMessagesRequest.

builder()

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

Signature

 static Slack.SearchMessagesRequest.Builder builder()

Return Value

Type: Slack.SearchMessagesRequest.Builder.

SearchMessagesRequest.Builder Class

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

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

SearchMessagesRequest.Builder Methods

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

build()

Required. Returns an instance of Slack.SearchMessagesRequest.

Signature

 Slack.SearchMessagesRequest build()

Return Value

Type: Slack.SearchMessagesRequest

count(count)

Number of items to return per page. The default is 20.

Signature

 Slack.SearchMessagesRequest.Builder count(Integer count)

Parameters

count

Type: Integer

Return Value

Type: Slack.SearchMessagesRequest.Builder

cursor(cursor)

Signature

public Slack.SearchMessagesRequest.Builder cursor(String cursor)

Parameters

cursor

Type: String

Return Value

Type: Slack.SearchMessagesRequest.Builder

highlight(highlight)

Specifies whether to enable query highlight markers.

Signature

 Slack.SearchMessagesRequest.Builder highlight(Boolean highlight)

Parameters

highlight

Type: Boolean

Return Value

Type: Slack.SearchMessagesRequest.Builder

page(page)

The page number of the results to return. The default is 1.

Signature

 Slack.SearchMessagesRequest.Builder page(Integer page)

Parameters

page

Type: Integer

Return Value

Type: Slack.SearchMessagesRequest.Builder

query(query)

Required. The search query.

Signature

 Slack.SearchMessagesRequest.Builder query(String query)

Parameters

query

Type: String

Return Value

Type: Slack.SearchMessagesRequest.Builder

sortDir(sortDir)

Changes sort direction. Valid values are asc (ascending) and desc (descending). The default is desc.

Signature

 Slack.SearchMessagesRequest.Builder sortDir(String sortDir)

Parameters

sortDir

Type: String

Return Value

Type: Slack.SearchMessagesRequest.Builder

sortValue(sortValue)

Returns martches sorted by score or timestamp. The default is score.

Signature

 Slack.SearchMessagesRequest.Builder sortValue(String sortValue)

Parameters

sortValue

Type: String

Return Value

Type: Slack.SearchMessagesRequest.Builder

teamId(teamId)

The encoded team ID to search in, which is required if org token is used.

Signature

 Slack.SearchMessagesRequest.Builder teamId(String teamId)

Parameters

teamId

Type: String

Return Value

Type: Slack.SearchMessagesRequest.Builder

SearchMessagesResponse Class

Searches for messages matching a query.

Usage See Slack’s search.messages method.

SearchMessagesResponse Methods

This class contains standard response methods.

The following are methods for SearchMessagesResponse.

getMessages()

Signature

public Slack.SearchResult getMessages()

Return Value

Type: Slack.SearchResult

getQuery()

Signature

 String getQuery()

Return Value

Type: String

setMessages(messages)

Signature

public void setMessages(Slack.SearchResult messages)

Parameters

messages

Type: Slack.SearchResult

Return Value

Type: void

setQuery(query)

Signature

 void setQuery(String query)

Parameters

query

Type: String

Return Value

Type: void