Calamity.Types.Model.Guild.Role

Guild roles

Documentation

data Role

Constructors

Role

Fields

• id :: Snowflake Role
• name :: Text
• color :: Colour Double
• hoist :: Bool
• icon :: Maybe RoleIcon
• emoji :: Maybe RawEmoji
• position :: Int
• permissions :: Permissions
• managed :: Bool
• mentionable :: Bool

Instances

FromJSON Role

Defined in Calamity.Types.Model.Guild.Role

Methods

parseJSON :: Value -> Parser Role

parseJSONList :: Value -> Parser [Role]

ToJSON Role

Defined in Calamity.Types.Model.Guild.Role

Methods

toJSON :: Role -> Value

toEncoding :: Role -> Encoding

toJSONList :: [Role] -> Value

toEncodingList :: [Role] -> Encoding

Show Role

Defined in Calamity.Types.Model.Guild.Role

Methods

showsPrec :: Int -> Role -> ShowS

show :: Role -> String

showList :: [Role] -> ShowS

CalamityToJSON' Role

Defined in Calamity.Types.Model.Guild.Role

Methods

toPairs :: KeyValue kv => Role -> [Maybe kv]

Mentionable Role

Defined in Calamity.Utils.Message

Methods

mention :: Role -> Text

Eq Role

Defined in Calamity.Types.Model.Guild.Role

Methods

(==) :: Role -> Role -> Bool

(/=) :: Role -> Role -> Bool

TextShow Role

Defined in Calamity.Types.Model.Guild.Role

Methods

showbPrec :: Int -> Role -> Builder

showb :: Role -> Builder

showbList :: [Role] -> Builder

showtPrec :: Int -> Role -> Text

showt :: Role -> Text

showtList :: [Role] -> Text

showtlPrec :: Int -> Role -> Text

showtl :: Role -> Text

showtlList :: [Role] -> Text

HasID Role Role

Defined in Calamity.Types.Model.Guild.Role

Methods

getID :: Role -> Snowflake Role

(Member (CacheEff :: (Type -> Type) -> Type -> Type) r, CalamityCommandContext c) => ParameterParser Role c r

ParameterParser for roles in the guild the command was invoked in, this only looks in the cache. Use Snowflake Role and use upgrade if you want to allow fetching from http.

Defined in Calamity.Commands.CalamityParsers

Associated Types

type ParserResult Role

Methods

parameterInfo :: ParameterInfo

parameterDescription :: Text

parse :: Sem (ParserEffs c r) (ParserResult Role)

(k ~ A_Lens, a ~ Colour Double, b ~ Colour Double) => LabelOptic "color" k Role Role a b

Defined in Calamity.Types.Model.Guild.Role

Methods

labelOptic :: Optic k NoIx Role Role a b

(k ~ A_Lens, a ~ Maybe RawEmoji, b ~ Maybe RawEmoji) => LabelOptic "emoji" k Role Role a b

Defined in Calamity.Types.Model.Guild.Role

Methods

labelOptic :: Optic k NoIx Role Role a b

(k ~ A_Lens, a ~ Bool, b ~ Bool) => LabelOptic "hoist" k Role Role a b

Defined in Calamity.Types.Model.Guild.Role

Methods

labelOptic :: Optic k NoIx Role Role a b

(k ~ A_Lens, a ~ Maybe RoleIcon, b ~ Maybe RoleIcon) => LabelOptic "icon" k Role Role a b

Defined in Calamity.Types.Model.Guild.Role

Methods

labelOptic :: Optic k NoIx Role Role a b

(k ~ A_Lens, a ~ Snowflake Role, b ~ Snowflake Role) => LabelOptic "id" k Role Role a b

Defined in Calamity.Types.Model.Guild.Role

Methods

labelOptic :: Optic k NoIx Role Role a b

(k ~ A_Lens, a ~ Bool, b ~ Bool) => LabelOptic "managed" k Role Role a b

Defined in Calamity.Types.Model.Guild.Role

Methods

labelOptic :: Optic k NoIx Role Role a b

(k ~ A_Lens, a ~ Bool, b ~ Bool) => LabelOptic "mentionable" k Role Role a b

Defined in Calamity.Types.Model.Guild.Role

Methods

labelOptic :: Optic k NoIx Role Role a b

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "name" k Role Role a b

Defined in Calamity.Types.Model.Guild.Role

Methods

labelOptic :: Optic k NoIx Role Role a b

(k ~ A_Lens, a ~ Permissions, b ~ Permissions) => LabelOptic "permissions" k Role Role a b

Defined in Calamity.Types.Model.Guild.Role

Methods

labelOptic :: Optic k NoIx Role Role a b

(k ~ A_Lens, a ~ Int, b ~ Int) => LabelOptic "position" k Role Role a b

Defined in Calamity.Types.Model.Guild.Role

Methods

labelOptic :: Optic k NoIx Role Role a b

Upgradeable Role (Snowflake Guild, Snowflake Role)

Defined in Calamity.Types.Upgradeable

Methods

upgrade :: forall (r :: EffectRow). BotC r => (Snowflake Guild, Snowflake Role) -> Sem r (Maybe Role)

ToMessage (TMention Role)

Add a Role id to the list of allowed role mentions

Defined in Calamity.Types.Tellable

Methods

intoMsg :: TMention Role -> Endo CreateMessageOptions

Mentionable (Snowflake Role)

Defined in Calamity.Utils.Message

Methods

mention :: Snowflake Role -> Text

ParameterParser (Snowflake Role) c r

Accepts both plain IDs and mentions

Defined in Calamity.Commands.CalamityParsers

Associated Types

type ParserResult (Snowflake Role)

Methods

parameterInfo :: ParameterInfo

parameterDescription :: Text

parse :: Sem (ParserEffs c r) (ParserResult (Snowflake Role))

type ParserResult Role

Defined in Calamity.Commands.CalamityParsers

type ParserResult Role = Role

type ParserResult (Snowflake Role)

Defined in Calamity.Commands.CalamityParsers

type ParserResult (Snowflake Role) = Snowflake Role

data RoleIcon

Constructors

RoleIcon

Fields

• roleID :: Snowflake Role
• hash :: Text

Instances

Show RoleIcon

Defined in Calamity.Types.Model.Guild.Role

Methods

showsPrec :: Int -> RoleIcon -> ShowS

show :: RoleIcon -> String

showList :: [RoleIcon] -> ShowS

CDNAsset RoleIcon

Defined in Calamity.Types.Model.Guild.Role

Methods

assetURL :: RoleIcon -> Url 'Https

Eq RoleIcon

Defined in Calamity.Types.Model.Guild.Role

Methods

(==) :: RoleIcon -> RoleIcon -> Bool

(/=) :: RoleIcon -> RoleIcon -> Bool