Calamity.Utils.Permissions

Permission utilities

Documentation

basePermissions :: Guild -> Member -> Permissions

Calculate a Member's Permissions in a Guild

applyOverwrites :: GuildChannel -> Member -> Permissions -> Permissions

Apply any Overwrites for a GuildChannel onto some Permissions

class PermissionsIn a where

Things that Members have Permissions in

Methods

permissionsIn :: a -> Member -> Permissions

Calculate a Member's Permissions in something

If permissions could not be calculated because something couldn't be found in the cache, this will return an empty set of permissions. Use permissionsIn' if you want to handle cases where something might not exist in cache.

Instances

PermissionsIn Guild

A Member's Permissions in a guild are just their roles

Defined in Calamity.Utils.Permissions

Methods

permissionsIn :: Guild -> Member -> Permissions

PermissionsIn (Guild, GuildChannel)

A Member's Permissions in a channel are their roles and overwrites

Defined in Calamity.Utils.Permissions

Methods

permissionsIn :: (Guild, GuildChannel) -> Member -> Permissions

class PermissionsIn' a where

A variant of PermissionsIn that will use the cache/http.

Methods

permissionsIn' :: (BotC r, HasID User u) => a -> u -> Sem r Permissions

Calculate the permissions of something that has a User id

Instances

PermissionsIn' GuildChannel

A User's Permissions in a channel are their roles and overwrites

This will fetch the guild from the cache or http as needed

Defined in Calamity.Utils.Permissions

Methods

permissionsIn' :: forall (r :: EffectRow) u. (BotC r, HasID User u) => GuildChannel -> u -> Sem r Permissions

PermissionsIn' Guild

A Member's Permissions in a guild are just their roles

Defined in Calamity.Utils.Permissions

Methods

permissionsIn' :: forall (r :: EffectRow) u. (BotC r, HasID User u) => Guild -> u -> Sem r Permissions

PermissionsIn' (Snowflake GuildChannel)

A Member's Permissions in a channel are their roles and overwrites

This will fetch the guild and channel from the cache or http as needed

Defined in Calamity.Utils.Permissions

Methods

permissionsIn' :: forall (r :: EffectRow) u. (BotC r, HasID User u) => Snowflake GuildChannel -> u -> Sem r Permissions

PermissionsIn' (Snowflake Guild)

A Member's Permissions in a guild are just their roles

This will fetch the guild from the cache or http as needed

Defined in Calamity.Utils.Permissions

Methods

permissionsIn' :: forall (r :: EffectRow) u. (BotC r, HasID User u) => Snowflake Guild -> u -> Sem r Permissions