reddit.live
- class praw.models.DraftHelper(reddit: praw.Reddit, _data: Dict[str, Any] | None)
Provide a set of functions to interact with
Draft
instances.Note
The methods provided by this class will only work on the currently authenticated user’s
Draft
s.- __call__(draft_id: str | None = None) List[praw.models.Draft] | praw.models.Draft
Return a list of
Draft
instances.- Parameters:
draft_id – When provided, return
Draft
instance (default:None
).- Returns:
A
Draft
instance ifdraft_id
is provided. Otherwise, a list ofDraft
objects.
Note
Drafts fetched using a specific draft ID are lazily loaded, so you might have to access an attribute to get all the expected attributes.
This method can be used to fetch a specific draft by ID, like so:
draft_id = "124862bc-e1e9-11eb-aa4f-e68667a77cbb" draft = reddit.drafts(draft_id) print(draft)
- __init__(reddit: praw.Reddit, _data: Dict[str, Any] | None)
Initialize a
PRAWBase
instance.- Parameters:
reddit – An instance of
Reddit
.
- create(*, flair_id: str | None = None, flair_text: str | None = None, is_public_link: bool = False, nsfw: bool = False, original_content: bool = False, selftext: str | None = None, send_replies: bool = True, spoiler: bool = False, subreddit: str | praw.models.Subreddit | praw.models.UserSubreddit | None = None, title: str | None = None, url: str | None = None, **draft_kwargs) praw.models.Draft
Create a new
Draft
.- Parameters:
flair_id – The flair template to select (default:
None
).flair_text – If the template’s
flair_text_editable
value isTrue
, this value will set a custom text (default:None
).flair_id
is required whenflair_text
is provided.is_public_link – Whether to enable public viewing of the draft before it is submitted (default:
False
).nsfw – Whether the draft should be marked NSFW (default:
False
).original_content – Whether the submission should be marked as original content (default:
False
).selftext – The Markdown formatted content for a text submission draft. Use
None
to make a title-only submission draft (default:None
).selftext
can not be provided ifurl
is provided.send_replies – When
True
, messages will be sent to the submission author when comments are made to the submission (default:True
).spoiler – Whether the submission should be marked as a spoiler (default:
False
).subreddit – The subreddit to create the draft for. This accepts a subreddit display name,
Subreddit
object, orUserSubreddit
object. IfNone
, theUserSubreddit
of currently authenticated user will be used (default:None
).title – The title of the draft (default:
None
).url – The URL for a
link
submission draft (default:None
).url
can not be provided ifselftext
is provided.
Additional keyword arguments can be provided to handle new parameters as Reddit introduces them.
- Returns:
The new
Draft
object.