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.Types.Emoji

Description

Synopsis

data Emoji = Emoji {
- name :: EmojiName
- modFlairOnly :: Bool
- postFlairAllowed :: Bool
- userFlairAllowed :: Bool
- createdBy :: Maybe UserID
- url :: Maybe UploadURL
}
mkEmoji :: EmojiName -> Emoji
data NewEmoji
data EmojiName
mkEmojiName :: MonadThrow m => Text -> m EmojiName
data EmojiList

Documentation

data Emoji Source #

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

Instances details

Eq Emoji Source #
Instance details Defined in Network.Reddit.Types.Emoji Methods (==) :: Emoji -> Emoji -> Bool # (/=) :: Emoji -> Emoji -> Bool #
Show Emoji Source #
Instance details Defined in Network.Reddit.Types.Emoji Methods showsPrec :: Int -> Emoji -> ShowS # show :: Emoji -> String # showList :: [Emoji] -> ShowS #
Generic Emoji Source #
Instance details 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 Source #
Instance details Defined in Network.Reddit.Types.Emoji Methods parseJSON :: Value -> Parser Emoji # parseJSONList :: Value -> Parser [Emoji] #
ToForm Emoji Source #
Instance details Defined in Network.Reddit.Types.Emoji Methods toForm :: Emoji -> Form #
type Rep Emoji Source #
Instance details Defined in Network.Reddit.Types.Emoji type Rep Emoji = D1 ('MetaData "Emoji" "Network.Reddit.Types.Emoji" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" '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 Source #

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

data NewEmoji Source #

Wrapper for creating new Emojis, which includes the name field

Instances

Instances details

Show NewEmoji Source #
Instance details Defined in Network.Reddit.Types.Emoji Methods showsPrec :: Int -> NewEmoji -> ShowS # show :: NewEmoji -> String # showList :: [NewEmoji] -> ShowS #
Generic NewEmoji Source #
Instance details 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 Source #
Instance details Defined in Network.Reddit.Types.Emoji Methods toForm :: NewEmoji -> Form #
type Rep NewEmoji Source #
Instance details Defined in Network.Reddit.Types.Emoji type Rep NewEmoji = D1 ('MetaData "NewEmoji" "Network.Reddit.Types.Emoji" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'True) (C1 ('MetaCons "NewEmoji" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Emoji)))

data EmojiName Source #

The name of an individual Emoji

Instances

Instances details

Eq EmojiName Source #
Instance details Defined in Network.Reddit.Types.Emoji Methods (==) :: EmojiName -> EmojiName -> Bool # (/=) :: EmojiName -> EmojiName -> Bool #
Show EmojiName Source #
Instance details Defined in Network.Reddit.Types.Emoji Methods showsPrec :: Int -> EmojiName -> ShowS # show :: EmojiName -> String # showList :: [EmojiName] -> ShowS #
Generic EmojiName Source #
Instance details 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 Source #
Instance details Defined in Network.Reddit.Types.Emoji Methods (<>) :: EmojiName -> EmojiName -> EmojiName # sconcat :: NonEmpty EmojiName -> EmojiName # stimes :: Integral b => b -> EmojiName -> EmojiName #
Monoid EmojiName Source #
Instance details Defined in Network.Reddit.Types.Emoji Methods mempty :: EmojiName # mappend :: EmojiName -> EmojiName -> EmojiName # mconcat :: [EmojiName] -> EmojiName #
FromJSON EmojiName Source #
Instance details Defined in Network.Reddit.Types.Emoji Methods parseJSON :: Value -> Parser EmojiName # parseJSONList :: Value -> Parser [EmojiName] #
ToHttpApiData EmojiName Source #
Instance details Defined in Network.Reddit.Types.Emoji Methods toUrlPiece :: EmojiName -> Text # toEncodedUrlPiece :: EmojiName -> Builder # toHeader :: EmojiName -> ByteString # toQueryParam :: EmojiName -> Text #
type Rep EmojiName Source #
Instance details Defined in Network.Reddit.Types.Emoji type Rep EmojiName = D1 ('MetaData "EmojiName" "Network.Reddit.Types.Emoji" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'True) (C1 ('MetaCons "EmojiName" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

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

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

data EmojiList Source #

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

Instances

Instances details

Show EmojiList Source #
Instance details Defined in Network.Reddit.Types.Emoji Methods showsPrec :: Int -> EmojiList -> ShowS # show :: EmojiList -> String # showList :: [EmojiList] -> ShowS #
Generic EmojiList Source #
Instance details 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 Source #
Instance details Defined in Network.Reddit.Types.Emoji Methods parseJSON :: Value -> Parser EmojiList # parseJSONList :: Value -> Parser [EmojiList] #
type Rep EmojiList Source #
Instance details Defined in Network.Reddit.Types.Emoji type Rep EmojiList = D1 ('MetaData "EmojiList" "Network.Reddit.Types.Emoji" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'True) (C1 ('MetaCons "EmojiList" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Seq Emoji))))