Packagecom.adobe.rtc.collaboration
Classpublic class BinarySubscriber
InheritanceBinarySubscriber Inheritance FileSubscriber Inheritance mx.core.UIComponent

BinarySubscriber is a simple variant of FileSubscriber that allows the developer to download a given FileDescriptor as a ByteArray in memory rather than as a file to be saved on the user's file system. To access lists of files in the room, see the FileManager APIs.

See also

com.adobe.rtc.sharedManagers.FileManager
com.adobe.rtc.sharedManagers.descriptors.FileDescriptor
com.adobe.rtc.collaboration.FilePublisher
com.adobe.rtc.collaboration.BinaryPublisher
com.adobe.rtc.collaboration.FileSubscriber

Public Properties
 PropertyDefined by
 InheritedaccessModel : int
The role value required for accessing files associated with this component's group as specified by groupName.
FileSubscriber
 InheritedconnectSession : IConnectSession
The IConnectSession with which this component is associated; it defaults to the first IConnectSession created in the application.
FileSubscriber
  fileData : ByteArray
[read-only] The file data of the downloaded file: it is null until a complete event fires.
BinarySubscriber
 InheritedgroupName : String
Components (pods) are assigned to a group via groupName; if not specified, the component is assigned to the default, public group (the room at large).
FileSubscriber
 InheritedisSynchronized : Boolean
Returns true if the model is synchronized.
FileSubscriber
 InheritedpublishModel : int
The role required for this component to publish to the group specified by groupName.
FileSubscriber
 InheritedsharedID : String
Defines the logical location of the component on the service; typically this assigns the sharedID of the collectionNode used by the component.
FileSubscriber
Public Methods
 MethodDefined by
  
BinarySubscriber()
BinarySubscriber
 Inherited
close():void
Disposes all listeners to the network and framework classes and is recommended for proper garbage collection of the component.
FileSubscriber
  
download(p_fileDescriptor:FileDescriptor):void
Downloads the file specified by the supplied FileDescriptor.
BinarySubscriber
 Inherited
getNodeConfiguration():NodeConfiguration
Gets the NodeConfiguration on a specific file group.
FileSubscriber
 Inherited
getUserRole(p_userID:String):int
Returns the role of a given user for files, within the group this component is assigned to.
FileSubscriber
 Inherited
setNodeConfiguration(p_nodeConfiguration:NodeConfiguration):void
Sets the NodeConfiguration.
FileSubscriber
 Inherited
setUserRole(p_userID:String, p_userRole:int):void
Sets the role of a given user for subscribing to files within this component's group specified by groupName.
FileSubscriber
 Inherited
subscribe():void
Subscribes to a particular stream.
FileSubscriber
Events
 EventSummaryDefined by
 Inherited
complete
Dispatched on download completion.FileSubscriber
 Inherited
httpStatus
Dispatched on httpStatus.FileSubscriber
 Inherited
ioError
Dispatched on an IO error.FileSubscriber
 Inherited
progress
Dispatched as a download progresses.FileSubscriber
 Inherited
securityError
Dispatched on a security error.FileSubscriber
 Inherited
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.FileSubscriber
Property detail
fileDataproperty
fileData:ByteArray  [read-only]

The file data of the downloaded file: it is null until a complete event fires.

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

Implementation
    public function get fileData():ByteArray
Constructor detail
BinarySubscriber()constructor
public function BinarySubscriber()
Method detail
download()method
public override function download(p_fileDescriptor:FileDescriptor):void

Downloads the file specified by the supplied FileDescriptor. The file in question will populate the fileData upon completion.

Parameters
p_fileDescriptor:FileDescriptor — A FileDescriptor representing the file to download. For details about accessing a list of files available in the room, see the FileManager's APIs.



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/collaboration/BinarySubscriber.html