IApplication - Bron voor Adobe ActionScript® 3 (AS3 ADEP Composite Application) API

Pakket	com.adobe.mosaic.om.interfaces
Interface	public interface IApplication extends IMosaicNode , IMessageBus , IMetadataAvailable , IContextProvider

Taalversie:

ActionScript 3.0

Productversie:

Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10

Runtimeversies:

AIR 2.6, Flash Player 10.2

The IApplication interface provides access to the DOM for an application, and provides methods for adding views, panels, and tiles, as well as querying aspects of the application's environment.

Openbare eigenschappen

Overerfde openbare eigenschappen verbergen

Overerfde openbare eigenschappen weergeven

	Eigenschap		Gedefinieerd door
		childrenNodes : Array [alleen-lezen] Returns an array of child nodes (IMosaicNode objects) of the node.	IMosaicNode
		context : IContext [alleen-lezen] Returns the context interface for the application.	IContextProvider
		defaultPanels : Array [alleen-lezen] An array of panels that are defined as defaults for the application.	IApplication
		defaultViews : Array [alleen-lezen] An array of views that are defined as defaults for the application.	IApplication
		loadedCatalogs : Array [alleen-lezen] Returns an array representing the catalogs loaded by the application.	IApplication
		metadata : IMetadata [alleen-lezen] Returns the metadata if any of the node.	IMetadataAvailable
		nodeID : String [alleen-lezen] Returns the ID of the node.	IMosaicNode
		nodeLabel : String Returns the label of the tile.	IMosaicNode
		nodeName : String [alleen-lezen] Returns the name of the node.	IMosaicNode
		nodeType : String [alleen-lezen] Returns the type value of the node.	IMosaicNode
		parentNode : IMosaicNode [alleen-lezen] Returns the direct parent node of the current node within the application.	IMosaicNode
		session : ISession [alleen-lezen] The current ISession associated with this application.	IApplication
		shell : IShell [alleen-lezen] Returns the shell interface for the application.	IApplication
		stylesheets : Array [alleen-lezen] Returns an array of URLs representing each stylesheet the application references.	IApplication
		uniqueID : String [alleen-lezen] Returns the generated unique ID of the node.	IMosaicNode
		url : String [alleen-lezen] The current URL for this application's descriptor.	IApplication
		userViews : Array [alleen-lezen] Returns the list of views that a user has saved for this application.	IApplication

Openbare methoden

Overerfde openbare methoden verbergen

Overerfde openbare methoden weergeven

	Methode		Gedefinieerd door
		acquireContextByName(name:String):IContext Returns the context interface with the given name for the application.	IApplication
		addMessageListener(namespace:String, name:String, handler:Function):void Adds a listener for a namespace and name combination.	IMessageBus
		clone():IMosaicNode Clones an IMosaicNode.	IMosaicNode
		createBlankPanel(l:ILayout = null):IPanel Creates a new blank panel in the application.	IApplication
		createBlankView(l:ILayout = null):IView Creates a new blank view in the application.	IApplication
		createBlankViewManager(l:ILayout = null):IViewManager Creates a new blank viewManager in the application.	IApplication
		createLayout(name:String):ILayout Creates a new layout in the application.	IApplication
		deleteUserView(view:IView, onSuccess:Function = null, onFailure:Function = null):void Deletes a view saved by a user.	IApplication
		findNode(id:String):IMosaicNode Locates a particular node in the DOM based on the node's unique identifier.	IApplication
		getUserViews(jcrQueryString:String = null, onSuccess:Function = null, onFailure:Function = null):void Returns the list of views that a user has saved for this application and satisfies the Content Repository query criteria.	IApplication
		loadCatalog(specifier:ICatalogSpecifier, onSuccess:Function = null, onFailure:Function = null):void Returns a catalog that has been deployed to the Experience Server.	IApplication
		loadService(service:IService, onSuccess:Function, onFailure:Function):void NOT IMPLEMENTED Loads a service for an application.	IApplication
		removeMessageListener(namespace:String, name:String, handler:Function):void Removes a listener for a namespace and name combination.	IMessageBus
		resolveReferences(onSuccess:Function = null, onFailure:Function = null):void Resolves any reference elements that may be in the View, Panel, or Tile.	IMosaicNode
		searchCatalog(specifier:ICatalogSpecifier, jcrQueryString:String = null, onSuccess:Function = null, onFailure:Function = null):void Returns a partial catalog that has been deployed to the server which satisfies the Content Repository query string.	IApplication
		sendMessage(message:Message):void Sends a message to all the tiles in a composite application.	IMessageBus
		unloadCatalog(catalog:ICatalog):void Unloads a catalog from memory cache.	IApplication

Eigenschapdetails

