BNMAPI

This is the bottom-most class in the BNMAPI chain. In other words, this is the end point for the API’s inheritance. All classes are extended by this one and the whole structure is reverse-traversed backwards by calling super constructors until the entire chain is created. This end-point class is provided as the way to create the authoritative and complete BNMAPI singleton instance and it should be the first thing that a prospective application does. The events in this class have been prepared and organized in very specific sequences to ensure that every piece of the API has access to all of its necessary data and references.

For a complete list of all functionality and data available through the BNMAPI instance, refer to the API documentation or to each class individually. Remember that since this is a singleton, all methods and members are available directly through this single reference.

This ActionScript library is licensed and released under the MIT License (http://www.opensource.org/licenses/mit-license.php). Please refer to the accompanying text file “license.txt”, which should be distributed with every package and version of this library, for information on usage, distribution, copying, and other important information.

This class is commented using the NaturalDocs documentation system. It is intended to be easily read both from the direct source code and from an adaptation that is generated as hyperlinked HTML. The NaturalDocs specification used in this class’ documentation is version 1.35 though older versions may probably be used safely. For more information, please visit: http://www.naturaldocs.org/

Variables

Application

public var Application: *

(untyped) A generic reference variable that a main application class can use to register itself with. This is typically a reference to the main document class and can be used to provide a centralized reference for various application modules. However, this reference is provided simply as a pseudo-global reference and may in fact point to anything.

Functions

BNMAPI

public function BNMAPI ()

Constructor method for this class instance and for the entire API class chain.

Parameters

none

Returns

BNMAPI: An instance of the BNMAPI class.

Broadcasts

nothing

Throws

nothing

Bubbles

no

create

public static function create ()

A static secondary constructor that can be used to non-destructively instantiate the API. If an instance already exists, this method will do nothing, otherwise it will create the single instance. Simply importing the <com.bnm.api.BNMAPI> class and calling `BNMAPI.create();` will ensure that the

setListeners

private function setListeners()

Sets default listeners for the API. These are only for the end class (BNMAPI) and does not apply to any other class in the chain.

Parameters

none

Returns

nothing

Broadcasts

nothing

Throws

nothing

Bubbles

no

Manages binary/data loads for the API.

public var Application: *

(untyped) A generic reference variable that a main application class can use to register itself with.

public function BNMAPI ()

Constructor method for this class instance and for the entire API class chain.

public static function create ()

A static secondary constructor that can be used to non-destructively instantiate the API.