Class OverflowMenuItem

OverflowMenuItem

含有圖示和文字標籤的 OverflowMenuItem。如有需要,您可以停用選單項目。

僅適用於 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'));

方法

方法傳回類型簡短說明
setAuthorizationAction(action)OverflowMenuItem設定授權動作,在點選物件時開啟授權流程的網址。
setComposeAction(action, composedEmailType)OverflowMenuItem設定動作,在使用者點選物件時,撰寫電子郵件草稿。
setDisabled(disabled)OverflowMenuItem設定選單項目是否已停用。
setOnClickAction(action)OverflowMenuItem設定在點選物件時執行的動作。
setOnClickOpenLinkAction(action)OverflowMenuItem設定動作,當使用者點選物件時,在分頁中開啟網址。
setOpenLink(openLink)OverflowMenuItem設定點選物件時要開啟的網址。
setStartIcon(icon)OverflowMenuItem設定選單項目的前置圖示。
setText(text)OverflowMenuItem設定選單項目的標題。

內容詳盡的說明文件

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

參數

名稱類型說明
actionAuthorizationAction物件,用於指定點選這個元素後要執行的授權動作。

回攻員

OverflowMenuItem:這個物件用於鏈結。


setComposeAction(action, composedEmailType)

設定在點選物件時,撰寫電子郵件草稿的動作。UI 物件只能設定 setOpenLink(openLink)setOnClickAction(action)setOnClickOpenLinkAction(action)setAuthorizationAction(action)setComposeAction(action, composedEmailType) 其中之一。

Action 參數必須指定回呼函式,以便傳回使用 ComposeActionResponseBuilder.setGmailDraft(draft) 設定的 ComposeActionResponse 物件。

// ...

const action = CardService.newAction().setFunctionName('composeEmailCallback');
CardService.newTextButton()
    .setText('Compose Email')
    .setComposeAction(action, CardService.ComposedEmailType.REPLY_AS_DRAFT);

// ...

function composeEmailCallback() {
  const thread = GmailApp.getThreadById(e.threadId);
  const draft = thread.createDraftReply('This is a reply');
  return CardService.newComposeActionResponseBuilder()
      .setGmailDraft(draft)
      .build();
}

參數

名稱類型說明
actionAction這個物件用於指定點選這個元素時要執行的組合動作。
composedEmailTypeComposedEmailType這個列舉值可指定所撰寫的草稿是獨立草稿還是回覆草稿。

回攻員

OverflowMenuItem:這個物件用於鏈結。


setDisabled(disabled)

設定是否停用選單項目。停用的項目會顯示為灰色,且無法點選。

參數

名稱類型說明
disabledBoolean已停用的狀態。

回攻員

OverflowMenuItem:這個物件用於鏈結。


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

參數

名稱類型說明
actionAction點選此元素時要採取的動作。

回攻員

OverflowMenuItem:這個物件用於鏈結。


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

參數

名稱類型說明
actionAction這個物件可指定使用者點選這個元素時要執行的公開連結動作。

回攻員

OverflowMenuItem:這個物件用於鏈結。


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

參數

名稱類型說明
openLinkOpenLink描述要開啟的網址的 OpenLink 物件。

回攻員

OverflowMenuItem:這個物件用於鏈結。


setStartIcon(icon)

設定選單項目的前置圖示。

參數

名稱類型說明
iconIconImage要顯示的圖示。

回攻員

OverflowMenuItem:這個物件用於鏈結。


setText(text)

設定選單項目的標題。必填。

參數

名稱類型說明
textString要顯示的文字。

回攻員

OverflowMenuItem:這個物件用於鏈結。