defaultPanels

eigenschap

defaultPanels:Array [alleen-lezen]

Taalversie:

ActionScript 3.0

Productversie:

Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10

Runtimeversies:

AIR 2.6, Flash Player 10.2

An array of panels that are defined as defaults for the application.

Implementatie
public function get defaultPanels():Array

defaultViews

eigenschap

defaultViews:Array [alleen-lezen]

Taalversie:

ActionScript 3.0

Productversie:

Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10

Runtimeversies:

AIR 2.6, Flash Player 10.2

An array of views that are defined as defaults for the application.

Implementatie
public function get defaultViews():Array

loadedCatalogs

eigenschap

loadedCatalogs:Array [alleen-lezen]

Taalversie:

ActionScript 3.0

Productversie:

Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10

Runtimeversies:

AIR 2.6, Flash Player 10.2

Returns an array representing the catalogs loaded by the application.

Implementatie
public function get loadedCatalogs():Array

Verwante API-elementen

com.adobe.mosaic.om.interfaces.ICatalog

session

eigenschap

session:ISession [alleen-lezen]

Taalversie:

ActionScript 3.0

Productversie:

Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10

Runtimeversies:

AIR 2.6, Flash Player 10.2

The current ISession associated with this application.

Implementatie
public function get session():ISession

Verwante API-elementen

com.adobe.mosaic.om.interfaces.ISession.

shell

eigenschap

shell:IShell [alleen-lezen]

Taalversie:

ActionScript 3.0

Productversie:

Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10

Runtimeversies:

AIR 2.6, Flash Player 10.2

Returns the shell interface for the application.

Implementatie
public function get shell():IShell

Verwante API-elementen

com.adobe.mosaic.om.interfaces.IShell

stylesheets

eigenschap

stylesheets:Array [alleen-lezen]

Taalversie:

ActionScript 3.0

Productversie:

Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10

Runtimeversies:

AIR 2.6, Flash Player 10.2

Returns an array of URLs representing each stylesheet the application references.

The stylesheets can be referenced by tiles to allow you to create consistent styling between tiles and the containing applications.

Implementatie
public function get stylesheets():Array

Verwante API-elementen

mx.styles.StyleManager

url

eigenschap

url:String [alleen-lezen]

Taalversie:

ActionScript 3.0

Productversie:

Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10

Runtimeversies:

AIR 2.6, Flash Player 10.2

The current URL for this application's descriptor.

Implementatie
public function get url():String

userViews

eigenschap

userViews:Array [alleen-lezen]

Taalversie:

ActionScript 3.0

Productversie:

Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10

Runtimeversies:

AIR 2.6, Flash Player 10.2

Returns the list of views that a user has saved for this application.

Implementatie
public function get userViews():Array

Methodedetails

acquireContextByName

()

methode

public function acquireContextByName(name:String):IContext

Taalversie:

ActionScript 3.0

Productversie:

Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10

Runtimeversies:

AIR 2.6, Flash Player 10.2

Returns the context interface with the given name for the application. When a given name does not exist, it is created.

Note: The named application context is seperate the general application context.

Parameters

name:String — Specifies the name of the context.

Geretourneerde waarde

IContext — The context for sharing data between tiles in the same application.

Verwante API-elementen

com.adobe.mosaic.om.interfaces.IContext

createBlankPanel

()

methode

public function createBlankPanel(l:ILayout = null):IPanel

Taalversie:

ActionScript 3.0

Productversie:

Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10

Runtimeversies:

AIR 2.6, Flash Player 10.2

Creates a new blank panel in the application.

Parameters

l:ILayout (default = null) — Specifies the ILayout for the new blank panel.

Geretourneerde waarde

IPanel — A new panel.

Verwante API-elementen

com.adobe.mosaic.om.interfaces.IPanel
com.adobe.mosaic.om.interfaces.ILayout

createBlankView

()

methode

public function createBlankView(l:ILayout = null):IView

Taalversie:

ActionScript 3.0

Productversie:

Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10

Runtimeversies:

AIR 2.6, Flash Player 10.2

Creates a new blank view in the application.

Parameters

l:ILayout (default = null) — Specifies the ILayout for the new blank view.

Geretourneerde waarde

IView — A new view.

Verwante API-elementen

com.adobe.mosaic.om.interfaces.ILayout
com.adobe.mosaic.om.interfaces.IView

createBlankViewManager

()

methode

public function createBlankViewManager(l:ILayout = null):IViewManager

Taalversie:

ActionScript 3.0

Productversie:

Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10

Runtimeversies:

AIR 2.6, Flash Player 10.2

Creates a new blank viewManager in the application.

Parameters

l:ILayout (default = null) — Specifies the ILayout for the new blank viewManager.

Geretourneerde waarde

