SubredditModerationStream¶
-
class
praw.models.reddit.subreddit.
SubredditModerationStream
(subreddit: praw.models.Subreddit)¶ Provides moderator streams.
-
__init__
(subreddit: praw.models.Subreddit)¶ Create a SubredditModerationStream instance.
- Parameters
subreddit – The moderated subreddit associated with the streams.
-
edited
(only: Optional[str] = None, **stream_options: Any) → Generator[Union[praw.models.Comment, praw.models.Submission], None, None]¶ Yield edited comments and submissions as they become available.
- Parameters
only – If specified, one of
"comments"
, or"submissions"
to yield only results of that type.
Keyword arguments are passed to
stream_generator()
.For example, to retrieve all new edited submissions/comments made to all moderated subreddits, try:
for item in reddit.subreddit("mod").mod.stream.edited(): print(item)
-
log
(action: Optional[str] = None, mod: Optional[Union[praw.models.Redditor, str]] = None, **stream_options: Any) → Generator[praw.models.ModAction, None, None]¶ Yield moderator log entries as they become available.
- Parameters
action – If given, only return log entries for the specified action.
mod – If given, only return log entries for actions made by the passed in Redditor.
For example, to retrieve all new mod actions made to all moderated subreddits, try:
for log in reddit.subreddit("mod").mod.stream.log(): print(f"Mod: {log.mod}, Subreddit: {log.subreddit}")
-
modmail_conversations
(other_subreddits: Optional[List[praw.models.Subreddit]] = None, sort: Optional[str] = None, state: Optional[str] = None, **stream_options: Any) → Generator[praw.models.reddit.modmail.ModmailConversation, None, None]¶ Yield new-modmail conversations as they become available.
- Parameters
other_subreddits – A list of
Subreddit
instances for which to fetch conversations (default: None).sort – Can be one of: mod, recent, unread, user (default: recent).
state – Can be one of: all, appeals, archived, default, highlighted, inbox, inprogress, mod, new, notifications (default: all). “all” does not include mod or archived conversations. “inbox” does not include appeals conversations.
Keyword arguments are passed to
stream_generator()
.To print new mail in the unread modmail queue try:
subreddit = reddit.subreddit("all") for message in subreddit.mod.stream.modmail_conversations(): print(f"From: {message.owner}, To: {message.participant}")
-
modqueue
(only: Optional[str] = None, **stream_options: Any) → Generator[Union[praw.models.Comment, praw.models.Submission], None, None]¶ Yield comments/submissions in the modqueue as they become available.
- Parameters
only – If specified, one of
"comments"
, or"submissions"
to yield only results of that type.
Keyword arguments are passed to
stream_generator()
.To print all new modqueue items try:
for item in reddit.subreddit("mod").mod.stream.modqueue(): print(item)
-
reports
(only: Optional[str] = None, **stream_options: Any) → Generator[Union[praw.models.Comment, praw.models.Submission], None, None]¶ Yield reported comments and submissions as they become available.
- Parameters
only – If specified, one of
"comments"
, or"submissions"
to yield only results of that type.
Keyword arguments are passed to
stream_generator()
.To print new user and mod report reasons in the report queue try:
for item in reddit.subreddit("mod").mod.stream.reports(): print(item)
-
spam
(only: Optional[str] = None, **stream_options: Any) → Generator[Union[praw.models.Comment, praw.models.Submission], None, None]¶ Yield spam comments and submissions as they become available.
- Parameters
only – If specified, one of
"comments"
, or"submissions"
to yield only results of that type.
Keyword arguments are passed to
stream_generator()
.To print new items in the spam queue try:
for item in reddit.subreddit("mod").mod.stream.spam(): print(item)
-
unmoderated
(**stream_options: Any) → Generator[praw.models.Submission, None, None]¶ Yield unmoderated submissions as they become available.
Keyword arguments are passed to
stream_generator()
.To print new items in the unmoderated queue try:
for item in reddit.subreddit("mod").mod.stream.unmoderated(): print(item)
-
unread
(**stream_options: Any) → Generator[praw.models.SubredditMessage, None, None]¶ Yield unread old modmail messages as they become available.
Keyword arguments are passed to
stream_generator()
.See also
inbox()
for all messages.To print new mail in the unread modmail queue try:
for message in reddit.subreddit("mod").mod.stream.unread(): print(f"From: {message.author}, To: {message.dest}")
-