Interface GetContentComments

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

Properties

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

Properties

Optional depth

depth?: string

(optional, default: "") the depth of the comments. Possible values are: "" (ROOT only), "all"

Optional expand

expand?: string

A comma separated list of properties to expand on the children. We can also specify some extensions such as extensions.inlineProperties (for getting inline comment-specific properties) or extensions.resolution for the resolution status of each comment in the results

id

id: string | number

Optional limit

limit?: number

(optional, default: site limit) how many items should be returned after the start index

Optional location

location?: string

(optional, default: "" means all) the location of the comments. Possible values are: "inline", "footer", "resolved". You can define multiple location params. The results will be the comments matched by any location.

Optional parentVersion

parentVersion?: number

An int representing the version of the content to retrieve children for

Optional start

start?: number

(optional, default: 0) the index of the first item within the result set that should be returned

Settings

Member Visibility

Theme

On This Page

depthexpandidlimitlocationparentVersionstart

Generated using TypeDoc v0.25.12