Class TextButton

NútVăn bản

TextButton có nhãn văn bản. Bạn có thể đặt màu nền và vô hiệu hoá nút 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ức	Loại 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 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 xem nút có bị tắt 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 để 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)	TextButton	Đặt một hành động 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 đố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)	TextButton	Đặt 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 không được đặt, giá trị mặc định sẽ là văn bản xuất hiện trên nút.

Tham số

Tên	Loại	Mô tả
altText	String	Vă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);

Tham số

Tên	Loại	Mô tả
action	AuthorizationAction	Đố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 giá trị cho nút TextButtonStyle.FILLED, thì nút đó 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.

Tham số

Tên	Loại	Mô tả
backgroundColor	String	Mà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).

Lưu ý: Phương thức này không đặt thao tác Compose dùng để mở rộng giao diện người dùng Compose. Thay vào đó, phương thức này kết nối phần tử trên giao diện người dùng này với Action soạn thư nháp trong Apps Script được mở trong Gmail khi thao tác hoàn tất.

// ...

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

Tham số

Tên	Loại	Mô tả
action	Action	Đố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.
composedEmailType	ComposedEmailType	Giá 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 xem nút có bị tắt hay không. Nút bị tắt sẽ chuyển sang màu xám và không thể nhấp vào.

Tham số

Tên	Loại	Mô tả
disabled	Boolean	Trạng thái tắt.

Cầu thủ trả bóng

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

---

setIcon(icon)

Đặt mộ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.

Tham số

Tên	Loại	Mô tả
icon	Icon	Mộ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 thuộc tính này hoặc setIcon(icon) để xác định hình ảnh nút.

Tham số

Tên	Loại	Mô tả
url	String	Đị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'),
);

Tham số

Tên	Loại	Mô tả
icon	MaterialIcon	Biể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 hành động 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();
}

Tham số

Tên	Loại	Mô tả
action	Action	Hà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 thẻ khi đối tượng được nhấp vào. 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();
}

Tham số

Tên	Loại	Mô tả
action	Action	Đối tượng chỉ định hành động 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.

---

setOpenLink(openLink)

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

Tham số

Tên	Loại	Mô tả
openLink	OpenLink	Đố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();

Tham số

Tên	Loại	Mô tả
menu	OverflowMenu	Đối tượng chỉ định trình đơn mục bổ sung sẽ hiển thị 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.

Tham số

Tên	Loại	Mô tả
text	String	Vă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 không được đặt, giá trị mặc định sẽ là nút TextButtonStyle.OUTLINED.

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

Tham số

Tên	Loại	Mô tả
textButtonStyle	TextButtonStyle	Kiểu nút.

Cầu thủ trả bóng

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