Class StateTokenBuilder

StateTokenBuilder

อนุญาตให้สคริปต์สร้างโทเค็นสถานะที่ใช้ใน API ของ Callback ได้ (เช่น ขั้นตอน 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	ตั้งค่าฟังก์ชัน Callback
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 ค่าเริ่มต้นคือฟังก์ชันชื่อ callback()

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

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
method	String	ชื่อของฟังก์ชัน Callback ซึ่งแสดงเป็นสตริงที่ไม่มีวงเล็บ หรือ อาร์กิวเมนต์ คุณใช้ฟังก์ชันจากไลบรารีที่รวมไว้ เช่น Library.libFunction1 ได้

รีเทิร์น

StateTokenBuilder — เครื่องมือสร้างโทเค็นสถานะสำหรับการทำเชน

---

withTimeout(seconds)

ตั้งค่าระยะเวลา (เป็นวินาที) ที่โทเค็นใช้งานได้ ค่าเริ่มต้นคือ 60 วินาที เวลา ระยะเวลาสูงสุดคือ 3,600 วินาที (1 ชั่วโมง)

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

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
seconds	Integer	ระยะเวลาที่โทเค็นใช้งานได้ ค่าสูงสุดคือ 3600

รีเทิร์น

StateTokenBuilder — เครื่องมือสร้างโทเค็นสถานะสำหรับการทำเชน