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 de um usuário. As propriedades do usuário têm escopo por usuário. nenhum o script executado sob a identidade de um usuário só pode acessar as propriedades desse usuário.
Métodos obsoletos
Método | Tipo de retorno | Breve descrição |
---|---|---|
|
| Exclui todas as propriedades. |
|
| Exclui a propriedade com a chave fornecida. |
| String[] | Consiga todas as chaves disponíveis. |
| Object | Receba todas as propriedades disponíveis de uma só vez. |
| String | Retorna o valor associado à chave fornecida ou retorna nulo se não houver esse valor. |
|
| Define em massa todas as propriedades desenhadas do objeto fornecido. |
|
| Define em massa todas as propriedades desenhadas do objeto fornecido. |
|
| Mantém o valor especificado com a chave fornecida. |
Métodos obsoletos
deleteAllProperties()
deleteAllProperties()
Obsoleto. Essa função foi descontinuada e não deve ser usada em novos scripts.
Exclui todas as propriedades.
UserProperties.deleteAllProperties();
Retornar
: este objeto, para encadeamentoUserProperties
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 fornecida.
UserProperties.deleteProperty('special');
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
key | String | chave para a propriedade excluir |
Retornar
: este objeto, para encadeamentoUserProperties
Consulte também
getKeys()
getKeys()
Obsoleto. Essa função foi descontinuada e não deve ser usada em novos scripts.
Consiga todas as chaves disponíveis.
Retornar
String[]
getProperties()
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, e não uma visualização ao vivo. Dessa forma, alterar as propriedades no objeto retornado não atualizá-los 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)
getProperty(key)
Obsoleto. Essa função foi descontinuada e não deve ser usada em novos scripts.
Retorna o valor associado à chave fornecida ou retorna nulo se não houver esse valor.
var specialValue = UserProperties.getProperty('special');
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
key | String | chave para o valor recuperar |
Retornar
String
: o valor associado à chave.
Consulte também
setProperties(properties)
setProperties(properties)
Obsoleto. Essa função foi descontinuada e não deve ser usada em novos scripts.
Define em massa todas as propriedades desenhadas do objeto fornecido.
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
: este objeto, para encadeamentoUserProperties
Consulte também
setProperties(properties, deleteAllOthers)
setProperties(properties, deleteAllOthers)
Obsoleto. Essa função foi descontinuada e não deve ser usada em novos scripts.
Define em massa todas as propriedades desenhadas do objeto fornecido.
// 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 | ou se quer excluir todas as propriedades existentes. |
Retornar
: este objeto, para encadeamentoUserProperties
Consulte também
setProperty(key, value)
setProperty(key, value)
Obsoleto. Essa função foi descontinuada e não deve ser usada em novos scripts.
Mantém o valor especificado com a chave fornecida. Qualquer valor associado a essa será substituída.
UserProperties.setProperty('special', 'sauce');
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
key | String | chave para propriedade |
value | String | o valor a ser associado à chave |
Retornar
: este objeto, para encadeamentoUserProperties