![]() |
Reddit.NET
1.5
Reddit.NET is a .NET Standard library that provides easy access to the Reddit API with virtually no boilerplate code required.
|
Controller class for subreddits. More...
Public Member Functions | |
Subreddit (Dispatch dispatch, Things.Subreddit subreddit) | |
Create a new subreddit controller instance populated from API return data. More... | |
Subreddit (Dispatch dispatch, Things.SubredditChild subredditChild) | |
Create a new subreddit controller instance populated from API return data. More... | |
Subreddit (Dispatch dispatch, Subreddit subreddit) | |
Copy another subreddit controller instance onto this one. More... | |
Subreddit (Dispatch dispatch, string name, string title="", string description="", string sidebar="", string submissionText=null, string lang="en", string subredditType="public", string submissionType="any", string submitLinkLabel=null, string submitTextLabel=null, bool wikiEnabled=false, bool over18=false, bool allowDiscovery=true, bool allowSpoilers=true, bool showMedia=true, bool showMediaPreview=true, bool allowImages=true, bool allowVideos=true, bool collapseDeletedComments=false, string suggestedCommentSort=null, int commentScoreHideMins=0, byte[] headerImage=null, byte[] iconImage=null, string primaryColor=null, string keyColor=null, string fullname=null) | |
Create a new subreddit controller instance, populated manually. More... | |
Subreddit (Dispatch dispatch) | |
Create an empty subreddit controller instance. More... | |
LinkPost | LinkPost (string title=null, string url=null, string author=null, string thumbnail=null, int? thumbnailHeight=null, int? thumbnailWidth=null, JObject preview=null, string id=null, string fullname=null, string permalink=null, DateTime created=default(DateTime), DateTime edited=default(DateTime), int score=0, int upVotes=0, int downVotes=0, bool removed=false, bool spam=false) |
Create a new LinkPost object attached to this subreddit. More... | |
LinkPost | LinkPost (string fullname) |
Create a new LinkPost object with the specified fullname attached to this subreddit. More... | |
SelfPost | SelfPost (string title=null, string selfText=null, string selfTextHtml=null, string author=null, string id=null, string fullname=null, string permalink=null, DateTime created=default(DateTime), DateTime edited=default(DateTime), int score=0, int upVotes=0, int downVotes=0, bool removed=false, bool spam=false) |
Create a new SelfPost object attached to this subreddit. More... | |
SelfPost | SelfPost (string fullname) |
Create a new SelfPost object with the specified fullname attached to this subreddit. More... | |
Post | Post () |
Create a new generic Post object attached to this subreddit. More... | |
Post | Post (string fullname) |
Create a new generic Post object with the specified fullname attached to this subreddit. More... | |
Subreddit | About () |
Return information about the current subreddit instance. More... | |
void | AcceptModeratorInvite () |
Accept an invite to moderate the specified subreddit. The authenticated user must have been invited to moderate the subreddit by one of its current moderators. More... | |
async Task | AcceptModeratorInviteAsync () |
Asynchronously accept an invite to moderate the specified subreddit. The authenticated user must have been invited to moderate the subreddit by one of its current moderators. More... | |
void | LeaveModerator () |
Abdicate moderator status in a subreddit. More... | |
async Task | LeaveModeratorAsync () |
Abdicate moderator status in a subreddit asynchronously. More... | |
void | LeaveContributor () |
Abdicate approved submitter status in a subreddit. More... | |
async Task | LeaveContributorAsync () |
Abdicate approved submitter status in a subreddit asynchronously. More... | |
List< Moderator > | GetModerators (string after="", string before="", int limit=25, string user="", bool includeCategories=false, int count=0, string show="all", bool srDetail=false) |
Get the moderators of this subreddit. More... | |
List< Moderator > | GetModerators (SubredditsAboutInput subredditsAboutInput) |
Get the moderators of this subreddit. More... | |
List< SubredditUser > | GetContributors (string after="", string before="", int limit=25, string user="", bool includeCategories=false, int count=0, string show="all", bool srDetail=false) |
Get the approved submitters of this subreddit. More... | |
List< SubredditUser > | GetContributors (SubredditsAboutInput subredditsAboutInput) |
Get the approved submitters of this subreddit. More... | |
List< SubredditUser > | GetMutedUsers (string after="", string before="", int limit=25, string user="", bool includeCategories=false, int count=0, string show="all", bool srDetail=false) |
Get the muted users of this subreddit. More... | |
List< SubredditUser > | GetMutedUsers (SubredditsAboutInput subredditsAboutInput) |
Get the muted users of this subreddit. More... | |
List< BannedUser > | GetBannedUsers (string after="", string before="", int limit=25, string user="", bool includeCategories=false, int count=0, string show="all", bool srDetail=false) |
Get a list of users who were banned from this subreddit. More... | |
List< BannedUser > | GetBannedUsers (SubredditsAboutInput subredditsAboutInput) |
Get a list of users who were banned from this subreddit. More... | |
Things.SubredditSubmitText | GetSubmitText () |
Get the submission text for the subreddit. This text is set by the subreddit moderators and intended to be displayed on the submission form. More... | |
void | UpdateStylesheet (string reason, string stylesheetContents) |
Update a subreddit's stylesheet. More... | |
async Task | UpdateStylesheetAsync (string reason, string stylesheetContents) |
Update a subreddit's stylesheet asynchronously. More... | |
void | Subscribe (bool skipInitialDefaults=false) |
Subscribe to a subreddit. More... | |
async Task | SubscribeAsync (bool skipInitialDefaults=false) |
Subscribe to a subreddit asynchronously. More... | |
void | Unsubscribe () |
Unsubscribe from a subreddit. More... | |
async Task | UnsubscribeAsync () |
Unsubscribe from a subreddit asynchronously. More... | |
void | DeleteBanner () |
Remove the subreddit's custom mobile banner. More... | |
async Task | DeleteBannerAsync () |
Remove the subreddit's custom mobile banner asynchronously. More... | |
void | DeleteHeader () |
Remove the subreddit's custom header image. The sitewide-default header image will be shown again after this call. More... | |
async Task | DeleteHeaderAsync () |
Remove the subreddit's custom header image asynchronously. More... | |
void | DeleteIcon () |
Remove the subreddit's custom mobile icon. More... | |
async Task | DeleteIconAsync () |
Remove the subreddit's custom mobile icon asynchronously. More... | |
void | DeleteImg (string imgName) |
Remove an image from the subreddit's custom image set. The image will no longer count against the subreddit's image limit. However, the actual image data may still be accessible for an unspecified amount of time. If the image is currently referenced by the subreddit's stylesheet, that stylesheet will no longer validate and won't be editable until the image reference is removed. More... | |
async Task | DeleteImgAsync (string imgName) |
Remove an image from the subreddit's custom image set asynchronously. The image will no longer count against the subreddit's image limit. However, the actual image data may still be accessible for an unspecified amount of time. If the image is currently referenced by the subreddit's stylesheet, that stylesheet will no longer validate and won't be editable until the image reference is removed. More... | |
Things.ImageUploadResult | UploadImg (byte[] imgData, string imgName, string imgType="png") |
Add or replace a subreddit stylesheet image. More... | |
async Task< Things.ImageUploadResult > | UploadImgAsync (byte[] imgData, string imgName, string imgType="png") |
Add or replace a subreddit stylesheet image asynchronously. More... | |
Things.ImageUploadResult | UploadHeader (byte[] imgData, string imgType="png") |
Add or replace the subreddit logo image. More... | |
async Task< Things.ImageUploadResult > | UploadHeaderAsync (byte[] imgData, string imgType="png") |
Add or replace the subreddit logo image asynchronously. More... | |
Things.ImageUploadResult | UploadIcon (byte[] imgData, string imgType="png") |
Add or replace a subreddit mobile icon image. More... | |
async Task< Things.ImageUploadResult > | UploadIconAsync (byte[] imgData, string imgType="png") |
Add or replace a subreddit mobile icon image asynchronously. More... | |
Things.ImageUploadResult | UploadBanner (byte[] imgData, string imgType="png") |
Add or replace a subreddit mobile banner image. More... | |
async Task< Things.ImageUploadResult > | UploadBannerAsync (byte[] imgData, string imgType="png") |
Add or replace a subreddit mobile banner image asynchronously. More... | |
Things.SubredditSettingsContainer | GetSettings (bool created=false, string location="") |
Get the current settings of a subreddit. More... | |
Things.RulesContainer | GetRules () |
Get the rules for the current subreddit. More... | |
Things.Traffic | GetTraffic () |
Get the traffic for the current subreddit. More... | |
List< Post > | Search (SearchGetSearchInput searchGetSearchInput) |
Search this subreddit for posts. To search across all subreddits, use RedditAPI.Search, instead. More... | |
List< Post > | Search (string q, SearchGetSearchInput searchGetSearchInput=null) |
Search this subreddit for posts. To search across all subreddits, use RedditAPI.Search, instead. More... | |
List< Post > | Search (string q="", bool restrictSr=true, string sort="new", string category="", bool includeFacets=false, string type=null, string t="all", string after=null, string before=null, bool includeCategories=false, int count=0, int limit=25, string show="all", bool srDetail=false) |
Search this subreddit for posts. More... | |
Dictionary< string, string > | SavedMediaText (string url) |
Retrieve the advisory text about saving media for relevant media links. This endpoint returns a notice for display during the post submission process that is pertinent to media links. More... | |
Things.ModActionContainer | GetLog (string type=null, int limit=25, string after="", string before="", string mod=null, string show="all", bool srDetail=false, int count=0) |
Get a list of recent moderation actions. Moderator actions taken within a subreddit are logged. This listing is a view of that log with various filters to aid in analyzing the information. The optional mod parameter can be a comma-delimited list of moderator names to restrict the results to, or the string a to restrict the results to admin actions taken within the subreddit. The type parameter is optional and if sent limits the log entries returned to only those of the type specified. More... | |
Things.ModActionContainer | GetLog (ModerationGetLogInput moderationGetLogInput) |
Get a list of recent moderation actions. Moderator actions taken within a subreddit are logged. This listing is a view of that log with various filters to aid in analyzing the information. The optional mod parameter can be a comma-delimited list of moderator names to restrict the results to, or the string a to restrict the results to admin actions taken within the subreddit. The type parameter is optional and if sent limits the log entries returned to only those of the type specified. More... | |
string | Stylesheet () |
Redirect to the subreddit's stylesheet if one exists. More... | |
void | ModeratorInvite (string username, string permissions, int? duration=null) |
Invite a user to become a moderator of this subreddit. More... | |
async Task | ModeratorInviteAsync (string username, string permissions, int? duration=null) |
Asynchronously invite a user to become a moderator of this subreddit. More... | |
void | ModeratorInvite (UsersFriendInput usersFriendInput) |
Invite a user to become a moderator of this subreddit. More... | |
async Task | ModeratorInviteAsync (UsersFriendInput usersFriendInput) |
Asynchronously invite a user to become a moderator of this subreddit. More... | |
void | SetUserPermissions (string username, string permissions, string type) |
Set permissions. More... | |
async Task | SetUserPermissionsAsync (string username, string permissions, string type) |
Set permissions asynchronously. More... | |
void | SetUserPermissions (UsersSetPermissionsInput usersSetPermissionsInput) |
Set permissions. More... | |
async Task | SetUserPermissionsAsync (UsersSetPermissionsInput usersSetPermissionsInput) |
Set permissions asynchronously. More... | |
Subreddit | Create (bool allowPostCrossposts=true, bool allowTop=true, bool excludeBannedModqueue=false, bool freeFormReports=true, string gRecaptchaResponse="", string linkType="any", string spamComments="low", string spamLinks="high", string spamSelfPosts="high", string themeSr="", bool themeSrUpdate=true, string wikiMode="disabled", int wikiEditAge=0, int wikiEditKarma=0) |
Create a new subreddit and return the created result. If a subreddit by that name already exists, an exception is thrown. More... | |
async Task< Subreddit > | CreateAsync (bool allowPostCrossposts=true, bool allowTop=true, bool excludeBannedModqueue=false, bool freeFormReports=true, string gRecaptchaResponse="", string linkType="any", string spamComments="low", string spamLinks="high", string spamSelfPosts="high", string themeSr="", bool themeSrUpdate=true, string wikiMode="disabled", int wikiEditAge=0, int wikiEditKarma=0) |
Create a new subreddit asynchronously and return the created result. If a subreddit by that name already exists, an exception is thrown. More... | |
Subreddit | Create (SubredditsSiteAdminInput subredditsSiteAdminInput, string gRecaptchaResponse="", string headerTitle="") |
Create a new subreddit and return the created result. If a subreddit by that name already exists, an exception is thrown. More... | |
async Task< Subreddit > | CreateAsync (SubredditsSiteAdminInput subredditsSiteAdminInput, string gRecaptchaResponse="", string headerTitle="") |
Create a new subreddit asynchronously and return the created result. If a subreddit by that name already exists, an exception is thrown. More... | |
Subreddit | CreateIfNotExists (bool allowPostCrossposts=true, bool allowTop=true, bool excludeBannedModqueue=false, bool freeFormReports=true, string gRecaptchaResponse="", string linkType="any", string spamComments="low", string spamLinks="high", string spamSelfPosts="high", string themeSr="", bool themeSrUpdate=true, string wikiMode="disabled", int wikiEditAge=0, int wikiEditKarma=0) |
Create a new subreddit and return the created result. If a subreddit by that name already exists, retrieve that existing subreddit and return the result. If the subreddit already exists, the parameters passed to this method will be ignored. More... | |
async Task< Subreddit > | CreateIfNotExistsAsync (bool allowPostCrossposts=true, bool allowTop=true, bool excludeBannedModqueue=false, bool freeFormReports=true, string gRecaptchaResponse="", string linkType="any", string spamComments="low", string spamLinks="high", string spamSelfPosts="high", string themeSr="", bool themeSrUpdate=true, string wikiMode="disabled", int wikiEditAge=0, int wikiEditKarma=0) |
Create a new subreddit asynchronously and return the created result. If a subreddit by that name already exists, retrieve that existing subreddit and return the result. If the subreddit already exists, the parameters passed to this method will be ignored. More... | |
Subreddit | CreateIfNotExists (SubredditsSiteAdminInput subredditsSiteAdminInput, string gRecaptchaResponse="", string headerTitle="") |
Create a new subreddit and return the created result. If a subreddit by that name already exists, retrieve that existing subreddit and return the result. If the subreddit already exists, the parameters passed to this method will be ignored. More... | |
async Task< Subreddit > | CreateIfNotExistsAsync (SubredditsSiteAdminInput subredditsSiteAdminInput, string gRecaptchaResponse="", string headerTitle="") |
Create a new subreddit asynchronously and return the created result. If a subreddit by that name already exists, retrieve that existing subreddit and return the result. If the subreddit already exists, the parameters passed to this method will be ignored. More... | |
Subreddit | CreateOrUpdate (bool allowPostCrossposts=true, bool allowTop=true, bool excludeBannedModqueue=false, bool freeFormReports=true, string gRecaptchaResponse="", string linkType="any", string spamComments="low", string spamLinks="high", string spamSelfPosts="high", string themeSr="", bool themeSrUpdate=true, string wikiMode="disabled", int wikiEditAge=0, int wikiEditKarma=0) |
Create a new subreddit and return the created result. If a subreddit by that name already exists, update that existing subreddit and return the result. More... | |
async Task< Subreddit > | CreateOrUpdateAsync (bool allowPostCrossposts=true, bool allowTop=true, bool excludeBannedModqueue=false, bool freeFormReports=true, string gRecaptchaResponse="", string linkType="any", string spamComments="low", string spamLinks="high", string spamSelfPosts="high", string themeSr="", bool themeSrUpdate=true, string wikiMode="disabled", int wikiEditAge=0, int wikiEditKarma=0) |
Create a new subreddit asynchronously and return the created result. If a subreddit by that name already exists, update that existing subreddit and return the result. More... | |
Subreddit | CreateOrUpdate (SubredditsSiteAdminInput subredditsSiteAdminInput, string gRecaptchaResponse="", string headerTitle="") |
Create a new subreddit and return the created result. If a subreddit by that name already exists, update that existing subreddit and return the result. More... | |
async Task< Subreddit > | CreateOrUpdateAsync (SubredditsSiteAdminInput subredditsSiteAdminInput, string gRecaptchaResponse="", string headerTitle="") |
Create a new subreddit asynchronously and return the created result. If a subreddit by that name already exists, update that existing subreddit and return the result. More... | |
Subreddit | Update (bool manualUpdate=false, bool? allOriginalContent=null, bool? allowDiscovery=null, bool? allowImages=null, bool? allowPostCrossposts=null, bool? allowTop=null, bool? allowVideos=null, bool? collapseDeletedComments=null, string description=null, bool? excludeBannedModqueue=null, bool? freeFormReports=null, string gRecaptchaResponse=null, string headerTitle=null, bool? hideAds=null, string keyColor=null, string lang=null, string linkType=null, string name=null, bool? originalContentTagEnabled=null, bool? over18=null, string publicDescription=null, bool? showMedia=null, bool? showMediaPreview=null, string spamComments=null, string spamLinks=null, string spamSelfPosts=null, bool? spoilersEnabled=null, string sr=null, string submitLinkLabel=null, string submitText=null, string submitTextLabel=null, string suggestedCommentSort=null, string themeSr=null, bool? themeSrUpdate=null, string title=null, string type=null, string wikiMode=null, int? commentScoreHideMins=null, int? wikiEditAge=null, int? wikiEditKarma=null) |
Update an existing subreddit. More... | |
async Task< Subreddit > | UpdateAsync (bool manualUpdate=false, bool? allOriginalContent=null, bool? allowDiscovery=null, bool? allowImages=null, bool? allowPostCrossposts=null, bool? allowTop=null, bool? allowVideos=null, bool? collapseDeletedComments=null, string description=null, bool? excludeBannedModqueue=null, bool? freeFormReports=null, string gRecaptchaResponse=null, string headerTitle=null, bool? hideAds=null, string keyColor=null, string lang=null, string linkType=null, string name=null, bool? originalContentTagEnabled=null, bool? over18=null, string publicDescription=null, bool? showMedia=null, bool? showMediaPreview=null, string spamComments=null, string spamLinks=null, string spamSelfPosts=null, bool? spoilersEnabled=null, string sr=null, string submitLinkLabel=null, string submitText=null, string submitTextLabel=null, string suggestedCommentSort=null, string themeSr=null, bool? themeSrUpdate=null, string title=null, string type=null, string wikiMode=null, int? commentScoreHideMins=null, int? wikiEditAge=null, int? wikiEditKarma=null) |
Update an existing subreddit asynchronously. More... | |
Subreddit | Update (SubredditsSiteAdminInput subredditsSiteAdminInput, string gRecaptchaResponse="", string headerTitle="") |
Update an existing subreddit. More... | |
async Task< Subreddit > | UpdateAsync (SubredditsSiteAdminInput subredditsSiteAdminInput, string gRecaptchaResponse="", string headerTitle="") |
Update an existing subreddit asynchronously. More... | |
![]() | |
BaseController () | |
Create a new Controller instance. More... | |
![]() | |
Exception | BuildException (Exception ex, List< List< string >> errors) |
dynamic | Validate (dynamic obj) |
GenericContainer | Validate (GenericContainer genericContainer) |
Generic | Validate (Generic generic) |
DynamicShortListingContainer | Validate (DynamicShortListingContainer dynamicShortListingContainer) |
DynamicShortListingData | Validate (DynamicShortListingData dynamicShortListingData) |
ImageUploadResult | Validate (ImageUploadResult imageUploadResult) |
LiveUpdateEventContainer | Validate (LiveUpdateEventContainer liveUpdateEventContainer) |
LiveThreadCreateResultContainer | Validate (LiveThreadCreateResultContainer liveThreadCreateResultContainer) |
LiveUpdateContainer | Validate (LiveUpdateContainer liveUpdateContainer, int? minChildren=null) |
SubredditSettingsContainer | Validate (SubredditSettingsContainer subredditSettingsContainer) |
SubredditSettings | Validate (SubredditSettings subredditSettings) |
List< ActionResult > | Validate (List< ActionResult > actionResults) |
ActionResult | Validate (ActionResult actionResult) |
FlairListResultContainer | Validate (FlairListResultContainer flairListResultContainer) |
Flair | Validate (Flair flair) |
FlairV2 | Validate (FlairV2 flairV2) |
ModActionContainer | Validate (ModActionContainer modActionContainer) |
ModActionData | Validate (ModActionData modActionData) |
WikiPageRevisionContainer | Validate (WikiPageRevisionContainer wikiPageRevisionContainer) |
WikiPageRevisionData | Validate (WikiPageRevisionData wikiPageRevisionData) |
WikiPageSettingsContainer | Validate (WikiPageSettingsContainer wikiPageSettingsContainer) |
WikiPageSettings | Validate (WikiPageSettings wikiPageSettings) |
List< UserPrefsContainer > | Validate (List< UserPrefsContainer > userPrefsContainers) |
UserPrefsContainer | Validate (UserPrefsContainer userPrefsContainer) |
UserPrefsData | Validate (UserPrefsData userPrefsData) |
PostResultShortContainer | Validate (PostResultShortContainer postResultShortContainer) |
PostResultShort | Validate (PostResultShort postResultShort) |
PostResultContainer | Validate (PostResultContainer postResultContainer) |
PostResult | Validate (PostResult postResult) |
JQueryReturn | Validate (JQueryReturn jQueryReturn) |
List<(PostContainer, CommentContainer)> | Validate (List<(PostContainer, CommentContainer)> ps) |
CommentResultContainer | Validate (CommentResultContainer commentResultContainer) |
SubredditContainer | Validate (SubredditContainer subredditContainer) |
Properties | |
string? | BannerImg [get, set] |
The banner image URL. More... | |
string? | BannerBackgroundColor [get, set] |
The banner background color. More... | |
string? | BannerBackgroundImage [get, set] |
The banner background image URL. More... | |
string? | SubredditType [get, set] |
The subreddit type (public, restricted, or private) More... | |
string? | CommunityIcon [get, set] |
The community icon URL. More... | |
string? | HeaderTitle [get, set] |
The header title. More... | |
bool? | WikiEnabled [get, set] |
Whether the wiki is enabled for this subreddit. More... | |
bool?? | Over18 [get, set] |
Whether you have to be over 18 to view this subreddit. More... | |
string? | Sidebar [get, set] |
The sidebar text. More... | |
string? | Name [get, set] |
The subreddit name. More... | |
byte[]? | HeaderImg [get, set] |
The header image. More... | |
string? | Title [get, set] |
The subreddit title. More... | |
bool?? | CollapseDeletedComments [get, set] |
Whether to collapse deleted comments. More... | |
string? | Id [get, set] |
The ID36 of this subreddit. More... | |
bool? | EmojisEnabled [get, set] |
Whether emojis are enabled. More... | |
bool?? | ShowMedia [get, set] |
Whether to show media. More... | |
bool? | AllowVideos [get, set] |
Whether to allow videos. More... | |
bool? | CanAssignUserFlair [get, set] |
Whether user flair can be assigned. More... | |
bool?? | SpoilersEnabled [get, set] |
Whether spoilers are enabled. More... | |
string? | PrimaryColor [get, set] |
The primary color. More... | |
string? | SuggestedCommentSort [get, set] |
The suggested comment sort for this subreddit. More... | |
int???? | ActiveUserCount [get, set] |
The active user count. More... | |
byte[]? | IconImg [get, set] |
The icon image. More... | |
bool? | CanAssignLinkFlair [get, set] |
Whether link flair can be assigned. More... | |
bool? | AllowVideoGifs [get, set] |
Whether to allow video GIFs. More... | |
int?? | Subscribers [get, set] |
The number of subscribers. More... | |
string? | SubmitTextLabel [get, set] |
The submit text label. More... | |
string? | KeyColor [get, set] |
The key color. More... | |
string? | Lang [get, set] |
The language. More... | |
string? | Fullname [get, set] |
The subreddit fullname. More... | |
DateTime? | Created [get, set] |
When the subreddit was created. More... | |
string? | URL [get, set] |
The URL. More... | |
string? | SubmitLinkLabel [get, set] |
The submit link label. More... | |
bool?? | AllowDiscovery [get, set] |
Whether to allow discovery. More... | |
string? | Description [get, set] |
The subreddit description. More... | |
bool?? | LinkFlairEnabled [get, set] |
Whether link flair is enabled. More... | |
bool?? | AllowImages [get, set] |
Whether to allow images. More... | |
int?? | CommentScoreHideMins [get, set] |
How many minutes to hide comment scores. More... | |
bool?? | ShowMediaPreview [get, set] |
Whether to show media previews. More... | |
string? | SubmissionType [get, set] |
The submission type. More... | |
Things.Subreddit | SubredditData [get] |
Full subreddit data retrieved from the API. More... | |
SubredditPosts | Posts [get, set] |
Posts belonging to this subreddit. More... | |
Comments | Comments [get, set] |
Comments belonging to this subreddit. More... | |
Flairs | Flairs [get, set] |
Flairs belonging to this subreddit. More... | |
Wiki | Wiki [get, set] |
The subreddit wiki controller. More... | |
Things.SubredditSubmitText? | SubmitText [get, set] |
Get the submission text for the subreddit. This text is set by the subreddit moderators and intended to be displayed on the submission form. More... | |
List< Moderator >? | Moderators [get, set] |
Get the moderators of this subreddit. More... | |
![]() | |
Lists | Lists [get, set] |
List-handling. More... | |
Additional Inherited Members | |
![]() | |
void | CheckErrors (List< List< string >> errors) |
void | CheckErrors (List< string > errors) |
void | CheckNull (object res, string msg="Reddit API returned null response.") |
Controller class for subreddits.
Reddit.Controllers.Subreddit.Subreddit | ( | Dispatch | dispatch, |
Things.Subreddit | subreddit | ||
) |
Create a new subreddit controller instance populated from API return data.
dispatch | |
subreddit |
Reddit.Controllers.Subreddit.Subreddit | ( | Dispatch | dispatch, |
Things.SubredditChild | subredditChild | ||
) |
Create a new subreddit controller instance populated from API return data.
dispatch | |
subredditChild |
Copy another subreddit controller instance onto this one.
dispatch | |
subreddit | A valid subreddit controller instance |
Reddit.Controllers.Subreddit.Subreddit | ( | Dispatch | dispatch, |
string | name, | ||
string | title = "" , |
||
string | description = "" , |
||
string | sidebar = "" , |
||
string | submissionText = null , |
||
string | lang = "en" , |
||
string | subredditType = "public" , |
||
string | submissionType = "any" , |
||
string | submitLinkLabel = null , |
||
string | submitTextLabel = null , |
||
bool | wikiEnabled = false , |
||
bool | over18 = false , |
||
bool | allowDiscovery = true , |
||
bool | allowSpoilers = true , |
||
bool | showMedia = true , |
||
bool | showMediaPreview = true , |
||
bool | allowImages = true , |
||
bool | allowVideos = true , |
||
bool | collapseDeletedComments = false , |
||
string | suggestedCommentSort = null , |
||
int | commentScoreHideMins = 0 , |
||
byte[] | headerImage = null , |
||
byte[] | iconImage = null , |
||
string | primaryColor = null , |
||
string | keyColor = null , |
||
string | fullname = null |
||
) |
Create a new subreddit controller instance, populated manually.
dispatch | |
name | |
title | |
description | |
sidebar | |
submissionText | |
lang | |
subredditType | |
submissionType | |
submitLinkLabel | |
submitTextLabel | |
wikiEnabled | |
over18 | |
allowDiscovery | |
allowSpoilers | |
showMedia | |
showMediaPreview | |
allowImages | |
allowVideos | |
collapseDeletedComments | |
suggestedCommentSort | |
commentScoreHideMins | |
headerImage | |
iconImage | |
primaryColor | |
keyColor | |
fullname |
Reddit.Controllers.Subreddit.Subreddit | ( | Dispatch | dispatch | ) |
Create an empty subreddit controller instance.
dispatch |
Subreddit Reddit.Controllers.Subreddit.About | ( | ) |
Return information about the current subreddit instance.
void Reddit.Controllers.Subreddit.AcceptModeratorInvite | ( | ) |
Accept an invite to moderate the specified subreddit. The authenticated user must have been invited to moderate the subreddit by one of its current moderators.
async Task Reddit.Controllers.Subreddit.AcceptModeratorInviteAsync | ( | ) |
Asynchronously accept an invite to moderate the specified subreddit. The authenticated user must have been invited to moderate the subreddit by one of its current moderators.
Subreddit Reddit.Controllers.Subreddit.Create | ( | bool | allowPostCrossposts = true , |
bool | allowTop = true , |
||
bool | excludeBannedModqueue = false , |
||
bool | freeFormReports = true , |
||
string | gRecaptchaResponse = "" , |
||
string | linkType = "any" , |
||
string | spamComments = "low" , |
||
string | spamLinks = "high" , |
||
string | spamSelfPosts = "high" , |
||
string | themeSr = "" , |
||
bool | themeSrUpdate = true , |
||
string | wikiMode = "disabled" , |
||
int | wikiEditAge = 0 , |
||
int | wikiEditKarma = 0 |
||
) |
Create a new subreddit and return the created result. If a subreddit by that name already exists, an exception is thrown.
allowPostCrossposts | boolean value |
allowTop | boolean value |
excludeBannedModqueue | boolean value |
freeFormReports | boolean value |
gRecaptchaResponse | |
linkType | one of (any, link, self) |
spamComments | one of (low, high, all) |
spamLinks | one of (low, high, all) |
spamSelfPosts | one of (low, high, all) |
themeSr | subreddit name |
themeSrUpdate | boolean value |
wikiMode | one of (disabled, modonly, anyone) |
wikiEditAge | an integer between 0 and 36600 (default: 0) |
wikiEditKarma | an integer between 0 and 1000000000 (default: 0) |
Subreddit Reddit.Controllers.Subreddit.Create | ( | SubredditsSiteAdminInput | subredditsSiteAdminInput, |
string | gRecaptchaResponse = "" , |
||
string | headerTitle = "" |
||
) |
Create a new subreddit and return the created result. If a subreddit by that name already exists, an exception is thrown.
subredditsSiteAdminInput | A valid SubredditsSiteAdminInput instance |
gRecaptchaResponse | |
headerTitle |
async Task<Subreddit> Reddit.Controllers.Subreddit.CreateAsync | ( | bool | allowPostCrossposts = true , |
bool | allowTop = true , |
||
bool | excludeBannedModqueue = false , |
||
bool | freeFormReports = true , |
||
string | gRecaptchaResponse = "" , |
||
string | linkType = "any" , |
||
string | spamComments = "low" , |
||
string | spamLinks = "high" , |
||
string | spamSelfPosts = "high" , |
||
string | themeSr = "" , |
||
bool | themeSrUpdate = true , |
||
string | wikiMode = "disabled" , |
||
int | wikiEditAge = 0 , |
||
int | wikiEditKarma = 0 |
||
) |
Create a new subreddit asynchronously and return the created result. If a subreddit by that name already exists, an exception is thrown.
allowPostCrossposts | boolean value |
allowTop | boolean value |
excludeBannedModqueue | boolean value |
freeFormReports | boolean value |
gRecaptchaResponse | |
linkType | one of (any, link, self) |
spamComments | one of (low, high, all) |
spamLinks | one of (low, high, all) |
spamSelfPosts | one of (low, high, all) |
themeSr | subreddit name |
themeSrUpdate | boolean value |
wikiMode | one of (disabled, modonly, anyone) |
wikiEditAge | an integer between 0 and 36600 (default: 0) |
wikiEditKarma | an integer between 0 and 1000000000 (default: 0) |
async Task<Subreddit> Reddit.Controllers.Subreddit.CreateAsync | ( | SubredditsSiteAdminInput | subredditsSiteAdminInput, |
string | gRecaptchaResponse = "" , |
||
string | headerTitle = "" |
||
) |
Create a new subreddit asynchronously and return the created result. If a subreddit by that name already exists, an exception is thrown.
subredditsSiteAdminInput | A valid SubredditsSiteAdminInput instance |
gRecaptchaResponse | |
headerTitle |
Subreddit Reddit.Controllers.Subreddit.CreateIfNotExists | ( | bool | allowPostCrossposts = true , |
bool | allowTop = true , |
||
bool | excludeBannedModqueue = false , |
||
bool | freeFormReports = true , |
||
string | gRecaptchaResponse = "" , |
||
string | linkType = "any" , |
||
string | spamComments = "low" , |
||
string | spamLinks = "high" , |
||
string | spamSelfPosts = "high" , |
||
string | themeSr = "" , |
||
bool | themeSrUpdate = true , |
||
string | wikiMode = "disabled" , |
||
int | wikiEditAge = 0 , |
||
int | wikiEditKarma = 0 |
||
) |
Create a new subreddit and return the created result. If a subreddit by that name already exists, retrieve that existing subreddit and return the result. If the subreddit already exists, the parameters passed to this method will be ignored.
allowPostCrossposts | boolean value |
allowTop | boolean value |
excludeBannedModqueue | boolean value |
freeFormReports | boolean value |
gRecaptchaResponse | |
linkType | one of (any, link, self) |
spamComments | one of (low, high, all) |
spamLinks | one of (low, high, all) |
spamSelfPosts | one of (low, high, all) |
themeSr | subreddit name |
themeSrUpdate | boolean value |
wikiMode | one of (disabled, modonly, anyone) |
wikiEditAge | an integer between 0 and 36600 (default: 0) |
wikiEditKarma | an integer between 0 and 1000000000 (default: 0) |
Subreddit Reddit.Controllers.Subreddit.CreateIfNotExists | ( | SubredditsSiteAdminInput | subredditsSiteAdminInput, |
string | gRecaptchaResponse = "" , |
||
string | headerTitle = "" |
||
) |
Create a new subreddit and return the created result. If a subreddit by that name already exists, retrieve that existing subreddit and return the result. If the subreddit already exists, the parameters passed to this method will be ignored.
subredditsSiteAdminInput | A valid SubredditsSiteAdminInput instance |
gRecaptchaResponse | |
headerTitle |
async Task<Subreddit> Reddit.Controllers.Subreddit.CreateIfNotExistsAsync | ( | bool | allowPostCrossposts = true , |
bool | allowTop = true , |
||
bool | excludeBannedModqueue = false , |
||
bool | freeFormReports = true , |
||
string | gRecaptchaResponse = "" , |
||
string | linkType = "any" , |
||
string | spamComments = "low" , |
||
string | spamLinks = "high" , |
||
string | spamSelfPosts = "high" , |
||
string | themeSr = "" , |
||
bool | themeSrUpdate = true , |
||
string | wikiMode = "disabled" , |
||
int | wikiEditAge = 0 , |
||
int | wikiEditKarma = 0 |
||
) |
Create a new subreddit asynchronously and return the created result. If a subreddit by that name already exists, retrieve that existing subreddit and return the result. If the subreddit already exists, the parameters passed to this method will be ignored.
allowPostCrossposts | boolean value |
allowTop | boolean value |
excludeBannedModqueue | boolean value |
freeFormReports | boolean value |
gRecaptchaResponse | |
linkType | one of (any, link, self) |
spamComments | one of (low, high, all) |
spamLinks | one of (low, high, all) |
spamSelfPosts | one of (low, high, all) |
themeSr | subreddit name |
themeSrUpdate | boolean value |
wikiMode | one of (disabled, modonly, anyone) |
wikiEditAge | an integer between 0 and 36600 (default: 0) |
wikiEditKarma | an integer between 0 and 1000000000 (default: 0) |
async Task<Subreddit> Reddit.Controllers.Subreddit.CreateIfNotExistsAsync | ( | SubredditsSiteAdminInput | subredditsSiteAdminInput, |
string | gRecaptchaResponse = "" , |
||
string | headerTitle = "" |
||
) |
Create a new subreddit asynchronously and return the created result. If a subreddit by that name already exists, retrieve that existing subreddit and return the result. If the subreddit already exists, the parameters passed to this method will be ignored.
subredditsSiteAdminInput | A valid SubredditsSiteAdminInput instance |
gRecaptchaResponse | |
headerTitle |
Subreddit Reddit.Controllers.Subreddit.CreateOrUpdate | ( | bool | allowPostCrossposts = true , |
bool | allowTop = true , |
||
bool | excludeBannedModqueue = false , |
||
bool | freeFormReports = true , |
||
string | gRecaptchaResponse = "" , |
||
string | linkType = "any" , |
||
string | spamComments = "low" , |
||
string | spamLinks = "high" , |
||
string | spamSelfPosts = "high" , |
||
string | themeSr = "" , |
||
bool | themeSrUpdate = true , |
||
string | wikiMode = "disabled" , |
||
int | wikiEditAge = 0 , |
||
int | wikiEditKarma = 0 |
||
) |
Create a new subreddit and return the created result. If a subreddit by that name already exists, update that existing subreddit and return the result.
allowPostCrossposts | boolean value |
allowTop | boolean value |
excludeBannedModqueue | boolean value |
freeFormReports | boolean value |
gRecaptchaResponse | |
linkType | one of (any, link, self) |
spamComments | one of (low, high, all) |
spamLinks | one of (low, high, all) |
spamSelfPosts | one of (low, high, all) |
themeSr | subreddit name |
themeSrUpdate | boolean value |
wikiMode | one of (disabled, modonly, anyone) |
wikiEditAge | an integer between 0 and 36600 (default: 0) |
wikiEditKarma | an integer between 0 and 1000000000 (default: 0) |
Subreddit Reddit.Controllers.Subreddit.CreateOrUpdate | ( | SubredditsSiteAdminInput | subredditsSiteAdminInput, |
string | gRecaptchaResponse = "" , |
||
string | headerTitle = "" |
||
) |
Create a new subreddit and return the created result. If a subreddit by that name already exists, update that existing subreddit and return the result.
subredditsSiteAdminInput | A valid SubredditsSiteAdminInput instance |
gRecaptchaResponse | |
headerTitle |
async Task<Subreddit> Reddit.Controllers.Subreddit.CreateOrUpdateAsync | ( | bool | allowPostCrossposts = true , |
bool | allowTop = true , |
||
bool | excludeBannedModqueue = false , |
||
bool | freeFormReports = true , |
||
string | gRecaptchaResponse = "" , |
||
string | linkType = "any" , |
||
string | spamComments = "low" , |
||
string | spamLinks = "high" , |
||
string | spamSelfPosts = "high" , |
||
string | themeSr = "" , |
||
bool | themeSrUpdate = true , |
||
string | wikiMode = "disabled" , |
||
int | wikiEditAge = 0 , |
||
int | wikiEditKarma = 0 |
||
) |
Create a new subreddit asynchronously and return the created result. If a subreddit by that name already exists, update that existing subreddit and return the result.
allowPostCrossposts | boolean value |
allowTop | boolean value |
excludeBannedModqueue | boolean value |
freeFormReports | boolean value |
gRecaptchaResponse | |
linkType | one of (any, link, self) |
spamComments | one of (low, high, all) |
spamLinks | one of (low, high, all) |
spamSelfPosts | one of (low, high, all) |
themeSr | subreddit name |
themeSrUpdate | boolean value |
wikiMode | one of (disabled, modonly, anyone) |
wikiEditAge | an integer between 0 and 36600 (default: 0) |
wikiEditKarma | an integer between 0 and 1000000000 (default: 0) |
async Task<Subreddit> Reddit.Controllers.Subreddit.CreateOrUpdateAsync | ( | SubredditsSiteAdminInput | subredditsSiteAdminInput, |
string | gRecaptchaResponse = "" , |
||
string | headerTitle = "" |
||
) |
Create a new subreddit asynchronously and return the created result. If a subreddit by that name already exists, update that existing subreddit and return the result.
subredditsSiteAdminInput | A valid SubredditsSiteAdminInput instance |
gRecaptchaResponse | |
headerTitle |
void Reddit.Controllers.Subreddit.DeleteBanner | ( | ) |
Remove the subreddit's custom mobile banner.
async Task Reddit.Controllers.Subreddit.DeleteBannerAsync | ( | ) |
Remove the subreddit's custom mobile banner asynchronously.
void Reddit.Controllers.Subreddit.DeleteHeader | ( | ) |
Remove the subreddit's custom header image. The sitewide-default header image will be shown again after this call.
async Task Reddit.Controllers.Subreddit.DeleteHeaderAsync | ( | ) |
Remove the subreddit's custom header image asynchronously.
void Reddit.Controllers.Subreddit.DeleteIcon | ( | ) |
Remove the subreddit's custom mobile icon.
async Task Reddit.Controllers.Subreddit.DeleteIconAsync | ( | ) |
Remove the subreddit's custom mobile icon asynchronously.
void Reddit.Controllers.Subreddit.DeleteImg | ( | string | imgName | ) |
Remove an image from the subreddit's custom image set. The image will no longer count against the subreddit's image limit. However, the actual image data may still be accessible for an unspecified amount of time. If the image is currently referenced by the subreddit's stylesheet, that stylesheet will no longer validate and won't be editable until the image reference is removed.
imgName | a valid subreddit image name |
async Task Reddit.Controllers.Subreddit.DeleteImgAsync | ( | string | imgName | ) |
Remove an image from the subreddit's custom image set asynchronously. The image will no longer count against the subreddit's image limit. However, the actual image data may still be accessible for an unspecified amount of time. If the image is currently referenced by the subreddit's stylesheet, that stylesheet will no longer validate and won't be editable until the image reference is removed.
imgName | a valid subreddit image name |
List<BannedUser> Reddit.Controllers.Subreddit.GetBannedUsers | ( | string | after = "" , |
string | before = "" , |
||
int | limit = 25 , |
||
string | user = "" , |
||
bool | includeCategories = false , |
||
int | count = 0 , |
||
string | show = "all" , |
||
bool | srDetail = false |
||
) |
Get a list of users who were banned from this subreddit.
after | fullname of a thing |
before | fullname of a thing |
limit | the maximum number of items desired (default: 25, maximum: 100) |
user | A valid, existing reddit username |
includeCategories | boolean value |
count | a positive integer (default: 0) |
show | (optional) the string all |
srDetail | (optional) expand subreddits |
List<BannedUser> Reddit.Controllers.Subreddit.GetBannedUsers | ( | SubredditsAboutInput | subredditsAboutInput | ) |
Get a list of users who were banned from this subreddit.
subredditsAboutInput | A valid SubredditsAboutInput instance |
List<SubredditUser> Reddit.Controllers.Subreddit.GetContributors | ( | string | after = "" , |
string | before = "" , |
||
int | limit = 25 , |
||
string | user = "" , |
||
bool | includeCategories = false , |
||
int | count = 0 , |
||
string | show = "all" , |
||
bool | srDetail = false |
||
) |
Get the approved submitters of this subreddit.
after | fullname of a thing |
before | fullname of a thing |
limit | the maximum number of items desired (default: 25, maximum: 100) |
user | A valid, existing reddit username |
includeCategories | boolean value |
count | a positive integer (default: 0) |
show | (optional) the string all |
srDetail | (optional) expand subreddits |
List<SubredditUser> Reddit.Controllers.Subreddit.GetContributors | ( | SubredditsAboutInput | subredditsAboutInput | ) |
Get the approved submitters of this subreddit.
subredditsAboutInput | A valid SubredditsAboutInput instance |
Things.ModActionContainer Reddit.Controllers.Subreddit.GetLog | ( | ModerationGetLogInput | moderationGetLogInput | ) |
Get a list of recent moderation actions. Moderator actions taken within a subreddit are logged. This listing is a view of that log with various filters to aid in analyzing the information. The optional mod parameter can be a comma-delimited list of moderator names to restrict the results to, or the string a to restrict the results to admin actions taken within the subreddit. The type parameter is optional and if sent limits the log entries returned to only those of the type specified.
moderationGetLogInput | A valid ModerationGetLogInput instance |
Things.ModActionContainer Reddit.Controllers.Subreddit.GetLog | ( | string | type = null , |
int | limit = 25 , |
||
string | after = "" , |
||
string | before = "" , |
||
string | mod = null , |
||
string | show = "all" , |
||
bool | srDetail = false , |
||
int | count = 0 |
||
) |
Get a list of recent moderation actions. Moderator actions taken within a subreddit are logged. This listing is a view of that log with various filters to aid in analyzing the information. The optional mod parameter can be a comma-delimited list of moderator names to restrict the results to, or the string a to restrict the results to admin actions taken within the subreddit. The type parameter is optional and if sent limits the log entries returned to only those of the type specified.
type | one of (banuser, unbanuser, spamlink, removelink, approvelink, spamcomment, removecomment, approvecomment, addmoderator, invitemoderator, uninvitemoderator, acceptmoderatorinvite, removemoderator, addcontributor, removecontributor, editsettings, editflair, distinguish, marknsfw, wikibanned, wikicontributor, wikiunbanned, wikipagelisted, removewikicontributor, wikirevise, wikipermlevel, ignorereports, unignorereports, setpermissions, setsuggestedsort, sticky, unsticky, setcontestmode, unsetcontestmode, lock, unlock, muteuser, unmuteuser, createrule, editrule, deleterule, spoiler, unspoiler, modmail_enrollment, community_styling, community_widgets, markoriginalcontent) |
limit | the maximum number of items desired (default: 25, maximum: 500) |
after | fullname of a thing |
before | fullname of a thing |
mod | (optional) a moderator filter |
show | (optional) the string all |
srDetail | (optional) expand subreddits |
count | a positive integer (default: 0) |
List<Moderator> Reddit.Controllers.Subreddit.GetModerators | ( | string | after = "" , |
string | before = "" , |
||
int | limit = 25 , |
||
string | user = "" , |
||
bool | includeCategories = false , |
||
int | count = 0 , |
||
string | show = "all" , |
||
bool | srDetail = false |
||
) |
Get the moderators of this subreddit.
after | fullname of a thing |
before | fullname of a thing |
limit | the maximum number of items desired (default: 25, maximum: 100) |
user | A valid, existing reddit username |
includeCategories | boolean value |
count | a positive integer (default: 0) |
show | (optional) the string all |
srDetail | (optional) expand subreddits |
List<Moderator> Reddit.Controllers.Subreddit.GetModerators | ( | SubredditsAboutInput | subredditsAboutInput | ) |
Get the moderators of this subreddit.
subredditsAboutInput | A valid SubredditsAboutInput instance |
List<SubredditUser> Reddit.Controllers.Subreddit.GetMutedUsers | ( | string | after = "" , |
string | before = "" , |
||
int | limit = 25 , |
||
string | user = "" , |
||
bool | includeCategories = false , |
||
int | count = 0 , |
||
string | show = "all" , |
||
bool | srDetail = false |
||
) |
Get the muted users of this subreddit.
after | fullname of a thing |
before | fullname of a thing |
limit | the maximum number of items desired (default: 25, maximum: 100) |
user | A valid, existing reddit username |
includeCategories | boolean value |
count | a positive integer (default: 0) |
show | (optional) the string all |
srDetail | (optional) expand subreddits |
List<SubredditUser> Reddit.Controllers.Subreddit.GetMutedUsers | ( | SubredditsAboutInput | subredditsAboutInput | ) |
Get the muted users of this subreddit.
subredditsAboutInput | A valid SubredditsAboutInput instance |
Things.RulesContainer Reddit.Controllers.Subreddit.GetRules | ( | ) |
Get the rules for the current subreddit.
Things.SubredditSettingsContainer Reddit.Controllers.Subreddit.GetSettings | ( | bool | created = false , |
string | location = "" |
||
) |
Get the current settings of a subreddit.
created | one of (true, false) |
location |
Things.SubredditSubmitText Reddit.Controllers.Subreddit.GetSubmitText | ( | ) |
Get the submission text for the subreddit. This text is set by the subreddit moderators and intended to be displayed on the submission form.
Things.Traffic Reddit.Controllers.Subreddit.GetTraffic | ( | ) |
Get the traffic for the current subreddit.
void Reddit.Controllers.Subreddit.LeaveContributor | ( | ) |
Abdicate approved submitter status in a subreddit.
async Task Reddit.Controllers.Subreddit.LeaveContributorAsync | ( | ) |
Abdicate approved submitter status in a subreddit asynchronously.
void Reddit.Controllers.Subreddit.LeaveModerator | ( | ) |
Abdicate moderator status in a subreddit.
async Task Reddit.Controllers.Subreddit.LeaveModeratorAsync | ( | ) |
Abdicate moderator status in a subreddit asynchronously.
LinkPost Reddit.Controllers.Subreddit.LinkPost | ( | string | fullname | ) |
LinkPost Reddit.Controllers.Subreddit.LinkPost | ( | string | title = null , |
string | url = null , |
||
string | author = null , |
||
string | thumbnail = null , |
||
int? | thumbnailHeight = null , |
||
int? | thumbnailWidth = null , |
||
JObject | preview = null , |
||
string | id = null , |
||
string | fullname = null , |
||
string | permalink = null , |
||
DateTime | created = default(DateTime) , |
||
DateTime | edited = default(DateTime) , |
||
int | score = 0 , |
||
int | upVotes = 0 , |
||
int | downVotes = 0 , |
||
bool | removed = false , |
||
bool | spam = false |
||
) |
void Reddit.Controllers.Subreddit.ModeratorInvite | ( | string | username, |
string | permissions, | ||
int? | duration = null |
||
) |
Invite a user to become a moderator of this subreddit.
username | the name of an existing user |
permissions | A string representing the permissions being set (e.g. "+wiki") |
duration | an integer between 1 and 999, or null to specify permanent duration |
void Reddit.Controllers.Subreddit.ModeratorInvite | ( | UsersFriendInput | usersFriendInput | ) |
Invite a user to become a moderator of this subreddit.
usersFriendInput | A valid UsersFriendInput instance |
async Task Reddit.Controllers.Subreddit.ModeratorInviteAsync | ( | string | username, |
string | permissions, | ||
int? | duration = null |
||
) |
Asynchronously invite a user to become a moderator of this subreddit.
username | the name of an existing user |
permissions | A string representing the permissions being set (e.g. "+wiki") |
duration | an integer between 1 and 999, or null to specify permanent duration |
async Task Reddit.Controllers.Subreddit.ModeratorInviteAsync | ( | UsersFriendInput | usersFriendInput | ) |
Asynchronously invite a user to become a moderator of this subreddit.
usersFriendInput | A valid UsersFriendInput instance |
Post Reddit.Controllers.Subreddit.Post | ( | ) |
Post Reddit.Controllers.Subreddit.Post | ( | string | fullname | ) |
Dictionary<string, string> Reddit.Controllers.Subreddit.SavedMediaText | ( | string | url | ) |
Retrieve the advisory text about saving media for relevant media links. This endpoint returns a notice for display during the post submission process that is pertinent to media links.
url | a valid URL |
List<Post> Reddit.Controllers.Subreddit.Search | ( | SearchGetSearchInput | searchGetSearchInput | ) |
Search this subreddit for posts. To search across all subreddits, use RedditAPI.Search, instead.
searchGetSearchInput | A valid SearchGetSearchInput instance |
List<Post> Reddit.Controllers.Subreddit.Search | ( | string | q, |
SearchGetSearchInput | searchGetSearchInput = null |
||
) |
Search this subreddit for posts. To search across all subreddits, use RedditAPI.Search, instead.
q | A valid search query |
searchGetSearchInput | A valid SearchGetSearchInput instance (optional) |
List<Post> Reddit.Controllers.Subreddit.Search | ( | string | q = "" , |
bool | restrictSr = true , |
||
string | sort = "new" , |
||
string | category = "" , |
||
bool | includeFacets = false , |
||
string | type = null , |
||
string | t = "all" , |
||
string | after = null , |
||
string | before = null , |
||
bool | includeCategories = false , |
||
int | count = 0 , |
||
int | limit = 25 , |
||
string | show = "all" , |
||
bool | srDetail = false |
||
) |
Search this subreddit for posts.
q | a string no longer than 512 characters |
restrictSr | boolean value |
sort | one of (relevance, hot, top, new, comments) |
category | a string no longer than 5 characters |
includeFacets | boolean value |
type | (optional) comma-delimited list of result types (sr, link, user) |
t | one of (hour, day, week, month, year, all) |
after | fullname of a thing |
before | fullname of a thing |
includeCategories | boolean value |
count | a positive integer (default: 0) |
limit | the maximum number of items desired (default: 25, maximum: 100) |
show | (optional) the string all |
srDetail | boolean value |
SelfPost Reddit.Controllers.Subreddit.SelfPost | ( | string | fullname | ) |
SelfPost Reddit.Controllers.Subreddit.SelfPost | ( | string | title = null , |
string | selfText = null , |
||
string | selfTextHtml = null , |
||
string | author = null , |
||
string | id = null , |
||
string | fullname = null , |
||
string | permalink = null , |
||
DateTime | created = default(DateTime) , |
||
DateTime | edited = default(DateTime) , |
||
int | score = 0 , |
||
int | upVotes = 0 , |
||
int | downVotes = 0 , |
||
bool | removed = false , |
||
bool | spam = false |
||
) |
void Reddit.Controllers.Subreddit.SetUserPermissions | ( | string | username, |
string | permissions, | ||
string | type | ||
) |
Set permissions.
username | the name of an existing user |
permissions | A string representing the permissions being set (e.g. "+wiki") |
type | A string representing the type (e.g. "moderator_invite") |
void Reddit.Controllers.Subreddit.SetUserPermissions | ( | UsersSetPermissionsInput | usersSetPermissionsInput | ) |
Set permissions.
usersSetPermissionsInput | A valid UsersSetPermissionsInput instance |
async Task Reddit.Controllers.Subreddit.SetUserPermissionsAsync | ( | string | username, |
string | permissions, | ||
string | type | ||
) |
Set permissions asynchronously.
username | the name of an existing user |
permissions | A string representing the permissions being set (e.g. "+wiki") |
type | A string representing the type (e.g. "moderator_invite") |
async Task Reddit.Controllers.Subreddit.SetUserPermissionsAsync | ( | UsersSetPermissionsInput | usersSetPermissionsInput | ) |
Set permissions asynchronously.
usersSetPermissionsInput | A valid UsersSetPermissionsInput instance |
string Reddit.Controllers.Subreddit.Stylesheet | ( | ) |
Redirect to the subreddit's stylesheet if one exists.
void Reddit.Controllers.Subreddit.Subscribe | ( | bool | skipInitialDefaults = false | ) |
Subscribe to a subreddit.
skipInitialDefaults | boolean value |
async Task Reddit.Controllers.Subreddit.SubscribeAsync | ( | bool | skipInitialDefaults = false | ) |
Subscribe to a subreddit asynchronously.
skipInitialDefaults | boolean value |
void Reddit.Controllers.Subreddit.Unsubscribe | ( | ) |
Unsubscribe from a subreddit.
async Task Reddit.Controllers.Subreddit.UnsubscribeAsync | ( | ) |
Unsubscribe from a subreddit asynchronously.
Subreddit Reddit.Controllers.Subreddit.Update | ( | bool | manualUpdate = false , |
bool? | allOriginalContent = null , |
||
bool? | allowDiscovery = null , |
||
bool? | allowImages = null , |
||
bool? | allowPostCrossposts = null , |
||
bool? | allowTop = null , |
||
bool? | allowVideos = null , |
||
bool? | collapseDeletedComments = null , |
||
string | description = null , |
||
bool? | excludeBannedModqueue = null , |
||
bool? | freeFormReports = null , |
||
string | gRecaptchaResponse = null , |
||
string | headerTitle = null , |
||
bool? | hideAds = null , |
||
string | keyColor = null , |
||
string | lang = null , |
||
string | linkType = null , |
||
string | name = null , |
||
bool? | originalContentTagEnabled = null , |
||
bool? | over18 = null , |
||
string | publicDescription = null , |
||
bool? | showMedia = null , |
||
bool? | showMediaPreview = null , |
||
string | spamComments = null , |
||
string | spamLinks = null , |
||
string | spamSelfPosts = null , |
||
bool? | spoilersEnabled = null , |
||
string | sr = null , |
||
string | submitLinkLabel = null , |
||
string | submitText = null , |
||
string | submitTextLabel = null , |
||
string | suggestedCommentSort = null , |
||
string | themeSr = null , |
||
bool? | themeSrUpdate = null , |
||
string | title = null , |
||
string | type = null , |
||
string | wikiMode = null , |
||
int? | commentScoreHideMins = null , |
||
int? | wikiEditAge = null , |
||
int? | wikiEditKarma = null |
||
) |
Update an existing subreddit.
manualUpdate | if true, only the values explicitly passed to this method will be updated (default: false) |
allOriginalContent | boolean value |
allowDiscovery | boolean value |
allowImages | boolean value |
allowPostCrossposts | boolean value |
allowTop | boolean value |
allowVideos | boolean value |
collapseDeletedComments | boolean value |
description | raw markdown text |
excludeBannedModqueue | boolean value |
freeFormReports | boolean value |
gRecaptchaResponse | |
headerTitle | a string no longer than 500 characters |
hideAds | boolean value |
keyColor | a 6-digit rgb hex color, e.g. #AABBCC |
lang | a valid IETF language tag (underscore separated) |
linkType | one of (any, link, self) |
name | subreddit name |
originalContentTagEnabled | boolean value |
over18 | boolean value |
publicDescription | raw markdown text |
showMedia | boolean value |
showMediaPreview | boolean value |
spamComments | one of (low, high, all) |
spamLinks | one of (low, high, all) |
spamSelfPosts | one of (low, high, all) |
spoilersEnabled | boolean value |
sr | fullname of a thing |
submitLinkLabel | a string no longer than 60 characters |
submitText | raw markdown text |
submitTextLabel | a string no longer than 60 characters |
suggestedCommentSort | one of (confidence, top, new, controversial, old, random, qa, live) |
themeSr | subreddit name |
themeSrUpdate | boolean value |
title | a string no longer than 100 characters |
type | one of (gold_restricted, archived, restricted, employees_only, gold_only, private, user, public) |
wikiMode | one of (disabled, modonly, anyone) |
commentScoreHideMins | an integer between 0 and 1440 (default: 0) |
wikiEditAge | an integer between 0 and 36600 (default: 0) |
wikiEditKarma | an integer between 0 and 1000000000 (default: 0) |
Subreddit Reddit.Controllers.Subreddit.Update | ( | SubredditsSiteAdminInput | subredditsSiteAdminInput, |
string | gRecaptchaResponse = "" , |
||
string | headerTitle = "" |
||
) |
Update an existing subreddit.
subredditsSiteAdminInput | A valid SubredditsSiteAdminInput instance |
gRecaptchaResponse | |
headerTitle |
async Task<Subreddit> Reddit.Controllers.Subreddit.UpdateAsync | ( | bool | manualUpdate = false , |
bool? | allOriginalContent = null , |
||
bool? | allowDiscovery = null , |
||
bool? | allowImages = null , |
||
bool? | allowPostCrossposts = null , |
||
bool? | allowTop = null , |
||
bool? | allowVideos = null , |
||
bool? | collapseDeletedComments = null , |
||
string | description = null , |
||
bool? | excludeBannedModqueue = null , |
||
bool? | freeFormReports = null , |
||
string | gRecaptchaResponse = null , |
||
string | headerTitle = null , |
||
bool? | hideAds = null , |
||
string | keyColor = null , |
||
string | lang = null , |
||
string | linkType = null , |
||
string | name = null , |
||
bool? | originalContentTagEnabled = null , |
||
bool? | over18 = null , |
||
string | publicDescription = null , |
||
bool? | showMedia = null , |
||
bool? | showMediaPreview = null , |
||
string | spamComments = null , |
||
string | spamLinks = null , |
||
string | spamSelfPosts = null , |
||
bool? | spoilersEnabled = null , |
||
string | sr = null , |
||
string | submitLinkLabel = null , |
||
string | submitText = null , |
||
string | submitTextLabel = null , |
||
string | suggestedCommentSort = null , |
||
string | themeSr = null , |
||
bool? | themeSrUpdate = null , |
||
string | title = null , |
||
string | type = null , |
||
string | wikiMode = null , |
||
int? | commentScoreHideMins = null , |
||
int? | wikiEditAge = null , |
||
int? | wikiEditKarma = null |
||
) |
Update an existing subreddit asynchronously.
manualUpdate | if true, only the values explicitly passed to this method will be updated (default: false) |
allOriginalContent | boolean value |
allowDiscovery | boolean value |
allowImages | boolean value |
allowPostCrossposts | boolean value |
allowTop | boolean value |
allowVideos | boolean value |
collapseDeletedComments | boolean value |
description | raw markdown text |
excludeBannedModqueue | boolean value |
freeFormReports | boolean value |
gRecaptchaResponse | |
headerTitle | a string no longer than 500 characters |
hideAds | boolean value |
keyColor | a 6-digit rgb hex color, e.g. #AABBCC |
lang | a valid IETF language tag (underscore separated) |
linkType | one of (any, link, self) |
name | subreddit name |
originalContentTagEnabled | boolean value |
over18 | boolean value |
publicDescription | raw markdown text |
showMedia | boolean value |
showMediaPreview | boolean value |
spamComments | one of (low, high, all) |
spamLinks | one of (low, high, all) |
spamSelfPosts | one of (low, high, all) |
spoilersEnabled | boolean value |
sr | fullname of a thing |
submitLinkLabel | a string no longer than 60 characters |
submitText | raw markdown text |
submitTextLabel | a string no longer than 60 characters |
suggestedCommentSort | one of (confidence, top, new, controversial, old, random, qa, live) |
themeSr | subreddit name |
themeSrUpdate | boolean value |
title | a string no longer than 100 characters |
type | one of (gold_restricted, archived, restricted, employees_only, gold_only, private, user, public) |
wikiMode | one of (disabled, modonly, anyone) |
commentScoreHideMins | an integer between 0 and 1440 (default: 0) |
wikiEditAge | an integer between 0 and 36600 (default: 0) |
wikiEditKarma | an integer between 0 and 1000000000 (default: 0) |
async Task<Subreddit> Reddit.Controllers.Subreddit.UpdateAsync | ( | SubredditsSiteAdminInput | subredditsSiteAdminInput, |
string | gRecaptchaResponse = "" , |
||
string | headerTitle = "" |
||
) |
Update an existing subreddit asynchronously.
subredditsSiteAdminInput | A valid SubredditsSiteAdminInput instance |
gRecaptchaResponse | |
headerTitle |
void Reddit.Controllers.Subreddit.UpdateStylesheet | ( | string | reason, |
string | stylesheetContents | ||
) |
Update a subreddit's stylesheet.
reason | a string up to 256 characters long, consisting of printable characters |
stylesheetContents | the new stylesheet content |
async Task Reddit.Controllers.Subreddit.UpdateStylesheetAsync | ( | string | reason, |
string | stylesheetContents | ||
) |
Update a subreddit's stylesheet asynchronously.
reason | a string up to 256 characters long, consisting of printable characters |
stylesheetContents | the new stylesheet content |
Things.ImageUploadResult Reddit.Controllers.Subreddit.UploadBanner | ( | byte[] | imgData, |
string | imgType = "png" |
||
) |
Add or replace a subreddit mobile banner image.
imgData | file upload with maximum size of 500 KiB |
imgType | one of png or jpg (default: png) |
async Task<Things.ImageUploadResult> Reddit.Controllers.Subreddit.UploadBannerAsync | ( | byte[] | imgData, |
string | imgType = "png" |
||
) |
Add or replace a subreddit mobile banner image asynchronously.
imgData | file upload with maximum size of 500 KiB |
imgType | one of png or jpg (default: png) |
Things.ImageUploadResult Reddit.Controllers.Subreddit.UploadHeader | ( | byte[] | imgData, |
string | imgType = "png" |
||
) |
Add or replace the subreddit logo image.
imgData | file upload with maximum size of 500 KiB |
imgType | one of png or jpg (default: png) |
async Task<Things.ImageUploadResult> Reddit.Controllers.Subreddit.UploadHeaderAsync | ( | byte[] | imgData, |
string | imgType = "png" |
||
) |
Add or replace the subreddit logo image asynchronously.
imgData | file upload with maximum size of 500 KiB |
imgType | one of png or jpg (default: png) |
Things.ImageUploadResult Reddit.Controllers.Subreddit.UploadIcon | ( | byte[] | imgData, |
string | imgType = "png" |
||
) |
Add or replace a subreddit mobile icon image.
imgData | file upload with maximum size of 500 KiB |
imgType | one of png or jpg (default: png) |
async Task<Things.ImageUploadResult> Reddit.Controllers.Subreddit.UploadIconAsync | ( | byte[] | imgData, |
string | imgType = "png" |
||
) |
Add or replace a subreddit mobile icon image asynchronously.
imgData | file upload with maximum size of 500 KiB |
imgType | one of png or jpg (default: png) |
Things.ImageUploadResult Reddit.Controllers.Subreddit.UploadImg | ( | byte[] | imgData, |
string | imgName, | ||
string | imgType = "png" |
||
) |
Add or replace a subreddit stylesheet image.
imgData | file upload with maximum size of 500 KiB |
imgName | a valid subreddit image name |
imgType | one of png or jpg (default: png) |
async Task<Things.ImageUploadResult> Reddit.Controllers.Subreddit.UploadImgAsync | ( | byte[] | imgData, |
string | imgName, | ||
string | imgType = "png" |
||
) |
Add or replace a subreddit stylesheet image asynchronously.
imgData | file upload with maximum size of 500 KiB |
imgName | a valid subreddit image name |
imgType | one of png or jpg (default: png) |
|
getset |
The active user count.
|
getset |
Whether to allow discovery.
|
getset |
Whether to allow images.
|
getset |
Whether to allow video GIFs.
|
getset |
Whether to allow videos.
|
getset |
The banner background color.
|
getset |
The banner background image URL.
|
getset |
The banner image URL.
|
getset |
Whether link flair can be assigned.
|
getset |
Whether user flair can be assigned.
|
getset |
Whether to collapse deleted comments.
|
getset |
How many minutes to hide comment scores.
|
getset |
The community icon URL.
|
getset |
When the subreddit was created.
|
getset |
The subreddit description.
|
getset |
Whether emojis are enabled.
|
getset |
The subreddit fullname.
|
getset |
The header image.
|
getset |
The header title.
|
getset |
The icon image.
|
getset |
The ID36 of this subreddit.
|
getset |
The key color.
|
getset |
The language.
|
getset |
Whether link flair is enabled.
|
getset |
Get the moderators of this subreddit.
|
getset |
The subreddit name.
|
getset |
Whether you have to be over 18 to view this subreddit.
|
getset |
Posts belonging to this subreddit.
|
getset |
The primary color.
|
getset |
Whether to show media.
|
getset |
Whether to show media previews.
|
getset |
The sidebar text.
|
getset |
Whether spoilers are enabled.
|
getset |
The submission type.
|
getset |
The submit link label.
|
getset |
Get the submission text for the subreddit. This text is set by the subreddit moderators and intended to be displayed on the submission form.
|
getset |
The submit text label.
|
get |
Full subreddit data retrieved from the API.
|
getset |
The subreddit type (public, restricted, or private)
|
getset |
The number of subscribers.
|
getset |
The suggested comment sort for this subreddit.
|
getset |
The subreddit title.
|
getset |
The URL.
|
getset |
The subreddit wiki controller.
|
getset |
Whether the wiki is enabled for this subreddit.