SubredditCollections

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

Class to represent a Subreddit’s Collections.

Obtain an instance via:

subreddit = await reddit.subreddit("test")
subreddit.collections
Parameters:
await __call__(collection_id=None, permalink=None, *, fetch=True)

Return the Collection with the specified ID.

Parameters:

  • collection_id (str | None) – The ID of a Collection (default: None).

  • permalink (str | None) – The permalink of a collection (default: None).

  • fetch (bool) – Determines if Async PRAW will fetch the object (default: True).

Return type:

Collection

Returns:

The specified Collection.

Exactly one of collection_id or permalink is required.

Example usage:

subreddit = await reddit.subreddit("test")

uuid = "847e4548-a3b5-4ad7-afb4-edbfc2ed0a6b"
collection = await subreddit.collections(uuid)
print(collection.title)
print(collection.description)

permalink = "https://www.reddit.com/r/test/collection/" + uuid
collection = await subreddit.collections(permalink=permalink)
print(collection.title)
print(collection.description)

If you don’t need the object fetched right away (e.g., to utilize a class method) you can do:

subreddit = await reddit.subreddit("test", fetch=True)
collection = await subreddit.collections(uuid, fetch=False)
await collection.mod.add("submission_id")
__init__(reddit, subreddit, _data=None)

Initialize a SubredditCollections instance.

Parameters:
Return type:

None

mod()

Get an instance of SubredditCollectionsModeration.

Provides create():

my_sub = await reddit.subreddit("test", fetch=True)
new_collection = await my_sub.collections.mod.create(title="Title", description="desc")
Return type:

SubredditCollectionsModeration

classmethod parse(data, reddit)

Return an instance of cls from data.

Parameters:
Return type:

AsyncPRAWBase