Work with Files
The following are Apex classes for the Slack files
API methods.
Represents information about a file shared with a workspace.
Usage
File Methods
The following are methods for File
.
getAppId()
Signature
Return Value
Type: String
getAppName()
Signature
Return Value
Type: String
getCc()
Signature
Return Value
Type: List<Slack.File.Address>
getChannelActionsCount()
Signature
Return Value
Type: Integer
getChannelActionsTs()
Signature
Return Value
Type: String
getChannels()
Signature
Return Value
Type: List<String>
getConvertedPdf()
Signature
Return Value
Type: String
getCreated()
Signature
Return Value
Type: Integer
getDeanimate()
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
getFiletype()
Signature
Return Value
Type: String
getFrom()
Signature
Return Value
Type: List<Slack.File.Address>
getGroups()
Signature
Return Value
Type: List<String>
getHeaders()
Signature
Return Value
Type: Slack.File.Headers
getId()
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
getMediaDisplayType()
Signature
Return Value
Type: String
getMimetype()
Signature
Return Value
Type: String
getMode()
Signature
Return Value
Type: String
getName()
Signature
Return Value
Type: String
getOriginalAttachmentCount()
Signature
Return Value
Type: Integer
getOriginalHeight()
Signature
Return Value
Type: String
getOriginalWidth()
Signature
Return Value
Type: String
getPermalink()
Signature
Return Value
Type: String
getPermalinkPublic()
Signature
Return Value
Type: String
getPinnedInfo()
Signature
Return Value
Type: Map<String,Slack.File.PinnedInfo>
getPjpeg()
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
getShares()
Signature
Return Value
Type: Slack.File.Shares
getSimplifiedHtml()
Signature
Return Value
Type: String
getSize()
Signature
Return Value
Type: Integer
getSubject()
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
Type: String
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
getThumbGif()
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
getThumbVideo()
Signature
Return Value
Type: String
getTimestamp()
Signature
Return Value
Type: Integer
getTitle()
Signature
Return Value
Type: String
getTo()
Signature
Return Value
Type: List<Slack.File.Address>
getUpdated()
Signature
Return Value
Type: Integer
getUrlPrivate()
Signature
Return Value
Type: String
getUrlPrivateDownload()
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
isHasMore()
Signature
Return Value
Type: Boolean
isHasRichPreview()
Signature
Return Value
Type: Boolean
isNonOwnerEditable()
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
setAppId(appId)
Signature
Parameters
appId
Type: String
Return Value
Type: void
setAppName(appName)
Signature
Parameters
appName
Type: String
Return Value
Type: void
setCc(cc)
Signature
Parameters
cc
Type: List<Slack.File.Address>
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
setConvertedPdf(convertedPdf)
Signature
Parameters
convertedPdf
Type: String
Return Value
Type: void
setCreated(created)
Signature
Parameters
created
Type: Integer
Return Value
Type: void
setDeanimateGif(deanimateGif)
Signature
Parameters
deanimatedGif
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
setFiletype(filetype)
Signature
Parameters
filetype
Type: String
Return Value
Type: void
setFrom(fromValue)
Signature
Parameters
fromValue
Type: List<Slack.File.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
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
setMediaDisplayType(mediaDisplayType)
Signature
Parameters
mediaDisplayType
Type: String
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(name)
Signature
Parameters
name
Type: String
Return Value
Type: void
setNonOwnerEditable(nonOwnerEditable)
Signature
Parameters
nonOwnerEditable
Type: Boolean
Return Value
Type: void
setOriginalAttachmentCount(originalAttachmentCount)
Signature
Parameters
originalAttachmentCount
Type: Integer
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: String
Return Value
Type: void
setPinnedInfo(pinnedInfo)
Signature
Parameters
pinnedInfo
Type: Map<String,Slack.File.PinnedInfo>
Return Value
Type: void
setPjpeg(pjpeg)
Signature
Parameters
pjpeg
Type: String
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
setpublic(_public)
Signature
Parameters
_public
Type: Boolean
Return Value
Type: void
setPublicUrlShared(publicUrlShared)
Signature
Parameters
publicUrlShared
Type: Boolean
Return Value
Type: void
setSentToSelf(sentToSelf)
Signature
Parameters
sentToSelf
Type: Boolean
Return Value
Type: void
setShares(shares)
Signature
Parameters
shares
Type: Slack.File.Shares
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
setSubject(subject)
Signature
Parameters
subject
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
setThumbGif(thumbGif)
Signature
Parameters
thumbGif
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
setThumbVideo(thumbVideo)
Signature
Parameters
thumbVideo
Type: String
Return Value
Type: void
setTimestamp(timestamp)
Signature
Parameters
timestamp
Type: Integer
Return Value
Type: void
setTitle(title)
Signature
Parameters
title
Type: String
Return Value
Type: void
setTo(to)
Signature
Parameters
to
Type: List<Slack.File.Address>
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: 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
File.Address Methods
The following are methods for File.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
File.Headers Methods
The following are methods for File.Headers
.
getDate()
Signature
Return Value
Type: String
getInReplyTo()
Signature
Return Value
Type: String
getReplyTo()
Signature
Return Value
Type: String
getMessageId()
Signature
Return Value
Type: String
setDate(dateValue)
Signature
Parameters
dateValue
Type: String
Return Value
Type: void
setInReplyTo(inReplyTo)
Signature
Parameters
inReplyTo
Type: String
Return Value
Type: void
setReplyTo(replyTo)
Signature
Parameters
replyTo
Type: String
Return Value
Type: void
setMessageId(messageId)
Signature
Parameters
messageId
Type: String
Return Value
Type: void
File.PinnedInfo Methods
The following are methods for File.PinnedInfo
.
getPinnedBy()
Signature
Return Value
Type: String
getPinnedTs()
Signature
Return Value
Type: Integer
setPinnedBy(pinnedBy)
Signature
Parameters
pinnedBy
Type: String
Return Value
Type: void
setPinnedTs(pinnedTs)
Signature
Parameters
pinnedTs
Type: Integer
Return Value
Type: void
File.ShareDetail Methods
The following are methods for File.ShareDetail
.
getChannelName()
Signature
Return Value
Type: String
getLatestReply()
Signature
Return Value
Type: String
getReplyCount()
Signature
Return Value
Type: Integer
getReplyUsers()
Signature
Return Value
Type: List<String>
getReplyUsersCount()
Signature
Return Value
Type: Integer
getShareUserId()
Signature
Return Value
Type: String
getTeamId()
Signature
Return Value
Type: String
getThreadTs()
Signature
Return Value
Type: String
getTs()
Signature
Return Value
Type: String
setChannelName(channelName)
Signature
Parameters
channelName
Type: String
Return Value
Type: void
setLatestReply(latestReply)
Signature
Parameters
latestReply
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
setShareUserId(shareUserId)
Signature
Parameters
shareUserId
Type: String
Return Value
Type: void
setTeamId(teamId)
Signature
Parameters
teamId
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
Represents information about a file share, such as to a private or public channel.
File.Shares Methods
The following are methods for File.Shares
.
getPrivateChannels()
Signature
Return Value
Type: Map<String,List<Slack.File.ShareDetail>>
getPublicChannels()
Signature
Return Value
Type: Map<String,List<Slack.File.ShareDetail>>
setPrivateChannels(privateChannels)
Signature
Parameters
privateChannels
Type: Map<String,List<Slack.File.ShareDetail>>
Return Value
Type: void
setPublicChannels(publicChannels)
Signature
Parameters
publicChannels
Type: Map<String,List<Slack.File.ShareDetail>>
Return Value
Type: void
FileComment Methods
The following are methods for FileComment
.
getChannel()
Signature
Return Value
Type: String
getComment()
Signature
Return Value
Type: String
getCreated()
Signature
Return Value
Type: Integer
getId()
Signature
Return Value
Type: String
getTimestamp()
Signature
Return Value
Type: Integer
getUser()
Signature
Return Value
Type: String
isIntro()
Signature
Return Value
Type: Boolean
setChannel(channel)
Signature
Parameters
channel
Type: String
Return Value
Type: void
setComment(comment)
Signature
Parameters
comment
Type: String
Return Value
Type: void
setCreated(created)
Signature
Parameters
created
Type: Integer
Return Value
Type: void
setDeanimate(deanimate)
Signature
Parameters
deanimate
Type: String
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
setTimestamp(timestamp)
Signature
Parameters
timestamp
Type: Integer
Return Value
Type: void
setUser(user)
Signature
Parameters
user
Type: String
Return Value
Type: void
Sends a request to delete a file.
Usage
See Slack’s files.delete method.
FilesDeleteRequest Methods
The following are methods for FilesDeleteRequest
.
builder()
Builds a request object that's used when executing the API call.
Signature
Return Value
Type: Slack.FilesDeleteRequest.Builder
Contains methods to build an instance of the Slack.FilesDeleteRequest
class.
A Builder object is obtained by invoking one of the FilesDeleteRequest.builder
methods defined by the FilesDeleteRequest
class.
FilesDeleteRequest.Builder Methods
The following are methods for FilesDeleteRequest.Builder
.
build()
Required. Returns an instance of Slack.FilesDeleteRequest
.
Signature
Return Value
Type: Slack.FilesDeleteRequest
file(file)
Required. The ID of file to delete.
Signature
Parameters
file
Type: String The ID of the file to delete
Return Value
Type: Slack.FilesDeleteRequest.Builder
Deletes a file.
Usage
See Slack’s files.delete method.
FilesDeleteResponse Methods
This class contains standard response methods.
Sends a request to get information about a file.
Usage
See Slack’s files.info method.
FilesInfoRequest Methods
The following are methods for FilesInfoRequest
.
builder()
Builds a request object that's used when executing the API call.
Signature
Return Value
Type: Slack.FilesInfoRequest.Builder
Contains methods to build an instance of the Slack.FilesInfoRequest
class.
A Builder object is obtained by invoking one of the FilesInfoRequest.builder
methods defined by the FilesInfoRequest
class.
FilesInfoRequest.Builder Methods
The following are methods for FilesInfoRequest.Builder
. These methods are optional unless specified otherwise.
build()
Required. Returns an instance of Slack.FilesInfoRequest
.
Signature
Return Value
Type: Slack.FilesInfoRequest
count(count)
Signature
Parameters
count
Type: Integer
Return Value
Type: Slack.FilesInfoRequest.Builder
file(file)
Required. The ID of the file to retrieve information for.
Signature
Parameters
file
Type: String
Return Value
Type: Slack.FilesInfoRequest.Builder
page(page)
Signature
Parameters
page
Type: Integer
Return Value
Type: Slack.FilesInfoRequest.Builder
Gets information about a file.
Usage
See Slack’s files.info method.
FilesInfoResponse Methods
This class contains standard response methods.
The following are methods for FilesInfoResponse
.
getContent()
Signature
Return Value
Type: String
getContentHighlightCss()
Signature
Return Value
Type: String
getContentHighlightHtml()
Signature
Return Value
Type: String
getFile()
Signature
Return Value
Type: Slack.File
isTruncated()
Signature
Return Value
Type: Boolean
setContent(content)
Signature
Parameters
content
Type: String
setContentHighlightCss(contentHighlightCss)
Signature
Parameters
contentHighlightCss
Type: String
Return Value
Type: void
setContentHighlightHtml(contentHighlightHtml)
Signature
Parameters
contentHighlightHtml
Type: String
Return Value
Type: void
setFile(file)
Signature
Parameters
file
Type: Slack.File
Return Value
Type: void
setTruncated(truncated)
Signature
Parameters
truncated
Type: Boolean
Return Value
Type: void
Sends a request to retrieve a list of files for a team, in a channel, or from a user with applied filters.
Usage
See Slack’s files.list method.
FilesListRequest Methods
The following are methods for FilesListRequest
.
builder()
Builds a request object that's used when executing the API call.
Signature
Return Value
Type: Slack.FilesListRequest.Builder
Contains methods to build an instance of the Slack.FilesListRequest
class.
A Builder object is obtained by invoking one of the FilesListRequest.builder
methods defined by the FilesListRequest
class.
FilesListRequest.Builder Methods
The following are methods for FilesListRequest.Builder
. These methods are optional unless specified otherwise.
build()
Required. Returns an instance of Slack.FilesListRequest
.
Signature
Return Value
Type: Slack.FilesListRequest
channel(channel)
Signature
Parameters
channel
Type: String
Return Value
Type: Slack.FilesListRequest.Builder
count(count)
Signature
Parameters
count
Type: Integer
Return Value
Type: Slack.FilesListRequest.Builder
page(page)
Signature
Parameters
page
Type: Integer
Return Value
Type: Slack.FilesListRequest.Builder
showFilesHiddenByLimit(showFilesHiddenByLimit)
Signature
Parameters
showFilesHiddenByLimit
Type: Boolean
Return Value
Type: Slack.FilesListRequest.Builder
teamId(teamId)
Signature
Parameters
teamId
Type: String
Return Value
Type: Slack.FilesListRequest.Builder
tsFrom(tsFrom)
Signature
Parameters
tsFrom
Type: String
Return Value
Type: Slack.FilesListRequest.Builder
tsTo(tsTo)
Signature
Parameters
tsTo
Type: String
Return Value
Type: Slack.FilesListRequest.Builder
types(types)
Signature
Parameters
types
Type: List<String>
Return Value
Type: Slack.FilesListRequest.Builder
user(user)
Signature
Parameters
user
Type: String
Return Value
Type: Slack.FilesListRequest.Builder
Retrieves a list of files for a team, in a channel, or from a user with applied filters.
Usage
See Slack’s files.list method.
FilesListResponse Methods
This class contains standard response methods.
The following are methods for FilesListResponse
.
getFiles()
Signature
Return Value
Type: List<Slack.File>
getPaging()
Signature
Return Value
Type: Slack.Paging
setFiles(files)
Signature
Parameters
files
Type: List<Slack.File>
Return Value
Type: void
setPaging(paging)
Signature
Parameters
paging
Type: Slack.Paging
Return Value
Type: void
Sends a request to add a file from a remote service.
Usage
See Slack’s files.remote.add method.
FilesRemoteAddRequest Methods
The following are methods for FilesRemoteAddRequest
.
builder()
Builds a request object that's used when executing the API call.
Signature
Return Value
Type: Slack.FilesRemoteAddRequest.Builder
Contains methods to build an instance of the Slack.FilesRemoteAddRequest
class.
A Builder object is obtained by invoking one of the FilesRemoteAddRequest.builder
methods defined by the FilesRemoteAddRequest
class.
FilesRemoteAddRequest.Builder Methods
The following are methods for FilesRemoteAddRequest.Builder
. These methods are optional unless specified otherwise.
build()
Required. Returns an instance of Slack.FilesRemoteAddRequest
.
Signature
Return Value
Type: Slack.FilesRemoteAddRequest
externalId(externalId)
Required. The creator-defined GUID for the file.
Signature
Parameters
externalId
Type: String
Return Value
Type: Slack.FilesRemoteAddRequest.Builder
externalUrl(externalUrl)
Required. The URL of the remote file.
Signature
Parameters
externalUrl
Type: String
Return Value
Type: Slack.FilesRemoteAddRequest.Builder
filetype(filetype)
Signature
Parameters
filetype
Type: String
Return Value
Type: Slack.FilesRemoteAddRequest.Builder
title(title)
Required. The title of the file being shared.
Signature
Parameters
title
Type: String
Return Value
Type: Slack.FilesRemoteAddRequest.Builder
Adds a file from a remote service.
Usage
See Slack’s files.remote.add method.
FilesRemoteAddResponse Methods
This class contains standard response methods.
The following are methods for FilesRemoteAddResponse
.
getFile()
Signature
Return Value
Type: Slack.File
setFile(file)
Signature
Parameters
file
Type: Slack.File
Return Value
Type: void
Sends a request to retrieve information about a remote file that’s added to Slack.
Usage
See Slack’s files.remote.info method.
FilesRemoteInfoRequest Methods
The following are methods for FilesRemoteInfoRequest
.
builder()
Builds a request object that's used when executing the API call.
Signature
Return Value
Type: Slack.FilesRemoteInfoRequest.Builder
Contains methods to build an instance of the Slack.FilesRemoteInfoRequest
class.
A Builder object is obtained by invoking one of the FilesRemoteInfoRequest.builder
methods defined by the FilesRemoteInfoRequest
class.
FilesRemoteInfoRequest.Builder Methods
The following are methods for FilesRemoteInfoRequest.Builder
. These methods are optional unless specified otherwise.
build()
Required. Returns an instance of Slack.FilesRemoteInfoRequest
.
Signature
Return Value
Type: Slack.FilesRemoteInfoRequest
externalId(externalId)
Signature
Return Value
Type: Slack.FilesRemoteInfoRequest.Builder
file(file)
Signature
Parameters
file
Type: String
Return Value
Type: Slack.FilesRemoteInfoRequest.Builder
Retrieves information about a remote file that’s added to Slack.
Usage
See Slack’s files.remote.info method.
FilesRemoteInfoResponse Methods
This class contains standard response methods.
The following are methods for FilesRemoteInfoResponse
.
getFile()
Signature
Return Value
Type: Slack.File
setFile(file)
Signature
Parameters
file
Type: Slack.File
Return Value
Type: void
Sends a request to retrieve a list of files that’s added to Slack for a team, in a channel, or from a user with applied filters.
Usage
See Slack’s files.remote.list method.
FilesRemoteListRequest Methods
The following are methods for FilesRemoteListRequest
.
builder()
Builds a request object that's used when executing the API call.
Signature
Return Value
Type: Slack.FilesRemoteListRequest.Builder
Contains methods to build an instance of the Slack.FilesRemoteListRequest
class.
A Builder object is obtained by invoking one of the FilesRemoteListRequest.builder
methods defined by the FilesRemoteListRequest
class.
FilesRemoteListRequest.Builder Methods
The following are methods for FilesRemoteListRequest.Builder
. These methods are optional unless specified otherwise.
build()
Required. Returns an instance of Slack.FilesRemoteListRequest
.
Signature
Return Value
Type: Slack.FilesRemoteListRequest
channel(channel)
Signature
Parameters
channel
Type: String
Return Value
Type: Slack.FilesRemoteListRequest.Builder
cursor(cursor)
Signature
Parameters
cursor
Type: String
Return Value
Type: Slack.FilesRemoteListRequest.Builder
limitValue(limitValue)
Signature
Parameters
limitValue
Type: Integer
Return Value
Type: Slack.FilesRemoteListRequest.Builder
tsFrom(tsFrom)
Signature
Parameters
tsFrom
Type: String
Return Value
Type: Slack.FilesRemoteListRequest.Builder
tsTo(tsTo)
Signature
Parameters
tsTo
Type: String
Return Value
Type: Slack.FilesRemoteListRequest.Builder
Retrieves a list of files that’s added to Slack for a team, in a channel, or from a user with applied filters.
Usage
See Slack’s files.remote.list method.
FilesRemoteListResponse Methods
This class contains standard response methods.
The following are methods for FilesRemoteListResponse
.
getFiles()
Signature
Return Value
Type: List<Slack.File>
getResponseMetadata()
Signature
Return Value
Type: Slack.ResponseMetadata
setFiles(files)
Signature
Parameters
files
Type: List<Slack.File>
Return Value
Type: void
setResponseMetadata(metadata)
Signature
Parameters
responseMetadata
Type: Slack.ResponseMetadata
Return Value
Type: void
Sends a request to remove a remote file.
Usage
See Slack’s files.remote.remove method.
FilesRemoteRemoveRequest Methods
The following are methods for FilesRemoteRemoveRequest
.
builder()
Builds a request object that's used when executing the API call.
Signature
Return Value
Type: Slack.FilesRemoteRemoveRequest.Builder
Contains methods to build an instance of the Slack.FilesRemoteRemoveRequest
class.
A Builder object is obtained by invoking one of the FilesRemoteRemoveRequest.builder
methods defined by the FilesRemoteRemoveRequest
class.
FilesRemoteRemoveRequest.Builder Methods
The following are methods for FilesRemoteRemoveRequest.Builder
. These methods are optional unless specified otherwise.
build()
Required. Returns an instance of Slack.FilesRemoteRemoveRequest
.
Signature
Return Value
Type: Slack.FilesRemoteRemoveRequest
externalId(externalId)
Signature
Parameters
externalId
Type: String
Return Value
Type: Slack.FilesRemoteRemoveRequest.Builder
file(file)
Signature
Parameters
file
Type: String
Return Value
Type: Slack.FilesRemoteRemoveRequest.Builder
Removes a remote file.
Usage
See Slack’s files.remote.remove method
FilesRemoteRemoveResponse Methods
This class contains standard response methods.
Sends a request to share a remote file into a channel.
Usage
See Slack’s files.remote.share method
FilesRemoteShareRequest Methods
The following are methods for FilesRemoteShareRequest
.
builder()
Builds a request object that's used when executing the API call.
Signature
Return Value
Type: Slack.FilesRemoteShareRequest.Builder
Contains methods to build an instance of the Slack.FilesRemoteShareRequest
class.
A Builder object is obtained by invoking one of the FilesRemoteShareRequest.builder
methods defined by the FilesRemoteShareRequest
class.
FilesRemoteShareRequest.Builder Methods
The following are methods for FilesRemoteShareRequest.Builder
. These methods are optional unless specified otherwise.
build()
Required. Returns an instance of Slack.FilesRemoteShareRequest
.
Signature
Return Value
Type: Slack.FilesRemoteShareRequest
channels(channels)
Required. The comma-separated list of channel IDs where the file is shared.
Signature
Parameters
channels
Type: List<String>
Return Value
Type: Slack.FilesRemoteShareRequest.Builder
externalId(externalId)
Signature
Parameters
externalId
Type: String
Return Value
Type: Slack.FilesRemoteShareRequest.Builder
file(file)
Signature
Parameters
file
Type: String
Return Value
Type: Slack.FilesRemoteShareRequest.Builder
Shares a remote file into a channel.
Usage
See Slack’s files.remote.share method.
FilesRemoteShareResponse Methods
This class contains standard response methods.
The following are methods for FilesRemoteShareResponse
.
getFile()
Signature
Return Value
Type: Slack.File
setFile(file)
Signature
Parameters
file
Type: Slack.File
Return Value
Type: void
Sends a request to update an existing remote file.
Usage
See Slack’s files.remote.update method.
FilesRemoteUpdateRequest Methods
The following are methods for FilesRemoteUpdateRequest
.
builder()
Builds a request object that's used when executing the API call.
Signature
Return Value
Type: Slack.FilesRemoteUpdateRequest.Builder
Contains methods to build an instance of the Slack.FilesRemoteUpdateRequest
class.
A Builder object is obtained by invoking one of the FilesRemoteUpdateRequest.builder
methods defined by the FilesRemoteUpdateRequest
class.
FilesRemoteUpdateRequest.Builder Methods
The following are methods for FilesRemoteUpdateRequest.Builder
. These methods are optional unless specified otherwise.
build()
Returns an instance of the Slack.FilesRemoteUpdateRequest
object.
Signature
Return Value
Type: Slack.FilesRemoteUpdateRequest
externalId(externalId)
Signature
Parameters
externalId
Type: String
Return Value
Type: Slack.FilesRemoteUpdateRequest.Builder
externalUrl(externalUrl)
Signature
Parameters
externalUrl
Type: String
Return Value
Type: Slack.FilesRemoteUpdateRequest.Builder
filetype(filetype)
Signature
Parameters
filetype
Type: String
Return Value
Type: Slack.FilesRemoteUpdateRequest.Builder
title(title)
Signature public Slack.FilesRemoteUpdateRequest.Builder title(String title)
Parameters
title
Type: String
Return Value
Type: Slack.FilesRemoteUpdateRequest.Builder
Updates an existing remote file.
Usage
See Slack’s files.remote.update method.
FilesRemoteUpdateResponse Methods
This class contains standard response methods.
The following are methods for FilesRemoteUpdateResponse
.
getFile()
Signature
Return Value
Type: Slack.File
setFile(file)
Signature
Parameters
file
Type: Slack.File
Return Value
Type: void
Sends a request to revoke public or external sharing access for a file.
Usage
See Slack’s files.revokePublicURL method.
FilesRevokePublicURLRequest Methods
The following are methods for FilesRevokePublicURLRequest
.
builder()
Builds a request object that's used when executing the API call.
Signature
Return Value
Type: Slack.FilesRevokePublicURLRequest.Builder
Contains methods to build an instance of the Slack.FilesRevokePublicURLRequest
class.
A Builder object is obtained by invoking one of the FilesRevokePublicURLRequest.builder
methods defined by the FilesRevokePublicURLRequest
class.
FilesRevokePublicURLRequest.Builder Methods
The following are methods for FilesRevokePublicURLRequest.Builder
.
build()
Required. Returns an instance of Slack.FilesRevokePublicURLRequest
.
Signature
Return Value
Type: Slack.FilesRevokePublicURLRequest
file(file)
Required. The file to revoke.
Signature
Parameters
file
Type: String
Return Value
Type: Slack.FilesRevokePublicURLRequest.Builder
Revokes public or external sharing access for a file.
Usage
See Slack’s files.revokePublicURL method.
FilesRevokePublicURLResponse Methods
This class contains standard response methods.
The following are methods for FilesRevokePublicURLResponse
.
getFile()
Signature
Return Value
Type: Slack.File
setFile(file)
Signature
Parameters
file
Type: Slack.File
Return Value
Type: void
Sends a request to enable a file for public or external sharing.
Usage
See Slack’s files.sharedPublicURL method.
FilesSharedPublicURLRequest Methods
The following are methods for FilesSharedPublicURLRequest
.
builder()
Builds a request object that's used when executing the API call.
Signature
Return Value
Type: Slack.FilesSharedPublicURLRequest.Builder
Contains methods to build an instance of the Slack.FilesSharedPublicURLRequest
class.
A Builder object is obtained by invoking one of the FilesRevokeSharedURLRequest.builder
methods defined by the FilesRevokeSharedURLRequest
class.
FilesSharedPublicURLRequest.Builder Methods
The following are methods for FilesSharedPublicURLRequest.Builder
. These methods are optional unless specified otherwise.
build()
Required. Returns an instance of Slack.FilesSharedPublicURLRequest
.
Signature
Return Value
Type: Slack.FilesSharedPublicURLRequest
file(file)
Required. The file to share.
Signature
Parameters
file
Type: String
Return Value
Type: Slack.FilesSharedPublicURLRequest.Builder
Enables a file for public or external sharing.
Usage
See Slack’s files.sharedPublicURL method.
FilesSharedPublicURLResponse Methods
This class contains standard response methods.
The following are methods for FilesSharedPublicURLResponse
.
getFile()
Signature
Return Value
Type: Slack.File
setFile(file)
Signature
Parameters
file
Type: Slack.File
Return Value
Type: void