Controller class for subreddit post listings. More...

Inheritance diagram for Reddit.Controllers.SubredditPosts:

Public Member Functions
	SubredditPosts (Dispatch dispatch, string subreddit, List< Post > best=null, List< Post > hot=null, List< Post > newPosts=null, List< Post > rising=null, List< Post > top=null, List< Post > controversial=null, List< Post > modQueue=null, List< Post > modQueueReports=null, List< Post > modQueueSpam=null, List< Post > modQueueUnmoderated=null, List< Post > modQueueEdited=null)
	Create a new instance of the subreddit posts controller. More...

List< Post >	GetBest (string after="", string before="", int limit=100, bool isInterface=false)
	Retrieve a list of posts using "best" sort. More...

List< Post >	GetBest (CategorizedSrListingInput categorizedSrListingInput, bool isInterface=false)
	Retrieve a list of posts using "best" sort. More...

List< Post >	GetHot (string g="", string after="", string before="", int limit=100, bool isInterface=false)
	Retrieve a list of posts using "hot" sort. More...

List< Post >	GetHot (ListingsHotInput listingsHotInput, bool isInterface=false)
	Retrieve a list of posts using "hot" sort. More...

List< Post >	GetNew (string after="", string before="", int limit=100, bool isInterface=false)
	Retrieve a list of posts using "new" sort. More...

List< Post >	GetNew (CategorizedSrListingInput categorizedSrListingInput, bool isInterface=false)
	Retrieve a list of posts using "new" sort. More...

List< Post >	GetRising (string after="", string before="", int limit=100, bool isInterface=false)
	Retrieve a list of posts using "rising" sort. More...

List< Post >	GetRising (CategorizedSrListingInput categorizedSrListingInput, bool isInterface=false)
	Retrieve a list of posts using "rising" sort. More...

List< Post >	GetTop (string t="all", string after="", string before="", int limit=100, bool isInterface=false)
	Retrieve a list of posts using "top" sort. More...

List< Post >	GetTop (TimedCatSrListingInput timedCatSrListingInput, bool isInterface=false)
	Retrieve a list of posts using "top" sort. More...

List< Post >	GetControversial (string t="all", string after="", string before="", int limit=100, bool isInterface=false)
	Retrieve a list of posts using "controversial" sort. More...

List< Post >	GetControversial (TimedCatSrListingInput timedCatSrListingInput, bool isInterface=false)
	Retrieve a list of posts using "controversial" sort. More...

List< Post >	GetModQueue (string after="", string before="", int limit=100, string show="all", bool srDetail=false, int count=0, bool isInterface=false)
	Retrieve a list of posts in the mod queue. More...

List< Post >	GetModQueueReports (string after="", string before="", int limit=100, string show="all", bool srDetail=false, int count=0, bool isInterface=false)
	Retrieve a list of reported posts in the mod queue. More...

List< Post >	GetModQueueSpam (string after="", string before="", int limit=100, string show="all", bool srDetail=false, int count=0, bool isInterface=false)
	Retrieve a list of spammed posts in the mod queue. More...

List< Post >	GetModQueueUnmoderated (string after="", string before="", int limit=100, string show="all", bool srDetail=false, int count=0, bool isInterface=false)
	Retrieve a list of unmoderated posts in the mod queue. More...

List< Post >	GetModQueueEdited (string after="", string before="", int limit=100, string show="all", bool srDetail=false, int count=0, bool isInterface=false)
	Retrieve a list of edited posts in the mod queue. More...

bool	MonitorBest (int? monitoringDelayMs=null, int? monitoringBaseDelayMs=null, List< MonitoringSchedule > schedule=null, bool? breakOnFailure=null, DateTime? monitoringExpiration=null, bool useCache=true)
	Monitor Reddit for new "Best" posts. More...

bool	MonitorHot (int? monitoringDelayMs=null, int? monitoringBaseDelayMs=null, List< MonitoringSchedule > schedule=null, bool? breakOnFailure=null, DateTime? monitoringExpiration=null, bool useCache=true)
	Monitor the subreddit for new "Hot" posts. More...

bool	MonitorNew (int? monitoringDelayMs=null, int? monitoringBaseDelayMs=null, List< MonitoringSchedule > schedule=null, bool? breakOnFailure=null, DateTime? monitoringExpiration=null, bool useCache=true)
	Monitor the subreddit for new posts. More...

bool	MonitorRising (int? monitoringDelayMs=null, int? monitoringBaseDelayMs=null, List< MonitoringSchedule > schedule=null, bool? breakOnFailure=null, DateTime? monitoringExpiration=null, bool useCache=true)
	Monitor the subreddit for new "Rising" posts. More...

bool	MonitorTop (int? monitoringDelayMs=null, int? monitoringBaseDelayMs=null, List< MonitoringSchedule > schedule=null, bool? breakOnFailure=null, DateTime? monitoringExpiration=null, bool useCache=true)
	Monitor the subreddit for new "Top" posts. More...

bool	MonitorControversial (int? monitoringDelayMs=null, int? monitoringBaseDelayMs=null, List< MonitoringSchedule > schedule=null, bool? breakOnFailure=null, DateTime? monitoringExpiration=null, bool useCache=true)
	Monitor the subreddit for new "Controversial" posts. More...

bool	MonitorModQueue (int? monitoringDelayMs=null, int? monitoringBaseDelayMs=null, List< MonitoringSchedule > schedule=null, bool? breakOnFailure=null, DateTime? monitoringExpiration=null, bool useCache=true)
	Monitor the subreddit's modqueue for new "modqueue" posts. More...

bool	MonitorModQueueReports (int? monitoringDelayMs=null, int? monitoringBaseDelayMs=null, List< MonitoringSchedule > schedule=null, bool? breakOnFailure=null, DateTime? monitoringExpiration=null, bool useCache=true)
	Monitor the subreddit's modqueue for new "reports" posts. More...

