reddit.multireddit¶
-
class
praw.models.
MultiredditHelper
(reddit: praw.Reddit, _data: Optional[Dict[str, Any]])¶ Provide a set of functions to interact with Multireddits.
-
__call__
(redditor: Union[str, praw.models.Redditor], name: str) → praw.models.Multireddit¶ Return a lazy instance of
Multireddit
.- Parameters
redditor – A redditor name (e.g.,
"spez"
) orRedditor
instance who owns the multireddit.name – The name of the multireddit.
-
__init__
(reddit: praw.Reddit, _data: Optional[Dict[str, Any]])¶ Initialize a PRAWModel instance.
- Parameters
reddit – An instance of
Reddit
.
-
create
(display_name: str, subreddits: Union[str, praw.models.Subreddit], description_md: Optional[str] = None, icon_name: Optional[str] = None, key_color: Optional[str] = None, visibility: str = 'private', weighting_scheme: str = 'classic') → praw.models.Multireddit¶ Create a new multireddit.
- Parameters
display_name – The display name for the new multireddit.
subreddits – Subreddits to add to the new multireddit.
description_md – (Optional) Description for the new multireddit, formatted in markdown.
icon_name – (Optional) Can be one of:
art and design
,ask
,books
,business
,cars
,comics
,cute animals
,diy
,entertainment
,food and drink
,funny
,games
,grooming
,health
,life advice
,military
,models pinup
,music
,news
,philosophy
,pictures and gifs
,science
,shopping
,sports
,style
,tech
,travel
,unusual stories
,video
, orNone
.key_color – (Optional) RGB hex color code of the form
"#FFFFFF"
.visibility – (Optional) Can be one of:
hidden
,private
,public
(default: private).weighting_scheme – (Optional) Can be one of:
classic
,fresh
(default: classic).
- Returns
The new Multireddit object.
-
classmethod
parse
(data: Dict[str, Any], reddit: praw.Reddit) → Any¶ Return an instance of
cls
fromdata
.- Parameters
data – The structured data.
reddit – An instance of
Reddit
.
-