browser.idle

شرح

از chrome.idle API برای تشخیص زمان تغییر وضعیت غیرفعال دستگاه استفاده کنید.

اجازه‌ها

idle

برای استفاده از میانای برنامه‌سازی کاربردی idle، باید اجازه "idle" را در مانیفست افزونه‌تان اعلام کنید. برای مثال:

{
  "name": "My extension",
  ...
  "permissions": [
    "idle"
  ],
  ...
}

انواع

IdleState

Chrome نسخه ۴۴ و بالاتر browser.* از Chrome نسخه ۱۴۸

شمارشی

«فعال»

«idle»

«قفل‌شده»

روش‌ها

getAutoLockDelay()

Chrome نسخه ۷۳ و بالاتر browser.* ‎ از Chrome نسخه ۱۴۸ فقط ChromeOS 
browser.idle.getAutoLockDelay(): Promise<number>

مدت زمان (به ثانیه) تا قفل شدن خودکار صفحه‌نمایش درحالت غیرفعال را دریافت می‌کند. اگر صفحه هرگز به‌طور خودکار قفل نشود، مدت‌زمان صفر را برمی‌گرداند. درحال‌حاضر فقط در Chrome OS پشتیبانی می‌شود.

بازگشتی‌ها

  • Promise<number>

    Chrome نسخه ۱۱۶ و بالاتر browser.* ‎ از Chrome نسخه ۱۴۸

queryState()

browser.idle.queryState(
  detectionIntervalInSeconds: number,
): Promise<IdleState>

اگر سیستم قفل باشد، «قفل‌شده» را برمی‌گرداند، اگر کاربر برای تعداد ثانیه‌های مشخصی هیچ ورودی‌ای تولید نکرده باشد، «بیکار» را برمی‌گرداند، و درغیراین‌صورت «فعال» را برمی‌گرداند.

پارامترها

  • detectionIntervalInSeconds

    شماره

    اگر detectionIntervalInSeconds ثانیه از آخرین ورودی شناسایی‌شده کاربر گذشته باشد، سیستم غیرفعال درنظر گرفته می‌شود.

بازگشتی‌ها

  • Promise<IdleState>

    Chrome نسخه ۱۱۶ و بالاتر browser.* ‎ از Chrome نسخه ۱۴۸

setDetectionInterval()

browser.idle.setDetectionInterval(
  intervalInSeconds: number,
): void

فاصله زمانی را (به ثانیه) تنظیم می‌کند که برای تعیین زمان قرار گرفتن سیستم در حالت غیرفعال برای رویدادهای onStateChanged استفاده می‌شود. فاصله پیش‌فرض ۶۰ ثانیه است.

پارامترها

  • intervalInSeconds

    شماره

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

رویدادها

onStateChanged

browser.idle.onStateChanged.addListener(
  callback: function,
)

وقتی سیستم به حالت فعال، غیرفعال، یا قفل‌شده تغییر می‌کند، فعال می‌شود. اگر صفحه قفل باشد یا محافظ صفحه‌نمایش فعال شود، رویداد با «قفل‌شده» فعال می‌شود، اگر قفل سیستم باز باشد و کاربر برای تعداد ثانیه مشخصی هیچ ورودی‌ای ایجاد نکرده باشد، با «بیکار» فعال می‌شود، و وقتی کاربر در سیستم بیکار ورودی ایجاد کند، با «فعال» فعال می‌شود.

پارامترها

  • تماس برگشتی

    عملکرد

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

    (newState: IdleState) => void