Trang này được dịch bởi Cloud Translation API.

Class DecoratedText

Một tiện ích hiển thị văn bản có các 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 dùng để thay thế KeyValue.

Có sẵn cho các ứng dụng Tiện ích bổ sung của Google Workspace và 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	Loại dữ liệu trả về	Mô tả ngắn
`setAuthorizationAction(action)`	`DecoratedText`	Đặ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.
`setBottomLabel(text)`	`DecoratedText`	Đặt văn bản nhãn để dùng làm khoá và hiển thị bên dưới nội dung văn bản.
`setButton(button)`	`DecoratedText`	Đặt `Button` hiển thị ở 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 hiển thị ở bên phải nội dung.
`setOnClickAction(action)`	`DecoratedText`	Đặt một hành động 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 đối tượng được nhấp vào.
`setOpenLink(openLink)`	`DecoratedText`	Đặt URL sẽ được mở khi đối tượng được nhấp vào.
`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` hiển thị ở 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 để dùng làm khoá và hiển thị phía trên nội dung văn bản.
`setWrapText(wrapText)`	`DecoratedText`	Đặt xem văn bản giá trị sẽ hiển thị trên một dòng hay nhiều dòng.

Tài liệu chi tiết

`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

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

`setBottomLabel(text)`

Đặt văn bản nhãn để dùng làm khoá và hiển thị 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, để tạo chuỗi.

`setButton(button)`

Đặt Button hiển thị ở bên phải văn bản. DecoratedText chỉ có thể hỗ trợ một nút hoặc một nút chuyển.

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, để 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

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

`setEndIcon(endIcon)`

Đặt IconImage không bắt buộc hiển thị ở bên phải nội dung. DecoratedText chỉ có thể hỗ trợ một nút, một nút chuyển 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, để 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

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

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

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

`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, để tạo chuỗi.

`setSwitchControl(switchToSet)`

Đặt Switch hiển thị ở bên phải nội dung. DecoratedText chỉ có thể hỗ trợ một nút hoặc một nút chuyển.

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, để tạo chuỗi.

`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.

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, để tạo chuỗi.

`setTopLabel(text)`

Đặt văn bản nhãn để dùng làm khoá và hiển thị 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, để tạo chuỗi.

`setWrapText(wrapText)`

Đặt xem văn bản giá trị sẽ 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 ngắt dòng và hiển thị trên nhiều dòng. Nếu không, văn bản sẽ bị cắt bớt.

Cầu thủ trả bóng

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