Class MyUserControls

Various methods to allow you to interact with the authorized user.

Hierarchy (view full)

BaseUserControls
- MyUserControls

Index

Methods

fetch fetchSubreddit getContributorSubreddits getModeratedSubreddits getPosts getSortedComments getSubscribedSubreddits namespace

Methods

fetch

fetch(): Promise<MyUser>
Fetch the details of the authorized user.

Returns Promise<MyUser>
The user.
- Defined in reddit/user/my-user/controls.ts:20

fetchSubreddit

fetchSubreddit(username): Promise<Subreddit>
Fetch a user's subreddit.
Parameters
- username: string
  The user who's subreddit to fetch.
Returns Promise<Subreddit>
A promise that resolves to the user's subreddit.
Inherited from BaseUserControls.fetchSubreddit
- Defined in reddit/user/base/controls.ts:39

getContributorSubreddits

getContributorSubreddits(): Listing<Subreddit>
Get the subreddits the authenticated account is a contributor in.

Returns Listing<Subreddit>
A Listing of Subreddits.

Note
Due to the way Reddit implements Listings, this will only contain the first 1000 subreddits.
- Defined in reddit/user/my-user/controls.ts:40

getModeratedSubreddits

getModeratedSubreddits(): Listing<Subreddit>
Get the subreddits the authenticated account is a moderator in.

Returns Listing<Subreddit>
A Listing of Subreddits.

Note
Due to the way Reddit implements Listings, this will only contain the first 1000 subreddits.
- Defined in reddit/user/my-user/controls.ts:52

getPosts

getPosts(username, sort?): Listing<Post>
Get a Listing of all the posts a user has made.
Parameters
- username: string
  The user to get posts from.
- sort: PostSort = "new"
  How to sort the posts.
Returns Listing<Post>
A sorted Listing of posts.
Inherited from BaseUserControls.getPosts
- Defined in reddit/user/base/controls.ts:51

getSortedComments

getSortedComments(username, sort?): Listing<Comment>
Get a Listing of all the comments a user has made.
Parameters
- username: string
  The user to get comments from.
- sort: UserItemsSort = "new"
  How to sort the comments.
Returns Listing<Comment>
A sorted Listing of comments.
Inherited from BaseUserControls.getSortedComments
- Defined in reddit/user/base/controls.ts:65

getSubscribedSubreddits

getSubscribedSubreddits(): Listing<Subreddit>
Get the subreddits the authenticated account has subscribed to.

Returns Listing<Subreddit>
A Listing of Subreddits.

Note
Due to the way Reddit implements Listings, this will only contain the first 1000 subreddits.
- Defined in reddit/user/my-user/controls.ts:64

namespace

namespace(id): string
Namespace an id with the proper prefix for its type.
Parameters
- id: string
  The ID to namespace.
Returns string
The namespaced version of the id.
Inherited from BaseUserControls.namespace
- Defined in reddit/base-controls.ts:27