Safe Haskell	Safe-Inferred
Language	Haskell2010

Calamity.HTTP.User

Description

User endpoints

Documentation

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 details

Request (UserRequest a) Source #
Instance details Defined in Calamity.HTTP.User Associated Types type Result (UserRequest a) Source # Methods route :: UserRequest a -> Route Source # action :: UserRequest a -> Url 'Https -> Option 'Https -> Req LbsResponse Source # modifyResponse :: UserRequest a -> Value -> Value Source #
type Result (UserRequest a) Source #
Instance details Defined in Calamity.HTTP.User type Result (UserRequest a) = a

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 details

ToJSON ModifyUserData Source #
Instance details Defined in Calamity.HTTP.User Methods toJSON :: ModifyUserData -> Value # toEncoding :: ModifyUserData -> Encoding # toJSONList :: [ModifyUserData] -> Value # toEncodingList :: [ModifyUserData] -> Encoding #
Show ModifyUserData Source #
Instance details Defined in Calamity.HTTP.User Methods showsPrec :: Int -> ModifyUserData -> ShowS # show :: ModifyUserData -> String # showList :: [ModifyUserData] -> ShowS #
CalamityToJSON' ModifyUserData Source #
Instance details Defined in Calamity.HTTP.User Methods toPairs :: KeyValue kv => ModifyUserData -> [Maybe kv] Source #
Default ModifyUserData Source #
Instance details Defined in Calamity.HTTP.User Methods def :: ModifyUserData #
(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "avatar" k ModifyUserData ModifyUserData a b Source #
Instance details 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 Source #
Instance details Defined in Calamity.HTTP.User Methods labelOptic :: Optic k NoIx ModifyUserData ModifyUserData a b #

Constructors

GetCurrentUserGuildsOptions
Fields before :: Maybe (Snowflake Guild) after :: Maybe (Snowflake Guild) limit :: Maybe Integer

Instances details

Show GetCurrentUserGuildsOptions Source #
Instance details Defined in Calamity.HTTP.User Methods showsPrec :: Int -> GetCurrentUserGuildsOptions -> ShowS # show :: GetCurrentUserGuildsOptions -> String # showList :: [GetCurrentUserGuildsOptions] -> ShowS #
Default GetCurrentUserGuildsOptions Source #
Instance details 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 Source #
Instance details 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 Source #
Instance details 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 Source #
Instance details Defined in Calamity.HTTP.User Methods labelOptic :: Optic k NoIx GetCurrentUserGuildsOptions GetCurrentUserGuildsOptions a b #