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 set
và một trong các khoá Decorated
, Decorated
, set
hoặc set
. Lớp này dùng để thay thế
.
Key
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 |
---|---|---|
set | Decorated | Đặ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. |
set | Decorated | Đặ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. |
set | Decorated | Đặt Button hiển thị ở bên phải văn bản. |
set | Decorated | Đặt một thao tác soạn email nháp khi người dùng nhấp vào đối tượng. |
set | Decorated | Đặt Icon không bắt buộc hiển thị ở bên phải nội dung. |
set | Decorated | Đặt một hành động thực thi khi người dùng nhấp vào đối tượng. |
set | Decorated | Đặt một thao tác mở URL trong thẻ khi đối tượng được nhấp vào. |
set | Decorated | Đặt URL sẽ được mở khi đối tượng được nhấp vào. |
set | Decorated | Đặt Icon không bắt buộc để hiển thị trước nội dung văn bản. |
set | Decorated | Đặt Switch hiển thị ở bên phải nội dung. |
set | Decorated | Đặt văn bản sẽ được dùng làm giá trị. |
set | Decorated | Đặ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. |
set | Decorated | Đặ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
set Authorization Action(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 set
, set
, set
, set
hoặc set
.
// ... const action = CardService.newAuthorizationAction().setAuthorizationUrl('url'); CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);
Tham số
Tên | Loại | Mô tả |
---|---|---|
action | Authorization | Đố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
Decorated
– Đối tượng này, để tạo chuỗi.
set Bottom Label(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
Decorated
– Đối tượng này, để tạo chuỗi.
set Button(button)
Đặt Button
hiển thị ở bên phải văn bản. Decorated
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
Decorated
– Đối tượng này, để tạo chuỗi.
set Compose Action(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 set
, set
, set
, set
hoặc set
.
Tham số Action
phải chỉ định một hàm gọi lại trả về đối tượng Compose
được định cấu hình bằng Compose
.
// ... 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. |
composed | Composed | 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
Decorated
– Đối tượng này, để tạo chuỗi.
set End Icon(endIcon)
Đặt Icon
không bắt buộc hiển thị ở bên phải nội dung. Decorated
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ả |
---|---|---|
end | Icon | Biểu tượng cần thêm. |
Cầu thủ trả bóng
Decorated
– Đối tượng này, để tạo chuỗi.
set On Click Action(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 set
, set
, set
, set
hoặc set
.
Tham số Action
phải chỉ định một hàm callback trả về đối tượng Action
.
// ... 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
Decorated
– Đối tượng này, để tạo chuỗi.
set On Click Open Link Action(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 Open
. 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 set
, set
, set
, set
hoặc set
.
Tham số Action
phải chỉ định một hàm gọi lại trả về đối tượng Action
được định cấu hình bằng Action
.
// ... 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
Decorated
– Đối tượng này, để tạo chuỗi.
set Open Link(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 set
, set
, set
, set
hoặc set
.
Tham số
Tên | Loại | Mô tả |
---|---|---|
open | Open | Đối tượng Open mô tả URL cần mở. |
Cầu thủ trả bóng
Decorated
– Đối tượng này, để tạo chuỗi.
set Start Icon(startIcon)
Đặt Icon
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ả |
---|---|---|
start | Icon | Biểu tượng cần hiển thị. |
Cầu thủ trả bóng
Decorated
– Đối tượng này, để tạo chuỗi.
set Switch Control(switchToSet)
Đặt Switch
hiển thị ở bên phải nội dung. Decorated
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ả |
---|---|---|
switch | Switch | Nút chuyển để thêm. |
Cầu thủ trả bóng
Decorated
– Đối tượng này, để tạo chuỗi.
set Text(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
Decorated
– Đối tượng này, để tạo chuỗi.
set Top Label(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
Decorated
– Đối tượng này, để tạo chuỗi.
set Wrap Text(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ả |
---|---|---|
wrap | 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
Decorated
– Đối tượng này, để tạo chuỗi.