ThingModerationMixin¶
- class asyncpraw.models.reddit.mixins.ThingModerationMixin¶
Provides moderation methods for Comments and Submissions.
- __init__()¶
- await approve()¶
Approve a
Comment
orSubmission
.Approving a comment or submission reverts a removal, resets the report counter, adds a green check mark indicator (only visible to other moderators) on the website view, and sets the
approved_by
attribute to the authenticated user.Example usage:
# approve a comment: comment = await reddit.comment("dkk4qjd", lazy=True) await comment.mod.approve() # approve a submission: submission = await reddit.submission(id="5or86n", lazy=True) await submission.mod.approve()
- await distinguish(how='yes', sticky=False)¶
Distinguish a
Comment
orSubmission
.- Parameters
how – One of “yes”, “no”, “admin”, “special”. “yes” adds a moderator level distinguish. “no” removes any distinction. “admin” and “special” require special user privileges to use.
sticky – Comment is stickied if
True
, placing it at the top of the comment page regardless of score. If thing is not a top-level comment, this parameter is silently ignored.
Example usage:
# distinguish and sticky a comment: comment = await reddit.comment("dkk4qjd", lazy=True) await comment.mod.distinguish(how="yes", sticky=True) # undistinguish a submission: submission = await reddit.submission(id="5or86n", lazy=True) await submission.mod.distinguish(how="no")
See also
- await ignore_reports()¶
Ignore future reports on a
Comment
orSubmission
.Calling this method will prevent future reports on this Comment or Submission from both triggering notifications and appearing in the various moderation listings. The report count will still increment on the Comment or Submission.
Example usage:
# ignore future reports on a comment: comment = await reddit.comment("dkk4qjd", lazy=True) await comment.mod.ignore_reports() # ignore future reports on a submission: submission = await reddit.submission(id="5or86n", lazy=True) await submission.mod.ignore_reports()
See also
- await lock()¶
Lock a
Comment
orSubmission
.Example usage:
# lock a comment: comment = await reddit.comment("dkk4qjd", lazy=True) await comment.mod.lock() # lock a submission: submission = await reddit.submission(id="5or86n", lazy=True) await submission.mod.lock()
See also
- await remove(spam=False, mod_note='', reason_id=None)¶
Remove a
Comment
orSubmission
.- Parameters
mod_note – A message for the other moderators.
spam – When True, use the removal to help train the Subreddit’s spam filter (default: False).
reason_id – The removal reason ID.
If either
reason_id
ormod_note
are provided, a second API call is made to add the removal reason.Example usage:
# remove a comment and mark as spam: comment = await reddit.comment("dkk4qjd", lazy=True) await comment.mod.remove(spam=True) # remove a submission submission = await reddit.submission(id="5or86n", lazy=True) await submission.mod.remove() # remove a submission with a removal reason sub = await reddit.subreddit("subreddit") reason = await sub.mod.removal_reasons.get_reason("110ni21zo23ql") submission = await reddit.submission(id="5or86n", lazy=True) await submission.mod.remove(reason_id=reason.id)
- await send_removal_message(message, title='ignored', type='public')¶
Send a removal message for a
Comment
orSubmission
.Warning
The object has to be removed before giving it a removal reason. Remove the object with
remove()
. Trying to add a removal reason without removing the object will result inRedditAPIException
being thrown with anINVALID_ID
error_type.Reddit adds human-readable information about the object to the message.
- Parameters
type – One of “public”, “private”, “private_exposed”. “public” leaves a stickied comment on the post. “private” sends a Modmail message with hidden username. “private_exposed” sends a Modmail message without hidden username.
title – The short reason given in the message. (Ignored if type is “public”.)
message – The body of the message.
If
type
is “public”, the newComment
is returned.
- await undistinguish()¶
Remove mod, admin, or special distinguishing from an object.
Also unstickies the object if applicable.
Example usage:
# undistinguish a comment: comment = await reddit.comment("dkk4qjd", lazy=True) await comment.mod.undistinguish() # undistinguish a submission: submission = await reddit.submission(id="5or86n", lazy=True) await submission.mod.undistinguish()
See also
- await unignore_reports()¶
Resume receiving future reports on a Comment or Submission.
Future reports on this
Comment
orSubmission
will cause notifications, and appear in the various moderation listings.Example usage:
# accept future reports on a comment: comment = await reddit.comment("dkk4qjd", lazy=True) await comment.mod.unignore_reports() # accept future reports on a submission: submission = await reddit.submission(id="5or86n", lazy=True) await submission.mod.unignore_reports()
See also
- await unlock()¶
Unlock a
Comment
orSubmission
.Example usage:
# unlock a comment: comment = await reddit.comment("dkk4qjd", lazy=True) await comment.mod.unlock() # unlock a submission: submission = await reddit.submission(id="5or86n", lazy=True) await submission.mod.unlock()
See also