Esta página foi traduzida pela API Cloud Translation.

Class Switch

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

Disponível nos complementos do Google Workspace e nos apps do Google Chat.

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 este switch no objeto de evento que é gerado quando há um Interação com a interface do usuário.
`setOnChangeAction(action)`	`Switch`	Define a ação a ser realizada quando o interruptor for alternado.
`setSelected(selected)`	`Switch`	Define se esta chave deve iniciar como selecionada ou desmarcada.
`setValue(value)`	`Switch`	Define o valor que é enviado como a 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 este switch no objeto de evento que é gerado quando há um Interação com a interface do usuário. Não está visível para o usuário. Obrigatório.

Ao contrário de outros campos de formulário, esse nome de campo não precisa ser exclusivo. Os valores de entrada do formulário para chaves que usam o mesmo nome de campo são retornadas como uma matriz. A matriz é composta pelos para todos os switches ativados com esse nome de campo.

Parâmetros

Nome	Tipo	Descrição
`fieldName`	`String`	É a chave usada para identificar o interruptor.

Retornar

Switch: este objeto, para encadeamento.

`setOnChangeAction(action)`

Define a ação a ser realizada quando o interruptor for alternado.

Parâmetros

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

Retornar

Switch: este objeto, para encadeamento.

`setSelected(selected)`

Define se esta chave deve iniciar como selecionada ou desmarcada.

Parâmetros

Nome	Tipo	Descrição
`selected`	`Boolean`	A configuração inicial do estado do interruptor.

Retornar

Switch: este objeto, para encadeamento.

`setValue(value)`

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

Parâmetros

Nome	Tipo	Descrição
`value`	`String`	Valor associado ao nome quando a chave está ativada. Quando isso é enviado ao do formulário, ela é sempre representada como uma string.

Retornar

Switch: este objeto, para encadeamento.