bool	MonitorModQueueSpam (int? monitoringDelayMs=null, int? monitoringBaseDelayMs=null, List< MonitoringSchedule > schedule=null, bool? breakOnFailure=null, DateTime? monitoringExpiration=null, bool useCache=true)
	Monitor the subreddit's modqueue for new "spam" posts. More...

bool	MonitorModQueueUnmoderated (int? monitoringDelayMs=null, int? monitoringBaseDelayMs=null, List< MonitoringSchedule > schedule=null, bool? breakOnFailure=null, DateTime? monitoringExpiration=null, bool useCache=true)
	Monitor the subreddit's modqueue for new "unmoderated" posts. More...

bool	MonitorModQueueEdited (int? monitoringDelayMs=null, int? monitoringBaseDelayMs=null, List< MonitoringSchedule > schedule=null, bool? breakOnFailure=null, DateTime? monitoringExpiration=null, bool useCache=true)
	Monitor the subreddit's modqueue for new "edited" posts. More...

bool	BestPostsIsMonitored ()
	Whether best is being monitored. More...

bool	HotPostsIsMonitored ()
	Whether hot is being monitored. More...

bool	NewPostsIsMonitored ()
	Whether new is being monitored. More...

bool	RisingPostsIsMonitored ()
	Whether rising is being monitored. More...

bool	TopPostsIsMonitored ()
	Whether top is being monitored. More...

bool	ControversialPostsIsMonitored ()
	Whether controversial is being monitored. More...

bool	ModQueuePostsIsMonitored ()
	Whether modqueue is being monitored. More...

bool	ModQueueReportsPostsIsMonitored ()
	Whether modqueue reports is being monitored. More...

bool	ModQueueSpamPostsIsMonitored ()
	Whether modqueue spam is being monitored. More...

bool	ModQueueUnmoderatedPostsIsMonitored ()
	Whether modqueue unmoderated is being monitored. More...

bool	ModQueueEditedPostsIsMonitored ()
	Whether modqueue edited is being monitored. More...

Public Member Functions inherited from Reddit.Controllers.Internal.Monitors
	Monitors ()

void	Wait (int ms)

bool	IsMonitored (string key, string subKey)

bool	IsScheduled ()

void	WaitOrDie (string key, int timeout=60)

void	WaitOrDie (Thread thread, int timeout=60)

void	KillAllMonitoringThreads ()

Public Member Functions inherited from Reddit.Controllers.BaseController
	BaseController ()
	Create a new Controller instance. More...

Public Member Functions inherited from Reddit.Controllers.Internal.Validators
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)

Protected Member Functions
override Thread	CreateMonitoringThread (string key, string subKey, int startDelayMs=0, int? monitoringDelayMs=null)
	Creates a new monitoring thread. More...

Protected Member Functions inherited from Reddit.Controllers.Internal.Monitors
bool	Monitor (string key, Thread thread, string subKey)

void	RebuildThreads (string subKey)

void	LaunchThreadIfNotNull (string key, Thread thread)

void	KillThread (Thread thread)

void	KillThread (string key)

void	ResetThreads (List< string > oldThreads)

Protected Member Functions inherited from Reddit.Controllers.Internal.Validators
void	CheckErrors (List< List< string >> errors)

void	CheckErrors (List< string > errors)

void	CheckNull (object res, string msg="Reddit API returned null response.")

Properties
List< Post >?	Best `[get]`
	(deprecated) List of posts using "best" sort. More...

IList< Post >?	IBest `[get]`
	(deprecated) IList of posts using "best" sort. More...

List< Post >?	Hot `[get]`
	List of posts using "hot" sort. More...

IList< Post >?	IHot `[get]`
	IList of posts using "hot" sort. More...

List< Post >?	New `[get]`
	List of posts using "new" sort. More...

IList< Post >?	INew `[get]`
	IList of posts using "new" sort. More...

List< Post >?	Rising `[get]`
	List of posts using "rising" sort. More...

IList< Post >?	IRising `[get]`
	IList of posts using "rising" sort. More...

List< Post >?	Top `[get]`
	List of posts using "top" sort. More...

IList< Post >?	ITop `[get]`
	IList of posts using "top" sort. More...

List< Post >?	Controversial `[get]`
	List of posts using "controversial" sort. More...

IList< Post >?	IControversial `[get]`
	IList of posts using "controversial" sort. More...

List< Post >?	ModQueue `[get]`
	List of posts in the mod queue. More...

IList< Post >?	IModQueue `[get]`
	IList of posts in the mod queue. More...

List< Post >?	ModQueueReports `[get]`
	List of reported posts in the mod queue. More...

IList< Post >?	IModQueueReports `[get]`
	IList of reported posts in the mod queue. More...

List< Post >?	ModQueueSpam `[get]`
	List of spammed posts in the mod queue. More...

IList< Post >?	IModQueueSpam `[get]`
	IList of spammed posts in the mod queue. More...

List< Post >?	ModQueueUnmoderated `[get]`
	List of unmoderated posts in the mod queue. More...

IList< Post >?	IModQueueUnmoderated `[get]`
	IList of unmoderated posts in the mod queue. More...

List< Post >?	ModQueueEdited `[get]`
	List of edited posts in the mod queue. More...

IList< Post >?	IModQueueEdited `[get]`
	IList of edited posts in the mod queue. More...

Properties inherited from Reddit.Controllers.Internal.Monitors
IDictionary< string, HashSet< string > >	MonitoringCache `[get, set]`
	An optional cache for preventing the same post from appearing multiple times during monitoring. See: https://github.com/sirkris/Reddit.NET/issues/117#issuecomment-759501039 More...

