Difference between revisions of "Common Methods Object"

From Hubitat Documentation
Jump to: navigation, search
Line 78: Line 78:
 
::''contentType'' - The content-type used for any data in the request body, as well as the <code>Accept</code> content-type that will be used for parsing the response.
 
::''contentType'' - The content-type used for any data in the request body, as well as the <code>Accept</code> content-type that will be used for parsing the response.
 
::''requestContentType'' - Assign a different content-type for the request than is expected for the response.
 
::''requestContentType'' - Assign a different content-type for the request than is expected for the response.
−
::timeout (since 2.0.9) - timeout in seconds for the request, max timeout is 300
+
::''timeout'' (since 2.0.9) - timeout in seconds for the request, max timeout is 300
 
:data - optional data to be passed to the callback method.
 
:data - optional data to be passed to the callback method.
  
Line 98: Line 98:
 
::''timeout'' (since 2.0.9) - timeout in seconds for the request, max timeout is 300
 
::''timeout'' (since 2.0.9) - timeout in seconds for the request, max timeout is 300
 
:data - optional data to be passed to the callback method.
 
:data - optional data to be passed to the callback method.
 +
 +
==<code>httpGet</code>==
 +
 +
Send an http GET request.  Any response from the call will be passed to the closure.
 +
 +
'''Signature:'''
 +
void httpGet(String uri, Closure closure)
 +
void httpGet(Map params, Closure closure)
 +
 +
'''Parameters:'''
 +
:uri - The full uri to send the request to.
 +
:params - the parameters to use to build the http GET call. Possible values:
 +
::''uri'' - The uri to send the request to
 +
::''queryString'' - The raw, already-escaped query string.
 +
::''query'' - Add these parameters to the existing query string. If any of the parameters already exist in the query, these values will not replace them.  Multiple values for the same query parameter may be added by putting them in a list.
 +
::''headers'' - Request headers
 +
::''path'' - The path component of this request.  The value may be absolute or relative to the current path.
 +
::''contentType'' - The content-type used for any data in the request body, as well as the <code>Accept</code> content-type that will be used for parsing the response.
 +
::''requestContentType'' - Assign a different content-type for the request than is expected for the response.
 +
::''timeout'' (since 2.0.9) - timeout in seconds for the request, max timeout is 300
 +
:closure - code to handle a successful HTTP response. an object of type HttpResponseDecorator is passed to this code.
 +
 +
==<code>httpPost</code>==
 +
'''Signature:'''
 +
void httpPost(String uri, String body, Closure closure)
 +
void httpPost(Map params, Closure closure)
 +
 +
'''Parameters:'''
 +
:uri - The full uri to send the request to.
 +
:body - The body of the request.
 +
:params - the parameters to use to build the http GET call. Possible values:
 +
::''uri'' - The uri to send the request to
 +
::''queryString'' - The raw, already-escaped query string.
 +
::''query'' - Add these parameters to the existing query string. If any of the parameters already exist in the query, these values will not replace them.  Multiple values for the same query parameter may be added by putting them in a list.
 +
::''headers'' - Request headers
 +
::''path'' - The path component of this request.  The value may be absolute or relative to the current path.
 +
::''contentType'' - The content-type used for any data in the request body, as well as the <code>Accept</code> content-type that will be used for parsing the response.
 +
::''requestContentType'' - Assign a different content-type for the request than is expected for the response.
 +
::''body'' - The request body
 +
::''timeout'' (since 2.0.9) - timeout in seconds for the request, max timeout is 300
 +
:closure - code to handle a successful HTTP response. an object of type HttpResponseDecorator is passed to this code.
  
 
==<code>runInMillis</code>==
 
==<code>runInMillis</code>==
Line 129: Line 170:
 
  BigDecimal celsiusToFahrenheit(BigDecimal val)
 
  BigDecimal celsiusToFahrenheit(BigDecimal val)
 
  BigDecimal fahrenheitToCelsius(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, String body, Closure closure)
 
  void httpPutJson(String uri, Map body, Closure closure)
 
  void httpPutJson(String uri, Map body, Closure closure)

