Difference between revisions of "InstalledApp Object"
(fixed an example that was formatted incorrectly and documented most of the updateSetting overloads.) |
(Added getid documentation) |
||
| Line 1: | Line 1: | ||
| + | ===<code>getId</code>=== | ||
| + | : Returns the internal ID that represents the installed app in Hubitat. | ||
| + | |||
| + | :;Signature | ||
| + | :: <code>Long getId()</code> | ||
| + | |||
| + | :;Parameters | ||
| + | ::None | ||
| + | |||
| + | :;Returns | ||
| + | ::The internal ID of the current app. | ||
| + | |||
===<code>getInstallationState</code>=== | ===<code>getInstallationState</code>=== | ||
:Returns a value indicating whether the app is currently installed or, if you are in the initial setup, that it is not. | :Returns a value indicating whether the app is currently installed or, if you are in the initial setup, that it is not. | ||
| Line 61: | Line 73: | ||
void removeSetting(String name) | void removeSetting(String name) | ||
void clearSetting(String name) | void clearSetting(String name) | ||
| − | |||
Long getName() | Long getName() | ||
List<EventSubscriptionWrapper> getSubscriptions() | List<EventSubscriptionWrapper> getSubscriptions() | ||
Revision as of 16:47, 8 April 2020
Contents
getId
- Returns the internal ID that represents the installed app in Hubitat.
- Signature
Long getId()
- Parameters
- None
- Returns
- The internal ID of the current app.
getInstallationState
- Returns a value indicating whether the app is currently installed or, if you are in the initial setup, that it is not.
- Signature
String getInstallationState()
- Parameters
- None
- Returns
COMPLETEif the app is installed, otherwiseINCOMPLETE.
getLabel
- Get the current label of the installed app.
- Signature
String getLabel()
- Parameters
- None
- Returns
- The current label of the installed app
- Example
def appLabel = app.getLabel()
log.debug "app label is ${appLabel}"
updateLabel
- Update the label of the installed app
- Signature
- void updateLabel(String label)
- Parameters
- label - new label for installed app
- Returns
- None
updateSetting
- Updates the value of a setting (preference) to the specified value. If the setting does not exist, this method will create it.
- Signature
void updateSetting(String name, Long value)void updateSetting(String name, Boolean value)void updateSetting(String name, String value)void updateSetting(String name, Double value)void updateSetting(String name, Date value)void updateSetting(String name, List value)
- Parameters
- name - The name of the setting to update
- value - The value to store in the setting
- Returns
- None
Additional Methods to Document
void updateSetting(String name, Map options) void removeSetting(String name) void clearSetting(String name) Long getName() List<EventSubscriptionWrapper> getSubscriptions()
