API Docs for: 2.0.20133.2
Show:

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

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

/**
 * @module API
 * @submodule API Modalities
 * @namespace api.modalities
 */
namespace internal.api.modalities {
    /**
     * Class representing a response from the modalities api
     * @class ModalitiesResponse
     */
    export class ModalitiesResponse {
        /**
         * An array of modality objects
         * @property {object[]} modalities
         */
        public readonly modalities: Array<ModalityObject>;

        /**
         * An object that contains additional rendering context
         * @property {object} renderingContext
         */
        public readonly renderingContext: RenderingContext;

        constructor(modalities: Array<ModalityObject>, renderingContext?: RenderingContext) {
            this.modalities = modalities;
            this.renderingContext = renderingContext;
        }
    }
}