Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Functions

createCommentReport

  • description

    Report a comment

    async
    since

    2.40.0

    example
     createCommentReport({
    commentId: '<comment_id>',
    description: '<Reason for reporting>',
    }).then((commentReport) => console.log(commentReport));
    ``

    Parameters

    Returns Promise<ICommentReport>

deleteCommentReport

  • description

    Delete a comment report resource

    async
    since

    2.40.0

    example
     deleteCommentReport({
    commentReportId: '<comment_report_id>',
    })
    ``

    Parameters

    Returns Promise<null>

dismissAllCommentReports

  • description

    Dismiss all the reports associated with a specific comment. This updates the report_status of all such reports to 'dismissed'.

    async
    since

    2.40.0

    example
     dismissAllCommentReports({
    commentBoardId: '<comment_board_id>',
    commentId: '<comment_id>',
    })
    ``

    Parameters

    Returns Promise<IDismissAllCommentReportsResponse>

dismissCommentReport

  • description

    Dismiss a comment report. This updates the report_status to 'dismissed'.

    async
    since

    2.40.0

    example
     dismissCommentReport({
    commentReportId: '<comment_report_id>',
    }).then((commentReport) => console.log(commentReport));
    ``

    Parameters

    Returns Promise<ICommentReport>

getCommentReport

  • description

    Get a report submitted for a comment.

    async
    since

    2.40.0

    example
     getCommentReport({
    commentReportId: '<comment_report_id>',
    }).then((commentReport) => console.log(commentReport));
    ``

    Parameters

    Returns Promise<IPaginatedResponse<ICommentReport>>

getCommentReports

  • description

    Get a list of comment reports i.e. the reports submitted for a comment in an application.

    async
    since

    2.40.0

    example
     getCommentReports({
    commentBoardId: '<comment_board_id>',
    commentId: '<comment_id>',
    reportStatus: CommentReportStatus.PENDING,
    }).then((paginatedResponse) => console.log(paginatedResponse));
    ``

    Parameters

    Returns Promise<IPaginatedResponse<ICommentReport>>

Legend

  • Namespace
  • Variable
  • Function
  • Function with type parameter
  • Type alias
  • Interface
  • Interface with type parameter
  • Enumeration

Generated using TypeDoc