@kadanza/extension-sdk
    Preparing search index...

    Interface ExtensionDetails

    Host context from handshake. Only set when the parent includes it.

    Field availability depends on where the iframe is mounted:

    • Experience Pages typically send spaceId and pageId.
    • Admin Console Pages typically omit those — there is no space page.

    Other identity fields are sent when the host knows them. Handshake does not require this object.

    interface ExtensionDetails {
        apiUrl?: string;
        baseUrl?: string;
        extensionId?: string;
        locale?: string;
        pageId?: string;
        spaceId?: string;
        tenantDomain?: string;
        tenantId?: string;
    }
    Index
    apiUrl?: string

    Platform API base URL the parent uses for its own API calls — the same string as the parent's HTTP client base URL. May be an origin or an origin plus a path. Older hosts omit it. Read via IExtensionSDK.getApiUrl.

    baseUrl?: string

    Base URL of the parent application.

    extensionId?: string
    locale?: string

    BCP 47 locale from the parent.

    pageId?: string

    Experience Page id. Omitted in Admin Console.

    spaceId?: string

    Space that owns the Experience Page. Omitted in Admin Console.

    tenantDomain?: string
    tenantId?: string