Module: Slack::Endpoint::Stars

Included in:
Slack::Endpoint
Defined in:
lib/slack/endpoint/stars.rb

Instance Method Summary collapse

Instance Method Details

#stars_add(options = {}) ⇒ Object

Adds a star to an item.

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :channel (Object) —

    Channel to add star to, or channel where the message to add star to was posted (used with timestamp).

  • :file (Object) —

    File to add star to.

  • :file_comment (Object) —

    File comment to add star to.

  • :timestamp (Object) —

    Timestamp of the message to add star to.

See Also:



20
21
22
 
# File 'lib/slack/endpoint/stars.rb', line 20

def stars_add(options={})
  post("stars.add", options)
end

#stars_list(options = {}) ⇒ Object

Lists stars for a user.

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :count (Object) —

    Number of items to return per page.

  • :page (Object) —

    Page number of results to return.

See Also:



34
35
36
 
# File 'lib/slack/endpoint/stars.rb', line 34

def stars_list(options={})
  post("stars.list", options)
end

#stars_remove(options = {}) ⇒ Object

Removes a star from an item.

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :channel (Object) —

    Channel to remove star from, or channel where the message to remove star from was posted (used with timestamp).

  • :file (Object) —

    File to remove star from.

  • :file_comment (Object) —

    File comment to remove star from.

  • :timestamp (Object) —

    Timestamp of the message to remove star from.

See Also:



52
53
54
 
# File 'lib/slack/endpoint/stars.rb', line 52

def stars_remove(options={})
  post("stars.remove", options)
end