Class CardAction

CardAction

Klikalny element menu dodawany do menu nagłówka karty.

const action = CardService.newAction();
// Finish building the action...

const cardAction =
    CardService.newCardAction().setText('Card action').setOnClickAction(action);

Metody

Metoda	Zwracany typ	Krótki opis
setAuthorizationAction(action)	CardAction	Ustawia działanie autoryzacji, które otwiera adres URL do procedury autoryzacji po kliknięciu obiektu.
setComposeAction(action, composedEmailType)	CardAction	Ustawia działanie, które tworzy wersję roboczą e-maila po kliknięciu obiektu.
setOnClickAction(action)	CardAction	Ustawia działanie, które jest wykonywane po kliknięciu obiektu.
setOnClickOpenLinkAction(action)	CardAction	Ustawia działanie, które otwiera URL w karcie po kliknięciu obiektu.
setOpenLink(openLink)	CardAction	Ustawia adres URL, który ma się otworzyć po kliknięciu obiektu.
setText(text)	CardAction	Ustawia tekst menu dla tego działania.

Szczegółowa dokumentacja

setAuthorizationAction(action)

Ustawia działanie autoryzacji, które otwiera adres URL do procedury autoryzacji po kliknięciu obiektu. URL otworzy się w nowym oknie. Gdy użytkownik zakończy proces autoryzacji i wróci do aplikacji, dodatek zostanie ponownie załadowany.

Obiekt interfejsu może mieć ustawioną tylko jedną z tych wartości: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) lub setComposeAction(action, composedEmailType).

// ...

const action = CardService.newAuthorizationAction().setAuthorizationUrl('url');
CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);

Parametry

Nazwa	Typ	Opis
action	AuthorizationAction	Obiekt określający działanie autoryzacji, które ma zostać wykonane po kliknięciu tego elementu.

Powrót

CardAction – ten obiekt do łączenia.

---

setComposeAction(action, composedEmailType)

Ustawia działanie, które tworzy wersję roboczą e-maila po kliknięciu obiektu. Obiekt interfejsu może mieć ustawioną tylko jedną z tych wartości: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) lub setComposeAction(action, composedEmailType).

Parametr Action musi określać funkcję wywołania zwrotnego, która zwraca obiekt ComposeActionResponse skonfigurowany za pomocą parametru ComposeActionResponseBuilder.setGmailDraft(draft).

Uwaga: ta metoda nie ustawia działania tworzenia, które jest używane do rozszerzania interfejsu tworzenia. Ta metoda łączy element interfejsu z Action, który tworzy robocze wiadomości w Apps Script, które są otwierane w Gmailu po zakończeniu działania.

// ...

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

// ...

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

Parametry

Nazwa	Typ	Opis
action	Action	Obiekt określający działanie tworzenia, które ma zostać wykonane po kliknięciu tego elementu.
composedEmailType	ComposedEmailType	Wartość wyliczeniowa określająca, czy utworzona wersja robocza jest wersją roboczą samodzielną czy odpowiedzią.

Powrót

CardAction – ten obiekt do łączenia.

---

setOnClickAction(action)

Ustawia działanie, które jest wykonywane po kliknięciu obiektu. Obiekt interfejsu może mieć ustawioną tylko jedną z tych wartości: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) lub setComposeAction(action, composedEmailType).

Parametr Action musi określać funkcję wywołania zwrotnego, która zwraca obiekt 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();
}

Parametry

Nazwa	Typ	Opis
action	Action	Działanie, które należy wykonać po kliknięciu tego elementu.

Powrót

CardAction – ten obiekt do łączenia.

---

setOnClickOpenLinkAction(action)

Ustawia działanie, które otwiera URL w karcie po kliknięciu obiektu. Użyj tej funkcji, gdy musisz utworzyć adres URL lub wykonać inne działania oprócz utworzenia obiektu OpenLink. Obiekt interfejsu może mieć ustawioną tylko jedną z tych wartości: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) lub setComposeAction(action, composedEmailType).

Parametr Action musi określać funkcję wywołania zwrotnego, która zwraca obiekt ActionResponse skonfigurowany za pomocą parametru ActionResponseBuilder.setOpenLink(openLink).

// ...

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

Parametry

Nazwa	Typ	Opis
action	Action	Obiekt określający działanie otwierania linku, które ma zostać wykonane po kliknięciu tego elementu.

Powrót

CardAction – ten obiekt do łączenia.

---

setOpenLink(openLink)

Ustawia adres URL, który ma się otworzyć po kliknięciu obiektu. Użyj tej funkcji, gdy adres URL jest już znany i wystarczy go otworzyć. Obiekt interfejsu może mieć ustawioną tylko jedną z tych wartości: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) lub setComposeAction(action, composedEmailType).

Parametry

Nazwa	Typ	Opis
openLink	OpenLink	Obiekt OpenLink opisujący adres URL do otwarcia.

Powrót

CardAction – ten obiekt do łączenia.

---

setText(text)

Ustawia tekst menu dla tego działania.

Parametry

Nazwa	Typ	Opis
text	String	Tekst pozycji menu.

Powrót

CardAction – ten obiekt do łączenia.