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.Live

Contents

Actions
- Live thread contribution
Types

Description

Actions for working with LiveThreads

Synopsis

getLiveThread :: MonadReddit m => LiveThreadID -> m LiveThread
getLiveInfo :: (MonadReddit m, Foldable t) => t LiveThreadID -> Paginator LiveThreadID LiveThread -> m (Listing LiveThreadID LiveThread)
getAllLiveInfo :: (MonadReddit m, Traversable t) => t LiveThreadID -> m (Seq LiveThread)
getLiveUpdates :: MonadReddit m => LiveThreadID -> Paginator LiveUpdateID LiveUpdate -> m (Listing LiveUpdateID LiveUpdate)
getLiveUpdate :: MonadReddit m => LiveThreadID -> LiveUpdateID -> m LiveUpdate
getLiveDiscussions :: MonadReddit m => LiveThreadID -> Paginator SubmissionID Submission -> m (Listing SubmissionID Submission)
getLiveContributors :: MonadReddit m => LiveThreadID -> m (Seq LiveContributor)
reportLiveThread :: MonadReddit m => LiveReportType -> LiveThreadID -> m ()
createLiveThread :: MonadReddit m => NewLiveThread -> m LiveThread
closeLiveThread :: MonadReddit m => LiveThreadID -> m ()
updateLiveThread :: MonadReddit m => LiveThreadID -> UpdatedLiveThread -> m ()
addLiveUpdate :: MonadReddit m => LiveThreadID -> Body -> m ()
strikeLiveUpdate :: MonadReddit m => LiveThreadID -> LiveUpdateID -> m ()
deleteLiveUpdate :: MonadReddit m => LiveThreadID -> LiveUpdateID -> m ()
removeLiveContributor :: MonadReddit m => LiveThreadID -> UserID -> m ()
removeLiveContributorByName :: MonadReddit m => LiveThreadID -> Username -> m ()
updateLiveContributor :: (MonadReddit m, Foldable t) => Maybe (t LivePermission) -> LiveThreadID -> Username -> m ()
abdicateLiveContributor :: MonadReddit m => LiveThreadID -> m ()
inviteLiveContributor :: MonadReddit m => LiveThreadID -> Username -> m ()
inviteLiveContributorWithPerms :: (MonadReddit m, Foldable t) => t LivePermission -> LiveThreadID -> Username -> m ()
revokeLiveInvitation :: MonadReddit m => LiveThreadID -> UserID -> m ()
revokeLiveInvitationByName :: MonadReddit m => LiveThreadID -> Username -> m ()
data LiveReportType
- = Spam
- | VoteManipulation
- | PersonalInfo
- | Sexualizing
- | SiteBreaking
data LivePermission
- = Edit
- | Update
- | Manage
- | Settings
data LiveContributor = LiveContributor UserID Username [LivePermission]
data LiveUpdateEmbed = LiveUpdateEmbed URL (Maybe Integer) (Maybe Integer)
newtype LiveUpdateID = LiveUpdateID Text
data LiveUpdate = LiveUpdate LiveUpdateID Username Body Body Bool (Seq LiveUpdateEmbed)
type UpdatedLiveThread = PostableLiveThread
type NewLiveThread = PostableLiveThread
data PostableLiveThread = PostableLiveThread Title (Maybe Body) (Maybe Body) Bool
data LiveState
- = Current
- | Complete
newtype LiveThreadID = LiveThreadID Text
data LiveThread = LiveThread LiveThreadID Title (Maybe Body) (Maybe Body) (Maybe Body) (Maybe Body) UTCTime (Maybe Integer) LiveState Bool (Maybe URL)
mkNewLiveThread :: Title -> NewLiveThread
liveThreadToPostable :: LiveThread -> UpdatedLiveThread

Actions

getLiveThread :: MonadReddit m => LiveThreadID -> m LiveThread Source #

Get the details on a single LiveThread given its ID

