Class Switch

Switch

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

Disponível para complementos do Google Workspace e 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étodoTipo de retornoBreve descrição
setControlType(controlType)SwitchDefine o tipo de controle do interruptor.
setFieldName(fieldName)SwitchDefine a chave que identifica essa chave no objeto de evento gerado quando há uma interação com a interface.
setOnChangeAction(action)SwitchDefine a ação a ser realizada quando o interruptor for alternado.
setSelected(selected)SwitchDefine se o interruptor deve começar com a seleção ou não.
setValue(value)SwitchDefine o valor enviado como a entrada do formulário quando esse interruptor é ativado.

Documentação detalhada

setControlType(controlType)

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

Parâmetros

NomeTipoDescrição
controlTypeSwitchControlTypeO tipo de controle do interruptor.

Retorno

Switch: este objeto para encadeamento.


setFieldName(fieldName)

Define a chave que identifica essa chave no objeto de evento gerado quando há uma interação com a interface. 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 interruptores que usam o mesmo nome de campo são retornados como uma matriz. A matriz consiste nos valores de todos os switches ativados com esse nome de campo.

Parâmetros

NomeTipoDescrição
fieldNameStringA chave usada para identificar o interruptor.

Retorno

Switch: este objeto para encadeamento.


setOnChangeAction(action)

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

Parâmetros

NomeTipoDescrição
actionActionA ação a ser realizada quando o interruptor estiver ativado.

Retorno

Switch: este objeto para encadeamento.


setSelected(selected)

Define se o interruptor deve começar com a seleção ou não.

Parâmetros

NomeTipoDescrição
selectedBooleanA configuração do estado do interruptor inicial.

Retorno

Switch: este objeto para encadeamento.


setValue(value)

Define o valor enviado como a entrada do formulário quando esse interruptor é ativado.

Parâmetros

NomeTipoDescrição
valueStringO valor associado ao nome quando a chave está ativada. Quando enviado para o callback do formulário, ele é sempre representado como uma string.

Retorno

Switch: este objeto para encadeamento.