Packagecom.adobe.rtc.session.sessionClasses
Classpublic class SessionContainerProxy
InheritanceSessionContainerProxy Inheritance flash.events.EventDispatcher
ImplementsIConnectSession

SessionContainerProxy is a specialized IConnectSession implementor used by UIComponent-based ISessionSubscribers to find the IConnectSession to which they should be associated. Upon finding the right IConnectSession, SessionContainerProxy proxies its implementation to that IConnectSession instance.

UIComponent-based ISessionSubscribers have 3 places to choose from in order to find an appropriate IConnectSession :

  1. An IConnectSession directly assigned to that component by a developer
  2. A ConnectSessionContainer which is in the parent chain of that component, if one exists
  3. The default ConnectSession.primarySession, which proxies the first IConnectSession created in the application.
SessionContainerProxy does the work of the 2 latter options is most appropriate. Developers of UIComponent-based ISessionSubscriber components should use SessionContainerProxy as their default connectSession value.

Example: a UIComponent-based ISessionSubscriber declares its _connectSession protected variable (for use in its public connectSession getter) to default to a SessionContainerProxy 

  protected var _connectSession:IConnectSession = new SessionContainerProxy(this as UIComponent);

See also

com.adobe.rtc.session.IConnectSession
com.adobe.rtc.session.ISessionSubscriber

Public Properties
 PropertyDefined by
  authenticator : AbstractAuthenticator
(Required) The authenticator through which login information is passed.
SessionContainerProxy
  fileManager : FileManager
[read-only] The FileManager class for the current session.
SessionContainerProxy
  initialRoomSettings : RoomSettings
The initial room settings for the current room.
SessionContainerProxy
  isSynchronized : Boolean
[read-only] [Read-only] A variable that indicates whether or not the ConnectSession is fully synchronized with the service.
SessionContainerProxy
  roomManager : RoomManager
[read-only] The RoomManager class for the current session.
SessionContainerProxy
  roomURL : String
[Required] The URL of the room to which to connect.
SessionContainerProxy
  streamManager : StreamManager
[read-only] The StreamManager class for the current session.
SessionContainerProxy
  userManager : UserManager
[read-only] The UserManager class for the current session.
SessionContainerProxy
Public Methods
 MethodDefined by
  
SessionContainerProxy(p_target:UIComponent = null)
SessionContainerProxy
  
addEventListener(p_type:String, p_listener:Function, p_useCapture:Boolean = false, p_priority:int = 0, p_useWR:Boolean = false):void
SessionContainerProxy
  
login():void
Logs into the RTC service.
SessionContainerProxy
  
logout():void
Logs out and disconnects from the session.
SessionContainerProxy
  
removeEventListener(p_type:String, p_listener:Function, p_useCapture:Boolean = false):void
SessionContainerProxy
Events
 EventSummaryDefined by
  
close
Dispatched when the session is closed before any children (in the case of ConnectSessionContainer) are removed.SessionContainerProxy
  
error
Dispatched when there's an error on the server.SessionContainerProxy
  
synchronizationChange
The synchronizationChange is dispatched when:
  • When ConnectSession establishes a connection to the service and has fully synchronized the major room elements such as UserManager, RoomManager, StreamManager, and FileManager.
  • When the component loses its connection to the service.
SessionContainerProxy
Property detail
authenticatorproperty
authenticator:AbstractAuthenticator  [read-write]

(Required) The authenticator through which login information is passed.

Implementation
    public function get authenticator():AbstractAuthenticator
    public function set authenticator(value:AbstractAuthenticator):void
fileManagerproperty 
fileManager:FileManager  [read-only]

The FileManager class for the current session.

Implementation
    public function get fileManager():FileManager
initialRoomSettingsproperty 
initialRoomSettings:RoomSettings  [read-write]

The initial room settings for the current room. Note that this property only works the FIRST TIME the room receives a connection from an user with an owner role.

Implementation
    public function get initialRoomSettings():RoomSettings
    public function set initialRoomSettings(value:RoomSettings):void
isSynchronizedproperty 
isSynchronized:Boolean  [read-only]

[Read-only] A variable that indicates whether or not the ConnectSession is fully synchronized with the service.

Implementation
    public function get isSynchronized():Boolean
roomManagerproperty 
roomManager:RoomManager  [read-only]

The RoomManager class for the current session.

Implementation
    public function get roomManager():RoomManager
roomURLproperty 
roomURL:String  [read-write]

[Required] The URL of the room to which to connect.

Implementation
    public function get roomURL():String
    public function set roomURL(value:String):void
streamManagerproperty 
streamManager:StreamManager  [read-only]

The StreamManager class for the current session.

Implementation
    public function get streamManager():StreamManager
userManagerproperty 
userManager:UserManager  [read-only]

The UserManager class for the current session.

Implementation
    public function get userManager():UserManager
Constructor detail
SessionContainerProxy()constructor
public function SessionContainerProxy(p_target:UIComponent = null)

Parameters
p_target:UIComponent (default = null) — The UIComponent which wants to locate its ConnectSessionContainer
Method detail
addEventListener()method
public override function addEventListener(p_type:String, p_listener:Function, p_useCapture:Boolean = false, p_priority:int = 0, p_useWR:Boolean = false):void

Parameters
p_type:String
 
p_listener:Function
 
p_useCapture:Boolean (default = false)
 
p_priority:int (default = 0)
 
p_useWR:Boolean (default = false)
login()method 
public function login():void

Logs into the RTC service. Calling login is required for using ConnectSession, as compared with ConnectSessionContainer, Which does so automatically.

logout()method 
public function logout():void

Logs out and disconnects from the session.

removeEventListener()method 
public override function removeEventListener(p_type:String, p_listener:Function, p_useCapture:Boolean = false):void

Parameters
p_type:String
 
p_listener:Function
 
p_useCapture:Boolean (default = false)
Event detail
closeevent 
Event object type: com.adobe.rtc.events.ConnectSessionEvent

Dispatched when the session is closed before any children (in the case of ConnectSessionContainer) are removed.

errorevent  
Event object type: com.adobe.rtc.events.SessionEvent

Dispatched when there's an error on the server.

synchronizationChangeevent  
Event object type: com.adobe.rtc.events.SessionEvent

The synchronizationChange is dispatched when:




2008-2009 Adobe Systems Incorporated. All rights reserved.

 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/labs/acrobatcom/com/adobe/rtc/session/sessionClasses/SessionContainerProxy.html