Class: ModNote
Table of contents
Properties
Methods
Properties
createdAt
• createdAt: Date
id
• id: string
modAction
• Optional modAction: ModAction
operator
• operator: Object
Type declaration
| Name | Type |
|---|---|
id? | `t2_${string}` |
name? | string |
subreddit
• subreddit: Object
Type declaration
| Name | Type |
|---|---|
id? | `t5_${string}` |
name? | string |
type
• type: ModNoteType
user
• user: Object
Type declaration
| Name | Type |
|---|---|
id? | `t2_${string}` |
name? | string |
userNote
• Optional userNote: UserNote
Methods
add
▸ Static add(options, metadata?): Promise<ModNote>
Parameters
| Name | Type |
|---|---|
options | Prettify<PostNotesRequest & { label: UserNoteLabel ; redditId: `t1_${string}` | `t3_${string}` }> |
metadata? | Metadata |
Returns
Promise<ModNote>
delete
▸ Static delete(options, metadata?): Promise<boolean>
Parameters
| Name | Type |
|---|---|
options | DeleteNotesRequest |
metadata? | Metadata |
Returns
Promise<boolean>
get
▸ Static get(options, metadata?): Listing<ModNote>
Parameters
| Name | Type |
|---|---|
options | Prettify<Pick<GetNotesRequest, "subreddit" | "user"> & { filter?: ModNoteType } & Pick<ListingFetchOptions, "before" | "limit">> |
metadata? | Metadata |