Một thao tác cho phép tương tác trong các thành phần trên giao diện người dùng. Thao tác không xảy ra trực tiếp trên ứng dụng mà sẽ gọi một hàm callback Apps Script với các thông số không bắt buộc.
Được cung cấp cho 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 | Kiểu dữ liệu trả về | Mô tả ngắn |
|---|---|---|
setFunctionName(functionName) | Action | Đặt tên cần gọi cho hàm callback. |
setInteraction(interaction) | Action | Đặt hoạt động 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 hành động đang được thực hiện. |
setParameters(parameters) | Action | Cho phép truyền thông số tùy chỉnh đến hàm callback. |
setPersistValues(persistValues) | Action | Cho biết liệu các giá trị của biểu mẫu được xác định theo giá trị của ứng dụng hay giá trị của máy chủ
sau khi phản hồi của thao tác cập nhật Card của biểu mẫu. |
Tài liệu chi tiết
setFunctionName(functionName)
Đặt tên cần gọi cho hàm callback. Bắt buộc.
Tham số
| Tên | Loại | Nội dung mô tả |
|---|---|---|
functionName | String | Tên của hàm. 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
Action – Đối tượng này để tạo chuỗi.
setInteraction(interaction)
Đặt hoạt động tương tác với người dùng (chỉ bắt buộc khi mở hộp thoại). Nếu không chỉ định, ứng dụng sẽ phản hồi bằng cách thực thi một 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ành cho các ứng dụng Google Chat. Không sử dụng được với 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 | Nội dung mô tả |
|---|---|---|
interaction | Interaction | Hành động 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 hành động đang được thực hiện.
Tham số
| Tên | Loại | Nội dung 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ố tùy chỉnh đến hàm callback. Không bắt buộc.
Tham số
| Tên | Loại | Nội dung 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 liệu các giá trị của biểu mẫu được xác định theo giá trị của ứng dụng hay giá trị của máy chủ
sau khi phản hồi của thao tác cập nhật Card của biểu mẫu. Khi bạn đặt thành true, các giá trị của ứng dụng sẽ vẫn tồn tại sau phản hồi của máy chủ. Khi bạn đặt thành false, các giá trị của máy chủ sẽ ghi đè các giá trị biểu mẫu. Giá trị mặc định là false.
Việc duy trì các giá trị ứng dụng sẽ giúp ngăn chặn các trường hợp mà 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 TextInput sau khi 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 duy trì, nội dung chỉnh sửa mà người dùng đã thực hiện vẫn sẽ sau khi phản hồi của máy chủ sẽ cập nhật Card; nếu không, giá trị biểu mẫu sẽ trả về giá trị mà người dùng đã gửi cho biểu mẫu lúc ban đầu.
Việc duy trì các giá trị ứng dụng có thể ảnh hưởng đến khả năng tập lệnh của bạn xoá các trường 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 đó. Nếu không có tính ổn đị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ó hành động onChange.
// 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 | Nội dung mô tả |
|---|---|---|
persistValues | Boolean | Liệu có lưu giữ 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.