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

Được cung cấp cho 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ứcKiểu dữ liệu trả vềMô tả ngắn
setAltText(altText)TextButtonĐặt văn bản thay thế cho nút hỗ trợ tiếp cận.
setAuthorizationAction(action)TextButtonĐặ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.
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 đối tượng được nhấp vào.
setDisabled(disabled)TextButtonThiết lập xem nút có tắt hay không.
setOnClickAction(action)TextButtonĐặt một hành động sẽ thực thi khi đối tượng được nhấp vào.
setOnClickOpenLinkAction(action)TextButtonĐặt một thao tác mở URL trong một thẻ khi đối tượng được nhấp vào.
setOpenLink(openLink)TextButtonĐặt URL được mở khi đối tượng được nhấp vào.
setText(text)TextButtonThiết lập 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ế cho nút hỗ trợ tiếp cận. Nếu bạn không đặt thì chế độ mặc định sẽ là văn bản xuất hiện trên nút.

Thông 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

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

Thông 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

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 này cho mộ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 cho các nút TextButtonStyle.OUTLINED.

Thông số

TênLoạiNội dung mô 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 đố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();
}

Thông 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

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


setDisabled(disabled)

Thiết lập xem nút có 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.

Thông số

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

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

Thông 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

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

Thông 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

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

Thông 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

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


setText(text)

Thiết lập văn bản xuất hiện trên nút.

Thông số

TênLoạiNội dung mô 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ì chế độ mặc định sẽ là nút TextButtonStyle.OUTLINED.

Thông số

TênLoạiNội dung mô tả
textButtonStyleTextButtonStyleKiểu nút.

Cầu thủ trả bóng

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