Simge ve metin etiketi içeren bir Chip
. Gerektiğinde çipi devre dışı bırakabilirsiniz.
Yalnızca Google Chat uygulamalarında kullanılabilir. Google Workspace eklentileri için kullanılamaz.
const chip = CardService.newChip() .setLabel('Open Link') .setOpenLink(CardService.newOpenLink().setUrl( 'https://www.google.com'));
Yöntemler
Yöntem | Dönüş türü | Kısa açıklama |
---|---|---|
setAltText(altText) | Chip | Erişilebilirlik için çipin alternatif metnini ayarlar. |
setAuthorizationAction(action) | Chip | Nesne tıklandığında yetkilendirme akışına giden bir URL açan yetkilendirme işlemi ayarlar. |
setComposeAction(action, composedEmailType) | Chip | Nesne tıklandığında bir e-posta taslağı oluşturan bir işlem ayarlar. |
setDisabled(disabled) | Chip | Çipin devre dışı olup olmadığını belirler. |
setIcon(icon) | Chip | Çip olarak kullanılacak simgeyi ayarlar. |
setLabel(label) | Chip | Çipin başlığını ayarlar. |
setOnClickAction(action) | Chip | Nesne tıklandığında yürütülecek bir işlemi ayarlar. |
setOnClickOpenLinkAction(action) | Chip | Nesne tıklandığında URL'yi bir sekmede açan işlemi ayarlar. |
setOpenLink(openLink) | Chip | Nesne tıklandığında açılacak bir URL ayarlar. |
Ayrıntılı dokümanlar
setAltText(altText)
Erişilebilirlik için çipin alternatif metnini ayarlar. Politika ayarlanmadan bırakılırsa varsayılan olarak çipte gösterilen metin kullanılır.
Parametreler
Ad | Tür | Açıklama |
---|---|---|
altText | String | Bu çipe atanacak alternatif metin. |
Return
Chip
: Zincirleme için bu nesne.
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 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
Chip
: 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() { 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
Chip
: Zincirleme için bu nesne.
setDisabled(disabled)
Çipin devre dışı bırakılıp bırakılmayacağını belirler. Devre dışı bırakılan bir çip devre dışıdır ve tıklanamaz.
const chip = CardService.newChip().setLabel('bug Report').setDisabled(true);
Parametreler
Ad | Tür | Açıklama |
---|---|---|
disabled | Boolean | Devre dışı durumu. |
Return
Chip
: Zincirleme için bu nesne.
setIcon(icon)
Çip olarak kullanılacak simgeyi ayarlar.
const chip = CardService.newChip().setIcon( CardService.newIconImage().setMaterialIcon( CardService.newMaterialIcon().setName('bug_report'), ), );
Parametreler
Ad | Tür | Açıklama |
---|---|---|
icon | IconImage | Önceden tanımlanmış IconImage değerlerinden biri. |
Return
Chip
: Zincirleme için bu nesne.
setLabel(label)
Çipin başlığını ayarlar. Zorunlu.
const chip = CardService.newChip().setLabel('bug Report');
Parametreler
Ad | Tür | Açıklama |
---|---|---|
label | String | Gösterilecek metin. |
Return
Chip
: 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)
ayarlanmış 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
Chip
: Zincirleme için bu nesne.
setOnClickOpenLinkAction(action)
Nesne tıklandığında URL'yi bir sekmede açan işlemi 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)
ayarlanmış 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
Chip
: Zincirleme için bu nesne.
setOpenLink(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 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
Chip
: Zincirleme için bu nesne.