heddit-0.0.1: Reddit API bindings
Copyright(c) 2021 Rory Tyler Hayford
LicenseBSD-3-Clause
Maintainerrory.hayford@protonmail.com
Stabilityexperimental
PortabilityGHC
Safe HaskellNone
LanguageHaskell2010

Network.Reddit.Types.Live

Description

 
Synopsis

Documentation

data LiveThread Source #

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

Constructors

LiveThread 

Fields

Instances

Instances details
Eq LiveThread Source # 
Instance details

Defined in Network.Reddit.Types.Live

Show LiveThread Source # 
Instance details

Defined in Network.Reddit.Types.Live

Generic LiveThread Source # 
Instance details

Defined in Network.Reddit.Types.Live

Associated Types

type Rep LiveThread :: Type -> Type #

FromJSON LiveThread Source # 
Instance details

Defined in Network.Reddit.Types.Live

Paginable LiveThread Source # 
Instance details

Defined in Network.Reddit.Types.Live

type Rep LiveThread Source # 
Instance details

Defined in Network.Reddit.Types.Live

type PaginateOptions LiveThread Source # 
Instance details

Defined in Network.Reddit.Types.Live

type PaginateThing LiveThread Source # 
Instance details

Defined in Network.Reddit.Types.Live

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

Show LiveThreadID Source # 
Instance details

Defined in Network.Reddit.Types.Live

Generic LiveThreadID Source # 
Instance details

Defined in Network.Reddit.Types.Live

Associated Types

type Rep LiveThreadID :: Type -> Type #

FromJSON LiveThreadID Source # 
Instance details

Defined in Network.Reddit.Types.Live

ToHttpApiData LiveThreadID Source # 
Instance details

Defined in Network.Reddit.Types.Live

Thing LiveThreadID Source # 
Instance details

Defined in Network.Reddit.Types.Live

type Rep LiveThreadID Source # 
Instance details

Defined in Network.Reddit.Types.Live

type Rep LiveThreadID = D1 ('MetaData "LiveThreadID" "Network.Reddit.Types.Live" "heddit-0.0.1-76ROQ5tOAm3CpLSaFw8ccb" 'True) (C1 ('MetaCons "LiveThreadID" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data PostableLiveThread Source #

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

Constructors

PostableLiveThread 

Fields

Instances

Instances details
Eq PostableLiveThread Source # 
Instance details

Defined in Network.Reddit.Types.Live

Show PostableLiveThread Source # 
Instance details

Defined in Network.Reddit.Types.Live

Generic PostableLiveThread Source # 
Instance details

Defined in Network.Reddit.Types.Live

Associated Types

type Rep PostableLiveThread :: Type -> Type #

ToForm PostableLiveThread Source # 
Instance details

Defined in Network.Reddit.Types.Live

type Rep PostableLiveThread Source # 
Instance details

Defined in Network.Reddit.Types.Live

type Rep PostableLiveThread = D1 ('MetaData "PostableLiveThread" "Network.Reddit.Types.Live" "heddit-0.0.1-76ROQ5tOAm3CpLSaFw8ccb" '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))))

type NewLiveThread = PostableLiveThread Source #

Type synonym for creating new live threads

type UpdatedLiveThread = PostableLiveThread Source #

Type synonym for updating existing live threads

liveThreadToPostable :: LiveThread -> UpdatedLiveThread Source #

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

mkNewLiveThread :: Title -> NewLiveThread Source #

Create a NewLiveThread with default values for most fields

data PostedLiveThread Source #

Wrapper for parsing the ID returned from POSTing a livethred

Instances

Instances details
Show PostedLiveThread Source # 
Instance details

Defined in Network.Reddit.Types.Live

Generic PostedLiveThread Source # 
Instance details

Defined in Network.Reddit.Types.Live

Associated Types

type Rep PostedLiveThread :: Type -> Type #

FromJSON PostedLiveThread Source # 
Instance details

Defined in Network.Reddit.Types.Live

type Rep PostedLiveThread Source # 
Instance details

Defined in Network.Reddit.Types.Live

