Interface CopyPageRequest

interface CopyPageRequest {
    body?: {
        editor2?: ContentBodyCreate;
        storage?: ContentBodyCreate;
    } & {
        [key: string]: unknown;
    };
    copyAttachments?: boolean;
    copyCustomContents?: boolean;
    copyLabels?: boolean;
    copyPermissions?: boolean;
    copyProperties?: boolean;
    destination: CopyPageRequestDestination;
    pageTitle?: string;
}

Hierarchy

  • Record<string, unknown>
    • CopyPageRequest

Properties

body? copyAttachments? copyCustomContents? copyLabels? copyPermissions? copyProperties? destination pageTitle?

Properties

Optionalbody

body?: {
    editor2?: ContentBodyCreate;
    storage?: ContentBodyCreate;
} & {
    [key: string]: unknown;
}

If defined, this will replace the body of the destination page.

Type declaration

  • Optionaleditor2?: ContentBodyCreate

    This object is used when creating or updating content.

  • Optionalstorage?: ContentBodyCreate

    This object is used when creating or updating content.

OptionalcopyAttachments

copyAttachments?: boolean

If set to true, attachments are copied to the destination page.

OptionalcopyCustomContents

copyCustomContents?: boolean

If set to true, custom contents are copied to the destination page.

OptionalcopyLabels

copyLabels?: boolean

If set to true, labels are copied to the destination page.

OptionalcopyPermissions

copyPermissions?: boolean

If set to true, page permissions are copied to the destination page.

OptionalcopyProperties

copyProperties?: boolean

If set to true, content properties are copied to the destination page.

destination

destination: CopyPageRequestDestination

Defines where the page will be copied to, and can be one of the following types.

  • parent_page: page will be copied as a child of the specified parent page
  • parent_content: page will be copied as a child of the specified parent content
  • space: page will be copied to the specified space as a root page on the space
  • existing_page: page will be copied and replace the specified page

OptionalpageTitle

pageTitle?: string

If defined, this will replace the title of the destination page.

Settings

Member Visibility

On This Page

Properties