Class CardAction

CardAction

Klikalne polecenie menu dodawane do menu nagłówka karty.

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

var cardAction = CardService.newCardAction()
    .setText("Card action")
    .setOnClickAction(action);

Metody

MetodaZwracany typKrótki opis
setAuthorizationAction(action)CardActionUstawia działanie autoryzacji, które po kliknięciu obiektu otwiera adres URL w procesie autoryzacji.
setComposeAction(action, composedEmailType)CardActionUstawia działanie tworzące wersję roboczą e-maila po kliknięciu tego obiektu.
setOnClickAction(action)CardActionUstawia działanie wykonywane po kliknięciu obiektu.
setOnClickOpenLinkAction(action)CardActionUstawia działanie, które po kliknięciu obiektu otwiera adres URL na karcie.
setOpenLink(openLink)CardActionUstawia adres URL, który ma być otwierany po kliknięciu obiektu.
setText(text)CardActionUstawia tekst menu dla tego działania.

Szczegółowa dokumentacja

setAuthorizationAction(action)

Ustawia działanie autoryzacji, które po kliknięciu obiektu otwiera adres URL w procesie autoryzacji. Spowoduje to otwarcie adresu URL w nowym oknie. Gdy użytkownik zakończy proces autoryzacji i wróci do aplikacji, dodatek załaduje się ponownie.

Obiekt interfejsu użytkownika może mieć ustawiony tylko jeden z tych elementów: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) lub setComposeAction(action, composedEmailType).

// ...

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

Parametry

NazwaTypOpis
actionAuthorizationActionObiekt określający działanie autoryzacji, które ma zostać wykonane po kliknięciu tego elementu.

Powroty

CardAction – obiekt do tworzenia łańcuchów.


setComposeAction(action, composedEmailType)

Ustawia działanie tworzące wersję roboczą e-maila po kliknięciu tego obiektu. Obiekt interfejsu użytkownika 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ą metody ComposeActionResponseBuilder.setGmailDraft(draft).

// ...

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

Parametry

NazwaTypOpis
actionActionObiekt określający działanie tworzenia, które ma zostać wykonane po kliknięciu tego elementu.
composedEmailTypeComposedEmailTypeWartość wyliczeniowa wskazująca, czy utworzona wersja robocza jest samodzielną wersją roboczą, czy też wersja robocza odpowiedzi.

Powroty

CardAction – obiekt do tworzenia łańcuchów.


setOnClickAction(action)

Ustawia działanie wykonywane po kliknięciu obiektu. Obiekt interfejsu użytkownika może mieć ustawiony tylko jeden z tych parametrów: 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.

// ...

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

Parametry

NazwaTypOpis
actionActionDziałanie, jakie ma zostać wykonane po kliknięciu tego elementu.

Powroty

CardAction – obiekt do tworzenia łańcuchów.


setOnClickOpenLinkAction(action)

Ustawia działanie, które po kliknięciu obiektu otwiera adres URL na karcie. Użyj tej funkcji, jeśli trzeba utworzyć adres URL lub gdy trzeba wykonać inne działania oprócz utworzenia obiektu OpenLink. Obiekt interfejsu użytkownika może mieć ustawiony tylko jeden z tych parametrów: 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ą metody ActionResponseBuilder.setOpenLink(openLink).

// ...

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

Parametry

NazwaTypOpis
actionActionObiekt określający działanie linku otwierającego, które ma być wykonywane po kliknięciu tego elementu.

Powroty

CardAction – obiekt do tworzenia łańcuchów.


Ustawia adres URL, który ma być otwierany po kliknięciu obiektu. Tej funkcji należy używać, gdy adres URL jest już znany i tylko trzeba go otworzyć. Obiekt interfejsu użytkownika może mieć ustawiony tylko jeden z tych parametrów: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) lub setComposeAction(action, composedEmailType).

Parametry

NazwaTypOpis
openLinkOpenLinkObiekt OpenLink opisujący adres URL do otwarcia.

Powroty

CardAction – obiekt do tworzenia łańcuchów.


setText(text)

Ustawia tekst menu dla tego działania.

Parametry

NazwaTypOpis
textStringTekst pozycji menu.

Powroty

CardAction – obiekt do tworzenia łańcuchów.