Network.Reddit.Types.Award

Documentation

data Awarding

Information about a Reddit award that has been granted. This can be a "global" award that may be granted site-wide, or a "community" award that is limited to a single subreddit

Instances

Eq Awarding

Defined in Network.Reddit.Types.Award

Methods

(==) :: Awarding -> Awarding -> Bool

(/=) :: Awarding -> Awarding -> Bool

Show Awarding

Defined in Network.Reddit.Types.Award

Methods

showsPrec :: Int -> Awarding -> ShowS

show :: Awarding -> String

showList :: [Awarding] -> ShowS

Generic Awarding

Defined in Network.Reddit.Types.Award

Associated Types

type Rep Awarding :: Type -> Type

Methods

from :: Awarding -> Rep Awarding x

to :: Rep Awarding x -> Awarding

FromJSON Awarding

Defined in Network.Reddit.Types.Award

Methods

parseJSON :: Value -> Parser Awarding

parseJSONList :: Value -> Parser [Awarding]

type Rep Awarding

Defined in Network.Reddit.Types.Award

type Rep Awarding = D1 ('MetaData "Awarding" "Network.Reddit.Types.Award" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "Awarding" 'PrefixI 'True) (((S1 ('MetaSel ('Just "awardID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AwardID) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Name) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Body))) :*: (S1 ('MetaSel ('Just "subredditID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SubredditID)) :*: (S1 ('MetaSel ('Just "awardType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AwardType) :*: S1 ('MetaSel ('Just "count") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))) :*: ((S1 ('MetaSel ('Just "coinPrice") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: (S1 ('MetaSel ('Just "coinReward") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "daysOfPremium") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) :*: (S1 ('MetaSel ('Just "iconURL") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 URL) :*: (S1 ('MetaSel ('Just "iconHeight") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "iconWidth") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newtype AwardID

The ID for an award, which users can grant each other. If you want to create a new AwardID, see the bundled pattern synonyms for this type, which include various common awards. Also see "doc/awards.org" in this repository for a list of awards and their IDs.

Note: Most newer awards are composed of a UUID identifier and an "award_" prefix. If you construct this type directly, you should omit the prefix, which will be added for you when making API requests

Constructors

AwardID Text

Bundled Patterns

pattern Silver :: AwardID

pattern Gold :: AwardID

pattern Platinum :: AwardID

pattern Argentium :: AwardID

pattern Ternion :: AwardID

Instances

Eq AwardID

Defined in Network.Reddit.Types.Award

Methods

(==) :: AwardID -> AwardID -> Bool

(/=) :: AwardID -> AwardID -> Bool

Show AwardID

Defined in Network.Reddit.Types.Award

Methods

showsPrec :: Int -> AwardID -> ShowS

show :: AwardID -> String

showList :: [AwardID] -> ShowS

Generic AwardID

Defined in Network.Reddit.Types.Award

Associated Types

type Rep AwardID :: Type -> Type

Methods

from :: AwardID -> Rep AwardID x

to :: Rep AwardID x -> AwardID

Hashable AwardID

Defined in Network.Reddit.Types.Award

Methods

hashWithSalt :: Int -> AwardID -> Int

hash :: AwardID -> Int

FromJSON AwardID

Defined in Network.Reddit.Types.Award

Methods

parseJSON :: Value -> Parser AwardID

parseJSONList :: Value -> Parser [AwardID]

FromJSONKey AwardID

Defined in Network.Reddit.Types.Award

Methods

fromJSONKey :: FromJSONKeyFunction AwardID

fromJSONKeyList :: FromJSONKeyFunction [AwardID]

ToHttpApiData AwardID

Defined in Network.Reddit.Types.Award

Methods

toUrlPiece :: AwardID -> Text

toEncodedUrlPiece :: AwardID -> Builder

toHeader :: AwardID -> ByteString

toQueryParam :: AwardID -> Text

type Rep AwardID

Defined in Network.Reddit.Types.Award

type Rep AwardID = D1 ('MetaData "AwardID" "Network.Reddit.Types.Award" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'True) (C1 ('MetaCons "AwardID" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data AwardType

The type of the Awarding, either site-wide ("global") or limited to a "community"

Constructors

Global

Community

Instances

Eq AwardType

Defined in Network.Reddit.Types.Award

Methods

(==) :: AwardType -> AwardType -> Bool

(/=) :: AwardType -> AwardType -> Bool

Show AwardType

Defined in Network.Reddit.Types.Award

Methods

showsPrec :: Int -> AwardType -> ShowS

show :: AwardType -> String

showList :: [AwardType] -> ShowS

Generic AwardType

Defined in Network.Reddit.Types.Award

Associated Types

type Rep AwardType :: Type -> Type

Methods

from :: AwardType -> Rep AwardType x

to :: Rep AwardType x -> AwardType

FromJSON AwardType

Defined in Network.Reddit.Types.Award

Methods

parseJSON :: Value -> Parser AwardType

parseJSONList :: Value -> Parser [AwardType]

type Rep AwardType

Defined in Network.Reddit.Types.Award

type Rep AwardType = D1 ('MetaData "AwardType" "Network.Reddit.Types.Award" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "Global" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Community" 'PrefixI 'False) (U1 :: Type -> Type))

data Award

Options for awarding an item

Constructors

Award

Fields

• awardID :: AwardID

  The ID of the award you wish to grant. See AwardID and its bundled pattern synonyms for common awards (e.g. gold)

• isAnonymous :: Bool

  If the award is issued anonymously

• message :: Maybe Body

  Optional message sent to the recipient

Instances

Eq Award

Defined in Network.Reddit.Types.Award

Methods

(==) :: Award -> Award -> Bool

(/=) :: Award -> Award -> Bool

Show Award

Defined in Network.Reddit.Types.Award

Methods

showsPrec :: Int -> Award -> ShowS

show :: Award -> String

showList :: [Award] -> ShowS

Generic Award

Defined in Network.Reddit.Types.Award

Associated Types

type Rep Award :: Type -> Type

Methods

from :: Award -> Rep Award x

to :: Rep Award x -> Award

ToForm Award

Defined in Network.Reddit.Types.Award

Methods

toForm :: Award -> Form

type Rep Award

Defined in Network.Reddit.Types.Award

type Rep Award = D1 ('MetaData "Award" "Network.Reddit.Types.Award" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "Award" 'PrefixI 'True) (S1 ('MetaSel ('Just "awardID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AwardID) :*: (S1 ('MetaSel ('Just "isAnonymous") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Body)))))

mkAward :: AwardID -> Award

Create a new anonymous Awarding without a message, given an AwardID

data Trophy

A Reddit trophy, such as the "one-year club", that the Reddit grants users. Redditors cannot gift each other these trophies

Instances

Eq Trophy

Defined in Network.Reddit.Types.Award

Methods

(==) :: Trophy -> Trophy -> Bool

(/=) :: Trophy -> Trophy -> Bool

Show Trophy

Defined in Network.Reddit.Types.Award

Methods

showsPrec :: Int -> Trophy -> ShowS

show :: Trophy -> String

showList :: [Trophy] -> ShowS

Generic Trophy

Defined in Network.Reddit.Types.Award

Associated Types

type Rep Trophy :: Type -> Type

Methods

from :: Trophy -> Rep Trophy x

to :: Rep Trophy x -> Trophy

FromJSON Trophy

Defined in Network.Reddit.Types.Award

Methods

parseJSON :: Value -> Parser Trophy

parseJSONList :: Value -> Parser [Trophy]

type Rep Trophy

Defined in Network.Reddit.Types.Award

type Rep Trophy = D1 ('MetaData "Trophy" "Network.Reddit.Types.Award" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "Trophy" 'PrefixI 'True) (((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Name) :*: S1 ('MetaSel ('Just "trophyID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TrophyID))) :*: (S1 ('MetaSel ('Just "awardID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Body)))) :*: ((S1 ('MetaSel ('Just "grantedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UTCTime)) :*: S1 ('MetaSel ('Just "url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe URL))) :*: (S1 ('MetaSel ('Just "icon40") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 URL) :*: S1 ('MetaSel ('Just "icon70") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 URL)))))

type TrophyID = Text

The ID of a Trophy

data TrophyList

Wrapper for parsing JSON objects listing Trophys

Instances

Show TrophyList

Defined in Network.Reddit.Types.Award

Methods

showsPrec :: Int -> TrophyList -> ShowS

show :: TrophyList -> String

showList :: [TrophyList] -> ShowS

Generic TrophyList

Defined in Network.Reddit.Types.Award

Associated Types

type Rep TrophyList :: Type -> Type

Methods

from :: TrophyList -> Rep TrophyList x

to :: Rep TrophyList x -> TrophyList

FromJSON TrophyList

Defined in Network.Reddit.Types.Award

Methods

parseJSON :: Value -> Parser TrophyList

parseJSONList :: Value -> Parser [TrophyList]

type Rep TrophyList

Defined in Network.Reddit.Types.Award

type Rep TrophyList = D1 ('MetaData "TrophyList" "Network.Reddit.Types.Award" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'True) (C1 ('MetaCons "TrophyList" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Seq Trophy))))

data AwardingsSummary

A summary of your Awardings, returned after you have awarded an item

Constructors

AwardingsSummary

Fields

• allAwardings :: Seq Awarding

  All of the awardings issued by the current user

• gildings :: HashMap AwardID Integer

  A mapping of award IDs to the number of times the authenticated user has granted each one

• coins :: Integer

  Coin balance for the authenticated user

Instances

Eq AwardingsSummary

Defined in Network.Reddit.Types.Award

Methods

(==) :: AwardingsSummary -> AwardingsSummary -> Bool

(/=) :: AwardingsSummary -> AwardingsSummary -> Bool

Show AwardingsSummary

Defined in Network.Reddit.Types.Award

Methods

showsPrec :: Int -> AwardingsSummary -> ShowS

show :: AwardingsSummary -> String

showList :: [AwardingsSummary] -> ShowS

Generic AwardingsSummary

Defined in Network.Reddit.Types.Award

Associated Types

type Rep AwardingsSummary :: Type -> Type

Methods

from :: AwardingsSummary -> Rep AwardingsSummary x

to :: Rep AwardingsSummary x -> AwardingsSummary

FromJSON AwardingsSummary

Defined in Network.Reddit.Types.Award

Methods

parseJSON :: Value -> Parser AwardingsSummary

parseJSONList :: Value -> Parser [AwardingsSummary]

type Rep AwardingsSummary

Defined in Network.Reddit.Types.Award

type Rep AwardingsSummary = D1 ('MetaData "AwardingsSummary" "Network.Reddit.Types.Award" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "AwardingsSummary" 'PrefixI 'True) (S1 ('MetaSel ('Just "allAwardings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Seq Awarding)) :*: (S1 ('MetaSel ('Just "gildings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap AwardID Integer)) :*: S1 ('MetaSel ('Just "coins") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Integer))))