Class TextButton

TextButton

TextButton có nhãn văn bản. Bạn có thể đặt màu nền và huỷ kích hoạt nút này khi cần.

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

const textButton = CardService.newTextButton()
                       .setText('Open Link')
                       .setOpenLink(CardService.newOpenLink().setUrl(
                           'https://www.google.com'));

Phương thức

Phương thứcLoại dữ liệu trả vềMô tả ngắn
setAltText(altText)TextButtonĐặt văn bản thay thế của nút cho tính năng hỗ trợ tiếp cận.
setAuthorizationAction(action)TextButtonĐặ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.
setBackgroundColor(backgroundColor)TextButtonĐặt màu nền cho nút TextButtonStyle.FILLED.
setComposeAction(action, composedEmailType)TextButtonĐặt một thao tác soạn email nháp khi người dùng nhấp vào đối tượng.
setDisabled(disabled)TextButtonĐặt trạng thái của nút là bật hay tắt.
setIcon(icon)TextButtonĐặt Icon được xác định trước để hiển thị trên nút.
setIconUrl(url)TextButtonĐặt URL của một hình ảnh để sử dụng làm biểu tượng của nút này.
setMaterialIcon(icon)TextButtonĐặt biểu tượng Material Design.
setOnClickAction(action)TextButtonThiết lập một thao tác thực thi khi đối tượng được nhấp vào.
setOnClickOpenLinkAction(action)TextButtonĐặt một thao tác mở URL trong thẻ khi đối tượng được nhấp vào.
setOpenLink(openLink)TextButtonĐặt URL sẽ được mở khi đối tượng được nhấp vào.
setOverflowMenu(menu)TextButtonĐặt một trình đơn bật lên để mở khi nhấp vào đối tượng.
setText(text)TextButtonThiết lập văn bản hiển thị trên nút.
setTextButtonStyle(textButtonStyle)TextButtonĐặt kiểu nút.

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. Nếu bạn không đặt chính sách này, hệ thống sẽ đặt văn bản hiển thị trên nút theo mặc định.

Thông số

TênLoạiMô tả
altTextStringVăn bản thay thế để chỉ định cho nút này.

Cầu thủ trả bóng

TextButton – Đố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 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

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


setBackgroundColor(backgroundColor)

Đặt màu nền cho nút TextButtonStyle.FILLED. Nếu bạn không đặt nút TextButtonStyle.FILLED, nút này sẽ sử dụng màu phụ được xác định trong manifest của tiện ích bổ sung. Phương thức này không hoạt động đối với các nút TextButtonStyle.OUTLINED.

Thông số

TênLoạiMô tả
backgroundColorStringMàu ở định dạng #rgb.

Cầu thủ trả bóng

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


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 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.
composedEmailTypeComposedEmailTypeGiá trị enum chỉ định liệu thư nháp đã soạn là thư độc lập hay thư trả lời.

Cầu thủ trả bóng

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


setDisabled(disabled)

Đặt trạng thái của nút là bật hay tắt. Nút bị tắt sẽ chuyển sang màu xám và không thể nhấp vào.

Thông số

TênLoạiMô tả
disabledBooleanTrạng thái bị vô hiệu hoá.

Cầu thủ trả bóng

TextButton – Đố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

TextButton – Đố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 mã 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

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


setMaterialIcon(icon)

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

const textButton = CardService.newTextButton().setMaterialIcon(
    CardService.newMaterialIcon().setName('search'),
);

Thông số

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

Cầu thủ trả bóng

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


setOnClickAction(action)

Đặt một thao tác 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 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

TextButton – Đố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. 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 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

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


Đặt URL sẽ được mở 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

TextButton – Đố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ẽ xuất hiện khi người dùng nhấp vào phần tử này.

Cầu thủ trả bóng

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


setText(text)

Đặt văn bản hiển thị trên nút.

Thông số

TênLoạiMô tả
textStringVăn bản xuất hiện trên nút.

Cầu thủ trả bóng

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


setTextButtonStyle(textButtonStyle)

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

const button =
    CardService.newTextButton()
        .setText('Filled')
        .setTextButtonStyle(CardService.TextButtonStyle.FILLED)
        .setOpenLink(CardService.newOpenLink().setUrl('www.google.com'));

Thông số

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

Cầu thủ trả bóng

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