Class StateTokenBuilder

StateTokenBuilder

סקריפטים יכולים ליצור אסימוני מצב שניתן להשתמש בהם בממשקי API לקריאה חוזרת (כמו תהליכי OAuth).

// Reusable function to generate a callback URL, assuming the script has been published as a
// web app (necessary to obtain the URL programmatically). If the script has not been published
// as a web app, set `var url` in the first line to the URL of your script project (which
// cannot be obtained programmatically).
function getCallbackURL(callbackFunction){
  var url = ScriptApp.getService().getUrl();      // Ends in /exec (for a web app)
  url = url.slice(0, -4) + 'usercallback?state='; // Change /exec to /usercallback
  var stateToken = ScriptApp.newStateToken()
      .withMethod(callbackFunction)
      .withTimeout(120)
      .createToken();
  return url + stateToken;
}

שיטות

שיטה	סוג הערך שמוחזר	תיאור קצר
createToken()	String	יוצרת ייצוג של מחרוזת מוצפנת של אסימון המצב.
withArgument(name, value)	StateTokenBuilder	הוספת ארגומנט לאסימון.
withMethod(method)	StateTokenBuilder	מגדירה פונקציית קריאה חוזרת.
withTimeout(seconds)	StateTokenBuilder	מגדיר את משך הזמן (בשניות) שעבורו האסימון תקף.

תיעוד מפורט

createToken()

יוצרת ייצוג של מחרוזת מוצפנת של אסימון המצב.

var stateToken = ScriptApp.newStateToken().createToken();

החזרות

String – מחרוזת מוצפנת שמייצגת את האסימון

---

withArgument(name, value)

הוספת ארגומנט לאסימון. אפשר לקרוא לשיטה הזו כמה פעמים.

var stateToken = ScriptApp.newStateToken().withArgument('myField', 'myValue').createToken();

פרמטרים

שם	תיאור	התיאור
name	String	שם הארגומנט
value	String	ערך הארגומנט

החזרות

StateTokenBuilder – הכלי ליצירת אסימוני מצב, לשרשורים

---

withMethod(method)

מגדירה פונקציית קריאה חוזרת. ברירת המחדל היא פונקציה בשם callback().

var stateToken = ScriptApp.newStateToken().withMethod('myCallback').createToken();

פרמטרים

שם	תיאור	התיאור
method	String	השם של פונקציית הקריאה החוזרת, מיוצג כמחרוזת ללא סוגריים או ארגומנטים. אפשר להשתמש בפונקציות מהספריות הכלולות, כמו Library.libFunction1.

החזרות

StateTokenBuilder – הכלי ליצירת אסימוני מצב, לשרשורים

---

withTimeout(seconds)

מגדיר את משך הזמן (בשניות) שעבורו האסימון תקף. ברירת המחדל היא 60 שניות, משך הזמן המקסימלי הוא 3,600 שניות (שעה אחת).

var stateToken = ScriptApp.newStateToken().withTimeout(60).createToken();

פרמטרים

שם	תיאור	התיאור
seconds	Integer	משך הזמן שבו האסימון חוקי; הערך המקסימלי הוא 3600

החזרות

StateTokenBuilder – הכלי ליצירת אסימוני מצב, לשרשורים