Class DecoratedText

DecoratedText

Metni isteğe bağlı süslemelerle gösteren bir widget. Olası anahtarlar arasında bir simge, üstte bir etiket ve altta bir etiket bulunur. Metin içeriğini ve anahtarlardan birini ayarlamak için setText(text) ile birlikte DecoratedText, DecoratedText, setTopLabel(text) veya setBottomLabel(text)'ten biri kullanılmalıdır. Bu sınıf, KeyValue sınıfının yerini alacak şekilde tasarlanmıştır.

Google Workspace eklentileri ve Google Chat uygulamaları için kullanılabilir.

const decoratedText =
    CardService.newDecoratedText().setText('Text').setTopLabel('TopLabel');

const multilineDecoratedText = CardService.newDecoratedText()
                                   .setText('Text')
                                   .setTopLabel('TopLabel')
                                   .setWrapText(true)
                                   .setBottomLabel('BottomLabel');

Yöntemler

YöntemDönüş türüKısa açıklama
setAuthorizationAction(action)DecoratedTextNesne tıklandığında yetkilendirme akışına giden bir URL açan yetkilendirme işlemi ayarlar.
setBottomLabel(text)DecoratedTextAnahtar olarak kullanılacak etiket metnini ayarlar ve metin içeriğinin altında görüntülenir.
setButton(button)DecoratedTextMetnin sağ tarafında görüntülenen Button öğesini ayarlar.
setComposeAction(action, composedEmailType)DecoratedTextNesne tıklandığında bir e-posta taslağı oluşturan bir işlem ayarlar.
setEndIcon(endIcon)DecoratedTextİçeriğin sağ tarafında gösterilen isteğe bağlı IconImage öğesini ayarlar.
setOnClickAction(action)DecoratedTextNesne tıklandığında yürütülecek bir işlem ayarlar.
setOnClickOpenLinkAction(action)DecoratedTextNesne tıklandığında bir URL'yi sekmede açan bir işlem ayarlar.
setOpenLink(openLink)DecoratedTextNesne tıklandığında açılacak bir URL ayarlar.
setStartIcon(startIcon)DecoratedTextİsteğe bağlı IconImage öğesini metin içeriğinden önce gösterilecek şekilde ayarlar.
setSwitchControl(switchToSet)DecoratedTextİçeriğin sağ tarafında gösterilen Switch öğesini ayarlar.
setText(text)DecoratedTextDeğer olarak kullanılacak metni ayarlar.
setTopLabel(text)DecoratedTextAnahtar olarak kullanılacak etiket metnini ayarlar ve metin içeriğinin üzerinde gösterilir.
setWrapText(wrapText)DecoratedTextDeğer metninin tek satırda mı yoksa birden fazla satırda mı gösterileceğini belirler.

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

DecoratedText: Zincirleme için bu nesne.


setBottomLabel(text)

Anahtar olarak kullanılacak etiket metnini ayarlar ve metin içeriğinin altında görüntülenir.

Parametreler

AdTürAçıklama
textStringEtiket metni.

Return

DecoratedText: Zincirleme için bu nesne.


setButton(button)

Metnin sağ tarafında gösterilen Button öğesini ayarlar. DecoratedText yalnızca bir düğmeyi veya bir anahtarı destekleyebilir.

Parametreler

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

Return

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

DecoratedText: Zincirleme için bu nesne.


setEndIcon(endIcon)

İçeriğin sağ tarafında gösterilen isteğe bağlı IconImage öğesini ayarlar. DecoratedText yalnızca bir düğme, bir anahtar veya bir simgeyi destekleyebilir.

Parametreler

AdTürAçıklama
endIconIconImageEklenecek simge.

Return

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

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

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

DecoratedText: Zincirleme için bu nesne.


setStartIcon(startIcon)

İsteğe bağlı IconImage öğesini metin içeriğinden önce gösterilecek şekilde ayarlar.

Parametreler

AdTürAçıklama
startIconIconImageGösterilecek simge.

Return

DecoratedText: Zincirleme için bu nesne.


setSwitchControl(switchToSet)

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

Parametreler

AdTürAçıklama
switchToSetSwitchEklenecek anahtar.

Return

DecoratedText: Zincirleme için bu nesne.


setText(text)

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

DecoratedText: Zincirleme için bu nesne.


setTopLabel(text)

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

Parametreler

AdTürAçıklama
textStringEtiket metni.

Return

DecoratedText: Zincirleme için bu nesne.


setWrapText(wrapText)

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

Parametreler

AdTürAçıklama
wrapTextBooleantrue ise metin kaydırılır ve birden fazla satırda gösterilir. Aksi takdirde metin kısaltılır.

Return

DecoratedText: Zincirleme için bu nesne.