Inbox class

A utility class used to interact with the Reddit inbox.

Inheritance

Constructors

Inbox(Reddit reddit)

Properties

hashCode int
The hash code for this object.
no setterinherited
infoParams Map<String, String>?
no setterinherited
infoPath String
The base request format for the current object.
no setterinherited
reddit Reddit
The current Reddit instance.
finalinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

all() Stream
Returns a Stream of all inbox comments and messages.
collapse(List items) Future<void>
Marks a list of Comment and/or Message objects as collapsed.
commentReplies() Stream<Comment>
Returns a Stream<Comment> of all comment replies.
fetch() Future
Requests the data associated with the current object.
inherited
markRead(List items) Future<void>
Marks a list of Comment and/or Message objects as read.
markUnread(List items) Future<void>
Marks a list of Comment and/or Message objects as unread.
mentions() Stream<Comment>
Returns a Stream<Comment> of comments in which the currently authenticated user was mentioned.
message(String messageId) Future<Message?>
Returns a Message associated with a given fullname.
messages() Stream<Message>
Returns a Stream<Message> of inbox messages.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
sent() Stream<Message>
Returns a Stream<Message> of sent messages.
stream({int? pauseAfter}) Stream
Returns a live Stream of Comment and Message objects.
submissionReplies() Stream<Comment>
Returns a Stream<Comment> of replies to submissions made by the currently authenticated user.
toString() String
A string representation of this object.
inherited
uncollapse(List items) Future<void>
Marks a list of Comment and/or Message objects as uncollapsed.
unread({int? limit, bool markRead = false}) Stream
Returns a Stream of Comment and/or Message objects that have not yet been read.

Operators

operator ==(Object other) bool
The equality operator.
inherited