Emoji

class praw.models.reddit.emoji.Emoji(reddit: Reddit, subreddit: Subreddit, name: str, _data: Optional[Dict[str, Any]] = None)

An individual Emoji object.

Typical Attributes

This table describes attributes that typically belong to objects of this class. Since attributes are dynamically provided (see Determine Available Attributes of an Object), there is not a guarantee that these attributes will always be present, nor is this list necessarily comprehensive.

Attribute Description
mod_flair_only Whether the emoji is restricted for mod use only.
name The name of the emoji.
post_flair_allowed Whether the emoji may appear in post flair.
url The URL of the emoji image.
user_flair_allowed Whether the emoji may appear in user flair.
__init__(reddit: Reddit, subreddit: Subreddit, name: str, _data: Optional[Dict[str, Any]] = None)

Construct an instance of the Emoji object.

delete()

Delete an emoji from this subreddit by Emoji.

To delete "test" as an emoji on the subreddit "praw_test" try:

reddit.subreddit("praw_test").emoji["test"].delete()
classmethod parse(data: Dict[str, Any], reddit: Reddit) → Any

Return an instance of cls from data.

Parameters:
  • data – The structured data.
  • reddit – An instance of Reddit.
update(mod_flair_only: Optional[bool] = None, post_flair_allowed: Optional[bool] = None, user_flair_allowed: Optional[bool] = None)

Update the permissions of an emoji in this subreddit.

Parameters:
  • mod_flair_only – (boolean) Indicate whether the emoji is restricted to mod use only. Respects pre-existing settings if not provided.
  • post_flair_allowed – (boolean) Indicate whether the emoji may appear in post flair. Respects pre-existing settings if not provided.
  • user_flair_allowed – (boolean) Indicate whether the emoji may appear in user flair. Respects pre-existing settings if not provided.

Note

In order to retain pre-existing values for those that are not explicitly passed, a network request is issued. To avoid that network request, explicitly provide all values.

To restrict the emoji test in subreddit wowemoji to mod use only, try:

reddit.subreddit("wowemoji").emoji["test"].update(mod_flair_only=True)