@devvit/public-api - v0.9.0
Table of contents
Enumerations
Classes
- ButtonWidget
- CalendarWidget
- Comment
- CommunityListWidget
- CustomWidget
- Flair
- FlairTemplate
- ImageWidget
- Listing
- ModNote
- Post
- PostFlairWidget
- PrivateMessage
- RedditAPIClient
- Subreddit
- TextAreaWidget
- User
- Widget
- WikiPage
- WikiPageRevision
- WikiPageSettings
Interfaces
- BanUserOptions
- BanWikiContributorOptions
- CreateFlairTemplateOptions
- CreateRelationshipOptions
- CreateWikiPageOptions
- CrosspostOptions
- EditFlairTemplateOptions
- FlairSettings
- GetCommentsByUserOptions
- GetCommentsOptions
- GetHotPostsOptions
- GetModerationLogOptions
- GetPageRevisionsOptions
- GetPostsByUserOptions
- GetPostsOptions
- GetPostsOptionsWithTimeframe
- GetSortedPostsOptions
- GetSubredditUsersByTypeOptions
- InternalSetPostFlairOptions
- InviteModeratorOptions
- ListingFetchOptions
- ListingFetchResponse
- ModAction
- ModActionTarget
- MoreObject
- MuteUserOptions
- RemoveRelationshipOptions
- SendPrivateMessageAsSubredditOptions
- SendPrivateMessageOptions
- SetFlairOptions
- SetPostFlairOptions
- SetUserFlairOptions
- SubmitLinkOptions
- SubredditSettings
- UpdatePageSettingsOptions
- UpdateWikiPageOptions
- UserNote
Type Aliases
- AddWidgetData
- AllowableFlairContent
- CommentMediaTypes
- CommentSort
- CommentSubmissionOptions
- CommonSubmitPostOptions
- CreateModNoteOptions
- EditCommentOptions
- FlairBackgroundColor
- FlairTextColor
- GetModNotesOptions
- ModActionType
- ModNoteType
- ModeratorPermission
- PostTextOptions
- RelationshipType
- ReplyToCommentOptions
- SubmitCustomPostOptions
- SubmitPostOptions
- SubmitSelfPostOptions
- SubredditType
- UserNoteLabel
Functions
Type Aliases
AddWidgetData
Ƭ AddWidgetData: AddImageWidgetRequest & { type: "image" } | AddCalendarWidgetRequest & { type: "calendar" } | AddTextAreaWidgetRequest & { type: "textarea" } | AddButtonWidgetRequest & { type: "button" } | AddCommunityListWidgetRequest & { type: "community-list" } | AddPostFlairWidgetRequest & { type: "post-flair" } | AddCustomWidgetRequest & { type: "custom" }
AllowableFlairContent
Ƭ AllowableFlairContent: "all" | "emoji" | "text"
CommentMediaTypes
Ƭ CommentMediaTypes: "giphy" | "static" | "animated"
CommentSort
Ƭ CommentSort: "confidence" | "top" | "new" | "controversial" | "old" | "random" | "qa" | "live"
CommentSubmissionOptions
Ƭ CommentSubmissionOptions: { text: string } | { richtext: object | string | RichTextBuilder }
CommonSubmitPostOptions
Ƭ CommonSubmitPostOptions: Object
Type declaration
| Name | Type |
|---|---|
flairId? | string |
flairText? | string |
nsfw? | boolean |
sendreplies? | boolean |
spoiler? | boolean |
title | string |
CreateModNoteOptions
Ƭ CreateModNoteOptions: Prettify< PostNotesRequest & { label: UserNoteLabel ; redditId: T1ID | T3ID }>
EditCommentOptions
Ƭ EditCommentOptions: CommentSubmissionOptions
FlairBackgroundColor
Ƭ FlairBackgroundColor: `#${string}` | "transparent"
FlairTextColor
Ƭ FlairTextColor: "light" | "dark"
GetModNotesOptions
Ƭ GetModNotesOptions: Prettify< Pick< GetNotesRequest, "subreddit" | "user"> & { filter?: ModNoteType } & Pick< ListingFetchOptions, "limit" | "before">>
ModActionType
Ƭ ModActionType: "banuser" | "unbanuser" | "spamlink" | "removelink" | "approvelink" | "spamcomment" | "removecomment" | "approvecomment" | "addmoderator" | "showcomment" | "invitemoderator" | "uninvitemoderator" | "acceptmoderatorinvite" | "removemoderator" | "addcontributor" | "removecontributor" | "editsettings" | "editflair" | "distinguish" | "marknsfw" | "wikibanned" | "wikicontributor" | "wikiunbanned" | "wikipagelisted" | "removewikicontributor" | "wikirevise" | "wikipermlevel" | "ignorereports" | "unignorereports" | "setpermissions" | "setsuggestedsort" | "sticky" | "unsticky" | "setcontestmode" | "unsetcontestmode" | "lock" | "unlock" | "muteuser" | "unmuteuser" | "createrule" | "editrule" | "reorderrules" | "deleterule" | "spoiler" | "unspoiler" | "modmail_enrollment" | "community_styling" | "community_widgets" | "markoriginalcontent" | "collections" | "events" | "hidden_award" | "add_community_topics" | "remove_community_topics" | "create_scheduled_post" | "edit_scheduled_post" | "delete_scheduled_post" | "submit_scheduled_post" | "edit_post_requirements" | "invitesubscriber" | "submit_content_rating_survey" | "adjust_post_crowd_control_level" | "enable_post_crowd_control_filter" | "disable_post_crowd_control_filter" | "deleteoverriddenclassification" | "overrideclassification" | "reordermoderators" | "snoozereports" | "unsnoozereports" | "addnote" | "deletenote" | "addremovalreason" | "createremovalreason" | "updateremovalreason" | "deleteremovalreason" | "dev_platform_app_changed" | "dev_platform_app_disabled" | "dev_platform_app_enabled" | "dev_platform_app_installed" | "dev_platform_app_uninstalled"
ModNoteType
Ƭ ModNoteType: "NOTE" | "APPROVAL" | "REMOVAL" | "BAN" | "MUTE" | "INVITE" | "SPAM" | "CONTENT_CHANGE" | "MOD_ACTION" | "ALL"
ModeratorPermission
Ƭ ModeratorPermission: "all" | "wiki" | "posts" | "access" | "mail" | "config" | "flair" | "chat_operator" | "chat_config"
PostTextOptions
Ƭ PostTextOptions: { text: string } | { richtext: object | string | RichTextBuilder }
RelationshipType
Ƭ RelationshipType: "moderator_invite" | "contributor" | "banned" | "muted" | "wikibanned" | "wikicontributor"
ReplyToCommentOptions
Ƭ ReplyToCommentOptions: CommentSubmissionOptions
SubmitCustomPostOptions
Ƭ SubmitCustomPostOptions: CommonSubmitPostOptions & { preview: Block }
SubmitPostOptions
Ƭ SubmitPostOptions: SubmitLinkOptions | SubmitSelfPostOptions | SubmitCustomPostOptions & { subredditName: string }
SubmitSelfPostOptions
Ƭ SubmitSelfPostOptions: PostTextOptions & CommonSubmitPostOptions
SubredditType
Ƭ SubredditType: "public" | "private" | "restricted" | "employees_only" | "gold_restricted" | "archived"
UserNoteLabel
Ƭ UserNoteLabel: "BOT_BAN" | "PERMA_BAN" | "BAN" | "ABUSE_WARNING" | "SPAM_WARNING" | "SPAM_WATCH" | "SOLID_CONTRIBUTOR" | "HELPFUL_USER"
Functions
getModerationLog
▸ getModerationLog(options, metadata?): Listing< ModAction>
Parameters
| Name | Type |
|---|---|
options | GetModerationLogOptions |
metadata? | Metadata |