new module:model/Document()
- Source:
Constructs a new Document.
Information about a document.
Members
(inner) documentBase64 :String
- Source:
The base64-encoded contents of the document.
Type:
- String
(inner) documentDisplay :String
- Source:
Display type: link, document or pdf
Type:
- String
(inner) documentHtml :String
- Source:
The HTML representation of the document.
Type:
- String
(inner) documentName :String
- Source:
The name of the document.
Type:
- String
(inner) fileExtension :String
- Source:
The file extension of the document.
Type:
- String
(inner) mustRead :Boolean
- Source:
True if the user needs to scroll to the end of the document.
Type:
- Boolean
(inner) mustView :Boolean
- Source:
True if the user must view the document.
Type:
- Boolean
(inner) order :Number
- Source:
The order of document layout.
Type:
- Number
Methods
(static) constructFromObject(data, obj) → {module:model/Document}
- Source:
Constructs a Document from a plain JavaScript object, optionally creating a new instance.
Copies all relevant properties from data to obj if supplied or a new instance if not.
Parameters:
| Name | Type | Description |
|---|---|---|
data |
Object | The plain JavaScript object bearing properties of interest. |
obj |
module:model/Document | Optional instance to populate. |
Returns:
The populated Document instance.