api

Documentation

Index

• Constants
• Variables
• func PostForm(ctx context.Context, vars sdkservices.Vars, kv url.Values, resp any, ...) error
• func PostJSON(ctx context.Context, vars sdkservices.Vars, req, resp any, slackMethod string) error
• type ResponseMetadata
• type SlackResponse

Constants

const (
	HeaderContentType    = "Content-Type"
	HeaderSlackTimestamp = "X-Slack-Request-Timestamp"
	HeaderSlackSignature = "X-Slack-Signature"
	HeaderAuthorization  = "Authorization"

	ContentTypeForm            = "application/x-www-form-urlencoded"
	ContentTypeJSONCharsetUTF8 = "application/json; charset=utf-8"
	ContentTypeJSON            = "application/json"

	// Timeout for short-lived outbound HTTP POST requests.
	Timeout = 3 * time.Second
)

Variables

var OAuthTokenContextKey = ctxKey("OAuthTokenContext")

Functions

func PostForm

func PostForm(ctx context.Context, vars sdkservices.Vars, kv url.Values, resp any, slackMethod string) error

PostForm sends a short-lived HTTP POST request with an OAuth bearer token and URL-encoded key/value payload, and then receives and parses the JSON response.

func PostJSON

func PostJSON(ctx context.Context, vars sdkservices.Vars, req, resp any, slackMethod string) error

PostJSON sends a short-lived HTTP POST request with an OAuth bearer token and JSON payload, and then receives and parses the JSON response.

Types

type ResponseMetadata

type ResponseMetadata struct {
	Messages   []string `json:"messages,omitempty"`
	Warnings   []string `json:"warnings,omitempty"`
	NextCursor string   `json:"next_cursor,omitempty"`
}

type SlackResponse

type SlackResponse struct {
	OK               bool              `json:"ok"`
	Warning          string            `json:"warning,omitempty"`
	Error            string            `json:"error,omitempty"`
	ResponseMetadata *ResponseMetadata `json:"response_metadata,omitempty"`
}