Class: WebInterface
WebInterface
new WebInterface()
Create a new instance of Web Interface
Properties:
| Name | Type | Description |
|---|---|---|
i18n |
I18n | the web interface's internationalization. |
summary |
String | the web interface's summary. |
summaryType |
String | The type of summary string. |
author |
User | the web interface's user. |
title |
String | the title of the web interface. |
rights |
String | the rights of the web interface. |
categories |
Array | the categories of the web interface. |
links |
Array | the links of the web interface. |
project |
Project | the project associated to the web interface. |
content |
String | the content of the web interface. |
contentType |
String | the content type of the content. |
targetProcess |
Process | the target process associated to the web interface. |
css |
Array | a list of style sheets. |
stylesheet_web |
String | the web style sheet of the web interface. |
headerTitle |
String | the header title of the web interface. |
portalAccept |
String | the acceptance of the web interface. |
users |
Array | the users associated. |
type |
String | the type of the web interface. |
tags |
Array | a list of tags associated to the web interface. |
updated |
Date | the date updated. |
published |
Date | the date published. |
Source: Project/WebInterface.js, line 48
See:
Methods
create()
Create a new WebInterface.
Parameters:
| Name | Type | Description |
|---|---|---|
options.onSuccess |
Resource~onSuccess | a callback function called in case of a success |
options.onFailure |
Resource~onFailure | a callback function called in case of a failure |
options.baseUrl |
String | base URL. If not set the current base URL will be used |
Source: Project/WebInterface.js, line 174
See:
generate_xml(options)
generate xml to create/update
Parameters:
| Name | Type | Description |
|---|---|---|
options |
object | options to be used during the call |
update |
Boolean | Is this an xml for update |
baseUrl |
String | base URL. If not set the current base URL will be used |
Source: Project/WebInterface.js, line 322
See:
generateUrl()
Overrides Resource's generateUrl method to return the request url
Source: Project/WebInterface.js, line 88
See:
loadPreset()
Overrides Resource's loadPreset method.
Source: Project/WebInterface.js, line 82
See:
loadSet(rObject)
Overrides Resource's loadSet method to set local variables after request.
Parameters:
| Name | Type | Description |
|---|---|---|
rObject |
json | JSON representation of the loaded data. |
Source: Project/WebInterface.js, line 98
See:
update()
Save a new WebInterface.
Parameters:
| Name | Type | Description |
|---|---|---|
options.onSuccess |
Resource~onSuccess | a callback function called in case of a success |
options.onFailure |
Resource~onFailure | a callback function called in case of a failure |
options.baseUrl |
String | base URL. If not set the current base URL will be used |
Source: Project/WebInterface.js, line 255
See: