IDCard¶
-
class
asyncpraw.models.
IDCard
(reddit, _data)¶ Class to represent an ID card widget.
subreddit = await reddit.subreddit("redditdev") widgets = subreddit.widgets id_card = await widgets.id_card() print(id_card.subscribersText)
Update one (requires proper moderator permissions):
id_card = await widgets.id_card() await id_card.mod.update(currentlyViewingText="Bots")
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
currentlyViewingCount
The number of Redditors viewing the subreddit.
currentlyViewingText
The text displayed next to the view count. For example, “users online”.
description
The subreddit description.
id
The widget ID.
kind
The widget kind (always
"id-card"
).shortName
The short name of the widget.
styles
A
dict
with the keys"backgroundColor"
and"headerColor"
.subreddit
The
Subreddit
the button widget belongs to.subscribersCount
The number of subscribers to the subreddit.
subscribersText
The text displayed next to the subscriber count. For example, “users subscribed”.
-
__init__
(reddit, _data)¶ Initialize an instance of the class.
-
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()
.
-
classmethod
parse
(data: Dict[str, Any], reddit: asyncpraw.Reddit) → Any¶ Return an instance of
cls
fromdata
.- Parameters
data – The structured data.
reddit – An instance of
Reddit
.
-
Note
This list of attributes is not complete. Async PRAW dynamically provides the attributes that Reddit returns via the API. Because those attributes are subject to change on Reddit’s end, Async 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.