Class KeyValue

KeyValue

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

Bu sınıf kullanımdan kaldırıldı. 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 yönlendiren bir URL açan yetkilendirme işlemi ayarlar.
setComposeAction(action, composedEmailType)KeyValueNesne tıklandığında taslak e-posta oluşturan bir işlemi 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 işlemi ayarlar.
setOpenLink(openLink)KeyValueNesne tıklandığında açılacak bir URL'yi ayarlar.

Ayrıntılı belgeler

setAuthorizationAction(action)

Nesne tıklandığında, yetkilendirme akışına yönlendiren bir URL açan yetkilendirme işlemi ayarlar. Bu işlem, URL'yi yeni bir pencerede açar. Kullanıcı yetkilendirme akışını bitirip uygulamaya döndüğünde eklenti yeniden yüklenir.

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. 

// ...

var action = CardService.newAuthorizationAction().setAuthorizationUrl('url');
CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);

Parametreler

AdTürAçıklama
actionAuthorizationActionBu öğe tıklandığında gerçekleştirilecek yetkilendirme işlemini belirten nesne.

Return

KeyValue: Zincirleme için bu nesne.

setComposeAction(action, composedEmailType)

Nesne tıklandığında taslak e-posta oluşturan bir işlemi 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 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 setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) veya setComposeAction(action, composedEmailType) değerlerinden yalnızca biri ayarlanmış 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

KeyValue: Zincirleme için bu nesne.

setOnClickOpenLinkAction(action)

Nesne tıklandığında bir URL'yi sekmede açan işlemi ayarlar. URL'nin oluşturulması gerektiğinde veya OpenLink nesnesini oluşturmaya ek olarak başka işlemler gerçekleştirmeniz 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) değerlerinden 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 gerçekleştirilecek açık bağlantı işlemini belirten nesne.

Return

KeyValue: Zincirleme için 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) grubundan birine sahip 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