Files
JiboOs/docs/bt/mim/MimRepeatManager.js
2026-03-16 13:53:01 +02:00

46 lines
1.5 KiB
JavaScript

/**
* Define how an individual repeat request should be handled.
* @class MimRepeat
* @memberof jibo.mim
* @private
*/
/**
* Prepend prompt to whatever Jibo repeats. Play alone if it's the last repeat allowed.
* @name jibo.mim.MimRepeat#result
* @type {String}
* @readOnly
*/
/**
* Take specified action after prompt is played. If 'cached', use exact prompt played when Mim
* was entered. If 'verbose', play verbose prompt or fall back to cached prompt. If 'exit', do
* not play a prompt & quit skill.
* @name jibo.mim.MimRepeat#result
* @type {String}
* @readOnly
*/
/**
* Manage how Mim repeat requests are handled.
* Instantiate this class to start loading the Announcement Mims to use when Jibo is asked to repeat
* himself.
* @class MimRepeatManager
* @memberof jibo.mim
* @private
*/
/**
* Maximum number of repeats allowed before before skill should exit.
* @name jibo.mim.MimRepeatManager#maxRepeat
* @type {Number}
* @readOnly
*/
/**
* Starts loading the default list SFX, for use by lists and Mim GUIs.
* @method jibo.mim.MimRepeatManager~getRepeat
* @param {String} mimType The type of the current Mim (question, announcement, optional-response).
* @param {Number} repeatCount The number of times that the user has requested a repeat (starting at 1 for the first time).
* @returns {jibo.mim.MimRepeat} Information on how to handle the repeat request.
*/