# Functions
Bool is a helper routine that allocates a new bool value to store v and returns a pointer to it.
CheckResponse checks the API response for errors, and returns them if present.
DefaultClient returns a valid, read-only client with limited access to the Reddit API.
DoRequest submits an HTTP request.
DoRequestWithClient submits an HTTP request using the specified client.
FromEnv configures the client with values from environment variables.
Int is a helper routine that allocates a new int value to store v and returns a pointer to it.
NewClient returns a new Reddit API client.
NewClient returns a new Reddit API client.
NewReadonlyClient returns a new read-only Reddit API client.
StreamDiscardInitial will discard data from the first fetch for the stream.
StreamInterval sets the frequency at which data will be fetched for the stream.
StreamMaxRequests sets a limit on the number of times data is fetched for a stream.
String is a helper routine that allocates a new string value to store v and returns a pointer to it.
No description provided by the author
WithBaseURL sets the base URL for the client to make requests to.
No description provided by the author
WithHTTPClient sets the HTTP client which will be used to make requests.
WithTokenURL sets the url used to get access tokens.
WithUserAgent sets the User-Agent header for requests made with the client.
# Constants
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
PermissionApprovedContributorsOnly is only for approved wiki contributors.
PermissionModeratorsOnly is only for moderators.
PermissionSubredditWikiPermissions uses subreddit wiki permissions.
# Structs
AccountService handles communication with the account related methods of the Reddit API.
APIError is an error coming from Reddit.
Ban represents a banned relationship.
BanConfig configures the ban of the user being banned.
Blocked represents a blocked relationship.
ButtonWidget displays up to 10 button style links with customizable font colors for each button.
Client manages communication with the Reddit API.
Collection is a mod curated group of posts within a subreddit.
CollectionCreateRequest represents a request to create a collection.
CollectionService handles communication with the collection related methods of the Reddit API.
Comment is a comment posted by a user.
CommentService handles communication with the comment related methods of the Reddit API.
CommunityDetailsWidget displays your subscriber count, users online, and community description, as defined in your subreddit settings.
CommunityListWidget display a list of up to 10 other communities (subreddits).
CommunityListWidgetCreateRequest represents a requets to create a community list widget.
Credentials are used to authenticate to make requests to the Reddit API.
CustomWidget is a custom widget.
Emoji is a graphic element you can include in a post flair or user flair.
EmojiCreateOrUpdateRequest represents a request to create/update an emoji.
EmojiService handles communication with the emoji related methods of the Reddit API.
An ErrorResponse reports the error caused by an API request.
Flair is a tag that can be attached to a user or a post.
FlairChangeRequest represents a request to change a user's flair.
FlairChangeResponse represents a response to a FlairChangeRequest.
FlairChoice is a choice of flair when selecting one for yourself or for a post.
FlairConfigureRequest represents a request to configure a subreddit's flair settings.
FlairSelectRequest represents a request to select a flair.
FlairService handles communication with the flair related methods of the Reddit API.
FlairSummary is a condensed version of Flair.
FlairTemplate is a generic flair structure that can users can use next to their username or posts in a subreddit.
FlairTemplateCreateOrUpdateRequest represents a request to create/update a flair template.
GoldService handles communication with the gold related methods of the Reddit API.
ImageWidget display a random image from up to 10 selected images.
No description provided by the author
JSONErrorResponse is an error response that sometimes gets returned with a 200 code.
ListDuplicatePostOptions defines possible options used when getting duplicates of a post, i.e.
ListingsService handles communication with the listing related methods of the Reddit API.
ListModActionOptions defines possible options used when getting moderation actions in a subreddit.
ListOptions specifies the optional parameters to various API calls that return a listing.
ListPostOptions defines possible options used when getting posts from a subreddit.
ListPostSearchOptions defines possible options used when searching for posts within a subreddit.
ListSubredditOptions defines possible options used when searching for subreddits.
ListUserOverviewOptions defines possible options used when getting a user's post and/or comments.
LiveThread is a thread on Reddit that provides real-time updates.
LiveThreadContributor is a user that can contribute to a live thread.
LiveThreadContributors is a list of users that can contribute to a live thread.
LiveThreadCreateOrUpdateRequest represents a request to create/update a live thread.
LiveThreadPermissions are the different permissions contributors have or don't have for a live thread.
LiveThreadService handles communication with the live thread related methods of the Reddit API.
LiveThreadUpdate is an update in a live thread.
MenuWidget displays tabs for your community's menu.
Message is a message.
MessageService handles communication with the message related methods of the Reddit API.
ModAction is an action executed by a moderator of a subreddit, such as inviting another user to be a mod, or setting permissions.
ModerationService handles communication with the moderation related methods of the Reddit API.
Moderator is a user who moderates a subreddit.
ModeratorsWidget displays the list of moderators of the subreddit.
ModPermissions are the different permissions moderators have or don't have on a subreddit.
More holds information used to retrieve additional comments omitted from a base comment tree.
Multi is a multireddit, i.e.
MultiCopyRequest represents a request to copy a multireddit.
MultiCreateOrUpdateRequest represents a request to create/update a multireddit.
MultiService handles communication with the multireddit related methods of the Reddit API.
Post is a submitted post on Reddit.
PostAndComments is a post and its comments.
PostService handles communication with the post related methods of the Reddit API.
No description provided by the author
ProxyErrorResponse is an error response that sometimes gets returned with a 200 code.
Rate represents the rate limit for the client.
RateLimitError occurs when the client is sending too many requests to Reddit in a given time frame.
Relationship holds information about a relationship (friend/blocked).
Replies holds replies to a comment.
Response is a Reddit response.
SendMessageRequest represents a request to send a message.
Settings are the user's account settings.
StreamService allows streaming new content from Reddit as it appears.
SubmitLinkRequest are options used for link posts.
Submitted is a newly submitted post on Reddit.
SubmitTextRequest are options used for text posts.
Subreddit holds information about a subreddit.
SubredditImage is an image part of the image set of a subreddit.
SubredditKarma holds user karma data for the subreddit.
SubredditPostRequirements is a list of moderator-designed requirements to post to a subreddit.
SubredditRule is a rule in the subreddit.
SubredditRuleCreateRequest represents a request to add a subreddit rule.
SubredditRulesWidget displays your community rules.
SubredditService handles communication with the subreddit related methods of the Reddit API.
SubredditSettings are a subreddit's settings.
SubredditStyleSheet contains the subreddit's styling information.
SubredditTrafficStats hold information about subreddit traffic.
TextAreaWidget displays a box of text in the subreddit.
TextAreaWidgetCreateRequest represents a requets to create a text area widget.
Timestamp represents a time that can be unmarshalled from a JSON string formatted as either an RFC3339 or Unix timestamp.
Trophy is a Reddit award.
User represents a Reddit user.
UserService handles communication with the user related methods of the Reddit API.
UserSummary represents a Reddit user, but contains fewer pieces of information.
WidgetButton is a button that's part of a widget.
WidgetButtonHoverState is the behaviour of a button that's part of a widget when it's hovered over with the mouse.
WidgetCommunity is a community (subreddit) that's displayed in a widget.
WidgetImage is an image in a widget.
WidgetImageLink is an image that links to an URL within a widget.
WidgetLinkMultiple is a dropdown of multiple links that's part of a widget.
WidgetLinkSingle is a link that's part of a widget.
WidgetService handles communication with the widget related methods of the Reddit API.
WidgetStyle contains style information for the widget.
WikiPage is a wiki page in a subreddit.
WikiPageEditRequest represents a request to edit a wiki page in a subreddit.
WikiPageRevision is a revision of a wiki page.
WikiPageSettings holds the settings for a specific wiki page.
WikiPageSettingsUpdateRequest represents a request to update the visibility and permissions of a wiki page.
WikiService handles communication with the wiki related methods of the Reddit API.
# Interfaces
Widget is a section of useful content on a subreddit.
WidgetCreateRequest represents a request to create a widget.
WidgetLink is a link or a group of links that's part of a widget.
# Type aliases
Opt is used to further configure a client upon initialization.
RequestCompletionCallback defines the type of the request callback function.
StreamOpt is a configuration option to configure a stream.
SubredditNames is a list of subreddit names.
WidgetLinkList is a list of widgets links.
WidgetList is a list of widgets.
WikiPagePermissionLevel defines who can edit a specific wiki page in a subreddit.