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

 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

 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

 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

 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

 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

 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

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

public Slack.StarsListRequest build()

Return Value

Type: Slack.StarsListRequest

count(count)

Signature

public Slack.StarsListRequest.Builder count(Integer count)

Parameters

count

Type: Integer

Return Value

Type: Slack.StarsListRequest.Builder

cursor(cursor)

Signature

public Slack.StarsListRequest.Builder cursor(String cursor)

Parameters

cursor

Type: String

Return Value

Type: Slack.StarsListRequest.Builder

limitValue(limitValue)

Signature

public Slack.StarsListRequest.Builder limitValue(Integer limitValue)

Parameters

limitValue

Type: Integer

Return Value

Type: Slack.StarsListRequest.Builder

page(page)

Signature

public Slack.StarsListRequest.Builder page(Integer page)

Parameters

page

Type: Integer

Return Value

Type: Slack.StarsListRequest.Builder

teamId(teamId)

Signature

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

public List<Slack.StarsListResponse.Item> getItems()

Return Value

Type: List<Slack.StarsListResponse.Item>

getPaging()

Signature

public Slack.Paging getPaging()

Return Value

Type: Slack.Paging

setItems(items)

Signature

public void setItems(List<Slack.StarsListResponse.Item> items)

Parameters

items

Type: List<Slack.StarsListResponse.Item>

Return Value

Type: void

setPaging(paging)

Signature

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

public String getComment()

Return Value

Type: String

getCreated()

Signature

public Integer getCreated()

Return Value

Type: Integer

getId()

Signature

public String getId()

Return Value

Type: String

getNumStars()

Signature

public Integer getNumStars()

Return Value

Type: Integer

getTimestamp()

Signature

public Integer getTimestamp()

Return Value

Type: Integer

getUser()

Signature

public String getUser()

Return Value

Type: String

isIntro()

Signature

public Boolean isIntro()

Return Value

Type: Boolean

isStarred()

Signature

public Boolean isStarred()

Return Value

Type: Boolean

setComment(comment)

Signature

public void setComment(String comment)

Parameters

comment

Type: String

Return Value

Type: void

setCreated(created)

Signature

public void setCreated(Integer created)

Parameters

created

Type: Integer

Return Value

Type: void

setId(id)

Signature

public void setId(String id)

Parameters

id

Type: String

Return Value

Type: void

setIntro(intro)

Signature

public void setIntro(Boolean intro)

Parameters

intro

Type: Boolean

Return Value

Type: void

setNumStars(numStars)

Signature

public void setNumStars(Integer numStars)

Parameters

numStars

Type: Integer

Return Value

Type: void

setStarred(starred)

Signature

public void setStarred(Boolean starred)

Parameters

starred

Type: Boolean

Return Value

Type: void

setTimestamp(timestamp)

Signature

public void setTimestamp(Integer timestamp)

Parameters

timestamp

Type: Integer

Return Value

Type: void

setUser(user)

Signature

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

public String getTs()

Return Value

Type: String

getUser()

Signature

public String getUser()

Return Value

Type: String

setTs(ts)

Signature

public void setTs(String ts)

Parameters

ts

Type: String

Return Value

Type: void

setUser(user)

Signature

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

public String getChannel()

Return Value

Type: String

getComment()

Signature

public Slack.StarsListResponse.Comment getComment()

Return Value

Type: Slack.StarsListResponse.Comment

getDateCreate()

Signature

public Integer getDateCreate()

Return Value

Type: Integer

getFile()

Signature

public Slack.File getFile()

Return Value

Type: Slack.File

getMessage()

Signature

public Slack.StarsListResponse.Message getMessage()

Return Value

Type: Slack.StarsListResponse.Message

getType()

Signature

public String getType()

Return Value

Type: String

setChannel(channel)

Signature

public void setChannel(String channel)

Parameters

channel

Type: String

Return Value

Type: void

setComment(comment)

Signature

public void setComment(Slack.StarsListResponse.Comment comment)

Parameters

comment

Type: Slack.StarsListResponse.Comment

Return Value

Type: void

setDateCreate(dateCreate)

Signature

public void setDateCreate(Integer dateCreate)

Parameters

dateCreate

Type: Integer

Return Value

Type: void

setFile(file)

Signature

public void setFile(Slack.File file)

Parameters

file

Type: Slack.File

Return Value

Type: void

setMessage(message)

Signature

public void setMessage(Slack.StarsListResponse.Message message)

Parameters

message

Type: Slack.StarsListResponse.Message

Return Value

Type: void

setType(type)

Signature

public void setType(String type)

Parameters

type

Type: String

Return Value

Type: void

StarsListResponse.Message Class

StarsListResponse.Message Methods

getBotId()

Signature

public String getBotId()

Return Value

Type: String

getBotProfile()

Signature

public Slack.BotProfile getBotProfile()

Return Value

Type: Slack.BotProfile

getClientMsgId()

Signature

public String getClientMsgId()

Return Value

Type: String

getDisplayAsBot()

Signature

public Boolean getDisplayAsBot()

Return Value

Type: Boolean

getEdited()

Signature

public Slack.StarsListResponse.Edited getEdited()

Return Value

Type: Slack.StarsListResponse.Edited

getInviter()

Signature

public String getInviter()

Return Value

Type: String

getFiles()

Signature

public List<Slack.File> getFiles()

Return Value

Type: List<Slack.File>

getLastRead()

Signature

public String getLastRead()

Return Value

Type: String

getLatestReply()

Signature

public String getLatestReply()

Return Value

Type: String

