Difference between revisions of "Common Methods Object"

From Hubitat Documentation
Jump to: navigation, search
(timeOfDayIsBetween)
Line 10: Line 10:
  
 
'''Parameters:'''
 
'''Parameters:'''
 +
 
start - The date to start comparison against.
 
start - The date to start comparison against.
 +
 
stop - The date to stop comparison against.
 
stop - The date to stop comparison against.
 +
 
value - The date to compare
 
value - The date to compare
 +
 
timezone - (Optional) The timezone to use for the comparison
 
timezone - (Optional) The timezone to use for the comparison
  
 
'''Returns:'''
 
'''Returns:'''
 
true if the value date is between the start and stop dates, otherwise returns false.
 
true if the value date is between the start and stop dates, otherwise returns false.

Revision as of 18:32, 9 September 2018

These methods can be used in both Apps and Drivers

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.