Class TextButton

附有文字標籤的 TextButton。您可以視需要設定背景顏色，並停用按鈕。

適用於 Google Workspace 外掛程式和 Google Chat 應用程式。

const 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`	設定按鈕是否停用。
`setIcon(icon)`	`TextButton`	設定要在按鈕上顯示的預先定義 `Icon`。
`setIconUrl(url)`	`TextButton`	設定要當做按鈕圖示的圖片網址。
`setMaterialIcon(icon)`	`TextButton`	設定 Material Design 圖示。
`setOnClickAction(action)`	`TextButton`	設定在點選物件時執行的動作。
`setOnClickOpenLinkAction(action)`	`TextButton`	設定動作，在點選物件時於分頁中開啟網址。
`setOpenLink(openLink)`	`TextButton`	設定點選物件時要開啟的網址。
`setOverflowMenu(menu)`	`TextButton`	設定在點選物件時開啟的彈出式選單。
`setText(text)`	`TextButton`	設定按鈕上顯示的文字。
`setTextButtonStyle(textButtonStyle)`	`TextButton`	設定按鈕樣式。

內容詳盡的說明文件

`setAltText(altText)`

設定按鈕的替代文字，方便使用者存取。如未設定，預設為按鈕上顯示的文字。

參數

名稱	類型	說明
`altText`	`String`	要指派給這個按鈕的替代文字。

回攻員

TextButton - 這個物件，用於鏈結。

`setAuthorizationAction(action)`

設定授權動作，在點選物件時開啟授權流程的網址。系統隨即會在新視窗中開啟網址。使用者完成授權流程並返回應用程式後，外掛程式會重新載入。

UI 物件只能設定 setOpenLink(openLink)、setOnClickAction(action)、setOnClickOpenLinkAction(action)、setAuthorizationAction(action) 或 setComposeAction(action, composedEmailType) 的其中一個。

// ...

const 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 物件。

注意：這個方法不會設定用於擴充 Compose UI 的 Compose 動作。這個方法會將這個 UI 元素連結至 Action，在 Apps Script 中撰寫郵件草稿，並在動作完成時於 Gmail 中開啟。

// ...

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();
}

參數

名稱	類型	說明
`action`	`Action`	這個物件會指定點選這個元素時要執行的撰寫動作。
`composedEmailType`	`ComposedEmailType`	列舉值，用於指定撰寫的草稿是獨立草稿還是回覆草稿。

回攻員

TextButton - 這個物件，用於鏈結。

`setDisabled(disabled)`

設定按鈕是否停用。停用的按鈕會顯示為灰色，且無法點選。

參數

名稱	類型	說明
`disabled`	`Boolean`	停用狀態。

回攻員

TextButton - 這個物件，用於鏈結。

`setIcon(icon)`

設定要在按鈕上顯示的預先定義 Icon。必須使用這個或 setIconUrl(url) 定義按鈕圖片。

參數

名稱	類型	說明
`icon`	`Icon`	預先定義的 `Icon` 值之一。

回攻員

TextButton - 這個物件，用於鏈結。

`setIconUrl(url)`

設定要當做按鈕圖示的圖片網址。必須使用這個或 setIcon(icon) 定義按鈕圖片。

參數

名稱	類型	說明
`url`	`String`	要當做按鈕圖示的代管圖片網址。

回攻員

TextButton - 這個物件，用於鏈結。

`setMaterialIcon(icon)`

設定 Material Design 圖示。

const textButton = CardService.newTextButton().setMaterialIcon(
    CardService.newMaterialIcon().setName('search'),
);

參數

名稱	類型	說明
`icon`	`MaterialIcon`	Material Design 圖示。

回攻員

TextButton - 這個物件，用於鏈結。

`setOnClickAction(action)`

設定在點選物件時執行的動作。UI 物件只能設定 setOpenLink(openLink)、setOnClickAction(action)、setOnClickOpenLinkAction(action)、setAuthorizationAction(action) 或 setComposeAction(action, composedEmailType) 的其中一個。

Action 參數必須指定會傳回 ActionResponse 物件的回呼函式。

// ...

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();
}

參數

名稱	類型	說明
`action`	`Action`	點選這個元素時要採取的動作。

回攻員

TextButton - 這個物件，用於鏈結。

`setOnClickOpenLinkAction(action)`

設定動作，在點選物件時於分頁中開啟網址。如需建構網址，或除了建立 OpenLink 物件外還需要採取其他動作，請使用這個函式。UI 物件只能設定 setOpenLink(openLink)、setOnClickAction(action)、setOnClickOpenLinkAction(action)、setAuthorizationAction(action) 或 setComposeAction(action, composedEmailType) 其中一個。

Action 參數必須指定回呼函式，該函式會傳回使用 ActionResponseBuilder.setOpenLink(openLink) 設定的 ActionResponse 物件。

// ...

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();
}

參數

名稱	類型	說明
`action`	`Action`	這個物件會指定點選這個元素時要執行的開啟連結動作。

回攻員

TextButton - 這個物件，用於鏈結。

`setOpenLink(openLink)`

設定在點選物件時開啟的網址。如果網址已知且只需要開啟，請使用這項函式。UI 物件只能設定 setOpenLink(openLink)、setOnClickAction(action)、setOnClickOpenLinkAction(action)、setAuthorizationAction(action) 或 setComposeAction(action, composedEmailType) 其中一個。

參數

名稱	類型	說明
`openLink`	`OpenLink`	說明要開啟網址的 `OpenLink` 物件。

回攻員

TextButton - 這個物件，用於鏈結。

`setOverflowMenu(menu)`

設定在點選物件時開啟的彈出式選單。選單中的每個項目都可以指定點選時要觸發的動作。不支援巢狀選單，選單項目的動作不應指定溢位選單。

適用於 Google Chat 應用程式。Google Workspace 外掛程式的開發人員預覽版。

const overflowMenuItem =
    CardService.newOverflowMenuItem()
        .setStartIcon(
            CardService.newIconImage().setIconUrl(
                'https://www.google.com/images/branding/googleg/1x/googleg_standard_color_64dp.png',
                ),
            )
        .setText('Open Link')
        .setOpenLink(
            CardService.newOpenLink().setUrl('https://www.google.com'));

const overflowMenu =
    CardService.newOverflowMenu().addMenuItem(overflowMenuItem).build();

參數

名稱	類型	說明
`menu`	`OverflowMenu`	這個物件會指定點選這個元素時要顯示的溢位選單。

回攻員

TextButton - 這個物件，用於鏈結。

`setText(text)`

設定按鈕上顯示的文字。

參數

名稱	類型	說明
`text`	`String`	按鈕上顯示的文字。

回攻員

TextButton - 這個物件，用於鏈結。

`setTextButtonStyle(textButtonStyle)`

設定按鈕樣式。如未設定，則預設為 TextButtonStyle.OUTLINED 按鈕。

const button =
    CardService.newTextButton()
        .setText('Filled')
        .setTextButtonStyle(CardService.TextButtonStyle.FILLED)
        .setOpenLink(CardService.newOpenLink().setUrl('www.google.com'));

參數

名稱	類型	說明
`textButtonStyle`	`TextButtonStyle`	按鈕樣式。

回攻員

TextButton - 這個物件，用於鏈結。

Class TextButton 透過集合功能整理內容 你可以依據偏好儲存及分類內容。

方法

內容詳盡的說明文件

setAltText(altText)

參數

回攻員

setAuthorizationAction(action)

參數

回攻員

setBackgroundColor(backgroundColor)

參數

回攻員

setComposeAction(action, composedEmailType)

參數

回攻員

setDisabled(disabled)

參數

回攻員

setIcon(icon)

參數

回攻員

setIconUrl(url)

參數

回攻員

setMaterialIcon(icon)

參數

回攻員

setOnClickAction(action)

參數

回攻員

setOnClickOpenLinkAction(action)

參數

回攻員

setOpenLink(openLink)

參數

回攻員

setOverflowMenu(menu)

參數

回攻員

setText(text)

參數

回攻員

setTextButtonStyle(textButtonStyle)

參數

回攻員

Class TextButton

`setAltText(altText)`

`setAuthorizationAction(action)`

`setBackgroundColor(backgroundColor)`

`setComposeAction(action, composedEmailType)`

`setDisabled(disabled)`

`setIcon(icon)`

`setIconUrl(url)`

`setMaterialIcon(icon)`

`setOnClickAction(action)`

`setOnClickOpenLinkAction(action)`

`setOpenLink(openLink)`

`setOverflowMenu(menu)`

`setText(text)`

`setTextButtonStyle(textButtonStyle)`