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.interfaces 

ISession  - AS3 ADEP Composite Application
Packagecom.adobe.mosaic.om.interfaces
Interfacepublic interface ISession extends IEventDispatcher

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 ISession interface represents an instance of a user's server connection. Use this interface to examine server information and to query the associated server for stored assets.


Public Properties
 PropertyDefined By
  name : String
[read-only] Returns the name supplied for this connection at open-time.
ISession
  securityManager : ISecurityManager
[read-only] Returns the ISecurityManager instance for a given session.
ISession
  server : IServer
[read-only] Returns an IServer instance for the remote server associated with this session.
ISession
  state : String
[read-only] Returns the current status of the ISession, valid values are contained in ServerConstants.
ISession
Public Methods
 MethodDefined By
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.
IEventDispatcher
 Inherited
dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow.
IEventDispatcher
 Inherited
hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
IEventDispatcher
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
IEventDispatcher
  
requestApplicationList(onSuccess:Function = null, onFailure:Function = null):void
Initiates a network request to the associated server for a list of the Applications available to the current user.
ISession
  
requestCatalogList(onSuccess:Function = null, onFailure:Function = null):void
Initiates a network request to the associated server for a list of the Catalogs available to the current user.
ISession
 Inherited
willTrigger(type:String):Boolean
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
IEventDispatcher
Property Detail

name

property
name: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

Returns the name supplied for this connection at open-time.



Implementation
    public function get name():String

securityManager

property 
securityManager:ISecurityManager  [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 the ISecurityManager instance for a given session. Provides the developer access to all available user information on the IUser interface (username, email, first/last name, etc), as well as full support for all authentication patterns (Web Basic-Auth, SSO, etc) provided by the Experience Service Client Security Library.



Implementation
    public function get securityManager():ISecurityManager

server

property 
server:IServer  [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 IServer instance for the remote server associated with this session.



Implementation
    public function get server():IServer

state

property 
state: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

Returns the current status of the ISession, valid values are contained in ServerConstants.



Implementation
    public function get state():String

Related API Elements

com.adobe.mosaic.om.constants.ServerConstants
Method Detail

requestApplicationList

()method
public function requestApplicationList(onSuccess:Function = null, onFailure:Function = null):void

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

Initiates a network request to the associated server for a list of the Applications available to the current user. The result is an Array of type IApplicationListItem.

Parameters

onSuccess:Function (default = null) — The onSuccess function.
 
onFailure:Function (default = null) — The onFailure function.

requestCatalogList

()method 
public function requestCatalogList(onSuccess:Function = null, onFailure:Function = null):void

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

Initiates a network request to the associated server for a list of the Catalogs available to the current user. The result is an Array of type ICatalogListItem.

Parameters

onSuccess:Function (default = null) — The onSuccess function.
 
onFailure:Function (default = null) — The onFailure function.



© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy