Class StateTokenBuilder

StateTokenBuilder

Cho phép tập lệnh tạo mã thông báo trạng thái có thể dùng trong các API gọi lại (chẳng hạn như các 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) {
  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;
}

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 được mã hoá biểu thị 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 được mã hoá biểu thị mã thông báo trạng thái.

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

Cầu thủ trả bóng

String – Một chuỗi được mã hoá biểu thị mã thông báo.


withArgument(name, value)

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

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

Thông số

TênLoạiMô 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, để liên kết.


withMethod(method)

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

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

Thông số

TênLoạiMô 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 các hàm trong 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, để liên kết.


withTimeout(seconds)

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

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

Thông số

TênLoạiMô tả
secondsIntegerThời lượng mà 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, để liên kết.