Class UserProperties

ویژگی‌های کاربر

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

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

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

روش	نوع بازگشتی	شرح مختصر
delete All Properties()	User Properties	تمام ویژگی‌ها را حذف می‌کند.
delete Property(key)	User Properties	ویژگی را با کلید داده شده حذف می‌کند.
get Keys()	String[]	تمام کلیدهای موجود را دریافت کنید.
get Properties()	Object	تمام املاک موجود را به طور همزمان دریافت کنید.
get Property(key)	String|null	مقدار مرتبط با کلید ارائه شده را برمی‌گرداند، یا اگر چنین مقداری وجود نداشته باشد null را برمی‌گرداند.
set Properties(properties)	User Properties	Bulk-sets تمام ویژگی‌های استخراج‌شده از شیء داده‌شده را تنظیم می‌کند.
set Properties(properties, deleteAllOthers)	User Properties	Bulk-sets تمام ویژگی‌های استخراج‌شده از شیء داده‌شده را تنظیم می‌کند.
set Property(key, value)	User Properties	مقدار مشخص شده را با کلید ارائه شده حفظ می‌کند.

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

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 را برمی‌گرداند.

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

پارامترها

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

بازگشت

String|null — مقدار مرتبط با کلید

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

• setProperty(key, value)

---

setProperties(properties)

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

Bulk-sets تمام ویژگی‌های استخراج‌شده از شیء داده‌شده را تنظیم می‌کند.

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

پارامترها

نام	نوع	توضیحات
properties	Object	یک شیء حاوی ویژگی‌هایی که باید تنظیم شوند.

بازگشت

UserProperties — این شیء، برای زنجیره‌سازی

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

• setProperty(key, value)

---

setProperties(properties, deleteAllOthers)

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

Bulk-sets تمام ویژگی‌های استخراج‌شده از شیء داده‌شده را تنظیم می‌کند.

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

پارامترها

نام	نوع	توضیحات
properties	Object	یک شیء حاوی ویژگی‌هایی که باید تنظیم شوند.
delete All Others	Boolean	آیا تمام ویژگی‌های موجود حذف شوند یا خیر.

بازگشت

UserProperties — این شیء، برای زنجیره‌سازی

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

• setProperty(key, value)

---

setProperty(key, value)

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

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

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

پارامترها

نام	نوع	توضیحات
key	String	کلید برای ملک
value	String	مقداری که قرار است به کلید مرتبط شود

بازگشت

UserProperties — این شیء، برای زنجیره‌سازی

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

• getProperty(key)