Class Action

Hành động

Một thao tác bật tính năng tương tác trong các phần tử trên giao diện người dùng. Hành động này không diễn ra trực tiếp trên ứng dụng mà gọi một hàm callback Apps Script với các tham số không bắt buộc.

Dùng được cho các tiện ích bổ sung của Google Workspace và ứng dụng Google Chat.

var image = CardService.newImage()
    .setOnClickAction(CardService.newAction()
        .setFunctionName("handleImageClick")
        .setParameters({imageSrc: 'carImage'}));

Phương thức

Phương thức	Loại dữ liệu trả về	Mô tả ngắn
addRequiredWidget(requiredWidget)	Action	Thêm tên của các tiện ích mà Hành động này cần để gửi một lượt gửi hợp lệ.
setAllWidgetsAreRequired(allWidgetsAreRequired)	Action	Cho biết liệu Hành động này có yêu cầu dữ liệu đầu vào từ tất cả tiện ích hay không.
setFunctionName(functionName)	Action	Đặt tên cho hàm callback sẽ được gọi.
setInteraction(interaction)	Action	Đặt lượt tương tác với người dùng, chỉ bắt buộc khi mở hộp thoại.
setLoadIndicator(loadIndicator)	Action	Đặt chỉ báo tải hiển thị trong khi đang thực hiện hành động.
setParameters(parameters)	Action	Cho phép truyền thông số tuỳ chỉnh đến hàm callback.
setPersistValues(persistValues)	Action	Cho biết giá trị của biểu mẫu là do giá trị của ứng dụng hay giá trị của máy chủ xác định sau khi phản hồi hành động cập nhật Card của biểu mẫu.

Các phương thức ngừng hoạt động

Phương thức	Loại dữ liệu trả về	Mô tả ngắn
setMethodName(functionName)	Action

Tài liệu chi tiết

addRequiredWidget(requiredWidget)

Thêm tên của các tiện ích mà Hành động này cần để gửi một lượt gửi hợp lệ. Nếu các tiện ích trong danh sách này không có giá trị khi Hành động này được gọi, quá trình gửi biểu mẫu sẽ bị huỷ.

Chỉ dùng được cho ứng dụng Google Chat. Không dùng được cho các Tiện ích bổ sung của Google Workspace.

var textInput = CardService.newTextInput()
    .setFieldName("text_input_1")
    .setTitle("Text input title")

// Creates a footer button that requires an input from the above TextInput Widget.
var action = CardService.newAction()
    .setFunctionName("notificationCallback")
    .addRequiredWidget("text_input_1");
var fixedFooter =
      CardService
          .newFixedFooter()
          .setPrimaryButton(
              CardService
                  .newTextButton()
                  .setText("help")
                  .setOnClickAction(action));

Tham số

Tên	Loại	Mô tả
requiredWidget	String	Tên của tiện ích mà Hành động này yêu cầu.

Cầu thủ trả bóng

Action – Đối tượng này để tạo chuỗi.

---

setAllWidgetsAreRequired(allWidgetsAreRequired)

Cho biết liệu Hành động này có yêu cầu dữ liệu đầu vào từ tất cả tiện ích hay không.

Chỉ dùng được cho ứng dụng Google Chat. Không dùng được cho các Tiện ích bổ sung của Google Workspace.

// Creates a button with an action that requires inputs from all widgets.
const button = CardService.newTextButton()
    .setText('Create notification')
    .setOnClickAction(
        CardService.newAction()
            .setAllWidgetsAreRequired(true));

Tham số

Tên	Loại	Mô tả
allWidgetsAreRequired	Boolean	Liệu thao tác có cần dữ liệu đầu vào từ tất cả tiện ích hay không. Mặc định là false.

Cầu thủ trả bóng

Action – Đối tượng này để tạo chuỗi.

---

setFunctionName(functionName)

Đặt tên cho hàm callback sẽ được gọi. Bắt buộc.

Tham số

Tên	Loại	Mô tả
functionName	String	Tên hàm. Bạn có thể dùng các hàm trong các thư viện đi kèm, chẳng hạn như Library.libFunction1.

Cầu thủ trả bóng

Action – Đối tượng này để tạo chuỗi.

