trackSuccessEvent

Tracks a SuccessEvent.

trackSuccessEvent = (parameters: {
tracker: Tracker,
message: string,
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.

Parameters

type
requiredtrackerReactTracker
requiredmessagestring
optionaloptionsTrackEventOptions
optionallocationStackLocationStack
optionalglobalContextsGlobalContexts

Returns

Promise<TrackerEvent>

Usage