Skip to content

docs(SmartApp): reference permissions/appId dependency #170

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
john-u merged 1 commit into from
Oct 26, 2020
Merged

docs(SmartApp): reference permissions/appId dependency #170

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions docs/classes/_smart_app_d_.smartapp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ ___
▸ **appId**(`id`: string): *[SmartApp](_smart_app_d_.smartapp.md)*

Set the app that this SmartApp object is implementing. This field
is necessary for any app that requires permissions in addition to those implied
is necessary for any app that requires [permissions](_smart_app_d_.smartapp.md#permissions) in addition to those implied
by the app configuration settings.

**Parameters:**
Expand Down Expand Up @@ -568,10 +568,9 @@ ___
▸ **page**(`id`: string, `callback`: function): *[SmartApp](_smart_app_d_.smartapp.md)*

Defines a configuration page that is displayed during app installation and update.
You can create as many pages as needed to satisfy your configuration needs. See the
the documentation on how to design pages for your automation.

https://smartthings.developer.samsung.com/docs/how-to/design-pages-smartapp.html
You can create as many pages as needed to satisfy your configuration needs. See the documentation on
[how to design pages](https://smartthings.developer.samsung.com/docs/how-to/design-pages-smartapp.html)
for your automation.

**Parameters:**

Expand All @@ -597,10 +596,13 @@ ___

▸ **permissions**(`value`: string | string[]): *[SmartApp](_smart_app_d_.smartapp.md)*

Specify of scopes explicitly required by this app. For example `['r:devices:*', and 'x:devices:*']
Specify the [OAuth2 scopes](https://smartthings.developer.samsung.com/docs/auth-and-permissions.html#OAuth2-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. You do not have to
provide this list for devices selected by the user in configuration settings.

If permissions are specified, [appId](_smart_app_d_.smartapp.md#appid) is also required.

**Parameters:**

Name | Type |
Expand Down
14 changes: 8 additions & 6 deletions lib/smart-app.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,7 @@ export class SmartApp {

/**
* Set the app that this SmartApp object is implementing. This field
* is necessary for any app that requires permissions in addition to those implied
* is necessary for any app that requires [[permissions]] in addition to those implied
* by the app configuration settings.
*
* @param id either the `App.appId` or `App.appName` field of your SmartApp
Expand Down Expand Up @@ -403,10 +403,9 @@ export class SmartApp {

/**
* Defines a configuration page that is displayed during app installation and update.
* You can create as many pages as needed to satisfy your configuration needs. See the
* the documentation on how to design pages for your automation.
*
* https://smartthings.developer.samsung.com/docs/how-to/design-pages-smartapp.html
* You can create as many pages as needed to satisfy your configuration needs. See the documentation on
* [how to design pages](https://smartthings.developer.samsung.com/docs/how-to/design-pages-smartapp.html)
* for your automation.
*/
page(id: string,
callback: (
Expand All @@ -415,9 +414,12 @@ export class SmartApp {
configData?: InstalledAppConfiguration) => HandlerResponse): SmartApp

/**
* Specify of scopes explicitly required by this app. For example `['r:devices:*', and 'x:devices:*']
* Specify the [OAuth2 scopes](https://smartthings.developer.samsung.com/docs/auth-and-permissions.html#OAuth2-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. You do not have to
* provide this list for devices selected by the user in configuration settings.
*
* If permissions are specified, [[appId]] is also required.
*/
permissions(value: string | string[]): SmartApp

Expand Down