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

ToJSON ModifyUserData

Defined in Calamity.HTTP.User

Methods

toJSON :: ModifyUserData -> Value

toEncoding :: ModifyUserData -> Encoding

toJSONList :: [ModifyUserData] -> Value

toEncodingList :: [ModifyUserData] -> Encoding

Show ModifyUserData

Defined in Calamity.HTTP.User

Methods

showsPrec :: Int -> ModifyUserData -> ShowS

show :: ModifyUserData -> String

showList :: [ModifyUserData] -> ShowS

CalamityToJSON' ModifyUserData

Defined in Calamity.HTTP.User

Methods

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

Default ModifyUserData

Defined in Calamity.HTTP.User

Methods

def :: ModifyUserData

(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "avatar" k ModifyUserData ModifyUserData a b

Defined in Calamity.HTTP.User

Methods

labelOptic :: Optic k NoIx ModifyUserData ModifyUserData a b

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

Defined in Calamity.HTTP.User

Methods

labelOptic :: Optic k NoIx ModifyUserData ModifyUserData a b

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

Default GetCurrentUserGuildsOptions

Defined in Calamity.HTTP.User

Methods

def :: GetCurrentUserGuildsOptions

(k ~ A_Lens, a ~ Maybe (Snowflake Guild), b ~ Maybe (Snowflake Guild)) => LabelOptic "after" k GetCurrentUserGuildsOptions GetCurrentUserGuildsOptions a b

Defined in Calamity.HTTP.User

Methods

labelOptic :: Optic k NoIx GetCurrentUserGuildsOptions GetCurrentUserGuildsOptions a b

(k ~ A_Lens, a ~ Maybe (Snowflake Guild), b ~ Maybe (Snowflake Guild)) => LabelOptic "before" k GetCurrentUserGuildsOptions GetCurrentUserGuildsOptions a b

Defined in Calamity.HTTP.User

Methods

labelOptic :: Optic k NoIx GetCurrentUserGuildsOptions GetCurrentUserGuildsOptions a b

(k ~ A_Lens, a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "limit" k GetCurrentUserGuildsOptions GetCurrentUserGuildsOptions a b

Defined in Calamity.HTTP.User

Methods

labelOptic :: Optic k NoIx GetCurrentUserGuildsOptions GetCurrentUserGuildsOptions a b