IDCard

class asyncpraw.models.IDCard(reddit: asyncpraw.Reddit, _data: Dict[str, Any])

Class to represent an ID card widget.

subreddit = await reddit.subreddit("test")
widgets = subreddit.widgets
id_card = await widgets.id_card()
print(id_card.subscribersText)

Update one:

id_card = await widgets.id_card()
await id_card.mod.update(currentlyViewingText="Bots")

Typical Attributes

Note

This table describes attributes that typically belong to objects of this class. Async PRAW dynamically provides the attributes that Reddit returns via the API. Since those attributes are subject to change on Reddit’s end, Async PRAW makes no effort to document any new/removed/changed attributes, other than to instruct you on how to discover what is available. As a result, this table of attributes may not be complete. See Determine Available Attributes of an Object for detailed information.

If you would like to add an attribute to this table, feel free to open a pull request.

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: asyncpraw.Reddit, _data: Dict[str, Any])

Initialize a Widget instance.

mod() asyncpraw.models.WidgetModeration

Get an instance of WidgetModeration for this widget.

Note

Using any of the methods of WidgetModeration will likely make outdated the data in the SubredditWidgets that this widget belongs to. To remedy this, call refresh().

classmethod parse(data: Dict[str, Any], reddit: asyncpraw.Reddit) Any

Return an instance of cls from data.

Parameters:
  • data – The structured data.

  • reddit – An instance of Reddit.