İsteğe bağlı süslemelerle metin görüntüleyen bir widget. Olası anahtarlar bir simge ve etiket içerir
üst ve altında bir etiket. Metin içeriğinin ve anahtarlardan birinin setText(text)
ile DecoratedText
, DecoratedText
, setTopLabel(text)
veya setBottomLabel(text)
kullanılarak ayarlanması gerekir. Bu sınıfın,
sınıfının yerini alması amaçlanmıştır.
KeyValue
Google Workspace eklentilerinde ve Google Chat uygulamalarında kullanılabilir.
var decoratedText = CardService.newDecoratedText() .setText("Text") .setTopLabel("TopLabel"); var 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 şu anda yetkilendirme akışı için bir URL açan yetkilendirme işlemi ayarlar: tıklandı. |
setBottomLabel(text) | DecoratedText | Anahtar olarak kullanılacak etiket metnini ayarlar ve metin içeriğinin altında gösterilir. |
setButton(button) | DecoratedText | Metnin sağında görüntülenen Button değerini ayarlar. |
setComposeAction(action, composedEmailType) | DecoratedText | Nesne tıklandığında e-posta taslağı oluşturan bir işlem ayarlar. |
setEndIcon(endIcon) | DecoratedText | İçeriğin sağında görüntülenen isteğe bağlı IconImage değerini ayarlar. |
setOnClickAction(action) | DecoratedText | Nesne tıklandığında yürütülecek bir işlemi ayarlar. |
setOnClickOpenLinkAction(action) | DecoratedText | Nesne tıklandığında URL'yi bir sekmede açan işlemi ayarlar. |
setOpenLink(openLink) | DecoratedText | Nesne tıklandığında açılacak bir URL'yi ayarlar. |
setStartIcon(startIcon) | DecoratedText | Metin içeriğinden önce görüntülenecek isteğe bağlı IconImage değerini ayarlar. |
setSwitchControl(switchToSet) | DecoratedText | İçeriğin sağında gösterilen Switch değerini 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örüntülenir. |
setWrapText(wrapText) | DecoratedText | Değer metninin tek bir satırda mı yoksa birden çok satırda mı gösterileceğini belirler. |
Ayrıntılı belgeler
setAuthorizationAction(action)
Nesne şu anda yetkilendirme akışı için bir URL açan yetkilendirme işlemi ayarlar: tıklandı. 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 setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
veya setComposeAction(action, composedEmailType)
ayarlanmış olabilir.
// ... var action = CardService.newAuthorizationAction().setAuthorizationUrl('url'); CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);
Parametreler
Ad | Tür | Açıklama |
---|---|---|
action | AuthorizationAction | Bu öğe olduğunda yapılacak yetkilendirme işlemini belirten nesne tıklandı. |
Return
DecoratedText
: Zincirleme için bu nesne.
setBottomLabel(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
DecoratedText
: Zincirleme için bu nesne.
setButton(button)
Metnin sağında görüntülenen Button
değerini ayarlar. DecoratedText
,
yalnızca bir düğme veya bir anahtar desteklenir.
Parametreler
Ad | Tür | Açıklama |
---|---|---|
button | Button | Eklenecek düğme. |
Return
DecoratedText
: Zincirleme için bu nesne.
setComposeAction(action, composedEmailType)
Nesne tıklandığında e-posta taslağı oluşturan bir işlem ayarlar. Kullanıcı arayüzü nesnesi yalnızca
biri setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
,
setAuthorizationAction(action)
veya setComposeAction(action, composedEmailType)
set.
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
Ad | Tür | Açıklama |
---|---|---|
action | Action | Bu öğe olduğunda yapılacak oluşturma işlemini belirten nesne tıklandı. |
composedEmailType | ComposedEmailType | Oluşturulan taslağın veya yanıt taslağı oluşturabilirsiniz. |
Return
DecoratedText
: Zincirleme için bu nesne.
setEndIcon(endIcon)
İçeriğin sağında görüntülenen isteğe bağlı IconImage
değerini ayarlar. DecoratedText
yalnızca bir düğmeyi, 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şlemi ayarlar. Kullanıcı arayüzü nesnesi
setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
veya setComposeAction(action, composedEmailType)
set.
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
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 URL'yi bir sekmede açan işlemi ayarlar. Bu işlevi
URL'nin oluşturulması veya OpenLink
nesnesini oluşturmak için ek olarak başka işlemler yapmanız gerektiğinde gereklidir. Bir kullanıcı arayüzü nesnesinde yalnızca setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
veya
setComposeAction(action, composedEmailType)
set.
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
Ad | Tür | Açıklama |
---|---|---|
action | Action | Bu öğe olduğunda yapılacak açık bağlantı işlemini belirten nesne tıklandı. |
Return
DecoratedText
: Zincirleme için bu nesne.
setOpenLink(openLink)
Nesne tıklandığında açılacak bir URL'yi ayarlar. URL zaten hazır olduğunda bu işlevi kullanın
açılması gerekir. Bir kullanıcı arayüzü nesnesinde yalnızca setOpenLink(openLink)
,
setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
,
veya setComposeAction(action, composedEmailType)
set.
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)
Metin içeriğinden önce görüntülenecek isteğe bağlı IconImage
değerini ayarlar.
Parametreler
Ad | Tür | Açıklama |
---|---|---|
startIcon | IconImage | Gösterilecek simge. |
Return
DecoratedText
: Zincirleme için bu nesne.
setSwitchControl(switchToSet)
İçeriğin sağında gösterilen Switch
değerini 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 için 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örüntülenir.
Parametreler
Ad | Tür | Açıklama |
---|---|---|
text | String | Etiket metni. |
Return
DecoratedText
: Zincirleme için bu nesne.
setWrapText(wrapText)
Değer metninin tek bir satırda mı yoksa birden çok satırda mı gösterileceğini belirler.
Parametreler
Ad | Tür | Açıklama |
---|---|---|
wrapText | Boolean | true ise metin kaydırılır ve birden çok satırda gösterilir. Aksi halde
metin kısaltılır. |
Return
DecoratedText
: Zincirleme için bu nesne.