Whitebeam Template Reference Documentation

Site Map
 
Home
 
Application Guide
Reference
  Installation
  Configuration
  XML Markup
  JavaScript Classes
  ROM
  Templates
  Environment
  Dev Process
  Tools
  External Links
  Example libraries
Community
Contact Whitebeam
To-Do
Download
Credits
Licence
Whitebeam Users
 
 
 

Whitebeam Template Reference Documentation

rb.file.fileInfoType

Details of any type of binary file (e.g. *.gif).

Elements

The rb.file.fileInfoType struct has 10 elements:

Name Type/Value Range/Length Description
fileIDnumberValid fileID Optional. Unique identifier for a file generated by the system when file is added.
Required for modify().
fragmentIDnumber0 or +ve integer Optional.

Identifies one-of-n possible fragments that form a single contiguous file. Assigned by the template when the application calls create or append. A specific fragmentID can optionally be specified for modify requests (othrewise fragmentID=0 is used).

Available from version : 1.3.12

contactIDarray of numbers  Optional.

Returned if bit 3 of allData is set. Read-only list of contacts to which this file is linked.

Available from version : 1.3.27

namestring1..50 Optional. Name of the file e.g. to appear in a selection list.
Required for create().
ownerstring1..50 Optional. Owner of the file e.g. department name.
Required for create().
typestring1..30 Optional. Short classification string to allow applications to distinguish between different 'things' stored in catalogue items.
modifiedTimedateJavaScript Date object Optional. The date/time at which this contact record was last changed. This field is usually automatically updated by the system on create/modify requests. This behaviour can be over-ridden by the modifyTimestamp flag.

Available from version : 1.3.14

descriptionstring0..250 Optional. Description of file.
customDataMetaData0-200K Optional. Application specific data
fileDefbinarybinary Optional. File mime, size and data or data source.

Whitebeam release 1.3.36
(loadtime : 60ms)