Class DecoratedText

DecoratedText

İsteğe bağlı süslemelerle metin görüntüleyen bir widget. Olası anahtarlar arasında simge, üstteki etiket ve alttaki etiket bulunur. Metin içeriğini ve anahtarlardan birini ayarlamak için setText(text) ve DecoratedText, DecoratedText, setTopLabel(text) veya setBottomLabel(text)'den biri kullanılmalıdır. Bu sınıf, KeyValue yerine geçmek üzere 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
addEventAction(eventAction)WidgetWidget'ta gerçekleştirilebilecek etkinlik işlemini ekler.
setAuthorizationAction(action)DecoratedTextNesne tıklandığında yetkilendirme akışına yönelik bir URL'yi açan yetkilendirme işlemi ayarlar.
setBottomLabel(text)DecoratedTextAnahtar olarak kullanılacak etiket metnini ayarlar ve metin içeriğinin altında gösterilir.
setButton(button)DecoratedTextMetnin sağında gösterilen Button ayarlar.
setComposeAction(action, composedEmailType)DecoratedTextNesne tıklandığında e-posta taslağı oluşturan bir işlem ayarlar.
setEndIcon(endIcon)DecoratedTextİçeriğin sağında gösterilen isteğe bağlı IconImage karakterini ayarlar.
setId(id)WidgetDeğiştirilecek widget'ı tanımlamak için kullanılan benzersiz kimliği 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)DecoratedTextMetin içeriğinden önce isteğe bağlı IconImage karakterinin gösterilmesini sağlar.
setSwitchControl(switchToSet)DecoratedTextİçeriğin sağında gösterilen Switch 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.
setVisibility(visibility)WidgetWidget'ın görünürlüğünü ayarlar.
setWrapText(wrapText)DecoratedTextDeğer metninin tek satırda mı yoksa birden fazla satırda mı gösterileceğini ayarlar.

Ayrıntılı belgeler

addEventAction(eventAction)

Widget'ta gerçekleştirilebilecek etkinlik işlemini ekler.

Parametreler

AdTürAçıklama
eventActionEventActionEklenecek EventAction.

Return

Widget: Zincirleme için kullanılan 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

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


setBottomLabel(text)

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

Parametreler

AdTürAçıklama
textStringEtiket metni.

Return

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


setButton(button)

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

Parametreler

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

Return

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

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


setEndIcon(endIcon)

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

Parametreler

AdTürAçıklama
endIconIconImageEklenecek simge.

Return

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


setId(id)

Değiştirilecek widget'ı tanımlamak için kullanılan benzersiz kimliği ayarlar. Widget mutasyonu yalnızca eklentilerde desteklenir.

Parametreler

AdTürAçıklama
idString64 karakterle sınırlı ve `[a-zA-Z0-9-]+` biçiminde olan widget'ın kimliği.

Return

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

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

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

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


setStartIcon(startIcon)

Metin içeriğinden önce isteğe bağlı IconImage öğesini görüntüler.

Parametreler

AdTürAçıklama
startIconIconImageGösterilecek simge.

Return

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


setSwitchControl(switchToSet)

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

Parametreler

AdTürAçıklama
switchToSetSwitchEklenecek anahtar.

Return

DecoratedText: Zincirleme için kullanılan 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 kullanılan 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 kullanılan bu nesne.


setVisibility(visibility)

Widget'ın görünürlüğünü ayarlar. Varsayılan değer "VISIBLE"dır.

Parametreler

AdTürAçıklama
visibilityVisibilityWidget'ın Visibility.

Return

Widget: Zincirleme için kullanılan Nesne.


setWrapText(wrapText)

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

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