Interface UsernoteInit

Details about a newly created usernote

interface UsernoteInit {
    contextPermalink?: string;
    moderatorUsername?: string;
    noteType?: string;
    text: string;
    timestamp?: Date;
    username: string;
}

Hierarchy (View Summary)

Properties

contextPermalink? moderatorUsername? noteType? text timestamp? username

Properties

OptionalcontextPermalink

contextPermalink?: string

Permalink to the item the note was left in response to

OptionalmoderatorUsername

moderatorUsername?: string

The username of the moderator who left the note, defaulting to the app user

OptionalnoteType

noteType?: string

The key of the note type of this note. To get information about corresponding note type (its label text and color information), get the subreddit's Toolbox configuration in a SubredditConfig instance,then pass this value to SubredditConfig.getNoteType.

Example: Get the color and text of a note type from the key:

const toolbox = new ToolboxClient(reddit);
const subreddit = 'mildlyinteresting';

// Acquire a note somehow
const usernotes = toolbox.getUsernotes(subreddit);
const note = usernotes.get('eritbh')[0];

// Look up information about the type of this note
const subConfig = toolbox.getConfig(subreddit);
const {color, text} = subConfig.getNoteType(note.noteType);

text

text: string

The text of the note

Optionaltimestamp

timestamp?: Date

The date and time the note was left, defaulting to the current time

username

username: string

The name of the user this note is attached to

Settings

Member Visibility

On This Page

Properties