SubredditCollectionsModeration

class asyncpraw.models.reddit.collections.SubredditCollectionsModeration(reddit, subreddit, _data=None)

Class to represent moderator actions on a Subreddit’s Collections.

Obtain an instance via:

subreddit = await reddit.subreddit("test")
subreddit.collections.mod
Parameters:
__init__(reddit, subreddit, _data=None)

Initialize a SubredditCollectionsModeration instance.

Parameters:
Return type:

None

await create(*, description, display_layout=None, title)

Create a new Collection.

The authenticated account must have appropriate moderator permissions in the subreddit this collection belongs to.

Parameters:

  • description (str) – The description, up to 500 characters.

  • display_layout (str | None) – Either "TIMELINE" for events or discussions or "GALLERY" for images or memes. Passing "" or None will make the collection appear on Reddit as if this is set to "TIMELINE" (default: None).

  • title (str) – The title of the collection, up to 300 characters.

Return type:

Collection

Returns:

The newly created Collection.

Example usage:

sub = await reddit.subreddit("test")
new_collection = await sub.collections.mod.create(title="Title", description="desc")
await new_collection.mod.add_post("bgibu9")

To specify the display layout as "GALLERY" when creating the collection:

my_sub = await reddit.subreddit("test")
new_collection = await my_sub.collections.mod.create(
    title="Title", description="desc", display_layout="GALLERY"
)
await new_collection.mod.add_post("bgibu9")

See also

delete()

classmethod parse(data, reddit)

Return an instance of cls from data.

Parameters:
Return type:

AsyncPRAWBase