توضیحات
برای دسترسی به سرویس Instance ID chrome.instanceID استفاده کنید.
مجوزها
gcmدر دسترس بودن
روشها
deleteID()
chrome.instanceID.deleteID(): Promise<void>
شناسه نمونه برنامه را مجدداً تنظیم میکند و تمام توکنهای مرتبط با آن را لغو میکند.
بازگشتها
قول<void>
کروم ۹۶+وقتی حذف کامل شود، برطرف میشود. اگر promise رد نشود، شناسه نمونه با موفقیت لغو شده است.
deleteToken()
chrome.instanceID.deleteToken(
deleteTokenParams: object,
): Promise<void>
یک توکن اعطا شده را لغو میکند.
پارامترها
- deleteTokenParams
شیء
پارامترهای مربوط به deleteToken.
- نهاد مجاز
رشته
کروم ۴۶+نهاد مجاز که برای دریافت توکن استفاده میشود.
- محدوده
رشته
کروم ۴۶+محدودهای که برای دریافت توکن استفاده میشود.
بازگشتها
قول<void>
کروم ۹۶+زمانی که حذف توکن کامل شود، برطرف میشود. اگر promise رد نشود، توکن با موفقیت لغو شده است.
getCreationTime()
chrome.instanceID.getCreationTime(): Promise<number>
زمانی که InstanceID تولید شده است را بازیابی میکند. زمان ایجاد توسط callback برگردانده میشود.
بازگشتها
قول<number>
کروم ۹۶+با اتمام بازیابی، برطرف میشود.
getID()
chrome.instanceID.getID(): Promise<string>
یک شناسه برای نمونه برنامه بازیابی میکند. شناسه نمونه توسط callback برگردانده میشود. تا زمانی که شناسه برنامه لغو یا منقضی نشده باشد، همان شناسه برگردانده میشود.
بازگشتها
قول<string>
کروم ۹۶+با اتمام بازیابی، برطرف میشود.
getToken()
chrome.instanceID.getToken(
getTokenParams: object,
): Promise<string>
یک توکن (token) را برمیگرداند که به موجودیت مجاز اجازه میدهد به سرویس تعریفشده توسط scope دسترسی داشته باشد.
پارامترها
- پارامترهای getToken
شیء
پارامترهای مربوط به getToken.
- نهاد مجاز
رشته
کروم ۴۶+موجودیتی را که مجاز به دسترسی به منابع مرتبط با این شناسه نمونه است، شناسایی میکند. این میتواند یک شناسه پروژه از کنسول توسعهدهندگان گوگل باشد.
- گزینهها
شیء اختیاری
کروم ۴۶+ از کروم ۸۹ منسوخ شده استگزینهها منسوخ شدهاند و نادیده گرفته خواهند شد.
اجازه میدهد تعداد کمی از جفتهای کلید/مقدار رشتهای که با توکن مرتبط هستند و ممکن است در پردازش درخواست استفاده شوند، گنجانده شوند.
- محدوده
رشته
کروم ۴۶+اقدامات مجاز که نهاد مجاز میتواند انجام دهد را شناسایی میکند. به عنوان مثال، برای ارسال پیامهای GCM، باید از محدوده
GCMاستفاده شود.
بازگشتها
قول<string>
کروم ۹۶+با اتمام بازیابی، برطرف میشود.
رویدادها
onTokenRefresh
chrome.instanceID.onTokenRefresh.addListener(
callback: function,
)
زمانی اجرا میشود که تمام توکنهای اعطا شده نیاز به بهروزرسانی داشته باشند.
پارامترها
- تماس برگشتی
تابع
پارامتر
callbackبه شکل زیر است:() => void