Interface CoreStates

Combined observable state exposed by the stateful core.

interface CoreStates {
    blockedEventStream: Observable<BlockedEvent | undefined>;
    canOptimize: Observable<boolean>;
    consent: Observable<boolean | undefined>;
    eventStream: Observable<
        | {
            channel: "mobile"
            | "server"
            | "web";
            context: {
                app?: { name: string; version: string };
                campaign: {
                    content?: string;
                    medium?: string;
                    name?: string;
                    source?: string;
                    term?: string;
                };
                gdpr: { isConsentGiven: boolean };
                library: { name: string; version: string };
                locale: string;
                location?: {
                    city?: string;
                    continent?: string;
                    coordinates?: { latitude: number; longitude: number };
                    country?: string;
                    countryCode?: string;
                    postalCode?: string;
                    region?: string;
                    regionCode?: string;
                    timezone?: string;
                };
                page?: {
                    path: string;
                    query: Record<string, string>;
                    referrer: string;
                    search: string;
                    title?: string;
                    url: string;
                    [key: string]: JSONType;
                };
                screen?: { name: string; [key: string]: JSONType };
                userAgent?: string;
            };
            messageId: string;
            originalTimestamp: string;
            sentAt: string;
            timestamp: string;
            type: "alias";
            userId?: string;
        }
        | {
            channel: "mobile"
            | "server"
            | "web";
            context: {
                app?: { name: string; version: string };
                campaign: {
                    content?: string;
                    medium?: string;
                    name?: string;
                    source?: string;
                    term?: string;
                };
                gdpr: { isConsentGiven: boolean };
                library: { name: string; version: string };
                locale: string;
                location?: {
                    city?: string;
                    continent?: string;
                    coordinates?: { latitude: number; longitude: number };
                    country?: string;
                    countryCode?: string;
                    postalCode?: string;
                    region?: string;
                    regionCode?: string;
                    timezone?: string;
                };
                page?: {
                    path: string;
                    query: Record<string, string>;
                    referrer: string;
                    search: string;
                    title?: string;
                    url: string;
                    [key: string]: JSONType;
                };
                screen?: { name: string; [key: string]: JSONType };
                userAgent?: string;
            };
            messageId: string;
            originalTimestamp: string;
            sentAt: string;
            timestamp: string;
            type: "group";
            userId?: string;
        }
        | {
            channel: "mobile"
            | "server"
            | "web";
            context: {
                app?: { name: string; version: string };
                campaign: {
                    content?: string;
                    medium?: string;
                    name?: string;
                    source?: string;
                    term?: string;
                };
                gdpr: { isConsentGiven: boolean };
                library: { name: string; version: string };
                locale: string;
                location?: {
                    city?: string;
                    continent?: string;
                    coordinates?: { latitude: number; longitude: number };
                    country?: string;
                    countryCode?: string;
                    postalCode?: string;
                    region?: string;
                    regionCode?: string;
                    timezone?: string;
                };
                page?: {
                    path: string;
                    query: Record<string, string>;
                    referrer: string;
                    search: string;
                    title?: string;
                    url: string;
                    [key: string]: JSONType;
                };
                screen?: { name: string; [key: string]: JSONType };
                userAgent?: string;
            };
            messageId: string;
            originalTimestamp: string;
            sentAt: string;
            timestamp: string;
            traits: Record<string, JSONType>;
            type: "identify";
            userId?: string;
        }
        | {
            channel: "mobile"
            | "server"
            | "web";
            context: {
                app?: { name: string; version: string };
                campaign: {
                    content?: string;
                    medium?: string;
                    name?: string;
                    source?: string;
                    term?: string;
                };
                gdpr: { isConsentGiven: boolean };
                library: { name: string; version: string };
                locale: string;
                location?: {
                    city?: string;
                    continent?: string;
                    coordinates?: { latitude: number; longitude: number };
                    country?: string;
                    countryCode?: string;
                    postalCode?: string;
                    region?: string;
                    regionCode?: string;
                    timezone?: string;
                };
                page: {
                    path: string;
                    query: Record<string, string>;
                    referrer: string;
                    search: string;
                    title?: string;
                    url: string;
                    [key: string]: JSONType;
                };
                userAgent?: string;
            };
            messageId: string;
            name?: string;
            originalTimestamp: string;
            properties: {
                path: string;
                query: Record<string, string>;
                referrer: string;
                search: string;
                title?: string;
                url: string;
                [key: string]: JSONType;
            };
            sentAt: string;
            timestamp: string;
            type: "page";
            userId?: string;
        }
        | {
            channel: "mobile"
            | "server"
            | "web";
            context: {
                app?: { name: string; version: string };
                campaign: {
                    content?: string;
                    medium?: string;
                    name?: string;
                    source?: string;
                    term?: string;
                };
                gdpr: { isConsentGiven: boolean };
                library: { name: string; version: string };
                locale: string;
                location?: {
                    city?: string;
                    continent?: string;
                    coordinates?: { latitude: number; longitude: number };
                    country?: string;
                    countryCode?: string;
                    postalCode?: string;
                    region?: string;
                    regionCode?: string;
                    timezone?: string;
                };
                screen: { name: string; [key: string]: JSONType };
                userAgent?: string;
            };
            messageId: string;
            name: string;
            originalTimestamp: string;
            properties?: Record<string, JSONType>;
            sentAt: string;
            timestamp: string;
            type: "screen";
            userId?: string;
        }
        | {
            channel: "mobile"
            | "server"
            | "web";
            context: {
                app?: { name: string; version: string };
                campaign: {
                    content?: string;
                    medium?: string;
                    name?: string;
                    source?: string;
                    term?: string;
                };
                gdpr: { isConsentGiven: boolean };
                library: { name: string; version: string };
                locale: string;
                location?: {
                    city?: string;
                    continent?: string;
                    coordinates?: { latitude: number; longitude: number };
                    country?: string;
                    countryCode?: string;
                    postalCode?: string;
                    region?: string;
                    regionCode?: string;
                    timezone?: string;
                };
                page?: {
                    path: string;
                    query: Record<string, string>;
                    referrer: string;
                    search: string;
                    title?: string;
                    url: string;
                    [key: string]: JSONType;
                };
                screen?: { name: string; [key: string]: JSONType };
                userAgent?: string;
            };
            event: string;
            messageId: string;
            originalTimestamp: string;
            properties: Record<string, JSONType>;
            sentAt: string;
            timestamp: string;
            type: "track";
            userId?: string;
        }
        | {
            channel: "mobile"
            | "server"
            | "web";
            componentId: string;
            componentType: "Entry" | "Variable";
            context: {
                app?: { name: string; version: string };
                campaign: {
                    content?: string;
                    medium?: string;
                    name?: string;
                    source?: string;
                    term?: string;
                };
                gdpr: { isConsentGiven: boolean };
                library: { name: string; version: string };
                locale: string;
                location?: {
                    city?: string;
                    continent?: string;
                    coordinates?: { latitude: number; longitude: number };
                    country?: string;
                    countryCode?: string;
                    postalCode?: string;
                    region?: string;
                    regionCode?: string;
                    timezone?: string;
                };
                page?: {
                    path: string;
                    query: Record<string, string>;
                    referrer: string;
                    search: string;
                    title?: string;
                    url: string;
                    [key: string]: JSONType;
                };
                screen?: { name: string; [key: string]: JSONType };
                userAgent?: string;
            };
            experienceId?: string;
            messageId: string;
            originalTimestamp: string;
            sentAt: string;
            timestamp: string;
            type: "component";
            userId?: string;
            variantIndex: number;
            viewDurationMs?: number;
            viewId?: string;
        }
        | {
            channel: "mobile"
            | "server"
            | "web";
            componentId: string;
            componentType: "Entry" | "Variable";
            context: {
                app?: { name: string; version: string };
                campaign: {
                    content?: string;
                    medium?: string;
                    name?: string;
                    source?: string;
                    term?: string;
                };
                gdpr: { isConsentGiven: boolean };
                library: { name: string; version: string };
                locale: string;
                location?: {
                    city?: string;
                    continent?: string;
                    coordinates?: { latitude: number; longitude: number };
                    country?: string;
                    countryCode?: string;
                    postalCode?: string;
                    region?: string;
                    regionCode?: string;
                    timezone?: string;
                };
                page?: {
                    path: string;
                    query: Record<string, string>;
                    referrer: string;
                    search: string;
                    title?: string;
                    url: string;
                    [key: string]: JSONType;
                };
                screen?: { name: string; [key: string]: JSONType };
                userAgent?: string;
            };
            experienceId?: string;
            messageId: string;
            originalTimestamp: string;
            sentAt: string;
            timestamp: string;
            type: "component_click";
            userId?: string;
            variantIndex: number;
        }
        | {
            channel: "mobile"
            | "server"
            | "web";
            componentId: string;
            componentType: "Entry" | "Variable";
            context: {
                app?: { name: string; version: string };
                campaign: {
                    content?: string;
                    medium?: string;
                    name?: string;
                    source?: string;
                    term?: string;
                };
                gdpr: { isConsentGiven: boolean };
                library: { name: string; version: string };
                locale: string;
                location?: {
                    city?: string;
                    continent?: string;
                    coordinates?: { latitude: number; longitude: number };
                    country?: string;
                    countryCode?: string;
                    postalCode?: string;
                    region?: string;
                    regionCode?: string;
                    timezone?: string;
                };
                page?: {
                    path: string;
                    query: Record<string, string>;
                    referrer: string;
                    search: string;
                    title?: string;
                    url: string;
                    [key: string]: JSONType;
                };
                screen?: { name: string; [key: string]: JSONType };
                userAgent?: string;
            };
            experienceId?: string;
            hoverDurationMs: number;
            hoverId: string;
            messageId: string;
            originalTimestamp: string;
            sentAt: string;
            timestamp: string;
            type: "component_hover";
            userId?: string;
            variantIndex: number;
        }
        | undefined,
    >;
    flag: (name: string) => Observable<unknown>;
    previewPanelAttached: Observable<boolean>;
    previewPanelOpen: Observable<boolean>;
    profile: Observable<
        | {
            audiences: string[];
            id: string;
            location: {
                city?: string;
                continent?: string;
                coordinates?: { latitude: number; longitude: number };
                country?: string;
                countryCode?: string;
                postalCode?: string;
                region?: string;
                regionCode?: string;
                timezone?: string;
            };
            random: number;
            session: {
                activeSessionLength: number;
                averageSessionLength: number;
                count: number;
                id: string;
                isReturningVisitor: boolean;
                landingPage: {
                    path: string;
                    query: Record<string, string>;
                    referrer: string;
                    search: string;
                    title?: string;
                    url: string;
                    [key: string]: JSONType;
                };
            };
            stableId: string;
            traits: Record<string, JSONType>;
        }
        | undefined,
    >;
    selectedOptimizations: Observable<
        | {
            experienceId: string;
            sticky?: boolean;
            variantIndex: number;
            variants: Record<string, string>;
        }[]
        | undefined,
    >;
}

