Class UserProperties

Proprietà utente

Ritiro. 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 per utente; qualsiasi script eseguito con l'identità di un utente può accedere alle proprietà utente solo per quell'utente.

MetodoTipo restituitoBreve descrizione
deleteAllProperties()UserPropertiesConsente di eliminare tutte le proprietà.
deleteProperty(key)UserPropertiesConsente di eliminare la proprietà con la chiave specificata.
getKeys()String[]Ottieni tutte le chiavi disponibili.
getProperties()ObjectVisualizza tutte le proprietà disponibili contemporaneamente.
getProperty(key)StringRestituisce il valore associato alla chiave fornita o null se non esiste un valore di questo tipo.
setProperties(properties)UserPropertiesImposta collettivamente tutte le proprietà ricavate dall'oggetto specificato.
setProperties(properties, deleteAllOthers)UserPropertiesImposta collettivamente tutte le proprietà ricavate dall'oggetto specificato.
setProperty(key, value)UserPropertiesMantiene il valore in specificato con la chiave fornita.

Metodi ritirati

Ritiro. Questa funzione è deprecata e non deve essere utilizzata nei nuovi script.

Consente di eliminare tutte le proprietà.

UserProperties.deleteAllProperties();

Invio

UserProperties: questo oggetto, per l'accodamento

Vedi anche


Ritiro. Questa funzione è deprecata e non deve essere utilizzata nei nuovi script.

Consente di eliminare la proprietà con la chiave specificata.

UserProperties.deleteProperty('special');

Parametri

NomeTipoDescrizione
keyStringChiave della proprietà da eliminare

Invio

UserProperties: questo oggetto, per l'accodamento

Vedi anche


Ritiro. Questa funzione è deprecata e non deve essere utilizzata nei nuovi script.

Ottieni tutte le chiavi disponibili.

Invio

String[]


Ritiro. Questa funzione è deprecata e non deve essere utilizzata nei nuovi script.

Visualizza tutte le proprietà disponibili contemporaneamente.

Viene generata una copia, non una visualizzazione in tempo reale, pertanto la modifica delle proprietà dell'oggetto restituito non le aggiornerà nello 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]);
}

Invio

Object: una copia delle proprietà contenenti coppie chiave/valore


Ritiro. Questa funzione è deprecata e non deve essere utilizzata nei nuovi script.

Restituisce il valore associato alla chiave fornita o null se non esiste un valore di questo tipo.

const specialValue = UserProperties.getProperty('special');

Parametri

NomeTipoDescrizione
keyStringChiave per il valore da recuperare

Invio

String: il valore associato alla chiave

Vedi anche


Ritiro. Questa funzione è deprecata e non deve essere utilizzata nei nuovi script.

Imposta collettivamente tutte le proprietà ricavate dall'oggetto specificato.

UserProperties.setProperties({special: 'sauce', 'meaning': 42});

Parametri

NomeTipoDescrizione
propertiesObjectUn oggetto contenente le proprietà da impostare.

Invio

UserProperties: questo oggetto, per l'accodamento

Vedi anche


Ritiro. Questa funzione è deprecata e non deve essere utilizzata nei nuovi script.

Imposta collettivamente tutte le proprietà ricavate dall'oggetto specificato.

// This deletes all other properties
UserProperties.setProperties({special: 'sauce', 'meaning': 42}, true);

Parametri

NomeTipoDescrizione
propertiesObjectUn oggetto contenente le proprietà da impostare.
deleteAllOthersBooleanse eliminare tutte le proprietà esistenti.

Invio

UserProperties: questo oggetto, per l'accodamento

Vedi anche


Ritiro. Questa funzione è deprecata e non deve essere utilizzata nei nuovi script.

Mantiene il valore in specificato con la chiave fornita. Qualsiasi valore esistente associato a questa chiave verrà sovrascritto.

UserProperties.setProperty('special', 'sauce');

Parametri

NomeTipoDescrizione
keyStringchiave per la proprietà
valueStringvalore da associare alla chiave

Invio

UserProperties: questo oggetto, per l'accodamento

Vedi anche