--- schema_version: "1" id: ef00e532f29fc29e2d8003d6aff29c095afff1c05451111ef48b213987c4b419 title: Work with Stars collection: developer version: current locale: en-us portal_url: https://docs.salesforce.com/developer/current/en-us/salesforce-slack-sdk/apex-slack-sdk/guides/apex_ref/apex_ref_stars.md canonical_url: https://developer.salesforce.com/docs/platform/salesforce-slack-sdk/guide/apex_ref_stars.html source_site: developer.salesforce.com content_type: documentation content_hash: e9c3fc29584ffe74108d32d5dd91292bf8bff3241e9c9a916788786b15a66330 products: - Apex SDK for Slack (Beta) --- # Work with Stars The following are Apex classes for the Slack `stars` [API methods](https://api.slack.com/methods?filter=stars). ## StarsAddRequest Class Sends a request to save an item for later. **Usage** See Slack’s [stars.add method](https://api.slack.com/methods/stars.add). ### StarsAddRequest Methods The following are methods for `StarsAddRequest`. #### builder() Builds a request object that's used when executing the API call. **Signature** ```java 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** ```java 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** ```java 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** ```java 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** ```java 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** ```java 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](https://api.slack.com/methods/stars.add). ### StarsAddResponse Methods This class contains [standard response methods](https://developer.salesforce.com/docs/platform/salesforce-slack-sdk/guide/apex_ref_response.md). ## 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** ```java 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** ```java public Slack.StarsListRequest build() ``` **Return Value** Type: Slack.StarsListRequest #### count(count) **Signature** ```java public Slack.StarsListRequest.Builder count(Integer count) ``` **Parameters** _count_ Type: Integer **Return Value** Type: Slack.StarsListRequest.Builder #### cursor(cursor) **Signature** ```java public Slack.StarsListRequest.Builder cursor(String cursor) ``` **Parameters** _cursor_ Type: String **Return Value** Type: [Slack.StarsListRequest.Builder](#starslistrequestbuilder-class) #### limitValue(limitValue) **Signature** ```java public Slack.StarsListRequest.Builder limitValue(Integer limitValue) ``` **Parameters** _limitValue_ Type: Integer **Return Value** Type: [Slack.StarsListRequest.Builder](#starslistrequestbuilder-class) #### page(page) **Signature** ```java public Slack.StarsListRequest.Builder page(Integer page) ``` **Parameters** _page_ Type: Integer **Return Value** Type: Slack.StarsListRequest.Builder #### teamId(teamId) **Signature** ```java public Slack.StarsListRequest.Builder teamId(String teamId) ``` **Parameters** _teamId_ Type: String **Return Value** Type: [Slack.StarsListRequest.Builder](#starslistrequestbuilder-class) ## StarsListResponse Class List a user's saved items. ### StarsListResponse Methods This class contains [standard response methods](https://developer.salesforce.com/docs/platform/salesforce-slack-sdk/guide/apex_ref_response.md). The following are methods for `StarsListResponse`. #### getItems() **Signature** ```java public List getItems() ``` **Return Value** Type: List #### getPaging() **Signature** ```java public Slack.Paging getPaging() ``` **Return Value** Type: [Slack.Paging](https://developer.salesforce.com/docs/platform/salesforce-slack-sdk/guide/apex_ref_paging.md) #### setItems(items) **Signature** ```java public void setItems(List items) ``` **Parameters** _items_ Type: List **Return Value** Type: void #### setPaging(paging) **Signature** ```java public void setPaging(Slack.Paging paging) ``` **Parameters** _paging_ Type: [Slack.Paging](https://developer.salesforce.com/docs/platform/salesforce-slack-sdk/guide/apex_ref_paging.md) **Return Value** Type: void ## StarsListResponse.Comment Class ### StarsListResponse.Comment Methods The following are methods for `StarsListResponse.Comment`. #### getComment() **Signature** ```java public String getComment() ``` **Return Value** Type: String #### getCreated() **Signature** ```java public Integer getCreated() ``` **Return Value** Type: Integer #### getId() **Signature** ```java public String getId() ``` **Return Value** Type: String #### getNumStars() **Signature** ```java public Integer getNumStars() ``` **Return Value** Type: Integer #### getTimestamp() **Signature** ```java public Integer getTimestamp() ``` **Return Value** Type: Integer #### getUser() **Signature** ```java public String getUser() ``` **Return Value** Type: String #### isIntro() **Signature** ```java public Boolean isIntro() ``` **Return Value** Type: Boolean #### isStarred() **Signature** ```java public Boolean isStarred() ``` **Return Value** Type: Boolean #### setComment(comment) **Signature** ```java public void setComment(String comment) ``` **Parameters** _comment_ Type: String **Return Value** Type: void #### setCreated(created) **Signature** ```java public void setCreated(Integer created) ``` **Parameters** _created_ Type: Integer **Return Value** Type: void #### setId(id) **Signature** ```java public void setId(String id) ``` **Parameters** _id_ Type: String **Return Value** Type: void #### setIntro(intro) **Signature** ```java public void setIntro(Boolean intro) ``` **Parameters** _intro_ Type: Boolean **Return Value** Type: void #### setNumStars(numStars) **Signature** ```java public void setNumStars(Integer numStars) ``` **Parameters** _numStars_ Type: Integer **Return Value** Type: void #### setStarred(starred) **Signature** ```java public void setStarred(Boolean starred) ``` **Parameters** _starred_ Type: Boolean **Return Value** Type: void #### setTimestamp(timestamp) **Signature** ```java public void setTimestamp(Integer timestamp) ``` **Parameters** _timestamp_ Type: Integer **Return Value** Type: void #### setUser(user) **Signature** ```java 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** ```java public String getTs() ``` **Return Value** Type: String #### getUser() **Signature** ```java public String getUser() ``` **Return Value** Type: String #### setTs(ts) **Signature** ```java public void setTs(String ts) ``` **Parameters** _ts_ Type: String **Return Value** Type: void #### setUser(user) **Signature** ```java 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** ```java public String getChannel() ``` **Return Value** Type: String #### getComment() **Signature** ```java public Slack.StarsListResponse.Comment getComment() ``` **Return Value** Type: Slack.StarsListResponse.Comment #### getDateCreate() **Signature** ```java public Integer getDateCreate() ``` **Return Value** Type: Integer #### getFile() **Signature** ```java public Slack.File getFile() ``` **Return Value** Type: [Slack.File](https://developer.salesforce.com/docs/platform/salesforce-slack-sdk/guide/apex_ref_files.md) #### getMessage() **Signature** ```java public Slack.StarsListResponse.Message getMessage() ``` **Return Value** Type: Slack.StarsListResponse.Message #### getType() **Signature** ```java public String getType() ``` **Return Value** Type: String #### setChannel(channel) **Signature** ```java public void setChannel(String channel) ``` **Parameters** _channel_ Type: String **Return Value** Type: void #### setComment(comment) **Signature** ```java public void setComment(Slack.StarsListResponse.Comment comment) ``` **Parameters** _comment_ Type: Slack.StarsListResponse.Comment **Return Value** Type: void #### setDateCreate(dateCreate) **Signature** ```java public void setDateCreate(Integer dateCreate) ``` **Parameters** _dateCreate_ Type: Integer **Return Value** Type: void #### setFile(file) **Signature** ```java public void setFile(Slack.File file) ``` **Parameters** _file_ Type: [Slack.File](https://developer.salesforce.com/docs/platform/salesforce-slack-sdk/guide/apex_ref_files.md) **Return Value** Type: void #### setMessage(message) **Signature** ```java public void setMessage(Slack.StarsListResponse.Message message) ``` **Parameters** _message_ Type: Slack.StarsListResponse.Message **Return Value** Type: void #### setType(type) **Signature** ```java public void setType(String type) ``` **Parameters** _type_ Type: String **Return Value** Type: void ## StarsListResponse.Message Class ### StarsListResponse.Message Methods #### getBotId() **Signature** ```java public String getBotId() ``` **Return Value** Type: String #### getBotProfile() **Signature** ```java public Slack.BotProfile getBotProfile() ``` **Return Value** Type: [Slack.BotProfile](https://developer.salesforce.com/docs/platform/salesforce-slack-sdk/guide/apex_ref_bot.md#botprofile-class) #### getClientMsgId() **Signature** ```java public String getClientMsgId() ``` **Return Value** Type: String #### getDisplayAsBot() **Signature** ```java public Boolean getDisplayAsBot() ``` **Return Value** Type: Boolean #### getEdited() **Signature** ```java public Slack.StarsListResponse.Edited getEdited() ``` **Return Value** Type: Slack.StarsListResponse.Edited #### getInviter() **Signature** ```java public String getInviter() ``` **Return Value** Type: String #### getFiles() **Signature** ```java public List getFiles() ``` **Return Value** Type: List<[Slack.File](https://developer.salesforce.com/docs/platform/salesforce-slack-sdk/guide/apex_ref_files.md)> #### getLastRead() **Signature** ```java public String getLastRead() ``` **Return Value** Type: String #### getLatestReply() **Signature** ```java public String getLatestReply() ``` **Return Value** Type: String #### getPermalink() **Signature** ```java public String getPermalink() ``` **Return Value** Type: String #### getReactions() **Signature** ```java public List getReactions() ``` **Return Value** Type: List<[Slack.Reaction](https://developer.salesforce.com/docs/platform/salesforce-slack-sdk/guide/apex_ref_reactions.md)> #### getReplyCount() **Signature** ```java public Integer getReplyCount() ``` **Return Value** Type: Integer #### getReplyUsers() **Signature** ```java public List getReplyUsers() ``` **Return Value** Type: List\ #### getReplyUsersCount() **Signature** ```java public Integer getReplyUsersCount() ``` **Return Value** Type: Integer #### getSubtype() **Signature** ```java public String getSubtype() ``` **Return Value** Type: String #### getTeam() **Signature** ```java public String getTeam() ``` **Return Value** Type: String #### getText() **Signature** ```java public String getText() ``` **Return Value** Type: String #### getThreadTs() **Signature** ```java public String getThreadTs() ``` **Return Value** Type: String #### getTs() **Signature** ```java public String getTs() ``` **Return Value** Type: String #### getType() **Signature** ```java public String getType() ``` **Return Value** Type: String #### getUpload() **Signature** ```java public Boolean getUpload() ``` **Return Value** Type: Boolean #### getUser() **Signature** ```java public String getUser() ``` **Return Value** Type: String #### getUsername() **Signature** ```java public String getUsername() ``` **Return Value** Type: String #### isLocked() **Signature** ```java public Boolean isLocked() ``` **Return Value** Type: Boolean #### isSubscribed() **Signature** ```java public Boolean isSubscribed() ``` **Return Value** Type: Boolean #### isStarred() **Signature** ```java public Boolean isStarred() ``` **Return Value** Type: Boolean #### setBotId(botId) **Signature** ```java public void setBotId(String botId) ``` **Parameters** _botId_ Type: String **Return Value** Type: void #### setBotProfile(botProfile) **Signature** ```java public void setBotProfile(Slack.BotProfile botProfile) ``` **Parameters** _botProfile_ Type: [Slack.BotProfile](https://developer.salesforce.com/docs/platform/salesforce-slack-sdk/guide/apex_ref_bot.md#botprofile-class) **Return Value** Type: void #### setClientMsgId(clientMsgId) **Signature** ```java public void setClientMsgId(String clientMsgId) ``` **Parameters** _clientMsgId_ Type: String **Return Value** Type: void #### setDisplayAsBot(displayAsBot) **Signature** ```java public void setDisplayAsBot(Boolean displayAsBot) ``` **Parameters** _displayAsBot_ Type: Boolean **Return Value** Type: void #### setEdited(edited) **Signature** ```java public void setEdited(Slack.StarsListResponse.Edited edited) ``` **Parameters** _edited_ Type: Slack.StarsListResponse.Edited **Return Value** Type: void #### setFiles(files) **Signature** ```java public void setFiles(List files) ``` **Parameters** _files_ Type: List<[Slack.File](https://developer.salesforce.com/docs/platform/salesforce-slack-sdk/guide/apex_ref_files.md)> **Return Value** Type: void #### setInviter(inviter) **Signature** ```java public void setInviter(String inviter) ``` **Parameters** _inviter_ Type: String **Return Value** Type: void #### setLastRead(lastRead) **Signature** ```java public void setLastRead(String lastRead) ``` **Parameters** _lastRead_ Type: String **Return Value** Type: void #### setLatestReply(latestReply) **Signature** ```java public void setLatestReply(String latestReply) ``` **Parameters** _latestReply_ Type: String **Return Value** Type: void #### setLocked(locked) **Signature** ```java public void setLocked(Boolean locked) ``` **Parameters** _locked_ Type: Boolean **Return Value** Type: void #### setPermalink(permalink) **Signature** ```java public void setPermalink(String permalink) ``` **Parameters** _permalink_ Type: String **Return Value** Type: void #### setReactions(reactions) **Signature** ```java public void setReactions(List reactions) ``` **Parameters** _reactions_ Type: List<[Slack.Reaction](https://developer.salesforce.com/docs/platform/salesforce-slack-sdk/guide/apex_ref_reactions.md)> **Return Value** Type: void #### setReplyCount(replyCount) **Signature** ```java public void setReplyCount(Integer replyCount) ``` **Parameters** _replyCount_ Type: Integer **Return Value** Type: void #### setReplyUsers(replyUsers) **Signature** ```java public void setReplyUsers(List replyUsers) ``` **Parameters** _replyUsers_ Type: List\ **Return Value** Type: void #### setReplyUsersCount(replyUsersCount) **Signature** ```java public void setReplyUsersCount(Integer replyUsersCount) ``` **Parameters** _replyUsersCount_ Type: Integer **Return Value** Type: void #### setStarred(starred) **Signature** ```java public void setStarred(Boolean starred) ``` **Parameters** _starred_ Type: Boolean **Return Value** Type: void #### setSubscribed(subscribed) **Signature** ```java public void setSubscribed(Boolean subscribed) ``` **Parameters** _subscribed_ Type: Boolean **Return Value** Type: void #### setSubtype(subtype) **Signature** ```java public void setSubtype(String subtype) ``` **Parameters** _subtype_ Type: String **Return Value** Type: void #### setTeam(team) **Signature** ```java public void setTeam(String team) ``` **Parameters** _team_ Type: String **Return Value** Type: void #### setText(text) **Signature** ```java public void setText(String text) ``` **Parameters** _text_ Type: String **Return Value** Type: void #### setThreadTs(threadTs) **Signature** ```java public void setThreadTs(String threadTs) ``` **Parameters** _threadTs_ Type: String **Return Value** Type: void #### setTs(ts) **Signature** ```java public void setTs(String ts) ``` **Parameters** _ts_ Type: String **Return Value** Type: void #### setType(type) **Signature** ```java public void setType(String type) ``` **Parameters** _type_ Type: String **Return Value** Type: void #### setUpload(upload) **Signature** ```java public void setUpload(Boolean upload) ``` **Parameters** _upload_ Type: Boolean **Return Value** Type: void #### setUser(user) **Signature** ```java public void setUser(String user) ``` **Parameters** _user_ Type: String **Return Value** Type: void #### setUsername(username) **Signature** ```java 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** ```java public String getTs() ``` **Return Value** Type: String #### getUser() **Signature** ```java public String getUser() ``` **Return Value** Type: String #### setTs(ts) **Signature** ```java public void setTs(String ts) ``` **Parameters** _ts_ Type: String **Return Value** Type: void #### setUser(user) **Signature** ```java 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](https://api.slack.com/methods/stars.remove). ### StarsRemoveRequest Methods The following are methods for `StarsRemoveRequest`. #### builder() Builds a request object that's used when executing the API call. **Signature** ```java 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** ```java 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** ```java 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** ```java Slack.StarsRemoveRequest.Builder file(String file) ``` **Parameters** _file_ Type: String **Return Value** Type: Slack.StarsRemoveRequest.Builder #### fileComment(fileComment) **Signature** ```java 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** ```java 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](https://api.slack.com/methods/stars.remove). ### StarsRemoveResponse Methods This class contains [standard response methods](https://developer.salesforce.com/docs/platform/salesforce-slack-sdk/guide/apex_ref_response.md).