Class KeyValue

KeyValue

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

הכיתה הזו הוצאה משימוש. במקום זאת, צריך להשתמש ב-DecoratedText.

Methods

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

שיטות שהוצאו משימוש

שיטה	סוג הערך המוחזר	תיאור קצר
setBottomLabel(text)	KeyValue	הגדרת טקסט התווית שישמש כמפתח.
setButton(button)	KeyValue	הגדרת Button שמוצגת משמאל להקשר.
setContent(text)	KeyValue	הגדרת הטקסט שישמש כערך.
setIcon(icon)	KeyValue	הגדרת הסמל שישמש כמפתח.
setIconAltText(altText)	KeyValue	הגדרת טקסט חלופי לסמל.
setIconUrl(url)	KeyValue	הגדרת כתובת ה-URL של הסמל שישמש כמפתח.
setMultiline(multiline)	KeyValue	מגדיר אם טקסט הערך יוצג בשורה אחת או בכמה שורות.
setSwitch(switchToSet)	KeyValue	הגדרת Switch שמוצגת בצד שמאל של התוכן.
setTopLabel(text)	KeyValue	הגדרת טקסט התווית שישמש כמפתח.

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

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	האובייקט שמציין את פעולת ההרשאה שתתבצע כשלוחצים על האלמנט הזה.

חזרה

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

---

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(e) {
  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 שמציין אם טיוטת ההודעה שנוצרה היא טיוטה עצמאית או טיוטת תשובה.

חזרה

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

---

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	הפעולה שתתבצע כשלוחצים על האלמנט הזה.

חזרה

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

---

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	האובייקט שמציין את הפעולה של פתיח הקישור שתתבצע כשמקישים על הרכיב הזה.

חזרה

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

---

setOpenLink(openLink)

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

פרמטרים

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

חזרה

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

שיטות שהוצאו משימוש

setBottomLabel(text)

הוצא משימוש. הפונקציה הזו הוצאה משימוש ואין להשתמש בה בסקריפטים חדשים.

הגדרת טקסט התווית שישמש כמפתח. מוצג מתחת לתוכן הטקסט.

פרמטרים

שם	סוג	תיאור
text	String	טקסט התווית. הערה: אין תמיכה בעיצוב HTML בסיסי.

חזרה

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

---

setButton(button)

הוצא משימוש. הפונקציה הזו הוצאה משימוש ואין להשתמש בה בסקריפטים חדשים.

הגדרת Button שמוצגת משמאל להקשר. KeyValue יכול לתמוך רק בלחצן אחד, במתג אחד או בסמל אחד.

פרמטרים

שם	סוג	תיאור
button	Button	הלחצן להוספה.

חזרה

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

---

setContent(text)

הוצא משימוש. הפונקציה הזו הוצאה משימוש ואין להשתמש בה בסקריפטים חדשים.

הגדרת הטקסט שישמש כערך. תמיכה בפורמט HTML בסיסי. חובה.

פרמטרים

שם	סוג	תיאור
text	String	תוכן הטקסט של הווידג'ט הזה.

חזרה

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

---

setIcon(icon)

הוצא משימוש. הפונקציה הזו הוצאה משימוש ואין להשתמש בה בסקריפטים חדשים.

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

פרמטרים

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

חזרה

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

---

setIconAltText(altText)

הוצא משימוש. הפונקציה הזו הוצאה משימוש ואין להשתמש בה בסקריפטים חדשים.

הגדרת טקסט חלופי לסמל.

פרמטרים

שם	סוג	תיאור
altText	String	הטקסט החלופי לסמל.

חזרה

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

---

setIconUrl(url)

הוצא משימוש. הפונקציה הזו הוצאה משימוש ואין להשתמש בה בסקריפטים חדשים.

הגדרת כתובת ה-URL של הסמל שישמש כמפתח.

פרמטרים

שם	סוג	תיאור
url	String	כתובת ה-URL של תמונה מתארחת שתשמש כסמל.

חזרה

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

---

setMultiline(multiline)

הוצא משימוש. הפונקציה הזו הוצאה משימוש ואין להשתמש בה בסקריפטים חדשים.

מגדיר אם טקסט הערך יוצג בשורה אחת או בכמה שורות.

פרמטרים

שם	סוג	תיאור
multiline	Boolean	ההגדרה של מספר שורות.

חזרה

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

---

setSwitch(switchToSet)

הוצא משימוש. הפונקציה הזו הוצאה משימוש ואין להשתמש בה בסקריפטים חדשים.

הגדרת Switch שמוצגת בצד שמאל של התוכן. KeyValue יכול לתמוך רק בלחצן אחד, במתג אחד או בסמל אחד.

פרמטרים

שם	סוג	תיאור
switchToSet	Switch	המתג להוספה.

חזרה

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

---

setTopLabel(text)

הוצא משימוש. הפונקציה הזו הוצאה משימוש ואין להשתמש בה בסקריפטים חדשים.

הגדרת טקסט התווית שישמש כמפתח. מוצג מעל תוכן הטקסט.

פרמטרים

שם	סוג	תיאור
text	String	טקסט התווית. הערה: אין תמיכה בעיצוב HTML בסיסי.

חזרה

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