@viewdo/dxp-story-cli/dist/app/models/configuration/PreviewConfiguration.d.ts

DXP Story Management CLI

import { OrganizationConfiguration } from "./OrganizationConfiguration";
import { IConfiguration } from "./support/IConfiguration";
import { StoryConfiguration } from "./StoryConfiguration";
/**
 * DXP PREVIEW CONFIG:
 * -----------------------------------------------------
 * This file defines configurable experience settings while previewing this story.
 *
 */
export declare class PreviewConfiguration implements IConfiguration {
    static file_name: string;
    /**
     * DXP model-type (read-only)
     */
    readonly kind: string;
    /**
     * API version, model location (read-only)
     */
    readonly apiVersion: string;
    /**
     * The pretend key for this model in the DXP platform
     * @pattern ^[A-Za-z0-9-$]{1,16}$
     */
    key: string;
    /**
     * This is the data that will be used while previewing this experience.
     *
     *
     */
    data: Record<string, any>;
    /**
     * The user model, if we need to preview user data rendering.
     */
    user?: Record<string, any>;
    /**
     * To see an experience after a milestone has already been reached.
     */
    milestone?: string;
    /**
     * You can add pre-fired events here, to see how the experience can look different after fired.
     */
    events?: string[];
    progress?: string | 'New' | 'Sent' | 'Opened' | 'Started' | 'Completed' | 'Converted';
    /** @ignore */
    currentEpisodeKey?: string;
    /**
     * Change the child-entity type here to render specific entities.
     */
    childEntityKey?: string;
    /** @ignore */
    story: any;
    /** @ignore */
    organization: any;
    setup(story_config: StoryConfiguration, org_config: OrganizationConfiguration): PreviewConfiguration;
    private _getDefaultInputValue;
}