| Package | com.adobe.rtc.session |
| Interface | public interface ISessionSubscriber |
| Implementors | AudioPublisher, AudioSubscriber, Baton, BatonProperty, CameraModel, CollectionNode, FileManager, FilePublisher, FileShare, FileSubscriber, HorizontalRoster, Note, NoteModel, RoomCleaner, RoomManager, Roster, SharedCollection, SharedCursorPane, SharedProperty, SharedWBModel, SharedWhiteBoard, SimpleChat, SimpleChatModel, StreamManager, UserManager, UserQueue, WebCamera, WebcamPublisher, WebcamSubscriber |
See also
| Property | Defined by | ||
|---|---|---|---|
| connectSession : IConnectSession
The IConnectSession with which this component is associated.
| ISessionSubscriber | ||
| isSynchronized : Boolean [read-only]
Returns whether or not the component has fully synched up to the service;
that is, whether it is connected and has all information stored on the service
regarding it.
| ISessionSubscriber | ||
| sharedID : String
Defines the logical location of the component on the service - typically this assigns the sharedID of the collectionNode
used by the component.
| ISessionSubscriber | ||
| Method | Defined by | ||
|---|---|---|---|
|
close():void
Disposes all listeners to the network and framework classes.
| ISessionSubscriber | ||
|
subscribe():void
Tells the component to begin synchronizing with the service.
| ISessionSubscriber | ||
| Event | Summary | Defined by | ||
|---|---|---|---|---|
| Dispatched when the component either loses its connection to the session or regains it and has finished re-synchronizing itself to the rest of the room | ISessionSubscriber | |||
| connectSession | property |
connectSession:IConnectSession [read-write]
The IConnectSession with which this component is associated.
Note that this may only be set once before subscribe()
is called; re-sessioning of components is not supported. Defaults
to the first IConnectSession created in the application.
public function get connectSession():IConnectSession
public function set connectSession(value:IConnectSession):void
| isSynchronized | property |
isSynchronized:Boolean [read-only]
Returns whether or not the component has fully synched up to the service;
that is, whether it is connected and has all information stored on the service
regarding it. Generally, such components cannot have their APIs used while
in a non-synchronized state. synchronizationChange events are
dispatched to indicate this value changing.
public function get isSynchronized():Boolean
| sharedID | property |
sharedID:String [read-write]
Defines the logical location of the component on the service - typically this assigns the sharedID of the collectionNode
used by the component. sharedIDs should be unique within a room (if they're expressing 2 unique locations). Note that
this can only be assigned once (before subscribe() is called). For components with an id property,
sharedID defaults to that value.
public function get sharedID():String
public function set sharedID(value:String):void
| close | () | method |
public function close():voidDisposes all listeners to the network and framework classes. Recommended for proper garbage collection of the component.
| subscribe | () | method |
public function subscribe():voidTells the component to begin synchronizing with the service. For UIComponent-based components, this will be called automatically upon being added to the displayList. For "headless" components, this method must be called explicitly.
| synchronizationChange | event |
com.adobe.rtc.events.CollectionNodeEvent
Dispatched when the component either loses its connection to the session or regains it and has finished re-synchronizing itself to the rest of the room
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/ISessionSubscriber.html