Copyright	(c) 2021 Rory Tyler Hayford
License	BSD-3-Clause
Maintainer	rory.hayford@protonmail.com
Stability	experimental
Portability	GHC
Safe Haskell	None
Language	Haskell2010

Network.Reddit.Message

Contents

Actions
Types

Description

Actions for messaging. These can be both comment replies as well as private messages

Synopsis

getInbox :: MonadReddit m => Paginator MessageID Message -> m (Listing MessageID Message)
getUnread :: MonadReddit m => Paginator MessageID Message -> m (Listing MessageID Message)
getSent :: MonadReddit m => Paginator MessageID Message -> m (Listing MessageID Message)
markRead :: MonadReddit m => MessageID -> m ()
sendMessage :: MonadReddit m => NewMessage -> m ()
replyToMessage :: MonadReddit m => MessageID -> Body -> m Message
reportMessage :: MonadReddit m => Report -> MessageID -> m ()
data NewMessage = NewMessage Subject Body Username
newtype PrivateMessageID = PrivateMessageID Text
data MessageID
data MessageOpts = MessageOpts Bool
data Message = Message MessageID Username Username Body Body Subject UTCTime Bool (Seq Message)

Actions

getInbox :: MonadReddit m => Paginator MessageID Message -> m (Listing MessageID Message) Source #

Get the Message inbox for the currently authenticated user

getUnread :: MonadReddit m => Paginator MessageID Message -> m (Listing MessageID Message) Source #

Get the unread Messages of the currently authenticated user

getSent :: MonadReddit m => Paginator MessageID Message -> m (Listing MessageID Message) Source #

Get the Messages sent by the currently authenticated user

markRead :: MonadReddit m => MessageID -> m () Source #

Mark a Message as read

sendMessage :: MonadReddit m => NewMessage -> m () Source #

Send a NewMessage to another user

replyToMessage :: MonadReddit m => MessageID -> Body -> m Message Source #

Reply to a Message, returning the newly created Message

reportMessage :: MonadReddit m => Report -> MessageID -> m () Source #

Report a message, bringing it to the attention of the Reddit admins

Types

data NewMessage Source #

For sending new Messages via the compose API endpoint

Constructors

NewMessage Subject Body Username

Instances

Instances details