type Rep PostedLiveThread = D1 ('MetaData "PostedLiveThread" "Network.Reddit.Types.Live" "heddit-0.0.1-76ROQ5tOAm3CpLSaFw8ccb" 'True) (C1 ('MetaCons "PostedLiveThread" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 LiveThreadID)))

data LiveUpdate Source #

An individual update in a LiveThread

Instances

Instances details
Eq LiveUpdate Source # 
Instance details

Defined in Network.Reddit.Types.Live

Show LiveUpdate Source # 
Instance details

Defined in Network.Reddit.Types.Live

Generic LiveUpdate Source # 
Instance details

Defined in Network.Reddit.Types.Live

Associated Types

type Rep LiveUpdate :: Type -> Type #

FromJSON LiveUpdate Source # 
Instance details

Defined in Network.Reddit.Types.Live

Paginable LiveUpdate Source # 
Instance details

Defined in Network.Reddit.Types.Live

type Rep LiveUpdate Source # 
Instance details

Defined in Network.Reddit.Types.Live

type PaginateOptions LiveUpdate Source # 
Instance details

Defined in Network.Reddit.Types.Live

type PaginateThing LiveUpdate Source # 
Instance details

Defined in Network.Reddit.Types.Live

newtype LiveUpdateID Source #

ID for a LiveUpdate

Constructors

LiveUpdateID Text 

Instances

Instances details
Eq LiveUpdateID Source # 
Instance details

Defined in Network.Reddit.Types.Live

Show LiveUpdateID Source # 
Instance details

Defined in Network.Reddit.Types.Live

Generic LiveUpdateID Source # 
Instance details

Defined in Network.Reddit.Types.Live

Associated Types

type Rep LiveUpdateID :: Type -> Type #

FromJSON LiveUpdateID Source # 
Instance details

Defined in Network.Reddit.Types.Live

ToHttpApiData LiveUpdateID Source # 
Instance details

Defined in Network.Reddit.Types.Live

Thing LiveUpdateID Source # 
Instance details

Defined in Network.Reddit.Types.Live

type Rep LiveUpdateID Source # 
Instance details

Defined in Network.Reddit.Types.Live

type Rep LiveUpdateID = D1 ('MetaData "LiveUpdateID" "Network.Reddit.Types.Live" "heddit-0.0.1-76ROQ5tOAm3CpLSaFw8ccb" 'True) (C1 ('MetaCons "LiveUpdateID" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data LiveUpdateEmbed Source #

External resources embedded in a LiveUpdate

Constructors

LiveUpdateEmbed 

Fields

data LiveContributor Source #

A user contributor in a LiveThread

newtype LiveContributorList Source #

Wrapper to parse lists of LiveContributors

Instances

Instances details
Show LiveContributorList Source # 
Instance details

Defined in Network.Reddit.Types.Live

Generic LiveContributorList Source # 
Instance details

Defined in Network.Reddit.Types.Live

Associated Types

type Rep LiveContributorList :: Type -> Type #

FromJSON LiveContributorList Source # 
Instance details

Defined in Network.Reddit.Types.Live

type Rep LiveContributorList Source # 
Instance details

Defined in Network.Reddit.Types.Live

type Rep LiveContributorList = D1 ('MetaData "LiveContributorList" "Network.Reddit.Types.Live" "heddit-0.0.1-76ROQ5tOAm3CpLSaFw8ccb" 'True) (C1 ('MetaCons "LiveContributorList" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Seq LiveContributor))))

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

Enum LivePermission Source # 
Instance details

Defined in Network.Reddit.Types.Live

Eq LivePermission Source # 
Instance details

Defined in Network.Reddit.Types.Live

Ord LivePermission Source # 
Instance details

Defined in Network.Reddit.Types.Live

Show LivePermission Source # 
Instance details

Defined in Network.Reddit.Types.Live

Generic LivePermission Source # 
Instance details

Defined in Network.Reddit.Types.Live

Associated Types

type Rep LivePermission :: Type -> Type #

FromJSON LivePermission Source # 
Instance details

Defined in Network.Reddit.Types.Live

ToHttpApiData LivePermission Source # 
Instance details

Defined in Network.Reddit.Types.Live

type Rep LivePermission Source # 
Instance details

Defined in Network.Reddit.Types.Live

type Rep LivePermission = D1 ('MetaData "LivePermission" "Network.Reddit.Types.Live" "heddit-0.0.1-76ROQ5tOAm3CpLSaFw8ccb" '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 LiveReportType Source #

The reason for reporting the LiveThread to the Reddit admins

Instances

Instances details
Eq LiveReportType Source # 
Instance details

Defined in Network.Reddit.Types.Live

Show LiveReportType Source # 
Instance details

Defined in Network.Reddit.Types.Live

Generic LiveReportType Source # 
Instance details

Defined in Network.Reddit.Types.Live

Associated Types

type Rep LiveReportType :: Type -> Type #

ToHttpApiData LiveReportType Source # 
Instance details

Defined in Network.Reddit.Types.Live

type Rep LiveReportType Source # 
Instance details

Defined in Network.Reddit.Types.Live

type Rep LiveReportType = D1 ('MetaData "LiveReportType" "Network.Reddit.Types.Live" "heddit-0.0.1-76ROQ5tOAm3CpLSaFw8ccb" '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 LiveState Source #

The state of the LiveThread

Constructors

Current 
Complete 

Instances

Instances details
Eq LiveState Source # 
Instance details

Defined in Network.Reddit.Types.Live

Show LiveState Source # 
Instance details

Defined in Network.Reddit.Types.Live

Generic LiveState Source # 
Instance details

Defined in Network.Reddit.Types.Live

Associated Types

type Rep LiveState :: Type -> Type #

FromJSON LiveState Source # 
Instance details

Defined in Network.Reddit.Types.Live

type Rep LiveState Source # 
Instance details

Defined in Network.Reddit.Types.Live

type Rep LiveState = D1 ('MetaData "LiveState" "Network.Reddit.Types.Live" "heddit-0.0.1-76ROQ5tOAm3CpLSaFw8ccb" 'False) (C1 ('MetaCons "Current" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Complete" 'PrefixI 'False) (U1 :: Type -> Type))