reddit.announcements¶

class asyncpraw.models.AnnouncementHelper(reddit, _data)¶

Provide a set of functions to interact with Announcement instances.

Note

The methods provided by this class will only work on the currently authenticated user’s Announcements.

Parameters:

__call__(**generator_kwargs)¶

Return a ListingGenerator for the authenticated user’s announcements.

Additional keyword arguments are passed in the initialization of ListingGenerator.

Example usage:

async for announcement in reddit.announcements():
    print(announcement.subject)

__init__(reddit, _data)¶

Initialize a AsyncPRAWBase instance.

Parameters:

Return type:

None

await hide(announcements)¶

Hide Announcements.

Parameters:: announcements (list[Announcement]) – A list of Announcement instances to hide.
Return type:: None

Requests are batched at 100 items (Reddit limit).

For example, to hide every announcement:

await reddit.announcements.hide([a async for a in reddit.announcements()])

See also

Announcement.hide() to hide a single announcement.

await mark_all_read()¶

Mark all announcements as read with just one API call.

Example usage:

await reddit.announcements.mark_all_read()

await mark_read(announcements)¶

Mark Announcements as read.

Parameters:: announcements (list[Announcement]) – A list of Announcement instances to mark as read.
Return type:: None

Requests are batched at 100 items (Reddit limit).

For example, to mark every unread announcement as read:

unread = [a async for a in reddit.announcements() if a.read_at is None]
await reddit.announcements.mark_read(unread)