Calamity.HTTP.User

User endpoints

Documentation

data UserRequest a where

Constructors

GetCurrentUser :: UserRequest User

GetUser :: HasID User u => u -> UserRequest User

ModifyCurrentUser :: ModifyUserData -> UserRequest User

GetCurrentUserGuilds :: GetCurrentUserGuildsOptions -> UserRequest [Partial Guild]

LeaveGuild :: HasID Guild g => g -> UserRequest ()

CreateDM :: HasID User u => u -> UserRequest DMChannel

Instances

Request (UserRequest a)

Defined in Calamity.HTTP.User

Associated Types

type Result (UserRequest a)

Methods

route :: UserRequest a -> Route

action :: UserRequest a -> Url 'Https -> Option 'Https -> Req LbsResponse

modifyResponse :: UserRequest a -> Value -> Value

type Result (UserRequest a)

Defined in Calamity.HTTP.User

type Result (UserRequest a) = a

data ModifyUserData

Constructors

ModifyUserData

Fields

• username :: Maybe Text
• avatar :: Maybe Text

  The avatar field should be in discord's image data format: https://discord.com/developers/docs/reference#image-data

Instances

Show ModifyUserData

Defined in Calamity.HTTP.User

Methods

showsPrec :: Int -> ModifyUserData -> ShowS

show :: ModifyUserData -> String

showList :: [ModifyUserData] -> ShowS

Generic ModifyUserData

Defined in Calamity.HTTP.User

Associated Types

type Rep ModifyUserData :: Type -> Type

Methods

from :: ModifyUserData -> Rep ModifyUserData x

to :: Rep ModifyUserData x -> ModifyUserData

ToJSON ModifyUserData

Defined in Calamity.HTTP.User

Methods

toJSON :: ModifyUserData -> Value

toEncoding :: ModifyUserData -> Encoding

toJSONList :: [ModifyUserData] -> Value

toEncodingList :: [ModifyUserData] -> Encoding

Default ModifyUserData

Defined in Calamity.HTTP.User

Methods

def :: ModifyUserData

type Rep ModifyUserData

Defined in Calamity.HTTP.User

type Rep ModifyUserData = D1 ('MetaData "ModifyUserData" "Calamity.HTTP.User" "calamity-0.3.0.0-inplace" 'False) (C1 ('MetaCons "ModifyUserData" 'PrefixI 'True) (S1 ('MetaSel ('Just "username") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "avatar") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

data GetCurrentUserGuildsOptions

Constructors

GetCurrentUserGuildsOptions

Fields

• before :: Maybe (Snowflake Guild)
• after :: Maybe (Snowflake Guild)
• limit :: Maybe Integer

Instances

Show GetCurrentUserGuildsOptions

Defined in Calamity.HTTP.User

Methods

showsPrec :: Int -> GetCurrentUserGuildsOptions -> ShowS

show :: GetCurrentUserGuildsOptions -> String

showList :: [GetCurrentUserGuildsOptions] -> ShowS

Generic GetCurrentUserGuildsOptions

Defined in Calamity.HTTP.User

Associated Types

type Rep GetCurrentUserGuildsOptions :: Type -> Type

Methods

from :: GetCurrentUserGuildsOptions -> Rep GetCurrentUserGuildsOptions x

to :: Rep GetCurrentUserGuildsOptions x -> GetCurrentUserGuildsOptions

Default GetCurrentUserGuildsOptions

Defined in Calamity.HTTP.User

Methods

def :: GetCurrentUserGuildsOptions

type Rep GetCurrentUserGuildsOptions

Defined in Calamity.HTTP.User

type Rep GetCurrentUserGuildsOptions = D1 ('MetaData "GetCurrentUserGuildsOptions" "Calamity.HTTP.User" "calamity-0.3.0.0-inplace" 'False) (C1 ('MetaCons "GetCurrentUserGuildsOptions" 'PrefixI 'True) (S1 ('MetaSel ('Just "before") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Snowflake Guild))) :*: (S1 ('MetaSel ('Just "after") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Snowflake Guild))) :*: S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))))