Slack Developer Kit for Node.js
Go to GitHub

MpimFacet

Kind: global class

mpimFacet.close(channel, [optCb])

Closes a multiparty direct message channel.

Kind: instance method of [MpimFacet](#MpimFacet)
See: mpim.close

Param Type Description
channel ? MPIM to close.
[optCb] function Optional callback, if not using promises.

mpimFacet.history(channel, [opts], [optCb])

Fetches history of messages and events from a multiparty direct message.

Kind: instance method of [MpimFacet](#MpimFacet)
See: mpim.history

Param Type Description
channel ? Multiparty direct message to fetch history for.
[opts] Object  
opts.latest ? End of time range of messages to include in results.
opts.oldest ? Start of time range of messages to include in results.
opts.inclusive ? Include messages with latest or oldest timestamp in results.
opts.count ? Number of messages to return, between 1 and 1000.
opts.unreads ? Include unread_count_display in the output?
[optCb] function Optional callback, if not using promises.

mpimFacet.list([optCb])

Lists multiparty direct message channels for the calling user.

Kind: instance method of [MpimFacet](#MpimFacet)
See: mpim.list

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

mpimFacet.mark(channel, ts, [optCb])

Sets the read cursor in a multiparty direct message channel.

Kind: instance method of [MpimFacet](#MpimFacet)
See: mpim.mark

Param Type Description
channel ? multiparty direct message channel to set reading cursor in.
ts ? Timestamp of the most recently seen message.
[optCb] function Optional callback, if not using promises.

mpimFacet.open(users, [optCb])

This method opens a multiparty direct message.

Kind: instance method of [MpimFacet](#MpimFacet)
See: mpim.open

Param Type Description
users ? Comma separated lists of users. The ordering of the users is preserved whenever a MPIM group is returned.
[optCb] function Optional callback, if not using promises.