תיאור
כדי לגשת לשירות מזהה המכונה, משתמשים ב-chrome.instanceID
.
הרשאות
gcm
זמינות
שיטות
deleteID()
chrome.instanceID.deleteID(
callback?: function,
)
איפוס מזהה המופע של האפליקציה וביטול כל האסימונים המשויכים אליו.
פרמטרים
-
קריאה חוזרת (callback)
פונקציה אופציונלי
הפרמטר
callback
נראה כך:() => void
החזרות
-
Promise<void>
Chrome 96 ומעלהיש תמיכה בהבטחות במניפסט מגרסה V3 ואילך, אבל אפשר לבצע קריאה חוזרת (callback) לצורך תאימות לאחור. אי אפשר להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה מסתיימת עם אותו הסוג שמועבר לקריאה החוזרת.
deleteToken()
chrome.instanceID.deleteToken(
deleteTokenParams: object,
callback?: function,
)
ביטול אסימון שהוענק.
פרמטרים
-
deleteTokenParams
אובייקט
פרמטרים ל-DeleteToken.
-
authorizedEntity
מחרוזת
Chrome 46 ואילךהישות המוסמכת שמשמשת לקבלת האסימון.
-
היקף
מחרוזת
Chrome 46 ואילךההיקף שבו נעשה שימוש כדי לקבל את האסימון.
-
-
קריאה חוזרת (callback)
פונקציה אופציונלי
הפרמטר
callback
נראה כך:() => void
החזרות
-
Promise<void>
Chrome 96 ומעלהיש תמיכה בהבטחות במניפסט מגרסה V3 ואילך, אבל אפשר לבצע קריאה חוזרת (callback) לצורך תאימות לאחור. אי אפשר להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה מסתיימת עם אותו הסוג שמועבר לקריאה החוזרת.
getCreationTime()
chrome.instanceID.getCreationTime(
callback?: function,
)
אחזור של השעה שבה נוצר מזהה ה-InstanceID. שעת היצירה תוחזר על ידי callback
.
פרמטרים
-
קריאה חוזרת (callback)
פונקציה אופציונלי
הפרמטר
callback
נראה כך:(creationTime: number) => void
-
creationTime
מספר
הזמן שבו מזהה המכונה נוצר, מיוצג באלפיות השנייה מאז תחילת התקופה של המערכת.
-
החזרות
-
הבטחה<number>
Chrome 96 ומעלהיש תמיכה בהבטחות במניפסט מגרסה V3 ואילך, אבל אפשר לבצע קריאה חוזרת (callback) לצורך תאימות לאחור. אי אפשר להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה מסתיימת עם אותו הסוג שמועבר לקריאה החוזרת.
getID()
chrome.instanceID.getID(
callback?: function,
)
מאחזר מזהה עבור מופע האפליקציה. מזהה המכונה יוחזר על ידי callback
. אותו מזהה יוחזר כל עוד זהות האפליקציה לא בוטלה או שפג תוקפה.
פרמטרים
-
קריאה חוזרת (callback)
פונקציה אופציונלי
הפרמטר
callback
נראה כך:(instanceID: string) => void
-
instanceID
מחרוזת
מזהה מופע שהוקצה למופע של האפליקציה.
-
החזרות
-
הבטחה<string>
Chrome 96 ומעלהיש תמיכה בהבטחות במניפסט מגרסה V3 ואילך, אבל אפשר לבצע קריאה חוזרת (callback) לצורך תאימות לאחור. אי אפשר להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה מסתיימת עם אותו הסוג שמועבר לקריאה החוזרת.
getToken()
chrome.instanceID.getToken(
getTokenParams: object,
callback?: function,
)
מחזיר אסימון שמאפשר לישות המוסמכת לגשת לשירות שמוגדר לפי היקף.
פרמטרים
-
getTokenParams
אובייקט
פרמטרים של getToken.
-
authorizedEntity
מחרוזת
Chrome 46 ואילךמשמש לזיהוי הישות שמוסמכת לגשת למשאבים שמשויכים למזהה המכונה הזה. הוא יכול להיות מזהה פרויקט ממסוף המפתחים של Google.
-
אפשרויות
אובייקט אופציונלי
Chrome 46 ואילך הוצא משימוש מאז Chrome 89האפשרויות הוצאו משימוש והמערכת תתעלם מהן.
מאפשר לכלול מספר קטן של צמדי מפתח/ערך של מחרוזת שישויכו לאסימון, ושניתן להשתמש בהם בעיבוד הבקשה.
-
היקף
מחרוזת
Chrome 46 ואילךמזהה פעולות מורשות שהישות המוסמכת יכולה לבצע. לדוגמה, כדי לשלוח הודעות GCM, צריך להשתמש בהיקף
GCM
.
-
-
קריאה חוזרת (callback)
פונקציה אופציונלי
הפרמטר
callback
נראה כך:(token: string) => void
-
אסימון
מחרוזת
אסימון שהוקצה על ידי השירות המבוקש.
-
החזרות
-
הבטחה<string>
Chrome 96 ומעלהיש תמיכה בהבטחות במניפסט מגרסה V3 ואילך, אבל אפשר לבצע קריאה חוזרת (callback) לצורך תאימות לאחור. אי אפשר להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה מסתיימת עם אותו הסוג שמועבר לקריאה החוזרת.
אירועים
onTokenRefresh
chrome.instanceID.onTokenRefresh.addListener(
callback: function,
)
מופעל כשצריך לרענן את כל האסימונים שהוענקו.
פרמטרים
-
קריאה חוזרת (callback)
פונקציה
הפרמטר
callback
נראה כך:() => void