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 setText(text)
ile birlikte DecoratedText
, DecoratedText
, setTopLabel(text)
veya setBottomLabel(text)
'ten biri kullanılmalıdır. Bu sınıf,
sınıfının yerini alacak şekilde tasarlanmıştır.
KeyValue
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 |
---|---|---|
setAuthorizationAction(action) | DecoratedText | Nesne tıklandığında yetkilendirme akışına giden bir URL açan yetkilendirme işlemi ayarlar. |
setBottomLabel(text) | DecoratedText | Anahtar olarak kullanılacak etiket metnini ayarlar ve metin içeriğinin altında görüntülenir. |
setButton(button) | DecoratedText | Metnin sağ tarafında görüntülenen Button öğesini ayarlar. |
setComposeAction(action, composedEmailType) | DecoratedText | Nesne tıklandığında bir e-posta taslağı oluşturan bir işlem ayarlar. |
setEndIcon(endIcon) | DecoratedText | İçeriğin sağ tarafında gösterilen isteğe bağlı IconImage öğesini ayarlar. |
setOnClickAction(action) | DecoratedText | Nesne tıklandığında yürütülecek bir işlem ayarlar. |
setOnClickOpenLinkAction(action) | DecoratedText | Nesne tıklandığında bir URL'yi sekmede açan bir işlem ayarlar. |
setOpenLink(openLink) | DecoratedText | Nesne tıklandığında açılacak bir URL ayarlar. |
setStartIcon(startIcon) | DecoratedText | İsteğe bağlı IconImage öğesini metin içeriğinden önce gösterilecek şekilde ayarlar. |
setSwitchControl(switchToSet) | DecoratedText | İçeriğin sağ tarafında gösterilen Switch öğesini ayarlar. |
setText(text) | DecoratedText | Değer olarak kullanılacak metni ayarlar. |
setTopLabel(text) | DecoratedText | Anahtar olarak kullanılacak etiket metnini ayarlar ve metin içeriğinin üzerinde gösterilir. |
setWrapText(wrapText) | DecoratedText | Değer metninin tek satırda mı yoksa birden fazla satırda mı gösterileceğini belirler. |
Ayrıntılı dokümanlar
setAuthorizationAction(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 setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
veya setComposeAction(action, composedEmailType)
ayarlarından biri olabilir.
// ... const action = CardService.newAuthorizationAction().setAuthorizationUrl('url'); CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);
Parametreler
Ad | Tür | Açıklama |
---|---|---|
action | AuthorizationAction | Bu öğe tıklandığında yapılacak yetkilendirme işlemini belirten nesne. |
Return
DecoratedText
: Zincirleme için bu nesne.
setBottomLabel(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
DecoratedText
: Zincirleme için bu nesne.
setButton(button)
Metnin sağ tarafında gösterilen Button
öğesini ayarlar. DecoratedText
yalnızca bir düğmeyi veya bir anahtarı destekleyebilir.
Parametreler
Ad | Tür | Açıklama |
---|---|---|
button | Button | Ekle düğmesi. |
Return
DecoratedText
: Zincirleme için bu nesne.
setComposeAction(action, composedEmailType)
Nesne tıklandığında bir e-posta taslağı oluşturan bir işlem ayarlar. Kullanıcı arayüzü nesnelerinde yalnızca setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
veya setComposeAction(action, composedEmailType)
ayarlarından biri 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.
// ... 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. |
composedEmailType | ComposedEmailType | Oluşturulan taslağın bağımsız mı yoksa yanıt taslağı mı olduğunu belirten bir enum değeri. |
Return
DecoratedText
: Zincirleme için bu nesne.
setEndIcon(endIcon)
İçeriğin sağ tarafında gösterilen isteğe bağlı IconImage
öğesini ayarlar. DecoratedText
yalnızca bir düğme, bir anahtar veya bir simgeyi destekleyebilir.
Parametreler
Ad | Tür | Açıklama |
---|---|---|
endIcon | IconImage | Eklenecek simge. |
Return
DecoratedText
: 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 yalnızca setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
veya setComposeAction(action, composedEmailType)
ayarlarından biri olabilir.
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
Ad | Tür | Açıklama |
---|---|---|
action | Action | Bu öğe tıklandığında yapılacak işlem. |
Return
DecoratedText
: Zincirleme için 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)
ayarlarından biri 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.
// ... 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
DecoratedText
: Zincirleme için bu nesne.
setOpenLink(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 setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
veya setComposeAction(action, composedEmailType)
ayarlarından biri olabilir.
Parametreler
Ad | Tür | Açıklama |
---|---|---|
openLink | OpenLink | Açılacak URL'yi açıklayan bir OpenLink nesnesi. |
Return
DecoratedText
: Zincirleme için bu nesne.
setStartIcon(startIcon)
İsteğe bağlı IconImage
öğesini metin içeriğinden önce gösterilecek şekilde ayarlar.
Parametreler
Ad | Tür | Açıklama |
---|---|---|
startIcon | IconImage | Gösterilecek simge. |
Return
DecoratedText
: Zincirleme için bu nesne.
setSwitchControl(switchToSet)
İçeriğin sağ tarafında gösterilen Switch
öğesini ayarlar. DecoratedText
yalnızca bir düğmeyi veya bir anahtarı destekleyebilir.
Parametreler
Ad | Tür | Açıklama |
---|---|---|
switchToSet | Switch | Eklenecek anahtar. |
Return
DecoratedText
: Zincirleme için bu nesne.
setText(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
DecoratedText
: Zincirleme için bu nesne.
setTopLabel(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
DecoratedText
: Zincirleme için bu nesne.
setWrapText(wrapText)
Değer metninin tek satırda mı yoksa birden fazla satırda mı gösterileceğini belirler.
Parametreler
Ad | Tür | Açıklama |
---|---|---|
wrapText | Boolean | true 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 bu nesne.