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

פרמטרים

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

חזרה

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


setComposeAction(action, composedEmailType)

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

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

// ...

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

פרמטרים

שםסוגתיאור
actionActionהאובייקט שמציין את פעולת הכתיבה שתתבצע כשמקישים על הרכיב הזה.
composedEmailTypeComposedEmailTypeערך 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();
}

פרמטרים

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

חזרה

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

פרמטרים

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

חזרה

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


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

פרמטרים

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

חזרה

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

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

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

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

פרמטרים

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

חזרה

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


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

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

פרמטרים

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

חזרה

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


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

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

פרמטרים

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

חזרה

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


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

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

פרמטרים

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

חזרה

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


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

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

פרמטרים

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

חזרה

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


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

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

פרמטרים

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

חזרה

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


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

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

פרמטרים

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

חזרה

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


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

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

פרמטרים

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

חזרה

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


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

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

פרמטרים

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

חזרה

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