Es un elemento de la IU que admite la activación o desactivación. Solo se puede usar dentro de un widget Decorated
.
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 muestra | Descripción breve |
---|---|---|
set | Switch | Establece el tipo de control del interruptor. |
set | Switch | Establece la clave que identifica este interruptor en el objeto del evento que se genera cuando hay una interacción con la IU. |
set | Switch | Establece la acción que se debe realizar cuando se activa el interruptor. |
set | Switch | Establece si este interruptor debe iniciarse seleccionado o no. |
set | Switch | Establece el valor que se envía como entrada del formulario cuando este interruptor está activado. |
Documentación detallada
setControlType(controlType)
Establece el tipo de control del interruptor. La configuración predeterminada es SWITCH
.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
control | Switch | Es el tipo de control del interruptor. |
Volver
Switch
: Este objeto, para encadenar.
setFieldName(fieldName)
Establece la clave que identifica este interruptor en el objeto del evento que se genera cuando hay una interacción con la IU. No es visible para el usuario. Obligatorio.
A diferencia de otros campos de formulario, este nombre no tiene que 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 |
---|---|---|
field | String | Es la clave que se usa para identificar este interruptor. |
Volver
Switch
: Este objeto, para encadenar.
setOnChangeAction(action)
setSelected(selected)
Establece si este interruptor debe iniciarse seleccionado o no.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
selected | Boolean | Es la configuración del estado del interruptor de inicio. |
Volver
Switch
: Este objeto, para encadenar.
setValue(value)
Establece el valor que se envía como entrada del formulario cuando este interruptor está activado.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
value | String | Es 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 encadenar.