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.
The following are methods for StarsAddRequest.
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.
The following are methods for StarsAddRequest.Builder. These methods are optional unless specified otherwise.
Required. Returns an instance of Slack.StarsAddRequest.
Signature
Return Value
Type: Slack.StarsAddRequest
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
The file to add a star to.
Signature
Parameters
file
Type: String
Type: Slack.StarsAddRequest.Builder
The file comment to add a star to.
Signature
Parameters
fileComment
Type: String
Return Value
Type: Slack.StarsAddRequest.Builder
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.
This class contains standard response methods.
Sends a request to list a user's saved items.
The following are methods for StarsListRequest.
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.
The following are methods for StarsListRequest.Builder. These methods are optional unless specified otherwise.
Required. Builds an instance of Slack.StarsListRequest.
Signature
Return Value
Type: Slack.StarsListRequest
Signature
Parameters
count
Type: Integer
Return Value
Type: Slack.StarsListRequest.Builder
Signature
Parameters
cursor
Type: String
Return Value
Type: Slack.StarsListRequest.Builder
Signature
Parameters
limitValue
Type: Integer
Return Value
Type: Slack.StarsListRequest.Builder
Signature
Parameters
page
Type: Integer
Return Value
Type: Slack.StarsListRequest.Builder
Signature
Parameters
teamId
Type: String
Return Value
Type: Slack.StarsListRequest.Builder
List a user's saved items.
This class contains standard response methods.
The following are methods for StarsListResponse.
Signature
Return Value
Type: List<Slack.StarsListResponse.Item>
Signature
Return Value
Type: Slack.Paging
Signature
Parameters
items
Type: List<Slack.StarsListResponse.Item>
Return Value
Type: void
Signature
Parameters
paging
Type: Slack.Paging
Return Value
Type: void
The following are methods for StarsListResponse.Comment.
Signature
Return Value
Type: String
Signature
Return Value
Type: Integer
Signature
Return Value
Type: String
Signature
Return Value
Type: Integer
Signature
Return Value
Type: Integer
Signature
Return Value
Type: String
Signature
Return Value
Type: Boolean
Signature
Return Value
Type: Boolean
Signature
Parameters
comment
Type: String
Return Value
Type: void
Signature
Parameters
created
Type: Integer
Return Value
Type: void
Signature
Parameters
id
Type: String
Return Value
Type: void
Signature
Parameters
intro
Type: Boolean
Return Value
Type: void
Signature
Parameters
numStars
Type: Integer
Return Value
Type: void
Signature
Parameters
starred
Type: Boolean
Return Value
Type: void
Signature
Parameters
timestamp
Type: Integer
Return Value
Type: void
Signature
Parameters
user
Type: String
Return Value
Type: void
The following are methods for StarsListResponse.Edited.
Signature
Return Value
Type: String
Signature
Return Value
Type: String
Signature
Parameters
ts
Type: String
Return Value
Type: void
Signature
Parameters
user
Type: String
Return Value
Type: void
Return Value
Type: void
The following are methods for StarsListResponse.Item.
Signature
Return Value
Type: String
Signature
Return Value
Type: Slack.StarsListResponse.Comment
Signature
Return Value
Type: Integer
Signature
Return Value
Type: Slack.File
Signature
Return Value
Type: Slack.StarsListResponse.Message
Signature
Return Value
Type: String
Signature
Parameters
channel
Type: String
Return Value
Type: void
Signature
Parameters
comment
Type: Slack.StarsListResponse.Comment
Return Value
Type: void
Signature
Parameters
dateCreate
Type: Integer
Return Value
Type: void
Signature
Parameters
file
Type: Slack.File
Return Value
Type: void
Signature
Parameters
message
Type: Slack.StarsListResponse.Message
Return Value
Type: void
Signature
Parameters
type
Type: String
Return Value
Type: void
Signature
Return Value
Type: String
Signature
Return Value
Type: Slack.BotProfile
Signature
Return Value
Type: String
Signature
Return Value
Type: Boolean
Signature
Return Value
Type: Slack.StarsListResponse.Edited
Signature
Return Value
Type: String
Signature
Return Value
Type: List<Slack.File>
Signature
Return Value
Type: String
Signature
Return Value
Type: String
Signature
Return Value
Type: String
Signature
Return Value
Type: List<Slack.Reaction>
Signature
Return Value
Type: Integer
Signature
Return Value
Type: List<String>
Signature
Return Value
Type: Integer
Signature
Return Value
Type: String
Signature
Return Value
Type: String
Signature
Return Value
Type: String
Signature
Return Value
Type: String
Signature
Return Value
Type: String
Signature
Return Value
Type: String
Signature
Return Value
Type: Boolean
Signature
Return Value
Type: String
Signature
Return Value
Type: String
Signature
Return Value
Type: Boolean
Signature
Return Value
Type: Boolean
Signature
Return Value
Type: Boolean
Signature
Parameters
botId
Type: String
Return Value
Type: void
Signature
Parameters
botProfile
Type: Slack.BotProfile
Return Value
Type: void
Signature
Parameters
clientMsgId
Type: String
Return Value
Type: void
Signature
Parameters
displayAsBot
Type: Boolean
Return Value
Type: void
Signature
Parameters
edited
Type: Slack.StarsListResponse.Edited
Return Value
Type: void
Signature
Parameters
files
Type: List<Slack.File>
Return Value
Type: void
Signature
Parameters
inviter
Type: String
Return Value
Type: void
Signature
Parameters
lastRead
Type: String
Return Value
Type: void
Signature
Parameters
latestReply
Type: String
Return Value
Type: void
Signature
Parameters
locked
Type: Boolean
Return Value
Type: void
Signature
Parameters
permalink
Type: String
Return Value
Type: void
Signature
Parameters
reactions
Type: List<Slack.Reaction>
Return Value
Type: void
Signature
Parameters
replyCount
Type: Integer
Return Value
Type: void
Signature
Parameters
replyUsers
Type: List<String>
Return Value
Type: void
Signature
Parameters
replyUsersCount
Type: Integer
Return Value
Type: void
Signature
Parameters
starred
Type: Boolean
Return Value
Type: void
Signature
Parameters
subscribed
Type: Boolean
Return Value
Type: void
Signature
Parameters
subtype
Type: String
Return Value
Type: void
Signature
Parameters
team
Type: String
Return Value
Type: void
Signature
Parameters
text
Type: String
Return Value
Type: void
Signature
Parameters
threadTs
Type: String
Return Value
Type: void
Signature
Parameters
ts
Type: String
Return Value
Type: void
Signature
Parameters
type
Type: String
Return Value
Type: void
Signature
Parameters
upload
Type: Boolean
Return Value
Type: void
Signature
Parameters
user
Type: String
Return Value
Type: void
Signature
Parameters
username
Type: String
Return Value
Type: void
The following are methods for StarsListResponse.MessageRootReply.
Signature
Return Value
Type: String
Signature
Return Value
Type: String
Signature
Parameters
ts
Type: String
Return Value
Type: void
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.
The following are methods for StarsRemoveRequest.
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.
The following are methods for StarsRemoveRequest.Builder. These methods are optional unless specified otherwise.
Required. Returns an instance of the Slack.StarsRemoveRequest object.
Signature
Return Value
Type: Slack.StarsRemoveRequest
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
The file comment to remove the star from.
Signature
Parameters
file
Type: String
Return Value
Type: Slack.StarsRemoveRequest.Builder
Signature
Parameters
fileComment
Type: String
Return Value
Type: Slack.StarsRemoveRequest.Builder
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.
This class contains standard response methods.