Tiện ích hiển thị văn bản với hình trang trí tuỳ chọn. Các khoá có thể bao gồm biểu tượng, nhãn
ở trên và một nhãn ở bên dưới. Bạn phải đặt nội dung văn bản và một trong các khoá bằ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
Dùng được cho các 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 | Loại dữ liệu trả về | Mô tả ngắn |
---|---|---|
setAuthorizationAction(action) | DecoratedText | Thiết lập một thao tác uỷ quyền sẽ mở một URL trong quy trình uỷ quyền khi đối tượng đã nhấp vào. |
setBottomLabel(text) | DecoratedText | Thiết lập văn bản nhãn sẽ được dùng làm khoá và hiển thị bên dưới nội dung văn bản. |
setButton(button) | DecoratedText | Thiết lập Button hiển thị ở bên phải văn bản. |
setComposeAction(action, composedEmailType) | DecoratedText | Thiết lập 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 | Thiết lập một thao tác thực thi khi đối tượng được nhấp vào. |
setOnClickOpenLinkAction(action) | DecoratedText | Thiết lập một hành động mở URL trong một thẻ khi người dùng nhấp vào đối tượng. |
setOpenLink(openLink) | DecoratedText | Đặt URL mở ra khi đối tượng được nhấp vào. |
setStartIcon(startIcon) | DecoratedText | Thiết lập IconImage không bắt buộc để hiển thị trước nội dung văn bản. |
setSwitchControl(switchToSet) | DecoratedText | Thiết lập Switch hiển thị ở bên phải nội dung. |
setText(text) | DecoratedText | Thiết lập văn bản sẽ được sử dụng làm giá trị. |
setTopLabel(text) | DecoratedText | Thiết lập văn bản nhãn sẽ được dùng làm khoá và hiển thị phía trên nội dung văn bản. |
setWrapText(wrapText) | DecoratedText | Thiết lập xem văn bản giá trị sẽ xuất hiện trên một dòng hay nhiều dòng. |
Tài liệu chi tiết
setAuthorizationAction(action)
Thiết lập một thao tác uỷ quyền sẽ mở một URL trong quy trình uỷ quyền khi đối tượng đã nhấp vào. Thao tác này sẽ mở URL trong một cửa sổ mới. Khi người dùng hoàn thành quy trình uỷ quyền và quay lại ứng dụng, tiện ích bổ sung sẽ tải lại.
Mỗi đối tượng giao diện người dùng chỉ được 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 | Mô tả |
---|---|---|
action | AuthorizationAction | Đối tượng chỉ định hành động uỷ quyền cần thực hiện khi phần tử này được đã nhấp vào. |
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 sẽ được 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)
Thiết lập Button
hiển thị ở bên phải văn bản. Một DecoratedText
lon
chỉ 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 để tạo chuỗi.
setComposeAction(action, composedEmailType)
Thiết lập một thao tác soạn email nháp khi người dùng nhấp vào đối tượng. Đối tượng giao diện người dùng chỉ có thể
có một trong các giá trị sau: setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
,
Đã đặt 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 | Mô tả |
---|---|---|
action | Action | Đối tượng chỉ định thao tác cần thực hiện khi phần tử này được đã nhấp vào. |
composedEmailType | ComposedEmailType | Giá trị enum chỉ định liệu bản nháp đã soạn có phải là thư nháp độc lập hoặc 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 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 để thêm. |
Cầu thủ trả bóng
DecoratedText
– Đối tượng này để tạo chuỗi.
setOnClickAction(action)
Thiết lập một thao tác thực thi khi đối tượng được nhấp vào. Đối tượng giao diện người dùng chỉ có thể có một trong
Đã đặt 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 | Mô tả |
---|---|---|
action | Action | Thao tác 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.
setOnClickOpenLinkAction(action)
Thiết lập một hành động mở URL trong một thẻ khi người dùng nhấp vào đối tượng. Sử dụng hàm này khi
Bạn cần tạo URL hoặc khi bạn cần thực hiện thêm thao tác khá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 thuộc tính sau: setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
, hoặc
Đã đặt 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 | Mô tả |
---|---|---|
action | Action | Đối tượng chỉ định thao tác cần thực hiện đối với đường liên kết mở khi phần tử này đã nhấp vào. |
Cầu thủ trả bóng
DecoratedText
– Đối tượng này để tạo chuỗi.
setOpenLink(openLink)
Đặt URL mở ra khi đối tượng được nhấp vào. Sử dụng chức năng này khi URL đã
đã biết và chỉ cần mở ra. Đối tượng giao diện người dùng chỉ có thể có một trong các thuộc tính 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 | Đố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)
Thiết lập 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 để hiển thị. |
Cầu thủ trả bóng
DecoratedText
– Đối tượng này để tạo chuỗi.
setSwitchControl(switchToSet)
Thiết lập Switch
hiển thị ở bên phải nội dung. Một 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)
Thiết lập văn bản sẽ đượ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 | 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 sẽ được 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)
Thiết lập xem văn bản giá trị sẽ xuất hiện trên một dòng hay nhiều dòng.
Tham số
Tên | Loại | Mô tả |
---|---|---|
wrapText | Boolean | Nếu là true , văn bản sẽ được xuống dòng tự động và xuất hiện trên nhiều dòng. Nếu không
văn bản bị cắt ngắn. |
Cầu thủ trả bóng
DecoratedText
– Đối tượng này để tạo chuỗi.