Class StateTokenBuilder

StateTokenBuilder

इस कुकी से स्क्रिप्ट को ऐसे स्टेट टोकन बनाने की अनुमति मिलती है जिनका इस्तेमाल कॉलबैक एपीआई (जैसे कि 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;
}

तरीके

तरीकारिटर्न टाइपसंक्षिप्त विवरण
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 सेकंड होता है. इसकी ज़्यादा से ज़्यादा अवधि 3600 सेकंड (एक घंटा) होती है. 

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

पैरामीटर

नामटाइपब्यौरा
secondsIntegerटोकन के मान्य रहने की अवधि. इसकी ज़्यादा से ज़्यादा वैल्यू 3600 है.

वापसी का टिकट

StateTokenBuilder — यह स्टेट टोकन बिल्डर है, जिसका इस्तेमाल चेनिंग के लिए किया जाता है.