From d0af7b0fac0f5acf38025c49071952dc94d2e16b Mon Sep 17 00:00:00 2001 From: Keegan Date: Wed, 9 Mar 2016 11:28:42 +1100 Subject: [PATCH] fix typo in readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c1ace31..6814b45 100755 --- a/README.md +++ b/README.md @@ -624,7 +624,7 @@ Pebble.addEventListener('webviewclosed', function(e) { | `Clay( [array] config, [function] customFn=null, [object] options={autoHandleEvents: true})`
`config` - an Array representing your config
`customFn` - function to be run in the context of the generated page
`options.autoHandleEvents` - set to `false` to prevent Clay from automatically handling the "showConfiguration" and "webviewclosed" events | `Clay` - a new instance of Clay. | | `.registerComponent( [ClayComponent] component )`
Registers a custom component. | `void`. | | `.generateUrl()` | `string` - The URL to open with `Pebble.openURL()` to use the Clay-generated config page. | -| `.getSettings( [object] response, [boolean] convert=true)`
`response` - the response object provided to the "webviewclosed" event
`convert` - Pass `false` to not convert the settings to be compatible with `Pebble.sendAppMessage()` | `Object` - object of keys and values for each config page item with an `appKey`, where the key is the `appKey` and the value is the chosen value of that item. This method will do some conversions depending on the type of the setting. Arrays containing strings will have zeros inserted before each item. eg `['one', 'two']` becomes `['one', 0, 'two', 0]`. Booleans will be converted to numbers. eg `true` becomes `1` and `false` becomes `0`, Pass `false` as the second parameter to disable this behavior | +| `.getSettings( [object] response, [boolean] convert=true)`
`response` - the response object provided to the "webviewclosed" event
`convert` - Pass `false` to not convert the settings to be compatible with `Pebble.sendAppMessage()` | `Object` - object of keys and values for each config page item with an `appKey`, where the key is the `appKey` and the value is the chosen value of that item. This method will do some conversions depending on the type of the setting. Arrays containing strings will have zeros inserted before each item. eg `['one', 'two']` becomes `['one', 0, 'two', 0]`. Booleans will be converted to numbers. eg `true` becomes `1` and `false` becomes `0`. Pass `false` as the second parameter to disable this behavior | ---