حزمة تطوير JavaScript - طريقة 'coldStart'

تفاصيل حول طريقة 'coldStart' من حزمة تطوير OpenReplay

حزمة تطوير JavaScript ⁠-⁠ طريقة 'coldStart'

تبدأ بتخزين الرسائل مؤقتًا دون بدء الجلسة الفعلية. سيحتفظ المخزن المؤقت بآخر 30 ثانية من الأحداث المسجَّلة. يمكنك تنشيط الجلسة عن طريق استدعاء start() أو عبر مُشغِّل شرطي.

coldStart(startOpts?: Partial<StartOptions>, isConditional?: boolean): Promise<void>

باستخدام startOpts يمكنك تخصيص جوانب مختلفة من التسجيل:

  • userID: string: يُستخدم لتعيين userID يدويًا لتتبُّعه عبر الجلسات. وهو قيمة نصية ويمكن أن يكون أي شيء تريده.
  • metadata: Record<string, string>: تعيين قيم البيانات الوصفية يدويًا. اطّلع على قسم البيانات الوصفية لمعرفة المزيد حول هذا الأمر.
  • forceNew: boolean: يُستخدم لفرض بدء جلسة جديدة بعد إعادة تحميل الصفحة. يكون مضبوطًا افتراضيًا على false، لذا تظل الجلسة محفوظة بعد إعادة التحميل.
  • sessionHash: string: يُستخدم للجلسات الثابتة (sticky sessions). يكون مفيدًا إذا كان لديك تطبيق متعدد المواقع أو إذا كان عليك إعادة توجيه المستخدم خارج موقعك ثم العودة إليه (مثل التوجيه إلى بوابة دفع).
  • isConditional: يُحدِّد ما إذا كان على أداة التتبُّع الانتظار حتى يتحقق شرط المُشغِّل قبل بدء الجلسة تلقائيًا.

ملاحظة: التسجيل الشرطي مدعوم فقط في إصداراتنا Cloud و Enterprise Edition.

القيمة المُرجَعة

Section titled القيمة المُرجَعة

لا تُرجِع هذه الطريقة أي قيمة.