chrome.idle

الوصف

ويمكنك استخدام واجهة برمجة تطبيقات chrome.idle لرصد تغيُّر حالة عدم النشاط للجهاز.

الأذونات

idle

يجب الإفصاح عن إذن "idle" في ملف بيان الإضافة لاستخدام واجهة برمجة التطبيقات غير المستخدَمة حاليًا. بالنسبة مثال:

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

الأنواع

IdleState

الإصدار 44 من Chrome أو الإصدارات الأحدث

Enum

"نشط"

"غير نشِط لفترة قصيرة"

"مقفل"

الطُرق

getAutoLockDelay()

وعود الإصدار 73 من Chrome أو الإصدارات الأحدث نظام التشغيل ChromeOS فقط
chrome.idle.getAutoLockDelay(
  callback?: function,
)

الحصول على الوقت بالثواني الذي يستغرقه قفل الشاشة تلقائيًا أثناء عدم النشاط. عرض مدة صفرية إذا لم يتم قفل الشاشة تلقائيًا أبدًا. لا تتوفّر هذه الميزة حاليًا إلا على نظام التشغيل ChromeOS.

المعلمات

  • رد الاتصال

    الدالة اختيارية

    تظهر المَعلمة callback على النحو التالي:

    (delay: number) => void

    • تأخير

      الرقم

      الوقت بالثواني حتى يتم قفل الشاشة تلقائيًا أثناء عدم النشاط. وتكون القيمة صفرًا إذا لم يتم قفل الشاشة تلقائيًا أبدًا.

المرتجعات

  • Promise<number>

    الإصدار 116 من Chrome أو الإصدارات الأحدث

    تتوفّر الوعود في الإصدار Manifest V3 والإصدارات الأحدث، ولكن يتم توفير معاودة الاتصال. التوافق مع الأنظمة القديمة. لا يمكنك استخدام كلتيهما في نفس استدعاء الدالة. تشير رسالة الأشكال البيانية يتم حل الوعد بنفس النوع الذي يتم إرساله إلى معاودة الاتصال.

queryState()

وعود
chrome.idle.queryState(
  detectionIntervalInSeconds: number,
  callback?: function,
)

عرض كلمة "مقفل" إذا كان النظام مُقفَلاً، "غير نشِط لفترة قصيرة" إذا لم يقم المستخدم بإنشاء أي مُدخل لعدد محدد من الثواني، أو إذا كان "نشطًا" وإلا.

المعلمات

  • detectionIntervalInSeconds

    الرقم

    ويُعتبر النظام في وضع عدم النشاط في حال مرور ثانيتَين على رصد آخر إدخال من المستخدم.

  • رد الاتصال

    الدالة اختيارية

    تظهر المَعلمة callback على النحو التالي:

    (newState: IdleState) => void

المرتجعات

  • Promise<IdleState>

    الإصدار 116 من Chrome أو الإصدارات الأحدث

    تتوفّر الوعود في الإصدار Manifest V3 والإصدارات الأحدث، ولكن يتم توفير معاودة الاتصال. التوافق مع الأنظمة القديمة. لا يمكنك استخدام كلتيهما في نفس استدعاء الدالة. تشير رسالة الأشكال البيانية يتم حل الوعد بنفس النوع الذي يتم إرساله إلى معاودة الاتصال.

setDetectionInterval()

chrome.idle.setDetectionInterval(
  intervalInSeconds: number,
)

تضبط هذه السياسة الفاصل الزمني بالثواني المُستخدَم لتحديد ما إذا كان النظام في حالة عدم نشاط لأحداث onStateChanged. الفاصل الزمني التلقائي هو 60 ثانية.

المعلمات

  • intervalInSeconds

    الرقم

    الحدّ الأدنى، بالثواني، يُستخدَم لتحديد وقت أن يكون النظام في حالة عدم نشاط.

فعاليات

onStateChanged

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

يتم إطلاقه عندما يتغير النظام إلى حالة نشطة أو غير مستخدَمة أو مقفلة. ينشط الحدث مع عرض كلمة "مقفل" إذا كانت الشاشة مقفلة أو تم تنشيط شاشة الاستراحة "خامل" إذا كان النظام غير مقفل ولم ينشئ المستخدم أي إدخال لعدد محدد من الثواني، وكان "نشطًا" عندما يُنشئ المستخدم مدخلات على نظام عدم النشاط.

المعلمات

  • رد الاتصال

    دالة

    تظهر المَعلمة callback على النحو التالي:

    (newState: IdleState) => void