Tiện ích hiển thị văn bản với các thành phần trang trí tuỳ chọn. Các khoá có thể sử dụng bao gồm một biểu tượng, nhãn ở trên và nhãn ở dưới. Bạn cần đặt nội dung văn bản và một trong các khoá này bằng cách sử dụng setText(text)
và một trong các giá trị DecoratedText
, DecoratedText
, setTopLabel(text)
hoặc setBottomLabel(text)
. Lớp này nhằm thay thế
.
KeyValue
Được cung cấp cho tiện ích bổ sung của Google Workspace và ứng dụng Google Chat.
var decoratedText = CardService.newDecoratedText() .setText("Text") .setTopLabel("TopLabel"); var 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 |
---|---|---|
setAuthorizationAction(action) | DecoratedText | Đặt một thao tác uỷ quyền mở URL thành quy trình uỷ quyền khi bạn nhấp vào đối tượng. |
setBottomLabel(text) | DecoratedText | Thiết lập văn bản nhãn được sử dụng làm khoá và văn bản này được 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 đối tượng được nhấp vào. |
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 sẽ thực thi khi đối tượng được nhấp vào. |
setOnClickOpenLinkAction(action) | DecoratedText | Đặt một thao tác mở URL trong một thẻ khi đối tượng được nhấp vào. |
setOpenLink(openLink) | DecoratedText | Đặt URL đượ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 được sử dụng làm giá trị. |
setTopLabel(text) | DecoratedText | Thiết lập văn bản nhãn được sử dụng làm khoá và văn bản này được 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 thao tác uỷ quyền mở URL thành quy trình uỷ quyền khi bạn 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.
Đố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)
.
// ... var action = CardService.newAuthorizationAction().setAuthorizationUrl('url'); CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);
Tham số
Tên | Loại | Nội dung mô tả |
---|---|---|
action | AuthorizationAction | Đối tượng chỉ định thao tác 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)
Thiết lập văn bản nhãn được sử dụng làm khoá và văn bản này được hiển thị bên dưới nội dung văn bản.
Tham số
Tên | Loại | Nội dung mô tả |
---|---|---|
text | String | Văn bản cho 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. Một DecoratedText
chỉ có thể hỗ trợ một nút hoặc một công tắc.
Tham số
Tên | Loại | Nội dung 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 đối tượng được nhấp vào. Đối tượng giao diện người dùng chỉ có thể đặt một trong các giá trị: 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 ComposeActionResponse
được định cấu hình bằng ComposeActionResponseBuilder.setGmailDraft(draft)
.
// ... var action = CardService.newAction().setFunctionName('composeEmailCallback'); CardService.newTextButton() .setText('Compose Email') .setComposeAction(action, CardService.ComposedEmailType.REPLY_AS_DRAFT); // ... function composeEmailCallback() { var thread = GmailApp.getThreadById(e.threadId); var draft = thread.createDraftReply('This is a reply'); return CardService.newComposeActionResponseBuilder() .setGmailDraft(draft) .build(); }
Tham số
Tên | Loại | Nội dung mô tả |
---|---|---|
action | Action | Đối tượng chỉ định thao tác 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 xem bản nháp đã soạn 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 để tạo chuỗi.
setEndIcon(endIcon)
Đặt IconImage
(không bắt buộc) hiển thị ở bên phải nội dung. Một 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 | Nội dung mô tả |
---|---|---|
endIcon | IconImage | Biểu tượng để 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 sẽ thực thi khi đối tượng được nhấp vào. Mỗi đối tượng giao diện người dùng chỉ có thể đặt một trong các giá trị 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
.
// ... var 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 | Nội dung 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 một thẻ khi đối tượng được nhấp vào. Hãy 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 cùng với việc tạo đối tượng OpenLink
. Đối tượng giao diện người dùng chỉ có thể đặt một trong các giá trị: 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
được định cấu hình bằng ActionResponseBuilder.setOpenLink(openLink)
.
// ... var 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 | Nội dung mô tả |
---|---|---|
action | Action | Đối tượng chỉ định thao tác 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 được mở khi đối tượng được nhấp vào. Hãy dùng hàm này khi URL đã biết và chỉ cần mở. Mỗi đối tượng giao diện người dùng chỉ có thể đặt một trong các giá trị: setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
hoặc setComposeAction(action, composedEmailType)
.
Tham số
Tên | Loại | Nội dung 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 | Nội dung mô tả |
---|---|---|
startIcon | IconImage | Biểu tượng 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 công tắc.
Tham số
Tên | Loại | Nội dung 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 được sử 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 | Nội dung 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)
Thiết lập văn bản nhãn được sử dụng làm khoá và văn bản này được hiển thị phía trên nội dung văn bản.
Tham số
Tên | Loại | Nội dung mô tả |
---|---|---|
text | String | Văn bản cho 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 | Nội dung mô tả |
---|---|---|
wrapText | Boolean | Nếu là true , văn bản sẽ được gói 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.