ModeratorsWidget¶
-
class
praw.models.
ModeratorsWidget
(reddit, _data)¶ Class to represent a moderators widget.
widgets = reddit.subreddit('redditdev').widgets print(widgets.moderators_widget)
Update one (requires proper moderator permissions):
new_styles = {'backgroundColor': '#FFFFFF', 'headerColor': '#FF9900'} widgets.moderators_widget.mod.update(styles=new_styles)
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 comprehensive in any way.
Attribute Description id
The widget ID. kind
The widget kind (always 'moderators'
).mods
A list of the Redditor
s that moderate the subreddit. Can be iterated over by iterating over theModeratorsWidget
(e.g.for mod in widgets.moderators_widget
).styles
A dict
with the keys'backgroundColor'
and'headerColor'
.subreddit
The Subreddit
the button widget belongs to.totalMods
The total number of moderators in the subreddit. -
__contains__
(item: Any) → bool¶ Test if item exists in the list.
-
__getitem__
(index: int) → Any¶ Return the item at position index in the list.
-
__init__
(reddit, _data)¶ Initialize the moderators widget.
-
__iter__
() → Iterator[Any]¶ Return an iterator to the list.
-
__len__
() → int¶ Return the number of items in the list.
-
mod
¶ Get an instance of
WidgetModeration
for this widget.Note
Using any of the methods of
WidgetModeration
will likely make outdated the data in theSubredditWidgets
that this widget belongs to. To remedy this, callrefresh()
.
-
Note
This list of attributes is not complete. PRAW dynamically provides the attributes that Reddit returns via the API. Because those attributes are subject to change on Reddit’s end, PRAW makes no effort to document them, other than to instruct you on how to discover what is available. See Determine Available Attributes of an Object for detailed information.