|
|
| (15 intermediate revisions by 5 users not shown) |
| Line 1: |
Line 1: |
| − | ==Provided Methods==
| + | |
| − | ===<code>subscribe</code>===
| + | <big>'''We're moving!''' Please visit http://docs2.hubitat.com for the latest documentation.</big> |
| − | :Subscribe to events sent from a device, app or location.
| |
| | | | |
| − | :;Signature
| + | <big>This document is available at: http://docs2.hubitat.com/en/developer/app/app-object</big> |
| − | :: <code>void subscribe(Object thing, handlerMethod)</code>
| |
| − | :: <code>void subscribe(Object thing, String attributeName, handlerMethod, Map options = null)</code>
| |
| − | | |
| − | :;Parameters
| |
| − | ::thing - The device, installed app or location to subscribe to.
| |
| − | ::handlerMethod - The method to run when an event is received.
| |
| − | ::attributeName - The name of the attribute to subscribe to.
| |
| − | ::options - Optional values to configure the subscribe. Possible values:
| |
| − | :::''filterEvents'' - Used for device subscriptions. Set to false to receive all events, defaults to true and events that do not have a changed value will not be processed.
| |
| − | | |
| − | | |
| − | ===<code>unsubscribe</code>===
| |
| − | :Unsubscribe from events sent from a device or all event subscriptions.
| |
| − | | |
| − | :;Signature
| |
| − | :: <code>void unsubscribe()</code>
| |
| − | :: <code>void unsubscribe(DeviceWrapper device)</code>
| |
| − | :: <code>void unsubscribe(List<DeviceWrapper> deviceList)</code> | |
| − | :: <code>void unsubscribe(DeviceWrapper device, String attributeName)</code> (Since 2.0.7)
| |
| − | :: <code>void unsubscribe(List<DeviceWrapper> deviceList, String attributeName)</code> (Since 2.1.0)
| |
| − | :: <code>void unsubscribe(DeviceWrapper device, String attributeName, String handlerMethod)</code> (Since 2.1.0)
| |
| − | :: <code>void unsubscribe(List<DeviceWrapper> deviceList, String attributeName, String handlerMethod)</code> (Since 2.1.0)
| |
| − | :: <code>void unsubscribe(InstalledAppWrapper installedApp)</code> (Since 2.1.2)
| |
| − | :: <code>void unsubscribe(Location location)</code> (Since 2.1.2)
| |
| − | :: <code>void unsubscribe(Location location, String attributeName)</code> (Since 2.1.2)
| |
| − | :: <code>void unsubscribe(String handlerMethod)</code> (Since 2.1.2)
| |
| − | | |
| − | :;Parameters
| |
| − | ::device - The device to unsubscribe from.
| |
| − | ::deviceList - A list of devices to unsubscribe from.
| |
| − | ::attributeName - which attribute you want to unsubscribe from.
| |
| − | ::handlerMethod - The name of a method which was subscribed to a device event.
| |
| − | ::location - The location to unsubscribe from.
| |
| − | ::installedApp - The installed app to unsubscribe from.
| |
| − | | |
| − | :;Returns
| |
| − | ::None
| |
| − | | |
| − | ==User Defined Methods==
| |
| − | ===<code>installed</code>===
| |
| − | :This method is called when the app is first installed.
| |
| − | | |
| − | :;Signature
| |
| − | :: <code>void installed()</code>
| |
| − | | |
| − | ===<code>updated</code>===
| |
| − | :This method is called when the preferences of an installed app are updated.
| |
| − | | |
| − | :;Signature
| |
| − | :: <code>void updated()</code>
| |
| − | | |
| − | ===<code>uninstalled</code>===
| |
| − | :This method is called when the app is uninstalled. This method can be used to do any cleanup that is necessary.
| |
| − | | |
| − | :;Signature
| |
| − | :: <code>void uninstalled()</code>
| |
| − | | |
| − | == <code>Additional to be documented</code> ==
| |
| − | Map getState()
| |
| − | String getHubUID()
| |
| − | String getApiServerUrl()
| |
| − | String getFullApiServerUrl()
| |
| − | String apiServerUrl(String url)
| |
| − | String getLocalApiServerUrl()
| |
| − | String getFullLocalApiServerUrl()
| |
| − | String localApiServerUrl(String url)
| |
| − | String fullLocalApiServerUrl(String url)
| |
| − | void setLocationMode(String mode)
| |
| − | String createAccessToken()
| |
| − | void pause(Long millisecs)
| |
| − | InstalledAppWrapper getParent()
| |
| − | InstalledAppWrapper addChildApp(String namespace, String name, String label, Map properties = null)
| |
| − | void deleteChildApp(Long childAppId)
| |
| − | ChildDeviceWrapper getChildDevice(String deviceNetworkId)
| |
| − | List<ChildDeviceWrapper> getChildDevices()
| |
| − | List<ChildDeviceWrapper> getAllChildDevices()
| |
| − | ChildDeviceWrapper addChildDevice(String namespace, String typeName, String deviceNetworkId, Long hubId = null, Map properties = null)
| |
| − | void deleteChildDevice(String deviceNetworkId)
| |
| − | DeviceWrapper getSubscribedDeviceById(Long deviceId)
| |
| − | void sendEvent(Map properties)
| |
| − | void sendEvent(DeviceWrapper device, Map properties)
| |
| − | void sendEvent(String dni, Map properties)
| |
| − | List<Event> getLocationEventsSince(String attributeName, Date startDate, Map options = null)
| |
| − | void subscribe(Object thing, String attributeName, handlerMethod, Map options = null)
| |
| − | void subscribe(Object thing, handlerMethod)
| |
| − | void sendSms(String phone, String message)
| |
| − | void sendSmsMessage(String phone, String message)
| |
| − | List<InstalledApp> getAllChildApps()
| |
| − | List<InstalledApp> getChildApps()
| |
| − | InstalledAppWrapper getChildAppById(Long childAppId)
| |
| − | InstalledAppWrapper getChildAppByLabel(String childAppLabel)
| |
