Files
JiboOs/docs/services/events/GlobalEvents.js
2026-03-16 13:53:01 +02:00

129 lines
4.0 KiB
JavaScript

/**
* Set of names of all events that globalEvents currently has
* subscribed handlers for
* @name jibo.globalEvents#eventsWithHandlers
* @type {Set<string>}
*/
/**
* Received any global event
* @name jibo.globalEvents#global
* @type {TypedEvent<jibo.globalEvents#GlobalEventData>}
*/
/**
* Global voice stop command received
* @name jibo.globalEvents#voiceStop
* @type {jibo.globalEvents.GlobalEvent<jibo.jetstream.types.ListenResult>}
*/
/**
* Received global help command
* @name jibo.globalEvents#help
* @type {jibo.globalEvents.GlobalEvent<jibo.jetstream.types.ListenResult>}
*/
/**
* Received global sleep command
* @name jibo.globalEvents#sleep
* @type {jibo.globalEvents.GlobalEvent<jibo.jetstream.types.ListenResult>}
*/
/**
* Received global pause command
* @name jibo.globalEvents#pause
* @type {jibo.globalEvents.GlobalEvent<jibo.jetstream.types.ListenResult>}
*/
/**
* Received global volume command
* @name jibo.globalEvents#volume
* @type {jibo.globalEvents.GlobalEvent<jibo.jetstream.types.ListenResult>}
*/
/**
* Received global whatCanIDo
* @name jibo.globalEvents#whatCanIDo
* @type {jibo.globalEvents.GlobalEvent<jibo.jetstream.types.ListenResult>}
*/
/**
* Received global holdOn
* @name jibo.globalEvents#holdOn
* @type {jibo.globalEvents.GlobalEvent<jibo.jetstream.types.ListenResult>}
*/
/**
* Received global overHere
* @name jibo.globalEvents#overHere
* @type {jibo.globalEvents.GlobalEvent<jibo.jetstream.types.ListenResult>}
*/
/**
* Received global skill launch
* @name jibo.globalEvents#skillLaunch
* @type {Event<jibo.jetstream.types.ListenResult>}
*/
/**
* Received global skill relaunch
* @name jibo.globalEvents#skillRelaunch
* @type {Event<jibo.jetstream.types.ListenResult>}
*/
/**
* Received global touchStop event.
* WARNING: this refers to the global `touchStop` event, which is
* otherwise used to stop Jibo. If you want to listen for the
* touch event but NOT clobber the stop behavior, please
* refer to {@link jibo.system.SystemEvents#touchOn}.
* @name jibo.globalEvents#touchStop
* @type {jibo.globalEvents.GlobalEvent<boolean[]>}
*/
/**
* Global events that are shared - anyone can listen and not interfere with other listeners.
* @name jibo.globalEvents#shared
* @type {jibo.globalEvents.shared}
*/
/**
* Announce to the skills service manager (SSM) if we can handle a specific global command.
* @param {string} action Global action for the SSM to recognize.
* @param {boolean} canHandle `true` if the `jibo` module can handle the global comand.
* @method jibo.globalEvents#announceGlobalHandler
*/
/**
* We got a message from WS
* @param {any} data Data from websocket message.
* @method jibo.globalEvents~onMessage
* @private
*/
/**
* We got a message from WS
* @param {WSResponse} data Data from websocket message.
* @method jibo.globalEvents~onGlobal
* @private
*/
/**
* Called when ws with message 'skill-relaunch' is received.
* @param {any} data JSON Data received from websocket.
* @method jibo.globalEvents#onSkillRelaunch
* @private
*/
/**
* Called when ws with message 'skill-launch' is received.
* @param {any} data JSON Data received from websocket.
* @method jibo.globalEvents#onSkillRelaunch
* @private
*/
/**
* Initialize the touch listener.
* @method jibo.globalEvents~_initializeTouchListener
* @private
*/