Class ImageButton

ImageButton

Üzerinde resim bulunan bir ImageButton.

Google Workspace eklentilerinde ve Google Chat uygulamalarında kullanılabilir.

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

Yöntemler

YöntemDönüş türüKısa açıklama
setAltText(altText)ImageButtonErişilebilirlik için düğmenin alternatif metnini ayarlar.
setAuthorizationAction(action)ImageButtonNesne tıklandığında yetkilendirme akışına giden bir URL açan yetkilendirme işlemi ayarlar.
setComposeAction(action, composedEmailType)ImageButtonNesne tıklandığında bir e-posta taslağı oluşturan bir işlem ayarlar.
setIcon(icon)ImageButtonDüğmede görüntülenecek önceden tanımlanmış bir Icon ayarlar.
setIconUrl(url)ImageButtonBu düğmenin simgesi olarak kullanılacak resmin URL'sini ayarlar.
setImageButtonStyle(imageButtonStyle)ImageButtonDüğme stilini ayarlar.
setMaterialIcon(icon)ImageButtonMateryal tasarım simgesini ayarlar.
setOnClickAction(action)ImageButtonNesne tıklandığında yürütülecek bir işlem ayarlar.
setOnClickOpenLinkAction(action)ImageButtonNesne tıklandığında URL'yi bir sekmede açan işlemi ayarlar.
setOpenLink(openLink)ImageButtonNesne tıklandığında açılacak bir URL ayarlar.
setOverflowMenu(menu)ImageButtonNesne tıklandığında açılacak bir pop-up menüsü ayarlar.

Ayrıntılı dokümanlar

setAltText(altText)

Erişilebilirlik için düğmenin alternatif metnini ayarlar. Zorunlu.

Parametreler

AdTürAçıklama
altTextStringBu düğmeye atanacak alternatif metin.

Return

ImageButton: Zincirleme için bu nesne.


setAuthorizationAction(action)

Nesne tıklandığında yetkilendirme akışına giden bir URL açan yetkilendirme işlemi ayarlar. Bu işlem, URL'yi yeni bir pencerede açar. Kullanıcı yetkilendirme akışını tamamlayıp uygulamaya döndüğünde eklenti yeniden yüklenir.

Bir kullanıcı arayüzü nesnesinde yalnızca setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) veya setComposeAction(action, composedEmailType) ayarlarından biri olabilir.

// ...

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

Parametreler

AdTürAçıklama
actionAuthorizationActionBu öğe tıklandığında yapılacak yetkilendirme işlemini belirten nesne.

Return

ImageButton: Zincirleme için bu nesne.


setComposeAction(action, composedEmailType)

Nesne tıklandığında bir e-posta taslağı oluşturan bir işlem ayarlar. Bir kullanıcı arayüzü nesnesinde setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) veya setComposeAction(action, composedEmailType) özelliklerinden yalnızca biri ayarlanabilir.

Action parametresi, ComposeActionResponseBuilder.setGmailDraft(draft) kullanılarak yapılandırılmış bir ComposeActionResponse nesnesi döndüren bir geri çağırma işlevi belirtmelidir.

// ...

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

Parametreler

AdTürAçıklama
actionActionBu öğe tıklandığında yapılacak oluşturma işlemini belirten nesne.
composedEmailTypeComposedEmailTypeOluşturulan taslağın bağımsız mı yoksa yanıt taslağı mı olduğunu belirten bir sıralama değeri.

Return

ImageButton: Zincirleme için bu nesne.


setIcon(icon)

Düğmede görüntülenecek önceden tanımlanmış bir Icon ayarlar. Düğme resmini tanımlamak için bu veya setIconUrl(url) değeri kullanılmalıdır.

Parametreler

AdTürAçıklama
iconIconÖnceden tanımlanmış Icon değerlerinden biri.

Return

ImageButton: Zincirleme için bu nesne.


setIconUrl(url)

Bu düğmenin simgesi olarak kullanılacak resmin URL'sini ayarlar. Düğme resmini tanımlamak için bu veya setIcon(icon) kullanılmalıdır.

Parametreler

AdTürAçıklama
urlStringBu düğmenin simgesi olarak kullanılacak, barındırılan resmin URL adresi.

Return

ImageButton: Zincirleme için bu nesne.


setImageButtonStyle(imageButtonStyle)

Düğme stilini ayarlar. Ayarlanmadan bırakılırsa varsayılan olarak ImageButtonStyle.BORDERLESS düğmesi olur.

Yalnızca Google Chat uygulamaları için kullanılabilir. Google Workspace eklentileri için kullanılamaz.

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

Parametreler

AdTürAçıklama
imageButtonStyleImageButtonStyleDüğme stili.

Return

ImageButton: Zincirleme için bu nesne.


setMaterialIcon(icon)

Materyal tasarım simgesini ayarlar.

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

Parametreler

AdTürAçıklama
iconMaterialIconMateryal tasarım simgesi.

Return

ImageButton: Zincirleme için bu nesne.


setOnClickAction(action)

Nesne tıklandığında yürütülecek bir işlemi ayarlar. Bir kullanıcı arayüzü nesnesinde yalnızca setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) veya setComposeAction(action, composedEmailType) ayarlanmış olabilir.

Action parametresi, ActionResponse nesnesi döndüren bir geri çağırma işlevi belirtmelidir.

// ...

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

Parametreler

AdTürAçıklama
actionActionBu öğe tıklandığında yapılacak işlem.

Return

ImageButton: Zincirleme için bu nesne.


setOnClickOpenLinkAction(action)

Nesne tıklandığında URL'yi bir sekmede açan işlemi ayarlar. URL'nin oluşturulması gerektiğinde veya OpenLink nesnesini oluşturmanın yanı sıra başka işlemler yapmanız gerektiğinde bu işlevi kullanın. Bir kullanıcı arayüzü nesnesinde yalnızca setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) veya setComposeAction(action, composedEmailType) ayarlarından biri olabilir.

Action parametresi, ActionResponseBuilder.setOpenLink(openLink) kullanılarak yapılandırılmış bir ActionResponse nesnesi döndüren bir geri çağırma işlevi belirtmelidir.

// ...

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

Parametreler

AdTürAçıklama
actionActionBu öğe tıklandığında gerçekleştirilecek açık bağlantı işlemini belirten nesne.

Return

ImageButton: Zincirleme için bu nesne.


Nesne tıklandığında açılacak bir URL ayarlar. URL zaten bilindiğinde ve yalnızca açılması gerektiğinde bu işlevi kullanın. Bir kullanıcı arayüzü nesnesinde yalnızca setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) veya setComposeAction(action, composedEmailType) ayarlarından biri olabilir.

Parametreler

AdTürAçıklama
openLinkOpenLinkAçılacak URL'yi açıklayan bir OpenLink nesnesi.

Return

ImageButton: Zincirleme için bu nesne.


setOverflowMenu(menu)

Nesne tıklandığında açılacak bir pop-up menüsü ayarlar. Menüdeki her öğe, tıklandığında tetiklenecek bir işlem belirtebilir. İç içe yerleştirilmiş menüler desteklenmez. Menü öğelerinin işlemleri, taşma menüsü belirtmemelidir.

Yalnızca Google Chat uygulamaları için kullanılabilir. Google Workspace eklentileri için kullanılamaz.

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

Parametreler

AdTürAçıklama
menuOverflowMenuBu öğe tıklandığında görüntülenecek taşma menüsünü belirten nesne.

Return

ImageButton: Zincirleme için bu nesne.