app.json File

Desk Phone API features described in this section are deprecated and supported only on the following models: D40, d45, d50, d60, d62, d65, d70

This file describes the application and provides specific settings used by the app engine. Every application must include an app.json file in its directory. The app.json file is a single file written in JSON notation. You must use double quotes to identify object keys and values in your app.json file.

Description

Required: The app.json file must contain the following information:

name 
The name of the app. This is how the app engine refers to the app. name must be 64 chars or less, and the first character must be a letter or a digit. The rest can be letters, digits, underscore, period, comma. We recommend all lowercase, but that's not required.

jsFiles 
The JavaScript file to load when the app starts. You may include multiple files, they are loaded and run in left-to-right order. It is not necessary to list language files here.

type 
The type of app, which is always foreground.

Also, this information can be included as appropriate:

displayName 
This is how the app name is displayed in various places (e.g., the Applications screen). If this is not included, name is used.

iconFile
Default icon file basename. The phone looks for D70.hello_world_icon.png first, on a D70, and likewise for other models. The icon can be dynamically set by the app instead (or in addition), but this file will be used when the app is not running.

hasIdle
Indicate true if the app supports an idle screen display mode. If you don't include this, or you indicate false, the app cannot use the idle screen. The digium.app.idleWindow object is created based on this.

hidden 
Indicate true if the app should not appear in the Applications screen. If you don't include this, or you indicate false, the app does appear in the Applications Screen.

Example

 {     "name": "helloworld",     "jsFiles": ["file1.js"],     "type": "foreground",     "displayName": "Hello, world!",     "iconFile"  : "hello_world_icon.png",     "hidden" : false,     "hasIdle": true }

 

Return to Documentation Home I Return to Sangoma Support