Index

Properties

blockedEventStream canOptimize consent eventStream flag previewPanelAttached previewPanelOpen profile selectedOptimizations

Properties

blockedEventStream

blockedEventStream: Observable<BlockedEvent | undefined>

Stream of the most recent blocked event payload.

canOptimize

canOptimize: Observable<boolean>

Whether optimization data is currently available.

consent: Observable<boolean | undefined>

Current consent value (if any).

eventStream

eventStream: Observable<
    | {
        channel: "mobile"
        | "server"
        | "web";
        context: {
            app?: { name: string; version: string };
            campaign: {
                content?: string;
                medium?: string;
                name?: string;
                source?: string;
                term?: string;
            };
            gdpr: { isConsentGiven: boolean };
            library: { name: string; version: string };
            locale: string;
            location?: {
                city?: string;
                continent?: string;
                coordinates?: { latitude: number; longitude: number };
                country?: string;
                countryCode?: string;
                postalCode?: string;
                region?: string;
                regionCode?: string;
                timezone?: string;
            };
            page?: {
                path: string;
                query: Record<string, string>;
                referrer: string;
                search: string;
                title?: string;
                url: string;
                [key: string]: JSONType;
            };
            screen?: { name: string; [key: string]: JSONType };
            userAgent?: string;
        };
        messageId: string;
        originalTimestamp: string;
        sentAt: string;
        timestamp: string;
        type: "alias";
        userId?: string;
    }
    | {
        channel: "mobile"
        | "server"
        | "web";
        context: {
            app?: { name: string; version: string };
            campaign: {
                content?: string;
                medium?: string;
                name?: string;
                source?: string;
                term?: string;
            };
            gdpr: { isConsentGiven: boolean };
            library: { name: string; version: string };
            locale: string;
            location?: {
                city?: string;
                continent?: string;
                coordinates?: { latitude: number; longitude: number };
                country?: string;
                countryCode?: string;
                postalCode?: string;
                region?: string;
                regionCode?: string;
                timezone?: string;
            };
            page?: {
                path: string;
                query: Record<string, string>;
                referrer: string;
                search: string;
                title?: string;
                url: string;
                [key: string]: JSONType;
            };
            screen?: { name: string; [key: string]: JSONType };
            userAgent?: string;
        };
        messageId: string;
        originalTimestamp: string;
        sentAt: string;
        timestamp: string;
        type: "group";
        userId?: string;
    }
    | {
        channel: "mobile"
        | "server"
        | "web";
        context: {
            app?: { name: string; version: string };
            campaign: {
                content?: string;
                medium?: string;
                name?: string;
                source?: string;
                term?: string;
            };
            gdpr: { isConsentGiven: boolean };
            library: { name: string; version: string };
            locale: string;
            location?: {
                city?: string;
                continent?: string;
                coordinates?: { latitude: number; longitude: number };
                country?: string;
                countryCode?: string;
                postalCode?: string;
                region?: string;
                regionCode?: string;
                timezone?: string;
            };
            page?: {
                path: string;
                query: Record<string, string>;
                referrer: string;
                search: string;
                title?: string;
                url: string;
                [key: string]: JSONType;
            };
            screen?: { name: string; [key: string]: JSONType };
            userAgent?: string;
        };
        messageId: string;
        originalTimestamp: string;
        sentAt: string;
        timestamp: string;
        traits: Record<string, JSONType>;
        type: "identify";
        userId?: string;
    }
    | {
        channel: "mobile"
        | "server"
        | "web";
        context: {
            app?: { name: string; version: string };
            campaign: {
                content?: string;
                medium?: string;
                name?: string;
                source?: string;
                term?: string;
            };
            gdpr: { isConsentGiven: boolean };
            library: { name: string; version: string };
            locale: string;
            location?: {
                city?: string;
                continent?: string;
                coordinates?: { latitude: number; longitude: number };
                country?: string;
                countryCode?: string;
                postalCode?: string;
                region?: string;
                regionCode?: string;
                timezone?: string;
            };
            page: {
                path: string;
                query: Record<string, string>;
                referrer: string;
                search: string;
                title?: string;
                url: string;
                [key: string]: JSONType;
            };
            userAgent?: string;
        };
        messageId: string;
        name?: string;
        originalTimestamp: string;
        properties: {
            path: string;
            query: Record<string, string>;
            referrer: string;
            search: string;
            title?: string;
            url: string;
            [key: string]: JSONType;
        };
        sentAt: string;
        timestamp: string;
        type: "page";
        userId?: string;
    }
    | {
        channel: "mobile"
        | "server"
        | "web";
        context: {
            app?: { name: string; version: string };
            campaign: {
                content?: string;
                medium?: string;
                name?: string;
                source?: string;
                term?: string;
            };
            gdpr: { isConsentGiven: boolean };
            library: { name: string; version: string };
            locale: string;
            location?: {
                city?: string;
                continent?: string;
                coordinates?: { latitude: number; longitude: number };
                country?: string;
                countryCode?: string;
                postalCode?: string;
                region?: string;
                regionCode?: string;
                timezone?: string;
            };
            screen: { name: string; [key: string]: JSONType };
            userAgent?: string;
        };
        messageId: string;
        name: string;
        originalTimestamp: string;
        properties?: Record<string, JSONType>;
        sentAt: string;
        timestamp: string;
        type: "screen";
        userId?: string;
    }
    | {
        channel: "mobile"
        | "server"
        | "web";
        context: {
            app?: { name: string; version: string };
            campaign: {
                content?: string;
                medium?: string;
                name?: string;
                source?: string;
                term?: string;
            };
            gdpr: { isConsentGiven: boolean };
            library: { name: string; version: string };
            locale: string;
            location?: {
                city?: string;
                continent?: string;
                coordinates?: { latitude: number; longitude: number };
                country?: string;
                countryCode?: string;
                postalCode?: string;
                region?: string;
                regionCode?: string;
                timezone?: string;
            };
            page?: {
                path: string;
                query: Record<string, string>;
                referrer: string;
                search: string;
                title?: string;
                url: string;
                [key: string]: JSONType;
            };
            screen?: { name: string; [key: string]: JSONType };
            userAgent?: string;
        };
        event: string;
        messageId: string;
        originalTimestamp: string;
        properties: Record<string, JSONType>;
        sentAt: string;
        timestamp: string;
        type: "track";
        userId?: string;
    }
    | {
        channel: "mobile"
        | "server"
        | "web";
        componentId: string;
        componentType: "Entry" | "Variable";
        context: {
            app?: { name: string; version: string };
            campaign: {
                content?: string;
                medium?: string;
                name?: string;
                source?: string;
                term?: string;
            };
            gdpr: { isConsentGiven: boolean };
            library: { name: string; version: string };
            locale: string;
            location?: {
                city?: string;
                continent?: string;
                coordinates?: { latitude: number; longitude: number };
                country?: string;
                countryCode?: string;
                postalCode?: string;
                region?: string;
                regionCode?: string;
                timezone?: string;
            };
            page?: {
                path: string;
                query: Record<string, string>;
                referrer: string;
                search: string;
                title?: string;
                url: string;
                [key: string]: JSONType;
            };
            screen?: { name: string; [key: string]: JSONType };
            userAgent?: string;
        };
        experienceId?: string;
        messageId: string;
        originalTimestamp: string;
        sentAt: string;
        timestamp: string;
        type: "component";
        userId?: string;
        variantIndex: number;
        viewDurationMs?: number;
        viewId?: string;
    }
    | {
        channel: "mobile"
        | "server"
        | "web";
        componentId: string;
        componentType: "Entry" | "Variable";
        context: {
            app?: { name: string; version: string };
            campaign: {
                content?: string;
                medium?: string;
                name?: string;
                source?: string;
                term?: string;
            };
            gdpr: { isConsentGiven: boolean };
            library: { name: string; version: string };
            locale: string;
            location?: {
                city?: string;
                continent?: string;
                coordinates?: { latitude: number; longitude: number };
                country?: string;
                countryCode?: string;
                postalCode?: string;
                region?: string;
                regionCode?: string;
                timezone?: string;
            };
            page?: {
                path: string;
                query: Record<string, string>;
                referrer: string;
                search: string;
                title?: string;
                url: string;
                [key: string]: JSONType;
            };
            screen?: { name: string; [key: string]: JSONType };
            userAgent?: string;
        };
        experienceId?: string;
        messageId: string;
        originalTimestamp: string;
        sentAt: string;
        timestamp: string;
        type: "component_click";
        userId?: string;
        variantIndex: number;
    }
    | {
        channel: "mobile"
        | "server"
        | "web";
        componentId: string;
        componentType: "Entry" | "Variable";
        context: {
            app?: { name: string; version: string };
            campaign: {
                content?: string;
                medium?: string;
                name?: string;
                source?: string;
                term?: string;
            };
            gdpr: { isConsentGiven: boolean };
            library: { name: string; version: string };
            locale: string;
            location?: {
                city?: string;
                continent?: string;
                coordinates?: { latitude: number; longitude: number };
                country?: string;
                countryCode?: string;
                postalCode?: string;
                region?: string;
                regionCode?: string;
                timezone?: string;
            };
            page?: {
                path: string;
                query: Record<string, string>;
                referrer: string;
                search: string;
                title?: string;
                url: string;
                [key: string]: JSONType;
            };
            screen?: { name: string; [key: string]: JSONType };
            userAgent?: string;
        };
        experienceId?: string;
        hoverDurationMs: number;
        hoverId: string;
        messageId: string;
        originalTimestamp: string;
        sentAt: string;
        timestamp: string;
        type: "component_hover";
        userId?: string;
        variantIndex: number;
    }
    | undefined,
