Class Switch

Switch

Es un elemento de la IU que se puede activar o desactivar. Solo se puede usar dentro de un widget DecoratedText.

Está disponible para los complementos de Google Workspace y las apps de 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 datos que se devuelve	Descripción breve
setControlType(controlType)	Switch	Establece el tipo de control del interruptor.
setFieldName(fieldName)	Switch	Establece la clave que identifica este interruptor en el objeto de evento que se genera cuando hay una interacción de la IU.
setOnChangeAction(action)	Switch	Establece la acción que se debe realizar cuando se activa o desactiva el interruptor.
setSelected(selected)	Switch	Establece si este interruptor debe comenzar como seleccionado o no.
setValue(value)	Switch	Establece el valor que se envía como entrada del formulario cuando se activa este interruptor.

Documentación detallada

setControlType(controlType)

Establece el tipo de control del interruptor. La configuración predeterminada es SWITCH.

Parámetros

Nombre	Tipo	Descripción
controlType	SwitchControlType	El tipo de control del interruptor.

Volver

Switch: Este objeto, para el encadenamiento.

---

setFieldName(fieldName)

Establece la clave que identifica este interruptor en el objeto de evento que se genera cuando hay una interacción de la IU. No es visible para el usuario. Obligatorio.

A diferencia de otros campos de formulario, este nombre de campo no necesita ser único. Los valores de entrada del formulario para los interruptores que usan el mismo nombre de campo se muestran como un array. El array consta de los valores de todos los interruptores habilitados con ese nombre de campo.

Parámetros

Nombre	Tipo	Descripción
fieldName	String	La clave que se usa para identificar este interruptor.

Volver

Switch: Este objeto, para el encadenamiento.

---

setOnChangeAction(action)

Establece la acción que se debe realizar cuando se activa o desactiva el interruptor.

Parámetros

Nombre	Tipo	Descripción
action	Action	La acción que se debe realizar cuando se activa o desactiva el interruptor.

Volver

Switch: Este objeto, para el encadenamiento.

---

setSelected(selected)

Establece si este interruptor debe comenzar como seleccionado o no.

Parámetros

Nombre	Tipo	Descripción
selected	Boolean	El parámetro de configuración del estado inicial del interruptor.

Volver

Switch: Este objeto, para el encadenamiento.

---

setValue(value)

Establece el valor que se envía como entrada del formulario cuando se activa este interruptor.

Parámetros

Nombre	Tipo	Descripción
value	String	El valor asociado con el nombre cuando el interruptor está activado. Cuando se envía a la devolución de llamada del formulario, siempre se representa como una cadena.

Volver

Switch: Este objeto, para el encadenamiento.