Class TextButton

TextButton

Metin etiketli bir TextButton. Arka plan rengini ayarlayabilir ve gerektiğinde düğmeyi devre dışı bırakabilirsiniz.

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

var textButton = CardService.newTextButton()
    .setText("Open Link")
    .setOpenLink(CardService.newOpenLink()
        .setUrl("https://www.google.com"));

Yöntemler

YöntemDönüş türüKısa açıklama
setAltText(altText)TextButtonErişilebilirlik için düğmenin alternatif metnini ayarlar.
setAuthorizationAction(action)TextButtonNesne tıklandığında yetkilendirme akışının URL'sini açan bir yetkilendirme işlemi ayarlar.
setBackgroundColor(backgroundColor)TextButtonTextButtonStyle.FILLED düğmesinin arka plan rengini ayarlar.
setComposeAction(action, composedEmailType)TextButtonNesne tıklandığında taslak e-posta oluşturan bir işlem ayarlar.
setDisabled(disabled)TextButtonDüğmenin devre dışı bırakılıp bırakılmayacağını belirler.
setOnClickAction(action)TextButtonNesne tıklandığında yürütülecek bir işlem ayarlar.
setOnClickOpenLinkAction(action)TextButtonNesne tıklandığında URL'yi sekmede açan bir işlem ayarlar.
setOpenLink(openLink)TextButtonNesne tıklandığında açılacak bir URL'yi ayarlar.
setText(text)TextButtonDüğmede görüntülenen metni ayarlar.
setTextButtonStyle(textButtonStyle)TextButtonDüğme stilini ayarlar.

Ayrıntılı belgeler

setAltText(altText)

Erişilebilirlik için düğmenin alternatif metnini ayarlar. Ayarlanmadan bırakılırsa varsayılan olarak düğmede gösterilen metin kullanılır.

Parametreler

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

Return

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


setAuthorizationAction(action)

Nesne tıklandığında yetkilendirme akışının URL'sini açan bir 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ü nesnesi yalnızca setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) veya setComposeAction(action, composedEmailType) aralığından birine sahip olabilir.

// ...

var 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

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


setBackgroundColor(backgroundColor)

TextButtonStyle.FILLED düğmesinin arka plan rengini ayarlar. Bir TextButtonStyle.FILLED düğmesi için ayarlanmadan bırakılırsa düğme, eklenti manifestinde tanımlanan ikincil rengi kullanır. Bu yöntemde TextButtonStyle.OUTLINED düğmeleri ile işlem yapılamaz.

Parametreler

AdTürAçıklama
backgroundColorString#rgb biçimindeki renk.

Return

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


setComposeAction(action, composedEmailType)

Nesne tıklandığında taslak e-posta oluşturan bir işlem ayarlar. Bir kullanıcı arayüzü nesnesinde setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) veya setComposeAction(action, composedEmailType) değerlerinden yalnızca biri ayarlanmış 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.

// ...

var action = CardService.newAction().setFunctionName('composeEmailCallback');
CardService.newTextButton()
    .setText('Compose Email')
    .setComposeAction(action, CardService.ComposedEmailType.REPLY_AS_DRAFT);

// ...

function composeEmailCallback() {
  var thread = GmailApp.getThreadById(e.threadId);
  var 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 oluşturma işlemini belirten nesne.
composedEmailTypeComposedEmailTypeOluşturulan taslağın bağımsız mı yoksa yanıt taslağı mı olduğunu belirten bir numaralandırma değeridir.

Return

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


setDisabled(disabled)

Düğmenin devre dışı bırakılıp bırakılmayacağını belirler. Devre dışı bırakılan bir düğme gri renktedir ve tıklanamaz.

Parametreler

AdTürAçıklama
disabledBooleanDevre dışı durumu.

Return

TextButton: 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ü nesnesi yalnızca setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) veya setComposeAction(action, composedEmailType) aralığından birine sahip olabilir.

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

// ...

var 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

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


setOnClickOpenLinkAction(action)

Nesne tıklandığında URL'yi sekmede açan bir işlem ayarlar. URL'nin oluşturulması gerektiğinde veya OpenLink nesnesini oluşturmaya ek olarak başka işlemler yapmanız gerektiğinde bu işlevi kullanın. Bir kullanıcı arayüzü nesnesi yalnızca setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) veya setComposeAction(action, composedEmailType) aralığından birine sahip 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.

// ...

var 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 açık bağlantı işlemini belirten nesne.

Return

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


Nesne tıklandığında açılacak bir URL'yi ayarlar. URL zaten biliniyorsa ve yalnızca açılması gerekiyorsa bu işlevi kullanın. Bir kullanıcı arayüzü nesnesi yalnızca setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) veya setComposeAction(action, composedEmailType) gruplarından birine sahip olabilir.

Parametreler

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

Return

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


setText(text)

Düğmede görüntülenen metni ayarlar.

Parametreler

AdTürAçıklama
textStringDüğmede görünen metin.

Return

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


setTextButtonStyle(textButtonStyle)

Düğme stilini ayarlar. Ayarlanmadan bırakılırsa varsayılan olarak TextButtonStyle.OUTLINED düğmesi kullanılır.

Parametreler

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

Return

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