‏JavaScript SDK - الطريقة 'startOfflineRecording'

تفاصيل حول الطريقة 'startOfflineRecording' من SDK الخاص بـ OpenReplay

‏JavaScript SDK ⁠-⁠ الطريقة 'startOfflineRecording'

تبدأ تسجيل الجلسة في وضع عدم الاتصال (لا يتم إرسال أي شيء ما لم يتم تشغيل عملية الرفع) وتُرجع طرقًا للتحكم في حالة التسجيل.

ملاحظة: سيتم استخراج الطوابع الزمنية للجلسة والأحداث من جهاز المستخدم، ولن تتم مزامنتها مع الواجهة الخلفية لدينا.

startOfflineRecording(
	startOpts?: Partial<StartOptions>, 
	onSessionSent: () => void
): { saveBuffer, getBuffer, setBuffer }

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

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

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

Section titled القيمة المُرجَعة
  • saveBuffer(): void - يحفظ المخزن المؤقت الحالي في كائن localStorage (قابل للتخصيص في المُنشئ)، وسيتم تحميل المخزن المؤقت تلقائيًا بمجرد استدعاء startOfflineRecording.
  • getBuffer(): Messages[] - يُرجع المخزن المؤقت الحالي للرسائل.
  • setBuffer(buffer: Messages[]) - يستبدل المخزن المؤقت الحالي بالمخزن المُعطى (إذا كنت تستخدم طرقًا بديلة للحفظ المؤقت).