Server-Side Communication ActionScript > SharedObject.handlerName

SharedObject.handlerName

Availability

Flash Communication Server MX.

Usage

SharedObject.onBroadcastMsg = function([p1,..., pN]){
	// insert code here
};

Parameters

p1, ..., pN Optional parameters passed to the handler method if the message contains user-defined parameters. These parameters are the user-defined JavaScript objects passed to the SharedObject.send method.

Returns

Any return value is ignored by the server.

Description

Event handler; a placeholder for a property name (onBroadcastMsg in the Usage example above) that specifies a function object that is invoked when the shared object receives a broadcast message whose method name matches the property name.

The this keyword used in the body of the function is set to the shared object instance returned by SharedObject.get.

If you don't want the server to receive a particular broadcast message, do not define this handler.

Example

The following example defines a handler function called broadcastMsg:

var mySO = SharedObject.get("userList", false);
mySO.broadcastMsg = function(msg1, msg2){
		trace(msg1 + " : " + msg2);
};