trackApplicationLoadedEvent
Tracks an ApplicationLoadedEvent.
trackApplicationLoadedEvent = (parameters: {
tracker: Tracker,
locationStack?: LocationStack,
globalContexts?: GlobalContexts,
options?: TrackEventOptions
}) => Promise<TrackerEvent>
caution
This is a lower-level API.
Event Tracking Hooks are preferable as they automate retrieving both the Tracker instance and LocationStack. In fact, the do use these lower-level APIs internally.
info
Under normal circumstances ObjectivTracker tracks this event automatically, unless disabled via its options.
Parameters
type | ||
---|---|---|
required | tracker | ReactTracker |
optional | options | TrackEventOptions |
optional | locationStack | LocationStack |
optional | globalContexts | GlobalContexts |
Returns
Promise<TrackerEvent>
Usage
import {
ReactTracker,
trackApplicationLoadedEvent,
ObjectivProvider,
useOnMount
} from '@objectiv/tracker-react';
const App = ({ children }) => {
const tracker = new ReactTracker({
endpoint: 'https://collector.app.dev',
applicationId: 'app-id'
})
useOnMount(() => {
trackApplicationLoadedEvent({ tracker });
})
return (
<ObjectivProvider tracker={tracker} options={{ trackApplicationLoaded: false }}>
{children}
</ObjectivProvider>
);
}
tip
The code above is actually very similar to what ObjectivProvider does internally. Check the source on GitHub.