Class Switch

Cambia

Un elemento dell'interfaccia utente che può essere attivato o disattivato. 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'opzione.
setFieldName(fieldName)SwitchImposta la chiave che identifica questo pulsante di attivazione/disattivazione nell'oggetto evento generato quando si verifica un'interazione con l'interfaccia utente.
setOnChangeAction(action)SwitchImposta l'azione da eseguire quando l'opzione è attivata.
setSelected(selected)SwitchImposta se questo pulsante deve essere selezionato o deselezionato all'avvio.
setValue(value)SwitchImposta il valore inviato come input del modulo quando questo pulsante è attivato.

Documentazione dettagliata

setControlType(controlType)

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

Parametri

NomeTipoDescrizione
controlTypeSwitchControlTypeIl tipo di controllo dell'interruttore.

Invio

Switch: questo oggetto, per l'accodamento.

setFieldName(fieldName)

Imposta la chiave che identifica questo pulsante di attivazione/disattivazione nell'oggetto evento generato quando si verifica un'interazione con l'interfaccia utente. Non visibile all'utente. Obbligatorio.

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

Parametri

NomeTipoDescrizione
fieldNameStringLa chiave utilizzata per identificare questo interruttore.

Invio

Switch: questo oggetto, per l'accodamento.

setOnChangeAction(action)

Imposta l'azione da eseguire quando l'opzione è attivata.

Parametri

NomeTipoDescrizione
actionActionL'azione da eseguire quando l'opzione è attivata.

Invio

Switch: questo oggetto, per l'accodamento.

setSelected(selected)

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

Parametri

NomeTipoDescrizione
selectedBooleanL'impostazione dello stato dell'interruttore iniziale.

Invio

Switch: questo oggetto, per l'accodamento.

setValue(value)

Imposta il valore inviato come input del modulo quando questo pulsante è attivato.

Parametri

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

Invio

Switch: questo oggetto, per l'accodamento.