Properties inherited from Reddit.Controllers.BaseController
Lists	Lists `[get, set]`
	List-handling. More...

Events
EventHandler< PostsUpdateEventArgs >	BestUpdated
	Event handler for monitoring best. More...

EventHandler< PostsUpdateEventArgs >	HotUpdated
	Event handler for monitoring hot. More...

EventHandler< PostsUpdateEventArgs >	NewUpdated
	Event handler for monitoring new. More...

EventHandler< PostsUpdateEventArgs >	RisingUpdated
	Event handler for monitoring rising. More...

EventHandler< PostsUpdateEventArgs >	TopUpdated
	Event handler for monitoring top. More...

EventHandler< PostsUpdateEventArgs >	ControversialUpdated
	Event handler for monitoring controversial. More...

EventHandler< PostsUpdateEventArgs >	ModQueueUpdated
	Event handler for monitoring modqueu. More...

EventHandler< PostsUpdateEventArgs >	ModQueueReportsUpdated
	Event handler for monitoring modqueue reports. More...

EventHandler< PostsUpdateEventArgs >	ModQueueSpamUpdated
	Event handler for monitoring modqueue spam. More...

EventHandler< PostsUpdateEventArgs >	ModQueueUnmoderatedUpdated
	Event handler for monitoring modqueue unmoderated. More...

EventHandler< PostsUpdateEventArgs >	ModQueueEditedUpdated
	Event handler for monitoring modqueue edited. More...

Additional Inherited Members
Public Attributes inherited from Reddit.Controllers.Internal.Monitors
int	MonitoringWaitDelayMS = 1500

Protected Attributes inherited from Reddit.Controllers.Internal.Monitors
volatile bool	Terminate = false

Detailed Description

Controller class for subreddit post listings.

Constructor & Destructor Documentation

◆ SubredditPosts()

Reddit.Controllers.SubredditPosts.SubredditPosts	(	Dispatch	dispatch,
		string	subreddit,
		List< Post >	best = `null`,
		List< Post >	hot = `null`,
		List< Post >	newPosts = `null`,
		List< Post >	rising = `null`,
		List< Post >	top = `null`,
		List< Post >	controversial = `null`,
		List< Post >	modQueue = `null`,
		List< Post >	modQueueReports = `null`,
		List< Post >	modQueueSpam = `null`,
		List< Post >	modQueueUnmoderated = `null`,
		List< Post >	modQueueEdited = `null`
	)

Create a new instance of the subreddit posts controller.

Parameters

dispatch
subreddit	The name of the subreddit
best
hot
newPosts
rising
top
controversial
modQueue
modQueueReports
modQueueSpam
modQueueUnmoderated
modQueueEdited

Member Function Documentation

◆ BestPostsIsMonitored()

bool Reddit.Controllers.SubredditPosts.BestPostsIsMonitored ( )

Whether best is being monitored.

Returns: Whether best is being monitored.

◆ ControversialPostsIsMonitored()

bool Reddit.Controllers.SubredditPosts.ControversialPostsIsMonitored ( )

Whether controversial is being monitored.

Returns: Whether controversial is being monitored.

◆ CreateMonitoringThread()

override Thread Reddit.Controllers.SubredditPosts.CreateMonitoringThread	(	string	key,
		string	subKey,
		int	startDelayMs = `0`,
		int?	monitoringDelayMs = `null`
	)

protectedvirtual

Creates a new monitoring thread.

Parameters

key	Monitoring key
subKey	Monitoring subKey
startDelayMs	How long to wait before starting the thread in milliseconds (default: 0)
monitoringDelayMs	How long to wait between monitoring queries; pass null to leave it auto-managed (default: null)

Returns: The newly-created monitoring thread.

Implements Reddit.Controllers.Internal.Monitors.

◆ GetBest() [1/2]

List<Post> Reddit.Controllers.SubredditPosts.GetBest	(	CategorizedSrListingInput	categorizedSrListingInput,
		bool	isInterface = `false`
	)

Retrieve a list of posts using "best" sort.

Parameters

categorizedSrListingInput	A valid CategorizedSrListingInput instance
isInterface	(optional) whether to store the result cache in the interface

Returns: A list of posts.

◆ GetBest() [2/2]

List<Post> Reddit.Controllers.SubredditPosts.GetBest	(	string	after = `""`,
		string	before = `""`,
		int	limit = `100`,
		bool	isInterface = `false`
	)

Retrieve a list of posts using "best" sort.

Parameters

after	fullname of a thing
before	fullname of a thing
limit	The maximum number of results to be retrieved (default: 100)
isInterface	(optional) whether to store the result cache in the interface

Returns: A list of posts.

◆ GetControversial() [1/2]

List<Post> Reddit.Controllers.SubredditPosts.GetControversial	(	string	t = `"all"`,
		string	after = `""`,
		string	before = `""`,
		int	limit = `100`,
		bool	isInterface = `false`
	)

Retrieve a list of posts using "controversial" sort.

Parameters

t	one of(hour, day, week, month, year, all)
after	fullname of a thing
before	fullname of a thing
limit	The maximum number of results to be retrieved (default: 100)
isInterface	(optional) whether to store the result cache in the interface

Returns: A list of posts.

◆ GetControversial() [2/2]

List<Post> Reddit.Controllers.SubredditPosts.GetControversial	(	TimedCatSrListingInput	timedCatSrListingInput,
		bool	isInterface = `false`
	)

Retrieve a list of posts using "controversial" sort.

Parameters

timedCatSrListingInput	A valid TimedCatSrListingInput instance
isInterface	(optional) whether to store the result cache in the interface

Returns: A list of posts.

◆ GetHot() [1/2]

List<Post> Reddit.Controllers.SubredditPosts.GetHot	(	ListingsHotInput	listingsHotInput,
		bool	isInterface = `false`
	)

