Class VoteableControlsAbstract

The base controls for all content that you can vote on.

Hierarchy (view full)

Methods

approve blockAuthor delete disableInboxReplies downvote edit enableInboxReplies gild ignoreFutureReports namespace remove reply report save unignoreFutureReports unsave unvote upvote

Methods

approve

  • approve(id): Promise<void>

  • Approve an item.

    Parameters

    • id: string

      The ID of the item to approve.

    Returns Promise<void>

    A promise that resolves when the item has been approved.

    Note

    This requires the authenticated user to be a moderator of the subreddit with the posts permission.

blockAuthor

  • blockAuthor(id): Promise<void>

  • Block the author of an item.

    Parameters

    • id: string

      The ID of the item to block the author of.

    Returns Promise<void>

    A promise that resolves when the request is complete.

    Note

    Apparently this only works if the item is in modmail or the user's inbox, and if it's not the request silently succeeds anyway.

delete

  • delete(id): Promise<void>

  • Delete an item.

    Parameters

    • id: string

      The ID of the item to delete.

    Returns Promise<void>

    A promise that resolves when the item has been deleted.

disableInboxReplies

  • disableInboxReplies(id): Promise<void>

  • Disable inbox replies for an item.

    Parameters

    • id: string

      The id of the item.

    Returns Promise<void>

    A promise that resolves when replies have been disabled.

downvote

  • downvote(id): Promise<void>

  • Cast a downvote.

    Parameters

    • id: string

      The ID of the item to downvote.

    Returns Promise<void>

    A promise that resolves when the vote has been cast.

edit

  • edit(id, newText): Promise<void>

  • Edit an item.

    Parameters

    • id: string

      The ID of the item to edit.

    • newText: string

      The new text to use.

    Returns Promise<void>

    A promise that resolves when the edit is complete.

enableInboxReplies

  • enableInboxReplies(id): Promise<void>

  • Enable inbox replies for an item.

    Parameters

    • id: string

      The id of the item.

    Returns Promise<void>

    A promise that resolves when replies have been enabled.

gild

  • gild(id): Promise<void>

  • Give Reddit gold to the author of an item.

    Parameters

    • id: string

      The ID of the item to gild.

    Returns Promise<void>

    A promise that resolves when the item has been gilded.

ignoreFutureReports

  • ignoreFutureReports(id): Promise<void>

  • Ignore any future reports of an item.

    Parameters

    • id: string

      The ID of the item to ignore reports for.

    Returns Promise<void>

    A promise that resolves when the setting has been changed.

    Note

    This requires the authenticated user to be a moderator of the subreddit with the posts permission.

namespace

remove

  • remove(id, spam?): Promise<void>

  • Remove an item, optionally marking it as spam.

    Parameters

    • id: string

      The ID of the item to remove.

    • spam: boolean = false

      Whether or not to mark this item as spam. Defaults to false.

    Returns Promise<void>

    A promise that resolves when the item has been removed.

    Note

    This requires the authenticated user to be a moderator of the subreddit with the posts permission.

reply

  • reply(id, text): Promise<Comment>

  • Reply to an item.

    Parameters

    • id: string

      The ID of the item to reply to.

    • text: string

      The text content of the reply to post.

    Returns Promise<Comment>

    A promise that resolves to the comment reply.

report

  • report(id, reason?): Promise<void>

  • Report an item to the mods.

    The report will be anonymous if you are not a mod of the subreddit. If you are a mod the report will be tied to your username.

    Parameters

    • id: string

      The ID of the item to report.

    • Optional reason: string

      The reason you are reporting the item.

    Returns Promise<void>

    A promise that resolves when the item has been reported.

save

  • save(id): Promise<void>

  • Save an item.

    This will make the item show up at reddit.com/saved.

    Parameters

    • id: string

      The ID of the item to save.

    Returns Promise<void>

    a promise that resolves when the item has been saved.

unignoreFutureReports

  • unignoreFutureReports(id): Promise<void>

  • Unignore any future reports of an item.

    Parameters

    • id: string

      The ID of the item to unignore reports for.

    Returns Promise<void>

    A promise that resolves when the setting has been changed.

    Note

    This requires the authenticated user to be a moderator of the subreddit with the posts permission.

unsave

  • unsave(id): Promise<void>

  • Unsave an item.

    This will make the item no longer show up at reddit.com/saved.

    Parameters

    • id: string

      The ID of the item to unsave.

    Returns Promise<void>

    a promise that resolves when the item has been unsaved.

unvote

  • unvote(id): Promise<void>

  • Remove your vote.

    Parameters

    • id: string

      The ID of the item to unvote.

    Returns Promise<void>

    A promise that resolves when the vote has been removed.

upvote

  • upvote(id): Promise<void>

  • Cast an upvote.

    Parameters

    • id: string

      The ID of the item to upvote.

    Returns Promise<void>

    A promise that resolves when the vote has been cast.

Settings

Member Visibility

Theme

On This Page

approveblockAuthordeletedisableInboxRepliesdownvoteeditenableInboxRepliesgildignoreFutureReportsnamespaceremovereplyreportsaveunignoreFutureReportsunsaveunvoteupvote

Generated using TypeDoc