Interface AsyncContentBody

interface AsyncContentBody {
    _expandable?: {
        content?: string;
        embeddedContent?: string;
        mediaToken?: string;
        webresource?: string;
    } & {
        [key: string]: unknown;
    };
    _links?: GenericLinks;
    embeddedContent?: EmbeddedContent[];
    error?: string;
    mediaToken?: {
        collectionIds?: string[];
        contentId?: string;
        expiryDateTime?: string;
        fileIds?: string[];
        token?: string;
    } & {
        [key: string]: unknown;
    };
    renderTaskId?: string;
    representation?:
        | "view"
        | "storage"
        | "export_view"
        | "styled_view"
        | "editor"
        | "editor2"
        | "anonymous_export_view"
        | "wiki"
        | "atlas_doc_format";
    status?:
        | "WORKING"
        | "QUEUED"
        | "FAILED"
        | "COMPLETED"
        | "RERUNNING";
    value?: string;
    webresource?: WebResourceDependencies;
}

Hierarchy

  • Record<string, unknown>
    • AsyncContentBody

Properties

_expandable? _links? embeddedContent? error? mediaToken? renderTaskId? representation? status? value? webresource?

Properties

Optional_expandable

_expandable?: {
    content?: string;
    embeddedContent?: string;
    mediaToken?: string;
    webresource?: string;
} & {
    [key: string]: unknown;
}

Optional_links

_links?: GenericLinks

OptionalembeddedContent

embeddedContent?: EmbeddedContent[]

Optionalerror

error?: string

OptionalmediaToken

mediaToken?: {
    collectionIds?: string[];
    contentId?: string;
    expiryDateTime?: string;
    fileIds?: string[];
    token?: string;
} & {
    [key: string]: unknown;
}

OptionalrenderTaskId

renderTaskId?: string

Optionalrepresentation

representation?:
    | "view"
    | "storage"
    | "export_view"
    | "styled_view"
    | "editor"
    | "editor2"
    | "anonymous_export_view"
    | "wiki"
    | "atlas_doc_format"

Optionalstatus

status?:
    | "WORKING"
    | "QUEUED"
    | "FAILED"
    | "COMPLETED"
    | "RERUNNING"

Rerunning is reserved for when the job is working, but there is a previous run's value in the cache. You may choose to continue polling, or use the cached value.

Optionalvalue

value?: string

Optionalwebresource

webresource?: WebResourceDependencies

Settings

Member Visibility

On This Page

Properties