mute

Documentation

Overview

Package mute implements a channel/guild muted state. It automatically updates.

Index

• type State
  • func NewState(store state.Store, r handlerrepo.AddHandler) *State
  • func (m *State) Category(channelID discord.ChannelID) bool
  • func (m *State) Channel(channelID discord.ChannelID) bool
  • func (m *State) ChannelOverrides(channelID discord.ChannelID) *gateway.SettingsChannelOverride
  • func (m *State) Guild(guildID discord.GuildID, everyone bool) bool
  • func (m *State) GuildSettings(guildID discord.GuildID) *gateway.UserGuildSettings

Types

type State

type State struct {
	// contains filtered or unexported fields
}

State implements a queryable channel and guild mute state.

func NewState

func NewState(store state.Store, r handlerrepo.AddHandler) *State

func (*State) Category

func (m *State) Category(channelID discord.ChannelID) bool

CategoryMuted returns whether or not the channel's category is muted.

func (*State) Channel

func (m *State) Channel(channelID discord.ChannelID) bool

Channel returns whether or not the channel is muted.

func (*State) ChannelOverrides

func (m *State) ChannelOverrides(channelID discord.ChannelID) *gateway.SettingsChannelOverride

func (*State) Guild

func (m *State) Guild(guildID discord.GuildID, everyone bool) bool

Guild returns whether or not the ping should mention. It works with @everyone if everyone is true.

func (*State) GuildSettings

func (m *State) GuildSettings(guildID discord.GuildID) *gateway.UserGuildSettings