Cette page a été traduite par l'API Cloud Translation.

Class UserProperties

Obsolète. Cette classe est obsolète et ne doit pas être utilisée dans les nouveaux scripts.

Les propriétés utilisateur sont des paires clé-valeur propres à un utilisateur. Les propriétés utilisateur sont définies par utilisateur. Tout script exécuté sous l'identité d'un utilisateur ne peut accéder qu'aux propriétés utilisateur de cet utilisateur.

Méthodes obsolètes

Méthode	Type renvoyé	Brève description
`deleteAllProperties()`	`UserProperties`	Supprime toutes les propriétés.
`deleteProperty(key)`	`UserProperties`	Supprime la propriété avec la clé donnée.
`getKeys()`	`String[]`	Obtenez toutes les clés disponibles.
`getProperties()`	`Object`	Obtenez toutes les propriétés disponibles en même temps.
`getProperty(key)`	`String`	Renvoie la valeur associée à la clé fournie, ou la valeur "null" si aucune valeur n'est associée.
`setProperties(properties)`	`UserProperties`	Définit de manière groupée toutes les propriétés extraites de l'objet donné.
`setProperties(properties, deleteAllOthers)`	`UserProperties`	Définit de manière groupée toutes les propriétés extraites de l'objet donné.
`setProperty(key, value)`	`UserProperties`	Persistance de la valeur spécifiée dans la clé fournie.

Méthodes obsolètes

`deleteAllProperties()`

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans les nouveaux scripts.

Supprime toutes les propriétés.

UserProperties.deleteAllProperties();

Renvois

UserProperties : cet objet, pour le chaînage

Voir aussi

deleteProperty(key)

`deleteProperty(key)`

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans les nouveaux scripts.

Supprime la propriété avec la clé donnée.

UserProperties.deleteProperty('special');

Paramètres

Nom	Type	Description
`key`	`String`	clé de la propriété à supprimer

Renvois

UserProperties : cet objet, pour le chaînage

Voir aussi

deleteAllProperties()

`getKeys()`

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans les nouveaux scripts.

Obtenez toutes les clés disponibles.

Renvois

String[]

`getProperties()`

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans les nouveaux scripts.

Obtenez toutes les propriétés disponibles en même temps.

Vous obtenez ainsi une copie, et non une vue en direct. Par conséquent, modifier les propriétés de l'objet renvoyé ne les mettra pas à jour dans l'espace de stockage, et inversement.

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

Renvois

Object : copie des propriétés contenant des paires clé-valeur

`getProperty(key)`

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans les nouveaux scripts.

Renvoie la valeur associée à la clé fournie, ou la valeur "null" si aucune valeur n'est associée.

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

Paramètres

Nom	Type	Description
`key`	`String`	clé de la valeur à récupérer

Renvois

String : valeur associée à la clé

Voir aussi

setProperty(key, value)

`setProperties(properties)`

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans les nouveaux scripts.

Définit de manière groupée toutes les propriétés extraites de l'objet donné.

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

Paramètres

Nom	Type	Description
`properties`	`Object`	un objet contenant les propriétés à définir.

Renvois

UserProperties : cet objet, pour le chaînage

Voir aussi

setProperty(key, value)

`setProperties(properties, deleteAllOthers)`

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans les nouveaux scripts.

Définit de manière groupée toutes les propriétés extraites de l'objet donné.

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

Paramètres

Nom	Type	Description
`properties`	`Object`	un objet contenant les propriétés à définir.
`deleteAllOthers`	`Boolean`	si vous souhaitez supprimer toutes les propriétés existantes.

Renvois

UserProperties : cet objet, pour le chaînage

Voir aussi

setProperty(key, value)

`setProperty(key, value)`

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans les nouveaux scripts.

Persistance de la valeur spécifiée dans la clé fournie. Toute valeur existante associée à cette clé sera écrasée.

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

Paramètres

Nom	Type	Description
`key`	`String`	clé de la propriété
`value`	`String`	valeur à associer à la clé

Renvois

UserProperties : cet objet, pour le chaînage

Voir aussi

getProperty(key)