Retrieve a list of posts using "hot" sort.

Parameters

listingsHotInput	A valid ListingsHotInput instance
isInterface	(optional) whether to store the result cache in the interface

Returns: A list of posts.

◆ GetHot() [2/2]

List<Post> Reddit.Controllers.SubredditPosts.GetHot	(	string	g = `""`,
		string	after = `""`,
		string	before = `""`,
		int	limit = `100`,
		bool	isInterface = `false`
	)

Retrieve a list of posts using "hot" sort.

Parameters

after	fullname of a thing
before	fullname of a thing
limit	The maximum number of results to be retrieved (default: 100)
isInterface	(optional) whether to store the result cache in the interface

Returns: A list of posts.

◆ GetModQueue()

List<Post> Reddit.Controllers.SubredditPosts.GetModQueue	(	string	after = `""`,
		string	before = `""`,
		int	limit = `100`,
		string	show = `"all"`,
		bool	srDetail = `false`,
		int	count = `0`,
		bool	isInterface = `false`
	)

Retrieve a list of posts in the mod queue.

Parameters

after	fullname of a thing
before	fullname of a thing
limit	The maximum number of results to be retrieved (default: 100)
show	(optional) the string all
srDetail	(optional) expand subreddits
count	a positive integer (default: 0)
isInterface	(optional) whether to store the result cache in the interface

Returns: A list of posts.

◆ GetModQueueEdited()

List<Post> Reddit.Controllers.SubredditPosts.GetModQueueEdited	(	string	after = `""`,
		string	before = `""`,
		int	limit = `100`,
		string	show = `"all"`,
		bool	srDetail = `false`,
		int	count = `0`,
		bool	isInterface = `false`
	)

Retrieve a list of edited posts in the mod queue.

Parameters

after	fullname of a thing
before	fullname of a thing
limit	The maximum number of results to be retrieved (default: 100)
show	(optional) the string all
srDetail	(optional) expand subreddits
count	a positive integer (default: 0)
isInterface	(optional) whether to store the result cache in the interface

Returns: A list of posts.

◆ GetModQueueReports()

List<Post> Reddit.Controllers.SubredditPosts.GetModQueueReports	(	string	after = `""`,
		string	before = `""`,
		int	limit = `100`,
		string	show = `"all"`,
		bool	srDetail = `false`,
		int	count = `0`,
		bool	isInterface = `false`
	)

Retrieve a list of reported posts in the mod queue.

Parameters

after	fullname of a thing
before	fullname of a thing
limit	The maximum number of results to be retrieved (default: 100)
show	(optional) the string all
srDetail	(optional) expand subreddits
count	a positive integer (default: 0)
isInterface	(optional) whether to store the result cache in the interface

Returns: A list of posts.

◆ GetModQueueSpam()

List<Post> Reddit.Controllers.SubredditPosts.GetModQueueSpam	(	string	after = `""`,
		string	before = `""`,
		int	limit = `100`,
		string	show = `"all"`,
		bool	srDetail = `false`,
		int	count = `0`,
		bool	isInterface = `false`
	)

Retrieve a list of spammed posts in the mod queue.

Parameters

after	fullname of a thing
before	fullname of a thing
limit	The maximum number of results to be retrieved (default: 100)
show	(optional) the string all
srDetail	(optional) expand subreddits
count	a positive integer (default: 0)
isInterface	(optional) whether to store the result cache in the interface

Returns: A list of posts.

◆ GetModQueueUnmoderated()

List<Post> Reddit.Controllers.SubredditPosts.GetModQueueUnmoderated	(	string	after = `""`,
		string	before = `""`,
		int	limit = `100`,
		string	show = `"all"`,
		bool	srDetail = `false`,
		int	count = `0`,
		bool	isInterface = `false`
	)

Retrieve a list of unmoderated posts in the mod queue.

Parameters

after	fullname of a thing
before	fullname of a thing
limit	The maximum number of results to be retrieved (default: 100)
show	(optional) the string all
srDetail	(optional) expand subreddits
count	a positive integer (default: 0)
isInterface	(optional) whether to store the result cache in the interface

Returns: A list of posts.

◆ GetNew() [1/2]

List<Post> Reddit.Controllers.SubredditPosts.GetNew	(	CategorizedSrListingInput	categorizedSrListingInput,
		bool	isInterface = `false`
	)

Retrieve a list of posts using "new" sort.

Parameters

categorizedSrListingInput	A valid CategorizedSrListingInput instance
isInterface	(optional) whether to store the result cache in the interface

Returns: A list of posts.

◆ GetNew() [2/2]

List<Post> Reddit.Controllers.SubredditPosts.GetNew	(	string	after = `""`,
		string	before = `""`,
		int	limit = `100`,
		bool	isInterface = `false`
	)

Retrieve a list of posts using "new" sort.

Parameters

after	fullname of a thing
before	fullname of a thing
limit	The maximum number of results to be retrieved (default: 100)
isInterface	(optional) whether to store the result cache in the interface

Returns: A list of posts.

◆ GetRising() [1/2]

List<Post> Reddit.Controllers.SubredditPosts.GetRising	(	CategorizedSrListingInput	categorizedSrListingInput,
		bool	isInterface = `false`
	)

Retrieve a list of posts using "rising" sort.

Parameters

categorizedSrListingInput	A valid CategorizedSrListingInput instance
isInterface	(optional) whether to store the result cache in the interface

Returns: A list of posts.

◆ GetRising() [2/2]

List<Post> Reddit.Controllers.SubredditPosts.GetRising	(	string	after = `""`,
		string	before = `""`,
		int	limit = `100`,
		bool	isInterface = `false`
	)

Retrieve a list of posts using "rising" sort.

Parameters

