summaryrefslogtreecommitdiffstats
path: root/vendor/github.com/slack-go/slack/channels.go
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/github.com/slack-go/slack/channels.go')
-rw-r--r--vendor/github.com/slack-go/slack/channels.go412
1 files changed, 412 insertions, 0 deletions
diff --git a/vendor/github.com/slack-go/slack/channels.go b/vendor/github.com/slack-go/slack/channels.go
new file mode 100644
index 00000000..c99e6655
--- /dev/null
+++ b/vendor/github.com/slack-go/slack/channels.go
@@ -0,0 +1,412 @@
+package slack
+
+import (
+ "context"
+ "net/url"
+ "strconv"
+)
+
+type channelResponseFull struct {
+ Channel Channel `json:"channel"`
+ Channels []Channel `json:"channels"`
+ Purpose string `json:"purpose"`
+ Topic string `json:"topic"`
+ NotInChannel bool `json:"not_in_channel"`
+ History
+ SlackResponse
+}
+
+// Channel contains information about the channel
+type Channel struct {
+ GroupConversation
+ IsChannel bool `json:"is_channel"`
+ IsGeneral bool `json:"is_general"`
+ IsMember bool `json:"is_member"`
+ Locale string `json:"locale"`
+}
+
+func (api *Client) channelRequest(ctx context.Context, path string, values url.Values) (*channelResponseFull, error) {
+ response := &channelResponseFull{}
+ err := postForm(ctx, api.httpclient, api.endpoint+path, values, response, api)
+ if err != nil {
+ return nil, err
+ }
+
+ return response, response.Err()
+}
+
+type channelsConfig struct {
+ values url.Values
+}
+
+// GetChannelsOption option provided when getting channels.
+type GetChannelsOption func(*channelsConfig) error
+
+// GetChannelsOptionExcludeMembers excludes the members collection from each channel.
+func GetChannelsOptionExcludeMembers() GetChannelsOption {
+ return func(config *channelsConfig) error {
+ config.values.Add("exclude_members", "true")
+ return nil
+ }
+}
+
+// GetChannelsOptionExcludeArchived excludes archived channels from results.
+func GetChannelsOptionExcludeArchived() GetChannelsOption {
+ return func(config *channelsConfig) error {
+ config.values.Add("exclude_archived", "true")
+ return nil
+ }
+}
+
+// ArchiveChannel archives the given channel
+// see https://api.slack.com/methods/channels.archive
+func (api *Client) ArchiveChannel(channelID string) error {
+ return api.ArchiveChannelContext(context.Background(), channelID)
+}
+
+// ArchiveChannelContext archives the given channel with a custom context
+// see https://api.slack.com/methods/channels.archive
+func (api *Client) ArchiveChannelContext(ctx context.Context, channelID string) (err error) {
+ values := url.Values{
+ "token": {api.token},
+ "channel": {channelID},
+ }
+
+ _, err = api.channelRequest(ctx, "channels.archive", values)
+ return err
+}
+
+// UnarchiveChannel unarchives the given channel
+// see https://api.slack.com/methods/channels.unarchive
+func (api *Client) UnarchiveChannel(channelID string) error {
+ return api.UnarchiveChannelContext(context.Background(), channelID)
+}
+
+// UnarchiveChannelContext unarchives the given channel with a custom context
+// see https://api.slack.com/methods/channels.unarchive
+func (api *Client) UnarchiveChannelContext(ctx context.Context, channelID string) (err error) {
+ values := url.Values{
+ "token": {api.token},
+ "channel": {channelID},
+ }
+
+ _, err = api.channelRequest(ctx, "channels.unarchive", values)
+ return err
+}
+
+// CreateChannel creates a channel with the given name and returns a *Channel
+// see https://api.slack.com/methods/channels.create
+func (api *Client) CreateChannel(channelName string) (*Channel, error) {
+ return api.CreateChannelContext(context.Background(), channelName)
+}
+
+// CreateChannelContext creates a channel with the given name and returns a *Channel with a custom context
+// see https://api.slack.com/methods/channels.create
+func (api *Client) CreateChannelContext(ctx context.Context, channelName string) (*Channel, error) {
+ values := url.Values{
+ "token": {api.token},
+ "name": {channelName},
+ }
+
+ response, err := api.channelRequest(ctx, "channels.create", values)
+ if err != nil {
+ return nil, err
+ }
+ return &response.Channel, nil
+}
+
+// GetChannelHistory retrieves the channel history
+// see https://api.slack.com/methods/channels.history
+func (api *Client) GetChannelHistory(channelID string, params HistoryParameters) (*History, error) {
+ return api.GetChannelHistoryContext(context.Background(), channelID, params)
+}
+
+// GetChannelHistoryContext retrieves the channel history with a custom context
+// see https://api.slack.com/methods/channels.history
+func (api *Client) GetChannelHistoryContext(ctx context.Context, channelID string, params HistoryParameters) (*History, error) {
+ values := url.Values{
+ "token": {api.token},
+ "channel": {channelID},
+ }
+ if params.Latest != DEFAULT_HISTORY_LATEST {
+ values.Add("latest", params.Latest)
+ }
+ if params.Oldest != DEFAULT_HISTORY_OLDEST {
+ values.Add("oldest", params.Oldest)
+ }
+ if params.Count != DEFAULT_HISTORY_COUNT {
+ values.Add("count", strconv.Itoa(params.Count))
+ }
+ if params.Inclusive != DEFAULT_HISTORY_INCLUSIVE {
+ if params.Inclusive {
+ values.Add("inclusive", "1")
+ } else {
+ values.Add("inclusive", "0")
+ }
+ }
+
+ if params.Unreads != DEFAULT_HISTORY_UNREADS {
+ if params.Unreads {
+ values.Add("unreads", "1")
+ } else {
+ values.Add("unreads", "0")
+ }
+ }
+
+ response, err := api.channelRequest(ctx, "channels.history", values)
+ if err != nil {
+ return nil, err
+ }
+ return &response.History, nil
+}
+
+// GetChannelInfo retrieves the given channel
+// see https://api.slack.com/methods/channels.info
+func (api *Client) GetChannelInfo(channelID string) (*Channel, error) {
+ return api.GetChannelInfoContext(context.Background(), channelID)
+}
+
+// GetChannelInfoContext retrieves the given channel with a custom context
+// see https://api.slack.com/methods/channels.info
+func (api *Client) GetChannelInfoContext(ctx context.Context, channelID string) (*Channel, error) {
+ values := url.Values{
+ "token": {api.token},
+ "channel": {channelID},
+ "include_locale": {strconv.FormatBool(true)},
+ }
+
+ response, err := api.channelRequest(ctx, "channels.info", values)
+ if err != nil {
+ return nil, err
+ }
+ return &response.Channel, nil
+}
+
+// InviteUserToChannel invites a user to a given channel and returns a *Channel
+// see https://api.slack.com/methods/channels.invite
+func (api *Client) InviteUserToChannel(channelID, user string) (*Channel, error) {
+ return api.InviteUserToChannelContext(context.Background(), channelID, user)
+}
+
+// InviteUserToChannelContext invites a user to a given channel and returns a *Channel with a custom context
+// see https://api.slack.com/methods/channels.invite
+func (api *Client) InviteUserToChannelContext(ctx context.Context, channelID, user string) (*Channel, error) {
+ values := url.Values{
+ "token": {api.token},
+ "channel": {channelID},
+ "user": {user},
+ }
+
+ response, err := api.channelRequest(ctx, "channels.invite", values)
+ if err != nil {
+ return nil, err
+ }
+ return &response.Channel, nil
+}
+
+// JoinChannel joins the currently authenticated user to a channel
+// see https://api.slack.com/methods/channels.join
+func (api *Client) JoinChannel(channelName string) (*Channel, error) {
+ return api.JoinChannelContext(context.Background(), channelName)
+}
+
+// JoinChannelContext joins the currently authenticated user to a channel with a custom context
+// see https://api.slack.com/methods/channels.join
+func (api *Client) JoinChannelContext(ctx context.Context, channelName string) (*Channel, error) {
+ values := url.Values{
+ "token": {api.token},
+ "name": {channelName},
+ }
+
+ response, err := api.channelRequest(ctx, "channels.join", values)
+ if err != nil {
+ return nil, err
+ }
+ return &response.Channel, nil
+}
+
+// LeaveChannel makes the authenticated user leave the given channel
+// see https://api.slack.com/methods/channels.leave
+func (api *Client) LeaveChannel(channelID string) (bool, error) {
+ return api.LeaveChannelContext(context.Background(), channelID)
+}
+
+// LeaveChannelContext makes the authenticated user leave the given channel with a custom context
+// see https://api.slack.com/methods/channels.leave
+func (api *Client) LeaveChannelContext(ctx context.Context, channelID string) (bool, error) {
+ values := url.Values{
+ "token": {api.token},
+ "channel": {channelID},
+ }
+
+ response, err := api.channelRequest(ctx, "channels.leave", values)
+ if err != nil {
+ return false, err
+ }
+
+ return response.NotInChannel, nil
+}
+
+// KickUserFromChannel kicks a user from a given channel
+// see https://api.slack.com/methods/channels.kick
+func (api *Client) KickUserFromChannel(channelID, user string) error {
+ return api.KickUserFromChannelContext(context.Background(), channelID, user)
+}
+
+// KickUserFromChannelContext kicks a user from a given channel with a custom context
+// see https://api.slack.com/methods/channels.kick
+func (api *Client) KickUserFromChannelContext(ctx context.Context, channelID, user string) (err error) {
+ values := url.Values{
+ "token": {api.token},
+ "channel": {channelID},
+ "user": {user},
+ }
+
+ _, err = api.channelRequest(ctx, "channels.kick", values)
+ return err
+}
+
+// GetChannels retrieves all the channels
+// see https://api.slack.com/methods/channels.list
+func (api *Client) GetChannels(excludeArchived bool, options ...GetChannelsOption) ([]Channel, error) {
+ return api.GetChannelsContext(context.Background(), excludeArchived, options...)
+}
+
+// GetChannelsContext retrieves all the channels with a custom context
+// see https://api.slack.com/methods/channels.list
+func (api *Client) GetChannelsContext(ctx context.Context, excludeArchived bool, options ...GetChannelsOption) ([]Channel, error) {
+ config := channelsConfig{
+ values: url.Values{
+ "token": {api.token},
+ },
+ }
+
+ if excludeArchived {
+ options = append(options, GetChannelsOptionExcludeArchived())
+ }
+
+ for _, opt := range options {
+ if err := opt(&config); err != nil {
+ return nil, err
+ }
+ }
+
+ response, err := api.channelRequest(ctx, "channels.list", config.values)
+ if err != nil {
+ return nil, err
+ }
+ return response.Channels, nil
+}
+
+// SetChannelReadMark sets the read mark of a given channel to a specific point
+// Clients should try to avoid making this call too often. When needing to mark a read position, a client should set a
+// timer before making the call. In this way, any further updates needed during the timeout will not generate extra calls
+// (just one per channel). This is useful for when reading scroll-back history, or following a busy live channel. A
+// timeout of 5 seconds is a good starting point. Be sure to flush these calls on shutdown/logout.
+// see https://api.slack.com/methods/channels.mark
+func (api *Client) SetChannelReadMark(channelID, ts string) error {
+ return api.SetChannelReadMarkContext(context.Background(), channelID, ts)
+}
+
+// SetChannelReadMarkContext sets the read mark of a given channel to a specific point with a custom context
+// For more details see SetChannelReadMark documentation
+// see https://api.slack.com/methods/channels.mark
+func (api *Client) SetChannelReadMarkContext(ctx context.Context, channelID, ts string) (err error) {
+ values := url.Values{
+ "token": {api.token},
+ "channel": {channelID},
+ "ts": {ts},
+ }
+
+ _, err = api.channelRequest(ctx, "channels.mark", values)
+ return err
+}
+
+// RenameChannel renames a given channel
+// see https://api.slack.com/methods/channels.rename
+func (api *Client) RenameChannel(channelID, name string) (*Channel, error) {
+ return api.RenameChannelContext(context.Background(), channelID, name)
+}
+
+// RenameChannelContext renames a given channel with a custom context
+// see https://api.slack.com/methods/channels.rename
+func (api *Client) RenameChannelContext(ctx context.Context, channelID, name string) (*Channel, error) {
+ values := url.Values{
+ "token": {api.token},
+ "channel": {channelID},
+ "name": {name},
+ }
+
+ // XXX: the created entry in this call returns a string instead of a number
+ // so I may have to do some workaround to solve it.
+ response, err := api.channelRequest(ctx, "channels.rename", values)
+ if err != nil {
+ return nil, err
+ }
+ return &response.Channel, nil
+}
+
+// SetChannelPurpose sets the channel purpose and returns the purpose that was successfully set
+// see https://api.slack.com/methods/channels.setPurpose
+func (api *Client) SetChannelPurpose(channelID, purpose string) (string, error) {
+ return api.SetChannelPurposeContext(context.Background(), channelID, purpose)
+}
+
+// SetChannelPurposeContext sets the channel purpose and returns the purpose that was successfully set with a custom context
+// see https://api.slack.com/methods/channels.setPurpose
+func (api *Client) SetChannelPurposeContext(ctx context.Context, channelID, purpose string) (string, error) {
+ values := url.Values{
+ "token": {api.token},
+ "channel": {channelID},
+ "purpose": {purpose},
+ }
+
+ response, err := api.channelRequest(ctx, "channels.setPurpose", values)
+ if err != nil {
+ return "", err
+ }
+ return response.Purpose, nil
+}
+
+// SetChannelTopic sets the channel topic and returns the topic that was successfully set
+// see https://api.slack.com/methods/channels.setTopic
+func (api *Client) SetChannelTopic(channelID, topic string) (string, error) {
+ return api.SetChannelTopicContext(context.Background(), channelID, topic)
+}
+
+// SetChannelTopicContext sets the channel topic and returns the topic that was successfully set with a custom context
+// see https://api.slack.com/methods/channels.setTopic
+func (api *Client) SetChannelTopicContext(ctx context.Context, channelID, topic string) (string, error) {
+ values := url.Values{
+ "token": {api.token},
+ "channel": {channelID},
+ "topic": {topic},
+ }
+
+ response, err := api.channelRequest(ctx, "channels.setTopic", values)
+ if err != nil {
+ return "", err
+ }
+ return response.Topic, nil
+}
+
+// GetChannelReplies gets an entire thread (a message plus all the messages in reply to it).
+// see https://api.slack.com/methods/channels.replies
+func (api *Client) GetChannelReplies(channelID, thread_ts string) ([]Message, error) {
+ return api.GetChannelRepliesContext(context.Background(), channelID, thread_ts)
+}
+
+// GetChannelRepliesContext gets an entire thread (a message plus all the messages in reply to it) with a custom context
+// see https://api.slack.com/methods/channels.replies
+func (api *Client) GetChannelRepliesContext(ctx context.Context, channelID, thread_ts string) ([]Message, error) {
+ values := url.Values{
+ "token": {api.token},
+ "channel": {channelID},
+ "thread_ts": {thread_ts},
+ }
+ response, err := api.channelRequest(ctx, "channels.replies", values)
+ if err != nil {
+ return nil, err
+ }
+ return response.History.Messages, nil
+}