IViewManager — A new viewManager.

Verwante API-elementen

com.adobe.mosaic.om.interfaces.IViewManager
com.adobe.mosaic.om.interfaces.ILayout

createLayout

()

methode

public function createLayout(name:String):ILayout

Taalversie:

ActionScript 3.0

Productversie:

Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10

Runtimeversies:

AIR 2.6, Flash Player 10.2

Creates a new layout in the application.

Parameters

name:String — Specifies either a short-cut name for a provided layout or a fully-qualified class name.

Geretourneerde waarde

ILayout — A new layout.

Verwante API-elementen

com.adobe.mosaic.om.interfaces.ILayout

deleteUserView

()

methode

public function deleteUserView(view:IView, onSuccess:Function = null, onFailure:Function = null):void

Taalversie:

ActionScript 3.0

Productversie:

Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10

Runtimeversies:

AIR 2.6, Flash Player 10.2

Deletes a view saved by a user. The resulting DeleteViewEvent indicating success or failure is returned in the callback function and also dispatched to the MessageListeners.

Parameters

	`view:IView` — Specifies the user's saved view to remove.

	`onSuccess:Function` (default = `null`) — Specifies a function callback that takes in one parameter of type `DeleteViewEvent` when the operation succeeded.

	`onFailure:Function` (default = `null`) — Specifies a Function callback that takes in one parameter of type `DeleteViewEvent` when the operation failed.

findNode

()

methode

public function findNode(id:String):IMosaicNode

Taalversie:

ActionScript 3.0

Productversie:

Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10

Runtimeversies:

AIR 2.6, Flash Player 10.2

Locates a particular node in the DOM based on the node's unique identifier.

Parameters

id:String — Specifies the unique ID of the node.

Geretourneerde waarde

IMosaicNode — The node, or null if a node with the ID cannot be located.

Verwante API-elementen

com.adobe.mosaic.om.interfaces.IMosaicNode

getUserViews

()

methode

public function getUserViews(jcrQueryString:String = null, onSuccess:Function = null, onFailure:Function = null):void

Taalversie:

ActionScript 3.0

Productversie:

Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10

Runtimeversies:

AIR 2.6, Flash Player 10.2

Returns the list of views that a user has saved for this application and satisfies the Content Repository query criteria. The resulting UserViewsLoadEvent indicating success or failure is returned in the callback function and also dispatched to the MessageListeners.

Example - Query to get all the views created before March 3rd: [jcr:created] < cast('+2011-03-03T11:03:03.000Z' as date)

Parameters

	`jcrQueryString:String` (default = `null`) — Specifies the query string in JCR-SQL2 format which will be used to fetch the views.

	`onSuccess:Function` (default = `null`) — Specifies a function callback that takes in one parameter of type `UserViewsLoadEvent` when the operation succeeded

	`onFailure:Function` (default = `null`) — Specifies a function callback that takes in one parameter of type `UserViewsLoadEvent` when the operation failed

loadCatalog

()

methode

public function loadCatalog(specifier:ICatalogSpecifier, onSuccess:Function = null, onFailure:Function = null):void

Taalversie:

ActionScript 3.0

Productversie:

Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10

Runtimeversies:

AIR 2.6, Flash Player 10.2

Returns a catalog that has been deployed to the Experience Server. When a catalog is deployed to the server, the catalog is loaded into the client memory cache.

This allows you to access tiles, views, etc. from the catalog to add to the application.

Parameters

	`specifier:ICatalogSpecifier` — Specifies the ICatalogSpecifier for the catalog to retrieve.

	`onSuccess:Function` (default = `null`) — Specifies a function callback that takes in one parameter of type `CatalogLoadEvent` when the operation succeeded.

	`onFailure:Function` (default = `null`) — Specifies a function callback that takes in one parameter of type `CatalogLoadEvent` when the operation failed. The onSuccess callback will be called if the loadCatalog call is successful. If the catalog was not already loaded, the catalog will be loaded into the client cache. The cached copy is returned in the `CatalogLoadEvent`. The onFailure callback with occur if the catalog was not available.

Verwante API-elementen

com.adobe.mosaic.om.interfaces.ICatalog

Voorbeeld
Hoe dit voorbeeld te gebruiken
This example retrieves a catalog named "sample_catalog":

		 mosaicApp.addMessageListener(CatalogLoadEvent.NAMESPACE, CatalogLoadEvent.SUCCESS, onCatLoadEvent);
		 mosaicApp.addMessageListener(CatalogLoadEvent.NAMESPACE, CatalogLoadEvent.FAILURE, onCatLoadEvent);
		 
		 mosaicApp.loadCatalog(new CatalogSpecifier("sample_catalog"), onLoadSuccess, onLoadFailure);                
         
		 
		 //functions to manage success or failure callbacks
		 private function onLoadSuccess(evt:CatalogLoadEvent):void {} 
		 private function onLoadFailure(evt:CatalogLoadEvent):void {}
		 
		 //functions to manage success or failure events
		 private function onCatLoadEvent(message:Message):void {
		     var  catalogLoadEvent:CatalogLoadEvent = message.payload as CatalogLoadEvent;
		     var catalog:ICatalog = catalogLoadEvent.catalog;
		     //custom processing
		 }

