API Docs for: 2.0.20133.2
Show:

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

/// <reference path="linkModality.ts" />
/// <reference path="common.ts" />

/**
 * @module API
 * @submodule API Modalities
 * @namespace api.modalities
 */
namespace internal.api.modalities {
    /**
     * @class ChatModality
     * @extends api.modalities.LinkModality
     */
    export class ChatModality extends LinkModality {
        /**
         * Link to hours of operations schedule
         * @property {string} hoopsLink
         */
        public readonly hoopsLink: string;

        /**
         * Get number of people currently in queue
         * @method getQueueLength
         * @return { Promise | Number } A promise that resolves to the number of people currently in queue
         */
        public readonly getQueueLength: () => JQueryPromise<number>;

        /**
         * Get status of the chat
         * @method getAvailability
         * @return { Promise | string } A promise that resolves to a value in {{#crossLink "api.modalities.Availability"}}{{/crossLink}}
         */
        public readonly getAvailability: () => JQueryPromise<string>;

        constructor(responseModality: any) {
            super(responseModality, Modality.CHAT);
            if (!responseModality.HoopsLink ||
                !responseModality.OpenNowLink ||
                !responseModality.QueueLength) {
                throw Error("Unable to create ChatModality");
            } 
            this.hoopsLink = responseModality.HoopsLink;
            this.getQueueLength = getQueueLengthCallback(responseModality);
            this.getAvailability = getAvailabilityCallback(responseModality);
        }
    }
}