Class UserProperties

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)