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) {
  let url = ScriptApp.getService().getUrl();  // Ends in /exec (for a web app)
  url = `${
      url.slice(0, -4)}usercallback?state=`;  // Change /exec to /usercallback
  const stateToken = ScriptApp.newStateToken()
                         .withMethod(callbackFunction)
                         .withTimeout(120)
                         .createToken();
  return url + stateToken;
}

Methods

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

תיעוד מפורט

createToken()

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

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

חזרה

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


withArgument(name, value)

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

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

פרמטרים

שםסוגתיאור
nameStringשם הארגומנט.
valueStringהערך של הארגומנט.

חזרה

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


withMethod(method)

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

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

פרמטרים

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

חזרה

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


withTimeout(seconds)

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

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

פרמטרים

שםסוגתיאור
secondsIntegerמשך הזמן שבו הטוקן תקף. הערך המקסימלי הוא 3600.

חזרה

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