RemovalReason

class asyncpraw.models.reddit.removal_reasons.RemovalReason(reddit: asyncpraw.Reddit, subreddit: asyncpraw.models.Subreddit, id: Optional[str] = None, reason_id: Optional[str] = None, _data: Optional[Dict[str, Any]] = None)

An individual Removal Reason object.

Typical Attributes

Note

This table describes attributes that typically belong to objects of this class. Async PRAW dynamically provides the attributes that Reddit returns via the API. Since those attributes are subject to change on Reddit’s end, Async PRAW makes no effort to document any new/removed/changed attributes, other than to instruct you on how to discover what is available. As a result, this table of attributes may not be complete. See Determine Available Attributes of an Object for detailed information.

If you would like to add an attribute to this table, feel free to open a pull request.

Attribute

Description

id

The ID of the removal reason.

message

The message of the removal reason.

title

The title of the removal reason.

__init__(reddit: asyncpraw.Reddit, subreddit: asyncpraw.models.Subreddit, id: Optional[str] = None, reason_id: Optional[str] = None, _data: Optional[Dict[str, Any]] = None)

Initialize a RemovalReason instance.

Parameters
  • reddit – An instance of Reddit.

  • subreddit – An instance of Subreddit.

  • id – The ID of the removal reason.

  • reason_id – The original name of the id parameter. Used for backwards compatibility. This parameter should not be used.

await delete()

Delete a removal reason from this subreddit.

To delete "141vv5c16py7d" from r/test try:

subreddit = await reddit.subreddit("test")
reason = await subreddit.mod.removal_reasons.get_reason("141vv5c16py7d")
await reason.delete()
await load()

Re-fetches the object.

This is used to explicitly fetch or re-fetch the object from reddit. This method can be used on any RedditBase object.

await reddit_base_object.load()
classmethod parse(data: Dict[str, Any], reddit: asyncpraw.Reddit) Any

Return an instance of cls from data.

Parameters
  • data – The structured data.

  • reddit – An instance of Reddit.

await update(message: Optional[str] = None, title: Optional[str] = None)

Update the removal reason from this subreddit.

Note

Existing values will be used for any unspecified arguments.

Parameters
  • message – The removal reason’s new message.

  • title – The removal reason’s new title.

To update "141vv5c16py7d" from r/test try:

subreddit = await reddit.subreddit("test")
reason = await subreddit.mod.removal_reasons.get_reason("141vv5c16py7d")
await reason.update(message="New message", title="New title")