Class TextButton

Nút văn bản

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

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

Phương pháp

Phương thứcLoại 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 sẽ mở URL thành luồng uỷ quyền khi đối tượng được nhấp vào.
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 việc nút này có tắt hay không.
setOnClickAction(action)TextButtonĐặt một thao tác thực thi khi nhấp vào đối tượng.
setOnClickOpenLinkAction(action)TextButtonĐặt thao tác mở URL trong một thẻ khi đối tượng được nhấp vào.
setOpenLink(openLink)TextButtonĐặt URL để mở khi người dùng 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ế cho nút hỗ trợ tiếp cận. Nếu bạn không đặt chính sách này, thì hệ thống sẽ mặc định đặt văn bản hiển thị trên nút.

Các tham số

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

Hai chiều

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


setAuthorizationAction(action)

Đặt một thao tác uỷ quyền sẽ mở URL thành luồng uỷ quyền khi đối tượng được 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 kết thúc quy trình ủy quyền và quay lại ứng dụng, tiện ích bổ sung sẽ tải lại.

Bạn chỉ có thể đặt một trong các đối tượng giao diện người dùng 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);

Các tham số

TênLoạiMô tả
actionAuthorizationActionĐối tượng chỉ định thao tác ủy quyền cần thực hiện khi nhấp vào phần tử này.

Hai chiều

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 TextButtonStyle.FILLED cho nút này, nút này sẽ sử dụng màu phụ được xác định trong tệp kê khai bổ sung. Phương thức này không hoạt động đối với các nút TextButtonStyle.TEXT.

Các tham số

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

Hai chiều

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 đặt một trong các giá trị cho 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();
}

Các tham 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 cho biết bản nháp là bản nháp hay là thư trả lời.

Hai chiều

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


setDisabled(disabled)

Thiết lập việc nút này có tắt hay không. Nút đã tắt có màu xám và không nhấp được.

Các tham số

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

Hai chiều

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


setOnClickAction(action)

Đặt một thao tác thực thi khi nhấp vào đối tượng. Bạn chỉ có thể đặt một trong các đối tượng giao diện người dùng 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();
}

Các tham số

TênLoạiMô tả
actionActionHành động cần thực hiện khi nhấp vào phần tử này.

Hai chiều

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


setOnClickOpenLinkAction(action)

Đặ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 trong tiện ích bổ sung để tạo đối tượng OpenLink. Bạn chỉ có thể đặt một trong các đối tượng giao diện người dùng 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();
}

Các tham số

TênLoạiMô tả
actionActionĐối tượng chỉ định hành động liên kết đang mở khi thực hiện phần tử này.

Hai chiều

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


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

Các tham số

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

Hai chiều

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.

Các tham số

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

Hai chiều

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ì hệ thống sẽ mặc định đặt nút TextButtonStyle.TEXT.

Các tham số

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

Hai chiều

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