ApplicationDefines the application implemented in this project.
The Application object allows the developer to define a mobile application in a Convertigo Mobile project. Only one Application object can be associated with a Convertigo Project.
The Application object represents the mobile application developed in project’s resources. It takes place for the web mobile application as well as for the native device applications that are built using Convertigo Mobile Builder server, leading to the generation of mobile applications that can be installed on devices.
The Application object includes the Flash Update functionality. When mobile application pages and resources are changed on the Convertigo project, the Flash Update will automatically update them in the mobile applications installed on devices. This feature can be enabled or not.
Most properties of Application are taken into account at application build. They cannot be updated thanks to the Flash Update: the app needs to be built again and updated on stores when these properties are changed. It is also the case for the config.xml configuration file: if it is changed, it is taken into account only at application re-build.
Only the following Application properties are always directly updated at Flash Update:
• Enable Flash Update property,
• Flash Update requires user confirmation property,
• Application version property (only updated in JavaScript variable, accessible using C8O.getCordovaEnv("currentVersion"); method),
• Splashscreen hiding mode property,
• and Accessibility property.
Note: If no file content has been modified, the Flash Update does not detect that some updates were made. The following cases are not managed for the moment:
• When updating the Application version property: if no other file content is updated, the Flash Update does not detect this change and the new value is not updated. The value available in JavaScript expression C8O.getCordovaEnv("currentVersion"); remains the old one.
• When renaming or deleting file(s): if no other file content is updated, the file renaming or deletion is not detected by the Flash Update. These changes are not updated on mobile devices and the old files remain.
These limitations are due to the fact that the Flash Update relies for now on the update date of files. If you want one of these changes to be taken into account, update one of the project resource files and save this update. It will lead the Flash Update to detect that an update was made.
| Property | Type | Category | Description |
|---|---|---|---|
| Application ID | String | standard | Defines the mobile application ID. If empty, the mobile application ID is set by default to com.convertigo.mobile.<project_name>, with <project_name> the name of the Convertigo project. The mobile application ID is used to build the mobile applications on the Convertigo Mobile builder platform. Note: After the application is built, this value is available in client JavaScript code using the C8O.getCordovaEnv("applicationId"); method. |
| Application author email | String | standard | Defines the author email of the mobile application. When the mobile application is built, the Application author email property defines the built application author email in the build server. Note: After the application is built, this value is available in client JavaScript code using the C8O.getCordovaEnv("applicationAuthorEmail"); method. |
| Application author name | String | standard | Defines the author name of the mobile application. When the mobile application is built, the Application author name property defines the built application author name in the build server. Note: After the application is built, this value is available in client JavaScript code using the C8O.getCordovaEnv("applicationAuthorName"); method. |
| Application author website | String | standard | Defines the website URL of the mobile application’s author. When the mobile application is built, the Application author website property defines the built application author’s website URL in the build server. Note: After the application is built, this value is available in client JavaScript code using the C8O.getCordovaEnv("applicationAuthorWebsite"); method. |
| Application background color | String | standard | Defines the mobile application background color. |
| Application description | String | standard | Defines the short description of the mobile application. When the mobile application is built, the Application description property defines the built application short description in the build server. Note: After the application is built, this value is available in client JavaScript code using the C8O.getCordovaEnv("applicationDescription"); method. |
| Application icons | XMLVector | standard | Defines the mobile application icons. |
| Application name | String | standard | Defines the name used by the mobile application. When the mobile application is built, the Application name property defines the built application name, used to identify the application in the build server. Note: After the application is built, this value is available in client JavaScript code using the C8O.getCordovaEnv("applicationName"); method. Note that this property is also used to set the application name in a WEB / PWA application and will be displayed as a browser’s TAB name |
| Application theme color | String | standard | Defines the mobile application theme color. |
| Application version | String | standard | Defines the mobile application’s version. This property allows the project’s developer to set a version to the mobile application. It is used for the built mobile application. The version syntax should be of the following form: x.y.z, with x, y and z being numbers. If not, the value is automatically transformed to an x.y.z version. For example, “2” will be transformed to “2.0.0”, “3.1” to “3.1.0”, “3.1.4_beta” to “3.1.4”. If left empty, the version of the parent Project is used. Note: After the application is built, this value is available in client JavaScript code using the C8O.getCordovaEnv("builtVersion"); method. If this value is updated thanks to the Flash Update, the current version (not from build) is available in client JavaScript code using the C8O.getCordovaEnv("currentVersion"); method. |
| Comment | String | standard | Describes the object comment to include in the documentation report. This property generally contains an explanation about the object. |
| Convertigo server endpoint | String | standard | Defines the URL of the Convertigo server used by the mobile application. The Convertigo server endpoint property defines the accessible URL of the Convertigo server where the project is deployed. This Convertigo server needs to be accessed by the mobile application after installation on devices. If this property is left empty, the default value is set to http://<current_Convertigo_host:port>/<Convertigo_webapp_name>, with: • <current_Convertigo_host:port> being the host name or IP address, plus port number, of the Convertigo server currently accessed, • <Convertigo_webapp_name> being the current Convertigo webapp name (for example convertigo for Studio or on-premises Server, cems for Cloud Server). Note: After the application is built, this value is available in client JavaScript code using the C8O.getCordovaEnv("endPoint"); method. |
| Enable Flash Update | boolean | standard | Defines whether the Flash Update feature is enabled for this mobile application. The Flash Update feature allows the mobile application to be notified when updates have been deployed on the server. The installed applications on mobile devices are then be automatically updated. The Enable Flash Update property can be set to true, enabling the Flash Update, or to false, disabling the Flash Update. Default value is true. Note: When this property is changed, the built applications already installed on devices will automatically take the new value into account, allowing the developer to switch between Flash Update modes without building again the app and re-deploying it on the stores. |
| Splashscreen hiding mode | SplashRemoveMode | standard | Defines the hiding mode of the mobile application’s splashscreen. This property allows the project’s developer to configure how and when the application splashscreen has to be hidden. This property can take the following values: • Before Flash Update: The application’s splashscreen is automatically hidden by the C8O JavaScript library, before the Flash Update starts. The Flash Update page is visible in the mobile application and then redirects to the application pages. • After Flash Update: The application’s splashscreen is automatically hidden by the C8O JavaScript library, after the Flash Update starts. The Flash Update page is not visible in the mobile application, masked by the splashscreen. The splashscreen is hidden when the library redirects to the application pages. • Manual: The application’s splashscreen is not automatically hidden by the C8O JavaScript library. The splashscreen must be explicitely hidden by the mobile application JavaScript code, using: C8O.splashscreenHide(); method. For Android platform, the config.xml file can declare a timeout for splashscreen hiding: SplashScreenDelay. Note: The C8O JavaScript API includes two methods to manipulate the splashscreen directly in application JavaScript code: • C8O.splashscreenShow(); allows to show the splashscreen, • C8O.splashscreenHide(); allows to hide the splashscreen. |
| Accessibility | Accessibility | expert | Defines the mobile application’s accessibility. This property can take the following values: • Public: The mobile application is runnable from everyone, it is visible in the Test Platform and it can be built. This is the default value. • Hidden: The mobile application is runnable but only from people who know the execution URL, it is not visible in the Test Platform so cannot be built, excepted for people who are identified in the Test Platform as administrator. • Private: The mobile application is only runnable from people who are identified in the Test Platform as administrator, it is not visible in the Test Platform and cannot be built, excepted for people who are identified in the Test Platform as administrator. Note: In the Test Platform: • The administrator user (authenticated in Administration Console or Test Platform) can see, run and build all mobile applications, no matter what their Accessibility is. • The test user (authenticated in the Test Platform or in case of anonymous access) can see, run and build public mobile applications and run hidden ones if he knows their execution URL. |
| Flash Update build mode | FlashUpdateBuildMode | expert | Defines the mobile application build mode. The mobile application can be built empty for installation on devices or already containing the all user interface. The Build mode property can take one of the following values: • full: the built mobile application will contain all the user interface and resources, • light: the built mobile application is a shell that will download the user interface and resources at first launch. In this case, the Flash Update feature should be enabled thanks to the Enable Flash Update property, otherwise, the UI and resources will not be downloaded and the app will remain empty. |
| Flash Update requires user confirmation | boolean | expert | Defines if the Flash Update feature requires the user confirmation. When the Flash Update feature is enabled thanks to the Enable Flash Update property, the Flash Update requires user confirmation property allows to define whether the application update is done automatically at application startup (property set to false), or after a confirmation from the mobile application’s user (property set to true). Default value is false, which sets the Flash Update to be automatic. Note: When this property is changed, the built applications already installed on devices will automatically take the new value into account, allowing the developer to switch between Flash Update modes without building again the app and re-deploying it on the stores. |
| Flash Update timeout | long | expert | Defines the maximum time (in ms) for Flash Update to check for application resource updates. If the timeout is reached, the Flash Update automatically redirects to the local application without update. An infinite timeout can be defined by setting this property to 0: the Flash Update will wait endlessly for updates. In case of network failure (no connection to network from the device, HTTP error from server, etc.), the timeout is not used and the Flash Update automatically redirects to the local application. |
| Mobile builder authentication token | String | expert | Defines the authentication token of the Mobile builder account to use to build the mobile application. When building a mobile application, a Mobile builder account (which is nothing more than a PhoneGap build account) is mandatory. Convertigo provides one by default, used by default in Convertigo engine. This default Mobile builder authentication token can be configured at engine level, in the Mobile builder tab of the Administration Console’s Configuration page. This engine level authentication token will be used by default for all mobile applications built by the Convertigo. The Mobile builder authentication token property allows to override the Mobile builder authentication token for this mobile application’s build. If left empty, the common Mobile builder authentication token defined at Convertigo engine level is used. Note: Once a PhoneGap build account is configured thanks to the Mobile builder authentication token, do not forget to configure all mobile platforms certificates and keys in accordance. Refer to the documentation of each platform object for more information. |