@devvit/public-api v0.13.2-dev
get approved():
boolean
boolean
get approvedAtUtc():
number
A number representing the UTC timestamp in seconds, or 0 if its not approved.
number
get authorFlair():
undefined|CommonFlair
undefined | CommonFlair
get authorId():
undefined|`t2_${string}`
undefined | `t2_${string}`
get authorName():
string
string
get bannedAtUtc():
number
number
get body():
string
string
get collapsedBecauseCrowdControl():
boolean
boolean
get createdAt():
Date
Date
get distinguishedBy():
undefined|string
undefined | string
get edited():
boolean
boolean
get id():
`t1_${string}`
`t1_${string}`
get ignoringReports():
boolean
boolean
get locked():
boolean
boolean
get modReportReasons():
string[]
string[]
get numReports():
number
number
get parentId():
`t1_${string}`|`t3_${string}`
`t1_${string}` | `t3_${string}`
get permalink():
string
string
get postId():
`t3_${string}`
`t3_${string}`
get removed():
boolean
boolean
get replies():
Listing<Comment>
Listing<Comment>
get score():
number
number
get spam():
boolean
boolean
get stickied():
boolean
boolean
get subredditId():
`t5_${string}`
`t5_${string}`
get subredditName():
string
string
get url():
string
string
get userReportReasons():
string[]
string[]
addRemovalNote(
options):Promise<void>
Add a mod note for why the comment was removed
string
the reason for removal (maximum 100 characters) (optional)
string
id of a Removal Reason - you can leave this as an empty string if you don't have one
Promise<void>
approve():
Promise<void>
Promise<void>
delete():
Promise<void>
Promise<void>
distinguish(
makeSticky):Promise<void>
boolean = false
Promise<void>
distinguishAsAdmin(
makeSticky):Promise<void>
boolean = false
Promise<void>
edit(
options):Promise<Comment>
Promise<Comment>
getAuthor():
Promise<undefined|User>
Promise<undefined | User>
ignoreReports():
Promise<void>
Promise<void>
isApproved():
boolean
boolean
isDistinguished():
boolean
boolean
isEdited():
boolean
boolean
isIgnoringReports():
boolean
boolean
isLocked():
boolean
boolean
isRemoved():
boolean
boolean
isSpam():
boolean
boolean
isStickied():
boolean
boolean
lock():
Promise<void>
Promise<void>
remove(
isSpam):Promise<void>
boolean = false
Promise<void>
reply(
options):Promise<Comment>
Promise<Comment>
showComment():
Promise<void>
Marks that this comment should not be collapsed by the crowd control system. It can still be collapsed for other reasons.
Promise<void>
snoozeReports(
reason):Promise<void>
Snooze subsequent reports with the given reason from the same users for the next 7 days. Only works for free-form reports.
string
The report reason to snooze.
Promise<void>
toJSON():
Pick<Comment,"subredditName"|"id"|"score"|"subredditId"|"postId"|"permalink"|"url"|"createdAt"|"authorName"|"body"|"approved"|"spam"|"stickied"|"removed"|"edited"|"locked"|"ignoringReports"|"distinguishedBy"|"authorFlair"|"userReportReasons"|"modReportReasons"|"parentId"|"replies"|"numReports"|"collapsedBecauseCrowdControl">
Pick<Comment, "subredditName" | "id" | "score" | "subredditId" | "postId" | "permalink" | "url" | "createdAt" | "authorName" | "body" | "approved" | "spam" | "stickied" | "removed" | "edited" | "locked" | "ignoringReports" | "distinguishedBy" | "authorFlair" | "userReportReasons" | "modReportReasons" | "parentId" | "replies" | "numReports" | "collapsedBecauseCrowdControl">
undistinguish():
Promise<void>
Promise<void>
unignoreReports():
Promise<void>
Promise<void>
unlock():
Promise<void>
Promise<void>
unsnoozeReports(
reason):Promise<void>
Unsnooze reports with the given reason. Only works for free-form reports.
string
The report reason to unsnooze.
Promise<void>