Work with Stars
The following are Apex classes for the Slack stars
API methods.
Sends a request to save an item for later.
Usage
See Slack’s stars.add method.
StarsAddRequest Methods
The following are methods for StarsAddRequest
.
builder()
Builds a request object that's used when executing the API call.
Signature
Return Value
Type: Slack.StarsAddRequest.Builder
Contains methods to build an instance of the Slack.StarsAddRequest
class.
A Builder object is obtained by invoking one of the StarsAddRequest.builder
methods defined by the StarsAddRequest
class.
StarsAddRequest.Builder Methods
The following are methods for StarsAddRequest.Builder
. These methods are optional unless specified otherwise.
build()
Required. Returns an instance of Slack.StarsAddRequest
.
Signature
Return Value
Type: Slack.StarsAddRequest
channel(channel)
The channel to add star to, or channel where the message to add star to was posted.
Signature
Parameters
channel
Type: String
Return Value
Type: Slack.StarsAddRequest.Builder
file(file)
The file to add a star to.
Signature
Parameters
file
Type: String
Type: Slack.StarsAddRequest.Builder
fileComment(fileComment)
The file comment to add a star to.
Signature
Parameters
fileComment
Type: String
Return Value
Type: Slack.StarsAddRequest.Builder
timestamp(timestamp)
Timestamp of the message to add a star to.
Signature
Parameters
timestamp
Type: String
Return Value
Type: Slack.StarsAddRequest.Builder
Saves an item for later.
Usage
See Slack’s stars.add method.
StarsAddResponse Methods
This class contains standard response methods.
Sends a request to list a user's saved items.
StarsListRequest Methods
The following are methods for StarsListRequest
.
builder()
Builds a request object that's used when executing the API call.
Signature
Return Value
Type: Slack.StarsListRequest.Builder
Contains methods to build an instance of the Slack.StarsListRequest
class.
A Builder object is obtained by invoking one of the StarsListRequest.builder
methods defined by the StarsListRequest
class.
StarsListRequest.Builder Methods
The following are methods for StarsListRequest.Builder
. These methods are optional unless specified otherwise.
build()
Required. Builds an instance of Slack.StarsListRequest
.
Signature
Return Value
Type: Slack.StarsListRequest
count(count)
Signature
Parameters
count
Type: Integer
Return Value
Type: Slack.StarsListRequest.Builder
cursor(cursor)
Signature
Parameters
cursor
Type: String
Return Value
Type: Slack.StarsListRequest.Builder
limitValue(limitValue)
Signature
Parameters
limitValue
Type: Integer
Return Value
Type: Slack.StarsListRequest.Builder
page(page)
Signature
Parameters
page
Type: Integer
Return Value
Type: Slack.StarsListRequest.Builder
teamId(teamId)
Signature
Parameters
teamId
Type: String
Return Value
Type: Slack.StarsListRequest.Builder
List a user's saved items.
StarsListResponse Methods
This class contains standard response methods.
The following are methods for StarsListResponse
.
getItems()
Signature
Return Value
Type: List<Slack.StarsListResponse.Item>
getPaging()
Signature
Return Value
Type: Slack.Paging
setItems(items)
Signature
Parameters
items
Type: List<Slack.StarsListResponse.Item>
Return Value
Type: void
setPaging(paging)
Signature
Parameters
paging
Type: Slack.Paging
Return Value
Type: void
StarsListResponse.Comment Methods
The following are methods for StarsListResponse.Comment
.
getComment()
Signature
Return Value
Type: String
getCreated()
Signature
Return Value
Type: Integer
getId()
Signature
Return Value
Type: String
getNumStars()
Signature
Return Value
Type: Integer
getTimestamp()
Signature
Return Value
Type: Integer
getUser()
Signature
Return Value
Type: String
isIntro()
Signature
Return Value
Type: Boolean
isStarred()
Signature
Return Value
Type: Boolean
setComment(comment)
Signature
Parameters
comment
Type: String
Return Value
Type: void
setCreated(created)
Signature
Parameters
created
Type: Integer
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
setNumStars(numStars)
Signature
Parameters
numStars
Type: Integer
Return Value
Type: void
setStarred(starred)
Signature
Parameters
starred
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
StarsListResponse.Edited Methods
The following are methods for StarsListResponse.Edited
.
getTs()
Signature
Return Value
Type: String
getUser()
Signature
Return Value
Type: String
setTs(ts)
Signature
Parameters
ts
Type: String
Return Value
Type: void
setUser(user)
Signature
Parameters
user
Type: String
Return Value
Type: void
Return Value
Type: void
StarsListResponse.Item Methods
The following are methods for StarsListResponse.Item
.
getChannel()
Signature
Return Value
Type: String
getComment()
Signature
Return Value
Type: Slack.StarsListResponse.Comment
getDateCreate()
Signature
Return Value
Type: Integer
getFile()
Signature
Return Value
Type: Slack.File
getMessage()
Signature
Return Value
Type: Slack.StarsListResponse.Message
getType()
Signature
Return Value
Type: String
setChannel(channel)
Signature
Parameters
channel
Type: String
Return Value
Type: void
setComment(comment)
Signature
Parameters
comment
Type: Slack.StarsListResponse.Comment
Return Value
Type: void
setDateCreate(dateCreate)
Signature
Parameters
dateCreate
Type: Integer
Return Value
Type: void
setFile(file)
Signature
Parameters
file
Type: Slack.File
Return Value
Type: void
setMessage(message)
Signature
Parameters
message
Type: Slack.StarsListResponse.Message
Return Value
Type: void
setType(type)
Signature
Parameters
type
Type: String
Return Value
Type: void
StarsListResponse.Message Methods
getBotId()
Signature
Return Value
Type: String
getBotProfile()
Signature
Return Value
Type: Slack.BotProfile
getClientMsgId()
Signature
Return Value
Type: String
getDisplayAsBot()
Signature
Return Value
Type: Boolean
getEdited()
Signature
Return Value
Type: Slack.StarsListResponse.Edited
getInviter()
Signature
Return Value
Type: String
getFiles()
Signature
Return Value
Type: List<Slack.File>
getLastRead()
Signature
Return Value
Type: String
getLatestReply()
Signature
Return Value
Type: String
getPermalink()
Signature
Return Value
Type: String
getReactions()
Signature
Return Value
Type: List<Slack.Reaction>
getReplyCount()
Signature
Return Value
Type: Integer
getReplyUsers()
Signature
Return Value
Type: List<String>
getReplyUsersCount()
Signature
Return Value
Type: Integer
getSubtype()
Signature
Return Value
Type: String
getTeam()
Signature
Return Value
Type: String
getText()
Signature
Return Value
Type: String
getThreadTs()
Signature
Return Value
Type: String
getTs()
Signature
Return Value
Type: String
getType()
Signature
Return Value
Type: String
getUpload()
Signature
Return Value
Type: Boolean
getUser()
Signature
Return Value
Type: String
getUsername()
Signature
Return Value
Type: String
isLocked()
Signature
Return Value
Type: Boolean
isSubscribed()
Signature
Return Value
Type: Boolean
isStarred()
Signature
Return Value
Type: Boolean
setBotId(botId)
Signature
Parameters
botId
Type: String
Return Value
Type: void
setBotProfile(botProfile)
Signature
Parameters
botProfile
Type: Slack.BotProfile
Return Value
Type: void
setClientMsgId(clientMsgId)
Signature
Parameters
clientMsgId
Type: String
Return Value
Type: void
setDisplayAsBot(displayAsBot)
Signature
Parameters
displayAsBot
Type: Boolean
Return Value
Type: void
setEdited(edited)
Signature
Parameters
edited
Type: Slack.StarsListResponse.Edited
Return Value
Type: void
setFiles(files)
Signature
Parameters
files
Type: List<Slack.File>
Return Value
Type: void
setInviter(inviter)
Signature
Parameters
inviter
Type: String
Return Value
Type: void
setLastRead(lastRead)
Signature
Parameters
lastRead
Type: String
Return Value
Type: void
setLatestReply(latestReply)
Signature
Parameters
latestReply
Type: String
Return Value
Type: void
setLocked(locked)
Signature
Parameters
locked
Type: Boolean
Return Value
Type: void
setPermalink(permalink)
Signature
Parameters
permalink
Type: String
Return Value
Type: void
setReactions(reactions)
Signature
Parameters
reactions
Type: List<Slack.Reaction>
Return Value
Type: void
setReplyCount(replyCount)
Signature
Parameters
replyCount
Type: Integer
Return Value
Type: void
setReplyUsers(replyUsers)
Signature
Parameters
replyUsers
Type: List<String>
Return Value
Type: void
setReplyUsersCount(replyUsersCount)
Signature
Parameters
replyUsersCount
Type: Integer
Return Value
Type: void
setStarred(starred)
Signature
Parameters
starred
Type: Boolean
Return Value
Type: void
setSubscribed(subscribed)
Signature
Parameters
subscribed
Type: Boolean
Return Value
Type: void
setSubtype(subtype)
Signature
Parameters
subtype
Type: String
Return Value
Type: void
setTeam(team)
Signature
Parameters
team
Type: String
Return Value
Type: void
setText(text)
Signature
Parameters
text
Type: String
Return Value
Type: void
setThreadTs(threadTs)
Signature
Parameters
threadTs
Type: String
Return Value
Type: void
setTs(ts)
Signature
Parameters
ts
Type: String
Return Value
Type: void
setType(type)
Signature
Parameters
type
Type: String
Return Value
Type: void
setUpload(upload)
Signature
Parameters
upload
Type: Boolean
Return Value
Type: void
setUser(user)
Signature
Parameters
user
Type: String
Return Value
Type: void
setUsername(username)
Signature
Parameters
username
Type: String
Return Value
Type: void
StarsListResponse.MessageRootReply Methods
The following are methods for StarsListResponse.MessageRootReply
.
getTs()
Signature
Return Value
Type: String
getUser()
Signature
Return Value
Type: String
setTs(ts)
Signature
Parameters
ts
Type: String
Return Value
Type: void
setUser(user)
Signature
Parameters
user
Type: String
Return Value
Type: void
Sends a request to remove a saved item (star) from an item.
Usage
See Slack’s stars.remove method.
StarsRemoveRequest Methods
The following are methods for StarsRemoveRequest
.
builder()
Builds a request object that's used when executing the API call.
Signature
Return Value
Type: Slack.StarsRemoveRequest.Builder
Contains methods to build an instance of the Slack.StarsRemoveRequest
class.
A Builder object is obtained by invoking one of the StarsRemoveRequest.builder
methods defined by the StarsRemoveRequest
class.
StarsRemoveRequest.Builder Methods
The following are methods for StarsRemoveRequest.Builder
. These methods are optional unless specified otherwise.
build()
Required. Returns an instance of the Slack.StarsRemoveRequest
object.
Signature
Return Value
Type: Slack.StarsRemoveRequest
channel(channel)
The channel to remove the star from, or channel where the message to remove the star from was posted.
Signature
Parameters
channel
Type: String
Return Value
Type: Slack.StarsRemoveRequest.Builder
file(file)
The file comment to remove the star from.
Signature
Parameters
file
Type: String
Return Value
Type: Slack.StarsRemoveRequest.Builder
fileComment(fileComment)
Signature
Parameters
fileComment
Type: String
Return Value
Type: Slack.StarsRemoveRequest.Builder
timestamp(timestamp)
The timestamp of the message to remove the star from.
Signature
Parameters
timestamp
Type: String
Return Value
Type: Slack.StarsRemoveRequest.Builder
Removes a saved item (star) from an item.
Usage
See Slack’s stars.remove method.
StarsRemoveResponse Methods
This class contains standard response methods.