顯示文字搭配選用裝飾的小工具。可能的索引鍵包括圖示、上方標籤和下方標籤。設定文字內容和其中一個鍵時,必須使用 setText(text)
和 DecoratedText
、DecoratedText
、setTopLabel(text)
或 setBottomLabel(text)
其中之一。這個類別的用途是取代
。KeyValue
適用於 Google Workspace 外掛程式和 Google Chat 應用程式。
var decoratedText = CardService.newDecoratedText() .setText("Text") .setTopLabel("TopLabel"); var multilineDecoratedText = CardService.newDecoratedText() .setText("Text") .setTopLabel("TopLabel") .setWrapText(true) .setBottomLabel("BottomLabel");
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
setAuthorizationAction(action) | DecoratedText | 設定授權動作,在物件點擊時開啟授權流程的網址。 |
setBottomLabel(text) | DecoratedText | 設定要在文字內容下方顯示的標籤文字。 |
setButton(button) | DecoratedText | 設定顯示在文字右側的 Button 。 |
setComposeAction(action, composedEmailType) | DecoratedText | 設定在物件點選時,撰寫電子郵件草稿的動作。 |
setEndIcon(endIcon) | DecoratedText | 設定顯示在內容右側的選用 IconImage 。 |
setOnClickAction(action) | DecoratedText | 設定在點選物件時要執行的動作。 |
setOnClickOpenLinkAction(action) | DecoratedText | 設定當使用者點選物件時,於分頁中開啟網址的動作。 |
setOpenLink(openLink) | DecoratedText | 設定在點選物件時開啟的網址。 |
setStartIcon(startIcon) | DecoratedText | 設定顯示在文字內容之前的選用 IconImage 。 |
setSwitchControl(switchToSet) | DecoratedText | 設定顯示在內容右側的 Switch 。 |
setText(text) | DecoratedText | 設定要使用的文字。 |
setTopLabel(text) | DecoratedText | 設定要使用的鍵標籤文字,這些文字會顯示在文字內容上方。 |
setWrapText(wrapText) | DecoratedText | 設定值文字應顯示於單行或多行。 |
內容詳盡的說明文件
setAuthorizationAction(action)
設定授權動作,在物件點擊時開啟授權流程的網址。網址會在新視窗中開啟。當使用者完成授權流程並返回應用程式時,外掛程式會重新載入。
UI 物件只能設定 setOpenLink(openLink)
、setOnClickAction(action)
、setOnClickOpenLinkAction(action)
、setAuthorizationAction(action)
或 setComposeAction(action, composedEmailType)
的其中一項。
// ... var action = CardService.newAuthorizationAction().setAuthorizationUrl('url'); CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);
參數
名稱 | 類型 | 說明 |
---|---|---|
action | AuthorizationAction | 這個物件會在使用者點擊此元素時,指定要採取的動作。 |
回攻員
DecoratedText
:這個物件用於鏈結。
setBottomLabel(text)
setButton(button)
設定顯示在文字右側的 Button
。DecoratedText
僅支援一個按鈕或一個切換按鈕。
參數
名稱 | 類型 | 說明 |
---|---|---|
button | Button | 要新增的按鈕。 |
回攻員
DecoratedText
:這個物件用於鏈結。
setComposeAction(action, composedEmailType)
設定在物件點選時,撰寫電子郵件草稿的動作。UI 物件只能設定 setOpenLink(openLink)
、setOnClickAction(action)
、setOnClickOpenLinkAction(action)
、setAuthorizationAction(action)
或 setComposeAction(action, composedEmailType)
的其中一項。
Action
參數必須指定回呼函式,該函式會傳回使用 ComposeActionResponseBuilder.setGmailDraft(draft)
設定的 ComposeActionResponse
物件。
// ... 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(); }
參數
名稱 | 類型 | 說明 |
---|---|---|
action | Action | 這個物件會在使用者點擊此元素時,指定要採取的動作。 |
composedEmailType | ComposedEmailType | 此列舉值可指定撰寫的草稿是獨立或回覆草稿。 |
回攻員
DecoratedText
:這個物件用於鏈結。
setEndIcon(endIcon)
設定顯示在內容右側的選用 IconImage
。DecoratedText
只支援一個按鈕、一個外接切換裝置或一個圖示。
參數
名稱 | 類型 | 說明 |
---|---|---|
endIcon | IconImage | 要新增的圖示。 |
回攻員
DecoratedText
:這個物件用於鏈結。
setOnClickAction(action)
設定在點選物件時要執行的動作。UI 物件只能設定 setOpenLink(openLink)
、setOnClickAction(action)
、setOnClickOpenLinkAction(action)
、setAuthorizationAction(action)
或 setComposeAction(action, composedEmailType)
的其中一項。
Action
參數必須指定回呼函式,以傳回 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(); }
參數
名稱 | 類型 | 說明 |
---|---|---|
action | Action | 點按此元素時要採取的動作。 |
回攻員
DecoratedText
:這個物件用於鏈結。
setOnClickOpenLinkAction(action)
設定當使用者點選物件時,於分頁中開啟網址的動作。在需要建構網址,或需要在外掛程式中執行其他動作以建立 OpenLink
物件時,請使用此函式。UI 物件只能設定 setOpenLink(openLink)
、setOnClickAction(action)
、setOnClickOpenLinkAction(action)
、setAuthorizationAction(action)
或 setComposeAction(action, composedEmailType)
的其中一種。
Action
參數必須指定回呼函式,該函式會傳回使用 ActionResponseBuilder.setOpenLink(openLink)
設定的 ActionResponse
物件。
// ... 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(); }
參數
名稱 | 類型 | 說明 |
---|---|---|
action | Action | 此物件會在使用者點選此元素時,指定開啟的連結動作。 |
回攻員
DecoratedText
:這個物件用於鏈結。
setOpenLink(openLink)
設定在點選物件時開啟的網址。當已知網址且只需要開啟時,請使用此函式。UI 物件只能設定 setOpenLink(openLink)
、setOnClickAction(action)
、setOnClickOpenLinkAction(action)
、setAuthorizationAction(action)
或 setComposeAction(action, composedEmailType)
的其中一項。
參數
名稱 | 類型 | 說明 |
---|---|---|
openLink | OpenLink | OpenLink 物件,用於描述要開啟的網址。 |
回攻員
DecoratedText
:這個物件用於鏈結。
setStartIcon(startIcon)
setSwitchControl(switchToSet)
設定顯示在內容右側的 Switch
。DecoratedText
僅支援一個按鈕或一個切換按鈕。
參數
名稱 | 類型 | 說明 |
---|---|---|
switchToSet | Switch | 要新增的切換鈕。 |
回攻員
DecoratedText
:這個物件用於鏈結。
setText(text)
setTopLabel(text)
setWrapText(wrapText)
設定值文字應顯示於單行或多行。
參數
名稱 | 類型 | 說明 |
---|---|---|
wrapText | Boolean | 如果是 true ,文字會換行並顯示至多行。否則文字會遭到截斷。 |
回攻員
DecoratedText
:這個物件用於鏈結。