TextButton
עם תווית טקסט. ניתן להגדיר את צבע הרקע ולהשבית את הלחצן במקרה הצורך.
אפשר להשתמש בתוספים ל-Google Workspace ובאפליקציות של Google Chat.
var textButton = CardService.newTextButton() .setText("Open Link") .setOpenLink(CardService.newOpenLink() .setUrl("https://www.google.com"));
שיטות
שיטה | סוג הערך שמוחזר | תיאור קצר |
---|---|---|
setAltText(altText) | TextButton | הגדרת הטקסט החלופי של הלחצן לנגישות. |
setAuthorizationAction(action) | TextButton | מגדירה פעולת הרשאה שפותחת כתובת URL לזרימת ההרשאה כשלוחצים על האובייקט. |
setBackgroundColor(backgroundColor) | TextButton | מגדיר את צבע הרקע של הלחצן TextButtonStyle.FILLED . |
setComposeAction(action, composedEmailType) | TextButton | מגדירה פעולה שכותבת טיוטת אימייל כשלוחצים על האובייקט. |
setDisabled(disabled) | TextButton | הגדרה זו קובעת אם הלחצן מושבת. |
setOnClickAction(action) | TextButton | מגדירה פעולה שמופעלת כשלוחצים על האובייקט. |
setOnClickOpenLinkAction(action) | TextButton | מגדירה פעולה שפותחת כתובת URL בכרטיסייה כשלוחצים על האובייקט. |
setOpenLink(openLink) | TextButton | מגדיר כתובת URL שתיפתח בעקבות לחיצה על האובייקט. |
setText(text) | TextButton | מגדיר את הטקסט שיוצג בלחצן. |
setTextButtonStyle(textButtonStyle) | TextButton | הגדרת סגנון הלחצן. |
תיעוד מפורט
setAltText(altText)
הגדרת הטקסט החלופי של הלחצן לנגישות. אם המדיניות לא מוגדרת, ברירת המחדל היא הטקסט שמוצג על הלחצן.
פרמטרים
שם | סוג | תיאור |
---|---|---|
altText | String | הטקסט החלופי שצריך להקצות ללחצן הזה. |
החזרות
TextButton
– האובייקט הזה, לשרשור.
setAuthorizationAction(action)
מגדירה פעולת הרשאה שפותחת כתובת URL לזרימת ההרשאה כשלוחצים על האובייקט. פעולה זו פותחת את כתובת האתר בחלון חדש. כשהמשתמש מסיים את תהליך ההרשאה וחוזר לאפליקציה, התוסף נטען מחדש.
באובייקט של ממשק משתמש אפשר להגדיר רק אחד מהערכים setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
או setComposeAction(action, composedEmailType)
.
// ... var action = CardService.newAuthorizationAction().setAuthorizationUrl('url'); CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);
פרמטרים
שם | סוג | תיאור |
---|---|---|
action | AuthorizationAction | האובייקט שמציין את פעולת ההרשאה שיש לבצע כשלוחצים על הרכיב הזה. |
החזרות
TextButton
– האובייקט הזה, לשרשור.
setBackgroundColor(backgroundColor)
מגדיר את צבע הרקע של הלחצן TextButtonStyle.FILLED
. אם הלחצן TextButtonStyle.FILLED
לא מוגדר, הלחצן משתמש בצבע המשני שהוגדר במניפסט של התוסף.
השיטה הזו לא מאפשרת הפעלה של TextButtonStyle.OUTLINED
לחצנים.
פרמטרים
שם | סוג | תיאור |
---|---|---|
backgroundColor | String | הצבע בפורמט #rgb. |
החזרות
TextButton
– האובייקט הזה, לשרשור.
setComposeAction(action, composedEmailType)
מגדירה פעולה שכותבת טיוטת אימייל כשלוחצים על האובייקט. אפשר להגדיר לאובייקט בממשק משתמש רק אחד מהערכים setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
או setComposeAction(action, composedEmailType)
.
הפרמטר Action
חייב לציין פונקציית קריאה חוזרת שמחזירה אובייקט ComposeActionResponse
שהוגדר באמצעות ComposeActionResponseBuilder.setGmailDraft(draft)
.
// ... 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(); }
פרמטרים
שם | סוג | תיאור |
---|---|---|
action | Action | האובייקט שמציין את פעולת הכתיבה שצריך לבצע כשלוחצים על הרכיב הזה. |
composedEmailType | ComposedEmailType | ערך 'טיפוסים בני מנייה (enum)' שמציין אם הטיוטה המורכבת היא טיוטה עצמאית או טיוטה של תשובה. |
החזרות
TextButton
– האובייקט הזה, לשרשור.
setDisabled(disabled)
הגדרה זו קובעת אם הלחצן מושבת. לחצן מושבת מופיע באפור ולא ניתן ללחוץ עליו.
פרמטרים
שם | סוג | תיאור |
---|---|---|
disabled | Boolean | מצב מושבת. |
החזרות
TextButton
– האובייקט הזה, לשרשור.
setOnClickAction(action)
מגדירה פעולה שמופעלת כשלוחצים על האובייקט. אובייקט של ממשק משתמש יכול להגדיר רק אחד מהערכים setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
או setComposeAction(action, composedEmailType)
.
הפרמטר Action
חייב לציין פונקציית קריאה חוזרת שמחזירה אובייקט ActionResponse
.
// ... 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(); }
פרמטרים
שם | סוג | תיאור |
---|---|---|
action | Action | הפעולה שצריך לבצע כשמשתמש לוחץ על הרכיב הזה. |
החזרות
TextButton
– האובייקט הזה, לשרשור.
setOnClickOpenLinkAction(action)
מגדירה פעולה שפותחת כתובת URL בכרטיסייה כשלוחצים על האובייקט. תוכלו להשתמש בפונקציה הזו כשצריך ליצור את כתובת ה-URL או לבצע פעולות אחרות בתוסף ליצירת האובייקט OpenLink
. באובייקט של ממשק משתמש אפשר להגדיר רק אחד מהערכים setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
או setComposeAction(action, composedEmailType)
.
הפרמטר Action
חייב לציין פונקציית קריאה חוזרת שמחזירה אובייקט ActionResponse
שהוגדר באמצעות ActionResponseBuilder.setOpenLink(openLink)
.
// ... 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(); }
פרמטרים
שם | סוג | תיאור |
---|---|---|
action | Action | האובייקט שמציין את פעולת הקישור הפתוח שיש לבצע כשלוחצים על האלמנט הזה. |
החזרות
TextButton
– האובייקט הזה, לשרשור.
setOpenLink(openLink)
מגדיר כתובת URL שתיפתח בעקבות לחיצה על האובייקט. השתמשו בפונקציה הזו כאשר כתובת ה-URL כבר ידועה וצריך לפתוח אותה רק. אובייקט של ממשק משתמש יכול להגדיר רק אחד מהערכים setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
או setComposeAction(action, composedEmailType)
.
פרמטרים
שם | סוג | תיאור |
---|---|---|
openLink | OpenLink | אובייקט OpenLink שמתאר את כתובת ה-URL לפתיחה. |
החזרות
TextButton
– האובייקט הזה, לשרשור.
setText(text)
מגדיר את הטקסט שיוצג בלחצן.
פרמטרים
שם | סוג | תיאור |
---|---|---|
text | String | הטקסט שמופיע על הלחצן. |
החזרות
TextButton
– האובייקט הזה, לשרשור.
setTextButtonStyle(textButtonStyle)
הגדרת סגנון הלחצן. אם המדיניות לא מוגדרת, ברירת המחדל היא הלחצן TextButtonStyle.OUTLINED
.
פרמטרים
שם | סוג | תיאור |
---|---|---|
textButtonStyle | TextButtonStyle | סגנון הלחצן. |
החזרות
TextButton
– האובייקט הזה, לשרשור.