این صفحه به‌وسیله ‏Cloud Translation API‏ ترجمه شده است.

Class UserProperties

منسوخ شده است. این کلاس منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.

ویژگی های کاربر جفت های کلید-مقدار منحصر به فرد یک کاربر هستند. ویژگی های کاربر به ازای هر کاربر محدوده می شود. هر اسکریپتی که تحت هویت یک کاربر اجرا می شود می تواند فقط برای آن کاربر به ویژگی های کاربر دسترسی داشته باشد.

روش های منسوخ شده

روش	نوع برگشت	شرح مختصر
`deleteAllProperties()`	`UserProperties`	تمام خواص را حذف می کند.
`deleteProperty(key)`	`UserProperties`	ویژگی را با کلید داده شده حذف می کند.
`getKeys()`	`String[]`	تمام کلیدهای موجود را دریافت کنید.
`getProperties()`	`Object`	همه املاک موجود را یکجا دریافت کنید.
`getProperty(key)`	`String`	مقدار مرتبط با کلید ارائه شده را برمی‌گرداند یا اگر چنین مقداری وجود نداشته باشد، null را برمی‌گرداند.
`setProperties(properties)`	`UserProperties`	انبوه تمام خصوصیات استخراج شده از شی داده شده را تنظیم می کند.
`setProperties(properties, deleteAllOthers)`	`UserProperties`	انبوه تمام خصوصیات استخراج شده از شی داده شده را تنظیم می کند.
`setProperty(key, value)`	`UserProperties`	مقدار مشخص شده را با کلید ارائه شده حفظ می کند.

روش های منسوخ شده

`deleteAllProperties()`

منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.

تمام خصوصیات را حذف می کند.

UserProperties.deleteAllProperties();

بازگشت

UserProperties - این شیء، برای زنجیر کردن

همچنین ببینید

deleteProperty(key)

`deleteProperty(key)`

منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.

ویژگی را با کلید داده شده حذف می کند.

UserProperties.deleteProperty('special');

پارامترها

نام	تایپ کنید	توضیحات
`key`	`String`	کلید برای حذف ملک

بازگشت

UserProperties - این شیء، برای زنجیر کردن

همچنین ببینید

deleteAllProperties()

`getKeys()`

منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.

تمام کلیدهای موجود را دریافت کنید.

بازگشت

String[]

`getProperties()`

منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.

همه املاک موجود را یکجا دریافت کنید.

این یک کپی می دهد، نه یک نمای زنده، بنابراین تغییر ویژگی ها در شیء برگشتی آنها را در ذخیره سازی به روز نمی کند و بالعکس.

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 - یک کپی از ویژگی های حاوی جفت های کلید-مقدار

`getProperty(key)`

منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.

مقدار مرتبط با کلید ارائه شده را برمی‌گرداند یا اگر چنین مقداری وجود نداشته باشد، null را برمی‌گرداند.

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

پارامترها

نام	تایپ کنید	توضیحات
`key`	`String`	کلید برای بازیابی مقدار

بازگشت

String - مقدار مرتبط با کلید

همچنین ببینید

setProperty(key, value)

`setProperties(properties)`

منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.

انبوه تمام خصوصیات استخراج شده از شی داده شده را تنظیم می کند.

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

پارامترها

نام	تایپ کنید	توضیحات
`properties`	`Object`	یک شی حاوی خصوصیات برای تنظیم.

بازگشت

UserProperties - این شیء، برای زنجیر کردن

همچنین ببینید

setProperty(key, value)

`setProperties(properties, deleteAllOthers)`

منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.

انبوه تمام خصوصیات استخراج شده از شی داده شده را تنظیم می کند.

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

پارامترها

نام	تایپ کنید	توضیحات
`properties`	`Object`	یک شی حاوی خصوصیات برای تنظیم.
`deleteAllOthers`	`Boolean`	آیا برای حذف تمام ویژگی های موجود.

بازگشت

UserProperties - این شیء، برای زنجیر کردن

همچنین ببینید

setProperty(key, value)

`setProperty(key, value)`

منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.

مقدار مشخص شده را با کلید ارائه شده حفظ می کند. هر مقدار موجود مرتبط با این کلید بازنویسی خواهد شد.

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

پارامترها

نام	تایپ کنید	توضیحات
`key`	`String`	کلید ملک
`value`	`String`	ارزش برای ارتباط با کلید

بازگشت

UserProperties - این شیء، برای زنجیر کردن

همچنین ببینید

getProperty(key)