Javascript Message - Revision history

Marian at 14:34, 27 January 2026

2026-01-27T14:34:36Z

Marian at 08:40, 10 September 2024

2024-09-10T08:40:09Z

Marian: /* Static Methods */

2024-09-04T06:00:03Z

‎Static Methods

Marian at 13:40, 3 September 2024

2024-09-03T13:40:37Z

Marian: /* Static Methods */

2024-09-03T09:45:12Z

‎Static Methods

Marian: /* Methods */

2024-09-03T09:44:35Z

‎Methods

Marian: /* Methods */

2024-09-03T09:43:12Z

‎Methods

Marian: /* Methods */

2024-09-03T09:42:51Z

‎Methods

Marian: /* Static Methods */

2024-09-03T09:40:07Z

‎Static Methods

Marian: /* Static Methods */

2024-09-03T09:31:48Z

‎Static Methods

@@ Line 2: / Line 2: @@
-Singleton functions (installSingleton,uninstallSingleton,handlersSingleton,installPostHookSingleton,posthooksSingleton) are not available in:
+Singleton functions (installSingleton,uninstallSingleton,handlersSingleton,installPostHookSingleton,posthooksSingleton/setSingletonData) are not available in:
 * Singleton contexts (when a singleton message is handled): handler or post hook<br/>
 * Temporary scripts (executed using the ''javascript eval'' command)<br/>
@@ Line 47: / Line 47: @@
-* '''Message.installSingleton(func,handlerContext,name[,priority[,filterName[,filterValue[,params]]])'''
+* '''Message.installSingleton(func,id,name[,priority[,filterName[,filterValue[,params]]])'''
 Install a Yate message handler.<br/>
 Callback function will be called using a separate script context (data) for each handled message.<br/>
-The context will be deleted after message handling returns.<br/>
+The context will be deleted after message handling returns if context reuse is disabled.<br/>
-Calling this function will replace an existing handler with the same ''handlerContext'' value regardless message name.<br>
+NOTE: A reused context is not changed from previous call. Its data will be the same with the following exceptions: message handlers will be uninstalled, events (timeout/interval) will be uninstalled, semaphores will signaled.<br/>
 Parameters:<br/>
 '''func''' - Function to be called when a message is received.<br/>
-'''handlerContext''' - Handler context (string). Wiil be passed as second parameter to callback function.<br/>
+'''id''' - Handler id (string). Will be passed as second parameter to callback function.<br/>
 '''name''' - Message name.<br/>
 '''priority''' - Message handler priority (integer). Must be at least 0. Defaults to 100 if not given.<br/>
@@ Line 62: / Line 63: @@
 Return: true on success, false on failure.
-Callback: '''function some_function_name(msg,handlerContext)'''<br>
+Callback: '''function some_function_name(msg,id,newScriptContext[,data])'''<br>
 Parameters:
 * '''msg''' - Message to handle.<br/>
-* '''handlerContext''' - Singleton context (string) set on install.<br/>
+* '''id''' - Singleton id (string) set on install.<br/>
 Handler parameters (set in '''params'''):
 * '''load_extensions''' - boolean. Load extensions (external, non native, objects) into script context.<br/>Not loading extensions may lead to a faster processing.<br/>Extensions are never loaded if message name matches ''script.init''.<br/>
@@ Line 76: / Line 84: @@
 Post hook handlers are called after a message is dispatched before returning to entity dispatching the message.<br/>
 Message object is read only (frozen), can't be changed, you can only read its parameters.<br/>
-Singleton: Callback function will be called using a separate script context (data) for each handled message. The context will be deleted after message handling returns.<br/>
+Singleton:
 The module maintains a single list of post hooks. Installing a post hook with a given id will replace an existing one (singleton or not).<br/>
@@ Line 88: / Line 99: @@
 Return: true on success, false on failure.
-Callback: '''function some_function_name(msg,handled,id)'''<br>
+Callback: '''function some_function_name(msg,handled,id,newScriptContext[,data])'''<br>
 Parameters:
 * '''msg''' - Message. Object is frozen.<br/>
 * '''handled''' - True if message was handled, false otherwise.<br/>
 * '''id''' - Post hook id (string) set in install.<br/>
 Post hook parameters (passed in '''params'''):
@@ Line 98: / Line 112: @@
 * '''engine.timer''' - boolean. Process ''engine.timer'' message.<br/>Default to false if ''filterMsg'' is set (assume engine.timer match is set there if desired).<br/>
 * '''handled''' - boolean. Callback function call based on message handled value (callback function will not be called if value of this parameter is not the same as meesage handled value).<br/>Default if missing or empty: always call the given callback.<br/>This parameter is ignored for broadcasted messages.<br/>

