Obsoleta. Questa classe è deprecata e non deve essere utilizzata nei nuovi script.
Le proprietà utente sono coppie chiave-valore univoche per un utente. Le proprietà utente hanno un ambito basato su singolo utente; qualsiasi script eseguito con l'identità di un utente può accedere alle proprietà utente solo per quell'utente.
Metodi deprecati
Metodo | Tipo restituito | Breve descrizione |
---|---|---|
|
| Elimina tutte le proprietà. |
|
| Elimina la proprietà con la chiave specificata. |
| String[] | Recupera tutte le chiavi disponibili. |
| Object | Visualizza contemporaneamente tutte le proprietà disponibili. |
| String | Restituisce il valore associato alla chiave fornita oppure null se tale valore non esiste. |
|
| Imposta in blocco tutte le proprietà estratte dall'oggetto specificato. |
|
| Imposta in blocco tutte le proprietà estratte dall'oggetto specificato. |
|
| Mantieni il valore specificato con la chiave fornita. |
Metodi deprecati
deleteAllProperties()
deleteAllProperties()
Obsoleta. Questa funzione è deprecata e non deve essere utilizzata nei nuovi script.
Elimina tutte le proprietà.
UserProperties.deleteAllProperties();
Ritorni
: questo oggetto per il concatenamentoUserProperties
Vedi anche
deleteProperty(key)
deleteProperty(key)
Obsoleta. Questa funzione è deprecata e non deve essere utilizzata nei nuovi script.
Elimina la proprietà con la chiave specificata.
UserProperties.deleteProperty('special');
Parametri
Nome | Tipo | Descrizione |
---|---|---|
key | String | chiave per la proprietà da eliminare |
Ritorni
: questo oggetto per il concatenamentoUserProperties
Vedi anche
getKeys()
getKeys()
Obsoleta. Questa funzione è deprecata e non deve essere utilizzata nei nuovi script.
Recupera tutte le chiavi disponibili.
Ritorni
String[]
getProperties()
getProperties()
Obsoleta. Questa funzione è deprecata e non deve essere utilizzata nei nuovi script.
Visualizza contemporaneamente tutte le proprietà disponibili.
Questo genera una copia, non una visualizzazione in tempo reale, quindi la modifica delle proprietà dell'oggetto restituito non ne aggiorna lo spazio di archiviazione e viceversa.
UserProperties.setProperties({ "cow" : "moo", "sheep" : "baa", "chicken" : "cluck" }); // Logs "A cow goes: moo" Logger.log("A cow goes: %s", UserProperties.getProperty("cow")); // This makes a copy. Any changes that happen here will not // be written back to properties. var animalSounds = UserProperties.getProperties(); // Logs: // A chicken goes cluck! // A cow goes moo! // A sheep goes baa! for(var kind in animalSounds) { Logger.log("A %s goes %s!", kind, animalSounds[kind]); }
Ritorni
Object
: una copia delle proprietà contenenti coppie chiave-valore
getProperty(key)
getProperty(key)
Obsoleta. Questa funzione è deprecata e non deve essere utilizzata nei nuovi script.
Restituisce il valore associato alla chiave fornita oppure null se tale valore non esiste.
var specialValue = UserProperties.getProperty('special');
Parametri
Nome | Tipo | Descrizione |
---|---|---|
key | String | chiave per il valore da recuperare |
Ritorni
String
: il valore associato alla chiave
Vedi anche
setProperties(properties)
setProperties(properties)
Obsoleta. Questa funzione è deprecata e non deve essere utilizzata nei nuovi script.
Imposta in blocco tutte le proprietà estratte dall'oggetto specificato.
UserProperties.setProperties({special: 'sauce', 'meaning': 42});
Parametri
Nome | Tipo | Descrizione |
---|---|---|
properties | Object | un oggetto contenente le proprietà da impostare. |
Ritorni
: questo oggetto per il concatenamentoUserProperties
Vedi anche
setProperties(properties, deleteAllOthers)
setProperties(properties, deleteAllOthers)
Obsoleta. Questa funzione è deprecata e non deve essere utilizzata nei nuovi script.
Imposta in blocco tutte le proprietà estratte dall'oggetto specificato.
// This deletes all other properties UserProperties.setProperties({special: 'sauce', 'meaning': 42}, true);
Parametri
Nome | Tipo | Descrizione |
---|---|---|
properties | Object | un oggetto contenente le proprietà da impostare. |
deleteAllOthers | Boolean | se eliminare tutte le proprietà esistenti. |
Ritorni
: questo oggetto per il concatenamentoUserProperties
Vedi anche
setProperty(key, value)
setProperty(key, value)
Obsoleta. Questa funzione è deprecata e non deve essere utilizzata nei nuovi script.
Mantieni il valore specificato con la chiave fornita. Qualsiasi valore esistente associato a questa chiave verrà sovrascritto.
UserProperties.setProperty('special', 'sauce');
Parametri
Nome | Tipo | Descrizione |
---|---|---|
key | String | chiave per la proprietà |
value | String | valore da associare alla chiave |
Ritorni
: questo oggetto per il concatenamentoUserProperties