Class StateTokenBuilder

Trình tạoMã thông báotrạng thái

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 (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) {
  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ứcLoại dữ liệu trả vềMô tả ngắn
createToken()StringTạo một chuỗi đã mã hoá đại diện cho 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 gọi lại.
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 đã mã hoá đại diện cho 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 đã 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. Bạn có thể gọi phương thức này nhiều lần.

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

Tham 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, để tạo chuỗi


withMethod(method)

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

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

Tham 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 từ 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. Thời lượng 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();

Tham số

TênLoạiMô tả
secondsIntegerkhoảng thời gian mã thông báo hợp lệ; 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