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שמירת הערך שצוין ב-in במפתח שסופק.

שיטות שהוצאו משימוש

הוצא משימוש. הפונקציה הזו הוצאה משימוש ואין להשתמש בה בסקריפטים חדשים.

מחיקת כל הנכסים.

UserProperties.deleteAllProperties();

חזרה

UserProperties – האובייקט הזה, לצורך שרשור

ראה גם


הוצא משימוש. הפונקציה הזו הוצאה משימוש ואין להשתמש בה בסקריפטים חדשים.

מחיקה של המאפיין עם המפתח שצוין.

UserProperties.deleteProperty('special');

פרמטרים

שםסוגתיאור
keyStringהמפתח של הנכס למחיקה

חזרה

UserProperties – האובייקט הזה, לצורך שרשור

ראה גם


הוצא משימוש. הפונקציה הזו הוצאה משימוש ואין להשתמש בה בסקריפטים חדשים.

הצגת כל המפתחות הזמינים.

חזרה

String[]


הוצא משימוש. הפונקציה הזו הוצאה משימוש ואין להשתמש בה בסקריפטים חדשים.

הצגת כל הנכסים הזמינים בבת אחת.

כך מקבלים עותק, ולא תצוגה פעילה, ולכן שינוי המאפיינים באובייקט המוחזר לא יעדכן אותם באחסון ולהפך.

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 – עותק של המאפיינים שמכילים צמדי מפתח/ערך


הוצא משימוש. הפונקציה הזו הוצאה משימוש ואין להשתמש בה בסקריפטים חדשים.

הפונקציה מחזירה את הערך שמשויך למפתח שצוין, או null אם אין ערך כזה.

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

פרמטרים

שםסוגתיאור
keyStringהמפתח של הערך לאחזור

חזרה

String – הערך שמשויך למפתח

ראה גם


הוצא משימוש. הפונקציה הזו הוצאה משימוש ואין להשתמש בה בסקריפטים חדשים.

הגדרה בכמות גדולה של כל המאפיינים שצוינו מהאובייקט הנתון.

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

פרמטרים

שםסוגתיאור
propertiesObjectאובייקט שמכיל את המאפיינים שרוצים להגדיר.

חזרה

UserProperties – האובייקט הזה, לצורך שרשור

ראה גם


הוצא משימוש. הפונקציה הזו הוצאה משימוש ואין להשתמש בה בסקריפטים חדשים.

הגדרה בכמות גדולה של כל המאפיינים שצוינו מהאובייקט הנתון.

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

פרמטרים

שםסוגתיאור
propertiesObjectאובייקט שמכיל את המאפיינים שרוצים להגדיר.
deleteAllOthersBooleanאם למחוק את כל הנכסים הקיימים.

חזרה

UserProperties – האובייקט הזה, לצורך שרשור

ראה גם


הוצא משימוש. הפונקציה הזו הוצאה משימוש ואין להשתמש בה בסקריפטים חדשים.

שמירת הערך שצוין ב-in במפתח שסופק. כל ערך קיים שמשויך למפתח הזה יוחלף.

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

פרמטרים

שםסוגתיאור
keyStringמפתח לנכס
valueStringהערך שרוצים לשייך למפתח

חזרה

UserProperties – האובייקט הזה, לצורך שרשור

ראה גם