Comment

@devvit/public-api v0.12.14-dev

---

Class: Comment

Accessors

approved

Get Signature

get approved(): boolean

Returns

boolean

---

approvedAtUtc

Get Signature

get approvedAtUtc(): number

A number representing the UTC timestamp in seconds, or 0 if its not approved.

Returns

number

---

authorFlair

Get Signature

get authorFlair(): undefined | CommonFlair

Returns

undefined | CommonFlair

---

authorId

Get Signature

get authorId(): undefined | `t2_${string}`

Returns

undefined | `t2_${string}`

---

authorName

Get Signature

get authorName(): string

Returns

string

---

bannedAtUtc

Get Signature

get bannedAtUtc(): number

Returns

number

---

body

Get Signature

get body(): string

Returns

string

---

collapsedBecauseCrowdControl

Get Signature

get collapsedBecauseCrowdControl(): boolean

Returns

boolean

---

createdAt

Get Signature

get createdAt(): Date

Returns

Date

---

distinguishedBy

Get Signature

get distinguishedBy(): undefined | string

Returns

undefined | string

---

edited

Get Signature

get edited(): boolean

Returns

boolean

---

id

Get Signature

get id(): `t1_${string}`

Returns

`t1_${string}`

---

ignoringReports

Get Signature

get ignoringReports(): boolean

Returns

boolean

---

locked

Get Signature

get locked(): boolean

Returns

boolean

---

modReportReasons

Get Signature

get modReportReasons(): string[]

Returns

string[]

---

numReports

Get Signature

get numReports(): number

Returns

number

---

parentId

Get Signature

get parentId(): `t1_${string}` | `t3_${string}`

Returns

`t1_${string}` | `t3_${string}`

---

permalink

Get Signature

get permalink(): string

Returns

string

---

postId

Get Signature

get postId(): `t3_${string}`

Returns

`t3_${string}`

---

removed

Get Signature

get removed(): boolean

Returns

boolean

---

replies

Get Signature

get replies(): Listing<Comment>

Returns

Listing<Comment>

---

score

Get Signature

get score(): number

Returns

number

---

spam

Get Signature

get spam(): boolean

Returns

boolean

---

stickied

Get Signature

get stickied(): boolean

Returns

boolean

---

subredditId

Get Signature

get subredditId(): `t5_${string}`

Returns

`t5_${string}`

---

subredditName

Get Signature

get subredditName(): string

Returns

string

---

url

Get Signature

get url(): string

Returns

string

---

userReportReasons

Get Signature

get userReportReasons(): string[]

Returns

string[]

Methods

addRemovalNote()

addRemovalNote(options): Promise<void>

Add a mod note for why the comment was removed

Parameters

options

modNote?

string

the reason for removal (maximum 100 characters) (optional)

reasonId

string

id of a Removal Reason - you can leave this as an empty string if you don't have one

Returns

Promise<void>

---

approve()

approve(): Promise<void>

Returns

Promise<void>

---

delete()

delete(): Promise<void>

Returns

Promise<void>

---

distinguish()

distinguish(makeSticky): Promise<void>

Parameters

makeSticky

boolean = false

Returns

Promise<void>

---

distinguishAsAdmin()

distinguishAsAdmin(makeSticky): Promise<void>

Parameters

makeSticky

boolean = false

Returns

Promise<void>

---

edit()

edit(options): Promise<Comment>

Parameters

options

CommentSubmissionOptions

Returns

Promise<Comment>

---

getAuthor()

getAuthor(): Promise<undefined | User>

Returns

Promise<undefined | User>

---

ignoreReports()

ignoreReports(): Promise<void>

Returns

Promise<void>

---

isApproved()

isApproved(): boolean

Returns

boolean

---

isDistinguished()

isDistinguished(): boolean

Returns

boolean

---

isEdited()

isEdited(): boolean

Returns

boolean

---

isIgnoringReports()

isIgnoringReports(): boolean

Returns

boolean

---

isLocked()

isLocked(): boolean

Returns

boolean

---

isRemoved()

isRemoved(): boolean

Returns

boolean

---

isSpam()

isSpam(): boolean

Returns

boolean

---

isStickied()

isStickied(): boolean

Returns

boolean

---

lock()

lock(): Promise<void>

Returns

Promise<void>

---

remove()

remove(isSpam): Promise<void>

Parameters

isSpam

boolean = false

Returns

Promise<void>

---

reply()

reply(options): Promise<Comment>

Parameters

options

CommentSubmissionOptions

Returns

Promise<Comment>

---

toJSON()

toJSON(): Pick<Comment, "subredditName" | "id" | "score" | "subredditId" | "postId" | "url" | "createdAt" | "permalink" | "authorName" | "body" | "approved" | "spam" | "stickied" | "removed" | "edited" | "locked" | "ignoringReports" | "distinguishedBy" | "authorFlair" | "userReportReasons" | "modReportReasons" | "parentId" | "replies" | "numReports" | "collapsedBecauseCrowdControl">

Returns

Pick<Comment, "subredditName" | "id" | "score" | "subredditId" | "postId" | "url" | "createdAt" | "permalink" | "authorName" | "body" | "approved" | "spam" | "stickied" | "removed" | "edited" | "locked" | "ignoringReports" | "distinguishedBy" | "authorFlair" | "userReportReasons" | "modReportReasons" | "parentId" | "replies" | "numReports" | "collapsedBecauseCrowdControl">

---

undistinguish()

undistinguish(): Promise<void>

Returns

Promise<void>

---

unignoreReports()

unignoreReports(): Promise<void>

Returns

Promise<void>

---

unlock()

unlock(): Promise<void>

Returns

Promise<void>