Class ImageButton

ImageButton

顯示圖片的 ImageButton。

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

const imageButton =
    CardService.newImageButton()
        .setAltText('An image button with an airplane icon.')
        .setIcon(CardService.Icon.AIRPLANE)
        .setOpenLink(CardService.newOpenLink().setUrl('https://airplane.com'));

方法

方法傳回類型簡短說明
setAltText(altText)ImageButton設定按鈕的替代文字，方便無障礙使用者。
setAuthorizationAction(action)ImageButton設定授權動作，在點選物件時開啟授權流程的網址。
setComposeAction(action, composedEmailType)ImageButton設定動作，在使用者點選物件時，撰寫電子郵件草稿。
setIcon(icon)ImageButton設定按鈕上要顯示的預先定義 Icon。
setIconUrl(url)ImageButton設定圖片的網址，做為這個按鈕的圖示。
setImageButtonStyle(imageButtonStyle)ImageButton設定按鈕樣式。
setMaterialIcon(icon)ImageButton設定 Material Design 圖示。
setOnClickAction(action)ImageButton設定在點選物件時執行的動作。
setOnClickOpenLinkAction(action)ImageButton設定動作，當使用者點選物件時，在分頁中開啟網址。
setOpenLink(openLink)ImageButton設定點選物件時要開啟的網址。
setOverflowMenu(menu)ImageButton設定在按下物件時開啟的彈出式選單。

內容詳盡的說明文件

setAltText(altText)

設定按鈕的替代文字，方便無障礙使用者。必填。

參數

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

回攻員

ImageButton：這個物件用於鏈結。

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指定在點選此元素時要採取的授權動作。

回攻員

ImageButton：這個物件用於鏈結。

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指定在點選此元素時要採取的 Compose 動作的物件。
composedEmailTypeComposedEmailType這個列舉值可指定所撰寫的草稿是獨立草稿還是回覆草稿。

回攻員

ImageButton：這個物件用於鏈結。

setIcon(icon)

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

參數

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

回攻員

ImageButton：這個物件用於鏈結。

setIconUrl(url)

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

參數

名稱類型說明
urlString要用來做為按鈕圖示的主機代管圖片網址。

回攻員

ImageButton：這個物件用於鏈結。

setImageButtonStyle(imageButtonStyle)

設定按鈕樣式。如果未設定，則預設為 ImageButtonStyle.BORDERLESS 按鈕。

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

const imageButton = CardService.newImageButton().setImageButtonStyle(
    CardService.ImageButtonStyle.BORDERLESS,
);

參數

名稱類型說明
imageButtonStyleImageButtonStyle按鈕樣式。

回攻員

ImageButton：這個物件用於鏈結。

setMaterialIcon(icon)

設定 Material Design 圖示。

const imageButton = CardService.newImageButton().setMaterialIcon(
    CardService.newMaterialIcon().setName('search'),
);

參數

名稱類型說明
iconMaterialIconMaterial Design 圖示。

回攻員

ImageButton：這個物件用於鏈結。

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點選此元素時要採取的動作。

回攻員

ImageButton：這個物件用於鏈結。

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指定在點選此元素時要執行的開啟連結動作的物件。

回攻員

ImageButton：這個物件用於鏈結。

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

參數

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

回攻員

ImageButton：這個物件用於鏈結。

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

參數

名稱類型說明
menuOverflowMenu指定在按一下此元素時要顯示的溢位選單。

回攻員

ImageButton：這個物件用於鏈結。