Packagecom.adobe.rtc.util
Classpublic class AccountManager
InheritanceAccountManager Inheritance flash.events.EventDispatcher

The AccountManager class enables the developer to build Flex applications which dynamically create rooms, list templates and rooms, and delete templates and rooms. It makes use of an upcoming REST-based API for the service which allows server-to-server calls to provide this functionality. The REST API is still being refined; for the time being this component allows developers to prototype dynamic room creation and management with an interface that will remain constant. Note: As the REST API changes underneath it, this class will be updated.

See also

com.adobe.rtc.util.RoomTemplater

Public Properties
 PropertyDefined by
  accountURL : String
The developer's account URL.
AccountManager
  authenticator : AbstractAuthenticator
An authenticator (AdobeHSAuthenticator) as used with an IConnectSession.
AccountManager
  isAuthenticated : Boolean = false
(Read-Only) Specifies whether or not the AccountManager has completed authentication and logging in.
AccountManager
  isSDKAccount : Boolean = false
(Read-Only) Specifies whether or not the account is an SDK account
AccountManager
Public Methods
 MethodDefined by
  
AccountManager()
AccountManager
  
createRoom(p_roomName:String, p_templateName:String = null):void
Creates a new room on the service under the current account.
AccountManager
  
deleteRoom(p_roomName:String, p_templateName:String = null):void
Deletes a specified room from the service.
AccountManager
  
deleteTemplate(p_templateName:String):void
Deletes the specified template.
AccountManager
  
login():void
Logs into the service.
AccountManager
  
requestRoomList():void
Requests a list of all rooms under the current account.
AccountManager
  
requestTemplateList():void
Requests a list of all templates under the current account.
AccountManager
Protected Methods
 MethodDefined by
  
onError(p_evt:Event):void
AccountManager
Events
 EventSummaryDefined by
  
accessError
Dispatched when a request fails AccountManager
  
loginFailure
Dispatched when a call to login to the service has failed.AccountManager
  
loginSuccess
Dispatched when a call to login to the service has succeeded.AccountManager
  
roomCreate
Dispatched when a call to createRoom has returned.AccountManager
  
roomDelete
Dispatched when a call to deleteRoom has returned.AccountManager
  
roomListReceive
Dispatched when a call to requestRoomList has returned.AccountManager
  
templateListReceive
Dispatched when a call to requestTemplateList has returned.AccountManager
Property detail
accountURLproperty
public var accountURL:String

The developer's account URL. This is typically the URL of a room with the last branch of the path removed. For example, if roomURL="https://connectnow.acrobat.com/fakeaccount/fakeroom", then accountURL="https://connectnow.acrobat.com/fakeaccount".

authenticatorproperty 
public var authenticator:AbstractAuthenticator

An authenticator (AdobeHSAuthenticator) as used with an IConnectSession.

isAuthenticatedproperty 
public var isAuthenticated:Boolean = false

(Read-Only) Specifies whether or not the AccountManager has completed authentication and logging in. Login is necessary before any other calls can be executed.

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

isSDKAccountproperty 
public var isSDKAccount:Boolean = false

(Read-Only) Specifies whether or not the account is an SDK account

Constructor detail
AccountManager()constructor
public function AccountManager()
Method detail
createRoom()method
public function createRoom(p_roomName:String, p_templateName:String = null):void

Creates a new room on the service under the current account.

Parameters
p_roomName:String — The name of the new room.
 
p_templateName:String (default = null) — The name of the template to use in creating the room. If null, the default template is used.
deleteRoom()method 
public function deleteRoom(p_roomName:String, p_templateName:String = null):void

Deletes a specified room from the service.

Parameters
p_roomName:String — The name of the room to delete (room name only--not the entire path).
 
p_templateName:String (default = null) — Optional. The name of the template from which the room came. Including the template name causes the ROOM_DELETE event to include the templateName; ommitting roomName has no effect.
deleteTemplate()method 
public function deleteTemplate(p_templateName:String):void

Deletes the specified template. Deleting a template results in all the rooms based on that template begin moved to the default template. However the room's configuration does not change.

Parameters
p_templateName:String
login()method 
public function login():void

Logs into the service. Note that an accountURL and authenticator are required before this method may be called. Also note that the account manager must be logged in for any subsequent calls to work.

onError()method 
protected function onError(p_evt:Event):voidParameters
p_evt:Event
requestRoomList()method 
public function requestRoomList():void

Requests a list of all rooms under the current account. An AccountManagerEvent.ROOM_LIST_RECEIVE event is dispatched with the result.

requestTemplateList()method 
public function requestTemplateList():void

Requests a list of all templates under the current account. An AccountManagerEvent.TEMPLATE_LIST_RECEIVE event is dispatched with the result.

Event detail
accessErrorevent 
Event object type: com.adobe.rtc.events.AccountManagerEvent

Dispatched when a request fails

loginFailureevent  
Event object type: com.adobe.rtc.events.AccountManagerEvent

Dispatched when a call to login to the service has failed.

loginSuccessevent  
Event object type: com.adobe.rtc.events.AccountManagerEvent

Dispatched when a call to login to the service has succeeded.

roomCreateevent  
Event object type: com.adobe.rtc.events.AccountManagerEvent

Dispatched when a call to createRoom has returned.

roomDeleteevent  
Event object type: com.adobe.rtc.events.AccountManagerEvent

Dispatched when a call to deleteRoom has returned.

roomListReceiveevent  
Event object type: com.adobe.rtc.events.AccountManagerEvent

Dispatched when a call to requestRoomList has returned.

templateListReceiveevent  
Event object type: com.adobe.rtc.events.AccountManagerEvent

Dispatched when a call to requestTemplateList has returned.




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/AccountManager.html