Work with Stars
The following are Apex classes for the Slack stars API methods .
StarsAddRequest Class
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
1 static Slack . StarsAddRequest . Builder builder ( )
Return Value
Type: Slack.StarsAddRequest.Builder
StarsAddRequest.Builder Class
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
1 Slack . StarsAddRequest build ( )
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
1 Slack . StarsAddRequest . Builder channel ( String channel )
Parameters
channel
Type: String
Return Value
Type: Slack.StarsAddRequest.Builder
file(file)
The file to add a star to.
Signature
1 Slack . StarsAddRequest . Builder file ( String file )
Parameters
file
Type: String
Type: Slack.StarsAddRequest.Builder
fileComment(fileComment)
The file comment to add a star to.
Signature
1 Slack . StarsAddRequest . Builder fileComment ( String fileComment )
Parameters
fileComment
Type: String
Return Value
Type: Slack.StarsAddRequest.Builder
timestamp(timestamp)
Timestamp of the message to add a star to.
Signature
1 Slack . StarsAddRequest . Builder timestamp ( String timestamp )
Parameters
timestamp
Type: String
Return Value
Type: Slack.StarsAddRequest.Builder
StarsAddResponse Class
Saves an item for later.
Usage
See Slack’s stars.add method .
StarsAddResponse Methods
This class contains standard response methods .
StarsListRequest Class
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
1 public static Slack . StarsListRequest . Builder builder ( )
Return Value
Type: Slack.StarsListRequest.Builder
StarsListRequest.Builder Class
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
1 public Slack . StarsListRequest build ( )
Return Value
Type: Slack.StarsListRequest
count(count)
Signature
1 public Slack . StarsListRequest . Builder count ( Integer count )
Parameters
count
Type: Integer
Return Value
Type: Slack.StarsListRequest.Builder
cursor(cursor)
Signature
1 public Slack . StarsListRequest . Builder cursor ( String cursor )
Parameters
cursor
Type: String
Return Value
Type: Slack.StarsListRequest.Builder
limitValue(limitValue)
Signature
1 public Slack . StarsListRequest . Builder limitValue ( Integer limitValue )
Parameters
limitValue
Type: Integer
Return Value
Type: Slack.StarsListRequest.Builder
page(page)
Signature
1 public Slack . StarsListRequest . Builder page ( Integer page )
Parameters
page
Type: Integer
Return Value
Type: Slack.StarsListRequest.Builder
teamId(teamId)
Signature
1 public Slack . StarsListRequest . Builder teamId ( String teamId )
Parameters
teamId
Type: String
Return Value
Type: Slack.StarsListRequest.Builder
StarsListResponse Class
List a user’s saved items.
StarsListResponse Methods
This class contains standard response methods .
The following are methods for StarsListResponse.
getItems()
Signature
1 public List < Slack . StarsListResponse . Item > getItems ( )
Return Value
Type: List<Slack.StarsListResponse.Item>
getPaging()
Signature
1 public Slack . Paging getPaging ( )
Return Value
Type: Slack.Paging
setItems(items)
Signature
1 public void setItems ( List < Slack . StarsListResponse . Item > items )
Parameters
items
Type: List<Slack.StarsListResponse.Item>
Return Value
Type: void
setPaging(paging)
Signature
1 public void setPaging ( Slack . Paging paging )
Parameters
paging
Type: Slack.Paging
Return Value
Type: void
StarsListResponse.Comment Class
StarsListResponse.Comment Methods
The following are methods for StarsListResponse.Comment.
getComment()
Signature
1 public String getComment ( )
Return Value
Type: String
getCreated()
Signature
1 public Integer getCreated ( )
Return Value
Type: Integer
getId()
Signature
Return Value
Type: String
getNumStars()
Signature
1 public Integer getNumStars ( )
Return Value
Type: Integer
getTimestamp()
Signature
1 public Integer getTimestamp ( )
Return Value
Type: Integer
getUser()
Signature
Return Value
Type: String
isIntro()
Signature
1 public Boolean isIntro ( )
Return Value
Type: Boolean
isStarred()
Signature
1 public Boolean isStarred ( )
Return Value
Type: Boolean
setComment(comment)
Signature
1 public void setComment ( String comment )
Parameters
comment
Type: String
Return Value
Type: void
setCreated(created)
Signature
1 public void setCreated ( Integer created )
Parameters
created
Type: Integer
Return Value
Type: void
setId(id)
Signature
1 public void setId ( String id )
Parameters
id
Type: String
Return Value
Type: void
setIntro(intro)
Signature
1 public void setIntro ( Boolean intro )
Parameters
intro
Type: Boolean
Return Value
Type: void
setNumStars(numStars)
Signature
1 public void setNumStars ( Integer numStars )
Parameters
numStars
Type: Integer
Return Value
Type: void
setStarred(starred)
Signature
1 public void setStarred ( Boolean starred )
Parameters
starred
Type: Boolean
Return Value
Type: void
setTimestamp(timestamp)
Signature
1 public void setTimestamp ( Integer timestamp )
Parameters
timestamp
Type: Integer
Return Value
Type: void
setUser(user)
Signature
1 public void setUser ( String user )
Parameters
user
Type: String
Return Value
Type: void
StarsListResponse.Edited Class
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
1 public void setTs ( String ts )
Parameters
ts
Type: String
Return Value
Type: void
setUser(user)
Signature
1 public void setUser ( String user )
Parameters
user
Type: String
Return Value
Type: void
Return Value
Type: void
StarsListResponse.Item Class
StarsListResponse.Item Methods
The following are methods for StarsListResponse.Item.
getChannel()
Signature
1 public String getChannel ( )
Return Value
Type: String
getComment()
Signature
1 public Slack . StarsListResponse . Comment getComment ( )
Return Value
Type: Slack.StarsListResponse.Comment
getDateCreate()
Signature
1 public Integer getDateCreate ( )
Return Value
Type: Integer
getFile()
Signature
1 public Slack . File getFile ( )
Return Value
Type: Slack.File
getMessage()
Signature
1 public Slack . StarsListResponse . Message getMessage ( )
Return Value
Type: Slack.StarsListResponse.Message
getType()
Signature
Return Value
Type: String
setChannel(channel)
Signature
1 public void setChannel ( String channel )
Parameters
channel
Type: String
Return Value
Type: void
setComment(comment)
Signature
1 public void setComment ( Slack . StarsListResponse . Comment comment )
Parameters
comment
Type: Slack.StarsListResponse.Comment
Return Value
Type: void
setDateCreate(dateCreate)
Signature
1 public void setDateCreate ( Integer dateCreate )
Parameters
dateCreate
Type: Integer
Return Value
Type: void
setFile(file)
Signature
1 public void setFile ( Slack . File file )
Parameters
file
Type: Slack.File
Return Value
Type: void
setMessage(message)
Signature
1 public void setMessage ( Slack . StarsListResponse . Message message )
Parameters
message
Type: Slack.StarsListResponse.Message
Return Value
Type: void
setType(type)
Signature
1 public void setType ( String type )
Parameters
type
Type: String
Return Value
Type: void
StarsListResponse.Message Class
StarsListResponse.Message Methods
getBotId()
Signature
1 public String getBotId ( )
Return Value
Type: String
getBotProfile()
Signature
1 public Slack . BotProfile getBotProfile ( )
Return Value
Type: Slack.BotProfile
getClientMsgId()
Signature
1 public String getClientMsgId ( )
Return Value
Type: String
getDisplayAsBot()
Signature
1 public Boolean getDisplayAsBot ( )
Return Value
Type: Boolean
getEdited()
Signature
1 public Slack . StarsListResponse . Edited getEdited ( )
Return Value
Type: Slack.StarsListResponse.Edited
getInviter()
Signature
1 public String getInviter ( )
Return Value
Type: String
getFiles()
Signature
1 public List < Slack . File > getFiles ( )
Return Value
Type: List<Slack.File >
getLastRead()
Signature
1 public String getLastRead ( )
Return Value
Type: String
getLatestReply()
Signature
1 public String getLatestReply ( )
Return Value
Type: String
getPermalink()
Signature
1 public String getPermalink ( )
Return Value
Type: String
getReactions()
Signature
1 public List < Slack . Reaction > getReactions ( )
Return Value
Type: List<Slack.Reaction >
getReplyCount()
Signature
1 public Integer getReplyCount ( )
Return Value
Type: Integer
getReplyUsers()
Signature
1 public List < String > getReplyUsers ( )
Return Value
Type: List<String>
getReplyUsersCount()
Signature
1 public Integer getReplyUsersCount ( )
Return Value
Type: Integer
getSubtype()
Signature
1 public String getSubtype ( )
Return Value
Type: String
getTeam()
Signature
Return Value
Type: String
getText()
Signature
Return Value
Type: String
getThreadTs()
Signature
1 public String getThreadTs ( )
Return Value
Type: String
getTs()
Signature
Return Value
Type: String
getType()
Signature
Return Value
Type: String
getUpload()
Signature
1 public Boolean getUpload ( )
Return Value
Type: Boolean
getUser()
Signature
Return Value
Type: String
getUsername()
Signature
1 public String getUsername ( )
Return Value
Type: String
isLocked()
Signature
1 public Boolean isLocked ( )
Return Value
Type: Boolean
isSubscribed()
Signature
1 public Boolean isSubscribed ( )
Return Value
Type: Boolean
isStarred()
Signature
1 public Boolean isStarred ( )
Return Value
Type: Boolean
setBotId(botId)
Signature
1 public void setBotId ( String botId )
Parameters
botId
Type: String
Return Value
Type: void
setBotProfile(botProfile)
Signature
1 public void setBotProfile ( Slack . BotProfile botProfile )
Parameters
botProfile
Type: Slack.BotProfile
Return Value
Type: void
setClientMsgId(clientMsgId)
Signature
1 public void setClientMsgId ( String clientMsgId )
Parameters
clientMsgId
Type: String
Return Value
Type: void
setDisplayAsBot(displayAsBot)
Signature
1 public void setDisplayAsBot ( Boolean displayAsBot )
Parameters
displayAsBot
Type: Boolean
Return Value
Type: void
setEdited(edited)
Signature
1 public void setEdited ( Slack . StarsListResponse . Edited edited )
Parameters
edited
Type: Slack.StarsListResponse.Edited
Return Value
Type: void
setFiles(files)
Signature
1 public void setFiles ( List < Slack . File > files )
Parameters
files
Type: List<Slack.File >
Return Value
Type: void
setInviter(inviter)
Signature
1 public void setInviter ( String inviter )
Parameters
inviter
Type: String
Return Value
Type: void
setLastRead(lastRead)
Signature
1 public void setLastRead ( String lastRead )
Parameters
lastRead
Type: String
Return Value
Type: void
setLatestReply(latestReply)
Signature
1 public void setLatestReply ( String latestReply )
Parameters
latestReply
Type: String
Return Value
Type: void
setLocked(locked)
Signature
1 public void setLocked ( Boolean locked )
Parameters
locked
Type: Boolean
Return Value
Type: void
setPermalink(permalink)
Signature
1 public void setPermalink ( String permalink )
Parameters
permalink
Type: String
Return Value
Type: void
setReactions(reactions)
Signature
1 public void setReactions ( List < Slack . Reaction > reactions )
Parameters
reactions
Type: List<Slack.Reaction >
Return Value
Type: void
setReplyCount(replyCount)
Signature
1 public void setReplyCount ( Integer replyCount )
Parameters
replyCount
Type: Integer
Return Value
Type: void
setReplyUsers(replyUsers)
Signature
1 public void setReplyUsers ( List < String > replyUsers )
Parameters
replyUsers
Type: List<String>
Return Value
Type: void
setReplyUsersCount(replyUsersCount)
Signature
1 public void setReplyUsersCount ( Integer replyUsersCount )
Parameters
replyUsersCount
Type: Integer
Return Value
Type: void
setStarred(starred)
Signature
1 public void setStarred ( Boolean starred )
Parameters
starred
Type: Boolean
Return Value
Type: void
setSubscribed(subscribed)
Signature
1 public void setSubscribed ( Boolean subscribed )
Parameters
subscribed
Type: Boolean
Return Value
Type: void
setSubtype(subtype)
Signature
1 public void setSubtype ( String subtype )
Parameters
subtype
Type: String
Return Value
Type: void
setTeam(team)
Signature
1 public void setTeam ( String team )
Parameters
team
Type: String
Return Value
Type: void
setText(text)
Signature
1 public void setText ( String text )
Parameters
text
Type: String
Return Value
Type: void
setThreadTs(threadTs)
Signature
1 public void setThreadTs ( String threadTs )
Parameters
threadTs
Type: String
Return Value
Type: void
setTs(ts)
Signature
1 public void setTs ( String ts )
Parameters
ts
Type: String
Return Value
Type: void
setType(type)
Signature
1 public void setType ( String type )
Parameters
type
Type: String
Return Value
Type: void
setUpload(upload)
Signature
1 public void setUpload ( Boolean upload )
Parameters
upload
Type: Boolean
Return Value
Type: void
setUser(user)
Signature
1 public void setUser ( String user )
Parameters
user
Type: String
Return Value
Type: void
setUsername(username)
Signature
1 public void setUsername ( String username )
Parameters
username
Type: String
Return Value
Type: void
StarsListResponse.MessageRootReply Class
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
1 public void setTs ( String ts )
Parameters
ts
Type: String
Return Value
Type: void
setUser(user)
Signature
1 public void setUser ( String user )
Parameters
user
Type: String
Return Value
Type: void
StarsRemoveRequest Class
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
1 static Slack . StarsRemoveRequest . Builder builder ( )
Return Value
Type: Slack.StarsRemoveRequest.Builder
StarsRemoveRequest.Builder Class
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
1 Slack . StarsRemoveRequest build ( )
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
1 Slack . StarsRemoveRequest . Builder channel ( String channel )
Parameters
channel
Type: String
Return Value
Type: Slack.StarsRemoveRequest.Builder
file(file)
The file comment to remove the star from.
Signature
1 Slack . StarsRemoveRequest . Builder file ( String file )
Parameters
file
Type: String
Return Value
Type: Slack.StarsRemoveRequest.Builder
fileComment(fileComment)
Signature
1 Slack . StarsRemoveRequest . Builder fileComment ( String fileComment )
Parameters
fileComment
Type: String
Return Value
Type: Slack.StarsRemoveRequest.Builder
timestamp(timestamp)
The timestamp of the message to remove the star from.
Signature
1 Slack . StarsRemoveRequest . Builder timestamp ( String timestamp )
Parameters
timestamp
Type: String
Return Value
Type: Slack.StarsRemoveRequest.Builder
StarsRemoveResponse Class
Removes a saved item (star) from an item.
Usage
See Slack’s stars.remove method .
StarsRemoveResponse Methods
This class contains standard response methods .
This feature is not generally available. It is not part of your purchased Services. This feature is subject to change, may be discontinued with no notice at any time in SFDC’s sole discretion, and SFDC may never make this feature generally available. Make your purchase decisions only on the basis of generally available products and features. This feature is made available on an AS IS basis and use of this feature is at your sole risk.