| Package | com.adobe.rtc.session |
| Interface | public interface IConnectSession extends flash.events.IEventDispatcher |
| Implementors | ConnectSession, ConnectSessionContainer, SessionContainerProxy |
roomURL and authenticator.login()
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
| Property | Defined 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 | ||
| Method | Defined by | ||
|---|---|---|---|
|
login():void
Logs into the RTC service.
| IConnectSession | ||
|
logout():void
Logs out and disconnects from the session.
| IConnectSession | ||
| Event | Summary | Defined 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:
| IConnectSession | |||
| authenticator | property |
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
| fileManager | property |
fileManager:FileManager [read-only]
The FileManager class for the current session.
public function get fileManager():FileManager
| initialRoomSettings | property |
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
| isSynchronized | property |
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
| roomManager | property |
roomManager:RoomManager [read-only]
The RoomManager class for the current session.
public function get roomManager():RoomManager
| roomURL | property |
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
| streamManager | property |
streamManager:StreamManager [read-only]
The StreamManager class for the current session.
public function get streamManager():StreamManager
| userManager | property |
userManager:UserManager [read-only]accessors for SharedManager classes
Implementation public function get userManager():UserManager
| login | () | method |
public function login():voidLogs into the RTC service. Calling login is required for using ConnectSession, as compared with ConnectSessionContainer, Which does so automatically.
| logout | () | method |
public function logout():voidLogs out and disconnects from the session.
| close | event |
com.adobe.rtc.events.ConnectSessionEvent
Dispatched when the session is closed before any children (in the case of ConnectSessionContainer) are removed.
| error | event |
com.adobe.rtc.events.SessionEvent
Dispatched when there's an error on the server.
| synchronizationChange | event |
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