Class DecoratedText

Văn bảnđược trang trí

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ể 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ứcKiểu dữ liệu trả vềMô tả ngắn
addEventAction(eventAction)WidgetThê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.

Thông số

TênLoạiMô tả
eventActionEventActionEventAction 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);

Thông số

TênLoạiMô tả
actionAuthorizationActionĐố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.

Thông số

TênLoạiMô tả
textStringVă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. Một DecoratedText chỉ có thể hỗ trợ một nút hoặc một công tắc.

Thông số

TênLoạiMô tả
buttonButtonNú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 gọi lại trả về đối tượng ComposeActionResponse được định cấu hình bằng ComposeActionResponseBuilder.setGmailDraft(draft). 

// ...

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

Thông số

TênLoạiMô tả
actionActionĐố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.
composedEmailTypeComposedEmailTypeMộ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.

Thông số

TênLoạiMô tả
endIconIconImageBiể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.

Thông số

TênLoạiMô tả
idStringMã 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();
}

Thông số

TênLoạiMô tả
actionActionHà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 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();
}

Thông số

TênLoạiMô tả
actionActionĐố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.

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

Thông số

TênLoạiMô tả
openLinkOpenLinkMộ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.

Thông số

TênLoạiMô tả
startIconIconImageBiể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.

Thông số

TênLoạiMô tả
switchToSetSwitchNút chuyển cầ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ợ định dạng HTML cơ bản. Bắt buộc.

Thông số

TênLoạiMô tả
textStringNộ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.

Thông số

TênLoạiMô tả
textStringVă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".

Thông số

TênLoạiMô tả
visibilityVisibilityVisibility 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.

Thông số

TênLoạiMô tả
wrapTextBooleanNế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.