Skip to content

Commit c0e927c

Browse files
authored
docs(SmartApp): reference permissions/appId dependency (#170)
1 parent 31fda0d commit c0e927c

File tree

2 files changed

+16
-12
lines changed

2 files changed

+16
-12
lines changed

docs/classes/_smart_app_d_.smartapp.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ ___
102102
**appId**(`id`: string): *[SmartApp](_smart_app_d_.smartapp.md)*
103103

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

108108
**Parameters:**
@@ -568,10 +568,9 @@ ___
568568
**page**(`id`: string, `callback`: function): *[SmartApp](_smart_app_d_.smartapp.md)*
569569

570570
Defines a configuration page that is displayed during app installation and update.
571-
You can create as many pages as needed to satisfy your configuration needs. See the
572-
the documentation on how to design pages for your automation.
573-
574-
https://smartthings.developer.samsung.com/docs/how-to/design-pages-smartapp.html
571+
You can create as many pages as needed to satisfy your configuration needs. See the documentation on
572+
[how to design pages](https://smartthings.developer.samsung.com/docs/how-to/design-pages-smartapp.html)
573+
for your automation.
575574

576575
**Parameters:**
577576

@@ -597,10 +596,13 @@ ___
597596

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

600-
Specify of scopes explicitly required by this app. For example `['r:devices:*', and 'x:devices:*']
599+
Specify the [OAuth2 scopes](https://smartthings.developer.samsung.com/docs/auth-and-permissions.html#OAuth2-scopes)
600+
explicitly required by this app. For example `['r:devices:*', and 'x:devices:*']
601601
to be able to read and control all devices in the location. You do not have to
602602
provide this list for devices selected by the user in configuration settings.
603603

604+
If permissions are specified, [appId](_smart_app_d_.smartapp.md#appid) is also required.
605+
604606
**Parameters:**
605607

606608
Name | Type |

lib/smart-app.d.ts

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,7 @@ export class SmartApp {
221221

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

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

417416
/**
418-
* Specify of scopes explicitly required by this app. For example `['r:devices:*', and 'x:devices:*']
417+
* Specify the [OAuth2 scopes](https://smartthings.developer.samsung.com/docs/auth-and-permissions.html#OAuth2-scopes)
418+
* explicitly required by this app. For example `['r:devices:*', and 'x:devices:*']
419419
* to be able to read and control all devices in the location. You do not have to
420420
* provide this list for devices selected by the user in configuration settings.
421+
*
422+
* If permissions are specified, [[appId]] is also required.
421423
*/
422424
permissions(value: string | string[]): SmartApp
423425

0 commit comments

Comments
 (0)