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.
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")));
Metodi
Metodo | Tipo restituito | Breve descrizione |
---|---|---|
setControlType(controlType) | Switch | Imposta il tipo di controllo dell'interruttore. |
setFieldName(fieldName) | Switch | Imposta la chiave che identifica questa opzione nell'oggetto evento generato quando si verifica un'interazione nell'interfaccia utente. |
setOnChangeAction(action) | Switch | Consente di impostare l'azione da eseguire quando l'opzione viene attivata. |
setSelected(selected) | Switch | Consente di impostare se questa opzione deve iniziare come selezionata o deselezionata. |
setValue(value) | Switch | Imposta il valore che viene inviato come input del modulo quando questa opzione è attivata. |
Documentazione dettagliata
setControlType(controlType)
Imposta il tipo di controllo dell'interruttore. Il valore predefinito è SWITCH
.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
controlType | SwitchControlType | Il tipo di controllo dell'interruttore. |
Ritorni
Switch
: questo oggetto per il concatenamento.
setFieldName(fieldName)
Imposta la chiave che identifica questa opzione nell'oggetto evento generato quando si verifica un'interazione nell'interfaccia utente. Non visibile all'utente. obbligatorio.
A differenza degli altri campi del modulo, questo nome campo non deve essere necessariamente univoco. I valori di input del modulo per i sensori che utilizzano lo stesso nome di campo vengono restituiti come array. L'array è composto dai valori per tutti i sensori attivati con quel nome di campo.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
fieldName | String | La chiave utilizzata per identificare questo sensore. |
Ritorni
Switch
: questo oggetto per il concatenamento.
setOnChangeAction(action)
setSelected(selected)
Consente di impostare se questa opzione deve iniziare come selezionata o deselezionata.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
selected | Boolean | L'impostazione iniziale dello stato dell'interruttore. |
Ritorni
Switch
: questo oggetto per il concatenamento.
setValue(value)
Imposta il valore che viene inviato come input del modulo quando questa opzione è attivata.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
value | String | Il valore associato al nome quando l'opzione è attiva. Quando viene inviato al callback del modulo, è sempre rappresentato come una stringa. |
Ritorni
Switch
: questo oggetto per il concatenamento.