Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Functions

addComment

  • description

    Add comment to a comment board

    async
    since

    2.39.0

    example
     addComment({
    text: '<Your text comment>',
    customData:'<Your custom data to send with reply comment>',
    commentBoardId:'<Your comment board Id>'
    }).then(comment => console.log(comment));

    Parameters

    Returns Promise<IComment>

addCommentReply

  • description

    Add reply to comment

    async
    since

    2.39.0

    example
     addCommentReply({
    text: '<Your text comment>',
    customData: '<Your custom data to send with reply comment>',
    commentBoardId: '<Your comment board Id>',
    parentCommentId: '<Your parent comment Id>'
    }).then(comment => console.log(comment));

    Parameters

    Returns Promise<IComment>

deleteComment

  • description

    Delete a comment inside a commentboard

    async
    since

    2.39.0

    example
    deleteComment({
    commentBoardId: "<comment-board-id>",
    commentId: "<comment-id>"
    })

    Parameters

    Returns Promise<null>

editComment

  • description

    edit comment of a comment board

    async
    since

    2.39.0

    example
    editComment({
    commentBoardId: "<comment-board-id>",
    commentId: "<comment-id>",
    text: '<Your text comment>',
    customData: '<Your custom data to send with reply comment>',
    }).then(comment => console.log(comment))

    Parameters

    Returns Promise<IComment>

getComment

  • description

    Get comment details

    async
    since

    2.40.0

    example
    getComment({
    commentBoardId: "<comment-board-id>",
    commentId:"<comment-id>"})
    .then(({results}) => console.log(results))

    Parameters

    Returns Promise<IComment>

getCommentReplies

  • description

    List of comments replies

    async
    since

    2.40.0

    example
     getCommentReplies({
    commentBoardId:'<comment-board-id>',
    commentId:'<comment-id>',
    sorting: CommentSort.NEWEST,
    since:'2023-08-22T14:30:45.123Z'
    until:'2023-08-22T14:30:45.123Z'
    }).then(comments => console.log(comments));

    Parameters

    Returns Promise<IPaginatedResponse<IComment>>

getComments

  • description

    List comments with replies

    async
    since

    2.39.0

    example
     getComments({
    commentBoardId:'<comment-board-id>',
    sorting:'<Your comment sorting enum value>',
    repliedSince:'2023-12-19T15:28:46.493Z',
    repliedUntil:'2023-12-19T15:28:46.493Z'
    since:'2023-08-22T14:30:45.123Z'
    until:'2023-08-22T14:30:45.123Z'
    isReported: true,
    }).then(paginatedResponse => console.log(paginatedResponse));

    Parameters

    Returns Promise<IPaginatedResponse<IComment>>

Legend

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

Generated using TypeDoc