SubredditRef class

A lazily initialized class representing a particular Reddit community, also known as a Subreddit. Can be promoted to a Subreddit object.

Inheritance
Mixed in types
Implementers

Constructors

SubredditRef(Reddit reddit)
SubredditRef.name(Reddit reddit, String name)
name is the name of the subreddit without the 'r/' prefix.

Properties

banned → SubredditRelationship
no setter
comments → CommentHelper
no setterinherited
contributor → ContributorRelationship
no setter
displayName → String
no setteroverride
filters → SubredditFilters
no setter
flair → SubredditFlair
no setter
hashCode → int
The hash code for this object.
no setteroverride
infoParams → Map<String, String>?
no setterinherited
infoPath → String
The base request format for the current object.
no setterinherited
mod → SubredditModeration
no setter
moderator → ModeratorRelationship
no setter
modmail → Modmail
no setter
muted → SubredditRelationship
no setter
path → String
no setteroverride
quarantine → SubredditQuarantine
no setter
reddit → Reddit
The current Reddit instance.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
stream → SubredditStream
no setter
stylesheet → SubredditStyleSheet
no setter
wiki → SubredditWiki
no setter

Methods

controversial({TimeFilter timeFilter = TimeFilter.all, int? limit, String? after, Map<String, String>? params}) → Stream<UserContent>
Returns a Stream of controversial comments and submissions. timeFilter is used to filter comments and submissions by time period.
inherited
fetch() → Future
Requests the data associated with the current object.
override
gilded({int? limit, String? after, Map<String, String>? params}) → Stream<UserContentInitialized>
Returns a Stream of content that has been gilded.
inherited
hot({int? limit, String? after, Map<String, String>? params}) → Stream<UserContent>
Returns a Stream of hot comments and submissions.
inherited
message(String subject, String message, {SubredditRef? fromSubreddit}) → Future<void>
Send a message.
inherited
newest({int? limit, String? after, Map<String, String>? params}) → Stream<UserContent>
Returns a Stream of the newest comments and submissions.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
populate() → Future<Subreddit>
Promotes this SubredditRef into a populated Subreddit.
random() → Future<SubmissionRef>
Returns a random submission from the Subreddit.
randomRising({int? limit, String? after, Map<String, String>? params}) → Stream<UserContent>
Returns a random UserContent that is "rising".
inherited
rising({int? limit, String? after, Map<String, String>? params}) → Stream<UserContent>
Returns a UserContent that is "rising".
inherited
rules() → Future<List<Rule>>
Return the rules for the subreddit.
Returns a Stream of UserContent that match query.
sticky({int number = 1}) → Future<SubmissionRef>
Return a SubmissionRef that has been stickied on the subreddit.
submit(String title, {String? selftext, String? url, String? flairId, String? flairText, bool resubmit = true, bool sendReplies = true, bool nsfw = false, bool spoiler = false}) → Future<Submission>
Creates a Submission on the Subreddit.
subscribe({List<SubredditRef>? otherSubreddits}) → Future<void>
Subscribes to the subreddit.
top({TimeFilter timeFilter = TimeFilter.all, int? limit, String? after, Map<String, String>? params}) → Stream<UserContent>
Returns a Stream of the top comments and submissions.
inherited
toString() → String
A string representation of this object.
inherited
traffic() → Future<Map>
Returns a dictionary of the Subreddit's traffic statistics.
unsubscribe({List<SubredditRef>? otherSubreddits}) → Future<void>
Unsubscribes from the subreddit.

Operators

operator ==(Object other) → bool
The equality operator.
override