Calamity.HTTP.Channel

Channel endpoints

Documentation

data ChannelRequest a where

Constructors

CreateMessage :: HasID Channel c => c -> CreateMessageOptions -> ChannelRequest Message

GetMessage :: (HasID Channel c, HasID Message m) => c -> m -> ChannelRequest Message

EditMessage :: (HasID Channel c, HasID Message m) => c -> m -> Maybe Text -> Maybe Embed -> ChannelRequest Message

DeleteMessage :: (HasID Channel c, HasID Message m) => c -> m -> ChannelRequest ()

BulkDeleteMessages :: (HasID Channel c, HasID Message m) => c -> [m] -> ChannelRequest ()

GetChannel :: HasID Channel c => c -> ChannelRequest Channel

ModifyChannel :: HasID Channel c => c -> ChannelUpdate -> ChannelRequest Channel

DeleteChannel :: HasID Channel c => c -> ChannelRequest ()

GetChannelMessages :: HasID Channel c => c -> Maybe ChannelMessagesQuery -> ChannelRequest [Message]

CreateReaction :: (HasID Channel c, HasID Message m) => c -> m -> RawEmoji -> ChannelRequest ()

DeleteOwnReaction :: (HasID Channel c, HasID Message m) => c -> m -> RawEmoji -> ChannelRequest ()

DeleteUserReaction :: (HasID Channel c, HasID Message m, HasID User u) => c -> m -> RawEmoji -> u -> ChannelRequest ()

GetReactions :: (HasID Channel c, HasID Message m) => c -> m -> RawEmoji -> GetReactionsOptions -> ChannelRequest [User]

DeleteAllReactions :: (HasID Channel c, HasID Message m) => c -> m -> ChannelRequest ()

GetChannelInvites :: HasID Channel c => c -> ChannelRequest [Invite]

CreateChannelInvite :: HasID Channel c => c -> CreateChannelInviteOptions -> ChannelRequest Invite

EditChannelPermissions :: HasID Channel c => c -> Overwrite -> ChannelRequest ()

DeleteChannelPermission :: (HasID Channel c, HasID Overwrite o) => c -> o -> ChannelRequest ()

TriggerTyping :: HasID Channel c => c -> ChannelRequest ()

GetPinnedMessages :: HasID Channel c => c -> ChannelRequest [Message]

AddPinnedMessage :: (HasID Channel c, HasID Message m) => c -> m -> ChannelRequest ()

DeletePinnedMessage :: (HasID Channel c, HasID Message m) => c -> m -> ChannelRequest ()

GroupDMAddRecipient :: (HasID Channel c, HasID User u) => c -> u -> GroupDMAddRecipientOptions -> ChannelRequest ()

GroupDMRemoveRecipient :: (HasID Channel c, HasID User u) => c -> u -> ChannelRequest ()

Instances

Request (ChannelRequest a)

Defined in Calamity.HTTP.Channel

Associated Types

type Result (ChannelRequest a)

Methods

route :: ChannelRequest a -> Route

action :: ChannelRequest a -> Options -> String -> IO (Response ByteString)

invoke :: forall (r :: [(Type -> Type) -> Type -> Type]). (BotC r, FromJSON (Result (ChannelRequest a))) => ChannelRequest a -> Sem r (Either RestError (Result (ChannelRequest a)))

type Result (ChannelRequest a)

Defined in Calamity.HTTP.Channel

type Result (ChannelRequest a) = a

data CreateMessageOptions

Constructors

CreateMessageOptions

Fields

• content :: Maybe Text
• nonce :: Maybe Text
• tts :: Maybe Bool
• file :: Maybe ByteString
• embed :: Maybe Embed

Instances

Show CreateMessageOptions

Defined in Calamity.HTTP.Channel

Methods

showsPrec :: Int -> CreateMessageOptions -> ShowS

show :: CreateMessageOptions -> String

showList :: [CreateMessageOptions] -> ShowS

Generic CreateMessageOptions

Defined in Calamity.HTTP.Channel

Associated Types

type Rep CreateMessageOptions :: Type -> Type

Methods

from :: CreateMessageOptions -> Rep CreateMessageOptions x

to :: Rep CreateMessageOptions x -> CreateMessageOptions

Default CreateMessageOptions

Defined in Calamity.HTTP.Channel

Methods

def :: CreateMessageOptions

ToMessage CreateMessageOptions

Defined in Calamity.Types.Tellable

Methods

intoMsg :: CreateMessageOptions -> Endo CreateMessageOptions

ToMessage (Endo CreateMessageOptions)

Defined in Calamity.Types.Tellable

Methods

