Se usó la API de Cloud Translation para traducir esta página.

Class Switch

Elemento de la IU que admite la activación o desactivación. Solo se puede usar dentro de un widget DecoratedText.

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 una interacción con la IU.
`setOnChangeAction(action)`	`Switch`	Configura la acción que se debe realizar cuando se activa el interruptor.
`setSelected(selected)`	`Switch`	Establece si el interruptor debe comenzar como seleccionado o no seleccionado.
`setValue(value)`	`Switch`	Establece el valor que se envía como la 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
`controlType`	`SwitchControlType`	El tipo de control del interruptor

Devolvedor

Switch: Este objeto se usa para encadenar.

`setFieldName(fieldName)`

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

A diferencia de otros campos del formulario, no es necesario que este nombre de campo sea único. Los valores de entrada del formulario para 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 tecla que se usa para identificar este interruptor.

Devolvedor

Switch: Este objeto se usa para encadenar.

`setOnChangeAction(action)`

Configura la acción que se debe realizar cuando se activa el interruptor.

Parámetros

Nombre	Tipo	Descripción
`action`	`Action`	La acción que se realiza cuando el interruptor está activado.

Devolvedor

Switch: Este objeto se usa para encadenar.

`setSelected(selected)`

Establece si el interruptor debe comenzar como seleccionado o no seleccionado.

Parámetros

Nombre	Tipo	Descripción
`selected`	`Boolean`	La configuración del estado del interruptor inicial

Devolvedor

Switch: Este objeto se usa para encadenar.

`setValue(value)`

Establece el valor que se envía como la entrada del formulario cuando este interruptor está activado.

Parámetros

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

Devolvedor

Switch: Este objeto se usa para encadenar.