Class Switch

Cambia

Un elemento UI che supporta l'attivazione o la disattivazione. Può essere utilizzato solo all'interno di un widget DecoratedText.

Disponibile per i componenti aggiuntivi di Google Workspace e le app 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'),
                    ),
        );

Metodi

MetodoTipo restituitoBreve descrizione
setControlType(controlType)SwitchImposta il tipo di controllo dell'interruttore.
setFieldName(fieldName)SwitchImposta la chiave che identifica questo interruttore nell'oggetto evento generato quando si verifica un'interazione con la UI.
setOnChangeAction(action)SwitchImposta l'azione da eseguire quando il sensore viene attivato/disattivato.
setSelected(selected)SwitchImposta se questo interruttore deve essere selezionato o deselezionato all'avvio.
setValue(value)SwitchImposta il valore inviato come input del modulo quando questa opzione viene attivata.

Documentazione dettagliata

setControlType(controlType)

Imposta il tipo di controllo dell'interruttore. Il valore predefinito è SWITCH.

Parametri

NomeTipoDescrizione
controlTypeSwitchControlTypeIl tipo di controllo interruttore.

Indietro

Switch: questo oggetto, per il concatenamento.


setFieldName(fieldName)

Imposta la chiave che identifica questo interruttore nell'oggetto evento generato quando si verifica un'interazione con la UI. Non visibile all'utente. Obbligatorio.

A differenza di altri campi del modulo, il nome di questo campo non deve essere univoco. I valori di input del modulo per le opzioni che utilizzano lo stesso nome di campo vengono restituiti come array. L'array è costituito dai valori di tutti gli switch attivati con quel nome di campo.

Parametri

NomeTipoDescrizione
fieldNameStringLa chiave utilizzata per identificare questo switch.

Indietro

Switch: questo oggetto, per il concatenamento.


setOnChangeAction(action)

Imposta l'azione da eseguire quando il sensore viene attivato/disattivato.

Parametri

NomeTipoDescrizione
actionActionL'azione da intraprendere quando viene attivato l'interruttore.

Indietro

Switch: questo oggetto, per il concatenamento.


setSelected(selected)

Imposta se questo interruttore deve essere selezionato o deselezionato all'avvio.

Parametri

NomeTipoDescrizione
selectedBooleanL'impostazione dello stato iniziale dell'interruttore.

Indietro

Switch: questo oggetto, per il concatenamento.


setValue(value)

Imposta il valore inviato come input del modulo quando questa opzione viene attivata.

Parametri

NomeTipoDescrizione
valueStringIl valore associato al nome quando l'opzione è attiva. Quando viene inviato al callback del modulo, viene sempre rappresentato come stringa.

Indietro

Switch: questo oggetto, per il concatenamento.