Esta página foi traduzida pela API Cloud Translation.

Class Switch

Um elemento da IU que pode ser ativado ou desativado. Isso só pode ser usado em um widget DecoratedText.

var switchDecoratedText  = CardService.newDecoratedText()
  .setTopLabel("Switch decorated text widget label")
  .setText("This is a decorated text widget with a switch on the right")
  .setWrapText(true)
  .setSwitchControl(CardService.newSwitch()
      .setFieldName("form_input_switch_key")
      .setValue("form_input_switch_value")
      .setOnChangeAction(CardService.newAction()
          .setFunctionName("handleSwitchChange")));

Métodos

Método	Tipo de retorno	Breve descrição
`setControlType(controlType)`	`Switch`	Define o tipo de controle do interruptor.
`setFieldName(fieldName)`	`Switch`	Define a chave que identifica essa chave no objeto de evento que é gerado quando há uma interação da IU.
`setOnChangeAction(action)`	`Switch`	Define a ação a ser realizada quando o botão é alternado.
`setSelected(selected)`	`Switch`	Define se este interruptor deve ser iniciado como selecionado ou não selecionado.
`setValue(value)`	`Switch`	Define o valor que é enviado como entrada do formulário quando essa chave está ativada.

Documentação detalhada

`setControlType(controlType)`

Define o tipo de controle do interruptor. O valor padrão é SWITCH.

Parâmetros

Nome	Tipo	Descrição
`controlType`	`SwitchControlType`	O tipo de controle do interruptor.

Retornar

Switch: este objeto, para encadeamento.

`setFieldName(fieldName)`

Define a chave que identifica essa chave no objeto de evento que é gerado quando há uma interação da IU. Não visível para o usuário. Obrigatório.

Diferentemente dos outros campos de formulário, esse nome de campo não precisa ser exclusivo. Os valores de entrada do formulário para interruptores que usam o mesmo nome de campo são retornados como uma matriz. A matriz consiste nos valores de todos os interruptores ativados com esse nome de campo.

Parâmetros

Nome	Tipo	Descrição
`fieldName`	`String`	A chave usada para identificar essa chave.

Retornar

Switch: este objeto, para encadeamento.

`setOnChangeAction(action)`

Define a ação a ser realizada quando o botão é alternado.

Parâmetros

Nome	Tipo	Descrição
`action`	`Action`	A ação a ser realizada quando a chave estiver ativada.

Retornar

Switch: este objeto, para encadeamento.

`setSelected(selected)`

Define se este interruptor deve ser iniciado como selecionado ou não selecionado.

Parâmetros

Nome	Tipo	Descrição
`selected`	`Boolean`	Configuração de estado do interruptor inicial.

Retornar

Switch: este objeto, para encadeamento.

`setValue(value)`

Define o valor que é enviado como entrada do formulário quando essa chave está ativada.

Parâmetros

Nome	Tipo	Descrição
`value`	`String`	O valor associado ao nome quando a chave está ativada. Quando ela é enviada para o callback do formulário, ela é sempre representada como uma string.

Retornar

Switch: este objeto, para encadeamento.