Xlack.Web.Mpim (xlack v0.1.0) View Source
Link to this section Summary
Functions
Closes a multiparty direct message channel.
Fetches history of messages and events from a multiparty direct message.
Lists multiparty direct message channels for the calling user.
Sets the read cursor in a multiparty direct message channel.
This method opens a multiparty direct message.
Link to this section Functions
Closes a multiparty direct message channel.
Required Params
channel- MPIM to close.
Errors the API can return:
channel_not_found- Value passed forchannelwas invalid.
Fetches history of messages and events from a multiparty direct message.
Required Params
channel- Multiparty direct message to fetch history for.
Optional Params
count- Number of messages to return, between 1 and 1000. ex:100inclusive- Include messages with latest or oldest timestamp in results. ex:1latest- End of time range of messages to include in results.oldest- Start of time range of messages to include in results.unreads- Includeunread_count_displayin the output? ex:1
Errors the API can return:
channel_not_found- Value passed forchannelwas invalid.invalid_ts_latest- Value passed forlatestwas invalidinvalid_ts_oldest- Value passed foroldestwas invalid
Lists multiparty direct message channels for the calling user.
Sets the read cursor in a multiparty direct message channel.
Required Params
channel- multiparty direct message channel to set reading cursor in.ts- Timestamp of the most recently seen message.
Errors the API can return:
channel_not_found- Value passed forchannelwas invalid.invalid_timestamp- Value passed fortimestampwas invalid.
This method opens a multiparty direct message.
Required Params
users- Comma separated lists of users. The ordering of the users is preserved whenever a MPIM group is returned.
Errors the API can return:
not_enough_users- Needs at least 2 users to opentoo_many_users- Needs at most 8 users to openusers_list_not_supplied- Missingusersin request