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)