A settings page a repository app registers for its admin configuration screen, pairing a template path with either a named or an actual JavaScript function that processes submitted form data. Registered through ControllerMappingList and read back by RepositoryApp to render and process the app's settings.
Implements: Serializable
Properties
| Property | Returns | Description |
|---|---|---|
| enabled | boolean | Whether this is the settings page currently in use for the app. Only one registered settings page is enabled at a time. |
| function | String | Name of the JavaScript function that processes this settings page's submitted form data, or null if the settings were registered with an actual function pointer instead. |
| functionPtr | VarArgFunction | The actual JavaScript function that processes this settings page's submitted form data, or null if the settings were registered with a function name instead. |
| path | String | Repository path of the template that renders this settings page. |
Methods
getPath()
Returns: String
Repository path of the template that renders this settings page.
isEnabled()
Returns: boolean
Whether this is the settings page currently in use for the app. Only one registered settings page is enabled at a time.
getFunction()
Returns: String
Name of the JavaScript function that processes this settings page's submitted form data, or null if the settings were registered with an actual function pointer instead.
getFunctionPtr()
Returns: VarArgFunction
The actual JavaScript function that processes this settings page's submitted form data, or null if the settings were registered with a function name instead.