after	fullname of a thing
before	fullname of a thing
limit	The maximum number of results to be retrieved (default: 100)
isInterface	(optional) whether to store the result cache in the interface

Returns: A list of posts.

◆ GetTop() [1/2]

List<Post> Reddit.Controllers.SubredditPosts.GetTop	(	string	t = `"all"`,
		string	after = `""`,
		string	before = `""`,
		int	limit = `100`,
		bool	isInterface = `false`
	)

Retrieve a list of posts using "top" sort.

Parameters

t	one of(hour, day, week, month, year, all)
after	fullname of a thing
before	fullname of a thing
limit	The maximum number of results to be retrieved (default: 100)
isInterface	(optional) whether to store the result cache in the interface

Returns: A list of posts.

◆ GetTop() [2/2]

List<Post> Reddit.Controllers.SubredditPosts.GetTop	(	TimedCatSrListingInput	timedCatSrListingInput,
		bool	isInterface = `false`
	)

Retrieve a list of posts using "top" sort.

Parameters

timedCatSrListingInput	A valid TimedCatSrListingInput instance
isInterface	(optional) whether to store the result cache in the interface

Returns: A list of posts.

◆ HotPostsIsMonitored()

bool Reddit.Controllers.SubredditPosts.HotPostsIsMonitored ( )

Whether hot is being monitored.

Returns: Whether hot is being monitored.

◆ ModQueueEditedPostsIsMonitored()

bool Reddit.Controllers.SubredditPosts.ModQueueEditedPostsIsMonitored ( )

Whether modqueue edited is being monitored.

Returns: Whether modqueue edited is being monitored.

◆ ModQueuePostsIsMonitored()

bool Reddit.Controllers.SubredditPosts.ModQueuePostsIsMonitored ( )

Whether modqueue is being monitored.

Returns: Whether modqueue is being monitored.

◆ ModQueueReportsPostsIsMonitored()

bool Reddit.Controllers.SubredditPosts.ModQueueReportsPostsIsMonitored ( )

Whether modqueue reports is being monitored.

Returns: Whether modqueue reports is being monitored.

◆ ModQueueSpamPostsIsMonitored()

bool Reddit.Controllers.SubredditPosts.ModQueueSpamPostsIsMonitored ( )

Whether modqueue spam is being monitored.

Returns: Whether modqueue spam is being monitored.

◆ ModQueueUnmoderatedPostsIsMonitored()

bool Reddit.Controllers.SubredditPosts.ModQueueUnmoderatedPostsIsMonitored ( )

Whether modqueue unmoderated is being monitored.

Returns: Whether modqueue unmoderated is being monitored.

◆ MonitorBest()

bool Reddit.Controllers.SubredditPosts.MonitorBest	(	int?	monitoringDelayMs = `null`,
		int?	monitoringBaseDelayMs = `null`,
		List< MonitoringSchedule >	schedule = `null`,
		bool?	breakOnFailure = `null`,
		DateTime?	monitoringExpiration = `null`,
		bool	useCache = `true`
	)

Monitor Reddit for new "Best" posts.

Parameters

monitoringDelayMs	The number of milliseconds between each monitoring query; leave null to auto-manage
monitoringBaseDelayMs	The number of milliseconds between each monitoring query PER THREAD (default: 1500)
schedule	A list of one or more timeframes during which monitoring of this object will occur (default: 24/7)
breakOnFailure	If true, an exception will be thrown when a monitoring query fails; leave null to keep current setting (default: false)
monitoringExpiration	If set, monitoring will automatically stop after the specified DateTime is reached
useCache	Whether to cache the IDs of the monitoring results to prevent duplicate fires (default: true)

Returns: True if this action turned monitoring on, false if this action turned it off.

◆ MonitorControversial()

bool Reddit.Controllers.SubredditPosts.MonitorControversial	(	int?	monitoringDelayMs = `null`,
		int?	monitoringBaseDelayMs = `null`,
		List< MonitoringSchedule >	schedule = `null`,
		bool?	breakOnFailure = `null`,
		DateTime?	monitoringExpiration = `null`,
		bool	useCache = `true`
	)

Monitor the subreddit for new "Controversial" posts.

Parameters

monitoringDelayMs	The number of milliseconds between each monitoring query; leave null to auto-manage
monitoringBaseDelayMs	The number of milliseconds between each monitoring query PER THREAD (default: 1500)
schedule	A list of one or more timeframes during which monitoring of this object will occur (default: 24/7)
breakOnFailure	If true, an exception will be thrown when a monitoring query fails; leave null to keep current setting (default: false)
monitoringExpiration	If set, monitoring will automatically stop after the specified DateTime is reached
useCache	Whether to cache the IDs of the monitoring results to prevent duplicate fires (default: true)

Returns: True if this action turned monitoring on, false if this action turned it off.

◆ MonitorHot()

bool Reddit.Controllers.SubredditPosts.MonitorHot	(	int?	monitoringDelayMs = `null`,
		int?	monitoringBaseDelayMs = `null`,
		List< MonitoringSchedule >	schedule = `null`,
		bool?	breakOnFailure = `null`,
		DateTime?	monitoringExpiration = `null`,
		bool	useCache = `true`
	)

Monitor the subreddit for new "Hot" posts.

Parameters

monitoringDelayMs	The number of milliseconds between each monitoring query; leave null to auto-manage
monitoringBaseDelayMs	The number of milliseconds between each monitoring query PER THREAD (default: 1500)
schedule	A list of one or more timeframes during which monitoring of this object will occur (default: 24/7)
breakOnFailure	If true, an exception will be thrown when a monitoring query fails; leave null to keep current setting (default: false)
monitoringExpiration	If set, monitoring will automatically stop after the specified DateTime is reached
useCache	Whether to cache the IDs of the monitoring results to prevent duplicate fires (default: true)

