ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
com.adobe.mosaic.om.events 

UserViewsLoadEvent  - AS3 ADEP Composite Application

Packagecom.adobe.mosaic.om.events
Classpublic class UserViewsLoadEvent
InheritanceUserViewsLoadEvent Inheritance BaseEvent Inheritance Event Inheritance Object

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Runtime Versions: AIR 2.6, Flash Player 10.2

The UserViewsLoadEvent class defines a transient notification of user views load results.

UserViewsLoadEvent objects are not retained or stored after all their listeners have been processed. UserViewsLoadEvent objects are used to communicate information and do not need to be persisted or referenced.



Public Properties
 PropertyDefined By
 Inheritedbubbles : Boolean
[read-only] Indicates whether an event is a bubbling event.
Event
 Inheritedcancelable : Boolean
[read-only] Indicates whether the behavior associated with the event can be prevented.
Event
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcurrentTarget : Object
[read-only] The object that is actively processing the Event object with an event listener.
Event
 InheritedeventPhase : uint
[read-only] The current phase in the event flow.
Event
 Inheritedmessage : String
[read-only] Returns a message string.
BaseEvent
  NAMESPACE : String
[static] [read-only] The namespace for messages of this type.
UserViewsLoadEvent
 Inheritedobject : *
[read-only] Returns the node that was added.
BaseEvent
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtype : String
[read-only] The type of event.
Event
  userViews : Array
[read-only] Returns an array of the user views loaded and/or requested.
UserViewsLoadEvent
Public Methods
 MethodDefined By
  
UserViewsLoadEvent(type:String, views:Array, errMsg:String)
Constructor.
UserViewsLoadEvent
 Inherited
Duplicates an instance of an Event subclass.
Event
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.
Event
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Checks whether the preventDefault() method has been called on the event.
Event
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns a string containing all the properties of the Event object.
Event
 Inherited
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
  FAILURE : String = "userViewsLoadEventFailure"
[static] The namespace for messages of this type.
UserViewsLoadEvent
  SUCCESS : String = "userViewsLoadEventSuccess"
[static] The message type sent when the user views are successfully loaded.
UserViewsLoadEvent
Property Detail

NAMESPACE

property
NAMESPACE:String  [read-only]

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Runtime Versions: AIR 2.6, Flash Player 10.2

The namespace for messages of this type.



Implementation
    public static function get NAMESPACE():String

userViews

property 
userViews:Array  [read-only]

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Runtime Versions: AIR 2.6, Flash Player 10.2

Returns an array of the user views loaded and/or requested. Depending on the query criteria, this could be the full set of user views, or just a subset.



Implementation
    public function get userViews():Array
Constructor Detail

UserViewsLoadEvent

()Constructor
public function UserViewsLoadEvent(type:String, views:Array, errMsg:String)

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Runtime Versions: AIR 2.6, Flash Player 10.2

Constructor.

Parameters
type:String — Event type
 
views:Array — Event views Array
 
errMsg:String — Event error message
Constant Detail

FAILURE

Constant
public static const FAILURE:String = "userViewsLoadEventFailure"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Runtime Versions: AIR 2.6, Flash Player 10.2

The namespace for messages of this type.

SUCCESS

Constant 
public static const SUCCESS:String = "userViewsLoadEventSuccess"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Runtime Versions: AIR 2.6, Flash Player 10.2

The message type sent when the user views are successfully loaded. This can occur through user interaction or API calls.