Calamity.Types.Model.User

A User

Documentation

data User

Constructors

User

Fields

• id :: Snowflake User
• username :: Text
• discriminator :: Text
• bot :: Maybe Bool
• avatar :: Avatar
• mfaEnabled :: Maybe Bool
• banner :: Maybe UserBanner
• accentColour :: Maybe (Colour Double)
• locale :: Maybe Text
• verified :: Maybe Bool
• email :: Maybe Text
• flags :: Maybe Word64
• premiumType :: Maybe Word64

Instances

Eq User

Defined in Calamity.Types.Model.User

Methods

(==) :: User -> User -> Bool

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

Show User

Defined in Calamity.Types.Model.User

Methods

showsPrec :: Int -> User -> ShowS

show :: User -> String

showList :: [User] -> ShowS

FromJSON User

Defined in Calamity.Types.Model.User

Methods

parseJSON :: Value -> Parser User

parseJSONList :: Value -> Parser [User]

TextShow User

Defined in Calamity.Types.Model.User

Methods

showbPrec :: Int -> User -> Builder

showb :: User -> Builder

showbList :: [User] -> Builder

showtPrec :: Int -> User -> Text

showt :: User -> Text

showtList :: [User] -> Text

showtlPrec :: Int -> User -> Text

showtl :: User -> Text

showtlList :: [User] -> Text

Updateable User

Defined in Calamity.Internal.Updateable

Associated Types

type Updated User

Methods

update :: Updated User -> User -> User

Tellable User

Defined in Calamity.Types.Tellable

Methods

getChannel :: forall (r :: [(Type -> Type) -> Type -> Type]). (BotC r, Member (Error RestError) r) => User -> Sem r (Snowflake Channel)

Mentionable User

Defined in Calamity.Utils.Message

Methods

mention :: User -> Text

HasID Member User

Defined in Calamity.Types.Model.User

Methods

getID :: User -> Snowflake Member

HasID User Message

Defined in Calamity.Types.Model.Channel.Message

Methods

getID :: Message -> Snowflake User

HasID User Member

Defined in Calamity.Types.Model.Guild.Member

Methods

getID :: Member -> Snowflake User

HasID User User

Defined in Calamity.Types.Model.User

Methods

getID :: User -> Snowflake User

HasID User Presence

Defined in Calamity.Types.Model.Presence.Presence

Methods

getID :: Presence -> Snowflake User

HasID User MessageAuthor

Defined in Calamity.Types.Model.Channel.Message

Methods

getID :: MessageAuthor -> Snowflake User

HasID User GroupChannel

Defined in Calamity.Types.Model.Channel.Group

Methods

getID :: GroupChannel -> Snowflake User

HasID User AuditLogEntry

Defined in Calamity.Types.Model.Guild.AuditLog

Methods

getID :: AuditLogEntry -> Snowflake User

HasID User BanData

Defined in Calamity.Types.Model.Guild.Ban

Methods

getID :: BanData -> Snowflake User

HasID User ReactionEvtData

Defined in Calamity.Gateway.DispatchEvents

Methods

getID :: ReactionEvtData -> Snowflake User

HasID User FullContext

Defined in Calamity.Commands.Context

Methods

getID :: FullContext -> Snowflake User

HasID User LightContext

Defined in Calamity.Commands.Context

Methods

getID :: LightContext -> Snowflake User

Member (CacheEff :: (Type -> Type) -> Type -> Type) r => ParameterParser User c r

ParameterParser for users, this only looks in the cache. Use Snowflake User and use upgrade if you want to allow fetching from http.

Defined in Calamity.Commands.CalamityParsers

Associated Types

type ParserResult User

Methods

parameterInfo :: ParameterInfo

parameterDescription :: Text

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

(k ~ A_Lens, a ~ Maybe (Colour Double), b ~ Maybe (Colour Double)) => LabelOptic "accentColour" k User User a b

Defined in Calamity.Types.Model.User