Returns: True if this action turned monitoring on, false if this action turned it off.

◆ MonitorModQueue()

bool Reddit.Controllers.SubredditPosts.MonitorModQueue	(	int?	monitoringDelayMs = `null`,
		int?	monitoringBaseDelayMs = `null`,
		List< MonitoringSchedule >	schedule = `null`,
		bool?	breakOnFailure = `null`,
		DateTime?	monitoringExpiration = `null`,
		bool	useCache = `true`
	)

Monitor the subreddit's modqueue for new "modqueue" posts.

Parameters

monitoringDelayMs	The number of milliseconds between each monitoring query; leave null to auto-manage
monitoringBaseDelayMs	The number of milliseconds between each monitoring query PER THREAD (default: 1500)
schedule	A list of one or more timeframes during which monitoring of this object will occur (default: 24/7)
breakOnFailure	If true, an exception will be thrown when a monitoring query fails; leave null to keep current setting (default: false)
monitoringExpiration	If set, monitoring will automatically stop after the specified DateTime is reached
useCache	Whether to cache the IDs of the monitoring results to prevent duplicate fires (default: true)

Returns: True if this action turned monitoring on, false if this action turned it off.

◆ MonitorModQueueEdited()

bool Reddit.Controllers.SubredditPosts.MonitorModQueueEdited	(	int?	monitoringDelayMs = `null`,
		int?	monitoringBaseDelayMs = `null`,
		List< MonitoringSchedule >	schedule = `null`,
		bool?	breakOnFailure = `null`,
		DateTime?	monitoringExpiration = `null`,
		bool	useCache = `true`
	)

Monitor the subreddit's modqueue for new "edited" posts.

Parameters

monitoringDelayMs	The number of milliseconds between each monitoring query; leave null to auto-manage
monitoringBaseDelayMs	The number of milliseconds between each monitoring query PER THREAD (default: 1500)
schedule	A list of one or more timeframes during which monitoring of this object will occur (default: 24/7)
breakOnFailure	If true, an exception will be thrown when a monitoring query fails; leave null to keep current setting (default: false)
monitoringExpiration	If set, monitoring will automatically stop after the specified DateTime is reached
useCache	Whether to cache the IDs of the monitoring results to prevent duplicate fires (default: true)

Returns: True if this action turned monitoring on, false if this action turned it off.

◆ MonitorModQueueReports()

bool Reddit.Controllers.SubredditPosts.MonitorModQueueReports	(	int?	monitoringDelayMs = `null`,
		int?	monitoringBaseDelayMs = `null`,
		List< MonitoringSchedule >	schedule = `null`,
		bool?	breakOnFailure = `null`,
		DateTime?	monitoringExpiration = `null`,
		bool	useCache = `true`
	)

Monitor the subreddit's modqueue for new "reports" posts.

Parameters

monitoringDelayMs	The number of milliseconds between each monitoring query; leave null to auto-manage
monitoringBaseDelayMs	The number of milliseconds between each monitoring query PER THREAD (default: 1500)
schedule	A list of one or more timeframes during which monitoring of this object will occur (default: 24/7)
breakOnFailure	If true, an exception will be thrown when a monitoring query fails; leave null to keep current setting (default: false)
monitoringExpiration	If set, monitoring will automatically stop after the specified DateTime is reached
useCache	Whether to cache the IDs of the monitoring results to prevent duplicate fires (default: true)

Returns: True if this action turned monitoring on, false if this action turned it off.

◆ MonitorModQueueSpam()

bool Reddit.Controllers.SubredditPosts.MonitorModQueueSpam	(	int?	monitoringDelayMs = `null`,
		int?	monitoringBaseDelayMs = `null`,
		List< MonitoringSchedule >	schedule = `null`,
		bool?	breakOnFailure = `null`,
		DateTime?	monitoringExpiration = `null`,
		bool	useCache = `true`
	)

Monitor the subreddit's modqueue for new "spam" posts.

Parameters

monitoringDelayMs	The number of milliseconds between each monitoring query; leave null to auto-manage
monitoringBaseDelayMs	The number of milliseconds between each monitoring query PER THREAD (default: 1500)
schedule	A list of one or more timeframes during which monitoring of this object will occur (default: 24/7)
breakOnFailure	If true, an exception will be thrown when a monitoring query fails; leave null to keep current setting (default: false)
monitoringExpiration	If set, monitoring will automatically stop after the specified DateTime is reached
useCache	Whether to cache the IDs of the monitoring results to prevent duplicate fires (default: true)

Returns: True if this action turned monitoring on, false if this action turned it off.

◆ MonitorModQueueUnmoderated()

bool Reddit.Controllers.SubredditPosts.MonitorModQueueUnmoderated	(	int?	monitoringDelayMs = `null`,
		int?	monitoringBaseDelayMs = `null`,
		List< MonitoringSchedule >	schedule = `null`,
		bool?	breakOnFailure = `null`,
		DateTime?	monitoringExpiration = `null`,
		bool	useCache = `true`
	)

Monitor the subreddit's modqueue for new "unmoderated" posts.

Parameters

monitoringDelayMs	The number of milliseconds between each monitoring query; leave null to auto-manage
monitoringBaseDelayMs	The number of milliseconds between each monitoring query PER THREAD (default: 1500)
schedule	A list of one or more timeframes during which monitoring of this object will occur (default: 24/7)
breakOnFailure	If true, an exception will be thrown when a monitoring query fails; leave null to keep current setting (default: false)
monitoringExpiration	If set, monitoring will automatically stop after the specified DateTime is reached
useCache	Whether to cache the IDs of the monitoring results to prevent duplicate fires (default: true)

Returns: True if this action turned monitoring on, false if this action turned it off.

◆ MonitorNew()

