Type Definitions
assetInfo
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
id |
number |
<optional> |
ID of the asset. |
name |
string | Name of the asset. |
It represents the asset information.
Type:
- object
dialogCloseCallback(data)
Parameters:
| Name | Type | Description |
|---|---|---|
data |
any | data send by app.dialog.closeDialog(data) call. see closeDialog * |
evalError
Properties:
| Name | Type | Description |
|---|---|---|
error |
scriptError | The exception message. |
Type:
- object
itemInfo
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
id |
number |
<optional> |
ID of the item. |
name |
string | Name of the item. |
It represents the asset information.
Type:
- object
projectLocation
Properties:
| Name | Type | Description |
|---|---|---|
path |
string | This path will point to the path of the project saved on disk except for the normal templates and read only projects. |
savedState |
boolean | This will be false if auto save has not saved the document, and true if auto save has saved the document, in other words path will be having the path for the auto saved document. |
isSaved |
boolean | This flag is true if the project we are referring to is saved on disk. In case of normal templates and Read Only projects this will always be FALSE. |
hasSourceFile |
boolean | This will be true for normal templates and Read Only projects i.e if the path of the source file is returned in the "sourceFilePath" parameter. |
sourceFilePath |
string | This will point to the path of the source file in case of read only projects and templates i.e on opening the normal templates and Read Only projects the unsaved copy of the project and template is created and the original file is closed. So in that case "sourceFilePath" refers to the original file. Moreover in this case "isSaved" flag will always be false. This will be valid only if hasSourceFile is true. |
Type:
- object
scriptCompletedCallback(response)
Parameters:
| Name | Type | Description |
|---|---|---|
response |
any | evalError | On success, the completion value of evaluating the given code. On failure response will be of type scriptError. |
scriptError
Properties:
| Name | Type | Description |
|---|---|---|
message |
string | The exception message. |
lineno |
number | The 1-based number of the line where the error occurred or 0 if the line number is unknown. |
columnNo |
number | The index within the line of the first character where the error occurred. |
resourceName |
string | Returns the resource name for the script from where the function causing the error originates. |
Type:
- object