- apiUrl
- appId
- clientId
- clientSecret
- disableCustomDisplayName
- disableRemoveApp
- enableEventLogging
- firstPageId
- jsonSpace
- keyApiHost
- keyCacheTTL
- logUnhandledRejections
- logger
- permissions
- publicKey
- redirectUri
- refreshUrl
• apiUrl? : string
Specify an alternate base URL for SmartThings API calls. This value is only necessary for testing new API versions or non-production environments.
• appId? : string
The App.appId or unique App.appName field of your SmartApp. This field
is necessary for any app that requires permissions in addition to those implied
by the app configuration settings.
• clientId? : string
The client id used to refresh expired tokens
• clientSecret? : string
The client secret used to refresh expired tokens
• disableCustomDisplayName? : boolean
Disables the ability for users to rename the installed app instance in the configuration page. This may be desirable for singleton apps that can only be installed once per location. Apps that can be installed multiple times per location should not disable renaming, or the result will be multiple apps with the same name.
• disableRemoveApp? : boolean
Disables the button that allows users to remove the app from the configuration page.
• enableEventLogging? : boolean
Enables logging of all lifecycle events and responses
• firstPageId? : string
Sets the initial configuration page to be rendered when an app is installed or updated. If not specified then the first page defined will be rendered.
• jsonSpace? : number
The number of spaces to indent pretty-printed JSON log output. Setting this value to zero disables pretty-printing
• keyApiHost? : string
Specify an alternate key host URL for use in validating request signatures. This value is only necessary for testing new API versions or non-production environments.
• keyCacheTTL? : number
Time-to-live of the ST_PADLOCK keys in milliseconds. The default value is 86400000 (24 hours).
• logUnhandledRejections? : boolean
Catch and log any unhandled rejections. Defaults to true
• logger? : Logger
Overrides the default Winston event and error logger that writes to the console
• permissions? : string | string[]
List of scopes explicitly required by this app. For example `['r:devices:', and 'x:devices:'] to be able to read and control all devices in the location. Note that you do not have to provide this list for devices selected by the user in configuration settings.
• publicKey? : string
The public key to be used for signature verification of lifecycle event calls. Not necessary for apps that use ST_PADLOCK signatures.
• redirectUri? : string
The OAuth2 redirect uri used for API access integrations to SmartThings
• refreshUrl? : string
Specify an alternate OAuth2 refresh URL for API access apps. This value is only necessary for testing new API versions or non-production environments.