|
|
(One intermediate revision by the same user not shown) |
Line 1: |
Line 1: |
− | ==Overview==
| + | |
− | The app definition provides the Hubitat Elevation hub with information about an App you wish to install.
| + | <big>'''We're moving!''' Please visit http://docs2.hubitat.com for the latest documentation.</big> |
| | | |
− | ==Structure==
| + | <big>This document is available at: http://docs2.hubitat.com/developer/app/definition</big> |
− | definition(
| |
− | ...
| |
− | )
| |
− | | |
− | ==Entries==
| |
− | :: author - The author of this app
| |
− | :: category - A category description of this app
| |
− | :: description - A text description of the app that is displayed in the popup when the '''Add User App'' button is clicked
| |
− | :: documentationLink - A link to the documentation for this app | |
− | :: iconUrl - Not currently used, should be set to an empty string
| |
− | :: iconX2Url - Not currently used, should be set to an empty string
| |
− | :: iconX3Url - Not currently used, should be set to an empty string
| |
− | :: importUrl - The URL where the Groovy code for this app can be found
| |
− | :: name - The name of the app
| |
− | :: namespace - The namespace within which the Groovy class for the application will be stored
| |
− | :: oauth - [true/false] - defines whether this app makes use of OAuth
| |
− | :: parent - If this is a child app, specifies the parent app in the format <code>namespace</code>:<code>app name</code>
| |
− | :: singleInstance - [true/false] - If set to true, on a single instance of this app can be installed. The default is false
| |
− | :: videoLink - A link to a video recording associated with this app
| |
− | | |
− | ==Example==
| |
− | definition(
| |
− | name: "My First App",
| |
− | namespace: "myfirstapp",
| |
− | author: "John Smith",
| |
− | description: "This is the first Hubitat app I've created",
| |
− | category: "General",
| |
− | iconUrl: "",
| |
− | iconX2Url: "",
| |
− | iconX3Url: ""
| |
− | )
| |