chrome.instanceID

refresh date: 2026-09-25 robots: noindex

شرح

برای دسترسی به سرویس «شناسه نمونه»، از chrome.instanceID استفاده کنید.

اجازه‌ها

gcm

دردسترس بودن

Chrome نسخه ۴۴ به بالا

روش‌ها

deleteID()

قول

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

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

پارامترها

• تماس برگشتی

  تابع اختیاری

  پارامتر callback به‌صورت زیر است:

  () => void

بازگشتی‌ها

• Promise<void>

  Chrome نسخه ۹۶ به بالا

  وقتی حذف تکمیل شود، مشکل برطرف می‌شود. اگر وعده رد نشود، شناسه نمونه با موفقیت لغو می‌شود.

  ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

deleteToken()

قول

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

کد اعطاشده را باطل می‌کند.

پارامترها

• deleteTokenParams

  شیء

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

  • authorizedEntity

    رشته

    Chrome نسخه ۴۶ و بالاتر

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

  • محدوده

    رشته

    Chrome نسخه ۴۶ و بالاتر

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

• تماس برگشتی

  تابع اختیاری

  پارامتر callback به‌صورت زیر است:

  () => void

بازگشتی‌ها

• Promise<void>

  Chrome نسخه ۹۶ به بالا

  وقتی حذف کردن کد به‌پایان برسد، حل می‌شود. اگر وعده رد نشود، توکن با موفقیت لغو می‌شود.

  ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

getCreationTime()

قول

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

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

پارامترها

• تماس برگشتی

  تابع اختیاری

  پارامتر callback به‌صورت زیر است:

  (creationTime: number) => void

  • creationTime

    شماره

    زمانی که «شناسه نمونه» تولید شده است، برحسب میلی‌ثانیه از تاریخ.

بازگشتی‌ها

• Promise<number>

  Chrome نسخه ۹۶ به بالا

  وقتی بازیابی تکمیل شود، مشکل برطرف می‌شود.

  ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

getID()

قول

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

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

پارامترها

• تماس برگشتی

  تابع اختیاری

  پارامتر callback به‌صورت زیر است:

  (instanceID: string) => void

  • instanceID

    رشته

    «شناسه نمونه» اختصاص‌داده‌شده به نمونه برنامه.

بازگشتی‌ها

• Promise<string>

  Chrome نسخه ۹۶ به بالا

  وقتی بازیابی تکمیل شود، مشکل برطرف می‌شود.

  ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

getToken()

قول

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

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

پارامترها

• getTokenParams

  شیء

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

  • authorizedEntity

    رشته

    Chrome نسخه ۴۶ و بالاتر

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

  • گزینه‌ها

    شیء اختیاری

    Chrome نسخه ۴۶ و بالاتر از Chrome نسخه ۸۹ منسوخ شده است

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

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

  • محدوده

    رشته

    Chrome نسخه ۴۶ و بالاتر

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

• تماس برگشتی

  تابع اختیاری

  پارامتر callback به‌صورت زیر است:

  (token: string) => void

  • کد

    رشته

    رمزه‌ای که توسط سرویس درخواستی اختصاص داده شده است.

بازگشتی‌ها

• Promise<string>

  Chrome نسخه ۹۶ به بالا

  وقتی بازیابی تکمیل شود، مشکل برطرف می‌شود.

  ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

رویدادها

onTokenRefresh

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

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

پارامترها

• تماس برگشتی

  عملکرد

  پارامتر callback به‌صورت زیر است:

  () => void