integration

Documentation

Index

• type Setting
  • func WithEnableEmoticons(yes bool) Setting
  • func WithExpireBehavior(t int) Setting
  • func WithExpireGracePeriod(t int) Setting
• type Settings
  • func NewSettings(opts ...Setting) *Settings

Types

type Setting

type Setting func(*Settings)

Setting is a function that configures an integration.

func WithEnableEmoticons

func WithEnableEmoticons(yes bool) Setting

WithEnableEmoticons sets whether emoticons are enabled for an integration.

func WithExpireBehavior

func WithExpireBehavior(t int) Setting

WithExpireBehavior sets the expiration behaviour of an integration.

func WithExpireGracePeriod

func WithExpireGracePeriod(t int) Setting

WithExpireGracePeriod sets the expire grace period of an integration.

type Settings

type Settings struct {
	// The behavior when an integration subscription lapses.
	ExpireBehavior *optional.Int
	// Period (in seconds) where the integration will ignore lapsed subscriptions.
	ExpireGracePeriod *optional.Int
	// Whether emoticons should be synced for this integration (twitch only currently).
	EnableEmoticons *optional.Bool
}

Settings describes a guild integration's settings.

func NewSettings

func NewSettings(opts ...Setting) *Settings

NewSettings returns new Settings to modify an integration.