com.adobe.rtc.session.ConnectSessionContainer

Package	com.adobe.rtc.session
Class	public class ConnectSessionContainer
Inheritance	ConnectSessionContainer mx.containers.Canvas
Implements	IConnectSession

ConnectSessionContainer is a Container-based tag which implements IConnectSession. As such, an instance of ConnectSessionContainer corresponds to a session established with an RTC room (as does any IConnectSession). Being container-based, it provides the convenience of easy expression through MXML tags. ConnectSessionContainer has the following behavior:

It requires both roomURL and authenticator.
It is responsible for the operation of the sharedManager classes (User, Room, Stream, File) and maintains the properties to access them.
It automatically logs in when created. To prevent it from doing so, set the autoLogin property to false. In this case, call the login() method when needed.
It does not instantiate any components within it until a session is fully established and all the major sharedManagers are fully synchronized. Use the synchronizationChange event and the isSynchronized property to determine when the session is fully synchronized.
Any children of the ConnectSessionContainer are automatically associated with that particular session. If multiple ConnectSessionContainers are used, their children will be aware of which sessions they belong to.

If an action should be taken once the children are created, use the standard creationComplete event for those children. To end the session, call logout() to simply disconnect, or call close() to remove all children before doing so. If the session is disconnected without these methods (for example, due to network or server failure), ConnectSessionContainer will automatically reconnect.

Creating a session

  <rtc:AdobeHSAuthenticator userName="AdobeIDusername password="AdobeIDpassword" id="auth"/>
        
  <session:ConnectSessionContainer
      roomURL="http://connect.acrobat.com/fakeRoom/" 
      authenticator="{auth}">
       
   <pods:WebCamera width="100%" height="100%"/>
       
  </session:ConnectSessionContainer>

	Property	Defined by
		authenticator : AbstractAuthenticator (Required) The authenticator through which login information is passed.	ConnectSessionContainer
		autoLogin : Boolean = true Whether to log in as soon as the `ConnectSessionContainer` is created (true) or wait until `login()` is explicitly called (false).	ConnectSessionContainer
		fileManager : FileManager [read-only] The `FileManager` class for the current session.	ConnectSessionContainer
		initialRoomSettings : RoomSettings The initial room settings for the current room.	ConnectSessionContainer
		isSynchronized : Boolean [read-only] [Read-only] A variable that indicates whether or not the ConnectSession is fully synchronized with the service.	ConnectSessionContainer
		roomManager : RoomManager [read-only] The `RoomManager` class for the current session.	ConnectSessionContainer
		roomURL : String [Required] The URL of the room to which to connect.	ConnectSessionContainer
		streamManager : StreamManager [read-only] The `StreamManager` class for the current session.	ConnectSessionContainer
		userManager : UserManager [read-only] The `UserManager` class for the current session.	ConnectSessionContainer

	Method	Defined by
		ConnectSessionContainer()	ConnectSessionContainer
		addEventListener(p_type:String, p_listener:Function, p_useCapture:Boolean = false, p_priority:int = 0, p_useWR:Boolean = false):void	ConnectSessionContainer
		close(p_reason:String = ""):void Logs out, disconnects from the session, and removes any children from the `displayList`.	ConnectSessionContainer
		login():void Logs in and begins the process of synchronizing with the room.	ConnectSessionContainer
		logout():void Logs out and disconnects from the session.	ConnectSessionContainer
		removeEventListener(p_type:String, p_listener:Function, p_useCapture:Boolean = false):void	ConnectSessionContainer

	Method	Defined by
		createChildren():void	ConnectSessionContainer

Summary	Defined by
close	Dispatched when the session is closed before any children are removed.	ConnectSessionContainer
error	Dispatched when there's an error on the server.	ConnectSessionContainer
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.	ConnectSessionContainer

Property detail

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

autoLogin

property

public var autoLogin:Boolean = true

Whether to log in as soon as the ConnectSessionContainer is created (true) or wait until login() is explicitly called (false).

The default value is true.

fileManager

property

fileManager:FileManager [read-only]

The FileManager class for the current session.

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

This property can be used as the source for data binding.

Implementation
public function get isSynchronized():Boolean

roomManager

property

roomManager:RoomManager [read-only]

The RoomManager class for the current session.

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

Implementation
public function get streamManager():StreamManager

userManager

property

userManager:UserManager [read-only]

The UserManager class for the current session.

Implementation
public function get userManager():UserManager

Constructor detail

ConnectSessionContainer

()

constructor

public function 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`)

()

method

public function close(p_reason:String = ""):void

Logs out, disconnects from the session, and removes any children from the displayList.

Parameters

p_reason:String (default = "") — An optional reason for closing the session.

createChildren

()

method

protected override function createChildren():void

()

method

public function login():void

Logs in and begins the process of synchronizing with the room. Note that unless autoLogin is set to false, login() is called automatically upon the container being added to the display list.

logout

()

method

public function logout():void

Logs out and disconnects from the session. Any children built are left on the displayList.

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

event

Event object type: com.adobe.rtc.events.ConnectSessionEvent

Dispatched when the session is closed before any children are removed.

error

event

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

Dispatched when there's an error on the server.

synchronizationChange

event

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

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.

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

AFCS API Reference	All Packages \| All Classes \| Index \| Frames No Frames
Class ConnectSessionContainer	Properties \| Methods \| Events