PostFlairWidget¶
-
class
praw.models.
PostFlairWidget
(reddit, _data)¶ Class to represent a post flair widget.
Find an existing one:
post_flair_widget = None widgets = reddit.subreddit("redditdev").widgets for widget in widgets.sidebar: if isinstance(widget, praw.models.PostFlairWidget): post_flair_widget = widget break for flair in post_flair_widget: print(flair) print(post_flair_widget.templates[flair])
Create one (requires proper moderator permissions):
subreddit = reddit.subreddit("redditdev") widgets = subreddit.widgets flairs = [f["id"] for f in subreddit.flair.link_templates] styles = {"backgroundColor": "#FFFF66", "headerColor": "#3333EE"} post_flair = widgets.mod.add_post_flair_widget("Some flairs", "list", flairs, styles)
For more information on creation, see
add_post_flair_widget()
.Update one (requires proper moderator permissions):
new_styles = {"backgroundColor": "#FFFFFF", "headerColor": "#FF9900"} post_flair = post_flair.mod.update(shortName="My fav flairs", styles=new_styles)
Delete one (requires proper moderator permissions):
post_flair.mod.delete()
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 complete.
Attribute
Description
display
The display style of the widget, either
"cloud"
or"list"
.id
The widget ID.
kind
The widget kind (always
"post-flair"
).order
A list of the flair IDs in this widget. Can be iterated over by iterating over the
PostFlairWidget
(e.g.for flair_id in post_flair
).shortName
The short name of the widget.
styles
A
dict
with the keys"backgroundColor"
and"headerColor"
.subreddit
The
Subreddit
the button widget belongs to.templates
A
dict
that maps flair IDs todict
s that describe flairs.-
__init__
(reddit, _data)¶ Initialize an instance of the class.
-
__iter__
() → Iterator[Any]¶ Return an iterator to the list.
-
mod
()¶ Get an instance of
WidgetModeration
for this widget.Note
Using any of the methods of
WidgetModeration
will likely make the data in theSubredditWidgets
that this widget belongs to outdated. To remedy this, callrefresh()
.
-
classmethod
parse
(data: Dict[str, Any], reddit: praw.Reddit) → Any¶ Return an instance of
cls
fromdata
.- Parameters
data – The structured data.
reddit – An instance of
Reddit
.
-