Class ImageButton

ImageButton

Üzerinde resim gösterilen bir ImageButton.

Google Workspace eklentileri ve Google Chat uygulamaları için 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 yönelik bir URL'yi açan yetkilendirme işlemi ayarlar.
setComposeAction(action, composedEmailType)ImageButtonNesne tıklandığında e-posta taslağı oluşturan bir işlem ayarlar.
setIcon(icon)ImageButtonDüğmede gösterilecek ö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)ImageButtonMalzeme tasarımı simgesini ayarlar.
setOnClickAction(action)ImageButtonNesne tıklandığında yürütülecek bir işlem ayarlar.
setOnClickOpenLinkAction(action)ImageButtonNesne tıklandığında bir URL'yi sekmede açan bir işlem ayarlar.
setOpenLink(openLink)ImageButtonNesne tıklandığında açılacak bir URL ayarlar.
setOverflowMenu(menu)ImageButtonNesne tıklandığında açılacak bir pop-up menü ayarlar.

Ayrıntılı belgeler

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 kullanılan bu nesne.


setAuthorizationAction(action)

Nesne tıklandığında yetkilendirme akışına yönelik bir URL'yi 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) ayarlanabilir.

// ...

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 kullanılan bu nesne.


setComposeAction(action, composedEmailType)

Nesne tıklandığında e-posta taslağı oluşturan bir işlem ayarlar. Bir kullanıcı arayüzü nesnesinde yalnızca setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) veya setComposeAction(action, composedEmailType) 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(e) {
  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 gerçekleştirilecek e-posta oluşturma işlemini belirten nesne.
composedEmailTypeComposedEmailTypeOluşturulan taslağın bağımsız mı yoksa yanıt taslağı mı olduğunu belirten bir enum değeri.

Return

ImageButton: Zincirleme için kullanılan bu nesne.


setIcon(icon)

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

Parametreler

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

Return

ImageButton: Zincirleme için kullanılan bu nesne.


setIconUrl(url)

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

Parametreler

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

Return

ImageButton: Zincirleme için kullanılan bu nesne.


setImageButtonStyle(imageButtonStyle)

Düğme stilini ayarlar. Ayarlanmazsa varsayılan olarak ImageButtonStyle.BORDERLESS düğmesi kullanılır.

Google Chat uygulamalarında kullanılabilir. Google Workspace eklentileri için geliştirici önizlemesinde.

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

Parametreler

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

Return

ImageButton: Zincirleme için kullanılan bu nesne.


setMaterialIcon(icon)

Malzeme 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 kullanılan bu nesne.


setOnClickAction(action)

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

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 kullanılan bu nesne.


setOnClickOpenLinkAction(action)

Nesne tıklandığında bir URL'yi sekmede açan bir işlem 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) ayarlanabilir.

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 kullanılan bu nesne.


Nesne tıklandığında açılacak bir URL ayarlar. URL zaten biliniyorsa ve yalnızca açılması gerekiyorsa 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) ayarlanabilir.

Parametreler

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

Return

ImageButton: Zincirleme için kullanılan bu nesne.


setOverflowMenu(menu)

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

Google Chat uygulamalarında kullanılabilir. Google Workspace eklentileri için geliştirici önizlemesinde.

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 kullanılan bu nesne.