Class Chip

צ'יפ

Chip עם סמל ותווית טקסט. אפשר להשבית את הצ'יפ לפי הצורך.

התכונה הזו זמינה רק באפליקציות של Google Chat. לא זמין לתוספים של Google Workspace.

const chip = CardService.newChip()
                 .setLabel('Open Link')
                 .setOpenLink(CardService.newOpenLink().setUrl(
                     'https://www.google.com'));

שיטות

שיטה	סוג הערך המוחזר	תיאור קצר
setAltText(altText)	Chip	הגדרת הטקסט החלופי של הצ'יפ לצורכי נגישות.
setAuthorizationAction(action)	Chip	הגדרת פעולת הרשאה שפותחת כתובת URL לתהליך ההרשאה כשמקישים על האובייקט.
setComposeAction(action, composedEmailType)	Chip	הגדרת פעולה שמכינה טיוטת אימייל כשלוחצים על האובייקט.
setDisabled(disabled)	Chip	הגדרה של מצב השבב: מופעל או מושבת.
setIcon(icon)	Chip	הגדרת הסמל שישמש כצ'יפ.
setLabel(label)	Chip	מגדיר את שם הצ'יפ.
setOnClickAction(action)	Chip	מגדיר פעולה שמופעלת כשמשתמש לוחץ על האובייקט.
setOnClickOpenLinkAction(action)	Chip	מגדירה פעולה שפותחת כתובת URL בכרטיסייה כשלוחצים על האובייקט.
setOpenLink(openLink)	Chip	הגדרת כתובת URL שתיפתח כשלוחצים על האובייקט.

מסמכים מפורטים

setAltText(altText)

הגדרת הטקסט החלופי של הצ'יפ לצורכי נגישות. אם לא מגדירים את השדה, ברירת המחדל היא הטקסט שמוצג על הצ'יפ.

פרמטרים

שם	סוג	תיאור
altText	String	הטקסט החלופי שצריך להקצות לצ'יפ הזה.

חזרה

Chip – האובייקט הזה, לצורך קישור.

---

setAuthorizationAction(action)

הגדרת פעולת הרשאה שפותחת כתובת URL לתהליך ההרשאה כשמקישים על האובייקט. כתובת ה-URL תיפתח בחלון חדש. כשהמשתמש מסיים את תהליך ההרשאה וחוזר לאפליקציה, התוסף נטען מחדש.

אפשר להגדיר לאובייקט בממשק המשתמש רק את אחד מהערכים setOpenLink(openLink),‏ setOnClickAction(action),‏ setOnClickOpenLinkAction(action),‏ setAuthorizationAction(action) או setComposeAction(action, composedEmailType).

// ...

const action = CardService.newAuthorizationAction().setAuthorizationUrl('url');
CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);

פרמטרים

שם	סוג	תיאור
action	AuthorizationAction	האובייקט שמציין את פעולת ההרשאה לבצע כשלוחצים על הרכיב הזה.

חזרה

Chip – האובייקט הזה, לצורך קישור.

---

setComposeAction(action, composedEmailType)

מגדיר פעולה שכותבת טיוטת אימייל כשמשתמש לוחץ על האובייקט. אובייקט בממשק המשתמש יכול לכלול רק אחת מהאפשרויות הבאות: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) או setComposeAction(action, composedEmailType).

הפרמטר Action חייב לציין פונקציית קריאה חוזרת שמחזירה אובייקט ComposeActionResponse שמוגדר באמצעות ComposeActionResponseBuilder.setGmailDraft(draft).

הערה: השיטה הזו לא מגדירה פעולת כתיבה שמשמשת להרחבת ממשק המשתמש של הכתיבה. במקום זאת, השיטה הזו מחברת את רכיב ממשק המשתמש הזה ל-Action שכותב טיוטות של הודעות ב-Apps Script, שנפתחות ב-Gmail כשהפעולה מסתיימת.

