Class Switch

Switch

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

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

const 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 gerado quando há uma interação da interface.
setOnChangeAction(action)	Switch	Define a ação a ser realizada quando o interruptor for acionado.
setSelected(selected)	Switch	Define se essa chave precisa ser iniciada como selecionada ou não.
setValue(value)	Switch	Define o valor enviado como a entrada do formulário quando essa opção 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 gerado quando há uma interação da interface. Não aparece para o usuário. Obrigatório.

Ao contrário de outros campos de formulário, o nome desse campo não precisa ser exclusivo. Os valores de entrada do formulário para chaves 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

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 interruptor for acionado.

Parâmetros

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

Retornar

Switch: este objeto, para encadeamento.

---

setSelected(selected)

Define se essa chave precisa ser iniciada como selecionada ou não.

Parâmetros

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

Retornar

Switch: este objeto, para encadeamento.

---

setValue(value)

Define o valor enviado como a entrada do formulário quando essa opção está ativada.

Parâmetros

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

Retornar

Switch: este objeto, para encadeamento.