loadService

()

methode

public function loadService(service:IService, onSuccess:Function, onFailure:Function):void

Taalversie:

ActionScript 3.0

Productversie:

NOT IMPLEMENTED

Runtimeversies:

AIR 2.6, Flash Player 10.2

NOT IMPLEMENTED Loads a service for an application. The service will not be injected into any variables until a tile is loaded with a reference to the service.

Parameters

	`service:IService` — Specifies the IService instance to load.

	`onSuccess:Function` — Specifies a function callback that takes in one parameter of type `Event` when the operation succeeded.

	`onFailure:Function` — Specifies a function callback that takes in one parameter of type `Event` when the operation failed.

Verwante API-elementen

com.adobe.mosaic.om.interfaces.IService

searchCatalog

()

methode

 public function searchCatalog(specifier:ICatalogSpecifier, jcrQueryString:String = null, onSuccess:Function = null, onFailure:Function = null):void

Taalversie:

ActionScript 3.0

Productversie:

Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10

Runtimeversies:

AIR 2.6, Flash Player 10.2

Returns a partial catalog that has been deployed to the server which satisfies the Content Repository query string. The partial catalog contains only assets which matches the query criteria. This catalog is not cached and fetched from the server everytime.

The returned catalog allows users to access catalog assets from the catalog to add to the application if they are present in the catalog.

Parameters

	`specifier:ICatalogSpecifier` — Specifies the ICatalogSpecifier for the catalog to retrieve.

	`jcrQueryString:String` (default = `null`) — Specifies the query string which is in JCR-SQL2 format.

	`onSuccess:Function` (default = `null`) — Specifies a function callback that takes in one parameter of type `SearchCatalogEvent` when the operation succeeded.

	`onFailure:Function` (default = `null`) — Specifies a function callback that takes in one parameter of type `SearchCatalogEvent` when the operation failed. The onSuccess callback will be called if the searchCatalog call is successful. A catalog, containing the assets that match the `jcrQueryString` parameter criteria, is returned in the `SearchCatalogEvent`. The onFailure callback with occur if the catalog was not available or the `jcrQueryString` parameter is not valid.

Verwante API-elementen

com.adobe.mosaic.om.interfaces.ICatalog

Voorbeeld
Hoe dit voorbeeld te gebruiken
This example searches a catalog named "sample_catalog":

		 mosaicApp.addMessageListener(SearchCatalogEvent.NAMESPACE, SearchCatalogEvent.SUCCESS, onCatSearchEvent);
		 mosaicApp.addMessageListener(SearchCatalogEvent.NAMESPACE, SearchCatalogEvent.FAILURE, onCatSearchEvent);
		 
		 mosaicApp.searchCatalog(new CatalogSpecifier("sample_catalog"), queryString, onSearchSuccess, onSearchFailure);                
		 
		 //functions to manage success or failure callbacks
		 private function onLoadSuccess(evt:SearchCatalogEvent):void {} 
		 private function onLoadFailure(evt:SearchCatalogEvent):void {}
		 
		 //functions to manage success or failure events
		 private function onCatSearchEvent(message:Message):void {
		     var  searchCatalogEvent:SearchCatalogEvent = message.payload as SearchCatalogEvent;
		     var catalog:ICatalog = searchCatalogEvent.catalog;
		     //custom processing
		 }

unloadCatalog

()

methode

public function unloadCatalog(catalog:ICatalog):void

Taalversie:

ActionScript 3.0

Productversie:

Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10

Runtimeversies:

AIR 2.6, Flash Player 10.2

Unloads a catalog from memory cache.

This allows you to free memory by unloaded a catalog.

Parameters

catalog:ICatalog — Specifies the ICatalog to be unloaded.

Verwante API-elementen

com.adobe.mosaic.om.interfaces.ICatalog

Juridische kennisgeving | Online privacybeleid

IApplication - AS3 ADEP Composite Application

Klassen x

defaultPanels

defaultViews

loadedCatalogs

session

shell

stylesheets

url

userViews

acquireContextByName

createBlankPanel

createBlankView

createBlankViewManager

createLayout

deleteUserView

findNode

getUserViews

loadCatalog

loadService

searchCatalog

unloadCatalog