Method; registers a listener object with a component instance that is broadcasting an event. When the event occurs, the listener object or function is notified. FlashInterface uses the EventDispatcher provided by the Flash framework. You many look up the documentation regarding its usage for any specific details.

   import flx.events.FlashInterface;
   FlashInterface.addEventListener("message", messageHandler);
   
   function messageHandler(evt:Object)
   {
     FlashInterface.alert("You said", evt.data);
   }
   

Method; used for debugging and providing error messages.

Method; invokes synchronous calls to public methods and properties of registered controls and receives and returns values.

The call function is power and easy to use. It allows you to communication and control another SWFs properties and functions as if they both resided inside the same AVM or scope. To communicate with another SWF, you reference it by its assigned id. Ids are used to reference a swf. Think of it as an instance name. Ids are typically assigned by the HTML page as an "id" or "name". However, when loading up a SWF inside another SWF, the loaded SWF by default takes on the id of the loader. To ensure that each item has its own unique id, we can assign it an id using the flashId property assignment. To assign a flashId do one of the following:

1) URL parameter - (i.e. myflashapp.swf?flashId=myFlashId) [recommended method of implementation]
2) Flash var - (i.e. SWFObject example - setVariable("flashId", "myFlashId")
3) Internal - (i.e. _root.flashId = "myFlashId") - [not recommended because it hard-codes a flashId value inside of the Flash 8 SWF]

To talk to another SWF you reference it by its flashId as demonstrated in the example code below, including children that have been loaded inside a Flash 9 SWF. Lets say a loaded Flash 8 SWF was given the flashId of "flash". We would communicate with with the following code.

    import flx.events.FlashInterface;
    FlashInterface.call("flash.sendMessage", "Hello, world!");
   

In order for the loaded Flash 8 SWF to communicate with its "parent" Flash 9 SWF, reference the Flash 9 SWF as "root".

    import flx.events.FlashInterface;
    FlashInterface.call("root.sendMessage", "Hello, world!");
    

In the previous examples we demonstrated calling a function. You can also use call to communicate with properties, both for setting and retrieving data. Below is an example:

    import flx.events.FlashInterface;
    var info:Object = FlashInterface.call("flash._visible", false);
    trace(info.result) // returns false
    var info:Object = FlashInterface.call("flash._name");
    trace(info.result) // returns the instance name of the movieclip.
   

   Object - 
     status: "success" (String)
     result: return value 
     target: SWF we are communicating with (String)
   

   Object - 
     status: "error" (String)
     target: SWF we are communicating with (String)
     message: Error message indicating problem (String)
   

Method; dispatches an event to any listener registered with an instance of the class. This method is usually called from within a component's class file. FlashInterface uses the EventDispatcher provided by the Flash framework. You many look up the documentation regarding its usage for any specific details.

    import flx.events.FlashInterface;
    FlashInterface.dispatchEvent({type:"message", data:"Hello, world!"});
    

Method; instantiates the needed JavaScript and EventDispatcher in order to perform any dispatching and/or calls to other SWFs. This function must be called before any other actions within FlashInterface or an error will be thrown.

Method; sets a control so it can be accessed through the call method. Public properties and methods may be accessed once a control has been registered.

Two examples are provided below. There is a subtle difference between using publis in AS 2.0 and AS3.0. When invoking publish, _root is referenced in AS 2.0, whereas root is referenced in AS 3.0. For details on using the publish function see documentation.

    import flx.events.FlashInterface;
    FlashInterface.publish(_root, true);
    FlashInterface.register("demo", myMovieClip);
    
    myMovieClip.sendMessage = function(message:String):Void
    {
     FlashInterface.alert("You said", message);
    }
   

    import flx.events.FlashInterface;
    FlashInterface.publish(root, true);
    FlashInterface.register("demo", myMovieClip);
    
    myMovieClip.sendMessage = function(message:String):Void
    {
     FlashInterface.alert("You said", message);
    }