Packagecom.adobe.rtc.session
Interfacepublic interface IConnectSession extends flash.events.IEventDispatcher
ImplementorsConnectSession, ConnectSessionContainer, SessionContainerProxy

IConnectSession is the interface responsible for representing a user session connected to a real-time collaboration room. IConnectSession instances have the following behavior : The principal implementors of IConnectSession are ConnectSession and ConnectSessionContainer, both of which can be used to create new sessions to the service.

Note that multiple IConnectSessions may be connected in one application simultaneously. In such cases, most RTC components will need to be associated with a particular session. Such components implement the ISessionSubscriber interface, exposing a connectSession property, which should be assigned to the appropriate IConnectSession, or they will default to being associated with ConnectSession.primarySession,the first IConnectSession created. ISessionSubscriber instances found within ConnectSessionContainer tags are automatically associated with their ConnectSessionContainer.

RTC components may only be instantiated and subscribed after an IConnectSession has been instantiated. However, such ISessionSubscriber components can be subscribed or added before any IConnectSession is finished synchronizing with the service.

See also

com.adobe.rtc.session.ConnectSession
com.adobe.rtc.session.ConnectSessionContainer
com.adobe.rtc.session.ISessionSubscriber
com.adobe.rtc.session.sessionClasses.SessionContainerProxy
com.adobe.rtc.authentication.AdobeHSAuthenticator
com.adobe.rtc.sharedManagers.UserManager
com.adobe.rtc.sharedManagers.RoomManager
com.adobe.rtc.sharedManagers.StreamManager
com.adobe.rtc.sharedManagers.FileManager
com.adobe.rtc.session.ISessionSubscriber


Public Properties
 PropertyDefined by
  authenticator : AbstractAuthenticator
(Required) The authenticator through which login information is passed.
IConnectSession
  fileManager : FileManager
[read-only] The FileManager class for the current session.
IConnectSession
  initialRoomSettings : RoomSettings
The initial room settings for the current room.
IConnectSession
  isSynchronized : Boolean
[read-only] [Read-only] A variable that indicates whether or not the ConnectSession is fully synchronized with the service.
IConnectSession
  roomManager : RoomManager
[read-only] The RoomManager class for the current session.
IConnectSession
  roomURL : String
[Required] The URL of the room to which to connect.
IConnectSession
  streamManager : StreamManager
[read-only] The StreamManager class for the current session.
IConnectSession
  userManager : UserManager
[read-only] accessors for SharedManager classes
IConnectSession
Public Methods
 MethodDefined by
  
login():void
Logs into the RTC service.
IConnectSession
  
logout():void
Logs out and disconnects from the session.
IConnectSession
Events
 EventSummaryDefined by
   Dispatched when the session is closed before any children (in the case of ConnectSessionContainer) are removed.IConnectSession
   Dispatched when there's an error on the server.IConnectSession
   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.
IConnectSession
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]

accessors for SharedManager classes

Implementation
    public function get userManager():UserManager
Method detail
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.

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:





 

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/IConnectSession.html