本頁面由 Cloud Translation API 翻譯而成。

Class TextButton

含有文字標籤的 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)`

設定按鈕的替代文字以顯示無障礙功能。如未設定，則會預設為。

參數

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

回攻員

TextButton：這個物件用於鏈結。

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

注意：這個方法不會設定用於擴充 Compose 使用者介面。而是會將這個 UI 元素連結至 Action，後者會使用 Apps Script 撰寫訊息草稿，動作完成後，你就會在 Gmail 中開啟

// ...

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)`

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

參數

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

回攻員

TextButton：這個物件用於鏈結。

`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)`

設定按鈕上顯示的文字。

參數

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

回攻員

TextButton：這個物件用於鏈結。

`setTextButtonStyle(textButtonStyle)`

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

參數

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

回攻員

TextButton：這個物件用於鏈結。