Class APIFeedback

The feedback board - ideas and private requests, votes, follows (replaces Fider at feedback.noti.bot).

── WHO SEES WHAT ────────────────────────────────────────────────────────── Reads work logged out: pass auth ONLY when the user is logged in. With a session the server answers for that user (premium-only boards, their own hidden posts, staff view) and marks the response private, no-store; without one it answers the public view and lets it be cached. Never cache a logged-in response on the page side as if it were public.

Behind the feedback launch flag: while it is hidden for the caller every method 404s. A post the viewer may not see is 404 too, never 403 - do not show "forbidden", show "not found".

── REFUSALS ─────────────────────────────────────────────────────────────── A refused write is { status, error: { code } }, code from FeedbackErrorCode. voteRefusal / commentRefusal on a post's viewer tell you up front why the buttons are off (banned, new account, archived board, locked post), so the page can say so instead of letting the click fail.

── TEXT ─────────────────────────────────────────────────────────────────── title is plain text. body is MARKDOWN, stored raw: render it with an allowlist (no raw HTML, images only from Noti's own host, links rel="nofollow ugc noopener"). The server does not sanitise HTML for you.

Constructors

constructor

new APIFeedback(web): APIFeedback
Parameters
- web: WebDataManager
Returns APIFeedback
- Defined in src/classes/feedback.ts:27

Methods

createFeedbackComment

createFeedbackComment(__namedParameters): Promise<WebResponse<FeedbackThread>>
Comment, or reply with parentId (a top-level comment only). uploadIds from createFeedbackUpload. 10/minute. Returns the thread.
Parameters
- __namedParameters: {
      auth: string;
      comment: {
          body: string;
          parentId?: string;
          uploadIds?: string[];
      };
      number: number;
  }
  - auth: string
  - comment: {
        body: string;
        parentId?: string;
        uploadIds?: string[];
    }
    - body: string
    - OptionalparentId?: string
    - OptionaluploadIds?: string[]
  - number: number
Returns Promise<WebResponse<FeedbackThread>>
- Defined in src/classes/feedback.ts:163

createFeedbackCommentReaction

createFeedbackCommentReaction(__namedParameters): Promise<WebResponse<{
reactions: FeedbackReactions;
}>>
Parameters
- __namedParameters: {
      auth: string;
      commentId: string;
      kind:
          | "heart"
          | "thumbsUp"
          | "thumbsDown"
          | "fire";
  }
  - auth: string
  - commentId: string
  - kind:
        | "heart"
        | "thumbsUp"
        | "thumbsDown"
        | "fire"
Returns Promise<WebResponse<{
reactions: FeedbackReactions;
}>>
- Defined in src/classes/feedback.ts:203

createFeedbackFollow

createFeedbackFollow(__namedParameters): Promise<WebResponse<FeedbackPostView>>
Follow: get notified when it changes status, ships, or gets an official answer.
Parameters
- __namedParameters: {
  auth: string;
  number: number;
  }
  - auth: string
  - number: number
Returns Promise<WebResponse<FeedbackPostView>>
- Defined in src/classes/feedback.ts:116

createFeedbackNotificationReads

createFeedbackNotificationReads(__namedParameters): Promise<WebResponse<{
read: number;
}>>
Mark notifications read: the given ids, or all of them when omitted.
Parameters
- __namedParameters: {
  auth: string;
  ids?: string[];
  }
  - auth: string
  - Optionalids?: string[]
Returns Promise<WebResponse<{
read: number;
}>>
- Defined in src/classes/feedback.ts:279

createFeedbackPost

createFeedbackPost(__namedParameters): Promise<WebResponse<FeedbackPostView>>
Post an idea / request. The author votes and follows it automatically. 5 per hour. uploadIds from createFeedbackUpload.
Parameters
- __namedParameters: {
      auth: string;
      post: {
          boardId: string;
          body?: string;
          tagIds?: string[];
          title: string;
          uploadIds?: string[];
      };
  }
  - auth: string
  - post: {
        boardId: string;
        body?: string;
        tagIds?: string[];
        title: string;
        uploadIds?: string[];
    }
    - boardId: string
    - Optionalbody?: string
    - OptionaltagIds?: string[]
    - title: string
    - OptionaluploadIds?: string[]
Returns Promise<WebResponse<FeedbackPostView>>
- Defined in src/classes/feedback.ts:75

createFeedbackPostReaction

createFeedbackPostReaction(__namedParameters): Promise<WebResponse<{
reactions: FeedbackReactions;
}>>
React to a post. Answers the post's reactions. reactions_off (404) when the switch is off.
Parameters
- __namedParameters: {
      auth: string;
      kind:
          | "heart"
          | "thumbsUp"
          | "thumbsDown"
          | "fire";
      number: number;
  }
  - auth: string
  - kind:
        | "heart"
        | "thumbsUp"
        | "thumbsDown"
        | "fire"
  - number: number
Returns Promise<WebResponse<{
reactions: FeedbackReactions;
}>>
- Defined in src/classes/feedback.ts:189

createFeedbackUpload

createFeedbackUpload(__namedParameters): Promise<WebResponse<FeedbackUpload>>
Upload one image (field image: png, jpeg, webp or gif, up to 8 MB). It comes back as webp, at most 2000px, with its metadata (GPS, camera) removed. Put url in the markdown as ![alt](url) and send uploadId in uploadIds when saving the post or comment; unattached uploads are deleted after 24h. 20 per day. Refusals: uploads_off, image_too_large, unsupported_image, invalid_image, upload_quota.
Parameters
- __namedParameters: {
  auth: string;
  formData: FormData;
  }
  - auth: string
  - formData: FormData
Returns Promise<WebResponse<FeedbackUpload>>
- Defined in src/classes/feedback.ts:223

createFeedbackVote

createFeedbackVote(__namedParameters): Promise<WebResponse<FeedbackPostView>>
Vote. Voting also follows the post, unless the user unfollowed it before. 30 per minute.
Parameters
- __namedParameters: {
  auth: string;
  number: number;
  }
  - auth: string
  - number: number
Returns Promise<WebResponse<FeedbackPostView>>
- Defined in src/classes/feedback.ts:101

deleteFeedbackComment

deleteFeedbackComment(__namedParameters): Promise<WebResponse<FeedbackThread>>
Delete your own comment (its replies stay). Returns the thread.
Parameters
- __namedParameters: {
  auth: string;
  commentId: string;
  }
  - auth: string
  - commentId: string
Returns Promise<WebResponse<FeedbackThread>>
- Defined in src/classes/feedback.ts:181

deleteFeedbackCommentReaction

deleteFeedbackCommentReaction(__namedParameters): Promise<WebResponse<{
reactions: FeedbackReactions;
}>>
Parameters
- __namedParameters: {
      auth: string;
      commentId: string;
      kind:
          | "heart"
          | "thumbsUp"
          | "thumbsDown"
          | "fire";
  }
  - auth: string
  - commentId: string
  - kind:
        | "heart"
        | "thumbsUp"
        | "thumbsDown"
        | "fire"
Returns Promise<WebResponse<{
reactions: FeedbackReactions;
}>>
- Defined in src/classes/feedback.ts:210

deleteFeedbackFollow

deleteFeedbackFollow(__namedParameters): Promise<WebResponse<FeedbackPostView>>
Unfollow. Sticks: voting again later does not re-follow.
Parameters
- __namedParameters: {
  auth: string;
  number: number;
  }
  - auth: string
  - number: number
Returns Promise<WebResponse<FeedbackPostView>>
- Defined in src/classes/feedback.ts:124

deleteFeedbackPost

deleteFeedbackPost(__namedParameters): Promise<WebResponse<{
deleted: true;
}>>
Delete your own post - only while nobody else has voted on it (ask_staff otherwise).
Parameters
- __namedParameters: {
  auth: string;
  number: number;
  }
  - auth: string
  - number: number
Returns Promise<WebResponse<{
deleted: true;
}>>
- Defined in src/classes/feedback.ts:93

deleteFeedbackPostReaction

deleteFeedbackPostReaction(__namedParameters): Promise<WebResponse<{
reactions: FeedbackReactions;
}>>
Parameters
- __namedParameters: {
      auth: string;
      kind:
          | "heart"
          | "thumbsUp"
          | "thumbsDown"
          | "fire";
      number: number;
  }
  - auth: string
  - kind:
        | "heart"
        | "thumbsUp"
        | "thumbsDown"
        | "fire"
  - number: number
Returns Promise<WebResponse<{
reactions: FeedbackReactions;
}>>
- Defined in src/classes/feedback.ts:196

deleteFeedbackVote

deleteFeedbackVote(__namedParameters): Promise<WebResponse<FeedbackPostView>>
Parameters
- __namedParameters: {
  auth: string;
  number: number;
  }
  - auth: string
  - number: number
Returns Promise<WebResponse<FeedbackPostView>>
- Defined in src/classes/feedback.ts:108

getFeedbackBoards

getFeedbackBoards(__namedParameters?): Promise<WebResponse<{
boards: FeedbackBoard[];
}>>
Boards the viewer may see, with visible-post counts per status.
Parameters
- __namedParameters: {
  auth?: string;
  } = {}
  - Optionalauth?: string
Returns Promise<WebResponse<{
boards: FeedbackBoard[];
}>>
- Defined in src/classes/feedback.ts:30

getFeedbackCommentRevisions

getFeedbackCommentRevisions(__namedParameters): Promise<WebResponse<{
revisions: FeedbackRevision[];
}>>
A comment's edit history, as getFeedbackPostRevisions (no title). A deleted comment's history is staff only.
Parameters
- __namedParameters: {
  auth?: string;
  commentId: string;
  }
  - Optionalauth?: string
  - commentId: string
Returns Promise<WebResponse<{
revisions: FeedbackRevision[];
}>>
- Defined in src/classes/feedback.ts:155

getFeedbackComments

getFeedbackComments(__namedParameters): Promise<WebResponse<FeedbackThread>>
The thread: the official staff answer first, then comments oldest first with their replies (one level). Staff notes (internal) only reach staff. A deleted comment shows as deleted: true with no body while it still has replies.
Parameters
- __namedParameters: {
  auth?: string;
  number: number;
  }
  - Optionalauth?: string
  - number: number
Returns Promise<WebResponse<FeedbackThread>>
- Defined in src/classes/feedback.ts:136

getFeedbackFeatured

getFeedbackFeatured(__namedParameters?): Promise<WebResponse<{
    posts: {
        post: FeedbackPost & {
            commentCount: number;
        };
        viewer: {
            following: boolean;
            voted: boolean;
        };
    }[];
}>>
Posts staff featured for the top of the feedback page (up to 10, in their order).
Parameters
- __namedParameters: {
  auth?: string;
  } = {}
  - Optionalauth?: string
Returns Promise<WebResponse<{
    posts: {
        post: FeedbackPost & {
            commentCount: number;
        };
        viewer: {
            following: boolean;
            voted: boolean;
        };
    }[];
}>>
- Defined in src/classes/feedback.ts:252

getFeedbackNotificationCount

getFeedbackNotificationCount(__namedParameters): Promise<WebResponse<{
capped: boolean;
unread: number;
}>>
The bell's number. Counts up to 100 (capped then true - show "99+").
Parameters
- __namedParameters: {
  auth: string;
  }
  - auth: string
Returns Promise<WebResponse<{
capped: boolean;
unread: number;
}>>
- Defined in src/classes/feedback.ts:271

getFeedbackNotifications

getFeedbackNotifications(__namedParameters): Promise<WebResponse<FeedbackNotificationList>>
The inbox (the bell): newest first. Visibility is checked when you read it, so a post that has gone private is simply not there. Page with before = the previous page's next.
Parameters
- __namedParameters: {
      auth: string;
      before?: string;
      limit?: number;
  }
  - auth: string
  - Optionalbefore?: string
  - Optionallimit?: number
Returns Promise<WebResponse<FeedbackNotificationList>>
- Defined in src/classes/feedback.ts:263

getFeedbackPost

getFeedbackPost(__namedParameters): Promise<WebResponse<FeedbackPostView>>
One post. A merged post answers { post: null, viewer: null, mergedInto }: send the user to mergedInto (its old number keeps working this way).
Parameters
- __namedParameters: {
  auth?: string;
  number: number;
  }
  - Optionalauth?: string
  - number: number
Returns Promise<WebResponse<FeedbackPostView>>
- Defined in src/classes/feedback.ts:67

getFeedbackPostRevisions

getFeedbackPostRevisions(__namedParameters): Promise<WebResponse<{
revisions: FeedbackRevision[];
}>>
A post's edit history ("View history"): newest first, the current version included, at most 50. Same visibility as the post (404 otherwise). After a staff / developer edit, non-staff see that version and later ones only.
Parameters
- __namedParameters: {
  auth?: string;
  number: number;
  }
  - Optionalauth?: string
  - number: number
Returns Promise<WebResponse<{
revisions: FeedbackRevision[];
}>>
- Defined in src/classes/feedback.ts:147

getFeedbackPosts

getFeedbackPosts(__namedParameters?): Promise<WebResponse<FeedbackPostList>>
The list. board / tag take a slug or id; sort is top (default, pinned first inside a board), new or trending (votes in the last 14 days). limit up to 50. Searching logged out is rate limited.
Parameters
- __namedParameters: {
      auth?: string;
      board?: string;
      limit?: number;
      offset?: number;
      q?: string;
      sort?: FeedbackSort;
      status?:
          | "done"
          | "open"
          | "underReview"
          | "planned"
          | "inProgress"
          | "declined";
      tag?: string;
  } = {}
  - Optionalauth?: string
  - Optionalboard?: string
  - Optionallimit?: number
  - Optionaloffset?: number
  - Optionalq?: string
  - Optionalsort?: FeedbackSort
  - Optionalstatus?:
        | "done"
        | "open"
        | "underReview"
        | "planned"
        | "inProgress"
        | "declined"
  - Optionaltag?: string
Returns Promise<WebResponse<FeedbackPostList>>
- Defined in src/classes/feedback.ts:48

getFeedbackRoadmap

getFeedbackRoadmap(__namedParameters?): Promise<WebResponse<FeedbackRoadmap>>
The roadmap: planned, in progress, and shipped in the last 30 days (older ones are on the timeline).
Parameters
- __namedParameters: {
  auth?: string;
  } = {}
  - Optionalauth?: string
Returns Promise<WebResponse<FeedbackRoadmap>>
- Defined in src/classes/feedback.ts:236

getFeedbackSettings

getFeedbackSettings(__namedParameters): Promise<WebResponse<FeedbackSettings>>
DM settings. dmBlocked: Discord refused a DM (closed DMs) - switching DMs on again clears it. dmsAvailable false = DMs are off for everyone.
Parameters
- __namedParameters: {
  auth: string;
  }
  - auth: string
Returns Promise<WebResponse<FeedbackSettings>>
- Defined in src/classes/feedback.ts:288

getFeedbackTags

getFeedbackTags(__namedParameters?): Promise<WebResponse<{
tags: FeedbackTag[];
}>>
Parameters
- __namedParameters: {
  auth?: string;
  } = {}
  - Optionalauth?: string
Returns Promise<WebResponse<{
tags: FeedbackTag[];
}>>
- Defined in src/classes/feedback.ts:37

getFeedbackTimeline

getFeedbackTimeline(__namedParameters?): Promise<WebResponse<FeedbackTimeline>>
Shipped posts, newest first, each with the public changelog entry it shipped in (if staff linked one).
Parameters
- __namedParameters: {
      auth?: string;
      limit?: number;
      offset?: number;
  } = {}
  - Optionalauth?: string
  - Optionallimit?: number
  - Optionaloffset?: number
Returns Promise<WebResponse<FeedbackTimeline>>
- Defined in src/classes/feedback.ts:244

getMyFeedback

getMyFeedback(__namedParameters): Promise<WebResponse<{
    following: FeedbackPost[];
    posts: FeedbackPost[];
    voted: FeedbackPost[];
}>>
The "my feedback" page: my posts, what I voted on, what I follow (100 each, newest first).
Parameters
- __namedParameters: {
  auth: string;
  }
  - auth: string
Returns Promise<WebResponse<{
    following: FeedbackPost[];
    posts: FeedbackPost[];
    voted: FeedbackPost[];
}>>
- Defined in src/classes/feedback.ts:305

getMyFeedbackKlipyId

getMyFeedbackKlipyId(__namedParameters): Promise<WebResponse<{
customerId: string;
}>>
My KLIPY customer_id for the GIF picker: stable per user, not the Discord id. The dashboard calls KLIPY itself (their terms: API requests come from the user's browser) and sends this on search, trending and share.
Parameters
- __namedParameters: {
  auth: string;
  }
  - auth: string
Returns Promise<WebResponse<{
customerId: string;
}>>
- Defined in src/classes/feedback.ts:316

getSimilarFeedbackPosts

getSimilarFeedbackPosts(__namedParameters): Promise<WebResponse<{
posts: FeedbackSimilarPost[];
}>>
Up to 5 visible posts whose titles look like q - the "is this already asked?" hint while typing a title.
Parameters
- __namedParameters: {
  auth?: string;
  q: string;
  }
  - Optionalauth?: string
  - q: string
Returns Promise<WebResponse<{
posts: FeedbackSimilarPost[];
}>>
- Defined in src/classes/feedback.ts:56

updateFeedbackComment

updateFeedbackComment(__namedParameters): Promise<WebResponse<FeedbackThread>>
Edit your own comment. Returns the thread.
Parameters
- __namedParameters: {
      auth: string;
      body: string;
      commentId: string;
  }
  - auth: string
  - body: string
  - commentId: string
Returns Promise<WebResponse<FeedbackThread>>
- Defined in src/classes/feedback.ts:172

updateFeedbackPost

updateFeedbackPost(__namedParameters): Promise<WebResponse<FeedbackPostView>>
Edit your own post. Only while it is open / under review and has 10 or fewer votes (viewer.canEdit).
Parameters
- __namedParameters: {
      auth: string;
      number: number;
      post: {
          body?: string;
          tagIds?: string[];
          title?: string;
          uploadIds?: string[];
      };
  }
  - auth: string
  - number: number
  - post: {
        body?: string;
        tagIds?: string[];
        title?: string;
        uploadIds?: string[];
    }
    - Optionalbody?: string
    - OptionaltagIds?: string[]
    - Optionaltitle?: string
    - OptionaluploadIds?: string[]
Returns Promise<WebResponse<FeedbackPostView>>
- Defined in src/classes/feedback.ts:84

updateFeedbackSettings

updateFeedbackSettings(__namedParameters): Promise<WebResponse<FeedbackSettings>>
Turn the update digest DM on or off (off by default; at most one DM per 15 minutes, 10 a day).
Parameters
- __namedParameters: {
  auth: string;
  dmEnabled: boolean;
  }
  - auth: string
  - dmEnabled: boolean
Returns Promise<WebResponse<FeedbackSettings>>
- Defined in src/classes/feedback.ts:296

Class APIFeedback

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns APIFeedback

Methods

createFeedbackComment

Parameters

auth: string

comment: { body: string; parentId?: string; uploadIds?: string[]; }

body: string

OptionalparentId?: string

OptionaluploadIds?: string[]

number: number

Returns Promise<WebResponse<FeedbackThread>>

createFeedbackCommentReaction

Parameters

auth: string

commentId: string

kind: | "heart" | "thumbsUp" | "thumbsDown" | "fire"

Returns Promise<WebResponse<{ reactions: FeedbackReactions; }>>

createFeedbackFollow

Parameters

auth: string

number: number

Returns Promise<WebResponse<FeedbackPostView>>

createFeedbackNotificationReads

Parameters

auth: string

Optionalids?: string[]

Returns Promise<WebResponse<{ read: number; }>>

createFeedbackPost

Parameters

auth: string

post: { boardId: string; body?: string; tagIds?: string[]; title: string; uploadIds?: string[]; }

boardId: string

Optionalbody?: string

OptionaltagIds?: string[]

title: string

OptionaluploadIds?: string[]

Returns Promise<WebResponse<FeedbackPostView>>

createFeedbackPostReaction

Parameters

auth: string

kind: | "heart" | "thumbsUp" | "thumbsDown" | "fire"

number: number

Returns Promise<WebResponse<{ reactions: FeedbackReactions; }>>

createFeedbackUpload

Parameters

auth: string

formData: FormData

Returns Promise<WebResponse<FeedbackUpload>>

createFeedbackVote

Parameters

auth: string

number: number

Returns Promise<WebResponse<FeedbackPostView>>

deleteFeedbackComment

Parameters

auth: string

commentId: string

Returns Promise<WebResponse<FeedbackThread>>

deleteFeedbackCommentReaction

Parameters

auth: string

commentId: string

kind: | "heart" | "thumbsUp" | "thumbsDown" | "fire"

Returns Promise<WebResponse<{ reactions: FeedbackReactions; }>>

deleteFeedbackFollow

Parameters

auth: string

number: number

Returns Promise<WebResponse<FeedbackPostView>>

deleteFeedbackPost

Parameters

auth: string

number: number

comment: {
body: string;
parentId?: string;
uploadIds?: string[];
}

`Optional`parentId?: string

`Optional`uploadIds?: string[]

kind:
| "heart"
| "thumbsUp"
| "thumbsDown"
| "fire"

Returns Promise<WebResponse<{
reactions: FeedbackReactions;
}>>

`Optional`ids?: string[]

Returns Promise<WebResponse<{
read: number;
}>>

post: {
boardId: string;
body?: string;
tagIds?: string[];
title: string;
uploadIds?: string[];
}

`Optional`body?: string

`Optional`tagIds?: string[]

`Optional`uploadIds?: string[]

kind:
| "heart"
| "thumbsUp"
| "thumbsDown"
| "fire"

Returns Promise<WebResponse<{
reactions: FeedbackReactions;
}>>

kind:
| "heart"
| "thumbsUp"
| "thumbsDown"
| "fire"

Returns Promise<WebResponse<{
reactions: FeedbackReactions;
}>>

Returns Promise<WebResponse<{
deleted: true;
}>>

kind:
| "heart"
| "thumbsUp"
| "thumbsDown"
| "fire"

Returns Promise<WebResponse<{
reactions: FeedbackReactions;
}>>

`Optional`auth?: string

Returns Promise<WebResponse<{
boards: FeedbackBoard[];
}>>

`Optional`auth?: string

Returns Promise<WebResponse<{
revisions: FeedbackRevision[];
}>>

`Optional`auth?: string

`Optional`auth?: string

Returns Promise<WebResponse<{
posts: {
post: FeedbackPost & {
commentCount: number;
};
viewer: {
following: boolean;
voted: boolean;
};
}[];
}>>

Returns Promise<WebResponse<{
capped: boolean;
unread: number;
}>>

`Optional`before?: string

`Optional`limit?: number

`Optional`auth?: string

`Optional`auth?: string

Returns Promise<WebResponse<{
revisions: FeedbackRevision[];
}>>

`Optional`auth?: string

`Optional`board?: string

`Optional`limit?: number

`Optional`offset?: number

`Optional`q?: string

`Optional`sort?: FeedbackSort

`Optional`status?:
| "done"
| "open"
| "underReview"
| "planned"
| "inProgress"
| "declined"

`Optional`tag?: string

`Optional`auth?: string