getLiveInfo :: (MonadReddit m, Foldable t) => t LiveThreadID -> Paginator LiveThreadID LiveThread -> m (Listing LiveThreadID LiveThread) Source #

Get information about live threads corresponding to each of the LiveThreadIDs in the given container. Invalid IDs are silently discarded by this endpoint

Note: This endpoint will only accept a maximum of 100 LiveThreadIDs. If you would like to get all of the information for a larger number of LiveThreads at once, see getAllLiveInfo

getAllLiveInfo :: (MonadReddit m, Traversable t) => t LiveThreadID -> m (Seq LiveThread) Source #

Get all of the LiveThreads corresponding to a container of LiveThreadIDs, without a limit

getLiveUpdates :: MonadReddit m => LiveThreadID -> Paginator LiveUpdateID LiveUpdate -> m (Listing LiveUpdateID LiveUpdate) Source #

Get a Listing of LiveUpdates for the given live thread

getLiveUpdate :: MonadReddit m => LiveThreadID -> LiveUpdateID -> m LiveUpdate Source #

Get a single LiveUpdate for the given live thread

getLiveDiscussions :: MonadReddit m => LiveThreadID -> Paginator SubmissionID Submission -> m (Listing SubmissionID Submission) Source #

Get a Listing of Submissions representing the discussions on the given live thread

getLiveContributors :: MonadReddit m => LiveThreadID -> m (Seq LiveContributor) Source #

Get a list of contributors to the live thread

reportLiveThread :: MonadReddit m => LiveReportType -> LiveThreadID -> m () Source #

Report the given live thread to Reddit admins with the provided reason

createLiveThread :: MonadReddit m => NewLiveThread -> m LiveThread Source #

Create a NewLiveThread, returning the LiveThread upon success. Also see mkNewLiveThread

closeLiveThread :: MonadReddit m => LiveThreadID -> m () Source #

Close an existing live thread. After closing, it is no longer possible to update or modify the live thread

Warning: This action is irreversible

updateLiveThread :: MonadReddit m => LiveThreadID -> UpdatedLiveThread -> m () Source #

Update the existing live thread with new settings

addLiveUpdate :: MonadReddit m => LiveThreadID -> Body -> m () Source #

Add an update to the live thread

strikeLiveUpdate :: MonadReddit m => LiveThreadID -> LiveUpdateID -> m () Source #

Strike the existing LiveUpdate, causing its stricken field to be True and the content to be crossed-out and marked incorrect on the web UI

deleteLiveUpdate :: MonadReddit m => LiveThreadID -> LiveUpdateID -> m () Source #

Strike the existing LiveUpdate, causing its stricken field to be True and the content to be crossed-out and marked incorrect on the web UI

Live thread contribution

removeLiveContributor :: MonadReddit m => LiveThreadID -> UserID -> m () Source #

Remove the user as a contributor to the live thread. If you don't know the contributor's user ID, you can use removeLiveContributorByName

removeLiveContributorByName :: MonadReddit m => LiveThreadID -> Username -> m () Source #

Remove the live contributor by username. Note that this action must perform an additional network request to fetch the user ID from the given username

updateLiveContributor Source #

Arguments

:: (MonadReddit m, Foldable t)
=> Maybe (t LivePermission)	If `Nothing`, grants all contributor permissions. If `Just` but empty, removes all permissions
-> LiveThreadID
-> Username
-> m ()

Update the permissions for the live contributor

abdicateLiveContributor :: MonadReddit m => LiveThreadID -> m () Source #

Abdicate your role as a live contributor, removing all access and permissions

Warning: This cannot be undone, even if you are the creator of the live thread

inviteLiveContributor :: MonadReddit m => LiveThreadID -> Username -> m () Source #

Invite a user to contribute to the live thread. Note that this implicitly grants all permissions to the invitee. If you would like more fine-grained control over permissions, see inviteLiveContributorWithPerms

inviteLiveContributorWithPerms Source #

Arguments

:: (MonadReddit m, Foldable t)
=> t LivePermission	If empty, grants no permissions
-> LiveThreadID
-> Username
-> m ()

