Class KeyValue

KeyValue

已淘汰。這個類別已淘汰,不應用於新的指令碼。

這個類別已淘汰,請改用 DecoratedText

方法

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

內容詳盡的說明文件

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這個物件可指定點選此元素時要採取的動作。

回攻員

KeyValue — 此物件用於鏈結。


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列舉值,指定撰寫的草稿是獨立還是回覆草稿。

回攻員

KeyValue — 此物件用於鏈結。


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

回攻員

KeyValue — 此物件用於鏈結。


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這個物件可指定使用者點選此元素時要採取的動作。

回攻員

KeyValue — 此物件用於鏈結。


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

參數

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

回攻員

KeyValue — 此物件用於鏈結。

已淘汰的方法