Эта страница переведена с помощью Cloud Translation API.

Class UserProperties

Устарело. Этот класс устарел и не должен использоваться в новых сценариях.

Свойства пользователя — это пары ключ-значение, уникальные для пользователя. Свойства пользователя ограничены для каждого пользователя; любой сценарий, запущенный под именем пользователя, может получить доступ к свойствам пользователя только для этого пользователя.

Устаревшие методы

Метод	Тип возврата	Краткое описание
`delete All Properties()`	`User Properties`	Удаляет все свойства.
`delete Property(key)`	`User Properties`	Удаляет свойство с заданным ключом.
`get Keys()`	`String[]`	Получите все доступные ключи.
`get Properties()`	`Object`	Получите все доступные свойства одновременно.
`get Property(key)`	`String`	Возвращает значение, связанное с предоставленным ключом, или значение NULL, если такого значения нет.
`set Properties(properties)`	`User Properties`	Массовая установка всех свойств, извлеченных из данного объекта.
`set Properties(properties, deleteAllOthers)`	`User Properties`	Массовая установка всех свойств, извлеченных из данного объекта.
`set Property(key, value)`	`User Properties`	Сохраняет указанное значение с помощью предоставленного ключа.

Устаревшие методы

`delete All Properties()`

Устарело. Эта функция устарела и не должна использоваться в новых скриптах.

Удаляет все свойства.

UserProperties.deleteAllProperties();

Возвращаться

User Properties — этот объект для цепочки

См. также

delete Property(key)

`delete Property(key)`

Устарело. Эта функция устарела и не должна использоваться в новых скриптах.

Удаляет свойство с заданным ключом.

UserProperties.deleteProperty('special');

Параметры

Имя	Тип	Описание
`key`	`String`	ключ для свойства, которое нужно удалить

Возвращаться

User Properties — этот объект для цепочки

См. также

delete All Properties()

`get Keys()`

Устарело. Эта функция устарела и не должна использоваться в новых скриптах.

Получите все доступные ключи.

Возвращаться

String[]

`get Properties()`

Устарело. Эта функция устарела и не должна использоваться в новых скриптах.

Получите все доступные свойства одновременно.

Это дает копию, а не просмотр в реальном времени, поэтому изменение свойств возвращаемого объекта не приведет к их обновлению в хранилище, и наоборот.

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

Возвращаться

Object — копия свойств, содержащая пары ключ-значение.

`get Property(key)`

Устарело. Эта функция устарела и не должна использоваться в новых скриптах.

Возвращает значение, связанное с предоставленным ключом, или значение NULL, если такого значения нет.

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

Параметры

Имя	Тип	Описание
`key`	`String`	ключ для значения, которое нужно получить

Возвращаться

String — значение, связанное с ключом

См. также

set Property(key, value)

`set Properties(properties)`

Устарело. Эта функция устарела и не должна использоваться в новых скриптах.

Массовая установка всех свойств, извлеченных из данного объекта.

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

Параметры

Имя	Тип	Описание
`properties`	`Object`	объект, содержащий свойства, которые необходимо установить.

Возвращаться

User Properties — этот объект для цепочки

См. также

set Property(key, value)

`set Properties(properties, deleteAllOthers)`

Устарело. Эта функция устарела и не должна использоваться в новых скриптах.

Массовая установка всех свойств, извлеченных из данного объекта.

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

Параметры

Имя	Тип	Описание
`properties`	`Object`	объект, содержащий свойства, которые необходимо установить.
`delete All Others`	`Boolean`	следует ли удалять все существующие свойства.

Возвращаться

User Properties — этот объект для цепочки

См. также

set Property(key, value)

`set Property(key, value)`

Устарело. Эта функция устарела и не должна использоваться в новых скриптах.

Сохраняет указанное значение с предоставленным ключом. Любое существующее значение, связанное с этим ключом, будет перезаписано.

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

Параметры

Имя	Тип	Описание
`key`	`String`	ключ от собственности
`value`	`String`	значение, которое можно связать с ключом

Возвращаться

User Properties — этот объект для цепочки

См. также

get Property(key)