Class DecoratedText

DecoratedText

Một tiện ích hiển thị văn bản có các thành phần trang trí không bắt buộc. Các khoá có thể có bao gồm một biểu tượng, một nhãn ở trên và một nhãn ở dưới. Bạn phải đặt nội dung văn bản và một trong các khoá bằng cách sử dụng setText(text) và một trong các khoá DecoratedText, DecoratedText, setTopLabel(text) hoặc setBottomLabel(text). Lớp này được dùng để thay thế KeyValue.

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

const decoratedText =
    CardService.newDecoratedText().setText('Text').setTopLabel('TopLabel');

const multilineDecoratedText = CardService.newDecoratedText()
                                   .setText('Text')
                                   .setTopLabel('TopLabel')
                                   .setWrapText(true)
                                   .setBottomLabel('BottomLabel');

Phương thức

Phương thức	Kiểu dữ liệu trả về	Mô tả ngắn
addEventAction(eventAction)	Widget	Thêm thao tác sự kiện có thể thực hiện trên tiện ích.
setAuthorizationAction(action)	DecoratedText	Đặ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.
setBottomLabel(text)	DecoratedText	Đặt văn bản nhãn sẽ được dùng làm khoá và xuất hiện bên dưới nội dung văn bản.
setButton(button)	DecoratedText	Đặt Button xuất hiện ở bên phải văn bản.
setComposeAction(action, composedEmailType)	DecoratedText	Đặt một thao tác soạn email nháp khi người dùng nhấp vào đối tượng.
setEndIcon(endIcon)	DecoratedText	Đặt IconImage không bắt buộc xuất hiện ở bên phải nội dung.
setId(id)	Widget	Đặt mã nhận dạng duy nhất được chỉ định dùng để xác định tiện ích cần thay đổi.
setOnClickAction(action)	DecoratedText	Đặt một thao tác sẽ thực thi khi người dùng nhấp vào đối tượng.
setOnClickOpenLinkAction(action)	DecoratedText	Đặt một thao tác mở URL trong thẻ khi người dùng nhấp vào đối tượng.
setOpenLink(openLink)	DecoratedText	Đặt một URL sẽ mở khi người dùng nhấp vào đối tượng.
setStartIcon(startIcon)	DecoratedText	Đặt IconImage không bắt buộc để hiển thị trước nội dung văn bản.
setSwitchControl(switchToSet)	DecoratedText	Đặt Switch xuất hiện ở bên phải nội dung.
setText(text)	DecoratedText	Đặt văn bản sẽ được dùng làm giá trị.
setTopLabel(text)	DecoratedText	Đặt văn bản nhãn sẽ được dùng làm khoá và xuất hiện phía trên nội dung văn bản.
setVisibility(visibility)	Widget	Đặt chế độ hiển thị của tiện ích.
setWrapText(wrapText)	DecoratedText	Đặt xem văn bản giá trị có được hiển thị trên một dòng hay nhiều dòng.

Tài liệu chi tiết

addEventAction(eventAction)

Thêm thao tác sự kiện có thể thực hiện trên tiện ích.

Tham số

Tên	Loại	Mô tả
eventAction	EventAction	EventAction cần thêm.

Cầu thủ trả bóng

Widget – Đối tượng, để 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);

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

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

---

setBottomLabel(text)

Đặt văn bản nhãn sẽ được dùng làm khoá và xuất hiện bên dưới nội dung văn bản.

Tham số

Tên	Loại	Mô tả
text	String	Văn bản nhãn.

Cầu thủ trả bóng

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

---

setButton(button)

Đặt Button xuất hiện ở bên phải văn bản. DecoratedText chỉ có thể hỗ trợ một nút hoặc một công tắc.

Tham số

Tên	Loại	Mô tả
button	Button	Nút để thêm.

Cầu thủ trả bóng

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

Lưu ý: Phương thức này không đặt một thao tác soạn thư được dùng để mở rộng giao diện người dùng soạn thư. 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 một Action soạn thảo thư nháp trong Apps Script. Thư nháp này sẽ đượ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 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.
composedEmailType	ComposedEmailType	Mộ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

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

---

setEndIcon(endIcon)

Đặt IconImage không bắt buộc xuất hiện ở bên phải nội dung. DecoratedText chỉ có thể hỗ trợ một nút, một công tắc hoặc một biểu tượng.

Tham số

Tên	Loại	Mô tả
endIcon	IconImage	Biểu tượng cần thêm.

Cầu thủ trả bóng

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

---

setId(id)

Đặt mã nhận dạng duy nhất được chỉ định dùng để xác định tiện ích cần thay đổi. Chỉ có Tiện ích bổ sung mới hỗ trợ thao tác thay đổi tiện ích.

Tham số

Tên	Loại	Mô tả
id	String	Mã nhận dạng của tiện ích, có giới hạn 64 ký tự và ở định dạng `[a-zA-Z0-9-]+`.

Cầu thủ trả bóng

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

Tham số

Tên	Loại	Mô tả
action	Action	Hà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

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

Tham số

Tên	Loại	Mô tả
action	Action	Đố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

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

---

setOpenLink(openLink)

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

Tham số

Tên	Loại	Mô tả
openLink	OpenLink	Một đối tượng OpenLink mô tả URL cần mở.

Cầu thủ trả bóng

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

---

setStartIcon(startIcon)

Đặt IconImage không bắt buộc để hiển thị trước nội dung văn bản.

Tham số

Tên	Loại	Mô tả
startIcon	IconImage	Biểu tượng cần hiển thị.

Cầu thủ trả bóng

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

---

setSwitchControl(switchToSet)

Đặt Switch xuất hiện ở bên phải nội dung. DecoratedText chỉ có thể hỗ trợ một nút hoặc một công tắc.

Tham số

Tên	Loại	Mô tả
switchToSet	Switch	Nút chuyển để thêm.

Cầu thủ trả bóng

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

---

setText(text)

Đặt văn bản sẽ được dùng làm giá trị. Hỗ trợ chế độ HTML cơ bản. Bắt buộc.

Tham số

Tên	Loại	Mô tả
text	String	Nội dung văn bản cho tiện ích này.

Cầu thủ trả bóng

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

---

setTopLabel(text)

Đặt văn bản nhãn sẽ được dùng làm khoá và xuất hiện phía trên nội dung văn bản.

Tham số

Tên	Loại	Mô tả
text	String	Văn bản nhãn.

Cầu thủ trả bóng

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

---

setVisibility(visibility)

Đặt chế độ hiển thị của tiện ích. Giá trị mặc định là "VISIBLE".

Tham số

Tên	Loại	Mô tả
visibility	Visibility	Visibility của tiện ích.

Cầu thủ trả bóng

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

---

setWrapText(wrapText)

Đặt xem văn bản giá trị có được hiển thị trên một dòng hay nhiều dòng.

Tham số

Tên	Loại	Mô tả
wrapText	Boolean	Nếu true, văn bản sẽ được xuống dòng và hiển thị trên nhiều dòng. Nếu không, văn bản sẽ bị rút ngắn.

Cầu thủ trả bóng

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