PinsFacet

Kind: global class

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

pinsFacet.add(channel, [opts], [optCb])

Pins an item to a channel.

Kind: instance method of [PinsFacet](#PinsFacet)
See: pins.add

Param	Type	Description
channel	?	Channel to pin the item in.
[opts]	Object
opts.file	?	File to pin.
opts.file_comment	?	File comment to pin.
opts.timestamp	?	Timestamp of the message to pin.
[optCb]	function	Optional callback, if not using promises.

pinsFacet.list(channel, [optCb])

Lists items pinned to a channel.

Kind: instance method of [PinsFacet](#PinsFacet)
See: pins.list

Param	Type	Description
channel	?	Channel to get pinned items for.
[optCb]	function	Optional callback, if not using promises.

pinsFacet.remove(channel, [opts], [optCb])

Un-pins an item from a channel.

Kind: instance method of [PinsFacet](#PinsFacet)
See: pins.remove

Param	Type	Description
channel	?	Channel where the item is pinned to.
[opts]	Object
opts.file	?	File to un-pin.
opts.file_comment	?	File comment to un-pin.
opts.timestamp	?	Timestamp of the message to un-pin.
[optCb]	function	Optional callback, if not using promises.