reddit.announcements

class praw.models.AnnouncementHelper(reddit, _data)

Provide a set of functions to interact with Announcements.

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:

for announcement in reddit.announcements():
    print(announcement.subject)
Return type:

Iterator[Announcement]

Parameters:

generator_kwargs (Any)

__init__(reddit, _data)

Initialize a PRAWBase instance.

Parameters:
Return type:

None

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:

reddit.announcements.hide(list(reddit.announcements()))

See also

Announcement.hide() to hide a single announcement.

mark_all_read()

Mark all announcements as read with just one API call.

Example usage:

reddit.announcements.mark_all_read()
Return type:

None

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 for a in reddit.announcements() if a.read_at is None]
reddit.announcements.mark_read(unread)

See also

classmethod parse(data, reddit)

Return an instance of cls from data.

Parameters:
Return type:

PRAWBase