chrome.instanceID

توضیحات

برای دسترسی به سرویس Instance ID از chrome.instanceID استفاده کنید.

مجوزها

gcm

در دسترس بودن

Chrome 44+

روش ها

deleteID()

chrome.instanceID.deleteID(): Promise<void>

شناسه نمونه برنامه را بازنشانی می کند و همه نشانه های مرتبط با آن را باطل می کند.

برمی گرداند

  • قول<باطل>

    Chrome 96+

deleteToken()

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

توکن اعطایی را باطل می کند.

پارامترها

  • حذف TokenParams

    شی

    پارامترهای حذف توکن

    • نهاد مجاز

      رشته

      Chrome 46+

      نهاد مجاز که برای دریافت توکن استفاده می شود.

    • دامنه

      رشته

      Chrome 46+

      محدوده ای که برای به دست آوردن توکن استفاده می شود.

برمی گرداند

  • قول<باطل>

    Chrome 96+

getCreationTime()

chrome.instanceID.getCreationTime(): Promise<number>

زمانی که InstanceID تولید شده است را بازیابی می کند. زمان ایجاد توسط callback برگردانده می شود.

برمی گرداند

  • قول <تعداد>

    Chrome 96+

getID()

chrome.instanceID.getID(): Promise<string>

یک شناسه برای نمونه برنامه بازیابی می کند. شناسه نمونه با callback برگردانده خواهد شد. تا زمانی که هویت برنامه باطل یا منقضی نشده باشد، همان شناسه بازگردانده می شود.

برمی گرداند

  • قول<رشته>

    Chrome 96+

getToken()

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

رمزی را برگردانید که به نهاد مجاز اجازه می دهد به سرویس تعریف شده توسط محدوده دسترسی داشته باشد.

پارامترها

  • getTokenParams

    شی

    پارامترهای getToken.

    • نهاد مجاز

      رشته

      Chrome 46+

      نهادی را که مجاز به دسترسی به منابع مرتبط با این Instance ID است را شناسایی می کند. این می تواند یک شناسه پروژه از کنسول توسعه دهنده Google باشد.

    • گزینه ها

      شی اختیاری

      Chrome 46+ از Chrome 89 منسوخ شده است

      گزینه ها منسوخ شده اند و نادیده گرفته خواهند شد.

      امکان گنجاندن تعداد کمی جفت کلید/مقدار رشته‌ای را می‌دهد که با نشانه مرتبط هستند و ممکن است در پردازش درخواست استفاده شوند.

    • دامنه

      رشته

      Chrome 46+

      اقدامات مجاز را که نهاد مجاز می تواند انجام دهد را شناسایی می کند. به عنوان مثال برای ارسال پیام های GCM، دامنه GCM باید استفاده شود.

برمی گرداند

  • قول<رشته>

    Chrome 96+

رویدادها

onTokenRefresh

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

زمانی فعال می‌شود که همه توکن‌های اعطا شده باید به‌روزرسانی شوند.

پارامترها

  • پاسخ به تماس

    تابع

    پارامتر callback به نظر می رسد: 

    () => void