Class ImageButton

ImageButton

ImageButton z wyświetlonym obrazem.

Dostępne w przypadku dodatków do Google Workspace i aplikacji Google Chat.

const imageButton =
    CardService.newImageButton()
        .setAltText('An image button with an airplane icon.')
        .setIcon(CardService.Icon.AIRPLANE)
        .setOpenLink(CardService.newOpenLink().setUrl('https://airplane.com'));

Metody

MetodaZwracany typKrótki opis
setAltText(altText)ImageButtonUstawia tekst zastępczy przycisku na potrzeby ułatwień dostępu.
setAuthorizationAction(action)ImageButtonPo kliknięciu obiektu ustawia działanie autoryzacyjne, które otwiera URL do procesu autoryzacji.
setComposeAction(action, composedEmailType)ImageButtonPo kliknięciu obiektu ustawia działanie, które tworzy wersję roboczą e-maila.
setIcon(icon)ImageButtonUstawia wstępnie zdefiniowany Icon do wyświetlania na przycisku.
setIconUrl(url)ImageButtonUstawia adres URL obrazu, który ma być używany jako ikona tego przycisku.
setImageButtonStyle(imageButtonStyle)ImageButtonUstawia styl przycisku.
setMaterialIcon(icon)ImageButtonUstawia ikonę Material Design.
setOnClickAction(action)ImageButtonOkreśla działanie, które jest wykonywane po kliknięciu obiektu.
setOnClickOpenLinkAction(action)ImageButtonUstawia działanie, które po kliknięciu obiektu otwiera adres URL na karcie.
setOpenLink(openLink)ImageButtonUstawia adres URL, który zostanie otwarty po kliknięciu obiektu.
setOverflowMenu(menu)ImageButtonUstawia menu, które otwiera się po kliknięciu obiektu.

Szczegółowa dokumentacja

setAltText(altText)

Ustawia tekst zastępczy przycisku na potrzeby ułatwień dostępu. Wymagane.

Parametry

NazwaTypOpis
altTextStringTekst zastępczy do przypisania do tego przycisku.

Powrót

ImageButton – ten obiekt do łańcucha.


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

ImageButton – ten obiekt do łańcucha.


setComposeAction(action, composedEmailType)

Ustawia działanie tworzące wersję roboczą e-maila po kliknięciu obiektu. 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() {
  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 związane z tworzeniem, które ma zostać wykonane po kliknięciu tego elementu.
composedEmailTypeComposedEmailTypeWartość typu enumeracji określająca, czy skomponowany projekt jest samodzielny czy jest odpowiedzią na inny projekt.

Powrót

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


setIcon(icon)

Ustawia wstępnie zdefiniowany Icon do wyświetlania na przycisku. Do zdefiniowania obrazu przycisku należy użyć tej właściwości lub właściwości setIconUrl(url).

Parametry

NazwaTypOpis
iconIconJedna ze wstępnie zdefiniowanych wartości atrybutu Icon.

Powrót

ImageButton – ten obiekt do łańcucha.


setIconUrl(url)

Ustawia adres URL obrazu, który ma być używany jako ikona tego przycisku. Do zdefiniowania obrazu przycisku należy użyć albo tego parametru, albo setIcon(icon).

Parametry

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

Powrót

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


setImageButtonStyle(imageButtonStyle)

Ustawia styl przycisku. Jeśli nie jest ustawiony, domyślnie jest używany przycisk ImageButtonStyle.BORDERLESS.

Dostępne tylko w aplikacjach Google Chat. Niedostępne w przypadku dodatków Google Workspace.

const imageButton = CardService.newImageButton().setImageButtonStyle(
    CardService.ImageButtonStyle.BORDERLESS,
);

Parametry

NazwaTypOpis
imageButtonStyleImageButtonStyleStyl przycisku.

Powrót

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


setMaterialIcon(icon)

Umożliwia skonfigurowanie ikony w ramach projektu Material Design.

const imageButton = CardService.newImageButton().setMaterialIcon(
    CardService.newMaterialIcon().setName('search'),
);

Parametry

NazwaTypOpis
iconMaterialIconIkona w stylu Material Design.

Powrót

ImageButton – 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

ImageButton – ten obiekt do łańcucha.


setOnClickOpenLinkAction(action)

Ustawia działanie, które po kliknięciu obiektu otwiera adres URL na karcie. Używaj tej funkcji, gdy musisz utworzyć adres URL lub gdy oprócz utworzenia obiektu OpenLink musisz wykonać inne działania. 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 otwierania linku, które ma zostać wykonane po kliknięciu tego elementu.

Powrót

ImageButton – 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, który ma zostać otwarty.

Powrót

ImageButton – ten obiekt do łańcucha.


setOverflowMenu(menu)

Ustawia menu, które otwiera się po kliknięciu obiektu. Każdy element w menu może określać działanie, które zostanie wykonane po kliknięciu. Zagnieżdżone menu nie są obsługiwane, a czynności dotyczące pozycji menu nie powinny określać menu przepełnienia.

Dostępne tylko w przypadku aplikacji Google Chat. Niedostępne w przypadku dodatków Google Workspace.

const overflowMenuItem =
    CardService.newOverflowMenuItem()
        .setStartIcon(
            CardService.newIconImage().setIconUrl(
                'https://www.google.com/images/branding/googleg/1x/googleg_standard_color_64dp.png',
                ),
            )
        .setText('Open Link')
        .setOpenLink(
            CardService.newOpenLink().setUrl('https://www.google.com'));

const overflowMenu =
    CardService.newOverflowMenu().addMenuItem(overflowMenuItem).build();

Parametry

NazwaTypOpis
menuOverflowMenuObiekt określający rozszerzone menu wyświetlane po kliknięciu tego elementu.

Powrót

ImageButton – ten obiekt do łańcucha.