← Older revision		Revision as of 08:40, 10 September 2024
Line 288:		Line 288:
	Found value or '''null''' if cell given by row/column is not found or result set is empty<br/>		Found value or '''null''' if cell given by row/column is not found or result set is empty<br/>

−	~~== See also ==~~

−	* [[Javascript]]	+	[[Category:Javascript]]

@@ Line 57: / Line 57: @@
 '''name''' - Message name.<br/>
 '''priority''' - Message handler priority (integer). Must be at least 0. Defaults to 100 if not given.<br/>
-'''filterName''' - Message handler parameter filter name. May be a MatchingItem object containing message parameter(s) matching (''filterValue'' will be ignored).<br/>
+'''filterName''' - Message handler parameter filter name. May be a [[Javascript MatchingItem|MatchingItem]] object containing message parameter(s) matching (''filterValue'' will be ignored).<br/>
 '''filterValue''' - Message handler parameter filter value. Simple data (not object) or RegExp.<br/>
 '''params''' - Handler parameters (object).<br/>
@@ Line 82: / Line 82: @@
 '''func''' - Function to be called when a message is handled.<br/>
 '''id''' - Handler context (string). Will be passed as second parameter to callback function.<br/>
-'''filterMsg''' - Optional message name match. May be a string, RegExp or MatchingItem for complex match.<br/>
+'''filterMsg''' - Optional message name match. May be a string, RegExp or [[Javascript MatchingItem|MatchingItem]] object.<br/>
-'''filterName''' - Message parameter filter name. May be a MatchingItem object containing message parameter(s) matching (''filterValue'' will be ignored).<br/>
+'''filterName''' - Message parameter filter name. May be a [[Javascript MatchingItem|MatchingItem]] object containing message parameter(s) matching (''filterValue'' will be ignored).<br/>
 '''filterValue''' - Message parameter filter value. Simple data (not object) or RegExp.<br/>
 '''params''' - Parameters (object)
@@ Line 135: / Line 135: @@
 * ''name'' - Handler only. Name of the handled message (string).<br>
 * ''priority'' - Handler only. Integer priority of the installed handler.<br>
-* ''msg_filter'' - Post hook only: message name match. Object. Properties: see MatchingItem dscription.<br>
+* ''msg_filter'' - Post hook only: message name match. Object. Properties: see see [[Javascript MatchingItem|MatchingItem]].getDesc().<br>
-* ''filter'' - Message parameter(s) match. Object. Properties: see MatchingItem dscription.<br>
+* ''filter'' - Message parameter(s) match. Object. Properties: see [[Javascript MatchingItem|MatchingItem]].getDesc().<br>
 * ''handler'' - Name of the handling function (string).<br>
 * ''trackName'' - Handler only. Name of the handler used in tracking (only if not empty). Format: track_name[:priority].<br>

← Older revision		Revision as of 13:40, 3 September 2024
Line 7:		Line 7:
	* Script instance greater than 1 for scripts configured with multiple instances. These functions are available in first instance only<br/>		* Script instance greater than 1 for scripts configured with multiple instances. These functions are available in first instance only<br/>
	* Routing script configured in javascript.conf		* Routing script configured in javascript.conf
		+
		+
		+	Multiple handlers and post hooks may be installed for the same message using same or different callback, priority, filter.<br>
		+	Multiple handlers and post hooks may be installed for different messages using same callback.<br>
		+

@@ Line 92: / Line 92: @@
 * '''load_extensions''' - boolean. Load extensions (external, non native, objects) into script context.<br/>Not loading extensions may lead to a faster processing.<br/>Extensions are never loaded if message name matches ''script.init''.<br/>
 * '''engine.timer''' - boolean. Process ''engine.timer'' message.<br/>Default to false if ''filterMsg'' is set (assume engine.timer match is set there if desired).<br/>
-* '''handled''' - boolean. Callback function call based on message handled value (callback function will not be called if value of this parameter is not the same as meesage handled value).<br/>This parameter is ignored for broadcasted messages.<br/>
+* '''handled''' - boolean. Callback function call based on message handled value (callback function will not be called if value of this parameter is not the same as meesage handled value).<br/>Default if missing or empty: always call the given callback.<br/>This parameter is ignored for broadcasted messages.<br/>

← Older revision		Revision as of 09:44, 3 September 2024
Line 174:		Line 174:

	Enqueue parameters (set in '''params'''):		Enqueue parameters (set in '''params'''):
