Packagecom.adobe.rtc.util
Classpublic class RoomTemplater
InheritanceRoomTemplater Inheritance flash.events.EventDispatcher

RoomTemplater allows developers to create templates from their existing rooms. For example, when your create a room with a chat, note, and whiteboard, then that room's CollectionNodes and settings are stored on the service. Since setting up a room and customizing it often represents a substantial amount of work, LCCS allows you to save your rooms as templates. Templates not only eliminate duplication of effort, but they also enable creating new rooms on-the-fly without requiring an OWNER to be in the room to recreate them. In other words, templates allow you to set up a new room with preconfigured CollectionNodes, nodes, configurations, items, and room settings without having to be present.
Templating a room with a chat node
  <util:RoomTemplater id="templater"/>
  <rtc:AdobeHSAuthenticator 
     // Deployed applications DO NOT hard code username and password here.
     userName="AdobeIDusername@example.com" 
     password="AdobeIDpassword" 
     id="auth"/> 
  <session:ConnectSessionContainer 
    roomURL="http://connect.acrobat.com/fakeAccount/fakeRoom" 
    authenticator="{auth}">
     <mx:VBox>
      <pods:SimpleChat id="publicChat"/>
       <mx:Button label="Save" click="templater.saveRoomAsTemplate('myTemplateName');"/>
     </mx:VBox>
   </session:ConnectSessionContainer>
Note: You can save rooms as templates programmatically or via the Room Console.

See also

com.adobe.rtc.util.AccountManager
com.adobe.rtc.session.RoomSettings

Public Properties
 PropertyDefined by
  connectSession : IConnectSession
The IConnectSession with which this component is associated.
RoomTemplater
Public Methods
 MethodDefined by
  
RoomTemplater()
RoomTemplater
  
saveRoomAsTemplate(p_name:String):void
Saves the room corresponding to the current IConnectSession as a template with the provided name.
RoomTemplater
Events
 EventSummaryDefined by
  
templateSave
Dispatched when the room has been successfully saved as a template.RoomTemplater
Property detail
connectSessionproperty
public var connectSession:IConnectSession

The IConnectSession with which this component is associated. Defaults to the first IConnectSession instance created.

Constructor detail
RoomTemplater()constructor
public function RoomTemplater()
Method detail
saveRoomAsTemplate()method
public function saveRoomAsTemplate(p_name:String):void

Saves the room corresponding to the current IConnectSession as a template with the provided name. Templates may be used for provisioning new rooms that are pre-populated with CollectionNodes. Note that the IConnectSession must be fully synchronized for this method to work.

Parameters
p_name:String — The name of the template to store. Using an existing name overwrites that template.
Event detail
templateSaveevent 
Event object type: com.adobe.rtc.events.RoomTemplateEvent

Dispatched when the room has been successfully saved as a template.




2008-2010 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/RoomTemplater.html