Kart üstbilgisi menüsüne eklenen tıklanabilir bir menü öğesi.
const action = CardService.newAction(); // Finish building the action... const cardAction = CardService.newCardAction().setText('Card action').setOnClickAction(action);
Yöntemler
Yöntem | Dönüş türü | Kısa açıklama |
---|---|---|
setAuthorizationAction(action) | CardAction | Nesne tıklandığında yetkilendirme akışına giden bir URL açan yetkilendirme işlemi ayarlar. |
setComposeAction(action, composedEmailType) | CardAction | Nesne tıklandığında bir e-posta taslağı oluşturan bir işlem ayarlar. |
setOnClickAction(action) | CardAction | Nesne tıklandığında yürütülecek bir işlem ayarlar. |
setOnClickOpenLinkAction(action) | CardAction | Nesne tıklandığında bir URL'yi sekmede açan bir işlem ayarlar. |
setOpenLink(openLink) | CardAction | Nesne tıklandığında açılacak bir URL ayarlar. |
setText(text) | CardAction | Bu işlemin menü metnini ayarlar. |
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
CardAction
: 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
CardAction
: 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
CardAction
: 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
CardAction
: 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
CardAction
: Zincirleme için bu nesne.
setText(text)
Bu işlemin menü metnini ayarlar.
Parametreler
Ad | Tür | Açıklama |
---|---|---|
text | String | Menü öğesi metni. |
Return
CardAction
: Zincirleme için bu nesne.