84 lines
2.5 KiB
TypeScript
84 lines
2.5 KiB
TypeScript
import React from 'react';
|
|
import Highlight from 'react-highlight'
|
|
import ToggleContent from 'Shared/ToggleContent'
|
|
|
|
function AssistNpm(props) {
|
|
return (
|
|
<div>
|
|
<p>Initialize the tracker then load the @openreplay/tracker-assist plugin.</p>
|
|
|
|
<div className="font-bold my-2">Usage</div>
|
|
<ToggleContent
|
|
label="Server-Side-Rendered (SSR)?"
|
|
first={
|
|
<Highlight className="js">
|
|
{`import OpenReplay from '@openreplay/tracker';
|
|
import trackerAssist from '@openreplay/tracker-assist';
|
|
const tracker = new OpenReplay({
|
|
projectKey: '${props.projectKey}',
|
|
});
|
|
// .start() returns a promise
|
|
tracker.start().then(sessionData => ... ).catch(e => ... )
|
|
|
|
tracker.use(trackerAssist(options)); // check the list of available options below`}
|
|
</Highlight>
|
|
}
|
|
second={
|
|
<Highlight className="js">
|
|
{`import OpenReplay from '@openreplay/tracker/cjs';
|
|
import trackerAssist from '@openreplay/tracker-assist/cjs';
|
|
const tracker = new OpenReplay({
|
|
projectKey: '${props.projectKey}'
|
|
});
|
|
const trackerAssist = tracker.use(trackerAssist(options)); // check the list of available options below
|
|
//...
|
|
function MyApp() {
|
|
useEffect(async () => { // use componentDidMount in case of React Class Component
|
|
// .start() returns a promise
|
|
tracker.start().then(sessionData => ... ).catch(e => ... )
|
|
}, [])
|
|
//...
|
|
}`}
|
|
</Highlight>
|
|
}
|
|
/>
|
|
|
|
<div className="font-bold my-2">Options</div>
|
|
<Highlight className="js">
|
|
{`trackerAssist({
|
|
onAgentConnect: StartEndCallback;
|
|
onCallStart: StartEndCallback;
|
|
onRemoteControlStart: StartEndCallback;
|
|
onRecordingRequest?: (agentInfo: Record<string, any>) => any;
|
|
onCallDeny?: () => any;
|
|
onRemoteControlDeny?: (agentInfo: Record<string, any>) => any;
|
|
onRecordingDeny?: (agentInfo: Record<string, any>) => any;
|
|
session_calling_peer_key: string;
|
|
session_control_peer_key: string;
|
|
callConfirm: ConfirmOptions;
|
|
controlConfirm: ConfirmOptions;
|
|
recordingConfirm: ConfirmOptions;
|
|
socketHost?: string;
|
|
config: RTCConfiguration;
|
|
serverURL: string
|
|
callUITemplate?: string;
|
|
})
|
|
|
|
type ConfirmOptions = {
|
|
text?:string,
|
|
style?: StyleObject, // style object (i.e {color: 'red', borderRadius: '10px'})
|
|
confirmBtn?: ButtonOptions,
|
|
declineBtn?: ButtonOptions
|
|
}
|
|
|
|
type ButtonOptions = HTMLButtonElement | string | {
|
|
innerHTML?: string, // to pass an svg string or text
|
|
style?: StyleObject, // style object (i.e {color: 'red', borderRadius: '10px'})
|
|
}
|
|
`}
|
|
</Highlight>
|
|
</div>
|
|
);
|
|
}
|
|
|
|
export default AssistNpm;
|