reddit.live#
- class praw.models.DraftHelper(reddit: praw.Reddit, _data: Optional[Dict[str, Any]])#
Provide a set of functions to interact with
Draftinstances.Note
The methods provided by this class will only work on the currently authenticated user’s
Drafts.- __call__(draft_id: Optional[str] = None) Union[List[praw.models.Draft], praw.models.Draft]#
Return a list of
Draftinstances.- Parameters:
draft_id – When provided, return
Draftinstance (default:None).- Returns:
A
Draftinstance ifdraft_idis provided. Otherwise, a list ofDraftobjects.
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: Optional[Dict[str, Any]])#
Initialize a
PRAWBaseinstance.- Parameters:
reddit – An instance of
Reddit.
- create(*, flair_id: Optional[str] = None, flair_text: Optional[str] = None, is_public_link: bool = False, nsfw: bool = False, original_content: bool = False, selftext: Optional[str] = None, send_replies: bool = True, spoiler: bool = False, subreddit: Optional[Union[str, praw.models.Subreddit, praw.models.UserSubreddit]] = None, title: Optional[str] = None, url: Optional[str] = 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_editablevalue isTrue, this value will set a custom text (default:None).flair_idis required whenflair_textis 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
Noneto make a title-only submission draft (default:None).selftextcan not be provided ifurlis 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,
Subredditobject, orUserSubredditobject. IfNone, theUserSubredditof currently authenticated user will be used (default:None).title – The title of the draft (default:
None).url – The URL for a
linksubmission draft (default:None).urlcan not be provided ifselftextis provided.
Additional keyword arguments can be provided to handle new parameters as Reddit introduces them.
- Returns:
The new
Draftobject.