As inviteLiveContributor, but allows customization of the permissions granted to the invitee

revokeLiveInvitation :: MonadReddit m => LiveThreadID -> UserID -> m () Source #

Revoke the invitation to contribute to the live thread. If you don't know the contributor's user ID, you can use revokeLiveInvitationByName

revokeLiveInvitationByName :: MonadReddit m => LiveThreadID -> Username -> m () Source #

Revoke the live invitation by username. Note that this action must perform an additional network request to fetch the user ID from the given username

Types

data LiveReportType Source #

The reason for reporting the LiveThread to the Reddit admins

Constructors

Spam
VoteManipulation
PersonalInfo
Sexualizing
SiteBreaking

Instances

Instances details

Eq LiveReportType Source #
Instance details Defined in Network.Reddit.Types.Live Methods (==) :: LiveReportType -> LiveReportType -> Bool # (/=) :: LiveReportType -> LiveReportType -> Bool #
Show LiveReportType Source #
Instance details Defined in Network.Reddit.Types.Live Methods showsPrec :: Int -> LiveReportType -> ShowS # show :: LiveReportType -> String # showList :: [LiveReportType] -> ShowS #
Generic LiveReportType Source #
Instance details Defined in Network.Reddit.Types.Live Associated Types type Rep LiveReportType :: Type -> Type # Methods from :: LiveReportType -> Rep LiveReportType x # to :: Rep LiveReportType x -> LiveReportType #
ToHttpApiData LiveReportType Source #
Instance details Defined in Network.Reddit.Types.Live Methods toUrlPiece :: LiveReportType -> Text # toEncodedUrlPiece :: LiveReportType -> Builder # toHeader :: LiveReportType -> ByteString # toQueryParam :: LiveReportType -> Text #
type Rep LiveReportType Source #
Instance details Defined in Network.Reddit.Types.Live type Rep LiveReportType = D1 ('MetaData "LiveReportType" "Network.Reddit.Types.Live" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) ((C1 ('MetaCons "Spam" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "VoteManipulation" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "PersonalInfo" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Sexualizing" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "SiteBreaking" 'PrefixI 'False) (U1 :: Type -> Type))))

data LivePermission Source #

Permission granted to a LiveContributor

Constructors

Edit
Update
Manage
Settings

Instances

Instances details

Bounded LivePermission Source #
Instance details Defined in Network.Reddit.Types.Live Methods minBound :: LivePermission # maxBound :: LivePermission #
Enum LivePermission Source #
Instance details Defined in Network.Reddit.Types.Live Methods succ :: LivePermission -> LivePermission # pred :: LivePermission -> LivePermission # toEnum :: Int -> LivePermission # fromEnum :: LivePermission -> Int # enumFrom :: LivePermission -> [LivePermission] # enumFromThen :: LivePermission -> LivePermission -> [LivePermission] # enumFromTo :: LivePermission -> LivePermission -> [LivePermission] # enumFromThenTo :: LivePermission -> LivePermission -> LivePermission -> [LivePermission] #
Eq LivePermission Source #
Instance details Defined in Network.Reddit.Types.Live Methods (==) :: LivePermission -> LivePermission -> Bool # (/=) :: LivePermission -> LivePermission -> Bool #
Ord LivePermission Source #
Instance details Defined in Network.Reddit.Types.Live Methods compare :: LivePermission -> LivePermission -> Ordering # (<) :: LivePermission -> LivePermission -> Bool # (<=) :: LivePermission -> LivePermission -> Bool # (>) :: LivePermission -> LivePermission -> Bool # (>=) :: LivePermission -> LivePermission -> Bool # max :: LivePermission -> LivePermission -> LivePermission # min :: LivePermission -> LivePermission -> LivePermission #
Show LivePermission Source #
Instance details Defined in Network.Reddit.Types.Live Methods showsPrec :: Int -> LivePermission -> ShowS # show :: LivePermission -> String # showList :: [LivePermission] -> ShowS #
Generic LivePermission Source #
Instance details Defined in Network.Reddit.Types.Live Associated Types type Rep LivePermission :: Type -> Type # Methods from :: LivePermission -> Rep LivePermission x # to :: Rep LivePermission x -> LivePermission #
FromJSON LivePermission Source #
Instance details Defined in Network.Reddit.Types.Live Methods parseJSON :: Value -> Parser LivePermission # parseJSONList :: Value -> Parser [LivePermission] #
ToHttpApiData LivePermission Source #
Instance details Defined in Network.Reddit.Types.Live Methods toUrlPiece :: LivePermission -> Text # toEncodedUrlPiece :: LivePermission -> Builder # toHeader :: LivePermission -> ByteString # toQueryParam :: LivePermission -> Text #
type Rep LivePermission Source #
Instance details Defined in Network.Reddit.Types.Live type Rep LivePermission = D1 ('MetaData "LivePermission" "Network.Reddit.Types.Live" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) ((C1 ('MetaCons "Edit" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Update" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Manage" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Settings" 'PrefixI 'False) (U1 :: Type -> Type)))

data LiveContributor Source #

A user contributor in a LiveThread

Constructors

LiveContributor UserID Username [LivePermission]

Instances

Instances details

Eq LiveContributor Source #
Instance details Defined in Network.Reddit.Types.Live Methods (==) :: LiveContributor -> LiveContributor -> Bool # (/=) :: LiveContributor -> LiveContributor -> Bool #
Show LiveContributor Source #
Instance details Defined in Network.Reddit.Types.Live Methods showsPrec :: Int -> LiveContributor -> ShowS # show :: LiveContributor -> String # showList :: [LiveContributor] -> ShowS #
Generic LiveContributor Source #
Instance details Defined in Network.Reddit.Types.Live Associated Types type Rep LiveContributor :: Type -> Type # Methods from :: LiveContributor -> Rep LiveContributor x # to :: Rep LiveContributor x -> LiveContributor #
FromJSON LiveContributor Source #
Instance details Defined in Network.Reddit.Types.Live Methods parseJSON :: Value -> Parser LiveContributor # parseJSONList :: Value -> Parser [LiveContributor] #
type Rep LiveContributor Source #
Instance details Defined in Network.Reddit.Types.Live type Rep LiveContributor = D1 ('MetaData "LiveContributor" "Network.Reddit.Types.Live" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "LiveContributor" 'PrefixI 'True) (S1 ('MetaSel ('Just "userID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UserID) :: (S1 ('MetaSel ('Just "username") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Username) :: S1 ('MetaSel ('Just "permissions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [LivePermission]))))

data LiveUpdateEmbed Source #

External resources embedded in a LiveUpdate

Constructors

LiveUpdateEmbed URL (Maybe Integer) (Maybe Integer)

Instances

Instances details

Eq LiveUpdateEmbed Source #
Instance details Defined in Network.Reddit.Types.Live Methods (==) :: LiveUpdateEmbed -> LiveUpdateEmbed -> Bool # (/=) :: LiveUpdateEmbed -> LiveUpdateEmbed -> Bool #
Show LiveUpdateEmbed Source #
Instance details Defined in Network.Reddit.Types.Live Methods showsPrec :: Int -> LiveUpdateEmbed -> ShowS # show :: LiveUpdateEmbed -> String # showList :: [LiveUpdateEmbed] -> ShowS #
Generic LiveUpdateEmbed Source #
Instance details Defined in Network.Reddit.Types.Live Associated Types type Rep LiveUpdateEmbed :: Type -> Type # Methods from :: LiveUpdateEmbed -> Rep LiveUpdateEmbed x # to :: Rep LiveUpdateEmbed x -> LiveUpdateEmbed #
FromJSON LiveUpdateEmbed Source #
Instance details Defined in Network.Reddit.Types.Live Methods parseJSON :: Value -> Parser LiveUpdateEmbed # parseJSONList :: Value -> Parser [LiveUpdateEmbed] #
type Rep LiveUpdateEmbed Source #
Instance details Defined in Network.Reddit.Types.Live type Rep LiveUpdateEmbed = D1 ('MetaData "LiveUpdateEmbed" "Network.Reddit.Types.Live" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "LiveUpdateEmbed" 'PrefixI 'True) (S1 ('MetaSel ('Just "url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 URL) :: (S1 ('MetaSel ('Just "height") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: S1 ('MetaSel ('Just "width") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))))

newtype LiveUpdateID Source #

ID for a LiveUpdate

Constructors

LiveUpdateID Text

Instances

Instances details

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

data LiveUpdate Source #

An individual update in a LiveThread

Constructors

LiveUpdate LiveUpdateID Username Body Body Bool (Seq LiveUpdateEmbed)

Instances

Instances details

Eq LiveUpdate Source #
Instance details Defined in Network.Reddit.Types.Live Methods (==) :: LiveUpdate -> LiveUpdate -> Bool # (/=) :: LiveUpdate -> LiveUpdate -> Bool #
Show LiveUpdate Source #
Instance details Defined in Network.Reddit.Types.Live Methods showsPrec :: Int -> LiveUpdate -> ShowS # show :: LiveUpdate -> String # showList :: [LiveUpdate] -> ShowS #
Generic LiveUpdate Source #
Instance details Defined in Network.Reddit.Types.Live Associated Types type Rep LiveUpdate :: Type -> Type # Methods from :: LiveUpdate -> Rep LiveUpdate x # to :: Rep LiveUpdate x -> LiveUpdate #
FromJSON LiveUpdate Source #
Instance details Defined in Network.Reddit.Types.Live Methods parseJSON :: Value -> Parser LiveUpdate # parseJSONList :: Value -> Parser [LiveUpdate] #
Paginable LiveUpdate Source #
Instance details Defined in Network.Reddit.Types.Live Associated Types type PaginateOptions LiveUpdate Source # type PaginateThing LiveUpdate Source # Methods defaultOpts :: PaginateOptions LiveUpdate Source # getFullname :: LiveUpdate -> PaginateThing LiveUpdate Source # optsToForm :: PaginateOptions LiveUpdate -> Form Source #
type Rep LiveUpdate Source #
Instance details Defined in Network.Reddit.Types.Live type Rep LiveUpdate = D1 ('MetaData "LiveUpdate" "Network.Reddit.Types.Live" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "LiveUpdate" 'PrefixI 'True) ((S1 ('MetaSel ('Just "liveUpdateID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LiveUpdateID) :: (S1 ('MetaSel ('Just "author") '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 "stricken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "embeds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Seq LiveUpdateEmbed))))))
type PaginateOptions LiveUpdate Source #
Instance details Defined in Network.Reddit.Types.Live type PaginateOptions LiveUpdate = ()
type PaginateThing LiveUpdate Source #
Instance details Defined in Network.Reddit.Types.Live type PaginateThing LiveUpdate = LiveUpdateID

type UpdatedLiveThread = PostableLiveThread Source #

Type synonym for updating existing live threads

type NewLiveThread = PostableLiveThread Source #

Type synonym for creating new live threads

data PostableLiveThread Source #

Data to create a new LiveThread or update an existing one. In the latter case, see liveThreadToPostable for conversion

Constructors

PostableLiveThread Title (Maybe Body) (Maybe Body) Bool

Instances

Instances details

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

data LiveState Source #

The state of the LiveThread

Constructors

Current
Complete

Instances

Instances details

Eq LiveState Source #
Instance details Defined in Network.Reddit.Types.Live Methods (==) :: LiveState -> LiveState -> Bool # (/=) :: LiveState -> LiveState -> Bool #
Show LiveState Source #
Instance details Defined in Network.Reddit.Types.Live Methods showsPrec :: Int -> LiveState -> ShowS # show :: LiveState -> String # showList :: [LiveState] -> ShowS #
Generic LiveState Source #
Instance details Defined in Network.Reddit.Types.Live Associated Types type Rep LiveState :: Type -> Type # Methods from :: LiveState -> Rep LiveState x # to :: Rep LiveState x -> LiveState #
FromJSON LiveState Source #
Instance details Defined in Network.Reddit.Types.Live Methods parseJSON :: Value -> Parser LiveState # parseJSONList :: Value -> Parser [LiveState] #
type Rep LiveState Source #
Instance details Defined in Network.Reddit.Types.Live type Rep LiveState = D1 ('MetaData "LiveState" "Network.Reddit.Types.Live" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "Current" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Complete" 'PrefixI 'False) (U1 :: Type -> Type))

newtype LiveThreadID Source #

ID for a single LiveThread

Constructors

LiveThreadID Text

Instances

Instances details

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

data LiveThread Source #

An existing Reddit live thread. It may be currently live or already complete

Constructors

LiveThread LiveThreadID Title (Maybe Body) (Maybe Body) (Maybe Body) (Maybe Body) UTCTime (Maybe Integer) LiveState Bool (Maybe URL)

Instances

Instances details

Eq LiveThread Source #
Instance details Defined in Network.Reddit.Types.Live Methods (==) :: LiveThread -> LiveThread -> Bool # (/=) :: LiveThread -> LiveThread -> Bool #
Show LiveThread Source #
Instance details Defined in Network.Reddit.Types.Live Methods showsPrec :: Int -> LiveThread -> ShowS # show :: LiveThread -> String # showList :: [LiveThread] -> ShowS #
Generic LiveThread Source #
Instance details Defined in Network.Reddit.Types.Live Associated Types type Rep LiveThread :: Type -> Type # Methods from :: LiveThread -> Rep LiveThread x # to :: Rep LiveThread x -> LiveThread #
FromJSON LiveThread Source #
Instance details Defined in Network.Reddit.Types.Live Methods parseJSON :: Value -> Parser LiveThread # parseJSONList :: Value -> Parser [LiveThread] #
Paginable LiveThread Source #
Instance details Defined in Network.Reddit.Types.Live Associated Types type PaginateOptions LiveThread Source # type PaginateThing LiveThread Source # Methods defaultOpts :: PaginateOptions LiveThread Source # getFullname :: LiveThread -> PaginateThing LiveThread Source # optsToForm :: PaginateOptions LiveThread -> Form Source #
type Rep LiveThread Source #
Instance details Defined in Network.Reddit.Types.Live type Rep LiveThread = D1 ('MetaData "LiveThread" "Network.Reddit.Types.Live" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "LiveThread" 'PrefixI 'True) (((S1 ('MetaSel ('Just "liveThreadID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LiveThreadID) :: S1 ('MetaSel ('Just "title") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Title)) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Body)) :: (S1 ('MetaSel ('Just "descriptionHTML") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Body)) :: S1 ('MetaSel ('Just "resources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Body))))) :: ((S1 ('MetaSel ('Just "resourcesHTML") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Body)) :: (S1 ('MetaSel ('Just "created") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UTCTime) :: S1 ('MetaSel ('Just "viewerCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))) :: (S1 ('MetaSel ('Just "liveState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LiveState) :: (S1 ('MetaSel ('Just "nsfw") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: S1 ('MetaSel ('Just "websocketURL") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe URL)))))))
type PaginateOptions LiveThread Source #
Instance details Defined in Network.Reddit.Types.Live type PaginateOptions LiveThread = ()
type PaginateThing LiveThread Source #
Instance details Defined in Network.Reddit.Types.Live type PaginateThing LiveThread = LiveThreadID

mkNewLiveThread :: Title -> NewLiveThread Source #

Create a NewLiveThread with default values for most fields

liveThreadToPostable :: LiveThread -> UpdatedLiveThread Source #

Convenience function to transform an existing LiveThread into a PostableLiveThread, which may be used in updates