Class KeyValue

KeyValue

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

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

Methods

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

תיעוד מפורט

addEventAction(eventAction)

מוסיף את פעולת האירוע שאפשר לבצע בווידג'ט.

פרמטרים

שםסוגתיאור
eventActionEventActionה-EventAction שרוצים להוסיף.

חזרה

‫Widget – האובייקט, לשרשור.

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 – האובייקט הזה, לשרשור.

setId(id)

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

פרמטרים

שםסוגתיאור
idStringהמזהה של הווידג'ט, עם מגבלה של 64 תווים ובפורמט [a-zA-Z0-9-]+.

חזרה

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

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 – האובייקט הזה, לשרשור.

setVisibility(visibility)

ההגדרה הזו קובעת את רמת החשיפה של הווידג'ט. ערך ברירת המחדל הוא `VISIBLE`.

פרמטרים

שםסוגתיאור
visibilityVisibilityהVisibility של הווידג'ט.

חזרה

‫Widget – האובייקט, לשרשור.

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