Class Button

按鈕

所有按鈕的基礎類別。

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

方法

方法傳回類型簡短說明
setAuthorizationAction(action)Button設定當物件在 點擊。
setComposeAction(action, composedEmailType)Button設定在點選物件時，撰寫電子郵件草稿的動作。
setOnClickAction(action)Button設定在點選物件時執行的動作。
setOnClickOpenLinkAction(action)Button設定在點選物件時，在分頁中開啟網址的動作。
setOpenLink(openLink)Button設定點選物件時要開啟的網址。

內容詳盡的說明文件

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

參數

名稱類型說明
actionAuthorizationAction這個物件，用來指定當這個元素出現 點擊。

回攻員

Button：這個物件用於鏈結。

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

參數

名稱類型說明
actionAction這個物件，用來指定當這個元素出現時要執行的組合動作 點擊。
composedEmailTypeComposedEmailType列舉值，用於指定撰寫草稿是否為 獨立或回覆草稿

回攻員

Button：這個物件用於鏈結。

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

參數

名稱類型說明
actionAction點選這個元素後要採取的動作。

回攻員

Button：這個物件用於鏈結。

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

參數

名稱類型說明
actionAction這個物件，用來指定當這個元素發生時要執行的公開連結動作 點擊。

回攻員

Button：這個物件用於鏈結。

設定點選物件時要開啟的網址。如果網址已經存在，請使用這個函式 只需要開啟即可使用UI 物件只能有 setOpenLink(openLink)、 setOnClickAction(action)、setOnClickOpenLinkAction(action)、setAuthorizationAction(action)、 或已設定 setComposeAction(action, composedEmailType)。

參數

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

回攻員

Button：這個物件用於鏈結。