Skip to content

Commit 9812eaa

Browse files
john-ujohn-u
authored
docs: deprecate color setting and fix typos (#203)
1 parent 5fd5479 commit 9812eaa

35 files changed

+55
-52
lines changed

‎docs/classes/_pages_color_setting_d_.colorsetting.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# ColorSetting
44

5-
NOT IMPLEMENTED
5+
**`deprecated`** Not currently implemented
66

77
## Methods
88

‎docs/classes/_pages_email_setting_d_.emailsetting.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# EmailSetting
44

5-
An email setting creates an input box with a keyboard appropriate for the entry of email addresses
5+
An email setting creates an input box with a keyboard appropriate for the entry of email addresses.
66
```
77
section.emailSetting("emailAddress")
88
```

‎docs/classes/_pages_enum_setting_d_.enumsetting.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ section.enumSetting('groupedEnum')
4747
{id:'red', name:'Red'},
4848
{id:'yellow', name:'Yellow'},
4949
{id:'blue', name:'Blue'}]},
50-
{name: 'primaryColors', options: [
50+
{name: 'secondaryColors', options: [
5151
{id:'green', name:'Green'},
5252
{id:'orange', name:'Orange'},
5353
{id:'purple', name:'Purple'}]},
@@ -213,7 +213,7 @@ ___
213213

214214
▸ **multiple**(`value`: boolean): *[EnumSetting](_pages_enum_setting_d_.enumsetting.md)*
215215

216-
Specifies whether this device setting can have multiple values.
216+
Specifies whether this enum setting can have multiple values.
217217

218218
**Parameters:**
219219

‎docs/classes/_pages_image_setting_d_.imagesetting.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# ImageSetting
44

5-
An image settings simply displays an image on the configuration page. There is no user input involved.
5+
An image setting simply displays an image on the configuration page. There is no user input involved.
66
```
77
section.imageSetting('banner')
88
.image('https://mysite/image.png')

‎docs/classes/_pages_images_setting_d_.imagessetting.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# ImagesSetting
44

5-
An images settings displays a carousel of images on the configuration page. There is no user input involved.
5+
An images setting displays a carousel of images on the configuration page. There is no user input involved.
66
```
77
section.imageSetting('banner')
88
.images(['https://mysite/image.png', 'https://mysite/image2.png', 'https://mysite/image3.png')

‎docs/classes/_pages_link_setting_d_.linksetting.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# LinkSetting
44

5-
A link setting display a hypertext link that opens an external web page in a browser window. It
5+
A link setting displays a hypertext link that opens an external web page in a browser window. It
66
does not replace the current configuration page window.
77
```
88
section.linkSetting('moreInfo')

‎docs/classes/_pages_mode_setting_d_.modesetting.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22

33
# ModeSetting
44

5-
A device setting creates a control that allows the user to select one or more location modes. To allow the selection
5+
A mode setting creates a control that allows the user to select one or more location modes. To allow the selection
66
of only one mode:
77
```
88
section.modeSetting('targetMode')
99
```
10-
The allow the selection of more than one mode:
10+
To allow the selection of more than one mode:
1111
```
1212
section.modeSetting('permittedModes').multiple(true)
1313
```
@@ -100,7 +100,7 @@ ___
100100

101101
▸ **multiple**(`boolean`: true): *[ModeSetting](_pages_mode_setting_d_.modesetting.md)*
102102

103-
Specifies whether this device setting can have multiple values.
103+
Specifies whether this mode setting can have multiple values.
104104

105105
**Parameters:**
106106

‎docs/classes/_pages_page_d_.page.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ ___
8686

8787
▸ **nextText**(`value`: string): *[Page](_pages_page_d_.page.md)*
8888

89-
Set the text of the next page link. Defaults to "Next"
89+
Set the text of the next page link (defaults to "Next"). Only applies if style is `SPLASH`
9090

9191
**Parameters:**
9292

‎docs/classes/_pages_page_setting_d_.pagesetting.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# PageSetting
44

5-
A page setting create a link to another configuration page. Tapping on the link displays
5+
A page setting creates a link to another configuration page. Tapping on the link displays
66
the linked page.
77

88
## Methods

‎docs/classes/_pages_scene_setting_d_.scenesetting.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# SceneSetting
44

5-
A scene setting display a control that allows one or more scenes to be selected.
5+
A scene setting displays a control that allows one or more scenes to be selected.
66
```
77
section.sceneSetting('selectedScene')
88
```
@@ -95,7 +95,7 @@ ___
9595

9696
▸ **multiple**(`value`: true): *[SceneSetting](_pages_scene_setting_d_.scenesetting.md)*
9797

98-
Specifies whether this device setting can have multiple values.
98+
Specifies whether this scene setting can have multiple values.
9999

100100
**Parameters:**
101101

‎docs/classes/_pages_security_setting_d_.securitysetting.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ ___
9292

9393
▸ **multiple**(`value`: boolean): *[SecuritySetting](_pages_security_setting_d_.securitysetting.md)*
9494

95-
Specifies whether this device setting can have multiple values.
95+
Specifies whether this security setting can have multiple values.
9696

9797
**Parameters:**
9898

‎docs/classes/_pages_sound_setting_d_.soundsetting.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ ___
9191

9292
▸ **multiple**(`value`: boolean): *[SoundSetting](_pages_sound_setting_d_.soundsetting.md)*
9393

94-
Specifies whether this device setting can have multiple values.
94+
Specifies whether this sound setting can have multiple values.
9595

9696
**Parameters:**
9797

‎docs/classes/_pages_text_setting_d_.textsetting.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# TextSetting
44

5-
A text setting create a text input field with full alphanumeric keypad.
5+
A text setting creates a text input field with full alphanumeric keypad.
66
```
77
section.textSetting('warningMessage')
88
```

‎docs/classes/_pages_video_setting_d_.videosetting.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
# VideoSetting
44

5-
An image settings simply displays an image on the configuration page. There is no user input involved.
5+
A video setting provides a player on the configuration page allowing the user to play/pause a video.
66
```
77
section.videoSetting('instructions')
88
.image('https://mysite/preview.png')
9-
.video('https…//mysite/video.mp4')
9+
.video('https://mysite/video.mp4')
1010
```
1111

1212
## Methods
@@ -80,7 +80,8 @@ ___
8080

8181
▸ **image**(`source`: string): *[VideoSetting](_pages_video_setting_d_.videosetting.md)*
8282

83-
Set the URL of an image to display as a preview of the video
83+
Set the URL of an image to display as a video thumbnail.
84+
Max length 2048 characters.
8485

8586
**Parameters:**
8687

@@ -177,7 +178,8 @@ ___
177178

178179
▸ **video**(`source`: string): *[VideoSetting](_pages_video_setting_d_.videosetting.md)*
179180

180-
Set the URL of the video
181+
Set the URL of the video.
182+
Max length 2048 characters.
181183

182184
**Parameters:**
183185

‎docs/classes/_smart_app_d_.smartapp.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -510,8 +510,7 @@ ___
510510

511511
▸ **initialized**(`callback`: function): *[SmartApp](_smart_app_d_.smartapp.md)*
512512

513-
Defines a handler to be called before configuration the first time a SmartApp is installed. If not specified then the
514-
`updated()` handler will be called on the initial installation as well as updates.
513+
Defines a handler to be called before configuration the first time a SmartApp is installed.
515514

516515
**Parameters:**
517516

‎lib/i18n.d.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ export namespace i18n {
5252

5353
/**
5454
* Whether to write new locale information to disk
55-
* @default true
55+
* @default false
5656
*/
5757
updateFiles?: boolean;
5858

‎lib/pages/color-setting.d.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import {Section} from './section'
22
import {SectionSetting} from './section-setting'
33

44
/**
5-
* NOT IMPLEMENTED
5+
* @deprecated Not currently implemented
66
*/
77
export class ColorSetting extends SectionSetting<ColorSetting> {
88
constructor(section: Section, id: string)

‎lib/pages/color-setting.js

+4-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,10 @@
22

33
const SectionSetting = require('./section-setting.js')
44

5-
module.exports = class ColorSetting extends SectionSetting { // TODO - is this right?
5+
/**
6+
* @deprecated
7+
*/
8+
module.exports = class ColorSetting extends SectionSetting {
69
constructor(section, id) {
710
super(section, id)
811
this._type = 'COLOR'

‎lib/pages/email-setting.d.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import {Section} from './section'
22
import {SectionSetting} from './section-setting'
33

44
/**
5-
* An email setting creates an input box with a keyboard appropriate for the entry of email addresses
5+
* An email setting creates an input box with a keyboard appropriate for the entry of email addresses.
66
* ```
77
* section.emailSetting("emailAddress")
88
* ```

‎lib/pages/enum-setting.d.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ export enum OptionsStyle {
6666
* {id:'red', name:'Red'},
6767
* {id:'yellow', name:'Yellow'},
6868
* {id:'blue', name:'Blue'}]},
69-
* {name: 'primaryColors', options: [
69+
* {name: 'secondaryColors', options: [
7070
* {id:'green', name:'Green'},
7171
* {id:'orange', name:'Orange'},
7272
* {id:'purple', name:'Purple'}]},
@@ -87,7 +87,7 @@ export class EnumSetting extends SectionSetting<EnumSetting> {
8787
groupedOptions(groups: OptionGroup[]): EnumSetting
8888

8989
/**
90-
* Specifies whether this device setting can have multiple values.
90+
* Specifies whether this enum setting can have multiple values.
9191
*/
9292
multiple(value: boolean): EnumSetting
9393

‎lib/pages/image-setting.d.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import {Section} from './section'
22
import {SectionSetting} from './section-setting'
33

44
/**
5-
* An image settings simply displays an image on the configuration page. There is no user input involved.
5+
* An image setting simply displays an image on the configuration page. There is no user input involved.
66
* ```
77
* section.imageSetting('banner')
88
* .image('https://mysite/image.png')

‎lib/pages/images-setting.d.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import {Section} from './section'
22
import {SectionSetting} from './section-setting'
33

44
/**
5-
* An images settings displays a carousel of images on the configuration page. There is no user input involved.
5+
* An images setting displays a carousel of images on the configuration page. There is no user input involved.
66
* ```
77
* section.imageSetting('banner')
88
* .images(['https://mysite/image.png', 'https://mysite/image2.png', 'https://mysite/image3.png')

‎lib/pages/link-setting.d.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ export enum LinkStyle {
99
}
1010

1111
/**
12-
* A link setting display a hypertext link that opens an external web page in a browser window. It
12+
* A link setting displays a hypertext link that opens an external web page in a browser window. It
1313
* does not replace the current configuration page window.
1414
* ```
1515
* section.linkSetting('moreInfo')

‎lib/pages/mode-setting.d.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,12 @@ export enum ModeStyle {
88
}
99

1010
/**
11-
* A device setting creates a control that allows the user to select one or more location modes. To allow the selection
11+
* A mode setting creates a control that allows the user to select one or more location modes. To allow the selection
1212
* of only one mode:
1313
* ```
1414
* section.modeSetting('targetMode')
1515
* ```
16-
* The allow the selection of more than one mode:
16+
* To allow the selection of more than one mode:
1717
* ```
1818
* section.modeSetting('permittedModes').multiple(true)
1919
* ```
@@ -27,7 +27,7 @@ export class ModeSetting extends SectionSetting<ModeSetting> {
2727
closeOnSelection(value: boolean): ModeSetting
2828

2929
/**
30-
* Specifies whether this device setting can have multiple values.
30+
* Specifies whether this mode setting can have multiple values.
3131
*/
3232
multiple(boolean: true): ModeSetting
3333

‎lib/pages/page-setting.d.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ export enum PageLinkStyle {
99
}
1010

1111
/**
12-
* A page setting create a link to another configuration page. Tapping on the link displays
12+
* A page setting creates a link to another configuration page. Tapping on the link displays
1313
* the linked page.
1414
*/
1515
export class PageSetting extends SectionSetting<PageSetting> {

‎lib/pages/page.d.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ export class Page {
3434
nextPageId(value: string): Page
3535

3636
/**
37-
* Set the text of the next page link. Defaults to "Next"
37+
* Set the text of the next page link (defaults to "Next"). Only applies if style is `SPLASH`
3838
*/
3939
nextText(value: string): Page
4040

‎lib/pages/scene-setting.d.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ export enum SceneStyle {
99
}
1010

1111
/**
12-
* A scene setting display a control that allows one or more scenes to be selected.
12+
* A scene setting displays a control that allows one or more scenes to be selected.
1313
* ```
1414
* section.sceneSetting('selectedScene')
1515
* ```
@@ -23,7 +23,7 @@ export class SceneSetting extends SectionSetting<SceneSetting> {
2323
closeOnSelection(value: true): SceneSetting
2424

2525
/**
26-
* Specifies whether this device setting can have multiple values.
26+
* Specifies whether this scene setting can have multiple values.
2727
*/
2828
multiple(value: true): SceneSetting
2929

‎lib/pages/section.d.ts

-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
import { Page } from './page'
22

33
import { BooleanSetting } from './boolean-setting'
4-
// import { ColorSetting } from './color-setting'
54
import { DecimalSetting } from './decimal-setting'
65
import { DeviceSetting } from './device-setting'
76
import { EmailSetting } from './email-setting'
@@ -81,8 +80,6 @@ export class Section {
8180
*/
8281
booleanSetting(id: string): BooleanSetting
8382

84-
// colorSetting(id: string): ColorSetting
85-
8683
/**
8784
* Creates a new decimal setting
8885
*/

‎lib/pages/section.js

+1
Original file line numberDiff line numberDiff line change
@@ -201,6 +201,7 @@ module.exports = class Section {
201201
}
202202

203203
/**
204+
* @deprecated
204205
* Color Setting
205206
*
206207
* @param {String} id Identifier used for i18n localization key

‎lib/pages/security-setting.d.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ export class SecuritySetting extends SectionSetting<SecuritySetting> {
2020
closeOnSelection(value: boolean): SecuritySetting
2121

2222
/**
23-
* Specifies whether this device setting can have multiple values.
23+
* Specifies whether this security setting can have multiple values.
2424
*/
2525
multiple(value: boolean): SecuritySetting
2626

‎lib/pages/sound-setting.d.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export class SoundSetting extends SectionSetting<SoundSetting> {
2828
groupedOptions(groupedOptions: SoundOptionGroup[]): SoundSetting
2929

3030
/**
31-
* Specifies whether this device setting can have multiple values.
31+
* Specifies whether this sound setting can have multiple values.
3232
*/
3333
multiple(value: boolean): SoundSetting
3434

‎lib/pages/text-setting.d.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import {Section} from './section'
22
import {SectionSetting} from './section-setting'
33

44
/**
5-
* A text setting create a text input field with full alphanumeric keypad.
5+
* A text setting creates a text input field with full alphanumeric keypad.
66
* ```
77
* section.textSetting('warningMessage')
88
* ```

0 commit comments

Comments
 (0)