API Docs for: 2.0.20133.2
Show:

File: src\internal\ui\assistedSupportPlugin\config.ts

/// <reference path="../uiConfig.ts" /> 

/** 
 * @module UI 
 * @submodule UI Assisted Support Plugin
 * @namespace ui.assistedSupportPlugin
 */
namespace internal.ui.assistedSupportPlugin {
    /**
     * Configuration for Assisted Support Plugin component
     * @class Config
     * @extends ui.UIConfig
     */
    export interface Config extends UIConfig {
        /**
         * Url of the plugin to invoke
         * @property {string} pluginUrl
         */
        pluginUrl: string;

        /**
         * Puid of the logged in user
         * @property {string} puid
         */
        puid?: string;

        /**
         * Locale of the experience
         * @property {string} locale
         */
        locale: string;

        /**
         * Assisted Support product code selected by the user
         * @property {string} product
         */
        product: string;

        /**
         * Assisted Support issue code selected by the user
         * @property {string} issue
         */
        issue: string;

        /**
         * Fired when plugin flow is completed by user
         * @event onCompleted
         */
        onCompleted: EventListener;

        /**
         * Fired when plugin flow is cancelled by user
         * @event onCancelled
         */
        onCancelled?: EventListener;
    }
}