|
|
| (39 intermediate revisions by 7 users not shown) |
| Line 1: |
Line 1: |
| − | These methods can be used in both Apps and Drivers
| |
| | | | |
| − | == <code>getLocation</code> ==
| + | <big>'''We're moving!''' Please visit http://docs2.hubitat.com for the latest documentation.</big> |
| | | | |
| − | '''Signature:'''
| + | <big> |
| − | Location getLocation()
| + | This document is available at: http://docs2.hubitat.com/en/developer/common-methods-object |
| − | | + | </big> |
| − | == <code>getTemperatureScale</code> ==
| |
| − | | |
| − | 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.
| |
| − | | |
| − | == <code>now</code> ==
| |
| − | | |
| − | '''Signature:'''
| |
| − | long now()
| |
| − | | |
| − | == <code>timeOfDayIsBetween</code> ==
| |
| − | | |
| − | 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.
| |
| − | | |
| − | | |
| − | == <code>unschedule</code> ==
| |
| − | | |
| − | 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
| |
| − | | |
| − | | |
| − | | |
| − | == <code>asynchttpGet</code> ==
| |
| − | | |
| − | 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.
| |
| − | | |
| − | == <code>Additional to be documented</code> ==
| |
| − | | |
| − | '''Signature:'''
| |
| − | BigDecimal celsiusToFahrenheit(BigDecimal val)
| |
| − | BigDecimal fahrenheitToCelsius(BigDecimal val)
| |
| − | void httpGet(String uri, Closure closure)
| |
| − | void httpGet(Map params, Closure closure)
| |
| − | void httpPost(String uri, String body, Closure closure)
| |
| − | void httpPost(Map params, Closure closure)
| |
| − | void httpPutJson(String uri, String body, Closure closure)
| |
| − | void httpPutJson(String uri, Map body, Closure closure)
| |
| − | void httpPutJson(Map params, Closure closure)
| |
| − | void httpPut(String uri, String body, Closure closure)
| |
| − | void httpPut(Map params, Closure closure)
| |
| − | void httpDelete(Map params, Closure closure)
| |
| − | String getMACFromIP(String ipAddr)
| |
| − | String convertTemperatureIfNeeded(BigDecimal value, String scale, Integer precision)
| |
| − | Object parseJson(String stringToParse)
| |
| − | GPathResult parseXML(String stringToParse)
| |
| − | Map parseLanMessage(String stringToParse)
| |
| − | void pauseExecution(Long millisecs)
| |
| − | void runEvery1Minute(String handlerMethod, Map options = null)
| |
| − | void runEvery5Minutes(String handlerMethod, Map options = null)
| |
| − | void runEvery10Minutes(String handlerMethod, Map options = null)
| |
| − | void runEvery15Minutes(String handlerMethod, Map options = null)
| |
| − | void runEvery30Minutes(String handlerMethod, Map options = null)
| |
| − | void runEvery1Hour(String handlerMethod, Map options = null)
| |
| − | void runEvery3Hours(String handlerMethod, Map options = null)
| |
| − | void runIn(Long delayInSeconds, String handlerMethod, Map options = null)
| |
| − | void runInMillis(Long delayInMilliSeconds, String handlerMethod, Map options = null)
| |
| − | void runOnce(Date dateTime, String handlerMethod, Map options = null)
| |
| − | void runOnce(String dateTime, String handlerMethod, Map options = null)
| |
| − | void schedule(Date dateTime, String handlerMethod, Map options = null)
| |
| − | void schedule(String expression, String handlerMethod, Map options = null)
| |
| − | void asynchttpGet(String callbackMethod = null, Map params, Map data = null)
| |
| − | void asynchttpPost(String callbackMethod = null, Map params, Map data = null)
| |
| − | void asynchttpPut(String callbackMethod = null, Map params, Map data = null)
| |
| − | void asynchttpDelete(String callbackMethod = null, Map params, Map data = null)
| |
| − | void asynchttpPatch(String callbackMethod = null, Map params, Map data = null)
| |
| − | void asynchttpHead(String callbackMethod = null, Map params, Map data = null)
| |
| − | Map textToSpeech(String stringToBeSynthesized, String voice = null)
| |
| − | String encrypt(String value)
| |
| − | String decrypt(String value)
| |
| − | void sendLocationEvent(Map properties)
| |
| − | void removeLocationVariable(String name)
| |
| − | void createLocationVariable(String name, List values = null,boolean readOnly = false)
| |
| − | List getLocationVariableNames()
| |
| − | List getLocationVariableValues(String locationVariable)
| |
| − | void httpPostJson(String uri, String body, Closure closure)
| |
| − | void httpPostJson(String uri, Map body, Closure closure)
| |
| − | void httpPostJson(Map params, Closure closure)
| |
| − | Date timeToday(String timeString, TimeZone timeZone = null)
| |
| − | Date toDateTime(String dateTimeString)
| |
