Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Functions

createCommentBoardBan

  • description

    Ban a user to restrict access in a comment board

    async
    since

    2.39.0

    example
     createCommentBoardBan({
    profileId: '<profile_id>',
    commentBoardId: '<comment_board_id>',
    description: '<Reason for banning>',
    }).then((commentBoardBan) => console.log(commentBoardBan));
    ``

    Parameters

    Returns Promise<ICommentBoardBan>

deleteCommentBoardBan

  • description

    Delete comment board ban resource

    async
    since

    2.39.0

    example
     deleteCommentBoardBan({
    commentBoardBanId: '<comment_board_ban_id>',
    })
    ``

    Parameters

    Returns Promise<null>

getCommentBoardBan

  • description

    Get comment board ban resource from commentBoardBanId

    async
    since

    2.39.0

    example
     getCommentBoardBan({
    commentBoardBanId: '<comment_board_ban_id>',
    })
    ``

    Parameters

    Returns Promise<ICommentBoardBan>

getCommentBoardBans

  • description

    Get a list of comment board bans in the Application. Each comment board ban resource represents restrictive access to comment board for a given user profile.

    async
    since

    2.39.0

    example
     getCommentBoardBans({
    profileId: '<profile_id>',
    commentBoardId: '<comment_board_id>',
    }).then((padinatedResponse) => console.log(padinatedResponse));
    ``

    Parameters

    Returns Promise<IPaginatedResponse<ICommentBoardBan>>

Legend

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

Generated using TypeDoc