Un elemento de la IU que permite activar o desactivar la opción. Esto solo se puede usar dentro de un widget DecoratedText
.
Está disponible para los complementos de Google Workspace y las apps de 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 datos que se muestra | 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 un Interacción de la IU |
setOnChangeAction(action) | Switch | Establece la acción que se debe realizar cuando se activa el interruptor. |
setSelected(selected) | Switch | Establece si este interruptor debe comenzar como seleccionado o no seleccionado. |
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 un Interacción de la IU No es visible para el usuario. Obligatorio.
A diferencia de otros campos de formulario, no es necesario que este nombre de campo sea único. Los valores de entrada del formulario de los interruptores que usan el mismo nombre de campo se devuelven como un array. El array consta de los para todos los interruptores habilitados con ese nombre de campo.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
fieldName | String | La tecla que se usa para identificar este interruptor. |
Volver
Switch
: Este objeto para el encadenamiento.
setOnChangeAction(action)
setSelected(selected)
Establece si este interruptor debe comenzar como seleccionado o no seleccionado.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
selected | Boolean | Es la configuración del estado del interruptor de inicio. |
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 al nombre cuando el interruptor está activado. Cuando se envía a la de formulario, siempre se representa como una cadena. |
Volver
Switch
: Este objeto para el encadenamiento.