>

Stream of the most recent event emitted.

flag

flag: (name: string) => Observable<unknown>

Key-scoped observable for a single Custom Flag value.

previewPanelAttached

previewPanelAttached: Observable<boolean>

Whether the preview panel has been attached to the host runtime.

previewPanelOpen

previewPanelOpen: Observable<boolean>

Whether the preview panel is currently open in the host runtime.

profile

profile: Observable<
    | {
        audiences: string[];
        id: string;
        location: {
            city?: string;
            continent?: string;
            coordinates?: { latitude: number; longitude: number };
            country?: string;
            countryCode?: string;
            postalCode?: string;
            region?: string;
            regionCode?: string;
            timezone?: string;
        };
        random: number;
        session: {
            activeSessionLength: number;
            averageSessionLength: number;
            count: number;
            id: string;
            isReturningVisitor: boolean;
            landingPage: {
                path: string;
                query: Record<string, string>;
                referrer: string;
                search: string;
                title?: string;
                url: string;
                [key: string]: JSONType;
            };
        };
        stableId: string;
        traits: Record<string, JSONType>;
    }
    | undefined,
>

Live view of the current profile.

selectedOptimizations

selectedOptimizations: Observable<
    | {
        experienceId: string;
        sticky?: boolean;
        variantIndex: number;
        variants: Record<string, string>;
    }[]
    | undefined,
>

Live view of selected optimizations (variants).

Interface CoreStates

Index

Properties

Properties

blockedEventStream

canOptimize

eventStream

flag

previewPanelAttached

previewPanelOpen

profile

selectedOptimizations

Settings

On This Page