Submission Moderation¶

class apraw.models.SubmissionModeration(reddit: Reddit, submission: apraw.models.submission.Submission)¶

A helper class to moderate submissions.

reddit: Reddit: The Reddit instance with which requests are made.
fullname: str: The ID prepended with the kind of the item this helper belongs to.

approve()¶

Approve the Reddit item.

Returns:	resp – The API response JSON.
Return type:	Dict

distinguish(how: NewType.<locals>.new_type = 'yes', sticky: bool = False)¶

Distinguish the Reddit item.

Parameters:	how ("yes" or "no" or "admin" or "special") – The type of distinguishment to be added to the item. sticky (bool, optional) – Whether the item should be stickied.
Returns:	resp – The API response JSON.
Return type:	Dict

ignore_reports()¶

Ignore reports on the Reddit item.

Returns:	resp – The API response JSON.
Return type:	Dict

lock()¶

Lock the item from further replies.

Returns:	resp – The API response JSON.
Return type:	Dict

mark_nsfw()¶

Mark the item as NSFW.

Returns:	resp – The API response JSON.
Return type:	Dict

remove()¶

Remove the Reddit item.

Returns:	resp – The API response JSON.
Return type:	Dict

spoiler()¶

Mark the item as a spoiler.

Returns:	resp – The API response JSON.
Return type:	Dict

sticky(position: int = 1, to_profile: bool = False)¶

Sticky a submission in its subreddit.

Parameters:	position (int) – The “slot” the submission will be stickied to. to_profile (bool) – Whether the submission will be stickied to the user profile.
Returns:	resp – The API response JSON.
Return type:	Dict

undistinguish()¶

Undistinguish the Reddit item.

Returns:	resp – The API response JSON.
Return type:	Dict

unignore_reports()¶

Unignore previously ignored reports on the Reddit item.

Returns:	resp – The API response JSON.
Return type:	Dict

unlock()¶

Unlock the item from further replies.

Returns:	resp – The API response JSON.
Return type:	Dict

unmark_nsfw()¶

Unmark the item as NSFW.

Returns:	resp – The API response JSON.
Return type:	Dict

unspoiler()¶

Unmark the item as a spoiler.

Returns:	resp – The API response JSON.
Return type:	Dict

unsticky(to_profile: bool = False)¶

Unsticky a submission from its subreddit.

Parameters:	to_profile (bool) – Whether the submission will be unstickied from the user profile.
Returns:	resp – The API response JSON.
Return type:	Dict