chrome.instanceID

תיאור

כדי לגשת לשירות של מזהה המכונה, משתמשים ב-chrome.instanceID.

הרשאות

gcm

זמינות

Chrome 44 ואילך

שיטות

deleteID()

הבטחה 
chrome.instanceID.deleteID(
  callback?: function,
)

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

פרמטרים

  • קריאה חוזרת (callback)

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

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

    () => void

החזרות

  • הבטחה<Empty>

    Chrome מגרסה 96 ואילך

    הבטחות נתמכות במניפסט מגרסה V3 ואילך, אבל ניתנות קריאות חוזרות (callback) בשביל תאימות לאחור. לא ניתן להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה הזו מצליחה לפתור את הבעיה באותו סוג שמועבר לקריאה החוזרת.

deleteToken()

הבטחה 
chrome.instanceID.deleteToken(
  deleteTokenParams: object,
  callback?: function,
)

ביטול של אסימון שהוענק.

פרמטרים

  • deleteTokenParams

    אובייקט

    הפרמטרים של deleteToken.

    • authorizedEntity

      מחרוזת

      Chrome 46 ואילך

      הישות המורשית שמשמשת לקבלת האסימון.

    • היקף

      מחרוזת

      Chrome 46 ואילך

      ההיקף שבו משתמשים לקבלת האסימון.

  • קריאה חוזרת (callback)

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

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

    () => void

החזרות

  • הבטחה<Empty>

    Chrome מגרסה 96 ואילך

    הבטחות נתמכות במניפסט מגרסה V3 ואילך, אבל ניתנות קריאות חוזרות (callback) בשביל תאימות לאחור. לא ניתן להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה הזו מצליחה לפתור את הבעיה באותו סוג שמועבר לקריאה החוזרת.

getCreationTime()

הבטחה 
chrome.instanceID.getCreationTime(
  callback?: function,
)

אחזור של השעה שבה נוצר ה-InstanceID. שעת היצירה תוחזר על ידי callback.

פרמטרים

  • קריאה חוזרת (callback)

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

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

    (creationTime: number) => void

    • creationTime

      number

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

החזרות

  • Promise&lt;number&gt;

    Chrome מגרסה 96 ואילך

    הבטחות נתמכות במניפסט מגרסה V3 ואילך, אבל ניתנות קריאות חוזרות (callback) בשביל תאימות לאחור. לא ניתן להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה הזו מצליחה לפתור את הבעיה באותו סוג שמועבר לקריאה החוזרת.

getID()

הבטחה 
chrome.instanceID.getID(
  callback?: function,
)

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

פרמטרים

  • קריאה חוזרת (callback)

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

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

    (instanceID: string) => void

    • instanceID

      מחרוזת

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

החזרות

  • Promise&lt;string&gt;

    Chrome מגרסה 96 ואילך

    הבטחות נתמכות במניפסט מגרסה V3 ואילך, אבל ניתנות קריאות חוזרות (callback) בשביל תאימות לאחור. לא ניתן להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה הזו מצליחה לפתור את הבעיה באותו סוג שמועבר לקריאה החוזרת.

getToken()

הבטחה 
chrome.instanceID.getToken(
  getTokenParams: object,
  callback?: function,
)

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

פרמטרים

  • getTokenParams

    אובייקט

    הפרמטרים של getToken.

    • authorizedEntity

      מחרוזת

      Chrome 46 ואילך

      העמודה הזו מציינת את הישות שמורשה לגשת למשאבים שמשויכים למזהה המופע הזה. אפשר להשתמש במזהה פרויקט מ-Google Developer Console.

    • אפשרויות

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

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

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

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

    • היקף

      מחרוזת

      Chrome 46 ואילך

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

  • קריאה חוזרת (callback)

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

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

    (token: string) => void

    • token

      מחרוזת

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

החזרות

  • Promise&lt;string&gt;

    Chrome מגרסה 96 ואילך

    הבטחות נתמכות במניפסט מגרסה V3 ואילך, אבל ניתנות קריאות חוזרות (callback) בשביל תאימות לאחור. לא ניתן להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה הזו מצליחה לפתור את הבעיה באותו סוג שמועבר לקריאה החוזרת.

אירועים

onTokenRefresh

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

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

פרמטרים

  • קריאה חוזרת (callback)

    פונקציה

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

    () => void