Phone API Reference - UI Core - window

Owned by Kelli Higdon
Last updated: Feb 28, 2024
1 min read

window

 

Automatically instantiated Group widget available to each app.

The window object is the group that is displayed when the app is in the foreground and its height and width proprerties are equal to the max for your phone's model. It shares most of its methods and properties with the Group widget. Adding other widgets to window will cause them to be displayed on the screen when the app is in the foreground.

Any app that wishes to display something after being put in the foreground must begin by attaching things to the window object.

Methods

Name 

Description 

Name 

Description 

add

Adds one or more widgets to the group.

clear

Removes all child elements from the group or removes all content from the list.

remove

Removes one or more widgets from a group.

Properties

Name 

Description 

Name 

Description 

showSoftkeys 

Boolean value that determines whether the softkey bar will be displayed. Can be set to false to allow drawing to the entire screen.

Note: actions assigned to softkeys will still be performed when the softkey bar is hidden.

 

Return to Documentation Home I Return to Sangoma Support