Difference between revisions of "Common Methods Object"

From Hubitat Documentation
Jump to: navigation, search
Line 1: Line 1:
 
These methods can be used in both Apps and Drivers
 
These methods can be used in both Apps and Drivers
 +
 +
== <code>getLocation</code> ==
 +
 +
'''Signature:'''
 +
Location getLocation()
  
 
== <code>getTemperatureScale</code> ==
 
== <code>getTemperatureScale</code> ==
Line 15: Line 20:
  
 
: "F" or "C" based on the setting in the hub.
 
: "F" or "C" based on the setting in the hub.
 +
 +
== <code>now</code> ==
 +
 +
'''Signature:'''
 +
long now()
  
 
== <code>timeOfDayIsBetween</code> ==
 
== <code>timeOfDayIsBetween</code> ==

Revision as of 20:40, 5 October 2018

These methods can be used in both Apps and Drivers

getLocation

Signature:

Location getLocation()

getTemperatureScale

Gets the current temperature scale set for the hub.

Signature:

String getTemperatureScale()

Parameters:

none

Returns:

"F" or "C" based on the setting in the hub.

now

Signature:

long now()

timeOfDayIsBetween

Check if a date is between two dates.


Signature:

boolean timeOfDayIsBetween(Date start, Date stop, Date value[, TimeZone timeZone])

Parameters:

start - The date to start comparison against.
stop - The date to stop comparison against.
value - The date to compare
timezone - (Optional) The timezone to use for the comparison


Returns:

true if the value date is between the start and stop dates, otherwise returns false.


unschedule

Remove any scheduled tasks. If method is called without paramters, all schedules will be removed.

Signature:

void unschedule()
void unschedule(handlerMethod)

Parameters:

handlerMethod - Only remove schedules for this handlerMethod


asynchttpGet

Send an http GET request and return control to the calling code. Any response from the call will be passed to the callback method.

Signature:

void asynchttpGet(callbackMethod, Map params, Map data = null)

Parameters:

callbackMethod - The name of a callback method to send the response to. Can be null if the response can be ignored.
params - the parameters to use to build the http GET call.
data - optional data to be passed to the callback method.