bool Reddit.Controllers.SubredditPosts.MonitorNew	(	int?	monitoringDelayMs = `null`,
		int?	monitoringBaseDelayMs = `null`,
		List< MonitoringSchedule >	schedule = `null`,
		bool?	breakOnFailure = `null`,
		DateTime?	monitoringExpiration = `null`,
		bool	useCache = `true`
	)

Monitor the subreddit for new posts.

Parameters

monitoringDelayMs	The number of milliseconds between each monitoring query; leave null to auto-manage
monitoringBaseDelayMs	The number of milliseconds between each monitoring query PER THREAD (default: 1500)
schedule	A list of one or more timeframes during which monitoring of this object will occur (default: 24/7)
breakOnFailure	If true, an exception will be thrown when a monitoring query fails; leave null to keep current setting (default: false)
monitoringExpiration	If set, monitoring will automatically stop after the specified DateTime is reached
useCache	Whether to cache the IDs of the monitoring results to prevent duplicate fires (default: true)

Returns: True if this action turned monitoring on, false if this action turned it off.

◆ MonitorRising()

bool Reddit.Controllers.SubredditPosts.MonitorRising	(	int?	monitoringDelayMs = `null`,
		int?	monitoringBaseDelayMs = `null`,
		List< MonitoringSchedule >	schedule = `null`,
		bool?	breakOnFailure = `null`,
		DateTime?	monitoringExpiration = `null`,
		bool	useCache = `true`
	)

Monitor the subreddit for new "Rising" posts.

Parameters

monitoringDelayMs	The number of milliseconds between each monitoring query; leave null to auto-manage
monitoringBaseDelayMs	The number of milliseconds between each monitoring query PER THREAD (default: 1500)
schedule	A list of one or more timeframes during which monitoring of this object will occur (default: 24/7)
breakOnFailure	If true, an exception will be thrown when a monitoring query fails; leave null to keep current setting (default: false)
monitoringExpiration	If set, monitoring will automatically stop after the specified DateTime is reached
useCache	Whether to cache the IDs of the monitoring results to prevent duplicate fires (default: true)

Returns: True if this action turned monitoring on, false if this action turned it off.

◆ MonitorTop()

bool Reddit.Controllers.SubredditPosts.MonitorTop	(	int?	monitoringDelayMs = `null`,
		int?	monitoringBaseDelayMs = `null`,
		List< MonitoringSchedule >	schedule = `null`,
		bool?	breakOnFailure = `null`,
		DateTime?	monitoringExpiration = `null`,
		bool	useCache = `true`
	)

Monitor the subreddit for new "Top" posts.

Parameters

monitoringDelayMs	The number of milliseconds between each monitoring query; leave null to auto-manage
monitoringBaseDelayMs	The number of milliseconds between each monitoring query PER THREAD (default: 1500)
schedule	A list of one or more timeframes during which monitoring of this object will occur (default: 24/7)
breakOnFailure	If true, an exception will be thrown when a monitoring query fails; leave null to keep current setting (default: false)
monitoringExpiration	If set, monitoring will automatically stop after the specified DateTime is reached
useCache	Whether to cache the IDs of the monitoring results to prevent duplicate fires (default: true)

Returns: True if this action turned monitoring on, false if this action turned it off.

◆ NewPostsIsMonitored()

bool Reddit.Controllers.SubredditPosts.NewPostsIsMonitored ( )

Whether new is being monitored.

Returns: Whether new is being monitored.

◆ RisingPostsIsMonitored()

bool Reddit.Controllers.SubredditPosts.RisingPostsIsMonitored ( )

Whether rising is being monitored.

Returns: Whether rising is being monitored.

◆ TopPostsIsMonitored()

bool Reddit.Controllers.SubredditPosts.TopPostsIsMonitored ( )

Whether top is being monitored.

Returns: Whether top is being monitored.

Property Documentation

◆ Best

List<Post>? Reddit.Controllers.SubredditPosts.Best

get

(deprecated) List of posts using "best" sort.

◆ Controversial

List<Post>? Reddit.Controllers.SubredditPosts.Controversial

get

List of posts using "controversial" sort.

◆ Hot

List<Post>? Reddit.Controllers.SubredditPosts.Hot

get

List of posts using "hot" sort.

◆ IBest

IList<Post>? Reddit.Controllers.SubredditPosts.IBest

get

(deprecated) IList of posts using "best" sort.

◆ IControversial

IList<Post>? Reddit.Controllers.SubredditPosts.IControversial

get

IList of posts using "controversial" sort.

◆ IHot

IList<Post>? Reddit.Controllers.SubredditPosts.IHot

get

IList of posts using "hot" sort.

◆ IModQueue

IList<Post>? Reddit.Controllers.SubredditPosts.IModQueue

get

IList of posts in the mod queue.

◆ IModQueueEdited

IList<Post>? Reddit.Controllers.SubredditPosts.IModQueueEdited

get

IList of edited posts in the mod queue.

◆ IModQueueReports

IList<Post>? Reddit.Controllers.SubredditPosts.IModQueueReports

get

IList of reported posts in the mod queue.

◆ IModQueueSpam

IList<Post>? Reddit.Controllers.SubredditPosts.IModQueueSpam

get

IList of spammed posts in the mod queue.

◆ IModQueueUnmoderated

IList<Post>? Reddit.Controllers.SubredditPosts.IModQueueUnmoderated

get

IList of unmoderated posts in the mod queue.

◆ INew

IList<Post>? Reddit.Controllers.SubredditPosts.INew

get

IList of posts using "new" sort.

◆ IRising

IList<Post>? Reddit.Controllers.SubredditPosts.IRising

get

IList of posts using "rising" sort.

◆ ITop

IList<Post>? Reddit.Controllers.SubredditPosts.ITop

get

IList of posts using "top" sort.

