react-native-tracker.md

Home > @snowplow/react-native-tracker

react-native-tracker package

Enumerations

Enumeration	Description
LOG_LEVEL
PlatformContextProperty

Functions

Function	Description
getAllTrackers()	Retrieves all initialized trackers
getTracker(trackerNamespace)	Retrieves an initialized tracker given its namespace
getWebViewCallback()	Enables tracking events from apps rendered in react-native-webview components. The apps need to use the Snowplow WebView tracker to track the events.To subscribe for the events, use as the onMessage prop for a WebView component.
newTracker(configuration)	Creates a new tracker instance with the given configuration
removeAllTrackers()	Removes all initialized trackers
removeTracker(trackerNamespace)	Removes a tracker given its namespace

Interfaces

Interface	Description
AppLifecycleConfiguration	Configuration for app lifecycle tracking
AsyncStorage
CoreConfiguration	The configuration object for the tracker core library
CorePlugin	Interface which defines Core Plugins
CorePluginConfiguration	The configuration of the plugin to add
DeepLinkConfiguration	Configuration for deep link tracking
DeviceTimestamp	A representation of a Device Timestamp (dtm)
Emitter	Emitter is responsible for sending events to the collector. It manages the event queue and sends events in batches depending on configuration.
EmitterConfiguration
EmitterConfigurationBase
EventPayloadAndContext	Interface for returning a built event (PayloadBuilder) and context (Array of SelfDescribingJson).
EventStoreConfiguration	Configuration for the event store
EventStoreIterator	EventStoreIterator allows iterating over all events in the store.
EventStorePayload
FormFocusOrChangeEvent	Represents either a Form Focus or Form Change event When a user focuses on a form element or when a user makes a change to a form element.
Logger
PageViewEvent	A Page View Event Represents a Page View, which is typically fired as soon as possible when a web page is loaded within the users browser. Often also fired on "virtual page views" within Single Page Applications (SPA).
PayloadBuilder	Interface for mutable object encapsulating tracker payload
PlatformContextConfiguration
PlatformContextRetriever	Overrides for the values for properties of the platform context.
RuleSet	A ruleset has accept or reject properties that contain rules for matching Iglu schema URIs
SessionConfiguration	Configuration for session tracking
SessionState	Current session state that is tracked in events.
SubjectConfiguration	Configuration of subject properties tracked with events
TrackerConfiguration	The configuration object for initialising the tracker
TrackerCore	Export interface containing all Core functions
TrueTimestamp	A representation of a True Timestamp (ttm)

Variables

Variable	Description
version

Type Aliases

Type Alias	Description
ConditionalContextProvider	Conditional context providers are two element arrays used to decide when to attach contexts, where: - the first element is some conditional criterion - the second element is any number of context primitives
ContextFilter	A context filter is a user-supplied callback that is evaluated for each event to determine if the context associated with the filter should be attached to the event
ContextGenerator	A context generator is a user-supplied callback that is evaluated for each event to allow an additional context to be dynamically attached to the event
ContextPrimitive	A context primitive is either a self-describing JSON or a context generator
DeepLinkReceivedProps	DeepLinkReceived event properties schema: iglu:com.snowplowanalytics.mobile/deep_link_received/jsonschema/1-0-0
EventBatch	A collection of event payloads which are sent to the collector.
EventContext	EventContext type
EventJson	An array of tuples which represents the unprocessed JSON to be added to the Payload
EventJsonWithKeys	A tuple which represents the unprocessed JSON to be added to the Payload
EventMethod
FilterProvider	A filter provider is a tuple that has two parts: a context filter and the context primitive(s) If the context filter evaluates to true, the tracker will attach the context primitive(s)
JsonProcessor	A function which will processor the Json onto the injected PayloadBuilder
ListItemViewProps	Event tracking the view of an item in a list. If screen engagement tracking is enabled, the list item view events will be aggregated into a screen_summary entity.Schema: iglu:com.snowplowanalytics.mobile/list_item_view/jsonschema/1-0-0
MessageNotificationAttachmentProps	Attachment object that identify an attachment in the MessageNotification.
MessageNotificationProps	MessageNotification event properties schema: iglu:com.snowplowanalytics.mobile/message_notification/jsonschema/1-0-0
Payload	Type for a Payload dictionary
ReactNativeTracker	The ReactNativeTracker type
RequestFailure	The data that will be available to the onRequestFailure callback
RuleSetProvider	A ruleset provider is aa tuple that has two parts: a ruleset and the context primitive(s) If the ruleset allows the current event schema URI, the tracker will attach the context primitive(s)
ScreenSize	Screen size in pixels
ScreenViewProps	ScreenView event properties schema: iglu:com.snowplowanalytics.mobile/screen_view/jsonschema/1-0-0
ScrollChangedProps	Event tracked when a scroll view's scroll position changes. If screen engagement tracking is enabled, the scroll changed events will be aggregated into a screen_summary entity.Schema: iglu:com.snowplowanalytics.mobile/scroll_changed/jsonschema/1-0-0
SelfDescribing	Interface for any self-describing JSON such as context entities or self-describing events
StructuredProps	Properties for a structured event. A classic style of event tracking, allows for easier movement between analytics systems. Self-describing events are preferred for their schema validation.
Timestamp	Algebraic datatype representing possible timestamp type choice
TimingProps	Timing event properties
Trigger	Trigger for MessageNotification event
WebViewMessageHandler	A callback to be used for the onMessage prop of a WebView component.