Xlack.Web.Pins (xlack v0.1.0) View Source
Link to this section Summary
Functions
Pins an item to a channel.
Lists items pinned to a channel.
Un-pins an item from a channel.
Link to this section Functions
Pins an item to a channel.
Required Params
channel- Channel to pin the item in.
Optional Params
file- File to pin.file_comment- File comment to pin.timestamp- Timestamp of the message to pin.
Errors the API can return:
already_pinned- The specified item is already pinned to the channel.bad_timestamp- Value passed fortimestampwas invalid.channel_not_found- Thechannelargument was not specified or was invalidfile_comment_not_found- File comment specified byfile_commentdoes not exist.file_not_found- File specified byfiledoes not exist.file_not_shared- File specified byfileis not public nor shared to the channel.message_not_found- Message specified bychannelandtimestampdoes not exist.no_item_specified- One offile,file_comment, ortimestampwas not specified.permission_denied- The user does not have permission to add pins to the channel.
Lists items pinned to a channel.
Required Params
channel- Channel to get pinned items for.
Errors the API can return:
channel_not_found- Value passed forchannelwas invalid.
Un-pins an item from a channel.
Required Params
channel- Channel where the item is pinned to.
Optional Params
file- File to un-pin.file_comment- File comment to un-pin.timestamp- Timestamp of the message to un-pin.
Errors the API can return:
bad_timestamp- Value passed fortimestampwas invalid.file_comment_not_found- File comment specified byfile_commentdoes not exist.file_not_found- File specified byfiledoes not exist.message_not_found- Message specified bychannelandtimestampdoes not exist.no_item_specified- One offile,file_comment, ortimestampwas not specified.not_pinned- The specified item is not pinned to the channel.permission_denied- The user does not have permission to remove pins from the channel.