chrome.instanceID

תיאור

משתמשים ב-chrome.instanceID כדי לגשת לשירות Instance ID.

הרשאות

gcm

זמינות

‫Chrome 44 ואילך

Methods

deleteID()

Promise 
chrome.instanceID.deleteID(
  callback?: function,
): Promise<void>

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

פרמטרים

  • callback

    פונקציה אופציונלית

    הפרמטר callback נראה כך: 

    () => void

החזרות

  • Promise<void>

    ‫Chrome 96 ואילך

    ההבטחות נתמכות רק ב-Manifest V3 ובגרסאות מאוחרות יותר. בפלטפורמות אחרות צריך להשתמש בפונקציות Callback.

deleteToken()

Promise 
chrome.instanceID.deleteToken(
  deleteTokenParams: object,
  callback?: function,
): Promise<void>

מבטלת טוקן שניתן.

פרמטרים

  • deleteTokenParams

    אובייקט

    פרמטרים של deleteToken.

    • authorizedEntity

      מחרוזת

      ‫Chrome 46 ואילך

      הישות המורשית שמשמשת להשגת הטוקן.

    • היקף

      מחרוזת

      ‫Chrome 46 ואילך

      היקף ההרשאות שמשמש להשגת הטוקן.

  • callback

    פונקציה אופציונלית

    הפרמטר callback נראה כך: 

    () => void

החזרות

  • Promise<void>

    ‫Chrome 96 ואילך

    ההבטחות נתמכות רק ב-Manifest V3 ובגרסאות מאוחרות יותר. בפלטפורמות אחרות צריך להשתמש בפונקציות Callback.

getCreationTime()

Promise 
chrome.instanceID.getCreationTime(
  callback?: function,
): Promise<number>

הפונקציה מחזירה את השעה שבה נוצר InstanceID. זמן היצירה יוחזר על ידי callback.

פרמטרים

  • callback

    פונקציה אופציונלית

    הפרמטר callback נראה כך: 

    (creationTime: number) => void

    • creationTime

      number

      הזמן שבו נוצר מזהה המופע, באלפיות השנייה מאז תחילת התקופה של זמן מערכת.

החזרות

  • Promise<number>

    ‫Chrome 96 ואילך

    ההבטחות נתמכות רק ב-Manifest V3 ובגרסאות מאוחרות יותר. בפלטפורמות אחרות צריך להשתמש בפונקציות Callback.

getID()

Promise 
chrome.instanceID.getID(
  callback?: function,
): Promise<string>

מאחזר מזהה של מופע האפליקציה. מזהה המופע יוחזר על ידי callback. אותו מזהה יוחזר כל עוד זהות האפליקציה לא בוטלה או שתוקפה פג.

פרמטרים

  • callback

    פונקציה אופציונלית

    הפרמטר callback נראה כך: 

    (instanceID: string) => void

    • instanceID

      מחרוזת

      מזהה מופע שהוקצה למופע האפליקציה.

החזרות

  • Promise<string>

    ‫Chrome 96 ואילך

    ההבטחות נתמכות רק ב-Manifest V3 ובגרסאות מאוחרות יותר. בפלטפורמות אחרות צריך להשתמש בפונקציות Callback.

getToken()

Promise 
chrome.instanceID.getToken(
  getTokenParams: object,
  callback?: function,
): Promise<string>

החזרת טוקן שמאפשר לישות המורשית לגשת לשירות שמוגדר על ידי ההיקף.

פרמטרים

  • getTokenParams

    אובייקט

    פרמטרים של getToken.

    • authorizedEntity

      מחרוזת

      ‫Chrome 46 ואילך

      מזהה את הישות שמורשית לגשת למשאבים שמשויכים למזהה המופע הזה. יכול להיות שזה מזהה פרויקט מ-Google developer console.

    • options

      אובייקט אופציונלי

      ‫Chrome 46 ואילך הוצא משימוש מאז Chrome 89

      הוצאו משימוש ויתעלמו מהן.

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

    • היקף

      מחרוזת

      ‫Chrome 46 ואילך

      מזהה פעולות מורשות שהישות המורשית יכולה לבצע. לדוגמה, כדי לשלוח הודעות GCM, צריך להשתמש בהיקף GCM.

  • callback

    פונקציה אופציונלית

    הפרמטר callback נראה כך: 

    (token: string) => void

    • token

      מחרוזת

      טוקן שהוקצה על ידי השירות המבוקש.

החזרות

  • Promise<string>

    ‫Chrome 96 ואילך

    ההבטחות נתמכות רק ב-Manifest V3 ובגרסאות מאוחרות יותר. בפלטפורמות אחרות צריך להשתמש בפונקציות Callback.

אירועים

onTokenRefresh

chrome.instanceID.onTokenRefresh.addListener(
  callback: function,
)

האירוע מופעל כשצריך לרענן את כל הטוקנים שניתנו.

פרמטרים

  • callback

    פונקציה

    הפרמטר callback נראה כך: 

    () => void