−	* '''handled''' - boolean. Callback function call based on message handled value (callback function will not be called if value of this parameter is not the same as meesage handled value).<br/>This parameter is ignored for broadcasted messages.<br/>	+	* '''handled''' - boolean. Callback function call based on message handled value (callback function will not be called if value of this parameter is not the same as meesage handled value).<br/>Default if missing or empty: always call the given callback.<br/>This parameter is ignored for broadcasted messages.<br/>

@@ Line 157: / Line 157: @@
 == Methods ==
-* '''enqueue([callback[,reserved,callback_args...]])'''
+* '''enqueue([callback[,params,callback_args...]])'''
 Enqueues the Message in the Yate engine<br/>
 Parameters:<br/>

@@ Line 157: / Line 157: @@
 == Methods ==
-* '''enqueue([callback[,reserved,parameters...]])'''
+* '''enqueue([callback[,reserved,callback_args...]])'''
 Enqueues the Message in the Yate engine<br/>
 Parameters:<br/>
 '''callback''' - Optional function to be called after message is dispatched. Function is called before passing the message to internal message post hook(s). Function won't be called if enqueue() fails<br/>
-'''reserved''' - Parameter reserved for future use<br/>
+'''params''' - Parameter reserved for future use<br/>
-'''parameters''' - Optional parameters to be passed to callback function<br/>
+'''callback_args''' - Optional parameters to be passed to callback function<br/>
 Return: True if enqueue succeeded, false on failure.
 '''NOTE: Message object will become invalid after enqueued. Subsequent functions call will fail or raise a runtime error.'''
-Callback: '''function some_func_name(msg,accepted[,parameters...])'''<br/>
+Callback: '''function some_func_name(msg,handled[,callback_args...])'''<br/>
 Parameters:<br/>
 '''msg''' - Enqueued message. Parameters may change during dispatch<br/>
-'''accepted''' - Boolean indicating message was accepted (handled) or not<br/>
+'''handled''' - Boolean indicating message was accepted (handled) or not<br/>
 '''parameters''' - Optional parameters passed on enqueue() function call<br/>

@@ Line 32: / Line 32: @@
 Return: true on success, false on failure.
-Callback: '''function some_function_name(msg)'''<br>
+Callback: '''function some_function_name(msg[,id])'''<br>
-Handler parameters (passed in '''params'''):<br>
+Handler parameters (set in '''params'''):<br>
 '''id''' - Optional handler id (string). Install of a message handler with the same (non empty) value will replace an existing one.<br/>
@@ Line 56: / Line 60: @@
 Parameters:
 * '''msg''' - Message to handle.<br/>
-* '''handlerContext''' - Singleton context (string) passed on install.<br/>
+* '''handlerContext''' - Singleton context (string) set on install.<br/>
-Handler parameters (passed in '''params'''):
+Handler parameters (set in '''params'''):
-* '''load_extensions''' - boolean. Extensions (external, non native, objects) will not be loaded into script context.<br/>This may lead to a faster processing if extensions are not needed.<br/>Extensions are never loaded if message name matches ''script.init''.<br/>
+* '''load_extensions''' - boolean. Load extensions (external, non native, objects) into script context.<br/>Not loading extensions may lead to a faster processing.<br/>Extensions are never loaded if message name matches ''script.init''.<br/>
@@ Line 83: / Line 87: @@
 * '''msg''' - Message. Object is frozen.<br/>
 * '''handled''' - True if message was handled, false otherwise.<br/>
-* '''id''' - Post hook id (string) passed in install.<br/>
+* '''id''' - Post hook id (string) set in install.<br/>
 Post hook parameters (passed in '''params'''):
-* '''load_extensions''' - boolean. Extensions (external, non native, objects) will not be loaded into script context.<br/>This may lead to a faster processing if extensions are not needed.<br/>Extensions are never loaded if message name matches ''script.init''.<br/>
+* '''load_extensions''' - boolean. Load extensions (external, non native, objects) into script context.<br/>Not loading extensions may lead to a faster processing.<br/>Extensions are never loaded if message name matches ''script.init''.<br/>
 * '''engine.timer''' - boolean. Process ''engine.timer'' message.<br/>Default to false if ''filterMsg'' is set (assume engine.timer match is set there if desired).<br/>

← Older revision		Revision as of 09:31, 3 September 2024
Line 131:		Line 131:
	* ''message_context'' - Singleton handler only: handler context.<br>		* ''message_context'' - Singleton handler only: handler context.<br>
	* ''id'' - Handler/PostHook id (string). Singleton handler: same as message context. Regular (non singleton) handler: present if given on install.<br>		* ''id'' - Handler/PostHook id (string). Singleton handler: same as message context. Regular (non singleton) handler: present if given on install.<br>
		+	* ''handled'' - PostHook only (boolean). Message handled filter state. Present if set on install.<br>