Safe Haskell | Safe-Inferred |
---|---|
Language | Haskell2010 |
Provides actions for Channel API interactions
Synopsis
- data UserRequest a where
- GetCurrentUser :: UserRequest User
- GetUser :: UserId -> UserRequest User
- ModifyCurrentUser :: Text -> Base64Image User -> UserRequest User
- GetCurrentUserGuilds :: UserRequest [PartialGuild]
- LeaveGuild :: GuildId -> UserRequest ()
- GetUserDMs :: UserRequest [Channel]
- CreateDM :: UserId -> UserRequest Channel
- GetUserConnections :: UserRequest [ConnectionObject]
- parseAvatarImage :: ByteString -> Either Text (Base64Image User)
Documentation
data UserRequest a where Source #
Data constructor for requests. See API
GetCurrentUser :: UserRequest User | Returns the |
GetUser :: UserId -> UserRequest User | Returns a |
ModifyCurrentUser :: Text -> Base64Image User -> UserRequest User | Modify user's username & avatar pic |
GetCurrentUserGuilds :: UserRequest [PartialGuild] | Returns a list of user |
LeaveGuild :: GuildId -> UserRequest () | Leave a guild. |
GetUserDMs :: UserRequest [Channel] | Returns a list of DM |
CreateDM :: UserId -> UserRequest Channel | Create a new DM channel with a user. Returns a DM |
GetUserConnections :: UserRequest [ConnectionObject] |
Instances
Request (UserRequest a) Source # | |
Defined in Discord.Internal.Rest.User majorRoute :: UserRequest a -> String Source # jsonRequest :: UserRequest a -> JsonRequest Source # |
parseAvatarImage :: ByteString -> Either Text (Base64Image User) Source #
parseAvatarImage bs
will attempt to convert the given image bytestring
bs
to the base64 format expected by the Discord API. It may return Left
with an error reason if the image format could not be predetermined from the
opening magic bytes. This function does not validate the rest of the image,
and this is up to the library user to check themselves.
This function accepts all file types accepted by getMimeType
.