2016-09-05 14:34:37 +00:00
|
|
|
package slack
|
|
|
|
|
|
|
|
import (
|
2020-07-18 15:27:41 +00:00
|
|
|
"bytes"
|
2017-07-16 12:29:46 +00:00
|
|
|
"context"
|
2016-09-05 14:34:37 +00:00
|
|
|
"encoding/json"
|
2020-07-18 15:27:41 +00:00
|
|
|
"io/ioutil"
|
2019-09-07 20:46:58 +00:00
|
|
|
"net/http"
|
2016-09-05 14:34:37 +00:00
|
|
|
"net/url"
|
2020-03-28 22:50:47 +00:00
|
|
|
"strconv"
|
2018-10-07 21:17:46 +00:00
|
|
|
|
2020-03-01 19:59:19 +00:00
|
|
|
"github.com/slack-go/slack/slackutilsx"
|
2016-09-05 14:34:37 +00:00
|
|
|
)
|
|
|
|
|
|
|
|
const (
|
2017-03-25 19:45:10 +00:00
|
|
|
DEFAULT_MESSAGE_USERNAME = ""
|
2018-01-08 21:41:38 +00:00
|
|
|
DEFAULT_MESSAGE_REPLY_BROADCAST = false
|
2017-03-25 19:45:10 +00:00
|
|
|
DEFAULT_MESSAGE_ASUSER = false
|
|
|
|
DEFAULT_MESSAGE_PARSE = ""
|
2018-08-09 22:38:19 +00:00
|
|
|
DEFAULT_MESSAGE_THREAD_TIMESTAMP = ""
|
2017-03-25 19:45:10 +00:00
|
|
|
DEFAULT_MESSAGE_LINK_NAMES = 0
|
|
|
|
DEFAULT_MESSAGE_UNFURL_LINKS = false
|
|
|
|
DEFAULT_MESSAGE_UNFURL_MEDIA = true
|
|
|
|
DEFAULT_MESSAGE_ICON_URL = ""
|
|
|
|
DEFAULT_MESSAGE_ICON_EMOJI = ""
|
|
|
|
DEFAULT_MESSAGE_MARKDOWN = true
|
|
|
|
DEFAULT_MESSAGE_ESCAPE_TEXT = true
|
2016-09-05 14:34:37 +00:00
|
|
|
)
|
|
|
|
|
|
|
|
type chatResponseFull struct {
|
2020-03-28 22:50:47 +00:00
|
|
|
Channel string `json:"channel"`
|
|
|
|
Timestamp string `json:"ts"` //Regular message timestamp
|
|
|
|
MessageTimeStamp string `json:"message_ts"` //Ephemeral message timestamp
|
|
|
|
ScheduledMessageID string `json:"scheduled_message_id,omitempty"` //Scheduled message id
|
|
|
|
Text string `json:"text"`
|
2016-09-05 14:34:37 +00:00
|
|
|
SlackResponse
|
|
|
|
}
|
|
|
|
|
2018-08-09 22:38:19 +00:00
|
|
|
// getMessageTimestamp will inspect the `chatResponseFull` to ruturn a timestamp value
|
|
|
|
// in `chat.postMessage` its under `ts`
|
|
|
|
// in `chat.postEphemeral` its under `message_ts`
|
|
|
|
func (c chatResponseFull) getMessageTimestamp() string {
|
|
|
|
if len(c.Timestamp) > 0 {
|
|
|
|
return c.Timestamp
|
|
|
|
}
|
|
|
|
return c.MessageTimeStamp
|
|
|
|
}
|
|
|
|
|
2016-09-05 14:34:37 +00:00
|
|
|
// PostMessageParameters contains all the parameters necessary (including the optional ones) for a PostMessage() request
|
|
|
|
type PostMessageParameters struct {
|
2019-01-31 16:06:36 +00:00
|
|
|
Username string `json:"username"`
|
|
|
|
AsUser bool `json:"as_user"`
|
|
|
|
Parse string `json:"parse"`
|
|
|
|
ThreadTimestamp string `json:"thread_ts"`
|
|
|
|
ReplyBroadcast bool `json:"reply_broadcast"`
|
|
|
|
LinkNames int `json:"link_names"`
|
|
|
|
UnfurlLinks bool `json:"unfurl_links"`
|
|
|
|
UnfurlMedia bool `json:"unfurl_media"`
|
|
|
|
IconURL string `json:"icon_url"`
|
|
|
|
IconEmoji string `json:"icon_emoji"`
|
|
|
|
Markdown bool `json:"mrkdwn,omitempty"`
|
|
|
|
EscapeText bool `json:"escape_text"`
|
2018-01-08 21:41:38 +00:00
|
|
|
|
|
|
|
// chat.postEphemeral support
|
|
|
|
Channel string `json:"channel"`
|
|
|
|
User string `json:"user"`
|
2016-09-05 14:34:37 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// NewPostMessageParameters provides an instance of PostMessageParameters with all the sane default values set
|
|
|
|
func NewPostMessageParameters() PostMessageParameters {
|
|
|
|
return PostMessageParameters{
|
2018-08-09 22:38:19 +00:00
|
|
|
Username: DEFAULT_MESSAGE_USERNAME,
|
|
|
|
User: DEFAULT_MESSAGE_USERNAME,
|
|
|
|
AsUser: DEFAULT_MESSAGE_ASUSER,
|
|
|
|
Parse: DEFAULT_MESSAGE_PARSE,
|
|
|
|
ThreadTimestamp: DEFAULT_MESSAGE_THREAD_TIMESTAMP,
|
|
|
|
LinkNames: DEFAULT_MESSAGE_LINK_NAMES,
|
|
|
|
UnfurlLinks: DEFAULT_MESSAGE_UNFURL_LINKS,
|
|
|
|
UnfurlMedia: DEFAULT_MESSAGE_UNFURL_MEDIA,
|
|
|
|
IconURL: DEFAULT_MESSAGE_ICON_URL,
|
|
|
|
IconEmoji: DEFAULT_MESSAGE_ICON_EMOJI,
|
|
|
|
Markdown: DEFAULT_MESSAGE_MARKDOWN,
|
|
|
|
EscapeText: DEFAULT_MESSAGE_ESCAPE_TEXT,
|
2016-09-05 14:34:37 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2017-07-16 12:29:46 +00:00
|
|
|
// DeleteMessage deletes a message in a channel
|
|
|
|
func (api *Client) DeleteMessage(channel, messageTimestamp string) (string, string, error) {
|
2020-03-28 22:50:47 +00:00
|
|
|
respChannel, respTimestamp, _, err := api.SendMessageContext(
|
|
|
|
context.Background(),
|
|
|
|
channel,
|
|
|
|
MsgOptionDelete(messageTimestamp),
|
|
|
|
)
|
2017-07-16 12:29:46 +00:00
|
|
|
return respChannel, respTimestamp, err
|
|
|
|
}
|
|
|
|
|
|
|
|
// DeleteMessageContext deletes a message in a channel with a custom context
|
|
|
|
func (api *Client) DeleteMessageContext(ctx context.Context, channel, messageTimestamp string) (string, string, error) {
|
2020-03-28 22:50:47 +00:00
|
|
|
respChannel, respTimestamp, _, err := api.SendMessageContext(
|
|
|
|
ctx,
|
|
|
|
channel,
|
|
|
|
MsgOptionDelete(messageTimestamp),
|
|
|
|
)
|
|
|
|
return respChannel, respTimestamp, err
|
|
|
|
}
|
|
|
|
|
|
|
|
// ScheduleMessage sends a message to a channel.
|
|
|
|
// Message is escaped by default according to https://api.slack.com/docs/formatting
|
|
|
|
// Use http://davestevens.github.io/slack-message-builder/ to help crafting your message.
|
|
|
|
func (api *Client) ScheduleMessage(channelID, postAt string, options ...MsgOption) (string, string, error) {
|
|
|
|
respChannel, respTimestamp, _, err := api.SendMessageContext(
|
|
|
|
context.Background(),
|
|
|
|
channelID,
|
|
|
|
MsgOptionSchedule(postAt),
|
|
|
|
MsgOptionCompose(options...),
|
|
|
|
)
|
2017-07-16 12:29:46 +00:00
|
|
|
return respChannel, respTimestamp, err
|
|
|
|
}
|
|
|
|
|
|
|
|
// PostMessage sends a message to a channel.
|
|
|
|
// Message is escaped by default according to https://api.slack.com/docs/formatting
|
|
|
|
// Use http://davestevens.github.io/slack-message-builder/ to help crafting your message.
|
2018-12-01 18:55:35 +00:00
|
|
|
func (api *Client) PostMessage(channelID string, options ...MsgOption) (string, string, error) {
|
2017-07-16 12:29:46 +00:00
|
|
|
respChannel, respTimestamp, _, err := api.SendMessageContext(
|
|
|
|
context.Background(),
|
2018-12-01 18:55:35 +00:00
|
|
|
channelID,
|
|
|
|
MsgOptionPost(),
|
|
|
|
MsgOptionCompose(options...),
|
2017-07-16 12:29:46 +00:00
|
|
|
)
|
|
|
|
return respChannel, respTimestamp, err
|
|
|
|
}
|
|
|
|
|
|
|
|
// PostMessageContext sends a message to a channel with a custom context
|
2018-12-01 18:55:35 +00:00
|
|
|
// For more details, see PostMessage documentation.
|
|
|
|
func (api *Client) PostMessageContext(ctx context.Context, channelID string, options ...MsgOption) (string, string, error) {
|
2017-07-16 12:29:46 +00:00
|
|
|
respChannel, respTimestamp, _, err := api.SendMessageContext(
|
|
|
|
ctx,
|
2018-12-01 18:55:35 +00:00
|
|
|
channelID,
|
|
|
|
MsgOptionPost(),
|
|
|
|
MsgOptionCompose(options...),
|
2017-07-16 12:29:46 +00:00
|
|
|
)
|
|
|
|
return respChannel, respTimestamp, err
|
|
|
|
}
|
|
|
|
|
2018-01-08 21:41:38 +00:00
|
|
|
// PostEphemeral sends an ephemeral message to a user in a channel.
|
|
|
|
// Message is escaped by default according to https://api.slack.com/docs/formatting
|
|
|
|
// Use http://davestevens.github.io/slack-message-builder/ to help crafting your message.
|
2018-08-09 22:38:19 +00:00
|
|
|
func (api *Client) PostEphemeral(channelID, userID string, options ...MsgOption) (string, error) {
|
2018-01-08 21:41:38 +00:00
|
|
|
return api.PostEphemeralContext(
|
|
|
|
context.Background(),
|
2018-08-09 22:38:19 +00:00
|
|
|
channelID,
|
2018-01-08 21:41:38 +00:00
|
|
|
userID,
|
|
|
|
options...,
|
|
|
|
)
|
|
|
|
}
|
|
|
|
|
|
|
|
// PostEphemeralContext sends an ephemeal message to a user in a channel with a custom context
|
|
|
|
// For more details, see PostEphemeral documentation
|
2018-08-09 22:38:19 +00:00
|
|
|
func (api *Client) PostEphemeralContext(ctx context.Context, channelID, userID string, options ...MsgOption) (timestamp string, err error) {
|
2020-03-28 22:50:47 +00:00
|
|
|
_, timestamp, _, err = api.SendMessageContext(
|
|
|
|
ctx,
|
|
|
|
channelID,
|
|
|
|
MsgOptionPostEphemeral(userID),
|
|
|
|
MsgOptionCompose(options...),
|
|
|
|
)
|
2018-08-09 22:38:19 +00:00
|
|
|
return timestamp, err
|
2018-01-08 21:41:38 +00:00
|
|
|
}
|
|
|
|
|
2017-07-16 12:29:46 +00:00
|
|
|
// UpdateMessage updates a message in a channel
|
2018-12-01 18:55:35 +00:00
|
|
|
func (api *Client) UpdateMessage(channelID, timestamp string, options ...MsgOption) (string, string, string, error) {
|
2020-03-28 22:50:47 +00:00
|
|
|
return api.SendMessageContext(
|
|
|
|
context.Background(),
|
|
|
|
channelID,
|
|
|
|
MsgOptionUpdate(timestamp),
|
|
|
|
MsgOptionCompose(options...),
|
|
|
|
)
|
2017-07-16 12:29:46 +00:00
|
|
|
}
|
|
|
|
|
2018-08-09 22:38:19 +00:00
|
|
|
// UpdateMessageContext updates a message in a channel
|
2018-12-01 18:55:35 +00:00
|
|
|
func (api *Client) UpdateMessageContext(ctx context.Context, channelID, timestamp string, options ...MsgOption) (string, string, string, error) {
|
2020-03-28 22:50:47 +00:00
|
|
|
return api.SendMessageContext(
|
|
|
|
ctx,
|
|
|
|
channelID,
|
|
|
|
MsgOptionUpdate(timestamp),
|
|
|
|
MsgOptionCompose(options...),
|
|
|
|
)
|
2018-12-01 18:55:35 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// UnfurlMessage unfurls a message in a channel
|
|
|
|
func (api *Client) UnfurlMessage(channelID, timestamp string, unfurls map[string]Attachment, options ...MsgOption) (string, string, string, error) {
|
|
|
|
return api.SendMessageContext(context.Background(), channelID, MsgOptionUnfurl(timestamp, unfurls), MsgOptionCompose(options...))
|
2017-07-16 12:29:46 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// SendMessage more flexible method for configuring messages.
|
|
|
|
func (api *Client) SendMessage(channel string, options ...MsgOption) (string, string, string, error) {
|
|
|
|
return api.SendMessageContext(context.Background(), channel, options...)
|
|
|
|
}
|
|
|
|
|
|
|
|
// SendMessageContext more flexible method for configuring messages with a custom context.
|
2019-09-07 20:46:58 +00:00
|
|
|
func (api *Client) SendMessageContext(ctx context.Context, channelID string, options ...MsgOption) (_channel string, _timestamp string, _text string, err error) {
|
2018-08-09 22:38:19 +00:00
|
|
|
var (
|
2019-09-07 20:46:58 +00:00
|
|
|
req *http.Request
|
|
|
|
parser func(*chatResponseFull) responseParser
|
2018-08-09 22:38:19 +00:00
|
|
|
response chatResponseFull
|
|
|
|
)
|
|
|
|
|
2019-09-07 20:46:58 +00:00
|
|
|
if req, parser, err = buildSender(api.endpoint, options...).BuildRequest(api.token, channelID); err != nil {
|
2017-07-16 12:29:46 +00:00
|
|
|
return "", "", "", err
|
2016-09-05 14:34:37 +00:00
|
|
|
}
|
2017-07-16 12:29:46 +00:00
|
|
|
|
2020-07-18 15:27:41 +00:00
|
|
|
if api.Debug() {
|
|
|
|
reqBody, err := ioutil.ReadAll(req.Body)
|
|
|
|
if err != nil {
|
|
|
|
return "", "", "", err
|
|
|
|
}
|
|
|
|
req.Body = ioutil.NopCloser(bytes.NewBuffer(reqBody))
|
|
|
|
api.Debugf("Sending request: %s", string(reqBody))
|
|
|
|
}
|
|
|
|
|
2019-09-07 20:46:58 +00:00
|
|
|
if err = doPost(ctx, api.httpclient, req, parser(&response), api); err != nil {
|
2017-07-16 12:29:46 +00:00
|
|
|
return "", "", "", err
|
2016-09-05 14:34:37 +00:00
|
|
|
}
|
2017-07-16 12:29:46 +00:00
|
|
|
|
2018-08-09 22:38:19 +00:00
|
|
|
return response.Channel, response.getMessageTimestamp(), response.Text, response.Err()
|
2016-09-05 14:34:37 +00:00
|
|
|
}
|
|
|
|
|
2018-10-07 21:17:46 +00:00
|
|
|
// UnsafeApplyMsgOptions utility function for debugging/testing chat requests.
|
|
|
|
// NOTE: USE AT YOUR OWN RISK: No issues relating to the use of this function
|
|
|
|
// will be supported by the library.
|
2019-09-07 20:46:58 +00:00
|
|
|
func UnsafeApplyMsgOptions(token, channel, apiurl string, options ...MsgOption) (string, url.Values, error) {
|
|
|
|
config, err := applyMsgOptions(token, channel, apiurl, options...)
|
2018-10-07 21:17:46 +00:00
|
|
|
return config.endpoint, config.values, err
|
2018-08-09 22:38:19 +00:00
|
|
|
}
|
|
|
|
|
2019-09-07 20:46:58 +00:00
|
|
|
func applyMsgOptions(token, channel, apiurl string, options ...MsgOption) (sendConfig, error) {
|
2017-07-16 12:29:46 +00:00
|
|
|
config := sendConfig{
|
2019-09-07 20:46:58 +00:00
|
|
|
apiurl: apiurl,
|
|
|
|
endpoint: apiurl + string(chatPostMessage),
|
2017-07-16 12:29:46 +00:00
|
|
|
values: url.Values{
|
|
|
|
"token": {token},
|
|
|
|
"channel": {channel},
|
|
|
|
},
|
2016-09-05 14:34:37 +00:00
|
|
|
}
|
2017-07-16 12:29:46 +00:00
|
|
|
|
|
|
|
for _, opt := range options {
|
|
|
|
if err := opt(&config); err != nil {
|
2018-08-09 22:38:19 +00:00
|
|
|
return config, err
|
2017-07-16 12:29:46 +00:00
|
|
|
}
|
2016-09-05 14:34:37 +00:00
|
|
|
}
|
2017-07-16 12:29:46 +00:00
|
|
|
|
2018-08-09 22:38:19 +00:00
|
|
|
return config, nil
|
2016-09-05 14:34:37 +00:00
|
|
|
}
|
|
|
|
|
2019-09-07 20:46:58 +00:00
|
|
|
func buildSender(apiurl string, options ...MsgOption) sendConfig {
|
|
|
|
return sendConfig{
|
|
|
|
apiurl: apiurl,
|
|
|
|
options: options,
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2017-07-16 12:29:46 +00:00
|
|
|
type sendMode string
|
|
|
|
|
|
|
|
const (
|
2020-03-28 22:50:47 +00:00
|
|
|
chatUpdate sendMode = "chat.update"
|
|
|
|
chatPostMessage sendMode = "chat.postMessage"
|
|
|
|
chatScheduleMessage sendMode = "chat.scheduleMessage"
|
|
|
|
chatDelete sendMode = "chat.delete"
|
|
|
|
chatPostEphemeral sendMode = "chat.postEphemeral"
|
|
|
|
chatResponse sendMode = "chat.responseURL"
|
|
|
|
chatMeMessage sendMode = "chat.meMessage"
|
|
|
|
chatUnfurl sendMode = "chat.unfurl"
|
2017-07-16 12:29:46 +00:00
|
|
|
)
|
|
|
|
|
|
|
|
type sendConfig struct {
|
2020-05-23 22:06:21 +00:00
|
|
|
apiurl string
|
|
|
|
options []MsgOption
|
|
|
|
mode sendMode
|
|
|
|
endpoint string
|
|
|
|
values url.Values
|
|
|
|
attachments []Attachment
|
|
|
|
blocks Blocks
|
|
|
|
responseType string
|
|
|
|
replaceOriginal bool
|
|
|
|
deleteOriginal bool
|
2019-09-07 20:46:58 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
func (t sendConfig) BuildRequest(token, channelID string) (req *http.Request, _ func(*chatResponseFull) responseParser, err error) {
|
|
|
|
if t, err = applyMsgOptions(token, channelID, t.apiurl, t.options...); err != nil {
|
|
|
|
return nil, nil, err
|
|
|
|
}
|
|
|
|
|
|
|
|
switch t.mode {
|
|
|
|
case chatResponse:
|
|
|
|
return responseURLSender{
|
2020-05-23 22:06:21 +00:00
|
|
|
endpoint: t.endpoint,
|
|
|
|
values: t.values,
|
|
|
|
attachments: t.attachments,
|
|
|
|
blocks: t.blocks,
|
|
|
|
responseType: t.responseType,
|
|
|
|
replaceOriginal: t.replaceOriginal,
|
|
|
|
deleteOriginal: t.deleteOriginal,
|
2019-09-07 20:46:58 +00:00
|
|
|
}.BuildRequest()
|
|
|
|
default:
|
|
|
|
return formSender{endpoint: t.endpoint, values: t.values}.BuildRequest()
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
type formSender struct {
|
2018-10-07 21:17:46 +00:00
|
|
|
endpoint string
|
|
|
|
values url.Values
|
2017-07-16 12:29:46 +00:00
|
|
|
}
|
|
|
|
|
2019-09-07 20:46:58 +00:00
|
|
|
func (t formSender) BuildRequest() (*http.Request, func(*chatResponseFull) responseParser, error) {
|
|
|
|
req, err := formReq(t.endpoint, t.values)
|
|
|
|
return req, func(resp *chatResponseFull) responseParser {
|
|
|
|
return newJSONParser(resp)
|
|
|
|
}, err
|
|
|
|
}
|
|
|
|
|
|
|
|
type responseURLSender struct {
|
2020-05-23 22:06:21 +00:00
|
|
|
endpoint string
|
|
|
|
values url.Values
|
|
|
|
attachments []Attachment
|
|
|
|
blocks Blocks
|
|
|
|
responseType string
|
|
|
|
replaceOriginal bool
|
|
|
|
deleteOriginal bool
|
2019-09-07 20:46:58 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
func (t responseURLSender) BuildRequest() (*http.Request, func(*chatResponseFull) responseParser, error) {
|
|
|
|
req, err := jsonReq(t.endpoint, Msg{
|
2020-05-23 22:06:21 +00:00
|
|
|
Text: t.values.Get("text"),
|
|
|
|
Timestamp: t.values.Get("ts"),
|
|
|
|
Attachments: t.attachments,
|
|
|
|
Blocks: t.blocks,
|
|
|
|
ResponseType: t.responseType,
|
|
|
|
ReplaceOriginal: t.replaceOriginal,
|
|
|
|
DeleteOriginal: t.deleteOriginal,
|
2019-09-07 20:46:58 +00:00
|
|
|
})
|
|
|
|
return req, func(resp *chatResponseFull) responseParser {
|
|
|
|
return newContentTypeParser(resp)
|
|
|
|
}, err
|
|
|
|
}
|
|
|
|
|
2017-07-16 12:29:46 +00:00
|
|
|
// MsgOption option provided when sending a message.
|
|
|
|
type MsgOption func(*sendConfig) error
|
|
|
|
|
2020-03-28 22:50:47 +00:00
|
|
|
// MsgOptionSchedule schedules a messages.
|
|
|
|
func MsgOptionSchedule(postAt string) MsgOption {
|
|
|
|
return func(config *sendConfig) error {
|
|
|
|
config.endpoint = config.apiurl + string(chatScheduleMessage)
|
|
|
|
config.values.Add("post_at", postAt)
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2017-07-16 12:29:46 +00:00
|
|
|
// MsgOptionPost posts a messages, this is the default.
|
|
|
|
func MsgOptionPost() MsgOption {
|
|
|
|
return func(config *sendConfig) error {
|
2019-09-07 20:46:58 +00:00
|
|
|
config.endpoint = config.apiurl + string(chatPostMessage)
|
2018-01-08 21:41:38 +00:00
|
|
|
config.values.Del("ts")
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2018-12-01 18:55:35 +00:00
|
|
|
// MsgOptionPostEphemeral - posts an ephemeral message to the provided user.
|
|
|
|
func MsgOptionPostEphemeral(userID string) MsgOption {
|
2018-08-09 22:38:19 +00:00
|
|
|
return func(config *sendConfig) error {
|
2019-09-07 20:46:58 +00:00
|
|
|
config.endpoint = config.apiurl + string(chatPostEphemeral)
|
2018-08-09 22:38:19 +00:00
|
|
|
MsgOptionUser(userID)(config)
|
|
|
|
config.values.Del("ts")
|
|
|
|
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// MsgOptionMeMessage posts a "me message" type from the calling user
|
|
|
|
func MsgOptionMeMessage() MsgOption {
|
|
|
|
return func(config *sendConfig) error {
|
2019-09-07 20:46:58 +00:00
|
|
|
config.endpoint = config.apiurl + string(chatMeMessage)
|
2018-08-09 22:38:19 +00:00
|
|
|
return nil
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2017-07-16 12:29:46 +00:00
|
|
|
// MsgOptionUpdate updates a message based on the timestamp.
|
|
|
|
func MsgOptionUpdate(timestamp string) MsgOption {
|
|
|
|
return func(config *sendConfig) error {
|
2019-09-07 20:46:58 +00:00
|
|
|
config.endpoint = config.apiurl + string(chatUpdate)
|
2017-07-16 12:29:46 +00:00
|
|
|
config.values.Add("ts", timestamp)
|
|
|
|
return nil
|
2016-09-05 14:34:37 +00:00
|
|
|
}
|
2017-07-16 12:29:46 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// MsgOptionDelete deletes a message based on the timestamp.
|
|
|
|
func MsgOptionDelete(timestamp string) MsgOption {
|
|
|
|
return func(config *sendConfig) error {
|
2019-09-07 20:46:58 +00:00
|
|
|
config.endpoint = config.apiurl + string(chatDelete)
|
2017-07-16 12:29:46 +00:00
|
|
|
config.values.Add("ts", timestamp)
|
|
|
|
return nil
|
2016-09-05 14:34:37 +00:00
|
|
|
}
|
2017-07-16 12:29:46 +00:00
|
|
|
}
|
|
|
|
|
2018-12-01 18:55:35 +00:00
|
|
|
// MsgOptionUnfurl unfurls a message based on the timestamp.
|
|
|
|
func MsgOptionUnfurl(timestamp string, unfurls map[string]Attachment) MsgOption {
|
|
|
|
return func(config *sendConfig) error {
|
2019-09-07 20:46:58 +00:00
|
|
|
config.endpoint = config.apiurl + string(chatUnfurl)
|
2018-12-01 18:55:35 +00:00
|
|
|
config.values.Add("ts", timestamp)
|
|
|
|
unfurlsStr, err := json.Marshal(unfurls)
|
|
|
|
if err == nil {
|
|
|
|
config.values.Add("unfurls", string(unfurlsStr))
|
|
|
|
}
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2019-09-07 20:46:58 +00:00
|
|
|
// MsgOptionResponseURL supplies a url to use as the endpoint.
|
2020-03-01 19:59:19 +00:00
|
|
|
func MsgOptionResponseURL(url string, responseType string) MsgOption {
|
2019-09-07 20:46:58 +00:00
|
|
|
return func(config *sendConfig) error {
|
|
|
|
config.mode = chatResponse
|
|
|
|
config.endpoint = url
|
2020-03-01 19:59:19 +00:00
|
|
|
config.responseType = responseType
|
2019-09-07 20:46:58 +00:00
|
|
|
config.values.Del("ts")
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2020-05-23 22:06:21 +00:00
|
|
|
// MsgOptionReplaceOriginal replaces original message with response url
|
|
|
|
func MsgOptionReplaceOriginal(responseURL string) MsgOption {
|
|
|
|
return func(config *sendConfig) error {
|
|
|
|
config.mode = chatResponse
|
|
|
|
config.endpoint = responseURL
|
|
|
|
config.replaceOriginal = true
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// MsgOptionDeleteOriginal deletes original message with response url
|
|
|
|
func MsgOptionDeleteOriginal(responseURL string) MsgOption {
|
|
|
|
return func(config *sendConfig) error {
|
|
|
|
config.mode = chatResponse
|
|
|
|
config.endpoint = responseURL
|
|
|
|
config.deleteOriginal = true
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2017-07-16 12:29:46 +00:00
|
|
|
// MsgOptionAsUser whether or not to send the message as the user.
|
|
|
|
func MsgOptionAsUser(b bool) MsgOption {
|
|
|
|
return func(config *sendConfig) error {
|
|
|
|
if b != DEFAULT_MESSAGE_ASUSER {
|
|
|
|
config.values.Set("as_user", "true")
|
2016-09-05 14:34:37 +00:00
|
|
|
}
|
2017-07-16 12:29:46 +00:00
|
|
|
return nil
|
2016-09-05 14:34:37 +00:00
|
|
|
}
|
2017-07-16 12:29:46 +00:00
|
|
|
}
|
|
|
|
|
2018-08-09 22:38:19 +00:00
|
|
|
// MsgOptionUser set the user for the message.
|
|
|
|
func MsgOptionUser(userID string) MsgOption {
|
|
|
|
return func(config *sendConfig) error {
|
|
|
|
config.values.Set("user", userID)
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2018-12-01 18:55:35 +00:00
|
|
|
// MsgOptionUsername set the username for the message.
|
|
|
|
func MsgOptionUsername(username string) MsgOption {
|
|
|
|
return func(config *sendConfig) error {
|
|
|
|
config.values.Set("username", username)
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2017-07-16 12:29:46 +00:00
|
|
|
// MsgOptionText provide the text for the message, optionally escape the provided
|
|
|
|
// text.
|
|
|
|
func MsgOptionText(text string, escape bool) MsgOption {
|
|
|
|
return func(config *sendConfig) error {
|
|
|
|
if escape {
|
2018-10-07 21:17:46 +00:00
|
|
|
text = slackutilsx.EscapeMessage(text)
|
2017-07-16 12:29:46 +00:00
|
|
|
}
|
|
|
|
config.values.Add("text", text)
|
|
|
|
return nil
|
2016-09-05 14:34:37 +00:00
|
|
|
}
|
2017-07-16 12:29:46 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// MsgOptionAttachments provide attachments for the message.
|
|
|
|
func MsgOptionAttachments(attachments ...Attachment) MsgOption {
|
|
|
|
return func(config *sendConfig) error {
|
|
|
|
if attachments == nil {
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
2019-09-07 20:46:58 +00:00
|
|
|
config.attachments = attachments
|
|
|
|
|
|
|
|
// FIXME: We are setting the attachments on the message twice: above for
|
|
|
|
// the json version, and below for the html version. The marshalled bytes
|
|
|
|
// we put into config.values below don't work directly in the Msg version.
|
|
|
|
|
|
|
|
attachmentBytes, err := json.Marshal(attachments)
|
2017-07-16 12:29:46 +00:00
|
|
|
if err == nil {
|
2019-09-07 20:46:58 +00:00
|
|
|
config.values.Set("attachments", string(attachmentBytes))
|
|
|
|
}
|
|
|
|
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// MsgOptionBlocks sets blocks for the message
|
|
|
|
func MsgOptionBlocks(blocks ...Block) MsgOption {
|
|
|
|
return func(config *sendConfig) error {
|
|
|
|
if blocks == nil {
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
2019-12-07 21:54:36 +00:00
|
|
|
config.blocks.BlockSet = append(config.blocks.BlockSet, blocks...)
|
|
|
|
|
2019-09-07 20:46:58 +00:00
|
|
|
blocks, err := json.Marshal(blocks)
|
|
|
|
if err == nil {
|
|
|
|
config.values.Set("blocks", string(blocks))
|
2017-07-16 12:29:46 +00:00
|
|
|
}
|
|
|
|
return err
|
2016-09-05 14:34:37 +00:00
|
|
|
}
|
2017-07-16 12:29:46 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// MsgOptionEnableLinkUnfurl enables link unfurling
|
|
|
|
func MsgOptionEnableLinkUnfurl() MsgOption {
|
|
|
|
return func(config *sendConfig) error {
|
|
|
|
config.values.Set("unfurl_links", "true")
|
|
|
|
return nil
|
2017-03-25 19:45:10 +00:00
|
|
|
}
|
2017-07-16 12:29:46 +00:00
|
|
|
}
|
2016-09-05 14:34:37 +00:00
|
|
|
|
2018-08-09 22:38:19 +00:00
|
|
|
// MsgOptionDisableLinkUnfurl disables link unfurling
|
|
|
|
func MsgOptionDisableLinkUnfurl() MsgOption {
|
|
|
|
return func(config *sendConfig) error {
|
|
|
|
config.values.Set("unfurl_links", "false")
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2017-07-16 12:29:46 +00:00
|
|
|
// MsgOptionDisableMediaUnfurl disables media unfurling.
|
|
|
|
func MsgOptionDisableMediaUnfurl() MsgOption {
|
|
|
|
return func(config *sendConfig) error {
|
|
|
|
config.values.Set("unfurl_media", "false")
|
|
|
|
return nil
|
2016-09-05 14:34:37 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2017-07-16 12:29:46 +00:00
|
|
|
// MsgOptionDisableMarkdown disables markdown.
|
|
|
|
func MsgOptionDisableMarkdown() MsgOption {
|
|
|
|
return func(config *sendConfig) error {
|
|
|
|
config.values.Set("mrkdwn", "false")
|
|
|
|
return nil
|
2016-09-05 14:34:37 +00:00
|
|
|
}
|
2017-07-16 12:29:46 +00:00
|
|
|
}
|
|
|
|
|
2018-08-09 22:38:19 +00:00
|
|
|
// MsgOptionTS sets the thread TS of the message to enable creating or replying to a thread
|
|
|
|
func MsgOptionTS(ts string) MsgOption {
|
|
|
|
return func(config *sendConfig) error {
|
|
|
|
config.values.Set("thread_ts", ts)
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// MsgOptionBroadcast sets reply_broadcast to true
|
|
|
|
func MsgOptionBroadcast() MsgOption {
|
|
|
|
return func(config *sendConfig) error {
|
|
|
|
config.values.Set("reply_broadcast", "true")
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2018-12-01 18:55:35 +00:00
|
|
|
// MsgOptionCompose combines multiple options into a single option.
|
2018-08-09 22:38:19 +00:00
|
|
|
func MsgOptionCompose(options ...MsgOption) MsgOption {
|
2020-10-11 21:07:00 +00:00
|
|
|
return func(config *sendConfig) error {
|
2018-08-09 22:38:19 +00:00
|
|
|
for _, opt := range options {
|
2020-10-11 21:07:00 +00:00
|
|
|
if err := opt(config); err != nil {
|
2018-08-09 22:38:19 +00:00
|
|
|
return err
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2018-12-01 18:55:35 +00:00
|
|
|
// MsgOptionParse set parse option.
|
2018-08-09 22:38:19 +00:00
|
|
|
func MsgOptionParse(b bool) MsgOption {
|
2020-10-11 21:07:00 +00:00
|
|
|
return func(config *sendConfig) error {
|
2018-08-09 22:38:19 +00:00
|
|
|
var v string
|
|
|
|
if b {
|
2019-09-07 20:46:58 +00:00
|
|
|
v = "full"
|
2018-08-09 22:38:19 +00:00
|
|
|
} else {
|
2019-09-07 20:46:58 +00:00
|
|
|
v = "none"
|
2018-08-09 22:38:19 +00:00
|
|
|
}
|
2020-10-11 21:07:00 +00:00
|
|
|
config.values.Set("parse", v)
|
2018-08-09 22:38:19 +00:00
|
|
|
return nil
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2019-09-07 20:46:58 +00:00
|
|
|
// MsgOptionIconURL sets an icon URL
|
|
|
|
func MsgOptionIconURL(iconURL string) MsgOption {
|
2020-10-11 21:07:00 +00:00
|
|
|
return func(config *sendConfig) error {
|
|
|
|
config.values.Set("icon_url", iconURL)
|
2019-09-07 20:46:58 +00:00
|
|
|
return nil
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// MsgOptionIconEmoji sets an icon emoji
|
|
|
|
func MsgOptionIconEmoji(iconEmoji string) MsgOption {
|
2020-10-11 21:07:00 +00:00
|
|
|
return func(config *sendConfig) error {
|
|
|
|
config.values.Set("icon_emoji", iconEmoji)
|
2019-09-07 20:46:58 +00:00
|
|
|
return nil
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2018-10-07 21:17:46 +00:00
|
|
|
// UnsafeMsgOptionEndpoint deliver the message to the specified endpoint.
|
|
|
|
// NOTE: USE AT YOUR OWN RISK: No issues relating to the use of this Option
|
|
|
|
// will be supported by the library, it is subject to change without notice that
|
|
|
|
// may result in compilation errors or runtime behaviour changes.
|
|
|
|
func UnsafeMsgOptionEndpoint(endpoint string, update func(url.Values)) MsgOption {
|
|
|
|
return func(config *sendConfig) error {
|
|
|
|
config.endpoint = endpoint
|
|
|
|
update(config.values)
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2017-07-16 12:29:46 +00:00
|
|
|
// MsgOptionPostMessageParameters maintain backwards compatibility.
|
|
|
|
func MsgOptionPostMessageParameters(params PostMessageParameters) MsgOption {
|
|
|
|
return func(config *sendConfig) error {
|
|
|
|
if params.Username != DEFAULT_MESSAGE_USERNAME {
|
2018-08-09 22:38:19 +00:00
|
|
|
config.values.Set("username", params.Username)
|
2017-07-16 12:29:46 +00:00
|
|
|
}
|
|
|
|
|
2018-01-08 21:41:38 +00:00
|
|
|
// chat.postEphemeral support
|
|
|
|
if params.User != DEFAULT_MESSAGE_USERNAME {
|
|
|
|
config.values.Set("user", params.User)
|
|
|
|
}
|
|
|
|
|
2017-07-16 12:29:46 +00:00
|
|
|
// never generates an error.
|
|
|
|
MsgOptionAsUser(params.AsUser)(config)
|
|
|
|
|
|
|
|
if params.Parse != DEFAULT_MESSAGE_PARSE {
|
2018-08-09 22:38:19 +00:00
|
|
|
config.values.Set("parse", params.Parse)
|
2017-07-16 12:29:46 +00:00
|
|
|
}
|
|
|
|
if params.LinkNames != DEFAULT_MESSAGE_LINK_NAMES {
|
|
|
|
config.values.Set("link_names", "1")
|
|
|
|
}
|
|
|
|
|
|
|
|
if params.UnfurlLinks != DEFAULT_MESSAGE_UNFURL_LINKS {
|
|
|
|
config.values.Set("unfurl_links", "true")
|
|
|
|
}
|
|
|
|
|
|
|
|
// I want to send a message with explicit `as_user` `true` and `unfurl_links` `false` in request.
|
|
|
|
// Because setting `as_user` to `true` will change the default value for `unfurl_links` to `true` on Slack API side.
|
|
|
|
if params.AsUser != DEFAULT_MESSAGE_ASUSER && params.UnfurlLinks == DEFAULT_MESSAGE_UNFURL_LINKS {
|
|
|
|
config.values.Set("unfurl_links", "false")
|
|
|
|
}
|
|
|
|
if params.UnfurlMedia != DEFAULT_MESSAGE_UNFURL_MEDIA {
|
|
|
|
config.values.Set("unfurl_media", "false")
|
|
|
|
}
|
|
|
|
if params.IconURL != DEFAULT_MESSAGE_ICON_URL {
|
|
|
|
config.values.Set("icon_url", params.IconURL)
|
|
|
|
}
|
|
|
|
if params.IconEmoji != DEFAULT_MESSAGE_ICON_EMOJI {
|
|
|
|
config.values.Set("icon_emoji", params.IconEmoji)
|
|
|
|
}
|
|
|
|
if params.Markdown != DEFAULT_MESSAGE_MARKDOWN {
|
|
|
|
config.values.Set("mrkdwn", "false")
|
|
|
|
}
|
|
|
|
|
|
|
|
if params.ThreadTimestamp != DEFAULT_MESSAGE_THREAD_TIMESTAMP {
|
|
|
|
config.values.Set("thread_ts", params.ThreadTimestamp)
|
|
|
|
}
|
2018-01-08 21:41:38 +00:00
|
|
|
if params.ReplyBroadcast != DEFAULT_MESSAGE_REPLY_BROADCAST {
|
|
|
|
config.values.Set("reply_broadcast", "true")
|
|
|
|
}
|
2017-07-16 12:29:46 +00:00
|
|
|
|
|
|
|
return nil
|
2016-09-05 14:34:37 +00:00
|
|
|
}
|
|
|
|
}
|
2018-12-01 18:55:35 +00:00
|
|
|
|
|
|
|
// PermalinkParameters are the parameters required to get a permalink to a
|
|
|
|
// message. Slack documentation can be found here:
|
|
|
|
// https://api.slack.com/methods/chat.getPermalink
|
|
|
|
type PermalinkParameters struct {
|
|
|
|
Channel string
|
|
|
|
Ts string
|
|
|
|
}
|
|
|
|
|
|
|
|
// GetPermalink returns the permalink for a message. It takes
|
|
|
|
// PermalinkParameters and returns a string containing the permalink. It
|
|
|
|
// returns an error if unable to retrieve the permalink.
|
|
|
|
func (api *Client) GetPermalink(params *PermalinkParameters) (string, error) {
|
|
|
|
return api.GetPermalinkContext(context.Background(), params)
|
|
|
|
}
|
|
|
|
|
|
|
|
// GetPermalinkContext returns the permalink for a message using a custom context.
|
|
|
|
func (api *Client) GetPermalinkContext(ctx context.Context, params *PermalinkParameters) (string, error) {
|
|
|
|
values := url.Values{
|
|
|
|
"token": {api.token},
|
|
|
|
"channel": {params.Channel},
|
|
|
|
"message_ts": {params.Ts},
|
|
|
|
}
|
|
|
|
|
|
|
|
response := struct {
|
|
|
|
Channel string `json:"channel"`
|
|
|
|
Permalink string `json:"permalink"`
|
|
|
|
SlackResponse
|
|
|
|
}{}
|
2019-09-07 20:46:58 +00:00
|
|
|
err := api.getMethod(ctx, "chat.getPermalink", values, &response)
|
2018-12-01 18:55:35 +00:00
|
|
|
if err != nil {
|
|
|
|
return "", err
|
|
|
|
}
|
|
|
|
return response.Permalink, response.Err()
|
|
|
|
}
|
2020-03-28 22:50:47 +00:00
|
|
|
|
|
|
|
type GetScheduledMessagesParameters struct {
|
|
|
|
Channel string
|
|
|
|
Cursor string
|
|
|
|
Latest string
|
|
|
|
Limit int
|
|
|
|
Oldest string
|
|
|
|
}
|
|
|
|
|
|
|
|
// GetScheduledMessages returns the list of scheduled messages based on params
|
2020-10-11 21:07:00 +00:00
|
|
|
func (api *Client) GetScheduledMessages(params *GetScheduledMessagesParameters) (channels []ScheduledMessage, nextCursor string, err error) {
|
2020-03-28 22:50:47 +00:00
|
|
|
return api.GetScheduledMessagesContext(context.Background(), params)
|
|
|
|
}
|
|
|
|
|
|
|
|
// GetScheduledMessagesContext returns the list of scheduled messages in a Slack team with a custom context
|
2020-10-11 21:07:00 +00:00
|
|
|
func (api *Client) GetScheduledMessagesContext(ctx context.Context, params *GetScheduledMessagesParameters) (channels []ScheduledMessage, nextCursor string, err error) {
|
2020-03-28 22:50:47 +00:00
|
|
|
values := url.Values{
|
|
|
|
"token": {api.token},
|
|
|
|
}
|
|
|
|
if params.Channel != "" {
|
|
|
|
values.Add("channel", params.Channel)
|
|
|
|
}
|
|
|
|
if params.Cursor != "" {
|
|
|
|
values.Add("cursor", params.Cursor)
|
|
|
|
}
|
|
|
|
if params.Limit != 0 {
|
|
|
|
values.Add("limit", strconv.Itoa(params.Limit))
|
|
|
|
}
|
|
|
|
if params.Latest != "" {
|
|
|
|
values.Add("latest", params.Latest)
|
|
|
|
}
|
|
|
|
if params.Oldest != "" {
|
|
|
|
values.Add("oldest", params.Oldest)
|
|
|
|
}
|
|
|
|
response := struct {
|
2020-10-11 21:07:00 +00:00
|
|
|
Messages []ScheduledMessage `json:"scheduled_messages"`
|
|
|
|
ResponseMetaData responseMetaData `json:"response_metadata"`
|
2020-03-28 22:50:47 +00:00
|
|
|
SlackResponse
|
|
|
|
}{}
|
|
|
|
|
|
|
|
err = api.postMethod(ctx, "chat.scheduledMessages.list", values, &response)
|
|
|
|
if err != nil {
|
|
|
|
return nil, "", err
|
|
|
|
}
|
|
|
|
|
|
|
|
return response.Messages, response.ResponseMetaData.NextCursor, response.Err()
|
|
|
|
}
|
|
|
|
|
|
|
|
type DeleteScheduledMessageParameters struct {
|
|
|
|
Channel string
|
|
|
|
ScheduledMessageID string
|
|
|
|
AsUser bool
|
|
|
|
}
|
|
|
|
|
|
|
|
// DeleteScheduledMessage returns the list of scheduled messages based on params
|
|
|
|
func (api *Client) DeleteScheduledMessage(params *DeleteScheduledMessageParameters) (bool, error) {
|
|
|
|
return api.DeleteScheduledMessageContext(context.Background(), params)
|
|
|
|
}
|
|
|
|
|
|
|
|
// DeleteScheduledMessageContext returns the list of scheduled messages in a Slack team with a custom context
|
|
|
|
func (api *Client) DeleteScheduledMessageContext(ctx context.Context, params *DeleteScheduledMessageParameters) (bool, error) {
|
|
|
|
values := url.Values{
|
|
|
|
"token": {api.token},
|
|
|
|
"channel": {params.Channel},
|
|
|
|
"scheduled_message_id": {params.ScheduledMessageID},
|
|
|
|
"as_user": {strconv.FormatBool(params.AsUser)},
|
|
|
|
}
|
|
|
|
response := struct {
|
|
|
|
SlackResponse
|
|
|
|
}{}
|
|
|
|
|
|
|
|
err := api.postMethod(ctx, "chat.deleteScheduledMessage", values, &response)
|
|
|
|
if err != nil {
|
|
|
|
return false, err
|
|
|
|
}
|
|
|
|
|
|
|
|
return response.Ok, response.Err()
|
|
|
|
}
|