Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Functions

createCommentBoard

  • description

    Create comment board

    async
    since

    2.38.0

    example
     createCommentBoard({
    title: 'sd',
    customId:'postid1',
    repliesDepth:2,
    allowComments:true,
    description: 'desc',
    customData:'abc',
    contentFilter: 'filtered'
    }).then(commentBoard => console.log(commentBoard));
    ``

    Parameters

    Returns Promise<ICommentBoard>

deleteCommentBoard

  • description

    Delete a comment board

    async
    since

    2.38.0

    example
    deleteCommentBoard({
    commentBoardId: "aa7e03fc-01f0-4a98-a2e0-3fed689632d7",
    })

    Parameters

    Returns Promise<null>

getCommentBoardDetails

  • description

    Get comment board details

    async
    since

    2.38.0

    example
    getCommentBoardDetails({ commentBoardId: "aa7e03fc-01f0-4a98-a2e0-3fed689632d7"}).then(({results}) => console.log(results))
    

    Parameters

    Returns Promise<ICommentBoard>

getCommentBoards

  • description

    Get list of comment boards in an application

    async
    since

    2.38.0

    example
    getCommentBoards().then(({results}) => console.log(results))
    

    Returns Promise<IPaginatedResponse<ICommentBoard>>

updateCommentBoard

  • description

    Update comment board

    async
    since

    2.38.0

    example
    updateCommentBoard({
    commentBoardId: '5f5fea99-569b-42f3-875d-5b3943b64ba0',
    title: "title",
    customId: "postID431",
    repliesDepth: 1,
    allowComments: true,
    description: 'abc',
    customData: 'custom data',
    contentFilter: 'filtered'
    }).then(commentBoard => console.log(commentBoard))
    ``

    Parameters

    Returns Promise<ICommentBoard>

Legend

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

Generated using TypeDoc