// ...

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();
}

פרמטרים

שם	סוג	תיאור
action	Action	האובייקט שמציין את פעולת הכתיבה שתתבצע כשלוחצים על האלמנט הזה.
composedEmailType	ComposedEmailType	ערך enum שמציין אם הטיוטה שהורכבה היא עצמאית או טיוטה של תשובה.

חזרה

Chip – האובייקט הזה, לצורך קישור.

---

setDisabled(disabled)

המדיניות קובעת אם הצ'יפ מושבת. צ'יפ מושבת מופיע באפור ואי אפשר ללחוץ עליו.

const chip = CardService.newChip().setLabel('bug Report').setDisabled(true);

פרמטרים

שם	סוג	תיאור
disabled	Boolean	מצב מושבת.

חזרה

Chip – האובייקט הזה, לשרשור.

---

setIcon(icon)

הגדרת הסמל שישמש כצ'יפ.

const chip = CardService.newChip().setIcon(
    CardService.newIconImage().setMaterialIcon(
        CardService.newMaterialIcon().setName('bug_report'),
        ),
);

פרמטרים

שם	סוג	תיאור
icon	IconImage	אחד מהערכים של IconImage שהוגדרו מראש.

חזרה

Chip – האובייקט הזה, לצורך קישור.

---

setLabel(label)

הגדרת השם של הצ'יפ. חובה.

const chip = CardService.newChip().setLabel('bug Report');

פרמטרים

שם	סוג	תיאור
label	String	הטקסט שיוצג.

חזרה

Chip – האובייקט הזה, לצורך קישור.

---

setOnClickAction(action)

מגדיר פעולה שמופעלת כשמשתמש לוחץ על האובייקט. אפשר להגדיר לאובייקט בממשק המשתמש רק את אחד מהערכים setOpenLink(openLink),‏ setOnClickAction(action),‏ setOnClickOpenLinkAction(action),‏ setAuthorizationAction(action) או setComposeAction(action, composedEmailType).

הפרמטר Action חייב לציין פונקציית קריאה חוזרת שמחזירה אובייקט ActionResponse.

// ...

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();
}

פרמטרים

שם	סוג	תיאור
action	Action	הפעולה שתתבצע כאשר לוחצים על האלמנט הזה.

חזרה

Chip – האובייקט הזה, לצורך קישור.

---

setOnClickOpenLinkAction(action)

מגדירה פעולה שפותחת כתובת URL בכרטיסייה כשלוחצים על האובייקט. משתמשים בפונקציה הזו כשצריך ליצור את כתובת ה-URL או כשצריך לבצע פעולות אחרות בנוסף ליצירת האובייקט OpenLink. אובייקט של ממשק משתמש יכול לכלול רק אחת מהאפשרויות הבאות: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) או setComposeAction(action, composedEmailType).

הפרמטר Action חייב לציין פונקציית קריאה חוזרת שמחזירה אובייקט ActionResponse שמוגדר באמצעות ActionResponseBuilder.setOpenLink(openLink).

// ...

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();
}

פרמטרים

שם	סוג	תיאור
action	Action	האובייקט שמציין את פעולת הקישור הפתוחה שצריך לבצע כשלוחצים על הרכיב הזה.

חזרה

Chip – האובייקט הזה, לצורך קישור.

---

setOpenLink(openLink)

הגדרת כתובת URL שתיפתח כשלוחצים על האובייקט. משתמשים בפונקציה הזו כשכתובת ה-URL כבר ידועה וצריך לפתוח רק אותה. אובייקט בממשק המשתמש יכול לכלול רק אחד מהערכים setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) או setComposeAction(action, composedEmailType).

פרמטרים

שם	סוג	תיאור
openLink	OpenLink	אובייקט OpenLink שמתאר את כתובת ה-URL שצריך לפתוח.

חזרה

Chip – האובייקט הזה, לצורך קישור.