Class UserProperties

Nutzereigenschaften

Veraltet. Diese Klasse wurde eingestellt und sollte in neuen Scripts nicht verwendet werden.

Nutzereigenschaften sind Schlüssel/Wert-Paare, die für einen Nutzer eindeutig sind. Nutzereigenschaften sind pro Nutzer gültig. Jedes Script, das unter der Identität eines Nutzers ausgeführt wird, kann nur auf die Nutzereigenschaften dieses Nutzers zugreifen.

MethodeRückgabetypKurzbeschreibung
deleteAllProperties()UserPropertiesAlle Properties werden gelöscht.
deleteProperty(key)UserPropertiesLöscht die Property mit dem angegebenen Schlüssel.
getKeys()String[]Alle verfügbaren Schlüssel abrufen
getProperties()ObjectAlle verfügbaren Properties auf einmal abrufen
getProperty(key)StringGibt den mit dem angegebenen Schlüssel verknüpften Wert zurück. Wenn kein solcher Wert vorhanden ist, wird „null“ zurückgegeben.
setProperties(properties)UserPropertiesHiermit werden alle Eigenschaften des angegebenen Objekts im Bulk-Verfahren festgelegt.
setProperties(properties, deleteAllOthers)UserPropertiesHiermit werden alle Eigenschaften des angegebenen Objekts im Bulk-Verfahren festgelegt.
setProperty(key, value)UserPropertiesSpeichert den angegebenen Wert mit dem angegebenen Schlüssel.

Eingestellte Methoden

Veraltet. Diese Funktion wurde eingestellt und sollte in neuen Scripts nicht verwendet werden.

Alle Properties werden gelöscht.

UserProperties.deleteAllProperties();

Rückflug

UserProperties – dieses Objekt, zum Verketten

Weitere Informationen


Veraltet. Diese Funktion wurde eingestellt und sollte in neuen Scripts nicht verwendet werden.

Löscht die Property mit dem angegebenen Schlüssel.

UserProperties.deleteProperty('special');

Parameter

NameTypBeschreibung
keyStringSchlüssel für die zu löschende Property

Rückflug

UserProperties – dieses Objekt, zum Verketten

Weitere Informationen


Veraltet. Diese Funktion wurde eingestellt und sollte in neuen Scripts nicht verwendet werden.

Alle verfügbaren Schlüssel abrufen

Rückflug

String[]


Veraltet. Diese Funktion wurde eingestellt und sollte in neuen Scripts nicht verwendet werden.

Alle verfügbaren Properties auf einmal abrufen

Es wird also eine Kopie und keine Liveansicht zurückgegeben. Wenn Sie die Eigenschaften des zurückgegebenen Objekts ändern, werden sie nicht im Speicher aktualisiert und umgekehrt.

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]);
}

Rückflug

Object: eine Kopie der Properties, die Schlüssel/Wert-Paare enthalten


Veraltet. Diese Funktion wurde eingestellt und sollte in neuen Scripts nicht verwendet werden.

Gibt den mit dem angegebenen Schlüssel verknüpften Wert zurück. Wenn kein solcher Wert vorhanden ist, wird „null“ zurückgegeben.

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

Parameter

NameTypBeschreibung
keyStringSchlüssel für den abzurufenden Wert

Rückflug

String: Der mit dem Schlüssel verknüpfte Wert.

Weitere Informationen


Veraltet. Diese Funktion wurde eingestellt und sollte in neuen Scripts nicht verwendet werden.

Hiermit werden alle Eigenschaften des angegebenen Objekts im Bulk-Verfahren festgelegt.

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

Parameter

NameTypBeschreibung
propertiesObjectein Objekt mit den zu setzenden Eigenschaften.

Rückflug

UserProperties – dieses Objekt, zum Verketten

Weitere Informationen


Veraltet. Diese Funktion wurde eingestellt und sollte in neuen Scripts nicht verwendet werden.

Hiermit werden alle Eigenschaften des angegebenen Objekts im Bulk-Verfahren festgelegt.

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

Parameter

NameTypBeschreibung
propertiesObjectein Objekt mit den zu setzenden Eigenschaften.
deleteAllOthersBooleanob alle vorhandenen Properties gelöscht werden sollen.

Rückflug

UserProperties – dieses Objekt, zum Verketten

Weitere Informationen


Veraltet. Diese Funktion wurde eingestellt und sollte in neuen Scripts nicht verwendet werden.

Speichert den angegebenen Wert mit dem angegebenen Schlüssel. Alle mit diesem Schlüssel verknüpften Werte werden überschrieben.

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

Parameter

NameTypBeschreibung
keyStringSchlüssel für Property
valueStringWert, der dem Schlüssel zugeordnet werden soll

Rückflug

UserProperties – dieses Objekt, zum Verketten

Weitere Informationen