Packagecom.adobe.rtc.pods
Classpublic class FileShare
InheritanceFileShare Inheritance mx.core.UIComponent
ImplementsISessionSubscriber

FileShare is a high level pod component which offers a full mini-application for uploading files, viewing lists of files, and downloading files. It uses FileManager groups as its basic model for display and FilePublisher and FileSubscriber to actually upload and download files.

Users with a viewer role or greater are able to download, and only users with a publisher role or greater may upload a file.

See also

com.adobe.rtc.collaboration.FilePublisher
com.adobe.rtc.collaboration.FileSubscriber
com.adobe.rtc.sharedManagers.FileManager

Public Properties
 PropertyDefined by
  clearUponSessionEnd : Boolean = false
Specifies whether files in the pod should be deleted as the session ends.
FileShare
  connectSession : IConnectSession
The IConnectSession with which this component is associated.
FileShare
  fileGrid : DataGrid
[read-only] Provides a reference to the grid display of files.
FileShare
  isSynchronized : Boolean
[read-only] Returns true if the component is synchronized; otherwise, false.
FileShare
  sharedID : String
The sharedID corresponds to the groupName of the FilePublisher and FileSubscriber used in this component.
FileShare
  useSSL : Boolean
Specifies whether or not to use SSL in uploading and downloading files.
FileShare
Public Methods
 MethodDefined by
  
FileShare()
FileShare
  
amIUploadingFile():Boolean
Determines whether or not the current user is uploading a file.
FileShare
  
cancelButtonToolTipChanger(event:ToolTipEvent):void
FileShare
  
cancelFileUpload():void
Cancels file upload.
FileShare
  
cancelUploadSelection(p_event:MouseEvent = null):void
Cancels the pending upload.
FileShare
  
close():void
Disposes all listeners to the network and framework classes.
FileShare
  
deleteSelection(p_event:MouseEvent = null):void
Causes the pod to begin deleting all selected files in the display grid.
FileShare
  
downloadSelection(p_event:MouseEvent = null):void
Causes the pod to begin downloading all selected files in the display grid.
FileShare
  
getUserRole(p_userID:String):int
Returns the role of a given user for files that are within this component's assigned group.
FileShare
  
renameSelection(p_event:MouseEvent = null):void
Causes the pod to rename the selected file in the display grid.
FileShare
  
setUserRole(p_userID:String, p_userRole:int):void
Sets the role of a given user for files that are within this component's assigned group.
FileShare
  
subscribe():void
Tells the component to begin synchronizing with the service.
FileShare
  
uploadFileReference(p_fileReference:FileReference):void
Uploads a fileReference to the pod.
FileShare
  
uploadSelection(p_event:MouseEvent = null):void
Causes the pod to prompt the user to browse for a file to upload.
FileShare
Events
 EventSummaryDefined 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.FileShare
Property detail
clearUponSessionEndproperty
public var clearUponSessionEnd:Boolean = false

Specifies whether files in the pod should be deleted as the session ends.

The default value is false.

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

Implementation
    public function get connectSession():IConnectSession
    public function set connectSession(value:IConnectSession):void
fileGridproperty 
fileGrid:DataGrid  [read-only]

Provides a reference to the grid display of files.

Implementation
    public function get fileGrid():DataGrid
isSynchronizedproperty 
isSynchronized:Boolean  [read-only]

Returns true if the component is synchronized; otherwise, false.

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

Implementation
    public function get isSynchronized():Boolean
sharedIDproperty 
sharedID:String  [read-write]

The sharedID corresponds to the groupName of the FilePublisher and FileSubscriber used in this component. If not specified explicitly, the pod's sharedID is used.

Implementation
    public function get sharedID():String
    public function set sharedID(value:String):void
useSSLproperty 
useSSL:Boolean  [read-write]

Specifies whether or not to use SSL in uploading and downloading files.

Implementation
    public function get useSSL():Boolean
    public function set useSSL(value:Boolean):void
Constructor detail
FileShare()constructor
public function FileShare()
Method detail
amIUploadingFile()method
public function amIUploadingFile():Boolean

Determines whether or not the current user is uploading a file.

Returns
Boolean
cancelButtonToolTipChanger()method 
public function cancelButtonToolTipChanger(event:ToolTipEvent):voidParameters
event:ToolTipEvent
cancelFileUpload()method 
public function cancelFileUpload():void

Cancels file upload.

cancelUploadSelection()method 
public function cancelUploadSelection(p_event:MouseEvent = null):void

Cancels the pending upload.

Parameters
p_event:MouseEvent (default = null)
close()method 
public function close():void

Disposes all listeners to the network and framework classes. Recommended for proper garbage collection of the component.

deleteSelection()method 
public function deleteSelection(p_event:MouseEvent = null):void

Causes the pod to begin deleting all selected files in the display grid.

Parameters
p_event:MouseEvent (default = null)
downloadSelection()method 
public function downloadSelection(p_event:MouseEvent = null):void

Causes the pod to begin downloading all selected files in the display grid.

Parameters
p_event:MouseEvent (default = null)
getUserRole()method 
public function getUserRole(p_userID:String):int

Returns the role of a given user for files that are within this component's assigned group.

Parameters
p_userID:String — The user ID for the user being queried.

Returns
int
renameSelection()method 
public function renameSelection(p_event:MouseEvent = null):void

Causes the pod to rename the selected file in the display grid.

Parameters
p_event:MouseEvent (default = null)
setUserRole()method 
public function setUserRole(p_userID:String, p_userRole:int):void

Sets the role of a given user for files that are within this component's assigned group.

Parameters
p_userID:String — The role value to set on the specified user.
 
p_userRole:int — The ID of the user whose role should be set.
subscribe()method 
public function subscribe():void

Tells the component to begin synchronizing with the service. For UIComponent-based components such as this one, subscribe() is called automatically upon being added to the displayList. For "headless" components, this method must be called explicitly.

uploadFileReference()method 
public function uploadFileReference(p_fileReference:FileReference):void

Uploads a fileReference to the pod.

Parameters
p_fileReference:FileReference
uploadSelection()method 
public function uploadSelection(p_event:MouseEvent = null):void

Causes the pod to prompt the user to browse for a file to upload.

Parameters
p_event:MouseEvent (default = null)
Event detail
synchronizationChangeevent 
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/pods/FileShare.html