@slack/client
Version:
A library for creating a Slack client
77 lines (64 loc) • 2.12 kB
JavaScript
/**
* API Facet to make calls to methods in the pins namespace.
*
* This provides functions to call:
* - add: {@link https://api.slack.com/methods/pins.add|pins.add}
* - list: {@link https://api.slack.com/methods/pins.list|pins.list}
* - remove: {@link https://api.slack.com/methods/pins.remove|pins.remove}
*
*/
/**
* @constructor
*/
function PinsFacet(makeAPICall) {
this.name = 'pins';
this.makeAPICall = makeAPICall;
}
/**
* Pins an item to a channel.
* @see {@link https://api.slack.com/methods/pins.add|pins.add}
*
* @param {?} channel - Channel to pin the item in.
* @param {Object=} opts
* @param {?} opts.file - File to pin.
* @param {?} opts.file_comment - File comment to pin.
* @param {?} opts.timestamp - Timestamp of the message to pin.
* @param {function=} optCb Optional callback, if not using promises.
*/
PinsFacet.prototype.add = function add(channel, opts, optCb) {
var requiredArgs = {
channel: channel
};
return this.makeAPICall('pins.add', requiredArgs, opts, optCb);
};
/**
* Lists items pinned to a channel.
* @see {@link https://api.slack.com/methods/pins.list|pins.list}
*
* @param {?} channel - Channel to get pinned items for.
* @param {function=} optCb Optional callback, if not using promises.
*/
PinsFacet.prototype.list = function list(channel, optCb) {
var requiredArgs = {
channel: channel
};
return this.makeAPICall('pins.list', requiredArgs, null, optCb);
};
/**
* Un-pins an item from a channel.
* @see {@link https://api.slack.com/methods/pins.remove|pins.remove}
*
* @param {?} channel - Channel where the item is pinned to.
* @param {Object=} opts
* @param {?} opts.file - File to un-pin.
* @param {?} opts.file_comment - File comment to un-pin.
* @param {?} opts.timestamp - Timestamp of the message to un-pin.
* @param {function=} optCb Optional callback, if not using promises.
*/
PinsFacet.prototype.remove = function remove(channel, opts, optCb) {
var requiredArgs = {
channel: channel
};
return this.makeAPICall('pins.remove', requiredArgs, opts, optCb);
};
module.exports = PinsFacet;