com.adobe.rtc.util.RoomCleaner

Package	com.adobe.rtc.util
Class	public class RoomCleaner
Inheritance	RoomCleaner mx.core.UIComponent
Implements	ISessionSubscriber

RoomCleaner is a simple utility class primarily used during development in order to restore a room to its pristine state. It resets all RoomManager settings and deletes any CollectionNodes in the room other than the sharedManagers' CollectionNodes (which are required). It thereby effectively wipes any data stored in the room. RoomCleaner also pops up a dialog asking for confirmation before proceeding. Note that only users with an owner role can clean up a room.

See also

Developer Guide
com.adobe.rtc.sharedModel.CollectionNode

Public Properties

	Property		Defined by
		autoClean : Boolean Determines whether the component should automatically begin cleaning the room (true) or whether it should wait until `clean()` is explicitly called (false).	RoomCleaner
		connectSession : IConnectSession The IConnectSession with which this component is associated.	RoomCleaner
		isSynchronized : Boolean [read-only] Returns true if the model is synchronized.	RoomCleaner
		sharedID : String The `sharedID` is the ID of the class.	RoomCleaner

Public Methods

	Method		Defined by
		clean():void Begins actually cleaning the room and opens a dialog box to asking the user to confirm the action.	RoomCleaner
		close():void	RoomCleaner
		subscribe():void Initiates a subscription.	RoomCleaner

Events

	Event		Summary	Defined by
		synchronizationChange	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.	RoomCleaner

Property detail

autoClean

property

autoClean:Boolean [read-write]

Determines whether the component should automatically begin cleaning the room (true) or whether it should wait until clean() is explicitly called (false).

The default value is true.

Implementation
public function get autoClean():Boolean
public function set autoClean(value:Boolean):void

connectSession

property

connectSession:IConnectSession [read-write]

The IConnectSession with which this component is associated.

Implementation
public function get connectSession():IConnectSession
public function set connectSession(value:IConnectSession):void

isSynchronized

property

isSynchronized:Boolean [read-only]

Returns true if the model is synchronized.

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

Implementation
public function get isSynchronized():Boolean

sharedID

property

sharedID:String [read-write]

The sharedID is the ID of the class.

Implementation
public function get sharedID():String
public function set sharedID(value:String):void

Method detail

clean

()

method

public function clean():void

Begins actually cleaning the room and opens a dialog box to asking the user to confirm the action.

close

()

method

public function close():void

subscribe

()

method

public function subscribe():void

Initiates a subscription.

Event detail

synchronizationChange

event

Event object type: 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.

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/util/RoomCleaner.html