包含文字標籤的 TextButton
。您可以視需求設定背景顏色並停用按鈕。
適用於 Google Workspace 外掛程式和 Google Chat 應用程式。
var textButton = CardService.newTextButton() .setText("Open Link") .setOpenLink(CardService.newOpenLink() .setUrl("https://www.google.com"));
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
setAltText(altText) | TextButton | 設定無障礙按鈕的替代文字。 |
setAuthorizationAction(action) | TextButton | 設定授權動作,在物件點擊時開啟授權流程的網址。 |
setBackgroundColor(backgroundColor) | TextButton | 設定 TextButtonStyle.FILLED 按鈕的背景顏色。 |
setComposeAction(action, composedEmailType) | TextButton | 設定在物件點選時,撰寫電子郵件草稿的動作。 |
setDisabled(disabled) | TextButton | 設定是否要停用按鈕。 |
setOnClickAction(action) | TextButton | 設定在點選物件時要執行的動作。 |
setOnClickOpenLinkAction(action) | TextButton | 設定當使用者點選物件時,於分頁中開啟網址的動作。 |
setOpenLink(openLink) | TextButton | 設定在點選物件時開啟的網址。 |
setText(text) | TextButton | 設定按鈕上顯示的文字。 |
setTextButtonStyle(textButtonStyle) | TextButton | 設定按鈕樣式。 |
內容詳盡的說明文件
setAltText(altText)
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 | 這個物件會在使用者點擊此元素時,指定要採取的動作。 |
回攻員
TextButton
:這個物件用於鏈結。
setBackgroundColor(backgroundColor)
設定 TextButtonStyle.FILLED
按鈕的背景顏色。如未為 TextButtonStyle.FILLED
按鈕取消設定,按鈕會使用外掛程式資訊清單中定義的次要顏色。此方法不適用於 TextButtonStyle.OUTLINED
按鈕。
參數
名稱 | 類型 | 說明 |
---|---|---|
backgroundColor | String | #rgb 格式的顏色。 |
回攻員
TextButton
:這個物件用於鏈結。
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 | 此列舉值可指定撰寫的草稿是獨立或回覆草稿。 |
回攻員
TextButton
:這個物件用於鏈結。
setDisabled(disabled)
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 | 點按此元素時要採取的動作。 |
回攻員
TextButton
:這個物件用於鏈結。
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 | 此物件會在使用者點選此元素時,指定開啟的連結動作。 |
回攻員
TextButton
:這個物件用於鏈結。
setOpenLink(openLink)
設定在點選物件時開啟的網址。當已知網址且只需要開啟時,請使用此函式。UI 物件只能設定 setOpenLink(openLink)
、setOnClickAction(action)
、setOnClickOpenLinkAction(action)
、setAuthorizationAction(action)
或 setComposeAction(action, composedEmailType)
的其中一項。
參數
名稱 | 類型 | 說明 |
---|---|---|
openLink | OpenLink | OpenLink 物件,用於描述要開啟的網址。 |
回攻員
TextButton
:這個物件用於鏈結。
setText(text)
setTextButtonStyle(textButtonStyle)
設定按鈕樣式。如未設定,則預設為 TextButtonStyle.OUTLINED
按鈕。
參數
名稱 | 類型 | 說明 |
---|---|---|
textButtonStyle | TextButtonStyle | 按鈕樣式。 |
回攻員
TextButton
:這個物件用於鏈結。