Confluence.js - Cloud and Server API library
    Preparing search index...

    Interface GetContentComments

    interface GetContentComments {
        depth?: string;
        expand?: string[];
        id: string;
        limit?: number;
        location?: string[];
        parentVersion?: number;
        start?: number;
    }
    Index

    Properties

    depth? expand? id limit? location? parentVersion? start?

    Properties

    depth?: string

    Currently, this parameter is not used. Comments are returned at the root level only.

    expand?: string[]

    A multi-value parameter indicating which properties of the content to expand.

    id: string

    The ID of the content to be queried for its comments.

    limit?: number

    The maximum number of comments to return per page. Note, this may be restricted by fixed system limits.

    location?: string[]

    The location of the comments in the page. Multiple locations can be specified. If no location is specified, comments from all locations are returned.

    parentVersion?: number

    The version of the parent content to retrieve children for. Currently, this only works for the latest version.

    start?: number

    The starting index of the returned comments.

    Settings

    Member Visibility

    On This Page

    Properties