bots

Documentation

Overview

Package bots is a lightweight wrapper over the "bots" methods in Slack's Web API: https://api.slack.com/methods?filter=bots.

Index

• type API
  • func (a API) Info(ctx context.Context, args []sdktypes.Value, kwargs map[string]sdktypes.Value) (sdktypes.Value, error)
• type Bot
• type InfoResponse
  • func InfoWithToken(ctx context.Context, secrets sdkservices.Secrets, scope, botToken string, ...) (*InfoResponse, error)

Types

type API

type API struct {
	Secrets sdkservices.Secrets
	Scope   string
}

func (API) Info

func (a API) Info(ctx context.Context, args []sdktypes.Value, kwargs map[string]sdktypes.Value) (sdktypes.Value, error)

Info gets information about a bot user. Based on: https://api.slack.com/methods/bots.info. Required Slack app scopes: https://api.slack.com/scopes/users:read.

type Bot

type Bot struct {
	ID      string            `json:"id,omitempty"`
	Deleted bool              `json:"deleted,omitempty"`
	Name    string            `json:"name,omitempty"`
	Updated int               `json:"updated,omitempty"`
	AppID   string            `json:"app_id,omitempty"`
	UserID  string            `json:"user_id,omitempty"`
	Icons   map[string]string `json:"icons,omitempty"`
}

https://api.slack.com/methods/bots.info#examples

type InfoResponse

type InfoResponse struct {
	api.SlackResponse

	Bot Bot `json:"bot,omitempty"`
}

https://api.slack.com/methods/bots.info#examples

func InfoWithToken

func InfoWithToken(ctx context.Context, secrets sdkservices.Secrets, scope, botToken string, authTest *auth.TestResponse) (*InfoResponse, error)

Info is only used internally, to check the usability of a bot token.