Class KeyValue

KluczWartość

Wycofany. Ta klasa została wycofana i nie powinna być używana w nowych skryptach.

Ta klasa została wycofana. Zamiast tego użyj DecoratedText.

Metody

MetodaZwracany typKrótki opis
setAuthorizationAction(action)KeyValueUstawia działanie autoryzacji, które otwiera URL do procesu autoryzacji po kliknięciu obiektu.
setComposeAction(action, composedEmailType)KeyValuePo kliknięciu obiektu ustawia działanie, które tworzy wersję roboczą e-maila.
setOnClickAction(action)KeyValueOkreśla działanie, które jest wykonywane po kliknięciu obiektu.
setOnClickOpenLinkAction(action)KeyValueUstawia działanie, które otwiera URL w karcie po kliknięciu obiektu.
setOpenLink(openLink)KeyValueUstawia adres URL, który zostanie otwarty po kliknięciu obiektu.
MetodaZwracany typKrótki opis
setBottomLabel(text)KeyValueUstawia tekst etykiety, który ma być używany jako klucz.
setButton(button)KeyValueUstawia Button, który jest wyświetlany po prawej stronie kontekstu.
setContent(text)KeyValueOkreśla tekst, który ma być używany jako wartość.
setIcon(icon)KeyValueUstawia ikonę, która ma być używana jako klucz.
setIconAltText(altText)KeyValueUstawia tekst alternatywny dla ikony.
setIconUrl(url)KeyValueUstawia adres URL ikony, która ma być używana jako klucz.
setMultiline(multiline)KeyValueOkreśla, czy tekst wartości ma być wyświetlany na jednym czy na kilku wierszach.
setSwitch(switchToSet)KeyValueUstawia Switch, który jest wyświetlany po prawej stronie treści.
setTopLabel(text)KeyValueUstawia tekst etykiety, który ma być używany jako klucz.

Szczegółowa dokumentacja

setAuthorizationAction(action)

Ustawia działanie autoryzacji, które otwiera URL do procesu autoryzacji po kliknięciu obiektu. Spowoduje to otwarcie adresu URL w nowym oknie. Gdy użytkownik zakończy proces autoryzacji i powróci do aplikacji, wtyczka zostanie ponownie załadowana.

Obiekt interfejsu może mieć tylko jeden z tych parametrów: 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

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

Powrót

KeyValue – ten obiekt do łańcucha.


setComposeAction(action, composedEmailType)

Po kliknięciu obiektu ustawia działanie, które tworzy wersję roboczą e-maila. Obiekt interfejsu może mieć tylko jedną z tych przeglądarek: 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ą ComposeActionResponseBuilder.setGmailDraft(draft).

// ...

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

NazwaTypOpis
actionActionObiekt określający działanie, które ma zostać wykonane po kliknięciu tego elementu.
composedEmailTypeComposedEmailTypeWartość typu enum określająca, czy skomponowany projekt jest samodzielny czy odpowiedź.

Powrót

KeyValue – ten obiekt do łańcucha.


setOnClickAction(action)

Określa działanie, które jest wykonywane po kliknięciu obiektu. Obiekt interfejsu może mieć 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.

// ...

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

NazwaTypOpis
actionActionDziałanie, które ma być wykonywane po kliknięciu tego elementu.

Powrót

KeyValue – ten obiekt do łańcucha.


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 gdy oprócz utworzenia obiektu OpenLink musisz wykonać inne czynności. Obiekt interfejsu może mieć 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ą 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

NazwaTypOpis
actionActionObiekt określający działanie polegające na otwarciu linku, które ma zostać wykonane po kliknięciu tego elementu.

Powrót

KeyValue – ten obiekt do łańcucha.


Ustawia adres URL, który zostanie otwarty po kliknięciu obiektu. Użyj tej funkcji, gdy adres URL jest już znany i trzeba go tylko otworzyć. Obiekt interfejsu może mieć 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.

Powrót

KeyValue – ten obiekt do łańcucha.

Wycofane metody

Wycofany. Ta funkcja została wycofana i nie należy jej używać w nowych skryptach.

Ustawia tekst etykiety, który ma być używany jako klucz. Wyświetlany pod treścią.

Parametry

NazwaTypOpis
textStringTekst etykiety. Uwaga: nie obsługuje podstawowego formatowania HTML.

Powrót

KeyValue – ten obiekt do łańcucha.


Wycofany. Ta funkcja została wycofana i nie należy jej używać w nowych skryptach.

Ustawia Button, który jest wyświetlany po prawej stronie kontekstu. KeyValue może obsługiwać tylko 1 przycisk, 1 przełącznik lub 1 ikonę.

Parametry

NazwaTypOpis
buttonButtonPrzycisk dodawania.

Powrót

KeyValue – ten obiekt do łańcucha.


Wycofany. Ta funkcja została wycofana i nie należy jej używać w nowych skryptach.

Określa tekst, który ma być używany jako wartość. Obsługuje podstawowe formatowanie HTML. Wymagane.

Parametry

NazwaTypOpis
textStringTreść tekstowa tego widżetu.

Powrót

KeyValue – ten obiekt do łańcucha.


Wycofany. Ta funkcja została wycofana i nie należy jej używać w nowych skryptach.

Ustawia ikonę, która ma być używana jako klucz.

Parametry

NazwaTypOpis
iconIconjedną z wstępnie zdefiniowanych wartości Icon.

Powrót

KeyValue – ten obiekt do łańcucha.


Wycofany. Ta funkcja została wycofana i nie należy jej używać w nowych skryptach.

Ustawia tekst alternatywny dla ikony.

Parametry

NazwaTypOpis
altTextStringTekst alternatywny ikony.

Powrót

KeyValue – ten obiekt do łańcucha.


Wycofany. Ta funkcja została wycofana i nie należy jej używać w nowych skryptach.

Ustawia adres URL ikony, która ma być używana jako klucz.

Parametry

NazwaTypOpis
urlStringAdres URL hostowanego obrazu, który ma być używany jako ikona.

Powrót

KeyValue – ten obiekt do łańcucha.


Wycofany. Ta funkcja została wycofana i nie należy jej używać w nowych skryptach.

Określa, czy tekst wartości ma być wyświetlany na jednym czy na kilku wierszach.

Parametry

NazwaTypOpis
multilineBooleanUstawienie wielowierszowe.

Powrót

KeyValue – ten obiekt do łańcucha.


Wycofany. Ta funkcja została wycofana i nie należy jej używać w nowych skryptach.

Ustawia Switch, który jest wyświetlany po prawej stronie treści. KeyValue może obsługiwać tylko 1 przycisk, 1 przełącznik lub 1 ikonę.

Parametry

NazwaTypOpis
switchToSetSwitchPrzełącznik do dodania.

Powrót

KeyValue – ten obiekt do łańcucha.


Wycofany. Ta funkcja została wycofana i nie należy jej używać w nowych skryptach.

Ustawia tekst etykiety, który ma być używany jako klucz. Wyświetlany nad treścią.

Parametry

NazwaTypOpis
textStringTekst etykiety. Uwaga: nie obsługuje podstawowego formatowania HTML.

Powrót

KeyValue – ten obiekt do łańcucha.