Revision as of 20:21, 16 April 2019

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. Possible values:
uri - The uri to send the request to
queryString - The raw, already-escaped query string.
query - Add these parameters to the existing query string. If any of the parameters already exist in the query, these values will not replace them. Multiple values for the same query parameter may be added by putting them in a list.
headers - Request headers
path - The path component of this request. The value may be absolute or relative to the current path.
contentType - The content-type used for any data in the request body, as well as the Accept content-type that will be used for parsing the response.
requestContentType - Assign a different content-type for the request than is expected for the response.
timeout (since 2.0.9) - timeout in seconds for the request, max timeout is 300
data - optional data to be passed to the callback method.

asynchttpPost

Signature: 

void asynchttpPost(String callbackMethod = null, 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. Possible values:
uri - The uri to send the request to
queryString - The raw, already-escaped query string.
query - Add these parameters to the existing query string. If any of the parameters already exist in the query, these values will not replace them. Multiple values for the same query parameter may be added by putting them in a list.
headers - Request headers
path - The path component of this request. The value may be absolute or relative to the current path.
contentType - The content-type used for any data in the request body, as well as the Accept content-type that will be used for parsing the response.
requestContentType - Assign a different content-type for the request than is expected for the response.
body - The request body
timeout (since 2.0.9) - timeout in seconds for the request, max timeout is 300
data - optional data to be passed to the callback method.

httpGet

Send an http GET request. Any response from the call will be passed to the closure.

Signature: 

void httpGet(String uri, Closure closure)
void httpGet(Map params, Closure closure)

Parameters:

uri - The full uri to send the request to.
params - the parameters to use to build the http GET call. Possible values:
uri - The uri to send the request to
queryString - The raw, already-escaped query string.
query - Add these parameters to the existing query string. If any of the parameters already exist in the query, these values will not replace them. Multiple values for the same query parameter may be added by putting them in a list.
headers - Request headers
path - The path component of this request. The value may be absolute or relative to the current path.
contentType - The content-type used for any data in the request body, as well as the Accept content-type that will be used for parsing the response.
requestContentType - Assign a different content-type for the request than is expected for the response.
timeout (since 2.0.9) - timeout in seconds for the request, max timeout is 300
closure - code to handle a successful HTTP response. an object of type HttpResponseDecorator is passed to this code.

httpPost

Signature: 

void httpPost(String uri, String body, Closure closure)
void httpPost(Map params, Closure closure)

Parameters:

uri - The full uri to send the request to.
body - The body of the request.
params - the parameters to use to build the http GET call. Possible values:
uri - The uri to send the request to
queryString - The raw, already-escaped query string.
query - Add these parameters to the existing query string. If any of the parameters already exist in the query, these values will not replace them. Multiple values for the same query parameter may be added by putting them in a list.
headers - Request headers
path - The path component of this request. The value may be absolute or relative to the current path.
contentType - The content-type used for any data in the request body, as well as the Accept content-type that will be used for parsing the response.
requestContentType - Assign a different content-type for the request than is expected for the response.
body - The request body
timeout (since 2.0.9) - timeout in seconds for the request, max timeout is 300
closure - code to handle a successful HTTP response. an object of type HttpResponseDecorator is passed to this code.

runInMillis

Signature: 

void runInMillis(Long delayInMilliSeconds, String handlerMethod, Map options = null)

Parameters:

delayInMilliseconds - How long to wait until the handler should be called, don't expect that it will be called in exactly that time.
handlerMethod - the name of a handler method in your driver or app. The method name should not contain parentheses.
options - a Map of optional parameters. If you specify [data: 'Some value'] then 'Some value' will be passed to your handler method. You can pass lists, maps etc. as a data parameter.

Example: 

  private processQueue(Map queue) {
    if (isQueueEmpty(queue)) {
        sendEvent name: 'lifxdiscovery', value: 'complete'
        return
    }
    def data = getNext(queue)
    sendPacket data.ipAddress, data.packet
    runInMillis(queue.delay, 'processQueue', [data: queue])
  }
  
  runInMillis(50, 'processQueue', [data: queue])

Additional to be documented

Signature: 

BigDecimal celsiusToFahrenheit(BigDecimal val)
BigDecimal fahrenheitToCelsius(BigDecimal val)
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 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 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 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)
Retrieved from "https://docs.hubitat.com/index.php?title=Common_Methods_Object&oldid=1849"