Defines an app installation page. App pages are composed of one or more sections, with each section being composed of one or more settings.
▸ complete(value: boolean): Page
Mark this page as complete, which renders a Done button that initiates the installation or update process.
Parameters:
| Name | Type |
|---|---|
value |
boolean |
Returns: Page
▸ defaultRequired(value: boolean): Page
Make all settings on this page required by default. Individual settings can be made optional.
Parameters:
| Name | Type |
|---|---|
value |
boolean |
Returns: Page
▸ name(value: string): Page
Sets the name of the page. Not normally necessary when using the i18n localization framework unless you need to set to set the name of the page to a non-localized value such as a room name.
Parameters:
| Name | Type |
|---|---|
value |
string |
Returns: Page
▸ nextPageId(value: string): Page
Sets the next page in a multi-page app configuration
Parameters:
| Name | Type |
|---|---|
value |
string |
Returns: Page
▸ nextText(value: string): Page
Set the text of the next page link (defaults to "Next"). Only applies if style is SPLASH
Parameters:
| Name | Type |
|---|---|
value |
string |
Returns: Page
▸ previousPageId(value: string): Page
Sets the previous page in a multi-page app configuration
Parameters:
| Name | Type |
|---|---|
value |
string |
Returns: Page
▸ section(name: string, closure: function): Page
Create a new page section
Parameters:
▪ name: string
the name of the section. All page section names should be unique. The section name is used in generating an i18n key to support localized section names
▪ closure: function
code block that defines the settings within the section
▸ (section: Section): void | Promise‹void›
Parameters:
| Name | Type |
|---|---|
section |
Section |
Returns: Page
▸ style(value: PageStyle): Page
Set the style of this page
Parameters:
| Name | Type |
|---|---|
value |
PageStyle |
Returns: Page