---

setInteraction(interaction)

Đặt lượt tương tác với người dùng, chỉ bắt buộc khi mở hộp thoại. Nếu bạn không chỉ định, ứng dụng phản hồi bằng cách thực thi Action như mở một đường liên kết hoặc chạy một hàm – như bình thường.

Chỉ dùng được cho ứng dụng Google Chat. Không dùng được cho các Tiện ích bổ sung của Google Workspace.

const action = CardService.newAction()
    .setFunctionName('handleDialog')
    .setInteraction(CardService.Interaction.OPEN_DIALOG);

Tham số

Tên	Loại	Mô tả
interaction	Interaction	Tương tác cần chỉ định.

Cầu thủ trả bóng

Action – Đối tượng này để tạo chuỗi.

---

setLoadIndicator(loadIndicator)

Đặt chỉ báo tải hiển thị trong khi đang thực hiện hành động.

Tham số

Tên	Loại	Mô tả
loadIndicator	LoadIndicator	Chỉ báo để hiển thị.

Cầu thủ trả bóng

Action – Đối tượng này để tạo chuỗi.

---

setParameters(parameters)

Cho phép truyền thông số tuỳ chỉnh đến hàm callback. Không bắt buộc.

Tham số

Tên	Loại	Mô tả
parameters	Object	Cả khoá và giá trị đều phải là chuỗi.

Cầu thủ trả bóng

Action – Đối tượng này để tạo chuỗi.

---

setPersistValues(persistValues)

Cho biết giá trị của biểu mẫu là do giá trị của ứng dụng hay giá trị của máy chủ xác định sau khi phản hồi hành động cập nhật Card của biểu mẫu. Khi được đặt thành true, các giá trị của ứng dụng khách vẫn tồn tại sau khi máy chủ phản hồi. Khi bạn đặt thành false, các giá trị trong biểu mẫu sẽ ghi đè lên các giá trị của biểu mẫu. Giá trị mặc định là false.

Việc duy trì các giá trị ứng dụng giúp ngăn chặn các tình huống trong đó biểu mẫu thay đổi đột ngột sau khi người dùng chỉnh sửa. Ví dụ: nếu người dùng chỉnh sửa một TextInput sau gửi biểu mẫu, nhưng trước khi máy chủ phản hồi. Nếu các giá trị vẫn còn, hãy chỉnh sửa thuộc tính người dùng thực hiện vẫn còn sau khi phản hồi của máy chủ cập nhật Card; nếu không, giá trị biểu mẫu sẽ trả về giá trị mà ban đầu người dùng đã gửi cho biểu mẫu.

Việc duy trì các giá trị của ứng dụng có thể ảnh hưởng đến khả năng xóa các trường trong biểu mẫu hoặc ghi đè các giá trị biểu mẫu, vì vậy, hãy tránh bật tính năng cố định cho loại chức năng đó. Không có cố định, bạn nên sử dụng LoadIndicator.SPINNER cho các sự kiện, vì điều này sẽ khoá giao diện người dùng và ngăn người dùng chỉnh sửa trước khi máy chủ phản hồi. Ngoài ra, bạn có thể sử dụng LoadIndicator.NONE và đảm bảo mọi phần tử trong biểu mẫu đều có onChange hành động.

// Creates a button with an action that persists the client's values as the on-click action.
const button = CardService.newTextButton()
    .setText('Create notification')
    .setOnClickAction(
        CardService.newAction()
            .setPersistValues(true)
            .setFunctionName('functionName'));

Tham số

Tên	Loại	Mô tả
persistValues	Boolean	Liệu có duy trì các giá trị hay không. Giá trị mặc định là false.

Cầu thủ trả bóng

Action – Đối tượng này để tạo chuỗi.

Các phương thức ngừng hoạt động

setMethodName(functionName)

Không dùng nữa. Bí danh cũ của setFunctionName(functionName).

Tham số

Tên	Loại	Mô tả
functionName	String	Tên hàm. Bạn có thể dùng các hàm trong các thư viện đi kèm, chẳng hạn như Library.libFunction1.

Cầu thủ trả bóng

Action – Đối tượng này để tạo chuỗi.