Class ImageButton

ImageButton

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

Được cung cấp cho tiện ích bổ sung của Google Workspace và ứng dụng Google Chat.

var 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ứcKiểu dữ liệu trả vềMô tả ngắn
setAltText(altText)ImageButtonĐặt văn bản thay thế cho nút hỗ trợ tiếp cận.
setAuthorizationAction(action)ImageButtonĐặt một thao tác uỷ quyền mở URL thành quy trình uỷ quyền khi bạn nhấp vào đối tượng.
setComposeAction(action, composedEmailType)ImageButtonĐặt một thao tác soạn email nháp khi đối tượng được nhấp vào.
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 hình ảnh cần sử dụng làm biểu tượng của nút này.
setOnClickAction(action)ImageButtonĐặt một hành động sẽ thực thi khi đối tượng được nhấp vào.
setOnClickOpenLinkAction(action)ImageButtonĐặt một thao tác mở URL trong một thẻ khi đối tượng được nhấp vào.
setOpenLink(openLink)ImageButtonĐặt URL được mở khi đối tượng được nhấp vào.

Tài liệu chi tiết

setAltText(altText)

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

Tham số

TênLoạiNội dung mô 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 thao tác uỷ quyền mở URL thành quy trình uỷ quyền khi bạn 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.

Đố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).

// ...

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

Tham số

TênLoạiNội dung mô 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)

Đặt một thao tác soạn email nháp khi đối tượng được nhấp vào. Đối tượng giao diện người dùng chỉ có thể đặt một trong các giá trị: 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).

// ...

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

// ...

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

Tham số

TênLoạiNội dung mô tả
actionActionĐối tượng chỉ định thao tác soạn thư cần thực hiện khi nhấp vào phần tử này.
composedEmailTypeComposedEmailTypeGiá 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

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


setIcon(icon)

Đặt mộ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.

Tham số

TênLoạiNội dung mô 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 hình ảnh cần 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.

Tham số

TênLoạiNội dung mô tả
urlStringĐịa chỉ URL của hình ảnh được lưu trữ để sử 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.


setOnClickAction(action)

Đặt một hành động sẽ thực thi khi đối tượng được nhấp vào. Mỗi đối tượng giao diện người dùng chỉ có thể đặt một trong các giá trị 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.

// ...

var 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ênLoạiNội dung mô 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 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 cùng với việc tạo đối tượng OpenLink. Đối tượng giao diện người dùng chỉ có thể đặt một trong các giá trị: 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).

// ...

var 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ênLoạiNội dung mô tả
actionActionĐối tượng chỉ định thao tác mở đường liên kết 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.


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

Tham số

TênLoạiNội dung mô 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.