@snowplow/react-native-tracker
Version:
React Native tracker for Snowplow
46 lines • 2.06 kB
TypeScript
import { EmitterConfiguration, TrackerCore } from '@snowplow/tracker-core';
import { ScreenTrackingConfiguration } from '@snowplow/browser-plugin-screen-tracking';
import { DeepLinkConfiguration, AppLifecycleConfiguration, EventStoreConfiguration, PlatformContextConfiguration, ReactNativeTracker, SessionConfiguration, SubjectConfiguration, TrackerConfiguration } from './types';
declare type Configuration = TrackerConfiguration & EmitterConfiguration & SessionConfiguration & SubjectConfiguration & EventStoreConfiguration & ScreenTrackingConfiguration & PlatformContextConfiguration & DeepLinkConfiguration & AppLifecycleConfiguration;
/**
* Creates a new tracker instance with the given configuration
* @param configuration - Configuration for the tracker
* @returns Tracker instance
*/
export declare function newTracker(configuration: Configuration): Promise<ReactNativeTracker>;
/**
* Retrieves an initialized tracker given its namespace
* @param trackerNamespace - Tracker namespace
* @returns Tracker instance if exists
*/
export declare function getTracker(trackerNamespace: string): ReactNativeTracker | undefined;
/**
* Retrieves all initialized trackers
* @returns All initialized trackers
*/
export declare function getAllTrackers(): ReactNativeTracker[];
/**
* Internal function to retrieve the tracker core given its namespace
* @param trackerNamespace - Tracker namespace
* @returns Tracker core if exists
*/
export declare function getTrackerCore(trackerNamespace: string): TrackerCore | undefined;
/**
* Internal function to retrieve all initialized tracker cores
* @returns All initialized tracker cores
*/
export declare function getAllTrackerCores(): TrackerCore[];
/**
* Removes a tracker given its namespace
*
* @param trackerNamespace - Tracker namespace
*/
export declare function removeTracker(trackerNamespace: string): void;
/**
* Removes all initialized trackers
*
* @returns - A boolean promise
*/
export declare function removeAllTrackers(): void;
export {};
//# sourceMappingURL=tracker.d.ts.map