nodes/generated

Interface ConfluenceNodeParameters

Source


interface ConfluenceNodeParameters {
    bodyAdf?: string;
    bodyFormat?:
        | "atlas_doc_format"
        | "plainText"
        | "storage";
    bodyPlainText?: string;
    bodyStorage?: string;
    includeDescendants?: boolean;
    maxPages?: number;
    operation?: "create"
    | "get";
    options?: {
        createAsDraft?: boolean;
        private?: boolean;
        rootLevel?: boolean;
    };
    page?: {
        mode: "id"
        | "list"
        | "url"
        | "title";
        value: string;
    };
    parentPage?: {
        mode: "id"
        | "list"
        | "url";
        value: string;
    };
    resource?: "page";
    space?: { mode: "id"
    | "list"; value: string };
    title?: string;
}

Properties§

§readonly bodyAdf?: string

Page content as an Atlassian Document Format document

§readonly bodyFormat?: "atlas_doc_format" | "plainText" | "storage"

How the page content below is interpreted Default: "plainText"

§readonly bodyPlainText?: string

Page content as plain text; each line becomes a paragraph. Blank lines and leading whitespace are removed. Type options: {"rows":4}

§readonly bodyStorage?: string

Page content in Confluence storage format Type options: {"rows":4}

§readonly includeDescendants?: boolean

Whether to also fetch every descendant page of the page, one item per page

§readonly maxPages?: number

Safeguard that stops the sub-tree walk after this many pages, root included Default: 100 Type options: {"minValue":1}

§readonly operation?: "create" | "get"

Default: "create"

§readonly options?: { ... }

Default: {}

§readonly page?: { ... }

The page to fetch Default: {"mode":"list","value":""} Type options: {"loadOptionsDependsOn":["space.value"]}

§readonly parentPage?: { ... }

The page to create the new page under. Leave empty to create under the space homepage. Default: {"mode":"list","value":""} Type options: {"loadOptionsDependsOn":["space.value"]}

§readonly resource?: "page"

Default: "page"

§readonly space?: { ... }

The space to create the page in Default: {"mode":"list","value":""}

§readonly title?: string

The title of the new page