Methods

labelOptic :: Optic k NoIx User User a b

(k ~ A_Lens, a ~ Avatar, b ~ Avatar) => LabelOptic "avatar" k User User a b

Defined in Calamity.Types.Model.User

Methods

labelOptic :: Optic k NoIx User User a b

(k ~ A_Lens, a ~ Maybe UserBanner, b ~ Maybe UserBanner) => LabelOptic "banner" k User User a b

Defined in Calamity.Types.Model.User

Methods

labelOptic :: Optic k NoIx User User a b

(k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "bot" k User User a b

Defined in Calamity.Types.Model.User

Methods

labelOptic :: Optic k NoIx User User a b

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "discriminator" k User User a b

Defined in Calamity.Types.Model.User

Methods

labelOptic :: Optic k NoIx User User a b

(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "email" k User User a b

Defined in Calamity.Types.Model.User

Methods

labelOptic :: Optic k NoIx User User a b

(k ~ A_Lens, a ~ Maybe Word64, b ~ Maybe Word64) => LabelOptic "flags" k User User a b

Defined in Calamity.Types.Model.User

Methods

labelOptic :: Optic k NoIx User User a b

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

Defined in Calamity.Types.Model.User

Methods

labelOptic :: Optic k NoIx User User a b

(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "locale" k User User a b

Defined in Calamity.Types.Model.User

Methods

labelOptic :: Optic k NoIx User User a b

(k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "mfaEnabled" k User User a b

Defined in Calamity.Types.Model.User

Methods

labelOptic :: Optic k NoIx User User a b

(k ~ A_Lens, a ~ Maybe Word64, b ~ Maybe Word64) => LabelOptic "premiumType" k User User a b

Defined in Calamity.Types.Model.User

Methods

labelOptic :: Optic k NoIx User User a b

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "username" k User User a b

Defined in Calamity.Types.Model.User

Methods

labelOptic :: Optic k NoIx User User a b

(k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "verified" k User User a b

Defined in Calamity.Types.Model.User

Methods

labelOptic :: Optic k NoIx User User a b

(k ~ An_Iso, a ~ Snowflake User, b ~ Snowflake User) => LabelOptic "id" k (Partial User) (Partial User) a b

Defined in Calamity.Types.Model.User

Methods

labelOptic :: Optic k NoIx (Partial User) (Partial User) a b

HasID User (Partial User)

Defined in Calamity.Types.Model.User

Methods

getID :: Partial User -> Snowflake User

Upgradeable User (Snowflake User)

Defined in Calamity.Types.Upgradeable

Methods

upgrade :: forall (r :: [(Type -> Type) -> Type -> Type]). BotC r => Snowflake User -> Sem r (Maybe User)

Eq (Partial User)

Defined in Calamity.Types.Model.User

Methods

(==) :: Partial User -> Partial User -> Bool

(/=) :: Partial User -> Partial User -> Bool

Show (Partial User)

Defined in Calamity.Types.Model.User

Methods

showsPrec :: Int -> Partial User -> ShowS

show :: Partial User -> String

showList :: [Partial User] -> ShowS

FromJSON (Partial User)

Defined in Calamity.Types.Model.User

Methods

parseJSON :: Value -> Parser (Partial User)

parseJSONList :: Value -> Parser [Partial User]

TextShow (Partial User)

Defined in Calamity.Types.Model.User

Methods

showbPrec :: Int -> Partial User -> Builder

showb :: Partial User -> Builder

showbList :: [Partial User] -> Builder

showtPrec :: Int -> Partial User -> Text

showt :: Partial User -> Text

showtList :: [Partial User] -> Text

showtlPrec :: Int -> Partial User -> Text

showtl :: Partial User -> Text

showtlList :: [Partial User] -> Text

Tellable (Snowflake User)

Defined in Calamity.Types.Tellable

Methods

getChannel :: forall (r :: [(Type -> Type) -> Type -> Type]). (BotC r, Member (Error RestError) r) => Snowflake User -> Sem r (Snowflake Channel)

ToMessage (TMention User)

Add a User id to the list of allowed user mentions

Defined in Calamity.Types.Tellable

Methods

intoMsg :: TMention User -> Endo CreateMessageOptions

Mentionable (Snowflake User)

Defined in Calamity.Utils.Message

Methods

mention :: Snowflake User -> Text

ParameterParser (Snowflake User) c r

Accepts both plain IDs and mentions

Defined in Calamity.Commands.CalamityParsers

Associated Types

type ParserResult (Snowflake User)

Methods

parameterInfo :: ParameterInfo

parameterDescription :: Text

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

type ParserResult User

Defined in Calamity.Commands.CalamityParsers

type ParserResult User = User

newtype Partial User

Defined in Calamity.Types.Model.User

newtype Partial User = PartialUser {

• id :: Snowflake User

}

type Updated User

Defined in Calamity.Internal.Updateable

type Updated User = User

type ParserResult (Snowflake User)

Defined in Calamity.Commands.CalamityParsers

type ParserResult (Snowflake User) = Snowflake User

data UserBanner

Constructors

UserBanner

Fields

• userID :: Snowflake User
• hash :: Text

Instances

Eq UserBanner

Defined in Calamity.Types.Model.User

Methods

(==) :: UserBanner -> UserBanner -> Bool

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

Show UserBanner

Defined in Calamity.Types.Model.User

Methods

showsPrec :: Int -> UserBanner -> ShowS

show :: UserBanner -> String

showList :: [UserBanner] -> ShowS

CDNAsset UserBanner

Defined in Calamity.Types.Model.User

Methods

assetURL :: UserBanner -> Url 'Https

data family Partial t

Instances

(k ~ A_Lens, a ~ Bool, b ~ Bool) => LabelOptic "animated" k (Partial Emoji) (Partial Emoji) a b

Defined in Calamity.Types.Model.Guild.Emoji

Methods

labelOptic :: Optic k NoIx (Partial Emoji) (Partial Emoji) a b

(k ~ A_Lens, a ~ Snowflake Channel, b ~ Snowflake Channel) => LabelOptic "channelID" k (Partial Message) (Partial Message) a b

Defined in Calamity.Types.Model.Channel.Message

Methods

labelOptic :: Optic k NoIx (Partial Message) (Partial Message) a b

(k ~ A_Lens, a ~ Maybe (Snowflake Guild), b ~ Maybe (Snowflake Guild)) => LabelOptic "guildID" k (Partial Message) (Partial Message) a b

Defined in Calamity.Types.Model.Channel.Message

Methods

labelOptic :: Optic k NoIx (Partial Message) (Partial Message) a b

(k ~ An_Iso, a ~ Snowflake User, b ~ Snowflake User) => LabelOptic "id" k (Partial User) (Partial User) a b

Defined in Calamity.Types.Model.User

Methods

labelOptic :: Optic k NoIx (Partial User) (Partial User) a b

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

Defined in Calamity.Types.Model.Guild.Emoji

Methods

labelOptic :: Optic k NoIx (Partial Emoji) (Partial Emoji) a b

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

Defined in Calamity.Types.Model.Channel

Methods

labelOptic :: Optic k NoIx (Partial Channel) (Partial Channel) a b

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

Defined in Calamity.Types.Model.Guild.Guild

Methods

labelOptic :: Optic k NoIx (Partial Guild) (Partial Guild) a b

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

Defined in Calamity.Types.Model.Guild.Emoji

Methods

labelOptic :: Optic k NoIx (Partial Emoji) (Partial Emoji) a b

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

Defined in Calamity.Types.Model.Channel

Methods

labelOptic :: Optic k NoIx (Partial Channel) (Partial Channel) a b

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

Defined in Calamity.Types.Model.Guild.Guild

Methods

labelOptic :: Optic k NoIx (Partial Guild) (Partial Guild) a b

(k ~ A_Lens, a ~ Maybe (Snowflake Category), b ~ Maybe (Snowflake Category)) => LabelOptic "parentID" k (Partial Channel) (Partial Channel) a b

Defined in Calamity.Types.Model.Channel

Methods

labelOptic :: Optic k NoIx (Partial Channel) (Partial Channel) a b

(k ~ A_Lens, a ~ Maybe Permissions, b ~ Maybe Permissions) => LabelOptic "permissions" k (Partial Channel) (Partial Channel) a b

Defined in Calamity.Types.Model.Channel

Methods

labelOptic :: Optic k NoIx (Partial Channel) (Partial Channel) a b

(k ~ A_Lens, a ~ ChannelType, b ~ ChannelType) => LabelOptic "type_" k (Partial Channel) (Partial Channel) a b

Defined in Calamity.Types.Model.Channel

Methods

labelOptic :: Optic k NoIx (Partial Channel) (Partial Channel) a b

HasID Channel (Partial Channel)

Defined in Calamity.Types.Model.Channel

Methods

getID :: Partial Channel -> Snowflake Channel

HasID Channel (Partial Message)

Defined in Calamity.Types.Model.Channel.Message

Methods

getID :: Partial Message -> Snowflake Channel

HasID Guild (Partial Guild)

Defined in Calamity.Types.Model.Guild.Guild

Methods

getID :: Partial Guild -> Snowflake Guild

HasID User (Partial User)

Defined in Calamity.Types.Model.User

Methods

getID :: Partial User -> Snowflake User

HasID Emoji (Partial Emoji)

Defined in Calamity.Types.Model.Guild.Emoji

Methods

getID :: Partial Emoji -> Snowflake Emoji

Eq (Partial Channel)

Defined in Calamity.Types.Model.Channel

Methods

(==) :: Partial Channel -> Partial Channel -> Bool

(/=) :: Partial Channel -> Partial Channel -> Bool

Eq (Partial Guild)

Defined in Calamity.Types.Model.Guild.Guild

Methods

(==) :: Partial Guild -> Partial Guild -> Bool

(/=) :: Partial Guild -> Partial Guild -> Bool

Eq (Partial User)

Defined in Calamity.Types.Model.User

Methods

(==) :: Partial User -> Partial User -> Bool

(/=) :: Partial User -> Partial User -> Bool

Eq (Partial Emoji)

Defined in Calamity.Types.Model.Guild.Emoji

Methods

(==) :: Partial Emoji -> Partial Emoji -> Bool

(/=) :: Partial Emoji -> Partial Emoji -> Bool

Show (Partial Channel)

Defined in Calamity.Types.Model.Channel

Methods

showsPrec :: Int -> Partial Channel -> ShowS

show :: Partial Channel -> String

showList :: [Partial Channel] -> ShowS

Show (Partial Message)

Defined in Calamity.Types.Model.Channel.Message

Methods

showsPrec :: Int -> Partial Message -> ShowS

show :: Partial Message -> String

showList :: [Partial Message] -> ShowS

Show (Partial Guild)

Defined in Calamity.Types.Model.Guild.Guild

Methods

showsPrec :: Int -> Partial Guild -> ShowS

show :: Partial Guild -> String

showList :: [Partial Guild] -> ShowS

Show (Partial User)

Defined in Calamity.Types.Model.User

Methods

showsPrec :: Int -> Partial User -> ShowS

show :: Partial User -> String

showList :: [Partial User] -> ShowS

Show (Partial Emoji)

Defined in Calamity.Types.Model.Guild.Emoji

Methods

showsPrec :: Int -> Partial Emoji -> ShowS

show :: Partial Emoji -> String

showList :: [Partial Emoji] -> ShowS

ToJSON (Partial Channel)

Defined in Calamity.Types.Model.Channel

Methods

toJSON :: Partial Channel -> Value

toEncoding :: Partial Channel -> Encoding

toJSONList :: [Partial Channel] -> Value

toEncodingList :: [Partial Channel] -> Encoding

ToJSON (Partial Guild)

Defined in Calamity.Types.Model.Guild.Guild

Methods

toJSON :: Partial Guild -> Value

toEncoding :: Partial Guild -> Encoding

toJSONList :: [Partial Guild] -> Value

toEncodingList :: [Partial Guild] -> Encoding

ToJSON (Partial Emoji)

Defined in Calamity.Types.Model.Guild.Emoji

Methods

toJSON :: Partial Emoji -> Value

toEncoding :: Partial Emoji -> Encoding

toJSONList :: [Partial Emoji] -> Value

toEncodingList :: [Partial Emoji] -> Encoding

FromJSON (Partial Channel)

Defined in Calamity.Types.Model.Channel

Methods

parseJSON :: Value -> Parser (Partial Channel)

parseJSONList :: Value -> Parser [Partial Channel]

FromJSON (Partial Message)

Defined in Calamity.Types.Model.Channel.Message

Methods

parseJSON :: Value -> Parser (Partial Message)

parseJSONList :: Value -> Parser [Partial Message]

FromJSON (Partial Guild)

Defined in Calamity.Types.Model.Guild.Guild

Methods

parseJSON :: Value -> Parser (Partial Guild)

parseJSONList :: Value -> Parser [Partial Guild]

FromJSON (Partial User)

Defined in Calamity.Types.Model.User

Methods

parseJSON :: Value -> Parser (Partial User)

parseJSONList :: Value -> Parser [Partial User]

FromJSON (Partial Emoji)

Defined in Calamity.Types.Model.Guild.Emoji

Methods

parseJSON :: Value -> Parser (Partial Emoji)

parseJSONList :: Value -> Parser [Partial Emoji]

TextShow (Partial Channel)

Defined in Calamity.Types.Model.Channel

Methods

showbPrec :: Int -> Partial Channel -> Builder

showb :: Partial Channel -> Builder

showbList :: [Partial Channel] -> Builder

showtPrec :: Int -> Partial Channel -> Text

showt :: Partial Channel -> Text

showtList :: [Partial Channel] -> Text

showtlPrec :: Int -> Partial Channel -> Text

showtl :: Partial Channel -> Text

showtlList :: [Partial Channel] -> Text

TextShow (Partial Message)

Defined in Calamity.Types.Model.Channel.Message

Methods

showbPrec :: Int -> Partial Message -> Builder

showb :: Partial Message -> Builder

showbList :: [Partial Message] -> Builder

showtPrec :: Int -> Partial Message -> Text

showt :: Partial Message -> Text

showtList :: [Partial Message] -> Text

showtlPrec :: Int -> Partial Message -> Text

showtl :: Partial Message -> Text

showtlList :: [Partial Message] -> Text

TextShow (Partial Guild)

Defined in Calamity.Types.Model.Guild.Guild

Methods

showbPrec :: Int -> Partial Guild -> Builder

showb :: Partial Guild -> Builder

showbList :: [Partial Guild] -> Builder

showtPrec :: Int -> Partial Guild -> Text

showt :: Partial Guild -> Text

showtList :: [Partial Guild] -> Text

showtlPrec :: Int -> Partial Guild -> Text

showtl :: Partial Guild -> Text

showtlList :: [Partial Guild] -> Text

TextShow (Partial User)

Defined in Calamity.Types.Model.User

Methods

showbPrec :: Int -> Partial User -> Builder

showb :: Partial User -> Builder

showbList :: [Partial User] -> Builder

showtPrec :: Int -> Partial User -> Text

showt :: Partial User -> Text

showtList :: [Partial User] -> Text

showtlPrec :: Int -> Partial User -> Text

showtl :: Partial User -> Text

showtlList :: [Partial User] -> Text

TextShow (Partial Emoji)

Defined in Calamity.Types.Model.Guild.Emoji

Methods

showbPrec :: Int -> Partial Emoji -> Builder

showb :: Partial Emoji -> Builder

showbList :: [Partial Emoji] -> Builder

showtPrec :: Int -> Partial Emoji -> Text

showt :: Partial Emoji -> Text

showtList :: [Partial Emoji] -> Text

showtlPrec :: Int -> Partial Emoji -> Text

showtl :: Partial Emoji -> Text

showtlList :: [Partial Emoji] -> Text

CalamityToJSON' (Partial Channel)

Defined in Calamity.Types.Model.Channel

Methods

toPairs :: KeyValue kv => Partial Channel -> [Maybe kv]

CalamityToJSON' (Partial Guild)

Defined in Calamity.Types.Model.Guild.Guild

Methods

toPairs :: KeyValue kv => Partial Guild -> [Maybe kv]

CalamityToJSON' (Partial Emoji)

Defined in Calamity.Types.Model.Guild.Emoji

Methods

toPairs :: KeyValue kv => Partial Emoji -> [Maybe kv]

data Partial Channel

Defined in Calamity.Types.Model.Channel

data Partial Channel = PartialChannel {

• id :: Snowflake Channel
• name :: Text
• type_ :: ChannelType
• permissions :: Maybe Permissions
• parentID :: Maybe (Snowflake Category)

}

data Partial Message

Defined in Calamity.Types.Model.Channel.Message

data Partial Message = PartialMessage {

• channelID :: Snowflake Channel
• guildID :: Maybe (Snowflake Guild)

}

data Partial Guild

Defined in Calamity.Types.Model.Guild.Guild

data Partial Guild = PartialGuild {

• id :: Snowflake Guild
• name :: Text

}

newtype Partial User

Defined in Calamity.Types.Model.User

newtype Partial User = PartialUser {

• id :: Snowflake User

}

data Partial Emoji

Defined in Calamity.Types.Model.Guild.Emoji

data Partial Emoji = PartialEmoji {

• id :: Snowflake Emoji
• name :: Text
• animated :: Bool

}

data StatusType

Constructors

Idle

DND

Online

Offline

Invisible

Instances

Enum StatusType

Defined in Calamity.Types.Model.User

Methods

succ :: StatusType -> StatusType

pred :: StatusType -> StatusType

toEnum :: Int -> StatusType

fromEnum :: StatusType -> Int

enumFrom :: StatusType -> [StatusType]

enumFromThen :: StatusType -> StatusType -> [StatusType]

enumFromTo :: StatusType -> StatusType -> [StatusType]

enumFromThenTo :: StatusType -> StatusType -> StatusType -> [StatusType]

Eq StatusType

Defined in Calamity.Types.Model.User

Methods

(==) :: StatusType -> StatusType -> Bool

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

Show StatusType

Defined in Calamity.Types.Model.User

Methods

showsPrec :: Int -> StatusType -> ShowS

show :: StatusType -> String

showList :: [StatusType] -> ShowS

ToJSON StatusType

Defined in Calamity.Types.Model.User

Methods

toJSON :: StatusType -> Value

toEncoding :: StatusType -> Encoding

toJSONList :: [StatusType] -> Value

toEncodingList :: [StatusType] -> Encoding

FromJSON StatusType

Defined in Calamity.Types.Model.User

Methods

parseJSON :: Value -> Parser StatusType

parseJSONList :: Value -> Parser [StatusType]

TextShow StatusType

Defined in Calamity.Types.Model.User

Methods

showbPrec :: Int -> StatusType -> Builder

showb :: StatusType -> Builder

showbList :: [StatusType] -> Builder

showtPrec :: Int -> StatusType -> Text

showt :: StatusType -> Text

showtList :: [StatusType] -> Text

showtlPrec :: Int -> StatusType -> Text

showtl :: StatusType -> Text

showtlList :: [StatusType] -> Text