StarsFacet

Kind: global class

• StarsFacet
  • .add([opts], [optCb])
  • .list([opts], [optCb])
  • .remove([opts], [optCb])

starsFacet.add([opts], [optCb])

Adds a star to an item.

Kind: instance method of [StarsFacet](#StarsFacet)
See: stars.add

Param	Type	Description
[opts]	Object
opts.file	?	File to add star to.
opts.file_comment	?	File comment to add star to.
opts.channel	?	Channel to add star to, or channel where the message to add star to was posted (used with timestamp).
opts.timestamp	?	Timestamp of the message to add star to.
[optCb]	function	Optional callback, if not using promises.

starsFacet.list([opts], [optCb])

Lists stars for a user.

Kind: instance method of [StarsFacet](#StarsFacet)
See: stars.list

Param	Type	Description
[opts]	Object
[optCb]	function	Optional callback, if not using promises.

starsFacet.remove([opts], [optCb])

Removes a star from an item.

Kind: instance method of [StarsFacet](#StarsFacet)
See: stars.remove

Param	Type	Description
[opts]	Object
opts.file	?	File to remove star from.
opts.file_comment	?	File comment to remove star from.
opts.channel	?	Channel to remove star from, or channel where the message to remove star from was posted (used with timestamp).
opts.timestamp	?	Timestamp of the message to remove star from.
[optCb]	function	Optional callback, if not using promises.