Network.Reddit.Types.Emoji

Documentation

data Emoji

A single emoji. This can either be one of Reddit's builtin "snoomojis" or a custom emoji for a subreddit. See mkEmoji for creating news ones

Constructors

Emoji

Fields

• name :: EmojiName

  Depending on how the emoji was obtained, this field may be empty, as names must be taken from keys of a larger JSON object

• modFlairOnly :: Bool

  This field will be present when obtaining existing emojis, but should be left empty when creating new ones

• postFlairAllowed :: Bool
• userFlairAllowed :: Bool
• createdBy :: Maybe UserID

  Points to a Reddit-hosted image. This will be present for existing emoji, but should be left empty when creating them

• url :: Maybe UploadURL

Instances

Eq Emoji

Defined in Network.Reddit.Types.Emoji

Methods

(==) :: Emoji -> Emoji -> Bool

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

Show Emoji

Defined in Network.Reddit.Types.Emoji

Methods

showsPrec :: Int -> Emoji -> ShowS

show :: Emoji -> String

showList :: [Emoji] -> ShowS

Generic Emoji

Defined in Network.Reddit.Types.Emoji

Associated Types

type Rep Emoji :: Type -> Type

Methods

from :: Emoji -> Rep Emoji x

to :: Rep Emoji x -> Emoji

FromJSON Emoji

Defined in Network.Reddit.Types.Emoji

Methods

parseJSON :: Value -> Parser Emoji

parseJSONList :: Value -> Parser [Emoji]

ToForm Emoji

Defined in Network.Reddit.Types.Emoji

Methods

toForm :: Emoji -> Form

type Rep Emoji

Defined in Network.Reddit.Types.Emoji

type Rep Emoji = D1 ('MetaData "Emoji" "Network.Reddit.Types.Emoji" "heddit-0.0.1-76ROQ5tOAm3CpLSaFw8ccb" 'False) (C1 ('MetaCons "Emoji" 'PrefixI 'True) ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 EmojiName) :*: (S1 ('MetaSel ('Just "modFlairOnly") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "postFlairAllowed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool))) :*: (S1 ('MetaSel ('Just "userFlairAllowed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: (S1 ('MetaSel ('Just "createdBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UserID)) :*: S1 ('MetaSel ('Just "url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UploadURL))))))

mkEmoji :: EmojiName -> Emoji

Create a new Emoji by providing an EmojiName; default values are provided for all other fields

data NewEmoji

Wrapper for creating new Emojis, which includes the name field

Instances

Show NewEmoji

Defined in Network.Reddit.Types.Emoji

Methods

showsPrec :: Int -> NewEmoji -> ShowS

show :: NewEmoji -> String

showList :: [NewEmoji] -> ShowS

Generic NewEmoji

Defined in Network.Reddit.Types.Emoji

Associated Types

type Rep NewEmoji :: Type -> Type

Methods

from :: NewEmoji -> Rep NewEmoji x

to :: Rep NewEmoji x -> NewEmoji

ToForm NewEmoji

Defined in Network.Reddit.Types.Emoji

Methods

toForm :: NewEmoji -> Form

type Rep NewEmoji

Defined in Network.Reddit.Types.Emoji

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

data EmojiName

The name of an individual Emoji

Instances

Eq EmojiName

Defined in Network.Reddit.Types.Emoji

Methods

(==) :: EmojiName -> EmojiName -> Bool

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

Show EmojiName

Defined in Network.Reddit.Types.Emoji

Methods

showsPrec :: Int -> EmojiName -> ShowS

show :: EmojiName -> String

showList :: [EmojiName] -> ShowS

Generic EmojiName

Defined in Network.Reddit.Types.Emoji

Associated Types

type Rep EmojiName :: Type -> Type

Methods

from :: EmojiName -> Rep EmojiName x

to :: Rep EmojiName x -> EmojiName

Semigroup EmojiName

Defined in Network.Reddit.Types.Emoji

Methods

(<>) :: EmojiName -> EmojiName -> EmojiName

sconcat :: NonEmpty EmojiName -> EmojiName

stimes :: Integral b => b -> EmojiName -> EmojiName

Monoid EmojiName

Defined in Network.Reddit.Types.Emoji

Methods

mempty :: EmojiName

mappend :: EmojiName -> EmojiName -> EmojiName

mconcat :: [EmojiName] -> EmojiName

FromJSON EmojiName

Defined in Network.Reddit.Types.Emoji

Methods

parseJSON :: Value -> Parser EmojiName

parseJSONList :: Value -> Parser [EmojiName]

ToHttpApiData EmojiName

Defined in Network.Reddit.Types.Emoji

Methods

toUrlPiece :: EmojiName -> Text

toEncodedUrlPiece :: EmojiName -> Builder

toHeader :: EmojiName -> ByteString

toQueryParam :: EmojiName -> Text

type Rep EmojiName

Defined in Network.Reddit.Types.Emoji

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

mkEmojiName :: MonadThrow m => Text -> m EmojiName

Smart constructor for EmojiNames, which may only contain alphanumeric characters, '_', '-', and '&', and may not exceed 24 characters in length

data EmojiList

Wrapper for parsing response JSON. Subreddit emojis must be extracted from a larger structure

Instances

Show EmojiList

Defined in Network.Reddit.Types.Emoji

Methods

showsPrec :: Int -> EmojiList -> ShowS

show :: EmojiList -> String

showList :: [EmojiList] -> ShowS

Generic EmojiList

Defined in Network.Reddit.Types.Emoji

Associated Types

type Rep EmojiList :: Type -> Type

Methods

from :: EmojiList -> Rep EmojiList x

to :: Rep EmojiList x -> EmojiList

FromJSON EmojiList

Defined in Network.Reddit.Types.Emoji

Methods

parseJSON :: Value -> Parser EmojiList

parseJSONList :: Value -> Parser [EmojiList]

type Rep EmojiList

Defined in Network.Reddit.Types.Emoji

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