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){
  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();

पैरामीटर

नामटाइपब्यौरा
nameStringआर्ग्युमेंट का नाम
valueStringआर्ग्युमेंट की वैल्यू

वापसी का टिकट

StateTokenBuilder — चेन बनाने के लिए स्टेट टोकन बिल्डर


withMethod(method)

कॉलबैक फ़ंक्शन सेट करता है. डिफ़ॉल्ट तौर पर, callback() नाम का फ़ंक्शन होता है.

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

पैरामीटर

नामटाइपब्यौरा
methodStringकॉलबैक फ़ंक्शन का नाम, जिसे बिना ब्रैकेट या आर्ग्युमेंट. आपके पास, शामिल की गई लाइब्रेरी के फ़ंक्शन इस्तेमाल करने का विकल्प होता है, जैसे कि Library.libFunction1.

वापसी का टिकट

StateTokenBuilder — चेन बनाने के लिए स्टेट टोकन बिल्डर


withTimeout(seconds)

यह नीति, उस अवधि (सेकंड में) सेट करती है जिसके लिए टोकन मान्य है. डिफ़ॉल्ट अवधि 60 सेकंड है; यह अधिकतम अवधि 3600 सेकंड (1 घंटा) होती है.

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

पैरामीटर

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

वापसी का टिकट

StateTokenBuilder — चेन बनाने के लिए स्टेट टोकन बिल्डर