Interface Content

Base object for all content types.

interface Content {
    _expandable?: {
        ancestors?: string;
        body?: string;
        children?: string;
        childTypes?: string;
        container?: string;
        descendants?: string;
        extensions?: string;
        history?: string;
        macroRenderedOutput?: string;
        metadata?: string;
        operations?: string;
        restrictions?: string;
        schedulePublishDate?: string;
        schedulePublishInfo?: string;
        space?: string;
        version?: string;
    } & {
        [key: string]: unknown;
    };
    _links?: GenericLinks;
    ancestors?: null | (null | Content)[];
    body?: {
        _expandable?: {
            anonymous_export_view?: string;
            atlas_doc_format?: string;
            dynamic?: string;
            editor?: string;
            editor2?: string;
            export_view?: string;
            raw?: string;
            storage?: string;
            styled_view?: string;
            view?: string;
            wiki?: string;
        } & {
            [key: string]: unknown;
        };
        anonymous_export_view?: ContentBody;
        atlas_doc_format?: ContentBody;
        dynamic?: ContentBody;
        editor?: ContentBody;
        editor2?: ContentBody;
        export_view?: ContentBody;
        raw?: ContentBody;
        storage?: ContentBody;
        styled_view?: ContentBody;
        view?: ContentBody;
        wiki?: ContentBody;
    } & {
        [key: string]: unknown;
    };
    children?: ContentChildren;
    childTypes?: ContentChildType;
    container?: null | Container;
    descendants?: ContentChildren;
    extensions?: {
        [key: string]: unknown;
    };
    history?: null | ContentHistory;
    id?: string;
    macroRenderedOutput?: {
        [key: string]: {
            [key: string]: unknown;
        };
    };
    metadata?: ContentMetadata;
    operations?: OperationCheckResult[];
    restrictions?: {
        _expandable?: {
            read?: string;
            update?: string;
        } & {
            [key: string]: unknown;
        };
        _links?: GenericLinks;
        read?: ContentRestriction;
        update?: ContentRestriction;
    } & {
        [key: string]: unknown;
    };
    space?: null | Space;
    status: string;
    title?: string;
    type: string;
    version?: null | VersionV1;
}

Hierarchy

  • Record<string, unknown>
    • Content

Properties

_expandable? _links? ancestors? body? children? childTypes? container? descendants? extensions? history? id? macroRenderedOutput? metadata? operations? restrictions? space? status title? type version?

Properties

Optional_expandable

_expandable?: {
    ancestors?: string;
    body?: string;
    children?: string;
    childTypes?: string;
    container?: string;
    descendants?: string;
    extensions?: string;
    history?: string;
    macroRenderedOutput?: string;
    metadata?: string;
    operations?: string;
    restrictions?: string;
    schedulePublishDate?: string;
    schedulePublishInfo?: string;
    space?: string;
    version?: string;
} & {
    [key: string]: unknown;
}

Optional_links

_links?: GenericLinks

Optionalancestors

ancestors?: null | (null | Content)[]

Optionalbody

body?: {
    _expandable?: {
        anonymous_export_view?: string;
        atlas_doc_format?: string;
        dynamic?: string;
        editor?: string;
        editor2?: string;
        export_view?: string;
        raw?: string;
        storage?: string;
        styled_view?: string;
        view?: string;
        wiki?: string;
    } & {
        [key: string]: unknown;
    };
    anonymous_export_view?: ContentBody;
    atlas_doc_format?: ContentBody;
    dynamic?: ContentBody;
    editor?: ContentBody;
    editor2?: ContentBody;
    export_view?: ContentBody;
    raw?: ContentBody;
    storage?: ContentBody;
    styled_view?: ContentBody;
    view?: ContentBody;
    wiki?: ContentBody;
} & {
    [key: string]: unknown;
}

Optionalchildren

children?: ContentChildren

OptionalchildTypes

childTypes?: ContentChildType

Shows whether a piece of content has attachments, comments, or child pages/whiteboards. Note, this doesn't actually contain the child objects.

Optionalcontainer

container?: null | Container

Container for content. This can be either a space (containing a page or blogpost) or a page/blog post (containing an attachment or comment)

Optionaldescendants

descendants?: ContentChildren

Optionalextensions

extensions?: {
    [key: string]: unknown;
}

Optionalhistory

history?: null | ContentHistory

Optionalid

id?: string

OptionalmacroRenderedOutput

macroRenderedOutput?: {
    [key: string]: {
        [key: string]: unknown;
    };
}

Optionalmetadata

metadata?: ContentMetadata

Metadata object for page, blogpost, comment content

Optionaloperations

operations?: OperationCheckResult[]

Optionalrestrictions

restrictions?: {
    _expandable?: {
        read?: string;
        update?: string;
    } & {
        [key: string]: unknown;
    };
    _links?: GenericLinks;
    read?: ContentRestriction;
    update?: ContentRestriction;
} & {
    [key: string]: unknown;
}

Optionalspace

space?: null | Space

status

status: string

Optionaltitle

title?: string

type

type: string

Can be "page", "blogpost", "attachment" or "content"

Optionalversion

version?: null | VersionV1

Settings

Member Visibility

On This Page

Properties