API Docs for: 2.0.20133.2
Show:

File: src\internal\api\modalities\constants.ts

/**
 * @module API
 * @submodule API Modalities
 * @namespace api.modalities
 */
namespace internal.api.modalities {
    /**
    * Enum api.modalities.Accessibility
    * @class Accessibility
    * @static
    */
    export namespace Accessibility {
        /**
         * @property {string} NONE
         * @default "none"
         */
        export const NONE = "none";
        /**
         * @property {string} ON
         * @default "on"
         */
        export const ON = "on";
    }

    /**
     * Enum api.modalities.Environment
     * @class Environment
     * @static 
     */
    export namespace Environment {
        /**
         * @property {string} DEV
         * @default "dev.support.services.microsoft.com"
         */

        /**
         * @property {string} STAGING
         * @default "staging.support.services.microsoft.com"
         */

        /**
         * @property {string} UAT
         * @default "support-uat.microsoft.com"
         */

        /**
         * @property {string} PRODUCTION
         * @default "partner.support.services.microsoft.com"
         */
    }

    /**
     * Enum api.modalities.Availability
     * @class Availability
     * @static
     */
    export namespace Availability {
        /**
         * @property {string} UNAVAILABLE
         * @default "unavailable"
         */
        export const UNAVAILABLE = "unavailable";
        /**
         * @property {string} OPEN
         * @default "open"
         */
        export const OPEN = "open";
        /**
         * @property {string} OUT_OF_HOURS
         * @default "out_of_hours"
         */
        export const OUT_OF_HOURS = "out_of_hours";
    };

    /**
     * Enum api.modalities.Modality
     * EXPECTATION IS THAT ALL MODALITY NAMES WILL BE STANDARDIZED ON LOWERCASE
     * @class Modality
     * @static
     */
    export namespace Modality {
        /**
         * @property {string} CHAT
         * @default "chat"
         */
        export const CHAT = "chat";
        /**
         * @property {string} CALLBACK
         * @default "callback"
         */
        export const CALLBACK = "callback";
        /**
         * @property {string} SCHEDULE_CALLBACK
         * @default "schedulecallback"
         */
        export const SCHEDULE_CALLBACK = "schedulecallback";
        /**
         * @property {string} TOLL_FREE
         * @default "tollfree"
         */
        export const TOLL_FREE = "tollfree";
        /**
         * @property {string} EMAIL
         * @default "email"
         */
        export const EMAIL = "email";
        /**
         * @property {string} COMMUNITY
         * @default "community"
         */
        export const COMMUNITY = "community";
        /**
         * @property {string} HELPSHIFT
         * @default "helpshift"
         * used for initial rave hoops setup
         * */
        export const HELPSHIFT = "helpshift";
        /**
         * @property {string} RAVECHATBOT
         * @default "rave-chat-bot"
         * used for rave VA chat integration - supports hoops
         * */
        export const RAVECHATBOT = "rave-chat-bot";
    }
}