intoMsg :: Endo CreateMessageOptions -> Endo CreateMessageOptions

ToMessage (CreateMessageOptions -> CreateMessageOptions)

Defined in Calamity.Types.Tellable

Methods

intoMsg :: (CreateMessageOptions -> CreateMessageOptions) -> Endo CreateMessageOptions

type Rep CreateMessageOptions

Defined in Calamity.HTTP.Channel

type Rep CreateMessageOptions = D1 ('MetaData "CreateMessageOptions" "Calamity.HTTP.Channel" "calamity-0.1.9.4-inplace" 'False) (C1 ('MetaCons "CreateMessageOptions" 'PrefixI 'True) ((S1 ('MetaSel ('Just "content") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "nonce") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "tts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "file") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ByteString)) :*: S1 ('MetaSel ('Just "embed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Embed))))))

data ChannelUpdate

Constructors

ChannelUpdate

Fields

• name :: Maybe Text
• position :: Maybe Int
• topic :: Maybe Text
• nsfw :: Maybe Bool
• rateLimitPerUser :: Maybe Int
• bitrate :: Maybe Int
• userLimit :: Maybe Int
• permissionOverwrites :: Maybe [Overwrite]
• parentID :: Maybe (Snowflake Channel)

Instances

Show ChannelUpdate

Defined in Calamity.HTTP.Channel

Methods

showsPrec :: Int -> ChannelUpdate -> ShowS

show :: ChannelUpdate -> String

showList :: [ChannelUpdate] -> ShowS

Generic ChannelUpdate

Defined in Calamity.HTTP.Channel

Associated Types

type Rep ChannelUpdate :: Type -> Type

Methods

from :: ChannelUpdate -> Rep ChannelUpdate x

to :: Rep ChannelUpdate x -> ChannelUpdate

ToJSON ChannelUpdate

Defined in Calamity.HTTP.Channel

Methods

toJSON :: ChannelUpdate -> Value

toEncoding :: ChannelUpdate -> Encoding

toJSONList :: [ChannelUpdate] -> Value

toEncodingList :: [ChannelUpdate] -> Encoding

Default ChannelUpdate

Defined in Calamity.HTTP.Channel

Methods

def :: ChannelUpdate

type Rep ChannelUpdate

Defined in Calamity.HTTP.Channel

type Rep ChannelUpdate = D1 ('MetaData "ChannelUpdate" "Calamity.HTTP.Channel" "calamity-0.1.9.4-inplace" 'False) (C1 ('MetaCons "ChannelUpdate" 'PrefixI 'True) (((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "topic") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "nsfw") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "rateLimitPerUser") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "bitrate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "userLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "permissionOverwrites") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [Overwrite])) :*: S1 ('MetaSel ('Just "parentID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Snowflake Channel))))))))

data ChannelMessagesQuery

Constructors

ChannelMessagesAround

Fields

• around :: Snowflake Message

ChannelMessagesBefore

Fields

• before :: Snowflake Message

ChannelMessagesAfter

Fields

• after :: Snowflake Message

ChannelMessagesLimit

Fields

• limit :: Int

Instances

Show ChannelMessagesQuery

Defined in Calamity.HTTP.Channel

Methods

showsPrec :: Int -> ChannelMessagesQuery -> ShowS

show :: ChannelMessagesQuery -> String

showList :: [ChannelMessagesQuery] -> ShowS

Generic ChannelMessagesQuery

Defined in Calamity.HTTP.Channel

Associated Types

type Rep ChannelMessagesQuery :: Type -> Type

Methods

from :: ChannelMessagesQuery -> Rep ChannelMessagesQuery x

to :: Rep ChannelMessagesQuery x -> ChannelMessagesQuery

ToJSON ChannelMessagesQuery

Defined in Calamity.HTTP.Channel

Methods

toJSON :: ChannelMessagesQuery -> Value

toEncoding :: ChannelMessagesQuery -> Encoding

toJSONList :: [ChannelMessagesQuery] -> Value

toEncodingList :: [ChannelMessagesQuery] -> Encoding

type Rep ChannelMessagesQuery

Defined in Calamity.HTTP.Channel

type Rep ChannelMessagesQuery = D1 ('MetaData "ChannelMessagesQuery" "Calamity.HTTP.Channel" "calamity-0.1.9.4-inplace" 'False) ((C1 ('MetaCons "ChannelMessagesAround" 'PrefixI 'True) (S1 ('MetaSel ('Just "around") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Snowflake Message))) :+: C1 ('MetaCons "ChannelMessagesBefore" 'PrefixI 'True) (S1 ('MetaSel ('Just "before") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Snowflake Message)))) :+: (C1 ('MetaCons "ChannelMessagesAfter" 'PrefixI 'True) (S1 ('MetaSel ('Just "after") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Snowflake Message))) :+: C1 ('MetaCons "ChannelMessagesLimit" 'PrefixI 'True) (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int))))

data GetReactionsOptions

Constructors

GetReactionsOptions

Fields

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

Instances

Show GetReactionsOptions

Defined in Calamity.HTTP.Channel

Methods

showsPrec :: Int -> GetReactionsOptions -> ShowS

show :: GetReactionsOptions -> String

showList :: [GetReactionsOptions] -> ShowS

Generic GetReactionsOptions

Defined in Calamity.HTTP.Channel

Associated Types

type Rep GetReactionsOptions :: Type -> Type

Methods

from :: GetReactionsOptions -> Rep GetReactionsOptions x

to :: Rep GetReactionsOptions x -> GetReactionsOptions

Default GetReactionsOptions

Defined in Calamity.HTTP.Channel

Methods

def :: GetReactionsOptions

type Rep GetReactionsOptions

Defined in Calamity.HTTP.Channel

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

data CreateChannelInviteOptions

Constructors

CreateChannelInviteOptions

Fields

• maxAge :: Maybe Int
• maxUses :: Maybe Int
• temporary :: Maybe Bool
• unique :: Maybe Bool

Instances

Show CreateChannelInviteOptions

Defined in Calamity.HTTP.Channel

Methods

showsPrec :: Int -> CreateChannelInviteOptions -> ShowS

show :: CreateChannelInviteOptions -> String

showList :: [CreateChannelInviteOptions] -> ShowS

Generic CreateChannelInviteOptions

Defined in Calamity.HTTP.Channel

Associated Types

type Rep CreateChannelInviteOptions :: Type -> Type

Methods

from :: CreateChannelInviteOptions -> Rep CreateChannelInviteOptions x

to :: Rep CreateChannelInviteOptions x -> CreateChannelInviteOptions

ToJSON CreateChannelInviteOptions

Defined in Calamity.HTTP.Channel

Methods

toJSON :: CreateChannelInviteOptions -> Value

toEncoding :: CreateChannelInviteOptions -> Encoding

toJSONList :: [CreateChannelInviteOptions] -> Value

toEncodingList :: [CreateChannelInviteOptions] -> Encoding

Default CreateChannelInviteOptions

Defined in Calamity.HTTP.Channel

Methods

def :: CreateChannelInviteOptions

type Rep CreateChannelInviteOptions

Defined in Calamity.HTTP.Channel

type Rep CreateChannelInviteOptions = D1 ('MetaData "CreateChannelInviteOptions" "Calamity.HTTP.Channel" "calamity-0.1.9.4-inplace" 'False) (C1 ('MetaCons "CreateChannelInviteOptions" 'PrefixI 'True) ((S1 ('MetaSel ('Just "maxAge") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "maxUses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "temporary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "unique") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))))

data GroupDMAddRecipientOptions

Constructors

GroupDMAddRecipientOptions

Fields

• accessToken :: Text
• nick :: Text

Instances

Show GroupDMAddRecipientOptions

Defined in Calamity.HTTP.Channel

Methods

showsPrec :: Int -> GroupDMAddRecipientOptions -> ShowS

show :: GroupDMAddRecipientOptions -> String

showList :: [GroupDMAddRecipientOptions] -> ShowS

Generic GroupDMAddRecipientOptions

Defined in Calamity.HTTP.Channel

Associated Types

type Rep GroupDMAddRecipientOptions :: Type -> Type

Methods

from :: GroupDMAddRecipientOptions -> Rep GroupDMAddRecipientOptions x

to :: Rep GroupDMAddRecipientOptions x -> GroupDMAddRecipientOptions

ToJSON GroupDMAddRecipientOptions

Defined in Calamity.HTTP.Channel

Methods

toJSON :: GroupDMAddRecipientOptions -> Value

toEncoding :: GroupDMAddRecipientOptions -> Encoding

toJSONList :: [GroupDMAddRecipientOptions] -> Value

toEncodingList :: [GroupDMAddRecipientOptions] -> Encoding

type Rep GroupDMAddRecipientOptions

Defined in Calamity.HTTP.Channel

type Rep GroupDMAddRecipientOptions = D1 ('MetaData "GroupDMAddRecipientOptions" "Calamity.HTTP.Channel" "calamity-0.1.9.4-inplace" 'False) (C1 ('MetaCons "GroupDMAddRecipientOptions" 'PrefixI 'True) (S1 ('MetaSel ('Just "accessToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "nick") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))