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

/**
* @module API
* @submodule API Modalities
* @namespace api.modalities
*/
namespace internal.api.modalities {
    /**
     * Interface for Modality Api Request Content
     * @class ModalityRequestContent
     */
    export class ModalityRequestContent {
        /**
         * Product name
         * @property {string} product
         */
        public product: string;

        /**
         * Issue type
         * @property {string} issue
         */
        public issue: string;

        /**
         * Partner Id
         * @property {string} partnerId
         */
        public partnerId: string;

        /**
         * Platform
         * @property {string} platform
         */
        public platform: string;

        /**
         * Requested language
         * @property {string} language
         */
        public language: string;

        /**
         * Requested country
         * @property {string} country
         */
        public country: string;

        /**
         * Accessibility queue. Default is {{#crossLink "api.modalities.Accessibility.NONE"}}{{/crossLink}}
         * @property {string} accessibility
         */
        public accessibility: string;

        /**
         * Requesting mode. Default is "live".
         * @property {string} mode
         */
        public mode: string;

        /**
         * Request modalities that are in the preview state. Default is false.
         * @property {string} preview
         */
        public preview: boolean;

        /**
         * A (property bag) context object used for enhanced routing
         * @property {Object} context
         */
        public context: Object;

        constructor(product: string, issue: string, partnerId: string, platform: string, language: string, country: string, accessibility?: string, preview?: boolean, mode?: string, context?: Object) {
            this.product = product;
            this.issue = issue;
            this.partnerId = partnerId;
            this.platform = platform || Platform.WEB;
            this.language = language;
            this.country = country;
            this.accessibility = accessibility || Accessibility.NONE;
            this.mode = mode || undefined;
            this.preview = preview;
            this.context = context || undefined;
        }
    }
}