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 set ile birlikte Decorated, Decorated, set veya set'ten biri kullanılmalıdır. Bu sınıf, sınıfının yerini alacak şekilde 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 |
|---|---|---|
set | Decorated | Nesne tıklandığında yetkilendirme akışına giden bir URL açan yetkilendirme işlemi ayarlar. |
set | Decorated | Anahtar olarak kullanılacak etiket metnini ayarlar ve metin içeriğinin altında görüntülenir. |
set | Decorated | Metnin sağ tarafında gösterilen Button öğesini ayarlar. |
set | Decorated | Nesne tıklandığında bir e-posta taslağı oluşturan bir işlem ayarlar. |
set | Decorated | İçeriğin sağ tarafında gösterilen isteğe bağlı Icon öğesini 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 | İsteğe bağlı Icon öğesini metin içeriğinden önce gösterilecek şekilde ayarlar. |
set | Decorated | İçeriğin sağ tarafında gösterilen Switch öğesini 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 | Decorated | Değer metninin tek satırda mı yoksa birden fazla satırda mı gösterileceğini belirler. |
Ayrıntılı dokümanlar
set Authorization Action(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 set, set, set, set veya set ayarlarından biri olabilir.
// ... 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 bu nesne.
set Bottom Label(text)
Anahtar olarak kullanılacak etiket metnini ayarlar ve metin içeriğinin altında görüntülenir.
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
text | String | Etiket metni. |
Return
Decorated: Zincirleme için bu nesne.
set Button(button)
Metnin sağ tarafında gösterilen Button öğesini ayarlar. Decorated yalnızca bir düğmeyi veya bir anahtarı destekleyebilir.
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
button | Button | Ekle düğmesi. |
Return
Decorated: Zincirleme için bu nesne.
set Compose Action(action, composedEmailType)
Nesne tıklandığında bir e-posta taslağı oluşturan bir işlem ayarlar. Kullanıcı arayüzü nesnelerinde yalnızca set, set, set, set veya set ayarlarından biri olabilir.
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 yapılacak 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 bu nesne.
set End Icon(endIcon)
İçeriğin sağ tarafında gösterilen isteğe bağlı Icon öğesini ayarlar. 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 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 ayarlarından biri olabilir.
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 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 ayarlarından biri olabilir.
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 yapılacak bağlantı açma işlemini belirten nesne. |
Return
Decorated: Zincirleme için bu nesne.
set Open Link(openLink)
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 set, set, set, set veya set ayarlarından biri olabilir.
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
open | Open | Açılacak URL'yi açıklayan bir Open nesnesi. |
Return
Decorated: Zincirleme için bu nesne.
set Start Icon(startIcon)
İsteğe bağlı Icon öğesini metin içeriğinden önce gösterilecek şekilde ayarlar.
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
start | Icon | Gösterilecek simge. |
Return
Decorated: Zincirleme için bu nesne.
set Switch Control(switchToSet)
İçeriğin sağ tarafında gösterilen Switch öğesini ayarlar. 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 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 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 bu nesne.
set Wrap Text(wrapText)
Değer metninin tek satırda mı yoksa birden fazla satırda mı gösterileceğini belirler.
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 bu nesne.