Class KeyValue

AnahtarDeğer

Kullanımdan kaldırıldı. Bu sınıfın desteği sonlandırıldı ve yeni komut dosyalarında kullanılmamalıdır.

Bu sınıfın desteği sonlandırılmıştır. Bunun yerine DecoratedText kullanın.

Yöntemler

YöntemDönüş türüKısa açıklama
setAuthorizationAction(action)KeyValueNesne tıklandığında yetkilendirme akışına giden bir URL açan yetkilendirme işlemi ayarlar.
setComposeAction(action, composedEmailType)KeyValueNesne tıklandığında bir e-posta taslağı oluşturan bir işlem ayarlar.
setOnClickAction(action)KeyValueNesne tıklandığında yürütülecek bir işlem ayarlar.
setOnClickOpenLinkAction(action)KeyValueNesne tıklandığında bir URL'yi sekmede açan bir işlem ayarlar.
setOpenLink(openLink)KeyValueNesne tıklandığında açılacak bir URL ayarlar.
YöntemDönüş türüKısa açıklama
setBottomLabel(text)KeyValueAnahtar olarak kullanılacak etiket metnini ayarlar.
setButton(button)KeyValueBağlamı sağ tarafında görüntülenen Button öğesini ayarlar.
setContent(text)KeyValueDeğer olarak kullanılacak metni ayarlar.
setIcon(icon)KeyValueAnahtar olarak kullanılacak simgeyi ayarlar.
setIconAltText(altText)KeyValueSimgenin alternatif metnini ayarlar.
setIconUrl(url)KeyValueAnahtar olarak kullanılacak simgenin URL'sini ayarlar.
setMultiline(multiline)KeyValueDeğer metninin tek satırda mı yoksa birden fazla satırda mı gösterileceğini belirler.
setSwitch(switchToSet)KeyValueİçeriğin sağ tarafında gösterilen Switch öğesini ayarlar.
setTopLabel(text)KeyValueAnahtar olarak kullanılacak etiket metnini ayarlar.

Ayrıntılı dokümanlar

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 geri 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

KeyValue: Zincirleme için bu nesne.


setComposeAction(action, composedEmailType)

Nesne tıklandığında bir e-posta taslağı oluşturan bir işlem ayarlar. Kullanıcı arayüzü nesnelerinde yalnızca setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) veya setComposeAction(action, composedEmailType) ayarlarından biri olabilir.

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 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 enum değeri.

Return

KeyValue: Zincirleme için 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) ayarlarından biri 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

KeyValue: Zincirleme için 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) 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 yapılacak bağlantı açma işlemini belirten nesne.

Return

KeyValue: 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

KeyValue: Zincirleme için bu nesne.

Kullanımdan kaldırılan yöntemler

Kullanımdan kaldırıldı. Bu işlevin desteği sonlandırılmıştır ve yeni komut dosyalarında kullanılmamalıdır.

Anahtar olarak kullanılacak etiket metnini ayarlar. Metin içeriğinin altında gösterilir.

Parametreler

AdTürAçıklama
textStringEtiket metni. Not: Temel HTML biçimlendirmesi desteklenmez.

Return

KeyValue: Zincirleme için bu nesne.


Kullanımdan kaldırıldı. Bu işlevin desteği sonlandırılmıştır ve yeni komut dosyalarında kullanılmamalıdır.

Bağlamı sağ tarafında görüntülenen Button öğesini ayarlar. KeyValue yalnızca bir düğmeyi, anahtarı veya simgeyi destekleyebilir.

Parametreler

AdTürAçıklama
buttonButtonEkle düğmesi.

Return

KeyValue: Zincirleme için bu nesne.


Kullanımdan kaldırıldı. Bu işlevin desteği sonlandırılmıştır ve yeni komut dosyalarında kullanılmamalıdır.

Değer olarak kullanılacak metni ayarlar. Temel HTML biçimlendirmesini destekler. Zorunlu.

Parametreler

AdTürAçıklama
textStringBu widget'ın metin içeriği.

Return

KeyValue: Zincirleme için bu nesne.


Kullanımdan kaldırıldı. Bu işlevin desteği sonlandırılmıştır ve yeni komut dosyalarında kullanılmamalıdır.

Anahtar olarak kullanılacak simgeyi ayarlar.

Parametreler

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

Return

KeyValue: Zincirleme için bu nesne.


Kullanımdan kaldırıldı. Bu işlevin desteği sonlandırılmıştır ve yeni komut dosyalarında kullanılmamalıdır.

Simgenin alternatif metnini ayarlar.

Parametreler

AdTürAçıklama
altTextStringSimgenin alternatif metni.

Return

KeyValue: Zincirleme için bu nesne.


Kullanımdan kaldırıldı. Bu işlevin desteği sonlandırılmıştır ve yeni komut dosyalarında kullanılmamalıdır.

Anahtar olarak kullanılacak simgenin URL'sini ayarlar.

Parametreler

AdTürAçıklama
urlStringSimge olarak kullanılacak barındırılan resmin URL adresi.

Return

KeyValue: Zincirleme için bu nesne.


Kullanımdan kaldırıldı. Bu işlevin desteği sonlandırılmıştır ve yeni komut dosyalarında kullanılmamalıdır.

Değer metninin tek satırda mı yoksa birden fazla satırda mı gösterileceğini belirler.

Parametreler

AdTürAçıklama
multilineBooleanÇok satırlık ayar.

Return

KeyValue: Zincirleme için bu nesne.


Kullanımdan kaldırıldı. Bu işlevin desteği sonlandırılmıştır ve yeni komut dosyalarında kullanılmamalıdır.

İçeriğin sağ tarafında gösterilen Switch öğesini ayarlar. KeyValue yalnızca bir düğmeyi, anahtarı veya simgeyi destekleyebilir.

Parametreler

AdTürAçıklama
switchToSetSwitchEklenecek anahtar.

Return

KeyValue: Zincirleme için bu nesne.


Kullanımdan kaldırıldı. Bu işlevin desteği sonlandırılmıştır ve yeni komut dosyalarında kullanılmamalıdır.

Anahtar olarak kullanılacak etiket metnini ayarlar. Metin içeriğinin üzerinde gösterilir.

Parametreler

AdTürAçıklama
textStringEtiket metni. Not: Temel HTML biçimlendirmesi desteklenmez.

Return

KeyValue: Zincirleme için bu nesne.