İsteğe bağlı süslemelerle metin gösteren bir widget. Olası anahtarlar arasında bir simge, üst kısımda bir etiket ve aşağıda bir etiket yer alır. Metin içeriğini ve anahtarlardan birini ayarlamak için setText(text)
ve DecoratedText
, DecoratedText
, setTopLabel(text)
veya setBottomLabel(text)
değerlerinden birini kullanmanız gerekir. Bu sınıfın,
yerine geçmesi amaçlanmıştır.
KeyValue
Google Workspace Eklentileri 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 tıklandığında yetkilendirme akışının URL'sini açan bir 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 bilgisini ayarlar. |
setComposeAction(action, composedEmailType) | DecoratedText | Nesne tıklandığında taslak e-posta oluşturan bir işlem ayarlar. |
setEndIcon(endIcon) | DecoratedText | İçeriğin sağ tarafında görüntülenen 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 URL'yi sekmede açan bir işlem 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ğ tarafında görüntülenen 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örüntülenir. |
setWrapText(wrapText) | DecoratedText | Değer metninin tek bir satırda mı yoksa birden fazla satırda mı görüntüleneceğini ayarlar. |
Ayrıntılı belgeler
setAuthorizationAction(action)
Nesne tıklandığında yetkilendirme akışının URL'sini açan bir 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ü nesnesi yalnızca setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
veya setComposeAction(action, composedEmailType)
aralığından birine sahip olabilir.
// ... var 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 kullanılan 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 kullanılan bu nesne.
setButton(button)
Metnin sağ tarafında görüntülenen Button
bilgisini ayarlar. DecoratedText
, yalnızca bir düğmeyi veya bir anahtarı destekleyebilir.
Parametreler
Ad | Tür | Açıklama |
---|---|---|
button | Button | Eklenecek düğme. |
Return
DecoratedText
: Zincirleme için kullanılan bu nesne.
setComposeAction(action, composedEmailType)
Nesne tıklandığında taslak e-posta oluşturan 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, 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 tıklandığında gerçekleştirilecek 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 numaralandırma değeridir. |
Return
DecoratedText
: Zincirleme için kullanılan bu nesne.
setEndIcon(endIcon)
İçeriğin sağ tarafında görüntülenen isteğe bağlı IconImage
öğesini ayarlar. Bir 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 kullanılan bu nesne.
setOnClickAction(action)
Nesne tıklandığında yürütülecek bir işlem ayarlar. Bir kullanıcı arayüzü nesnesi yalnızca setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
veya setComposeAction(action, composedEmailType)
aralığından birine sahip 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
Ad | Tür | Açıklama |
---|---|---|
action | Action | Bu öğe tıklandığında yapılacak işlem. |
Return
DecoratedText
: Zincirleme için kullanılan bu nesne.
setOnClickOpenLinkAction(action)
Nesne tıklandığında URL'yi sekmede açan bir işlem ayarlar. URL'nin oluşturulması gerektiğinde veya OpenLink
nesnesini oluşturmaya ek olarak başka işlemler yapmanız 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)
aralığından 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
Ad | Tür | Açıklama |
---|---|---|
action | Action | Bu öğe tıklandığında yapılacak açık bağlantı işlemini belirten nesne. |
Return
DecoratedText
: Zincirleme için kullanılan bu nesne.
setOpenLink(openLink)
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)
gruplarından birine sahip olabilir.
Parametreler
Ad | Tür | Açıklama |
---|---|---|
openLink | OpenLink | Açılacak URL'yi açıklayan bir OpenLink nesnesi. |
Return
DecoratedText
: Zincirleme için kullanılan 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 kullanılan bu nesne.
setSwitchControl(switchToSet)
İçeriğin sağ tarafında görüntülenen 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 kullanılan 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 kullanılan 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 kullanılan bu nesne.
setWrapText(wrapText)
Değer metninin tek bir satırda mı yoksa birden fazla satırda mı görüntüleneceğini ayarlar.
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 kullanılan bu nesne.