Class KeyValue

KeyValue

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

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

שיטות

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

תיעוד מפורט

setAuthorizationAction(action)

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

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

// ...

var 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). 

// ...

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

פרמטרים

שםתיאורהתיאור
actionActionהאובייקט שמציין את פעולת הכתיבה שצריך לבצע כשלוחצים על הרכיב הזה.
composedEmailTypeComposedEmailTypeערך enum שמציין אם הטיוטה שנוצרה היא טיוטה של תשובה או טיוטה של תשובה.

החזרות

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

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

פרמטרים

שםתיאורהתיאור
actionActionהפעולה שצריך לבצע כשלוחצים על הרכיב הזה.

החזרות

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

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

פרמטרים

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

החזרות

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

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

פרמטרים

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

החזרות

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

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