Class TextButton

TextButton

Một 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 khi cần.

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

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

Phương thức

Phương thứcKiểu dữ liệu trả vềMô tả ngắn
setAltText(altText)TextButtonĐặt văn bản thay thế của nút để hỗ trợ tiếp cận.
setAuthorizationAction(action)TextButtonĐặ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.
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 xem nút có bị vô hiệu hoá hay không.
setIcon(icon)TextButtonĐặt mộ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 để dùng làm biểu tượng của nút này.
setMaterialIcon(icon)TextButtonĐặt biểu tượng thiết kế theo nguyên tắc Material Design.
setOnClickAction(action)TextButtonĐặt một thao tác sẽ thực thi khi người dùng nhấp vào đối tượng.
setOnClickOpenLinkAction(action)TextButtonĐặt một thao tác mở URL trong thẻ khi người dùng nhấp vào đối tượng.
setOpenLink(openLink)TextButtonĐặt một URL sẽ mở khi người dùng nhấp vào đối tượng.
setOverflowMenu(menu)TextButtonĐặ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.
setText(text)TextButtonĐặt văn bản xuất hiện 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, thì giá trị mặc định sẽ là văn bản xuất hiện trên nút.

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, để 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);

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, để liên kết.

setBackgroundColor(backgroundColor)

Đặt màu nền cho nút TextButtonStyle.FILLED. Nếu bạn không đặt cho nút TextButtonStyle.FILLED, thì nút này sẽ sử dụng màu phụ được xác định trong tệp kê khai 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, để 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). 

// ...

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

Thông số

TênLoạiMô tả
actionActionĐố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.
composedEmailTypeComposedEmailTypeMộ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

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

setDisabled(disabled)

Đặt xem nút có bị vô hiệu hoá hay không. Nút bị vô hiệu hoá 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, để 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.

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, để 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.

Thông số

TênLoạiMô tả
urlStringĐị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

TextButton – Đố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 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, để 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();
}

Thông số

TênLoạiMô tả
actionActionHà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

TextButton – Đố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();
}

Thông số

TênLoạiMô tả
actionActionĐố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

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

Đặ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.

Thông số

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

Cầu thủ trả bóng

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

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, để liên kết.

setText(text)

Đặt văn bản xuất hiện 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, để liên kết.

setTextButtonStyle(textButtonStyle)

Đặ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à 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, để liên kết.