Class TextButton

TextButton

TextButton với nhãn văn bản. Bạn có thể đặt màu nền và tắt nút này khi cần.

Dùng được cho các tiện ích bổ sung của Google Workspace và ứng dụng Google Chat.

var 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)TextButtonThiết lập một thao tác uỷ quyền sẽ mở một URL trong quy trình uỷ quyền khi đối tượng đã nhấp vào.
setBackgroundColor(backgroundColor)TextButtonĐặt màu nền cho nút TextButtonStyle.FILLED.
setComposeAction(action, composedEmailType)TextButtonThiế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.
setDisabled(disabled)TextButtonĐặt xem nút có bị tắt hay không.
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)TextButtonThiết lập một hành động mở URL trong một thẻ khi người dùng nhấp vào đối tượng.
setOpenLink(openLink)TextButtonĐặt URL mở ra khi đối tượng được nhấp vào.
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 cho tính năng hỗ trợ tiếp cận. Nếu bạn không đặt chính sách này, hệ thống sẽ đặt mặc định văn bản hiển thị trên nút.

Tham số

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

Cầu thủ trả bóng

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


setAuthorizationAction(action)

Thiết lập một thao tác uỷ quyền sẽ mở một URL trong quy trình uỷ quyền khi đối tượng đã nhấp vào. Thao tác này sẽ mở URL trong một cửa sổ mới. Khi người dùng hoàn thành quy trình uỷ quyền và quay lại ứng dụng, tiện ích bổ sung sẽ tải lại.

Mỗi đối tượng giao diện người dùng chỉ được 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ạiMô tả
actionAuthorizationActionĐối tượng chỉ định hành động uỷ quyền cần thực hiện khi phần tử này được đã nhấp vào.

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

Tham 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)

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. Đối tượng giao diện người dùng chỉ có thể có một trong các giá trị sau: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), Đã đặt 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ạiMô tả
actionActionĐối tượng chỉ định thao tác cần thực hiện khi phần tử này được đã nhấp vào.
composedEmailTypeComposedEmailTypeGiá trị enum chỉ định liệu bản nháp đã soạn có phải là thư nháp độc lập hoặc thư trả lời.

Cầu thủ trả bóng

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


setDisabled(disabled)

Đặt xem nút có bị tắt hay không. Nút đã bị vô hiệu hoá có màu xám và không thể nhấp vào được.

Tham 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.


setOnClickAction(action)

Thiết lập một thao tác thực thi khi đối tượng được nhấp vào. Đối tượng giao diện người dùng chỉ có thể có một trong Đã đặt 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ạiMô tả
actionActionThao tác 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.


setOnClickOpenLinkAction(action)

Thiết lập 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 Bạn cần tạo URL hoặc khi bạn cần thực hiện thêm thao tác khá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 thuộc tính sau: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action), hoặc Đã đặt 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ạ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 phần tử này đã nhấp vào.

Cầu thủ trả bóng

TextButton – Đố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 chức năng này khi URL đã đã biết và chỉ cần mở ra. Đối tượng giao diện người dùng chỉ có thể có một trong các thuộc tính setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) hoặc setComposeAction(action, composedEmailType) được đặt.

Tham 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.


setText(text)

Thiết lập văn bản hiển thị trên nút.

Tham 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.

Tham 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.