Source: sessionHandler/sessionHandler.js

  1. /**
  2.  * @author Sloan Seaman 
  3.  * @copyright 2016 and on
  4.  * @version .1
  5.  * @license https://www.apache.org/licenses/LICENSE-2.0 Apache License 2.0
  6.  */
  8. /**
  9.  * Interface for classes that can handle can act as a session handler
  10.  *
  11.  * @interface SessionHandler
  12.  */
  14. /**
  15.  * Returns the name of the SessionHandler.  If not set, SkillVC will attempt to determine one for you and add the function
  16.  * to your object
  17.  *
  18.  * @function
  19.  * @name  SessionHandler.getName
  20.  * @return {String} The name of the SessionHandler
  21.  */
  23. /**
  24.  * Returns the order location in which the session handlers should be called.
  25.  *
  26.  * If not defined, the order will be assumed to be the order in which it was loaded
  27.  *
  28.  * @function
  29.  * @name  SessionHandler#getOrder
  30.  * @return {Number} The place in execution order (index) of the session handler.
  31.  */
  33. /**
  34.  * Called when a session is started. 
  35.  *
  36.  * A SessionHandler should implement either sessionStart or sessionEnd, it does not need to implement both.
  37.  * If the SessionHandler has any async operations a `Promise` should be returned to SkillVC so that it will wait until 
  38.  * execution of the async operation has completed
  39.  * 
  40.  * @function
  41.  * @name  SessionHandler#sessionStart
  42.  * @param {Object} event The event for the skill (from lambda)
  43.  * @param {OBject} context The context for the skill (from lambda)
  44.  * @param {SVContext} svContext The context of the execution
  45.  * @returns {Promise} The optional `Promise` that can be used to wait until this completes
  46.  */
  48. /**
  49.  * Called when a session has ended
  50.  *
  51.  * A essionHandler should implement either sessionStart or sessionEnd, it does not need to implement both.
  52.  * If the SessionHandler has any async operations a `Promise` should be returned to SkillVC so that it will wait until 
  53.  * execution of the async operation has completed
  54.  * 
  55.  * @function
  56.  * @name  SessionHandler#sessionEnd
  57.  * @param {Object} event The event for the skill (from lambda)
  58.  * @param {OBject} context The context for the skill (from lambda)
  59.  * @param {SVContext} svContext The context of the execution
  60.  * @returns {Promise} The optional `Promise` that can be used to wait until this completes
  61.  */