◆ ModQueue

List<Post>? Reddit.Controllers.SubredditPosts.ModQueue

get

List of posts in the mod queue.

◆ ModQueueEdited

List<Post>? Reddit.Controllers.SubredditPosts.ModQueueEdited

get

List of edited posts in the mod queue.

◆ ModQueueReports

List<Post>? Reddit.Controllers.SubredditPosts.ModQueueReports

get

List of reported posts in the mod queue.

◆ ModQueueSpam

List<Post>? Reddit.Controllers.SubredditPosts.ModQueueSpam

get

List of spammed posts in the mod queue.

◆ ModQueueUnmoderated

List<Post>? Reddit.Controllers.SubredditPosts.ModQueueUnmoderated

get

List of unmoderated posts in the mod queue.

◆ New

List<Post>? Reddit.Controllers.SubredditPosts.New

get

List of posts using "new" sort.

◆ Rising

List<Post>? Reddit.Controllers.SubredditPosts.Rising

get

List of posts using "rising" sort.

◆ Top

List<Post>? Reddit.Controllers.SubredditPosts.Top

get

List of posts using "top" sort.

Event Documentation

◆ BestUpdated

EventHandler<PostsUpdateEventArgs> Reddit.Controllers.SubredditPosts.BestUpdated

Event handler for monitoring best.

◆ ControversialUpdated

EventHandler<PostsUpdateEventArgs> Reddit.Controllers.SubredditPosts.ControversialUpdated

Event handler for monitoring controversial.

◆ HotUpdated

EventHandler<PostsUpdateEventArgs> Reddit.Controllers.SubredditPosts.HotUpdated

Event handler for monitoring hot.

◆ ModQueueEditedUpdated

EventHandler<PostsUpdateEventArgs> Reddit.Controllers.SubredditPosts.ModQueueEditedUpdated

Event handler for monitoring modqueue edited.

◆ ModQueueReportsUpdated

EventHandler<PostsUpdateEventArgs> Reddit.Controllers.SubredditPosts.ModQueueReportsUpdated

Event handler for monitoring modqueue reports.

◆ ModQueueSpamUpdated

EventHandler<PostsUpdateEventArgs> Reddit.Controllers.SubredditPosts.ModQueueSpamUpdated

Event handler for monitoring modqueue spam.

◆ ModQueueUnmoderatedUpdated

EventHandler<PostsUpdateEventArgs> Reddit.Controllers.SubredditPosts.ModQueueUnmoderatedUpdated

Event handler for monitoring modqueue unmoderated.

◆ ModQueueUpdated

EventHandler<PostsUpdateEventArgs> Reddit.Controllers.SubredditPosts.ModQueueUpdated

Event handler for monitoring modqueu.

◆ NewUpdated

EventHandler<PostsUpdateEventArgs> Reddit.Controllers.SubredditPosts.NewUpdated

Event handler for monitoring new.

◆ RisingUpdated

EventHandler<PostsUpdateEventArgs> Reddit.Controllers.SubredditPosts.RisingUpdated

Event handler for monitoring rising.

◆ TopUpdated

EventHandler<PostsUpdateEventArgs> Reddit.Controllers.SubredditPosts.TopUpdated

Event handler for monitoring top.

The documentation for this class was generated from the following file:

E:/repos/Reddit.NET/src/Reddit.NET/Controllers/SubredditPosts.cs

Public Member Functions

Protected Member Functions

Properties

Events

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SubredditPosts()

Member Function Documentation

◆ BestPostsIsMonitored()

◆ ControversialPostsIsMonitored()

◆ CreateMonitoringThread()

◆ GetBest() [1/2]

◆ GetBest() [2/2]

◆ GetControversial() [1/2]

◆ GetControversial() [2/2]

◆ GetHot() [1/2]

◆ GetHot() [2/2]

◆ GetModQueue()

◆ GetModQueueEdited()

◆ GetModQueueReports()

◆ GetModQueueSpam()

◆ GetModQueueUnmoderated()

◆ GetNew() [1/2]

◆ GetNew() [2/2]

◆ GetRising() [1/2]

◆ GetRising() [2/2]

◆ GetTop() [1/2]

◆ GetTop() [2/2]

◆ HotPostsIsMonitored()

◆ ModQueueEditedPostsIsMonitored()

◆ ModQueuePostsIsMonitored()

◆ ModQueueReportsPostsIsMonitored()

◆ ModQueueSpamPostsIsMonitored()

◆ ModQueueUnmoderatedPostsIsMonitored()

◆ MonitorBest()

◆ MonitorControversial()

◆ MonitorHot()

◆ MonitorModQueue()

◆ MonitorModQueueEdited()

◆ MonitorModQueueReports()

◆ MonitorModQueueSpam()

◆ MonitorModQueueUnmoderated()

◆ MonitorNew()

◆ MonitorRising()

◆ MonitorTop()

◆ NewPostsIsMonitored()

◆ RisingPostsIsMonitored()

◆ TopPostsIsMonitored()

Property Documentation

◆ Best

◆ Controversial

◆ Hot

◆ IBest

◆ IControversial

◆ IHot

◆ IModQueue

◆ IModQueueEdited

◆ IModQueueReports

◆ IModQueueSpam

◆ IModQueueUnmoderated

◆ INew

◆ IRising

◆ ITop

◆ ModQueue

◆ ModQueueEdited

◆ ModQueueReports

◆ ModQueueSpam

◆ ModQueueUnmoderated

◆ New

◆ Rising

◆ Top

Event Documentation

◆ BestUpdated

◆ ControversialUpdated

◆ HotUpdated

◆ ModQueueEditedUpdated

◆ ModQueueReportsUpdated

◆ ModQueueSpamUpdated

◆ ModQueueUnmoderatedUpdated