Class Button

Button

Lớp cơ sở cho tất cả các nút.

Có sẵn cho tiện ích bổ sung của Google Workspace và ứng dụng Google Chat.

Phương thức

Phương thức	Kiểu dữ liệu trả về	Mô tả ngắn
setAuthorizationAction(action)	Button	Đặt một thao tác uỷ quyền mở URL cho quy trình uỷ quyền khi đối tượng được nhấp vào.
setComposeAction(action, composedEmailType)	Button	Đặt một thao tác soạn email nháp khi đối tượng được nhấp vào.
setOnClickAction(action)	Button	Đặt một thao tác thực thi khi đối tượng được nhấp vào.
setOnClickOpenLinkAction(action)	Button	Đặt một thao tác mở URL trong một thẻ khi đối tượng được nhấp vào.
setOpenLink(openLink)	Button	Đặt một URL sẽ được mở khi đối tượng được nhấp vào.
setOverflowMenu(menu)	Button	Đặt một trình đơn bật lên sẽ được mở khi đối tượng được nhấp vào.

Tài liệu chi tiết

setAuthorizationAction(action)

Đặt một thao tác uỷ quyền mở URL cho quy trình uỷ quyền khi đối tượng được nhấp vào. Thao tác này sẽ mở URL trong một cửa sổ mới. Khi người dùng hoàn tất quy trình uỷ quyền và quay lại ứng dụng, tiện ích bổ sung sẽ tải lại.

Một đối tượng giao diện người dùng chỉ có thể đặt một trong các đối tượng setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) hoặc setComposeAction(action, composedEmailType).

// ...

const action = CardService.newAuthorizationAction().setAuthorizationUrl('url');
CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);

Tham số

Tên	Loại	Mô tả
action	AuthorizationAction	Đối tượng chỉ định thao tác uỷ quyền cần thực hiện khi phần tử này được nhấp vào.

Cầu thủ trả bóng

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

---

setComposeAction(action, composedEmailType)

Đặt một thao tác soạn email nháp khi đối tượng được nhấp vào. Một đối tượng giao diện người dùng chỉ có thể đặt một trong các đối tượng setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) hoặc setComposeAction(action, composedEmailType).

Tham số Action phải chỉ định một hàm callback trả về đối tượng ComposeActionResponse được định cấu hình bằng ComposeActionResponseBuilder.setGmailDraft(draft).

Lưu ý: Phương thức này không đặt thao tác soạn dùng để để mở rộng giao diện người dùng soạn. Thay vào đó, phương thức này kết nối phần tử trên giao diện người dùng này với một Action mà soạn thư nháp trong Apps Script được mở trong Gmail khi thao tác hoàn tất.

// ...

const action = CardService.newAction().setFunctionName('composeEmailCallback');
CardService.newTextButton()
    .setText('Compose Email')
    .setComposeAction(action, CardService.ComposedEmailType.REPLY_AS_DRAFT);

// ...

function composeEmailCallback(e) {
  const thread = GmailApp.getThreadById(e.threadId);
  const draft = thread.createDraftReply('This is a reply');
  return CardService.newComposeActionResponseBuilder()
      .setGmailDraft(draft)
      .build();
}

Tham số

Tên	Loại	Mô tả
action	Action	Đối tượng chỉ định thao tác soạn cần thực hiện khi phần tử này được nhấp vào.
composedEmailType	ComposedEmailType	Giá trị enum chỉ định xem bản nháp đã soạn là bản nháp độc lập hay bản nháp trả lời.

Cầu thủ trả bóng

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

---

setOnClickAction(action)

Đặt một thao tác thực thi khi đối tượng được nhấp vào. Một đối tượng giao diện người dùng chỉ có thể đặt một trong các đối tượng setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) hoặc setComposeAction(action, composedEmailType).

Tham số Action phải chỉ định một hàm callback trả về đối tượng ActionResponse.

// ...

const action = CardService.newAction().setFunctionName('notificationCallback');
CardService.newTextButton()
    .setText('Create notification')
    .setOnClickAction(action);

// ...

function notificationCallback() {
  return CardService.newActionResponseBuilder()
      .setNotification(
          CardService.newNotification().setText('Some info to display to user'),
          )
      .build();
}

Tham số

Tên	Loại	Mô tả
action	Action	Thao tác cần thực hiện khi phần tử này được nhấp vào.

Cầu thủ trả bóng

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

---

setOnClickOpenLinkAction(action)

Đặt một thao tác mở URL trong một thẻ khi đối tượng được nhấp vào. Hãy sử dụng hàm này khi cần tạo URL hoặc khi bạn cần thực hiện các thao tác khác ngoài việc tạo đối tượng OpenLink. Một đối tượng giao diện người dùng chỉ có thể đặt một trong các đối tượng setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) hoặc setComposeAction(action, composedEmailType).

Tham số Action phải chỉ định một hàm callback trả về đối tượng ActionResponse được định cấu hình bằng ActionResponseBuilder.setOpenLink(openLink).

// ...

const action = CardService.newAction().setFunctionName('openLinkCallback');
CardService.newTextButton()
    .setText('Open Link')
    .setOnClickOpenLinkAction(action);

// ...

function openLinkCallback() {
  return CardService.newActionResponseBuilder()
      .setOpenLink(CardService.newOpenLink().setUrl('https://www.google.com'))
      .build();
}

Tham số

Tên	Loại	Mô tả
action	Action	Đối tượng chỉ định thao tác mở đường liên kết cần thực hiện khi phần tử này được nhấp vào.

Cầu thủ trả bóng

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

---

setOpenLink(openLink)

Đặt một URL sẽ được mở khi đối tượng được nhấp vào. Hãy sử dụng hàm này khi URL đã được biết và chỉ cần mở. Một đối tượng giao diện người dùng chỉ có thể đặt một trong các đối tượng setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) hoặc setComposeAction(action, composedEmailType).

Tham số

Tên	Loại	Mô tả
openLink	OpenLink	Đối tượng OpenLink mô tả URL cần mở.

Cầu thủ trả bóng

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

---

setOverflowMenu(menu)

Đặt một trình đơn bật lên sẽ được mở khi đối tượng được nhấp vào. Mỗi mục trong trình đơn có thể chỉ định một thao tác được kích hoạt khi nhấp vào. Không hỗ trợ trình đơn lồng nhau, các thao tác cho mục trong trình đơn không được chỉ định trình đơn mục bổ sung.

Có sẵn cho ứng dụng Google Chat. Trong bản dùng thử cho nhà phát triển đối với tiện ích bổ sung của Google Workspace.

Bản dùng trước cho nhà phát triển: Được cung cấp trong Chương trình Bản dùng trước cho nhà phát triển của Google Workspace, cho phép bạn tiếp cận sớm một số tính năng.

const overflowMenuItem =
    CardService.newOverflowMenuItem()
        .setStartIcon(
            CardService.newIconImage().setIconUrl(
                'https://www.google.com/images/branding/googleg/1x/googleg_standard_color_64dp.png',
                ),
            )
        .setText('Open Link')
        .setOpenLink(
            CardService.newOpenLink().setUrl('https://www.google.com'));

const overflowMenu =
    CardService.newOverflowMenu().addMenuItem(overflowMenuItem).build();

Tham số

Tên	Loại	Mô tả
menu	OverflowMenu	Đối tượng chỉ định trình đơn mục bổ sung cần hiển thị khi phần tử này được nhấp vào.

Cầu thủ trả bóng

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