Esta página foi traduzida pela API Cloud Translation.

Class UserProperties

Obsoleto. Essa classe foi descontinuada e não deve ser usada em novos scripts.

As propriedades do usuário são pares de chave-valor exclusivos para um usuário. As propriedades do usuário são definidas por usuário. Qualquer script executado com a identidade de um usuário pode acessar as propriedades desse usuário apenas.

Métodos obsoletos

Método	Tipo de retorno	Breve descrição
`deleteAllProperties()`	`UserProperties`	Exclui todas as propriedades.
`deleteProperty(key)`	`UserProperties`	Exclui a propriedade com a chave especificada.
`getKeys()`	`String[]`	Receba todas as chaves disponíveis.
`getProperties()`	`Object`	Receba todas as propriedades disponíveis de uma só vez.
`getProperty(key)`	`String`	Retorna o valor associado à chave fornecida ou nulo, se não houver esse valor.
`setProperties(properties)`	`UserProperties`	Define em massa todas as propriedades extraídas do objeto especificado.
`setProperties(properties, deleteAllOthers)`	`UserProperties`	Define em massa todas as propriedades extraídas do objeto especificado.
`setProperty(key, value)`	`UserProperties`	Persistência do valor especificado com a chave fornecida.

Métodos obsoletos

`deleteAllProperties()`

Obsoleto. Essa função foi descontinuada e não deve ser usada em novos scripts.

Exclui todas as propriedades.

UserProperties.deleteAllProperties();

Retornar

UserProperties: este objeto, para encadeamento

Consulte também

deleteProperty(key)

`deleteProperty(key)`

Obsoleto. Essa função foi descontinuada e não deve ser usada em novos scripts.

Exclui a propriedade com a chave especificada.

UserProperties.deleteProperty('special');

Parâmetros

Nome	Tipo	Descrição
`key`	`String`	chave da propriedade a ser excluída

Retornar

UserProperties: este objeto, para encadeamento

Consulte também

deleteAllProperties()

`getKeys()`

Obsoleto. Essa função foi descontinuada e não deve ser usada em novos scripts.

Receba todas as chaves disponíveis.

Retornar

String[]

`getProperties()`

Obsoleto. Essa função foi descontinuada e não deve ser usada em novos scripts.

Receba todas as propriedades disponíveis de uma só vez.

Isso gera uma cópia, não uma visualização em tempo real. Portanto, mudar as propriedades no objeto retornado não vai atualizar no armazenamento e vice-versa.

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

Retornar

Object: uma cópia das propriedades que contêm pares de chave-valor.

`getProperty(key)`

Obsoleto. Essa função foi descontinuada e não deve ser usada em novos scripts.

Retorna o valor associado à chave fornecida ou nulo, se não houver esse valor.

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

Parâmetros

Nome	Tipo	Descrição
`key`	`String`	chave para o valor a ser recuperado

Retornar

String: o valor associado à chave.

Consulte também

setProperty(key, value)

`setProperties(properties)`

Obsoleto. Essa função foi descontinuada e não deve ser usada em novos scripts.

Define em massa todas as propriedades extraídas do objeto especificado.

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

Parâmetros

Nome	Tipo	Descrição
`properties`	`Object`	um objeto que contém as propriedades a serem definidas.

Retornar

UserProperties: este objeto, para encadeamento

Consulte também

setProperty(key, value)

`setProperties(properties, deleteAllOthers)`

Obsoleto. Essa função foi descontinuada e não deve ser usada em novos scripts.

Define em massa todas as propriedades extraídas do objeto especificado.

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

Parâmetros

Nome	Tipo	Descrição
`properties`	`Object`	um objeto que contém as propriedades a serem definidas.
`deleteAllOthers`	`Boolean`	se todas as propriedades atuais serão excluídas.

Retornar

UserProperties: este objeto, para encadeamento

Consulte também

setProperty(key, value)

`setProperty(key, value)`

Obsoleto. Essa função foi descontinuada e não deve ser usada em novos scripts.

Persistência do valor especificado com a chave fornecida. Qualquer valor associado a essa chave será substituído.

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

Parâmetros

Nome	Tipo	Descrição
`key`	`String`	chave da propriedade
`value`	`String`	valor a ser associado à chave

Retornar

UserProperties: este objeto, para encadeamento

Consulte também

getProperty(key)