getPermalink()

Signature

public String getPermalink()

Return Value

Type: String

getReactions()

Signature

public List<Slack.Reaction> getReactions()

Return Value

Type: List<Slack.Reaction>

getReplyCount()

Signature

public Integer getReplyCount()

Return Value

Type: Integer

getReplyUsers()

Signature

public List<String> getReplyUsers()

Return Value

Type: List<String>

getReplyUsersCount()

Signature

public Integer getReplyUsersCount()

Return Value

Type: Integer

getSubtype()

Signature

public String getSubtype()

Return Value

Type: String

getTeam()

Signature

public String getTeam()

Return Value

Type: String

getText()

Signature

public String getText()

Return Value

Type: String

getThreadTs()

Signature

public String getThreadTs()

Return Value

Type: String

getTs()

Signature

public String getTs()

Return Value

Type: String

getType()

Signature

public String getType()

Return Value

Type: String

getUpload()

Signature

public Boolean getUpload()

Return Value

Type: Boolean

getUser()

Signature

public String getUser()

Return Value

Type: String

getUsername()

Signature

public String getUsername()

Return Value

Type: String

isLocked()

Signature

public Boolean isLocked()

Return Value

Type: Boolean

isSubscribed()

Signature

public Boolean isSubscribed()

Return Value

Type: Boolean

isStarred()

Signature

public Boolean isStarred()

Return Value

Type: Boolean

setBotId(botId)

Signature

public void setBotId(String botId)

Parameters

botId

Type: String

Return Value

Type: void

setBotProfile(botProfile)

Signature

public void setBotProfile(Slack.BotProfile botProfile)

Parameters

botProfile

Type: Slack.BotProfile

Return Value

Type: void

setClientMsgId(clientMsgId)

Signature

public void setClientMsgId(String clientMsgId)

Parameters

clientMsgId

Type: String

Return Value

Type: void

setDisplayAsBot(displayAsBot)

Signature

public void setDisplayAsBot(Boolean displayAsBot)

Parameters

displayAsBot

Type: Boolean

Return Value

Type: void

setEdited(edited)

Signature

public void setEdited(Slack.StarsListResponse.Edited edited)

Parameters

edited

Type: Slack.StarsListResponse.Edited

Return Value

Type: void

setFiles(files)

Signature

public void setFiles(List<Slack.File> files)

Parameters

files

Type: List<Slack.File>

Return Value

Type: void

setInviter(inviter)

Signature

public void setInviter(String inviter)

Parameters

inviter

Type: String

Return Value

Type: void

setLastRead(lastRead)

Signature

public void setLastRead(String lastRead)

Parameters

lastRead

Type: String

Return Value

Type: void

setLatestReply(latestReply)

Signature

public void setLatestReply(String latestReply)

Parameters

latestReply

Type: String

Return Value

Type: void

setLocked(locked)

Signature

public void setLocked(Boolean locked)

Parameters

locked

Type: Boolean

Return Value

Type: void

setPermalink(permalink)

Signature

public void setPermalink(String permalink)

Parameters

permalink

Type: String

Return Value

Type: void

setReactions(reactions)

Signature

public void setReactions(List<Slack.Reaction> reactions)

Parameters

reactions

Type: List<Slack.Reaction>

Return Value

Type: void

setReplyCount(replyCount)

Signature

public void setReplyCount(Integer replyCount)

Parameters

replyCount

Type: Integer

Return Value

Type: void

setReplyUsers(replyUsers)

Signature

public void setReplyUsers(List<String> replyUsers)

Parameters

replyUsers

Type: List<String>

Return Value

Type: void

setReplyUsersCount(replyUsersCount)

Signature

public void setReplyUsersCount(Integer replyUsersCount)

Parameters

replyUsersCount

Type: Integer

Return Value

Type: void

setStarred(starred)

Signature

public void setStarred(Boolean starred)

Parameters

starred

Type: Boolean

Return Value

Type: void

setSubscribed(subscribed)

Signature

public void setSubscribed(Boolean subscribed)

Parameters

subscribed

Type: Boolean

Return Value

Type: void

setSubtype(subtype)

Signature

public void setSubtype(String subtype)

Parameters

subtype

Type: String

Return Value

Type: void

setTeam(team)

Signature

public void setTeam(String team)

Parameters

team

Type: String

Return Value

Type: void

setText(text)

Signature

public void setText(String text)

Parameters

text

Type: String

Return Value

Type: void

setThreadTs(threadTs)

Signature

public void setThreadTs(String threadTs)

Parameters

threadTs

Type: String

Return Value

Type: void

setTs(ts)

Signature

public void setTs(String ts)

Parameters

ts

Type: String

Return Value

Type: void

setType(type)

Signature

public void setType(String type)

Parameters

type

Type: String

Return Value

Type: void

setUpload(upload)

Signature

public void setUpload(Boolean upload)

Parameters

upload

Type: Boolean

Return Value

Type: void

setUser(user)

Signature

public void setUser(String user)

Parameters

user

Type: String

Return Value

Type: void

setUsername(username)

Signature

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

public String getTs()

Return Value

Type: String

getUser()

Signature

public String getUser()

Return Value

Type: String

setTs(ts)

Signature

public void setTs(String ts)

Parameters

ts

Type: String

Return Value

Type: void

setUser(user)

Signature

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

 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

 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

 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

 Slack.StarsRemoveRequest.Builder file(String file)

Parameters

file

Type: String

Return Value

Type: Slack.StarsRemoveRequest.Builder

fileComment(fileComment)

Signature

 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

 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.