Class StateTokenBuilder

StateTokenBuilder

Cho phép tập lệnh tạo mã thông báo trạng thái có thể sử dụng trong API gọi lại (như luồng 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;
}

Phương thức

Phương thứcKiểu dữ liệu trả vềMô tả ngắn
createToken()StringTạo một chuỗi đại diện đã mã hoá của mã thông báo trạng thái.
withArgument(name, value)StateTokenBuilderThêm một đối số vào mã thông báo.
withMethod(method)StateTokenBuilderĐặt một hàm callback.
withTimeout(seconds)StateTokenBuilderĐặt thời lượng (tính bằng giây) mà mã thông báo có hiệu lực.

Tài liệu chi tiết

createToken()

Tạo một chuỗi đại diện đã mã hoá của mã thông báo trạng thái.

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

Cầu thủ trả bóng

String – một chuỗi đã mã hoá đại diện cho mã thông báo


withArgument(name, value)

Thêm một đối số vào mã thông báo. Phương thức này có thể được gọi nhiều lần.

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

Các tham số

TênLoạiNội dung mô tả
nameStringtên của đối số
valueStringgiá trị của đối số

Cầu thủ trả bóng

StateTokenBuilder – trình tạo mã thông báo trạng thái để tạo chuỗi


withMethod(method)

Đặt một hàm callback. Giá trị mặc định là hàm có tên callback().

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

Các tham số

TênLoạiNội dung mô tả
methodStringTên của hàm callback, được biểu thị dưới dạng một chuỗi không có dấu ngoặc đơn hoặc đối số. Bạn có thể sử dụng hàm trong các thư viện đi kèm, chẳng hạn như Library.libFunction1.

Cầu thủ trả bóng

StateTokenBuilder – trình tạo mã thông báo trạng thái để tạo chuỗi


withTimeout(seconds)

Đặt thời lượng (tính bằng giây) mà mã thông báo có hiệu lực. Giá trị mặc định là 60 giây; thời lượng tối đa là 3600 giây (1 giờ).

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

Các tham số

TênLoạiNội dung mô tả
secondsIntegerkhoảng thời gian mã thông báo có hiệu lực; giá trị tối đa là 3600

Cầu thủ trả bóng

StateTokenBuilder – trình tạo mã thông báo trạng thái để tạo chuỗi