Work with Search
The following are Apex classes for the Slack search
API methods.
Represents an item that matches a search query.
MatchedItem Methods
The following are methods for MatchedItem
.
getBotId()
Signature
Return Value
Type: String
getCc()
Signature
Return Value
Type: List<Slack.MatchedItem.Address>
getChannel()
Signature
Return Value
Type: Slack.Channel
getChannelActionsCount()
Signature
Return Value
Type: Integer
getChannelActionsTs()
Signature
Return Value
Type: String
getChannels()
Signature
Return Value
Type: List<String>
getComment()
Signature
Return Value
Type: String
getCreated()
Signature
Return Value
Type: String
getDeanimateGif()
Signature
Return Value
Type: String
getEditLink()
Signature
Return Value
Type: String
getEditor()
Signature
Return Value
Type: String
getExternalId()
Signature
Return Value
Type: String
getExternalType()
Signature
Return Value
Type: String
getExternalUrl()
Signature
Return Value
Type: String
getFileId()
Signature
Return Value
Type: String
getFiletype()
Signature
Return Value
Type: String
getFrom()
Signature
Return Value
Type: List<Slack.MatchedItem.Address>
getGroups()
Signature
Return Value
Type: List<String>
getId()
The ID of the matching file item.
Signature
Return Value
Type: String
getIid()
Gets the ID of the matching message item.
Signature
Return Value
Type: String
getImageExifRotation()
Signature
Return Value
Type: Integer
getIms()
Signature
Return Value
Type: List<String>
getLastEditor()
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
getNext()
Signature
Return Value
Type: Slack.MatchedItem.OtherItem
getNext2()
Signature
Return Value
Type: Slack.MatchedItem.OtherItem
getOriginalHeight()
Signature
Return Value
Type: String
getOriginalWidth()
Signature
Return Value
Type: String
getPermalink()
Signature
Return Value
Type: String
getPlainText()
Signature
Return Value
Type: String
getPrettyType()
Signature
Return Value
Type: String
getPreview()
Signature
Return Value
Type: String
getPreviewHighlight()
Signature
Return Value
Type: String
getPreviewPlainText()
Signature
Return Value
Type: String
getPrevious()
Signature
Return Value
Type: Slack.MatchedItem.OtherItem
getPrevious2()
Signature
Return Value
Type: Slack.MatchedItem.OtherItem
getScore()
Signature
Return Value
Type: String
getSize()
Signature
Return Value
Type: Integer
getSourceTeam()
Signature
Return Value
Type: String
getSubject()
Signature
Return Value
Type: String
getTeam()
Signature
Return Value
Type: String
getText()
Signature
Return Value
Type: String
getThumb64()
Signature
Return Value
Type: String
getThumb64Gif()
Signature
Return Value
Type: String
getThumb64Height()
Signature
Return Value
Type: String
getThumb64Width()
Signature
Return Value
Type: String
getThumb80()
Signature
Return Value
Type: String
getThumb80Gif()
Signature
Return Value
Type: String
getThumb80Height()
Signature
Return Value
Type: String
getThumb80Width()
Signature
Return Value
Type: String
getThumb160()
Signature
Return Value
Type: String
getThumb160Gif()
Signature
Return Value
Type: String
getThumb160Height()
Signature
Return Value
Type: String
getThumb160Width()
Signature
Return Value
Type: String
getThumb360()
Signature
Return Value
Type: String
getThumb360Gif()
Signature
Return Value
Type: String
getThumb360Height()
Signature
Return Value
Type: String
getThumb360Width()
Signature
Return Value
Type: String
getThumb480()
Signature
Return Value
Type: String
getThumb480Gif()
Signature
Return Value
Type: String
getThumb480Height()
Signature
Return Value
Type: String
getThumb480Width()
Signature
Return Value
Type: String
getThumb720()
Signature
Return Value
Type: String
getThumb720Gif()
Signature
Return Value
Type: String
getThumb720Height()
Signature
Return Value
Type: String
getThumb720Width()
Signature
Return Value
Type: String
getThumb800()
Signature
Return Value
Type: String
getThumb800Gif()
Signature
Return Value
Type: String
getThumb800Height()
Signature
Return Value
getThumb800Width()
Signature
Return Value
Type: String
getThumb960()
Signature
Return Value
Type: String
getThumb960Gif()
Signature
Return Value
Type: String
getThumb960Height()
Signature
Return Value
Type: String
getThumb960Width()
Signature
Return Value
Type: String
getThumb1024()
Signature
Return Value
Type: String
getThumb1024Gif()
Signature
Return Value
Type: String
getThumb1024Height()
Signature
Return Value
Type: String
getThumb1024Width()
Signature
Return Value
Type: String
getThumbPdf()
Signature
Return Value
Type: String
getThumbPdfHeight()
Signature
Return Value
Type: String
getThumbPdfWidth()
Signature
Return Value
Type: String
getThumbTiny()
Signature
Return Value
Type: String
getTimestamp()
Signature
Return Value
Type: String
getTitle()
Signature
Return Value
Type: String
getTo()
Signature
Return Value
Type: List<Slack.MatchedItem.Address>
getTs()
Signature
Return Value
Type: String
getType()
Signature
Return Value
Type: String
getUpdated()
Signature
Return Value
Type: Integer
getUrlPrivate()
Signature
Return Value
Type: String
getUser()
Signature
Return Value
Type: String
getUserTeam()
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
isHasMore()
Signature
Return Value
Type: Booolean
isHasRichPreview()
Signature
Return Value
Type: Boolean
isMpim()
Signature
Return Value
Type: Boolean
isNonOwnerEditable()
Signature
Return Value
Type: Boolean
isNoReactions()
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
isSentToSelf()
Signature
Return Value
Type: Boolean
isStarred()
Signature
Return Value
Type: Boolean
isTopFile()
Signature
Return Value
Type: Boolean
isUrlPrivateDownload()
Signature
Return Value
Type: Boolean
setBotId(botId)
Signature
Parameters
botId
Type: String
Return Value
Type: void
setCc(cc)
Signature
Parameters
cc
Type: List<Slack.MatchedItem.Address>
Return Value
Type: void
setChannel(channel)
Signature
Parameters
channel
Type: Slack.Channel
Return Value
Type: void
setChannelActionsCount(channelActionsCount)
Signature
Parameters
channelActionsCount
Type: Integer
Return Value
Type: void
setChannelActionsTs(channelActionsTs)
Signature
Parameters
channelActionsTs
Type: String
Return Value
Type: void
setChannels(channels)
Signature
Parameters
channels
Type: List<String>
Return Value
Type: void
setComment(comment)
Signature
Parameters
comment
Type: String
Return Value
Type: void
setCreated(created)
Signature
Parameters
created
Type: String
Return Value
Type: void
setDeanimateGif(deanimateGif)
Signature
Parameters
deanimateGif
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
setEditor(editor)
Signature
Parameters
editor
Type: String
Return Value
Type: void
setExternal(external)
Signature
Parameters
external
Type: Boolean
Return Value
Type: void
setExternalId(externalId)
Signature
Parameters
externalId
Type: String
Return Value
Type: void
setExternalType(externalType)
Signature
Parameters
externalType
Type: String
Return Value
Type: void
setExternalUrl(externalUrl)
Signature
Parameters
externalUrl
Type: String
Return Value
Type: void
setFileId(fileId)
Signature
Parameters
fileId
Type: String
Return Value
Type: void
setFiletype(filetype)
Signature
Parameters
filetype
Type: String
Return Value
Type: void
setFrom(fromValue)
Signature
Parameters
fromValue
Type: List<Slack.MatchedItem.Address>
Return Value
Type: void
setGroups(groups)
Signature
Parameters
groups
Type: List<String>
Return Value
Type: void
setHasMore(hasMore)
Signature
Parameters
hasMore
Type: Boolean
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
setIid(iid)
Signature
Parameters
iid
Type: String
Return Value
Type: void
setImageExifRotation(imageExifRotation)
Signature
Parameters
imageExifRotation
Type: Integer
Return Value
Type: void
setIms(ims)
Signature
Parameters
ims
Type: List<String>
Return Value
Type: void
setLastEditor(lastEditor)
Signature
Parameters
lastEditor
Type: String
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: mimetype
Return Value
Type: void
setMode(mode)
Signature
Parameters
mode
Type: String
Return Value
Type: void
setMpim(mpim)
Signature
Parameters
mpim
Type: Boolean
Return Value
Type: void
setName(name)
Signature
Parameters
name
Type: String
Return Value
Type: void
setNext(next)
Signature
Parameters
next
Type: Slack.MatchedItem.OtherItem
Return Value
Type: void
setNext2(next2)
Signature
Parameters
next2
Type: Slack.MatchedItem.OtherItem
Return Value
Type: void
setNonOwnerEditable(nonOwnerEditable)
Signature
Parameters
nonOwnerEditable
Type: Boolean
Return Value
Type: void
setNoReactions(noReactions)
Signature
Parameters
noReactions
Type: Boolean
Return Value
Type: void
setOriginalHeight(originalHeight)
Signature
Parameters
originalHeight
Type: String
Return Value
Type: void
setOriginalWidth(originalWidth)
Signature
Parameters
originalWidth
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
setPlainText(plainText)
Signature
Parameters
plainText
Type: String
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
setPreviewPlainText(previewPlainText)
Signature
Parameters
previewPlainText
Type: String
Return Value
Type: void
setPreviewTruncated(previewTruncated)
Signature
Parameters
previewTruncated
Type: Boolean
Return Value
Type: void
setPrevious(previous)
Signature
Parameters
previous
Type: Slack.MatchedItem.OtherItem
Return Value
Type: void
setPrevious2(previous2)
Signature
Parameters
previous
Type: Slack.MatchedItem.OtherItem
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
setScore(score)
Signature
Parameters
score
Type: String
Return Value
Type: void
setSentToSelf(sentToSelf)
Signature
Parameters
sentToSelf
Type: Boolean
Return Value
Type: void
setSize(size)
Signature
Parameters
size
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
setSubject(subject)
Signature
Parameters
subject
Type: String
Return Value
Type: void
setTeam(team)
Signature
Parameters
team
Type: String
Return Value
Type: void
setText(text)
Signature
Parameters
Type: String
Return Value
Type: void
setThumb64(thumb64)
Signature
Parameters
thumb64
Type: String
Return Value
Type: void
setThumb64Gif(thumb64Gif)
Signature
Parameters
thumb64Gif
Type: String
Return Value
Type: void
setThumb64Height(thumb64Height)
Signature
Parameters
thumb64Height
Type: String
Return Value
Type: void
setThumb64Width(thumb64Width)
Signature
Parameters
thumb64Width
Type: String
Return Value
Type: void
setThumb80(thumb80)
Signature
Parameters
thumb80
Type: String
Return Value
Type: void
setThumb80Gif(thumb80Gif)
Signature
Parameters
thumb80Gif
Type: String
Return Value
Type: void
setThumb80Height(thumb80Height)
Signature
Parameters
thumb80Height
Type: String
Return Value
Type: void
setThumb80Width(thumb80Width)
Signature
Parameters
thumb80Width
Type: String
Return Value
Type: void
setThumb160(thumb160)
Signature
Parameters
thumb160
Type: String
Return Value
Type: void
setThumb160Gif(thumb160Gif)
Signature
Parameters
thumb160Gif
Type: String
Return Value
Type: void
setThumb160Height(thumb160Height)
Signature
Parameters
thumb160Height
Type: String
Return Value
Type: void
setThumb160Width(thumb160Width)
Signature
Parameters
thumb160Width
Type: String
Return Value
Type: void
setThumb360(thumb360)
Signature
Parameters
thumb360
Type: String
Return Value
Type: void
setThumb360Gif(thumb360Gif)
Signature
Parameters
thumb360Gif
Type: String
Return Value
Type: void
setThumb360Height(thumb360Height)
Signature
Parameters
thumb360Height
Type: String
Return Value
Type: void
setThumb360Width(thumb360Width)
Signature
Parameters
thumb360Width
Type: String
Return Value
Type: void
setThumb480(thumb480)
Signature
Parameters
thumb480
Type: String
Return Value
Type: void
setThumb480Gif(thumb480Gif)
Signature
Parameters
thumb480Gif
Type: String
Return Value
Type: void
setThumb480Height(thumb480Height)
Signature
Parameters
thumb480Height
Type: String
Return Value
Type: void
setThumb480Width(thumb480Width)
Signature
Parameters
thumb480Width
Type: String
Return Value
Type: void
setThumb720(thumb720)
Signature
Parameters
thumb720
Type: String
Return Value
Type: void
setThumb720Gif(thumb720Gif)
Signature
Parameters
thumb720Gif
Type: String
Return Value
Type: void
setThumb720Height(thumb720Height)
Signature
Parameters
thumb720Height
Type: String
Return Value
Type: void
setThumb720Width(thumb720Width)
Signature
Parameters
thumb720Width
Type: String
Return Value
Type: void
setThumb800(thumb800)
Signature
Parameters
thumb800
Type: String
Return Value
Type: void
setThumb800Gif(thumb800Gif)
Signature
Parameters
thumb800Gif
Type: String
Return Value
Type: void
setThumb800Height(thumb800Height)
Signature
Parameters
thumb800Height
Type: String
Return Value
Type: void
setThumb800Width(thumb800Width)
Signature
Parameters
thumb800Width
Type: String
Return Value
Type: void
setThumb960(thumb960)
Signature
Parameters
thumb960
Type: String
Return Value
Type: void
setThumb960Gif(thumb960Gif)
Signature
Parameters
thumb960Gif
Type: String
Return Value
Type: void
setThumb960Height(thumb960Height)
Signature
Parameters
thumb960Height
Type: String
Return Value
Type: void
setThumb960Width(thumb960Width)
Signature
Parameters
thumb960Width
Type: String
Return Value
Type: void
setThumb1024(thumb1024)
Signature
Parameters
thumb1024
Type: String
Return Value
Type: void
setThumb1024Gif(thumb1024Gif)
Signature
Parameters
thumb1024Gif
Type: String
Return Value
Type: void
setThumb1024Height(thumb1024Height)
Signature
Parameters
thumb1024Height
Type: String
Return Value
Type: void
setThumb1024Width(thumb1024Width)
Signature
Parameters
thumb1024Width
Type: String
Return Value
Type: void
setThumbPdf(thumbPdf)
Signature
Parameters
thumbPdf
Type: String
Return Value
Type: void
setThumbPdfHeight(thumbPdfHeight)
Signature
Parameters
thumbPdfHeight
Type: String
Return Value
Type: void
setThumbPdfWidth(thumbPdfWidth)
Signature
Parameters
thumbPdfWidth
Type: String
Return Value
Type: void
setThumbTiny(thumbTiny)
Signature
Parameters
thumbTiny
Type: String
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
setTo(to)
Signature
Parameters
to
Type: List<Slack.MatchedItem.Address>
Return Value
Type: void
setTopFile(topFile)
Signature
Parameters
topFile
Type: Boolean
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
setUpdated(updated)
Signature
Parameters
updated
Type: Integer
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
setUserTeam(userTeam)
Signature
Parameters
userTeam
Type: String
Return Value
Type: void
MatchedItem.Address Methods
The following are methods for MatchedItem.Address
.
getAddress()
Signature
Return Value
Type: String
getName()
Signature
Return Value
Type: String
getOriginal()
Signature
Return Value
Type: String
setAddress(address)
Signature
Parameters
address
Type: String
Return Value
Type: void
setName(name)
Signature
Parameters
name
Type: String
Return Value
Type: void
setOriginal(original)
Signature
Parameters
original
Type: String
Return Value
Type: void
MatchedItem.OtherItem Methods
The following are methods for MatchedItem.OtherItem
.
getIid()
Signature
Return Value
Type: String
getPermalink()
Signature
Return Value
Type: String
getText()
Signature
Return Value
Type: String
getTs()
Signature
Return Value
Type: String
getType()
Signature
Return Value
Type: String
getUser()
Signature
Return Value
Type: String
getUsername()
Signature
Return Value
Type: String
setIid(iid)
Signature
Parameters
iid
Type: String
Return Value
Type: void
setPermalink(permalink)
Signature
Parameters
permalink
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
setUsername(username)
Signature
Parameters
username
Type: String
Return Value
Type: void
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
Return Value
Type: List<Slack.MatchedItem>
getPagination()
Signature
Return Value
Type: Slack.SearchResult.Pagination
getPaging()
Signature
Return Value
Type: Slack.Paging
getRefinements()
Signature
Return Value
Type: List<String>
getTotal()
Signature
Return Value
Type: Integer
setMatches(matches)
Signature
Parameters
matches
Type: List<Slack.MatchedItem>
Return Value
Type: void
setPagination(pagination)
Signature
Parameters
pagination
Type: Slack.SearchResult.Pagination
Return Value
Type: void
setPaging(paging)
Signature
Parameters
pagination
Type: Slack.Paging
Return Value
Type: void
setRefinements(refinements)
Signature
Parameters
refinements
Type: List<String>
Return Value
Type: void
setTotal(total)
Signature
Parameters
total
Type: Integer
Return Value
Type: void
SearchResult.Pagination Methods
The following are methods for SearchResult.Pagination
.
getFirst()
Signature
Return Value
Type: Integer
getLast()
Signature
Return Value
Type: Integer
getPage()
Signature
Return Value
Type: Integer
getPageCount()
Signature
Return Value
Type: Integer
getPerPage()
Signature
Return Value
Type: Integer
getTotalCount()
Signature
Return Value
Type: Integer
setFirst(first)
Signature
Parameters
first
Type: Integer
Return Value
Type: void
setLast(last)
Signature
Parameters
last
Type: Integer
Return Value
Type: void
setPage(page)
Signature
Parameters
page
Type: Integer
Return Value
Type: void
setPageCount(pageCount)
Signature
Parameters
pageCount
Type: Integer
Return Value
Type: void
setPerPage(perPage)
Signature
Parameters
perPage
Type: Integer
Return Value
Type: void
setTotalCount(totalCount)
Signature
Parameters
totalCount
Type: Integer
Return Value
Type: void
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
Return Value
Type: Slack.SearchAllRequest.Builder
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
Return Value
Type: Slack.SearchAllRequest
count(count)
Number of items to return per page. The default is 20.
Signature
Parameters
count
Type: Integer
Return Value
Type: Slack.SearchAllRequest.Builder
highlight(highlight)
Specifies whether to enable query highlight markers.
Signature
Parameters
highlight
Type: Boolean
Return Value
Type: Slack.SearchAllRequest.Builder
page(page)
Page number of results to return. The default is 1.
Signature
Parameters
page
Type: Integer
Return Value
Type: Slack.SearchAllRequest.Builder
query(query)
Required. The search query, which can contain booleans.
Signature
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
Parameters
sortDir
Type: String
sortValue(sortValue)
Signature
Parameters
sortType
Type: String
Return Value
Type: Slack.SearchAllRequest.Builder
teamId(teamId)
Signature
Parameters
teamId
Type: String
Return Value
Type: Slack.SearchAllRequest.Builder
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
Return Value
Type: Slack.SearchResult
getMessages()
Signature
Return Value
Type: Slack.SearchResult
getPosts()
Signature
Return Value
Type: Slack.SearchAllResponse.Posts
getQuery()
Signature
Return Value
Type: String
setFiles(files)
Signature
Parameters
files
Type: Slack.SearchResult
Return Value
Type: void
setMessages(messages)
Signature
Parameters
messages
Type: Slack.SearchResult
Return Value
Type: void
setPosts(posts)
Signature
Parameters
posts
Type: Slack.SearchAllResponse.Posts
Return Value
Type: void
setQuery(query)
Signature
Parameters
query
Type: String
Return Value
Type: void
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
Return Value
Type: List<String>
getTotal()
Signature
Return Value
Type: Integer
setMatches(matches)
Signature
Parameters
matches
Type: List<String>
Return Value
Type: void
setTotal(total)
Signature
Parameters
total
Type: Integer
Return Value
Type: void
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
Return Value
Type: Slack.SearchFilesRequest.Builder
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
Return Value
Type: Slack.SearchFilesRequest
count(count)
Number of items to return per page. The default is 20.
Signature
Parameters
count
Type: Integer
Return Value
Type: Slack.SearchFilesRequest.Builder
highlight(highlight)
Specifies whether to enable query highlight markers.
Signature
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
Parameters
page
Type: Integer
Return Value
Type: Slack.SearchFilesRequest.Builder
query(query)
Required. The search query.
Signature
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
Parameters
sortDir
Type: String
Return Value
Type: Slack.SearchFilesRequest.Builder
sortValue(sortValue)
Returns martches sorted by score
or timestamp
. The default is score
.
Signature
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
Parameters
teamId
Type: String
Return Value
Type: Slack.SearchFilesRequest.Builder
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
Return Value
Type: Slack.SearchResult
getQuery()
Signature
Return Value
Type: String
setFiles(files)
Signature
Parameters
files
Type: Slack.SearchResult
Return Value
Type: void
setQuery(query)
Signature
Parameters
query
Type: String
Return Value
Type: void
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
Return Value
Type: Slack.SearchMessagesRequest.Builder.
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
Return Value
Type: Slack.SearchMessagesRequest
count(count)
Number of items to return per page. The default is 20.
Signature
Parameters
count
Type: Integer
Return Value
Type: Slack.SearchMessagesRequest.Builder
cursor(cursor)
Signature
Parameters
cursor
Type: String
Return Value
Type: Slack.SearchMessagesRequest.Builder
highlight(highlight)
Specifies whether to enable query highlight markers.
Signature
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
Parameters
page
Type: Integer
Return Value
Type: Slack.SearchMessagesRequest.Builder
query(query)
Required. The search query.
Signature
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
Parameters
sortDir
Type: String
Return Value
Type: Slack.SearchMessagesRequest.Builder
sortValue(sortValue)
Returns martches sorted by score
or timestamp
. The default is score
.
Signature
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
Parameters
teamId
Type: String
Return Value
Type: Slack.SearchMessagesRequest.Builder
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
Return Value
Type: Slack.SearchResult
getQuery()
Signature
Return Value
Type: String
setMessages(messages)
Signature
Parameters
messages
Type: Slack.SearchResult
Return Value
Type: void
setQuery(query)
Signature
Parameters
query
Type: String
Return Value
Type: void