JavaScript SDK - metodo 'startOfflineRecording'

Dettagli sul metodo 'startOfflineRecording' dell'SDK di OpenReplay

JavaScript SDK ⁠-⁠ metodo 'startOfflineRecording'

Avvia la registrazione della sessione in modalità offline (non viene inviato nulla finché non viene attivato il caricamento) e restituisce i metodi per controllare lo stato della registrazione.

Nota: i timestamp della sessione e degli eventi vengono ricavati dal dispositivo dell’utente e non sono sincronizzati con il nostro backend.

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

Con startOpts puoi personalizzare diversi aspetti della registrazione:

  • userID: string: Serve a impostare manualmente lo userID per tracciarlo tra le sessioni. È un valore di tipo stringa e può essere qualsiasi cosa tu voglia.
  • metadata: Record<string, string>: Imposta manualmente i valori dei metadati. Consulta la sezione Metadati per saperne di più su questa funzionalità.
  • forceNew: boolean: Serve a forzare una nuova sessione dopo un aggiornamento della pagina. Per impostazione predefinita è false, quindi dopo un aggiornamento la sessione viene mantenuta.
  • sessionHash: string: Serve per le sessioni persistenti (sticky). Utile se hai un’applicazione multi-sito o se devi reindirizzare l’utente all’esterno e poi di nuovo sul tuo sito (ad esempio verso un gateway di pagamento).
  • onSessionSent: Callback che viene chiamata quando la sessione è stata caricata completamente.
  • saveBuffer(): void - Salva il buffer corrente nell’oggetto localStorage (personalizzabile nel costruttore); il buffer verrà ricaricato automaticamente quando viene chiamato startOfflineRecording.
  • getBuffer(): Messages[] - Restituisce il buffer di messaggi corrente.
  • setBuffer(buffer: Messages[]) - Sostituisce il buffer corrente con quello fornito (se usi metodi alternativi di salvataggio temporaneo).