SubredditCollections¶
-
class
asyncpraw.models.reddit.collections.
SubredditCollections
(reddit: asyncpraw.Reddit, subreddit: asyncpraw.models.Subreddit, _data: Optional[Dict[str, Any]] = None)¶ Class to represent a Subreddit’s
Collection
s.Obtain an instance via:
subreddit = await reddit.subreddit("SUBREDDIT") subreddit.collections
-
await
__call__
(collection_id: Optional[str] = None, permalink: Optional[str] = None, lazy: bool = False)¶ Return the
Collection
with the specified ID.- Parameters
collection_id – The ID of a Collection (default: None).
permalink – The permalink of a Collection (default: None).
lazy – If True, object is loaded lazily (default: False)
- Returns
The specified Collection.
Exactly one of
collection_id
andpermalink
is required.Example usage:
subreddit = await reddit.subreddit("SUBREDDIT") uuid = "847e4548-a3b5-4ad7-afb4-edbfc2ed0a6b" collection = await subreddit.collections(uuid) print(collection.title) print(collection.description) permalink = "https://www.reddit.com/r/SUBREDDIT/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("SUBREDDIT", fetch=True) collection = await subreddit.collections(uuid, lazy=True) await collection.mod.add("submission_id")
-
__init__
(reddit: asyncpraw.Reddit, subreddit: asyncpraw.models.Subreddit, _data: Optional[Dict[str, Any]] = None)¶ Initialize an instance of SubredditCollections.
-
mod
() → asyncpraw.models.reddit.collections.SubredditCollectionsModeration¶ Get an instance of
SubredditCollectionsModeration
.Provides
create()
:my_sub = await reddit.subreddit("SUBREDDIT", fetch=True) new_collection = await my_sub.collections.mod.create("Title", "desc")
-
classmethod
parse
(data: Dict[str, Any], reddit: asyncpraw.Reddit) → Any¶ Return an instance of
cls
fromdata
.- Parameters
data – The structured data.
reddit – An instance of
Reddit
.
-
await