Phone API Reference - UI Core - digium.app.idleWindow

digium.app.idleWindow

 

A specially instantiated Group widget displayed on the phone's idle screen in place of the logo. This is only instantiated and available to the app after the property 'hasIdle' has been set to true in its app.json file.

Any widgets added to digium.app.idleWindow will be displayed in the logo area of the phone's home screen.

If multiple apps have provided idleWindow data, the phone will cycle through them at a rate defined by the idle_cycle_seconds setting in the phone's configuration.

Properties

Name 

Description 

Name 

Description 

hideBottomBar

Boolean value that allows the app, when in control of the idleWindow, to hide the clock display area. This changes the height value of the idleWindow Group which allots more space for use.

Basic Example:

digium.app.idleWindow.hideBottomBar = true; 

hideTopBar

Boolean value that allows the app, when in control of the idleWindow, to hide the presence status area (which displays Available, Do Not Disturb, etc.). This changes the height value of the idleWindow Group which allots more space for use.

Basic Example:

 digium.app.idleWindow.hideTopBar = true;

 

Return to Documentation Home I Return to Sangoma Support