Skip to content

Latest commit

 

History

History
185 lines (110 loc) · 5.82 KB

_pages_oauth_setting_d_.oauthsetting.md

File metadata and controls

185 lines (110 loc) · 5.82 KB

ReferenceSmartAppPageSectionOAuthSetting

OAuthSetting

Creates an OAuth2 link to initiate the connection from SmartThings to an external web service.

Methods

defaultValue

defaultValue(value: string | number): OAuthSetting

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: OAuthSetting


description

description(value: string): OAuthSetting

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: OAuthSetting


disabled

disabled(value: boolean): OAuthSetting

Inherited from SectionSetting.disabled

Disables the ability to use the control

Parameters:

Name Type
value boolean

Returns: OAuthSetting


name

name(value: string): OAuthSetting

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: OAuthSetting


required

required(value: boolean): OAuthSetting

Inherited from SectionSetting.required

Specifies that the control must be set in order to save the configuration page

Parameters:

Name Type
value boolean

Returns: OAuthSetting


style

style(value: OAuthStyle): OAuthSetting

Sets the style of the link

Parameters:

Name Type
value OAuthStyle

Returns: OAuthSetting


submitOnChange

submitOnChange(value: boolean): OAuthSetting

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: OAuthSetting


translateDefaultValue

translateDefaultValue(value: string): OAuthSetting

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: OAuthSetting


urlTemplate

urlTemplate(url: string): OAuthSetting

Base url of the external web service

Parameters:

Name Type
url string

Returns: OAuthSetting