Class ImageButton

ImageButton

Một ImageButton có hình ảnh hiển thị trên đó.

Dành cho tiện ích bổ sung của Google Workspace và ứng dụng Google Chat.

const imageButton =
    CardService.newImageButton()
        .setAltText('An image button with an airplane icon.')
        .setIcon(CardService.Icon.AIRPLANE)
        .setOpenLink(CardService.newOpenLink().setUrl('https://airplane.com'));

Phương thức

Phương thức	Kiểu dữ liệu trả về	Mô tả ngắn
setAltText(altText)	ImageButton	Đặt văn bản thay thế của nút để hỗ trợ tiếp cận.
setAuthorizationAction(action)	ImageButton	Đặt một thao tác uỷ quyền sẽ mở một URL cho quy trình uỷ quyền khi người dùng nhấp vào đối tượng.
setComposeAction(action, composedEmailType)	ImageButton	Đặt một thao tác soạn email nháp khi người dùng nhấp vào đối tượng.
setIcon(icon)	ImageButton	Đặt một Icon được xác định trước để hiển thị trên nút.
setIconUrl(url)	ImageButton	Đặt URL của một hình ảnh để dùng làm biểu tượng của nút này.
setImageButtonStyle(imageButtonStyle)	ImageButton	Đặt kiểu nút.
setMaterialIcon(icon)	ImageButton	Đặt biểu tượng thiết kế theo nguyên tắc Material Design.
setOnClickAction(action)	ImageButton	Đặt một thao tác sẽ thực thi khi người dùng nhấp vào đối tượng.
setOnClickOpenLinkAction(action)	ImageButton	Đặt một thao tác mở URL trong thẻ khi người dùng nhấp vào đối tượng.
setOpenLink(openLink)	ImageButton	Đặt một URL sẽ mở khi người dùng nhấp vào đối tượng.
setOverflowMenu(menu)	ImageButton	Đặt một trình đơn bật lên sẽ mở ra khi người dùng nhấp vào đối tượng.

Tài liệu chi tiết

setAltText(altText)

Đặt văn bản thay thế của nút để hỗ trợ tiếp cận. Bắt buộc.

Tham số

Tên	Loại	Mô tả
altText	String	Văn bản thay thế để chỉ định cho nút này.

Cầu thủ trả bóng

ImageButton – Đối tượng này, để liên kết.

---

setAuthorizationAction(action)

Đặt một thao tác uỷ quyền sẽ mở một URL cho quy trình uỷ quyền khi người dùng nhấp vào đối tượng. 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ể có một trong các giá trị setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) hoặc setComposeAction(action, composedEmailType) được đặt.

// ...

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 hành động uỷ quyền cần thực hiện khi người dùng nhấp vào phần tử này.

Cầu thủ trả bóng

ImageButton – Đối tượng này, để liên kết.

---

setComposeAction(action, composedEmailType)

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

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 một thao tác soạn thư được dùng để mở rộng giao diện người dùng soạn thư. 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 soạn thảo thư nháp trong Apps Script. Thư nháp này sẽ đượ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 thư cần thực hiện khi người dùng nhấp vào phần tử này.
composedEmailType	ComposedEmailType	Một giá trị enum chỉ định xem bản nháp được tạo là bản nháp độc lập hay bản nháp trả lời.

Cầu thủ trả bóng

ImageButton – Đối tượng này, để liên kết.

---

setIcon(icon)

Đặt một Icon được xác định trước để hiển thị trên nút. Bạn phải dùng tham số này hoặc setIconUrl(url) để xác định hình ảnh của nút.

Tham số

Tên	Loại	Mô tả
icon	Icon	Một trong các giá trị Icon được xác định trước.

Cầu thủ trả bóng

ImageButton – Đối tượng này, để liên kết.

---

setIconUrl(url)

Đặt URL của một hình ảnh để dùng làm biểu tượng của nút này. Bạn phải dùng thuộc tính này hoặc setIcon(icon) để xác định hình ảnh nút.

Tham số

Tên	Loại	Mô tả
url	String	Địa chỉ URL của một hình ảnh được lưu trữ để dùng làm biểu tượng của nút này.

Cầu thủ trả bóng

ImageButton – Đối tượng này, để liên kết.

---

setImageButtonStyle(imageButtonStyle)

Đặt kiểu nút. Nếu bạn không đặt chính sách này, nút mặc định sẽ là ImageButtonStyle.BORDERLESS.

Có trong các ứng dụng Google Chat. Trong bản dùng thử cho nhà phát triển của tiện ích bổ sung 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 imageButton = CardService.newImageButton().setImageButtonStyle(
    CardService.ImageButtonStyle.BORDERLESS,
);

Tham số

Tên	Loại	Mô tả
imageButtonStyle	ImageButtonStyle	Kiểu nút.

Cầu thủ trả bóng

ImageButton – Đối tượng này, để liên kết.

---

setMaterialIcon(icon)

Đặt biểu tượng thiết kế theo nguyên tắc Material Design.

const imageButton = CardService.newImageButton().setMaterialIcon(
    CardService.newMaterialIcon().setName('search'),
);

Tham số

Tên	Loại	Mô tả
icon	MaterialIcon	Biểu tượng Material Design.

Cầu thủ trả bóng

ImageButton – Đối tượng này, để liên kết.

---

setOnClickAction(action)

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

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	Hành động cần thực hiện khi người dùng nhấp vào phần tử này.

Cầu thủ trả bóng

ImageButton – Đối tượng này, để liên kết.

---

setOnClickOpenLinkAction(action)

Đặt một thao tác mở URL trong thẻ khi người dùng nhấp vào đối tượng. 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ể có một trong các giá trị setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) hoặc setComposeAction(action, composedEmailType) được đặt.

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 hành động mở đường liên kết sẽ thực hiện khi người dùng nhấp vào phần tử này.

Cầu thủ trả bóng

ImageButton – Đối tượng này, để liên kết.

---

setOpenLink(openLink)

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

Tham số

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

Cầu thủ trả bóng

ImageButton – Đối tượng này, để liên kết.

---

setOverflowMenu(menu)

Đặt một trình đơn bật lên sẽ mở ra khi người dùng nhấp vào đối tượng. Mỗi mục trong trình đơn đều có thể chỉ định một thao tác sẽ được kích hoạt khi người dùng 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ó trong các ứng dụng Google Chat. Trong bản dùng thử cho nhà phát triển của tiện ích bổ sung 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 sẽ xuất hiện khi người dùng nhấp vào phần tử này.

Cầu thủ trả bóng

ImageButton – Đối tượng này, để liên kết.