Eq NewMessage Source #
Instance details Defined in Network.Reddit.Types.Message Methods (==) :: NewMessage -> NewMessage -> Bool # (/=) :: NewMessage -> NewMessage -> Bool #
Show NewMessage Source #
Instance details Defined in Network.Reddit.Types.Message Methods showsPrec :: Int -> NewMessage -> ShowS # show :: NewMessage -> String # showList :: [NewMessage] -> ShowS #
Generic NewMessage Source #
Instance details Defined in Network.Reddit.Types.Message Associated Types type Rep NewMessage :: Type -> Type # Methods from :: NewMessage -> Rep NewMessage x # to :: Rep NewMessage x -> NewMessage #
ToForm NewMessage Source #
Instance details Defined in Network.Reddit.Types.Message Methods toForm :: NewMessage -> Form #
type Rep NewMessage Source #
Instance details Defined in Network.Reddit.Types.Message type Rep NewMessage = D1 ('MetaData "NewMessage" "Network.Reddit.Types.Message" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "NewMessage" 'PrefixI 'True) (S1 ('MetaSel ('Just "subject") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Subject) :: (S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Body) :: S1 ('MetaSel ('Just "dest") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Username))))

newtype PrivateMessageID Source #

A private message ID

Constructors

PrivateMessageID Text

Instances

Instances details

Eq PrivateMessageID Source #
Instance details Defined in Network.Reddit.Types.Message Methods (==) :: PrivateMessageID -> PrivateMessageID -> Bool # (/=) :: PrivateMessageID -> PrivateMessageID -> Bool #
Ord PrivateMessageID Source #
Instance details Defined in Network.Reddit.Types.Message Methods compare :: PrivateMessageID -> PrivateMessageID -> Ordering # (<) :: PrivateMessageID -> PrivateMessageID -> Bool # (<=) :: PrivateMessageID -> PrivateMessageID -> Bool # (>) :: PrivateMessageID -> PrivateMessageID -> Bool # (>=) :: PrivateMessageID -> PrivateMessageID -> Bool # max :: PrivateMessageID -> PrivateMessageID -> PrivateMessageID # min :: PrivateMessageID -> PrivateMessageID -> PrivateMessageID #
Show PrivateMessageID Source #
Instance details Defined in Network.Reddit.Types.Message Methods showsPrec :: Int -> PrivateMessageID -> ShowS # show :: PrivateMessageID -> String # showList :: [PrivateMessageID] -> ShowS #
Generic PrivateMessageID Source #
Instance details Defined in Network.Reddit.Types.Message Associated Types type Rep PrivateMessageID :: Type -> Type # Methods from :: PrivateMessageID -> Rep PrivateMessageID x # to :: Rep PrivateMessageID x -> PrivateMessageID #
FromJSON PrivateMessageID Source #
Instance details Defined in Network.Reddit.Types.Message Methods parseJSON :: Value -> Parser PrivateMessageID # parseJSONList :: Value -> Parser [PrivateMessageID] #
ToHttpApiData PrivateMessageID Source #
Instance details Defined in Network.Reddit.Types.Message Methods toUrlPiece :: PrivateMessageID -> Text # toEncodedUrlPiece :: PrivateMessageID -> Builder # toHeader :: PrivateMessageID -> ByteString # toQueryParam :: PrivateMessageID -> Text #
Thing PrivateMessageID Source #
Instance details Defined in Network.Reddit.Types.Message Methods fullname :: PrivateMessageID -> Text Source #
type Rep PrivateMessageID Source #
Instance details Defined in Network.Reddit.Types.Message type Rep PrivateMessageID = D1 ('MetaData "PrivateMessageID" "Network.Reddit.Types.Message" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'True) (C1 ('MetaCons "PrivateMessageID" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data MessageID Source #

This can be CommentID for replies to a comment, or a PrivateMessageID for private messages. Querying one's inbox or unread messages can provide both types

Instances

Instances details

Eq MessageID Source #
Instance details Defined in Network.Reddit.Types.Message Methods (==) :: MessageID -> MessageID -> Bool # (/=) :: MessageID -> MessageID -> Bool #
Ord MessageID Source #
Instance details Defined in Network.Reddit.Types.Message Methods compare :: MessageID -> MessageID -> Ordering # (<) :: MessageID -> MessageID -> Bool # (<=) :: MessageID -> MessageID -> Bool # (>) :: MessageID -> MessageID -> Bool # (>=) :: MessageID -> MessageID -> Bool # max :: MessageID -> MessageID -> MessageID # min :: MessageID -> MessageID -> MessageID #
Show MessageID Source #
Instance details Defined in Network.Reddit.Types.Message Methods showsPrec :: Int -> MessageID -> ShowS # show :: MessageID -> String # showList :: [MessageID] -> ShowS #
Generic MessageID Source #
Instance details Defined in Network.Reddit.Types.Message Associated Types type Rep MessageID :: Type -> Type # Methods from :: MessageID -> Rep MessageID x # to :: Rep MessageID x -> MessageID #
FromJSON MessageID Source #
Instance details Defined in Network.Reddit.Types.Message Methods parseJSON :: Value -> Parser MessageID # parseJSONList :: Value -> Parser [MessageID] #
ToHttpApiData MessageID Source #
Instance details Defined in Network.Reddit.Types.Message Methods toUrlPiece :: MessageID -> Text # toEncodedUrlPiece :: MessageID -> Builder # toHeader :: MessageID -> ByteString # toQueryParam :: MessageID -> Text #
Thing MessageID Source #
Instance details Defined in Network.Reddit.Types.Message Methods fullname :: MessageID -> Text Source #
type Rep MessageID Source #
Instance details Defined in Network.Reddit.Types.Message type Rep MessageID = D1 ('MetaData "MessageID" "Network.Reddit.Types.Message" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "CommentReply" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CommentID)) :+: C1 ('MetaCons "PrivateMessage" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PrivateMessageID)))

data MessageOpts Source #

Options for requesting and paginating Listings of Messages

Constructors

MessageOpts Bool

Instances

Instances details

Eq MessageOpts Source #
Instance details Defined in Network.Reddit.Types.Message Methods (==) :: MessageOpts -> MessageOpts -> Bool # (/=) :: MessageOpts -> MessageOpts -> Bool #
Show MessageOpts Source #
Instance details Defined in Network.Reddit.Types.Message Methods showsPrec :: Int -> MessageOpts -> ShowS # show :: MessageOpts -> String # showList :: [MessageOpts] -> ShowS #
Generic MessageOpts Source #
Instance details Defined in Network.Reddit.Types.Message Associated Types type Rep MessageOpts :: Type -> Type # Methods from :: MessageOpts -> Rep MessageOpts x # to :: Rep MessageOpts x -> MessageOpts #
ToForm MessageOpts Source #
Instance details Defined in Network.Reddit.Types.Message Methods toForm :: MessageOpts -> Form #
type Rep MessageOpts Source #
Instance details Defined in Network.Reddit.Types.Message type Rep MessageOpts = D1 ('MetaData "MessageOpts" "Network.Reddit.Types.Message" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "MessageOpts" 'PrefixI 'True) (S1 ('MetaSel ('Just "mark") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)))

data Message Source #

A private message or comment reply

Constructors

Message MessageID Username Username Body Body Subject UTCTime Bool (Seq Message)

Instances

Instances details

Eq Message Source #
Instance details Defined in Network.Reddit.Types.Message Methods (==) :: Message -> Message -> Bool # (/=) :: Message -> Message -> Bool #
Show Message Source #
Instance details Defined in Network.Reddit.Types.Message Methods showsPrec :: Int -> Message -> ShowS # show :: Message -> String # showList :: [Message] -> ShowS #
Generic Message Source #
Instance details Defined in Network.Reddit.Types.Message Associated Types type Rep Message :: Type -> Type # Methods from :: Message -> Rep Message x # to :: Rep Message x -> Message #
FromJSON Message Source #
Instance details Defined in Network.Reddit.Types.Message Methods parseJSON :: Value -> Parser Message # parseJSONList :: Value -> Parser [Message] #
Paginable Message Source #
Instance details Defined in Network.Reddit.Types.Message Associated Types type PaginateOptions Message Source # type PaginateThing Message Source # Methods defaultOpts :: PaginateOptions Message Source # getFullname :: Message -> PaginateThing Message Source # optsToForm :: PaginateOptions Message -> Form Source #
type Rep Message Source #
Instance details Defined in Network.Reddit.Types.Message type Rep Message = D1 ('MetaData "Message" "Network.Reddit.Types.Message" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "Message" 'PrefixI 'True) (((S1 ('MetaSel ('Just "messageID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 MessageID) :: S1 ('MetaSel ('Just "author") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Username)) :: (S1 ('MetaSel ('Just "dest") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Username) :: S1 ('MetaSel ('Just "body") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Body))) :: ((S1 ('MetaSel ('Just "bodyHTML") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Body) :: S1 ('MetaSel ('Just "subject") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Subject)) :: (S1 ('MetaSel ('Just "created") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UTCTime) :: (S1 ('MetaSel ('Just "new") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: S1 ('MetaSel ('Just "replies") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Seq Message)))))))
type PaginateOptions Message Source #
Instance details Defined in Network.Reddit.Types.Message type PaginateOptions Message = MessageOpts
type PaginateThing Message Source #
Instance details Defined in Network.Reddit.Types.Message type PaginateThing Message = MessageID