Class ImageButton

ImageButton

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

Có sẵn cho các ứng dụng Tiện ích bổ sung của Google Workspace và 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ứcLoại 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 hành động uỷ quyền mở URL đến quy trình uỷ quyền khi người dùng nhấp vào đối tượng.
setComposeAction(action, composedEmailType)ImageButtonThiết lập 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 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 để sử 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 Material Design.
setOnClickAction(action)ImageButtonĐặt một thao tác 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 đối tượng được nhấp vào.
setOpenLink(openLink)ImageButtonĐặt URL sẽ được mở khi đối tượng được nhấp vào.
setOverflowMenu(menu)ImageButtonĐặt một trình đơn bật lên để mở khi 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.

Thông số

TênLoạiMô tả
altTextStringVăn bản thay thế để gán cho nút này.

Cầu thủ trả bóng

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


setAuthorizationAction(action)

Đặt một hành động uỷ quyền mở URL đến 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 tập hợp 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);

Thông số

TênLoạiMô tả
actionAuthorizationActionĐối tượng chỉ định thao tác 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 để tạo chuỗi.


setComposeAction(action, composedEmailType)

Thiết lập 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 tập hợp setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) hoặc setComposeAction(action, composedEmailType).

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

// ...

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

// ...

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

Thông số

TênLoạiMô tả
actionActionĐối tượng chỉ định hành động soạn thư cần thực hiện khi nhấp vào phần tử này.
composedEmailTypeComposedEmailTypeMột giá trị enum chỉ định việc bản nháp đã soạn là bản nháp độc lập hay bản nháp câu trả lời.

Cầu thủ trả bóng

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


setIcon(icon)

Đặt Icon được xác định trước để hiển thị trên nút. Bạn phải sử dụng thuộc tính này hoặc setIconUrl(url) để xác định hình ảnh nút.

Thông số

TênLoạiMô tả
iconIconMộ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, để tạo chuỗi.


setIconUrl(url)

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

Thông số

TênLoạiMô tả
urlStringĐịa chỉ URL của 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, để tạo chuỗi.


setImageButtonStyle(imageButtonStyle)

Đặt kiểu nút. Nếu không được đặt, giá trị mặc định sẽ là nút ImageButtonStyle.BORDERLESS.

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

const imageButton = CardService.newImageButton().setImageButtonStyle(
    CardService.ImageButtonStyle.BORDERLESS,
);

Thông số

TênLoạiMô tả
imageButtonStyleImageButtonStyleKiểu nút.

Cầu thủ trả bóng

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


setMaterialIcon(icon)

Đặt biểu tượng Material Design.

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

Thông số

TênLoạiMô tả
iconMaterialIconBiểu tượng Material Design.

Cầu thủ trả bóng

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


setOnClickAction(action)

Thiết lập 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ể có một trong các tập hợp 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();
}

Thông số

TênLoạiMô tả
actionActionHành động cần thực hiện khi nhấp vào phần tử này.

Cầu thủ trả bóng

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


setOnClickOpenLinkAction(action)

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

Tham số Action phải chỉ định một hàm gọi lại 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();
}

Thông số

TênLoạiMô tả
actionActionĐối tượng chỉ định thao tác cần thực hiện đối với đường liên kết mở 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, để tạo chuỗi.


Đặt URL mở ra khi đối tượng được nhấp vào. 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ể có một trong các tập hợp setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) hoặc setComposeAction(action, composedEmailType).

Thông số

TênLoạiMô tả
openLinkOpenLinkĐối tượng OpenLink mô tả URL cần mở.

Cầu thủ trả bóng

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


setOverflowMenu(menu)

Đặt một trình đơn bật lên để mở khi nhấp vào đối tượng. Mỗi mục trong trình đơn có thể chỉ định một thao tác sẽ được kích hoạt khi được 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.

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

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();

Thông số

TênLoạiMô tả
menuOverflowMenuĐối tượng chỉ định trình đơn mục bổ sung sẽ hiển thị 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, để tạo chuỗi.