Class UserProperties

UserProperties

Obsoleto. Esta clase está obsoleta y no se debe usar en secuencias de comandos nuevas.

Las propiedades del usuario son pares clave-valor únicos para un usuario. Las propiedades del usuario se definen para cada usuario. Cualquier secuencia de comandos que se ejecute con la identidad de un usuario solo puede acceder a las propiedades del usuario de ese usuario.

Métodos obsoletos

Método	Tipo de datos que se devuelve	Descripción breve
deleteAllProperties()	UserProperties	Borra todas las propiedades.
deleteProperty(key)	UserProperties	Borra la propiedad con la clave determinada.
getKeys()	String[]	Obtén todas las claves disponibles.
getProperties()	Object	Obtiene todas las propiedades disponibles de una vez.
getProperty(key)	String|null	Devuelve el valor asociado a la clave proporcionada o null si no existe tal valor.
setProperties(properties)	UserProperties	Establece de forma masiva todas las propiedades extraídas del objeto determinado.
setProperties(properties, deleteAllOthers)	UserProperties	Establece de forma masiva todas las propiedades extraídas del objeto determinado.
setProperty(key, value)	UserProperties	Persiste el valor especificado con la clave proporcionada.

Métodos obsoletos

deleteAllProperties()

Obsoleto. Esta función está obsoleta y no se debe usar en secuencias de comandos nuevas.

Borra todas las propiedades.

UserProperties.deleteAllProperties();

Volver

UserProperties: Este objeto, para encadenar

Consulta también

• deleteProperty(key)

---

deleteProperty(key)

Obsoleto. Esta función está obsoleta y no se debe usar en secuencias de comandos nuevas.

Borra la propiedad con la clave determinada.

UserProperties.deleteProperty('special');

Parámetros

Nombre	Tipo	Descripción
key	String	clave de la propiedad que se borrará

Volver

UserProperties: Este objeto, para encadenar

Consulta también

• deleteAllProperties()

---

getKeys()

Obsoleto. Esta función está obsoleta y no se debe usar en secuencias de comandos nuevas.

Obtén todas las claves disponibles.

Volver

String[]

---

getProperties()

Obsoleto. Esta función está obsoleta y no se debe usar en secuencias de comandos nuevas.

Obtiene todas las propiedades disponibles de una vez.

Esto proporciona una copia, no una vista en vivo, por lo que cambiar las propiedades del objeto devuelto no las actualizará en el almacenamiento y 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]);
}

Volver

Object: Una copia de las propiedades que contienen pares clave-valor

---

getProperty(key)

Obsoleto. Esta función está obsoleta y no se debe usar en secuencias de comandos nuevas.

Devuelve el valor asociado a la clave proporcionada o null si no existe tal valor.

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

Parámetros

Nombre	Tipo	Descripción
key	String	clave del valor que se recuperará

Volver

String|null: Es el valor asociado a la clave.

Consulta también

• setProperty(key, value)

---

setProperties(properties)

Obsoleto. Esta función está obsoleta y no se debe usar en secuencias de comandos nuevas.

Establece de forma masiva todas las propiedades extraídas del objeto determinado.

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

Parámetros

Nombre	Tipo	Descripción
properties	Object	Un objeto que contiene las propiedades que se deben establecer.

Volver

UserProperties: Este objeto, para encadenar

Consulta también

• setProperty(key, value)

---

setProperties(properties, deleteAllOthers)

Obsoleto. Esta función está obsoleta y no se debe usar en secuencias de comandos nuevas.

Establece de forma masiva todas las propiedades extraídas del objeto determinado.

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

Parámetros

Nombre	Tipo	Descripción
properties	Object	Un objeto que contiene las propiedades que se deben establecer.
deleteAllOthers	Boolean	Indica si se deben borrar todas las propiedades existentes.

Volver

UserProperties: Este objeto, para encadenar

Consulta también

• setProperty(key, value)

---

setProperty(key, value)

Obsoleto. Esta función está obsoleta y no se debe usar en secuencias de comandos nuevas.

Persiste el valor especificado con la clave proporcionada. Se reemplazará cualquier valor existente asociado con esta clave.

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

Parámetros

Nombre	Tipo	Descripción
key	String	clave de la propiedad
value	String	valor para asociar con la clave

Volver

UserProperties: Este objeto, para encadenar

Consulta también

• getProperty(key)