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

/**
 * @module API
 * @submodule API Modalities
 * @namespace api.modalities
 */
namespace internal.api.modalities {
    /**
     * Base class for all modality classes
     * @class ModalityObject
     */
    export abstract class ModalityObject {
        /**
         * Type of modality. A value from {{#crossLink "api.modalities.Modality"}}{{/crossLink}}
         * @property {string} type
         */
        public readonly type: string;

        constructor(responseModality: any, type?: string) {
            let modalityType = responseModality.Name || <any>type;
            if (!modalityType) {
                throw new Error("Unable to create modality object due to missing 'type'");
            }
            this.type = modalityType.toLowerCase();
        }
    }
}