| Package | com.adobe.rtc.sharedManagers.descriptors |
| Class | public class FileDescriptor |
| Implements | IValueObjectEncodable |
FileDescriptors can be thought of as control metadata for indicating the presence and current state of files in the room. FileDescriptors can be accessed through FileManager's methods, and FileManager's events will notify of any changes to the set of fileDescriptors.
See also
| Property | Defined by | ||
|---|---|---|---|
| ANNOUNCING_INTENTION_TO_PUBLISH : String = "announcingIntentionToPublish" [static]
Constant value descriptor state which is published in the descriptor for validation
to the service when the publisher is about to upload a file.
| FileDescriptor | ||
| filename : String
The name of the file on the server (including possible encoding).
| FileDescriptor | ||
| FILE_UPLOAD_PROGRESS : String = "fileUploadProgress" [static]
Constant value for the descriptor stae: When the file upload is in progress,
the descriptor is periodically updated with the percent completion of the
upload and this state.
| FileDescriptor | ||
| groupName : String
The group name which the stream descriptor belongs to
| FileDescriptor | ||
| id : String
A unique descriptor ID.
| FileDescriptor | ||
| lastModified : int
The timestamp of the last modified date.
| FileDescriptor | ||
| name : String
The name of the file on the client.
| FileDescriptor | ||
| previousFilename : String
If the file has been renamed, the last server fileName used before it was renamed.
| FileDescriptor | ||
| previousName : String
If the file has been renamed, the last client name used before it was renamed.
| FileDescriptor | ||
| PUBLISHING_DESCRIPTOR : String = "publishingDescriptor" [static]
Constant value for the descriptor state: When the file upload is finished and the final
URL has been determined, the descriptor is updated with the URL and this state.
| FileDescriptor | ||
| size : int = 0
The size of the file in bytes.
| FileDescriptor | ||
| state : String
The state of the publish operation which must be one of the constant values
described in this class.
| FileDescriptor | ||
| submitterID : String
The file publisher's
userID. | FileDescriptor | ||
| token : String
A server token to allow for validated download of the file.
| FileDescriptor | ||
| type : String
The file type.
| FileDescriptor | ||
| uploadProgress : Number = 0
The progress of the file upload expressed numerically from 0 to 100.
| FileDescriptor | ||
| url : String
The final URL of the file on a server for download.
| FileDescriptor | ||
| Method | Defined by | ||
|---|---|---|---|
|
Returns a copy of itself.
| FileDescriptor | ||
|
createValueObject():Object
Creates a ValueObject representation of this descriptor.
| FileDescriptor | ||
|
readValueObject(p_valueObject:Object):void
Takes in a
valueObject and structure the MessageItem according to the values therein. | FileDescriptor | ||
| ANNOUNCING_INTENTION_TO_PUBLISH | property |
public static var ANNOUNCING_INTENTION_TO_PUBLISH:String = "announcingIntentionToPublish"Constant value descriptor state which is published in the descriptor for validation to the service when the publisher is about to upload a file.
| filename | property |
public var filename:StringThe name of the file on the server (including possible encoding).
| FILE_UPLOAD_PROGRESS | property |
public static var FILE_UPLOAD_PROGRESS:String = "fileUploadProgress"Constant value for the descriptor stae: When the file upload is in progress, the descriptor is periodically updated with the percent completion of the upload and this state.
| groupName | property |
public var groupName:StringThe group name which the stream descriptor belongs to
| id | property |
public var id:StringA unique descriptor ID.
| lastModified | property |
public var lastModified:intThe timestamp of the last modified date.
| name | property |
public var name:StringThe name of the file on the client.
| previousFilename | property |
public var previousFilename:StringIf the file has been renamed, the last server fileName used before it was renamed.
| previousName | property |
public var previousName:StringIf the file has been renamed, the last client name used before it was renamed.
| PUBLISHING_DESCRIPTOR | property |
public static var PUBLISHING_DESCRIPTOR:String = "publishingDescriptor"Constant value for the descriptor state: When the file upload is finished and the final URL has been determined, the descriptor is updated with the URL and this state.
| size | property |
public var size:int = 0The size of the file in bytes.
| state | property |
public var state:StringThe state of the publish operation which must be one of the constant values described in this class.
| submitterID | property |
public var submitterID:String
The file publisher's userID.
| token | property |
public var token:StringA server token to allow for validated download of the file.
| type | property |
public var type:StringThe file type.
| uploadProgress | property |
public var uploadProgress:Number = 0The progress of the file upload expressed numerically from 0 to 100.
| url | property |
public var url:StringThe final URL of the file on a server for download.
| clone | () | method |
| createValueObject | () | method |
public function createValueObject():ObjectCreates a ValueObject representation of this descriptor.
ReturnsObject — An Object which represents the non-default values for this descriptor,
suitable for consumption by readValueObject.
|
| readValueObject | () | method |
public function readValueObject(p_valueObject:Object):void
Takes in a valueObject and structure the MessageItem according to the values therein.
p_valueObject:Object — An Object which represents the non-default values for this MessageItem.
|
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/sharedManagers/descriptors/FileDescriptor.html