İ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 set ve Decorated, Decorated, set veya set'den biri kullanılmalıdır. Bu sınıf, yerine geçmek üzere tasarlanmıştır.
Key
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öntem | Dönüş türü | Kısa açıklama |
|---|---|---|
add | Widget | Widget'ta gerçekleştirilebilecek etkinlik işlemini ekler. |
set | Decorated | Nesne tıklandığında yetkilendirme akışına yönelik bir URL'yi açan yetkilendirme işlemi ayarlar. |
set | Decorated | Anahtar olarak kullanılacak etiket metnini ayarlar ve metin içeriğinin altında gösterilir. |
set | Decorated | Metnin sağında gösterilen Button ayarlar. |
set | Decorated | Nesne tıklandığında e-posta taslağı oluşturan bir işlem ayarlar. |
set | Decorated | İçeriğin sağında gösterilen isteğe bağlı Icon karakterini ayarlar. |
set | Widget | Değiştirilecek widget'ı tanımlamak için kullanılan benzersiz kimliği ayarlar. |
set | Decorated | Nesne tıklandığında yürütülecek bir işlem ayarlar. |
set | Decorated | Nesne tıklandığında bir URL'yi sekmede açan bir işlem ayarlar. |
set | Decorated | Nesne tıklandığında açılacak bir URL ayarlar. |
set | Decorated | Metin içeriğinden önce isteğe bağlı Icon karakterinin gösterilmesini sağlar. |
set | Decorated | İçeriğin sağında gösterilen Switch ayarlar. |
set | Decorated | Değer olarak kullanılacak metni ayarlar. |
set | Decorated | Anahtar olarak kullanılacak etiket metnini ayarlar ve metin içeriğinin üzerinde gösterilir. |
set | Widget | Widget'ın görünürlüğünü ayarlar. |
set | Decorated | Değer metninin tek satırda mı yoksa birden fazla satırda mı gösterileceğini ayarlar. |
Ayrıntılı belgeler
add Event Action(eventAction)
Widget'ta gerçekleştirilebilecek etkinlik işlemini ekler.
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
event | Event | Eklenecek Event. |
Return
Widget: Zincirleme için kullanılan Nesne.
set Authorization Action(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 set, set, set, set veya set ayarlanabilir.
// ... const action = CardService.newAuthorizationAction().setAuthorizationUrl('url'); CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
action | Authorization | Bu öğe tıklandığında yapılacak yetkilendirme işlemini belirten nesne. |
Return
Decorated: Zincirleme için kullanılan bu nesne.
set Bottom Label(text)
Anahtar olarak kullanılacak etiket metnini ayarlar ve metin içeriğinin altında gösterilir.
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
text | String | Etiket metni. |
Return
Decorated: Zincirleme için kullanılan bu nesne.
set Button(button)
Metnin sağında gösterilen Button ayarlar. Bir Decorated yalnızca bir düğmeyi veya bir anahtarı destekleyebilir.
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
button | Button | Ekleme düğmesi. |
Return
Decorated: Zincirleme için kullanılan bu nesne.
set Compose Action(action, composedEmailType)
Nesne tıklandığında e-posta taslağı oluşturan bir işlem ayarlar. Bir kullanıcı arayüzü nesnesinde yalnızca set, set, set, set veya set ayarlanabilir.
Action parametresi, Compose kullanılarak yapılandırılmış bir Compose 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
| Ad | Tür | Açıklama |
|---|---|---|
action | Action | Bu öğe tıklandığında gerçekleştirilecek e-posta oluşturma işlemini belirten nesne. |
composed | Composed | Oluşturulan taslağın bağımsız mı yoksa yanıt taslağı mı olduğunu belirten bir enum değeri. |
Return
Decorated: Zincirleme için kullanılan bu nesne.
set End Icon(endIcon)
İçeriğin sağında gösterilen isteğe bağlı Icon karakterini ayarlar. Bir Decorated yalnızca bir düğmeyi, bir anahtarı veya bir simgeyi destekleyebilir.
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
end | Icon | Eklenecek simge. |
Return
Decorated: Zincirleme için kullanılan bu nesne.
set Id(id)
Değiştirilecek widget'ı tanımlamak için kullanılan benzersiz kimliği ayarlar. Widget mutasyonu yalnızca eklentilerde desteklenir.
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
id | String | 64 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.
set On Click Action(action)
Nesne tıklandığında yürütülecek bir işlem ayarlar. Bir kullanıcı arayüzü nesnesinde yalnızca set, set, set, set veya set ayarlanabilir.
Action parametresi, Action 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
| Ad | Tür | Açıklama |
|---|---|---|
action | Action | Bu öğe tıklandığında yapılacak işlem. |
Return
Decorated: Zincirleme için kullanılan bu nesne.
set On Click Open Link Action(action)
Nesne tıklandığında bir URL'yi sekmede açan bir işlem ayarlar. URL'nin oluşturulması gerektiğinde veya Open 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 set, set, set, set veya set ayarlanabilir.
Action parametresi, Action kullanılarak yapılandırılmış bir Action 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
| Ad | Tür | Açıklama |
|---|---|---|
action | Action | Bu öğe tıklandığında gerçekleştirilecek açık bağlantı işlemini belirten nesne. |
Return
Decorated: Zincirleme için kullanılan bu nesne.
set Open Link(openLink)
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 set, set, set, set veya set ayarlanabilir.
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
open | Open | Açılacak URL'yi açıklayan bir Open nesnesi. |
Return
Decorated: Zincirleme için kullanılan bu nesne.
set Start Icon(startIcon)
Metin içeriğinden önce isteğe bağlı Icon öğesini görüntüler.
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
start | Icon | Gösterilecek simge. |
Return
Decorated: Zincirleme için kullanılan bu nesne.
set Switch Control(switchToSet)
İçeriğin sağında gösterilen Switch ayarlar. Bir Decorated
yalnızca bir düğmeyi veya bir anahtarı destekleyebilir.
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
switch | Switch | Eklenecek anahtar. |
Return
Decorated: Zincirleme için kullanılan bu nesne.
set Text(text)
Değer olarak kullanılacak metni ayarlar. Temel HTML biçimlendirmesini destekler. Zorunlu.
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
text | String | Bu widget'ın metin içeriği. |
Return
Decorated: Zincirleme için kullanılan bu nesne.
set Top Label(text)
Anahtar olarak kullanılacak etiket metnini ayarlar ve metin içeriğinin üzerinde gösterilir.
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
text | String | Etiket metni. |
Return
Decorated: Zincirleme için kullanılan bu nesne.
set Visibility(visibility)
Widget'ın görünürlüğünü ayarlar. Varsayılan değer "VISIBLE"dır.
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
visibility | Visibility | Widget'ın Visibility. |
Return
Widget: Zincirleme için kullanılan Nesne.
set Wrap Text(wrapText)
Değer metninin tek satırda mı yoksa birden fazla satırda mı gösterileceğini ayarlar.
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
wrap | Boolean | true ise metin kaydırılır ve birden fazla satırda gösterilir. Aksi takdirde metin kısaltılır. |
Return
Decorated: Zincirleme için kullanılan bu nesne.