Difference between revisions of "InstalledApp Object"

From Hubitat Documentation
Jump to: navigation, search
(Added getInstallationState and standardized formatting.)
 
(3 intermediate revisions by one other user not shown)
Line 1: Line 1:
===<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.
 
  
:;Signature
+
<big>'''We're moving!''' Please visit http://docs2.hubitat.com for the latest documentation.</big>
:: <code>String getInstallationState()</code>
 
  
:;Parameters
+
<big>
::None
+
This document is available at: http://docs2.hubitat.com/en/developer/app/installedapp-object
 
+
</big>
:;Returns
 
::<code>COMPLETE</code> if the app is installed, otherwise <code>INCOMPLETE</code>.
 
 
 
== <code>getLabel</code> ==
 
:Get the current label of the installed app.
 
 
 
:;Signature
 
:: <code>String getLabel()</code>
 
 
 
:;Parameters
 
::None
 
 
 
:;Returns
 
::The current label of the installed app
 
 
 
:;Example
 
::<code> def appLabel = app.getLabel()
 
log.debug "app label is ${appLabel}"</code>
 
 
 
 
 
=== <code>updateLabel</code> ===
 
:Update the label of the installed app
 
 
 
:;Signature
 
::void updateLabel(String label)
 
 
 
:;Parameters
 
::label - new label for installed app
 
 
 
:;Returns
 
::None
 
 
 
== <code>Additional Methods to Document</code> ==
 
void updateSetting(String name, Map options)
 
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)
 
void removeSetting(String name)
 
void clearSetting(String name)
 
Long getId()
 
Long getName()
 
List<EventSubscriptionWrapper> getSubscriptions()
 

Latest revision as of 19:39, 25 September 2022

We're moving! Please visit http://docs2.hubitat.com for the latest documentation.

This document is available at: http://docs2.hubitat.com/en/developer/app/installedapp-object