Callback Parameters Object

The callback parameters object is used to specify the callback function for asynchronous commands, it can also be used to specify that a function should be called synchronously (see the sync property below).

usage: ssCore.Command.method( paramsObject [, callbackParamsObject] [, errorParamsObject] );

The following properties can be set on the callback parameters object:

callback - used to specify the callback function that will be called when the given command is executed and the results are available. The callback property can be specified as a string (name of the function) or as a function reference. This is an optional parameter.

scope - is used to provide scope to the callback function. The value of this property must be an object or movieclip. This is an optional parameter and should only be used with the callback property.

sync - is used to override the global default call mode setting (ssDefaults.synchronousCommands) and identify a particular call as synchronous or asynchronous. If this property is true the command will be synchronous regardless of whether or not a callback function is specified. Setting this property to false means the command will be asynchronous. A command that contains a callback parameters object will be executed as asynchronous unless the sync property is set to true, regardless of the value of ssDefaults.synchronousCommands.

Notes:

If the callback property is specified as a string and the scope property is not specified, ssCore will attempt to identify the scope of the function. For instance, if you specify the callback property as "_level0.NavBar.myFunction" then ssCore will understand that the function "myFunction" resides on _level0.NavBar. If you only specify the function as "myFunction", ssCore will assume the function resides on _level0.

You can add your own additional properties to the callback parameters object because the contents of the callback parameters object will be returned to the callback function(or error callback function) as the callback return object.