Reference › SmartApp › Page › Section › TimeSetting
A time setting creates a control that supports the entry of the time of day. This value can be used in scheduling one-per-day events at a specific time. For example this setting:
section.timeSetting('happyHour')
Coupled with this schedule call will execute a handler at the selected time each day:
context.schedules.runDaily('happyHourHandler', context.config.happyHour)
▸ defaultValue(value: string | number): TimeSetting
Inherited from SectionSetting.defaultValue
Sets the initial value displayed in the setting when first shown to the user.
Parameters:
| Name | Type |
|---|---|
value |
string | number |
Returns: TimeSetting
▸ description(value: string): TimeSetting
Inherited from SectionSetting.description
Sets value displayed in the setting control. Defaults to 'Tap to Set' for most types of settings.
Parameters:
| Name | Type |
|---|---|
value |
string |
Returns: TimeSetting
▸ disabled(value: boolean): TimeSetting
Inherited from SectionSetting.disabled
Disables the ability to use the control
Parameters:
| Name | Type |
|---|---|
value |
boolean |
Returns: TimeSetting
▸ image(source: string): TimeSetting
Specify an image URL to display with this setting
Parameters:
| Name | Type | Description |
|---|---|---|
source |
string | HTTPS url or Base64-encoded data URI. Max length 2048 characters. |
Returns: TimeSetting
▸ max(value: string): TimeSetting
The latest time that can be entered
Parameters:
| Name | Type |
|---|---|
value |
string |
Returns: TimeSetting
▸ min(value: string): TimeSetting
The earliest time that can be entered
Parameters:
| Name | Type |
|---|---|
value |
string |
Returns: TimeSetting
▸ name(value: string): TimeSetting
Inherited from SectionSetting.name
Sets the name of this setting. Used to reference the setting value during the processing of events. Also used as part of the i18n key for translating the displayed name and description of the setting. All settings on a page must have unique names.
Parameters:
| Name | Type |
|---|---|
value |
string |
Returns: TimeSetting
▸ required(value: boolean): TimeSetting
Inherited from SectionSetting.required
Specifies that the control must be set in order to save the configuration page
Parameters:
| Name | Type |
|---|---|
value |
boolean |
Returns: TimeSetting
▸ submitOnChange(value: boolean): TimeSetting
Inherited from SectionSetting.submitOnChange
Causes the page to be submitted and re-rendered any time the value of the setting is changed, rather than requiring the user to tap Next or Done. This behavior is useful when the the presence or enabled/disabled status of some settings depend on the value of other settings.
Parameters:
| Name | Type |
|---|---|
value |
boolean |
Returns: TimeSetting
▸ translateDefaultValue(value: string): TimeSetting
Inherited from SectionSetting.translateDefaultValue
Sets the initial value of the setting by passing the specified value through the i18n translation process.
You might want to use translatedDefaultValue rather than defaultValue in a case like setting the
default value of a text setting to the word "Kitchen" in the language of the user. defaultValue('Kitchen')
will set the value "Kitchen" regardless of the user's language or whether there were localization file entries
for the key "Kitchen". However, translateDefaultValue('Kitchen') will look for a localization file entry
with the key "Kitchen" and set the default to that value.
Parameters:
| Name | Type |
|---|---|
value |
string |
Returns: TimeSetting