slackkit

Documentation

Index

• type Block
  • func NewDivider() Block
  • func NewHeader(text string, emoji bool) Block
  • func NewSection(text string, emoji bool) Block
• type BlockType
• type Error
  • func (e Error) Error() string
• type Notification
  • func NewNotification(blocks ...Block) (*Notification, error)
• type Style
• type Text
• type TextType

Types

type Block

type Block struct {
	Type BlockType `json:"type"`
	Text *Text     `json:"text,omitempty"`
}

Block is a single block of a notification.

func NewDivider

func NewDivider() Block

NewDivider creates a new divider block.

func NewHeader

func NewHeader(text string, emoji bool) Block

NewHeader creates a new header block.

func NewSection

func NewSection(text string, emoji bool) Block

NewSection creates a new section block.

type BlockType

type BlockType string

Block types are defined in the Slack API documentation.

const (
	Header  BlockType = "header"
	Divider BlockType = "divider"
	Section BlockType = "section"
)

Block types are defined in the Slack API documentation.

type Error

type Error string

Error is a custom error type for Slack notifications.

const (
	// ErrNilBlock is returned when a block is nil.
	ErrNilBlock Error = "nil block"

	// ErrNilText is returned when a text is nil.
	ErrNilText Error = "nil text"

	// ErrInvalidBlockType is returned when a block type is invalid.
	ErrInvalidBlockType Error = "invalid block type"

	// ErrInvalidBlockTextType is returned when a block text type is invalid.
	ErrInvalidBlockTextType Error = "invalid block text type"

	// ErrInvalidBlockTextStyle is returned when a block text style is invalid.
	ErrInvalidBlockTextStyle Error = "invalid block text style"

	// ErrInvalidBlockTextEmoji is returned when a block text emoji is invalid.
	ErrInvalidBlockTextEmoji Error = "invalid block text emoji"
)

Slack notification errors.

func (Error) Error

func (e Error) Error() string

type Notification

type Notification struct {
	Blocks []Block `json:"blocks"`
}

Notification is the main struct for sending notifications to Slack.

func NewNotification

func NewNotification(blocks ...Block) (*Notification, error)

NewNotification creates a new notification.

type Style

type Style struct {
	Bold   *bool `json:"bold,omitempty"`
	Italic *bool `json:"italic,omitempty"`
	Strike *bool `json:"strike,omitempty"`
}

Style is a style block of a notification.

type Text

type Text struct {
	Type  TextType `json:"type"`
	Text  string   `json:"text"`
	Emoji *bool    `json:"emoji,omitempty"`
	Style *Style   `json:"style,omitempty"`
}

Text is a single text block of a notification.

type TextType

type TextType string

Text types are defined in the Slack API documentation.

const (
	// PlainText is the default text type.
	PlainText TextType = "plain_text"

	// Markdown is the markdown text type.
	Markdown TextType = "mrkdwn"
)