diff --git a/api-docs/docs/browser-tracker/markdown/browser-tracker.coreplugin.deactivateplugin.md b/api-docs/docs/browser-tracker/markdown/browser-tracker.coreplugin.deactivateplugin.md index 5d63baf9d..bf29e5d18 100644 --- a/api-docs/docs/browser-tracker/markdown/browser-tracker.coreplugin.deactivateplugin.md +++ b/api-docs/docs/browser-tracker/markdown/browser-tracker.coreplugin.deactivateplugin.md @@ -1,13 +1,13 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [CorePlugin](./browser-tracker.coreplugin.md) > [deactivatePlugin](./browser-tracker.coreplugin.deactivateplugin.md) - -## CorePlugin.deactivatePlugin property - -Called when the tracker is being destroyed. Should be used to clean up any resources or listeners that the plugin has created. - -Signature: - -```typescript -deactivatePlugin?: (core: TrackerCore) => void; -``` + + +[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [CorePlugin](./browser-tracker.coreplugin.md) > [deactivatePlugin](./browser-tracker.coreplugin.deactivateplugin.md) + +## CorePlugin.deactivatePlugin property + +Called when the tracker is being destroyed. Should be used to clean up any resources or listeners that the plugin has created. + +Signature: + +```typescript +deactivatePlugin?: (core: TrackerCore) => void; +``` diff --git a/api-docs/docs/browser-tracker/markdown/browser-tracker.trackerconfiguration.md b/api-docs/docs/browser-tracker/markdown/browser-tracker.trackerconfiguration.md index c3ede1535..5aae2288c 100644 --- a/api-docs/docs/browser-tracker/markdown/browser-tracker.trackerconfiguration.md +++ b/api-docs/docs/browser-tracker/markdown/browser-tracker.trackerconfiguration.md @@ -45,5 +45,6 @@ newTracker('sp1', 'collector.my-website.com', { plugins: [ PerformanceTimingPlugin(), AdTrackingPlugin() ], stateStorageStrategy: 'cookieAndLocalStorage' }); + ``` diff --git a/api-docs/docs/browser-tracker/markdown/browser-tracker.trackercore.deactivate.md b/api-docs/docs/browser-tracker/markdown/browser-tracker.trackercore.deactivate.md index 74ac88a56..3a86b5b43 100644 --- a/api-docs/docs/browser-tracker/markdown/browser-tracker.trackercore.deactivate.md +++ b/api-docs/docs/browser-tracker/markdown/browser-tracker.trackercore.deactivate.md @@ -1,17 +1,17 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [TrackerCore](./browser-tracker.trackercore.md) > [deactivate](./browser-tracker.trackercore.deactivate.md) - -## TrackerCore.deactivate() method - -Deactivate tracker core including all plugins. This is useful for cleaning up resources or listeners that have been created. Once deactivated, the tracker won't be able to track any events. - -Signature: - -```typescript -deactivate(): void; -``` -Returns: - -void - + + +[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [TrackerCore](./browser-tracker.trackercore.md) > [deactivate](./browser-tracker.trackercore.deactivate.md) + +## TrackerCore.deactivate() method + +Deactivate tracker core including all plugins. This is useful for cleaning up resources or listeners that have been created. Once deactivated, the tracker won't be able to track any events. + +Signature: + +```typescript +deactivate(): void; +``` +Returns: + +void + diff --git a/api-docs/docs/node-tracker/markdown/index.md b/api-docs/docs/node-tracker/markdown/index.md index 87f8bb7e7..58bc37403 100644 --- a/api-docs/docs/node-tracker/markdown/index.md +++ b/api-docs/docs/node-tracker/markdown/index.md @@ -8,5 +8,5 @@ | Package | Description | | --- | --- | -| [@snowplow/node-tracker](./node-tracker.md) | | +| [@snowplow/react-native-tracker](./react-native-tracker.md) | | diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.adclickevent.advertiserid.md b/api-docs/docs/node-tracker/markdown/node-tracker.adclickevent.advertiserid.md deleted file mode 100644 index 3e5e1c1f2..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.adclickevent.advertiserid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AdClickEvent](./node-tracker.adclickevent.md) > [advertiserId](./node-tracker.adclickevent.advertiserid.md) - -## AdClickEvent.advertiserId property - -Identifier for the advertiser which the campaign belongs to - -Signature: - -```typescript -advertiserId?: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.adclickevent.bannerid.md b/api-docs/docs/node-tracker/markdown/node-tracker.adclickevent.bannerid.md deleted file mode 100644 index 79afd60f4..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.adclickevent.bannerid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AdClickEvent](./node-tracker.adclickevent.md) > [bannerId](./node-tracker.adclickevent.bannerid.md) - -## AdClickEvent.bannerId property - -Identifier for the ad banner being displayed - -Signature: - -```typescript -bannerId?: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.adclickevent.campaignid.md b/api-docs/docs/node-tracker/markdown/node-tracker.adclickevent.campaignid.md deleted file mode 100644 index 4a067d9d9..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.adclickevent.campaignid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AdClickEvent](./node-tracker.adclickevent.md) > [campaignId](./node-tracker.adclickevent.campaignid.md) - -## AdClickEvent.campaignId property - -Identifier for the advertiser which the campaign belongs to - -Signature: - -```typescript -campaignId?: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.adclickevent.clickid.md b/api-docs/docs/node-tracker/markdown/node-tracker.adclickevent.clickid.md deleted file mode 100644 index 85816030e..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.adclickevent.clickid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AdClickEvent](./node-tracker.adclickevent.md) > [clickId](./node-tracker.adclickevent.clickid.md) - -## AdClickEvent.clickId property - -Identifier for the particular click instance - -Signature: - -```typescript -clickId?: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.adclickevent.cost.md b/api-docs/docs/node-tracker/markdown/node-tracker.adclickevent.cost.md deleted file mode 100644 index 18c8f7a07..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.adclickevent.cost.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AdClickEvent](./node-tracker.adclickevent.md) > [cost](./node-tracker.adclickevent.cost.md) - -## AdClickEvent.cost property - -Advertisement cost - -Signature: - -```typescript -cost?: number; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.adclickevent.costmodel.md b/api-docs/docs/node-tracker/markdown/node-tracker.adclickevent.costmodel.md deleted file mode 100644 index d568b747c..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.adclickevent.costmodel.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AdClickEvent](./node-tracker.adclickevent.md) > [costModel](./node-tracker.adclickevent.costmodel.md) - -## AdClickEvent.costModel property - -The cost model for the campaign - -Signature: - -```typescript -costModel?: "cpa" | "cpc" | "cpm"; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.adclickevent.impressionid.md b/api-docs/docs/node-tracker/markdown/node-tracker.adclickevent.impressionid.md deleted file mode 100644 index 8af82e525..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.adclickevent.impressionid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AdClickEvent](./node-tracker.adclickevent.md) > [impressionId](./node-tracker.adclickevent.impressionid.md) - -## AdClickEvent.impressionId property - -Identifier for the particular impression instance - -Signature: - -```typescript -impressionId?: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.adclickevent.md b/api-docs/docs/node-tracker/markdown/node-tracker.adclickevent.md deleted file mode 100644 index f7b092d92..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.adclickevent.md +++ /dev/null @@ -1,32 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AdClickEvent](./node-tracker.adclickevent.md) - -## AdClickEvent interface - -An Ad Click Event Used to track an advertisement click - -Signature: - -```typescript -interface AdClickEvent -``` - -## Remarks - -If you provide the cost field, you must also provide one of 'cpa', 'cpc', and 'cpm' for the costModel field. - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [advertiserId?](./node-tracker.adclickevent.advertiserid.md) | string | (Optional) Identifier for the advertiser which the campaign belongs to | -| [bannerId?](./node-tracker.adclickevent.bannerid.md) | string | (Optional) Identifier for the ad banner being displayed | -| [campaignId?](./node-tracker.adclickevent.campaignid.md) | string | (Optional) Identifier for the advertiser which the campaign belongs to | -| [clickId?](./node-tracker.adclickevent.clickid.md) | string | (Optional) Identifier for the particular click instance | -| [cost?](./node-tracker.adclickevent.cost.md) | number | (Optional) Advertisement cost | -| [costModel?](./node-tracker.adclickevent.costmodel.md) | "cpa" \| "cpc" \| "cpm" | (Optional) The cost model for the campaign | -| [impressionId?](./node-tracker.adclickevent.impressionid.md) | string | (Optional) Identifier for the particular impression instance | -| [targetUrl](./node-tracker.adclickevent.targeturl.md) | string | The destination URL of the advertisement | -| [zoneId?](./node-tracker.adclickevent.zoneid.md) | string | (Optional) Identifier for the zone where the ad banner is located | - diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.adclickevent.targeturl.md b/api-docs/docs/node-tracker/markdown/node-tracker.adclickevent.targeturl.md deleted file mode 100644 index 7da8c1ed8..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.adclickevent.targeturl.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AdClickEvent](./node-tracker.adclickevent.md) > [targetUrl](./node-tracker.adclickevent.targeturl.md) - -## AdClickEvent.targetUrl property - -The destination URL of the advertisement - -Signature: - -```typescript -targetUrl: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.adclickevent.zoneid.md b/api-docs/docs/node-tracker/markdown/node-tracker.adclickevent.zoneid.md deleted file mode 100644 index 678870cf5..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.adclickevent.zoneid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AdClickEvent](./node-tracker.adclickevent.md) > [zoneId](./node-tracker.adclickevent.zoneid.md) - -## AdClickEvent.zoneId property - -Identifier for the zone where the ad banner is located - -Signature: - -```typescript -zoneId?: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.adconversionevent.action.md b/api-docs/docs/node-tracker/markdown/node-tracker.adconversionevent.action.md deleted file mode 100644 index 7a4372493..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.adconversionevent.action.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AdConversionEvent](./node-tracker.adconversionevent.md) > [action](./node-tracker.adconversionevent.action.md) - -## AdConversionEvent.action property - -The type of user interaction e.g. 'purchase' - -Signature: - -```typescript -action?: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.adconversionevent.advertiserid.md b/api-docs/docs/node-tracker/markdown/node-tracker.adconversionevent.advertiserid.md deleted file mode 100644 index 442ca64d4..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.adconversionevent.advertiserid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AdConversionEvent](./node-tracker.adconversionevent.md) > [advertiserId](./node-tracker.adconversionevent.advertiserid.md) - -## AdConversionEvent.advertiserId property - -Identifier for the advertiser which the campaign belongs to - -Signature: - -```typescript -advertiserId?: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.adconversionevent.campaignid.md b/api-docs/docs/node-tracker/markdown/node-tracker.adconversionevent.campaignid.md deleted file mode 100644 index 052760288..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.adconversionevent.campaignid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AdConversionEvent](./node-tracker.adconversionevent.md) > [campaignId](./node-tracker.adconversionevent.campaignid.md) - -## AdConversionEvent.campaignId property - -Identifier for the advertiser which the campaign belongs to - -Signature: - -```typescript -campaignId?: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.adconversionevent.category.md b/api-docs/docs/node-tracker/markdown/node-tracker.adconversionevent.category.md deleted file mode 100644 index 993a9384b..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.adconversionevent.category.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AdConversionEvent](./node-tracker.adconversionevent.md) > [category](./node-tracker.adconversionevent.category.md) - -## AdConversionEvent.category property - -Conversion category - -Signature: - -```typescript -category?: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.adconversionevent.conversionid.md b/api-docs/docs/node-tracker/markdown/node-tracker.adconversionevent.conversionid.md deleted file mode 100644 index 714874194..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.adconversionevent.conversionid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AdConversionEvent](./node-tracker.adconversionevent.md) > [conversionId](./node-tracker.adconversionevent.conversionid.md) - -## AdConversionEvent.conversionId property - -Identifier for the particular conversion instance - -Signature: - -```typescript -conversionId?: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.adconversionevent.cost.md b/api-docs/docs/node-tracker/markdown/node-tracker.adconversionevent.cost.md deleted file mode 100644 index 1745c1116..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.adconversionevent.cost.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AdConversionEvent](./node-tracker.adconversionevent.md) > [cost](./node-tracker.adconversionevent.cost.md) - -## AdConversionEvent.cost property - -Advertisement cost - -Signature: - -```typescript -cost?: number; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.adconversionevent.costmodel.md b/api-docs/docs/node-tracker/markdown/node-tracker.adconversionevent.costmodel.md deleted file mode 100644 index 60ad5c84f..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.adconversionevent.costmodel.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AdConversionEvent](./node-tracker.adconversionevent.md) > [costModel](./node-tracker.adconversionevent.costmodel.md) - -## AdConversionEvent.costModel property - -The cost model for the campaign - -Signature: - -```typescript -costModel?: "cpa" | "cpc" | "cpm"; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.adconversionevent.initialvalue.md b/api-docs/docs/node-tracker/markdown/node-tracker.adconversionevent.initialvalue.md deleted file mode 100644 index fc4d27d82..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.adconversionevent.initialvalue.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AdConversionEvent](./node-tracker.adconversionevent.md) > [initialValue](./node-tracker.adconversionevent.initialvalue.md) - -## AdConversionEvent.initialValue property - -How much the conversion is initially worth - -Signature: - -```typescript -initialValue?: number; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.adconversionevent.md b/api-docs/docs/node-tracker/markdown/node-tracker.adconversionevent.md deleted file mode 100644 index c9fb83e7c..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.adconversionevent.md +++ /dev/null @@ -1,32 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AdConversionEvent](./node-tracker.adconversionevent.md) - -## AdConversionEvent interface - -An Ad Conversion Event Used to track an advertisement click - -Signature: - -```typescript -interface AdConversionEvent -``` - -## Remarks - -If you provide the cost field, you must also provide one of 'cpa', 'cpc', and 'cpm' for the costModel field. - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [action?](./node-tracker.adconversionevent.action.md) | string | (Optional) The type of user interaction e.g. 'purchase' | -| [advertiserId?](./node-tracker.adconversionevent.advertiserid.md) | string | (Optional) Identifier for the advertiser which the campaign belongs to | -| [campaignId?](./node-tracker.adconversionevent.campaignid.md) | string | (Optional) Identifier for the advertiser which the campaign belongs to | -| [category?](./node-tracker.adconversionevent.category.md) | string | (Optional) Conversion category | -| [conversionId?](./node-tracker.adconversionevent.conversionid.md) | string | (Optional) Identifier for the particular conversion instance | -| [cost?](./node-tracker.adconversionevent.cost.md) | number | (Optional) Advertisement cost | -| [costModel?](./node-tracker.adconversionevent.costmodel.md) | "cpa" \| "cpc" \| "cpm" | (Optional) The cost model for the campaign | -| [initialValue?](./node-tracker.adconversionevent.initialvalue.md) | number | (Optional) How much the conversion is initially worth | -| [property?](./node-tracker.adconversionevent.property.md) | string | (Optional) Describes the object of the conversion | - diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.adconversionevent.property.md b/api-docs/docs/node-tracker/markdown/node-tracker.adconversionevent.property.md deleted file mode 100644 index 620fbd221..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.adconversionevent.property.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AdConversionEvent](./node-tracker.adconversionevent.md) > [property](./node-tracker.adconversionevent.property.md) - -## AdConversionEvent.property property - -Describes the object of the conversion - -Signature: - -```typescript -property?: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.addtocartevent.category.md b/api-docs/docs/node-tracker/markdown/node-tracker.addtocartevent.category.md deleted file mode 100644 index c673cc6da..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.addtocartevent.category.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AddToCartEvent](./node-tracker.addtocartevent.md) > [category](./node-tracker.addtocartevent.category.md) - -## AddToCartEvent.category property - -The category of the product - -Signature: - -```typescript -category?: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.addtocartevent.currency.md b/api-docs/docs/node-tracker/markdown/node-tracker.addtocartevent.currency.md deleted file mode 100644 index e039e4930..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.addtocartevent.currency.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AddToCartEvent](./node-tracker.addtocartevent.md) > [currency](./node-tracker.addtocartevent.currency.md) - -## AddToCartEvent.currency property - -The currency of the product - -Signature: - -```typescript -currency?: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.addtocartevent.md b/api-docs/docs/node-tracker/markdown/node-tracker.addtocartevent.md deleted file mode 100644 index db24e8413..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.addtocartevent.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AddToCartEvent](./node-tracker.addtocartevent.md) - -## AddToCartEvent interface - -An Add To Cart Event For tracking users adding items from a cart on an ecommerce site. - -Signature: - -```typescript -interface AddToCartEvent -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [category?](./node-tracker.addtocartevent.category.md) | string | (Optional) The category of the product | -| [currency?](./node-tracker.addtocartevent.currency.md) | string | (Optional) The currency of the product | -| [name?](./node-tracker.addtocartevent.name.md) | string | (Optional) The name of the product | -| [quantity](./node-tracker.addtocartevent.quantity.md) | number | The number added to the cart | -| [sku](./node-tracker.addtocartevent.sku.md) | string | A Product Stock Keeping Unit (SKU) | -| [unitPrice?](./node-tracker.addtocartevent.unitprice.md) | number | (Optional) The price of the product | - diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.addtocartevent.name.md b/api-docs/docs/node-tracker/markdown/node-tracker.addtocartevent.name.md deleted file mode 100644 index ee05beaa6..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.addtocartevent.name.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AddToCartEvent](./node-tracker.addtocartevent.md) > [name](./node-tracker.addtocartevent.name.md) - -## AddToCartEvent.name property - -The name of the product - -Signature: - -```typescript -name?: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.addtocartevent.quantity.md b/api-docs/docs/node-tracker/markdown/node-tracker.addtocartevent.quantity.md deleted file mode 100644 index faa389463..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.addtocartevent.quantity.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AddToCartEvent](./node-tracker.addtocartevent.md) > [quantity](./node-tracker.addtocartevent.quantity.md) - -## AddToCartEvent.quantity property - -The number added to the cart - -Signature: - -```typescript -quantity: number; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.addtocartevent.sku.md b/api-docs/docs/node-tracker/markdown/node-tracker.addtocartevent.sku.md deleted file mode 100644 index 7812ee51e..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.addtocartevent.sku.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AddToCartEvent](./node-tracker.addtocartevent.md) > [sku](./node-tracker.addtocartevent.sku.md) - -## AddToCartEvent.sku property - -A Product Stock Keeping Unit (SKU) - -Signature: - -```typescript -sku: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.addtocartevent.unitprice.md b/api-docs/docs/node-tracker/markdown/node-tracker.addtocartevent.unitprice.md deleted file mode 100644 index 1004e0b41..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.addtocartevent.unitprice.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AddToCartEvent](./node-tracker.addtocartevent.md) > [unitPrice](./node-tracker.addtocartevent.unitprice.md) - -## AddToCartEvent.unitPrice property - -The price of the product - -Signature: - -```typescript -unitPrice?: number; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.adimpressionevent.advertiserid.md b/api-docs/docs/node-tracker/markdown/node-tracker.adimpressionevent.advertiserid.md deleted file mode 100644 index 714669fd1..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.adimpressionevent.advertiserid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AdImpressionEvent](./node-tracker.adimpressionevent.md) > [advertiserId](./node-tracker.adimpressionevent.advertiserid.md) - -## AdImpressionEvent.advertiserId property - -Identifier for the advertiser which the campaign belongs to - -Signature: - -```typescript -advertiserId?: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.adimpressionevent.bannerid.md b/api-docs/docs/node-tracker/markdown/node-tracker.adimpressionevent.bannerid.md deleted file mode 100644 index 6abc38e9c..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.adimpressionevent.bannerid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AdImpressionEvent](./node-tracker.adimpressionevent.md) > [bannerId](./node-tracker.adimpressionevent.bannerid.md) - -## AdImpressionEvent.bannerId property - -Identifier for the ad banner being displayed - -Signature: - -```typescript -bannerId?: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.adimpressionevent.campaignid.md b/api-docs/docs/node-tracker/markdown/node-tracker.adimpressionevent.campaignid.md deleted file mode 100644 index 295fd04d9..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.adimpressionevent.campaignid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AdImpressionEvent](./node-tracker.adimpressionevent.md) > [campaignId](./node-tracker.adimpressionevent.campaignid.md) - -## AdImpressionEvent.campaignId property - -Identifier for the advertiser which the campaign belongs to - -Signature: - -```typescript -campaignId?: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.adimpressionevent.cost.md b/api-docs/docs/node-tracker/markdown/node-tracker.adimpressionevent.cost.md deleted file mode 100644 index a44fd3ac0..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.adimpressionevent.cost.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AdImpressionEvent](./node-tracker.adimpressionevent.md) > [cost](./node-tracker.adimpressionevent.cost.md) - -## AdImpressionEvent.cost property - -Advertisement cost - -Signature: - -```typescript -cost?: number; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.adimpressionevent.costmodel.md b/api-docs/docs/node-tracker/markdown/node-tracker.adimpressionevent.costmodel.md deleted file mode 100644 index 976c9370a..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.adimpressionevent.costmodel.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AdImpressionEvent](./node-tracker.adimpressionevent.md) > [costModel](./node-tracker.adimpressionevent.costmodel.md) - -## AdImpressionEvent.costModel property - -The cost model for the campaign - -Signature: - -```typescript -costModel?: "cpa" | "cpc" | "cpm"; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.adimpressionevent.impressionid.md b/api-docs/docs/node-tracker/markdown/node-tracker.adimpressionevent.impressionid.md deleted file mode 100644 index 1085dc7f1..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.adimpressionevent.impressionid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AdImpressionEvent](./node-tracker.adimpressionevent.md) > [impressionId](./node-tracker.adimpressionevent.impressionid.md) - -## AdImpressionEvent.impressionId property - -Identifier for the particular impression instance - -Signature: - -```typescript -impressionId?: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.adimpressionevent.md b/api-docs/docs/node-tracker/markdown/node-tracker.adimpressionevent.md deleted file mode 100644 index b1e09a8c9..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.adimpressionevent.md +++ /dev/null @@ -1,31 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AdImpressionEvent](./node-tracker.adimpressionevent.md) - -## AdImpressionEvent interface - -An Ad Impression Event Used to track an advertisement impression - -Signature: - -```typescript -interface AdImpressionEvent -``` - -## Remarks - -If you provide the cost field, you must also provide one of 'cpa', 'cpc', and 'cpm' for the costModel field. - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [advertiserId?](./node-tracker.adimpressionevent.advertiserid.md) | string | (Optional) Identifier for the advertiser which the campaign belongs to | -| [bannerId?](./node-tracker.adimpressionevent.bannerid.md) | string | (Optional) Identifier for the ad banner being displayed | -| [campaignId?](./node-tracker.adimpressionevent.campaignid.md) | string | (Optional) Identifier for the advertiser which the campaign belongs to | -| [cost?](./node-tracker.adimpressionevent.cost.md) | number | (Optional) Advertisement cost | -| [costModel?](./node-tracker.adimpressionevent.costmodel.md) | "cpa" \| "cpc" \| "cpm" | (Optional) The cost model for the campaign | -| [impressionId?](./node-tracker.adimpressionevent.impressionid.md) | string | (Optional) Identifier for the particular impression instance | -| [targetUrl?](./node-tracker.adimpressionevent.targeturl.md) | string | (Optional) The destination URL of the advertisement | -| [zoneId?](./node-tracker.adimpressionevent.zoneid.md) | string | (Optional) Identifier for the zone where the ad banner is located | - diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.adimpressionevent.targeturl.md b/api-docs/docs/node-tracker/markdown/node-tracker.adimpressionevent.targeturl.md deleted file mode 100644 index 969998014..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.adimpressionevent.targeturl.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AdImpressionEvent](./node-tracker.adimpressionevent.md) > [targetUrl](./node-tracker.adimpressionevent.targeturl.md) - -## AdImpressionEvent.targetUrl property - -The destination URL of the advertisement - -Signature: - -```typescript -targetUrl?: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.adimpressionevent.zoneid.md b/api-docs/docs/node-tracker/markdown/node-tracker.adimpressionevent.zoneid.md deleted file mode 100644 index 5a0f779e0..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.adimpressionevent.zoneid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AdImpressionEvent](./node-tracker.adimpressionevent.md) > [zoneId](./node-tracker.adimpressionevent.zoneid.md) - -## AdImpressionEvent.zoneId property - -Identifier for the zone where the ad banner is located - -Signature: - -```typescript -zoneId?: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.buildadclick.md b/api-docs/docs/node-tracker/markdown/node-tracker.buildadclick.md deleted file mode 100644 index 785a252c5..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.buildadclick.md +++ /dev/null @@ -1,30 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [buildAdClick](./node-tracker.buildadclick.md) - -## buildAdClick() function - -Build a Ad Click Event Used to track an advertisement click - -Signature: - -```typescript -declare function buildAdClick(event: AdClickEvent): PayloadBuilder; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | AdClickEvent | Contains the properties for the Ad Click event | - -Returns: - -PayloadBuilder - -PayloadBuilder to be sent to - -## Remarks - -If you provide the cost field, you must also provide one of 'cpa', 'cpc', and 'cpm' for the costModel field. - diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.buildadconversion.md b/api-docs/docs/node-tracker/markdown/node-tracker.buildadconversion.md deleted file mode 100644 index 03f7a9eff..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.buildadconversion.md +++ /dev/null @@ -1,30 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [buildAdConversion](./node-tracker.buildadconversion.md) - -## buildAdConversion() function - -Build a Ad Conversion Event Used to track an advertisement click - -Signature: - -```typescript -declare function buildAdConversion(event: AdConversionEvent): PayloadBuilder; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | AdConversionEvent | Contains the properties for the Ad Conversion event | - -Returns: - -PayloadBuilder - -PayloadBuilder to be sent to - -## Remarks - -If you provide the cost field, you must also provide one of 'cpa', 'cpc', and 'cpm' for the costModel field. - diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.buildaddtocart.md b/api-docs/docs/node-tracker/markdown/node-tracker.buildaddtocart.md deleted file mode 100644 index d03b5d54f..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.buildaddtocart.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [buildAddToCart](./node-tracker.buildaddtocart.md) - -## buildAddToCart() function - -Build a Add To Cart Event For tracking users adding items from a cart on an ecommerce site. - -Signature: - -```typescript -declare function buildAddToCart(event: AddToCartEvent): PayloadBuilder; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | AddToCartEvent | Contains the properties for the Add To Cart event | - -Returns: - -PayloadBuilder - -PayloadBuilder to be sent to - diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.buildadimpression.md b/api-docs/docs/node-tracker/markdown/node-tracker.buildadimpression.md deleted file mode 100644 index 69913bd47..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.buildadimpression.md +++ /dev/null @@ -1,30 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [buildAdImpression](./node-tracker.buildadimpression.md) - -## buildAdImpression() function - -Build a Ad Impression Event Used to track an advertisement impression - -Signature: - -```typescript -declare function buildAdImpression(event: AdImpressionEvent): PayloadBuilder; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | AdImpressionEvent | Contains the properties for the Ad Impression event | - -Returns: - -PayloadBuilder - -PayloadBuilder to be sent to - -## Remarks - -If you provide the cost field, you must also provide one of 'cpa', 'cpc', and 'cpm' for the costModel field. - diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.buildconsentgranted.md b/api-docs/docs/node-tracker/markdown/node-tracker.buildconsentgranted.md deleted file mode 100644 index 8ed40e118..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.buildconsentgranted.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [buildConsentGranted](./node-tracker.buildconsentgranted.md) - -## buildConsentGranted() function - -Build a Consent Granted Event Used for tracking when a user grants their consent - -Signature: - -```typescript -declare function buildConsentGranted(event: ConsentGrantedEvent): EventPayloadAndContext; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | ConsentGrantedEvent | Contains the properties for the Consent Granted event | - -Returns: - -EventPayloadAndContext - -An object containing the PayloadBuilder to be sent to and a 'consent\_document' context - diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.buildconsentwithdrawn.md b/api-docs/docs/node-tracker/markdown/node-tracker.buildconsentwithdrawn.md deleted file mode 100644 index 1c1daff46..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.buildconsentwithdrawn.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [buildConsentWithdrawn](./node-tracker.buildconsentwithdrawn.md) - -## buildConsentWithdrawn() function - -Build a Consent Withdrawn Event Used for tracking when a user withdraws their consent - -Signature: - -```typescript -declare function buildConsentWithdrawn(event: ConsentWithdrawnEvent): EventPayloadAndContext; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | ConsentWithdrawnEvent | Contains the properties for the Consent Withdrawn event | - -Returns: - -EventPayloadAndContext - -An object containing the PayloadBuilder to be sent to and a 'consent\_document' context - diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.buildecommercetransaction.md b/api-docs/docs/node-tracker/markdown/node-tracker.buildecommercetransaction.md deleted file mode 100644 index 3710ec68c..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.buildecommercetransaction.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [buildEcommerceTransaction](./node-tracker.buildecommercetransaction.md) - -## buildEcommerceTransaction() function - -Build an Ecommerce Transaction Event Allows for tracking common ecommerce events, this event is usually used when a consumer completes a transaction. - -Signature: - -```typescript -declare function buildEcommerceTransaction(event: EcommerceTransactionEvent): PayloadBuilder; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | EcommerceTransactionEvent | Contains the properties for the Ecommerce Transactoion event | - -Returns: - -PayloadBuilder - -PayloadBuilder to be sent to - diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.buildecommercetransactionitem.md b/api-docs/docs/node-tracker/markdown/node-tracker.buildecommercetransactionitem.md deleted file mode 100644 index 6454fe481..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.buildecommercetransactionitem.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [buildEcommerceTransactionItem](./node-tracker.buildecommercetransactionitem.md) - -## buildEcommerceTransactionItem() function - -Build an Ecommerce Transaction Item Event Related to the [buildEcommerceTransaction()](./node-tracker.buildecommercetransaction.md) Each Ecommerce Transaction may contain one or more EcommerceTransactionItem events - -Signature: - -```typescript -declare function buildEcommerceTransactionItem(event: EcommerceTransactionItemEvent): PayloadBuilder; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | EcommerceTransactionItemEvent | Contains the properties for the Ecommerce Transaction Item event | - -Returns: - -PayloadBuilder - -PayloadBuilder to be sent to - diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.buildformfocusorchange.md b/api-docs/docs/node-tracker/markdown/node-tracker.buildformfocusorchange.md deleted file mode 100644 index 2e85d8821..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.buildformfocusorchange.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [buildFormFocusOrChange](./node-tracker.buildformfocusorchange.md) - -## buildFormFocusOrChange() function - -Build a Form Focus or Change Form Event based on schema property When a user focuses on a form element or when a user makes a change to a form element. - -Signature: - -```typescript -declare function buildFormFocusOrChange(event: FormFocusOrChangeEvent): PayloadBuilder; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | FormFocusOrChangeEvent | Contains the properties for the Form Focus or Change Form event | - -Returns: - -PayloadBuilder - -PayloadBuilder to be sent to - diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.buildformsubmission.md b/api-docs/docs/node-tracker/markdown/node-tracker.buildformsubmission.md deleted file mode 100644 index 7f25820d9..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.buildformsubmission.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [buildFormSubmission](./node-tracker.buildformsubmission.md) - -## buildFormSubmission() function - -Build a Form Submission Event Used to track when a user submits a form - -Signature: - -```typescript -declare function buildFormSubmission(event: FormSubmissionEvent): PayloadBuilder; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | FormSubmissionEvent | Contains the properties for the Form Submission event | - -Returns: - -PayloadBuilder - -PayloadBuilder to be sent to - diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.buildlinkclick.md b/api-docs/docs/node-tracker/markdown/node-tracker.buildlinkclick.md deleted file mode 100644 index 0d93ee880..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.buildlinkclick.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [buildLinkClick](./node-tracker.buildlinkclick.md) - -## buildLinkClick() function - -Build a Link Click Event Used when a user clicks on a link on a webpage, typically an anchor tag `` - -Signature: - -```typescript -declare function buildLinkClick(event: LinkClickEvent): PayloadBuilder; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | LinkClickEvent | Contains the properties for the Link Click event | - -Returns: - -PayloadBuilder - -PayloadBuilder to be sent to - diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.buildpageping.md b/api-docs/docs/node-tracker/markdown/node-tracker.buildpageping.md deleted file mode 100644 index f72b55146..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.buildpageping.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [buildPagePing](./node-tracker.buildpageping.md) - -## buildPagePing() function - -Build a Page Ping Event Fires when activity tracking is enabled in the browser. Tracks same information as the last tracked Page View and includes scroll information from the current page view - -Signature: - -```typescript -declare function buildPagePing(event: PagePingEvent): PayloadBuilder; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | PagePingEvent | Contains the properties for the Page Ping event | - -Returns: - -PayloadBuilder - -PayloadBuilder to be sent to - diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.buildpageview.md b/api-docs/docs/node-tracker/markdown/node-tracker.buildpageview.md deleted file mode 100644 index 25a198ad1..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.buildpageview.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [buildPageView](./node-tracker.buildpageview.md) - -## buildPageView() function - -Build 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). - -Signature: - -```typescript -declare function buildPageView(event: PageViewEvent): PayloadBuilder; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | PageViewEvent | Contains the properties for the Page View event | - -Returns: - -PayloadBuilder - -PayloadBuilder to be sent to - diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.buildremovefromcart.md b/api-docs/docs/node-tracker/markdown/node-tracker.buildremovefromcart.md deleted file mode 100644 index d9aa28129..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.buildremovefromcart.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [buildRemoveFromCart](./node-tracker.buildremovefromcart.md) - -## buildRemoveFromCart() function - -Build a Remove From Cart Event For tracking users removing items from a cart on an ecommerce site. - -Signature: - -```typescript -declare function buildRemoveFromCart(event: RemoveFromCartEvent): PayloadBuilder; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | RemoveFromCartEvent | Contains the properties for the Remove From Cart event | - -Returns: - -PayloadBuilder - -PayloadBuilder to be sent to - diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.buildscreenview.md b/api-docs/docs/node-tracker/markdown/node-tracker.buildscreenview.md deleted file mode 100644 index 8ead82eac..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.buildscreenview.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [buildScreenView](./node-tracker.buildscreenview.md) - -## buildScreenView() function - -Build a Scren View Event Similar to a Page View but less focused on typical web properties Often used for mobile applications as the user is presented with new views as they performance navigation events - -Signature: - -```typescript -declare function buildScreenView(event: ScreenViewEvent): PayloadBuilder; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | ScreenViewEvent | Contains the properties for the Screen View event. One or more properties must be included. | - -Returns: - -PayloadBuilder - -PayloadBuilder to be sent to - diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.buildselfdescribingevent.md b/api-docs/docs/node-tracker/markdown/node-tracker.buildselfdescribingevent.md deleted file mode 100644 index 4f293a24a..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.buildselfdescribingevent.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [buildSelfDescribingEvent](./node-tracker.buildselfdescribingevent.md) - -## buildSelfDescribingEvent() function - -Build a self-describing event A custom event type, allowing for an event to be tracked using your own custom schema and a data object which conforms to the supplied schema - -Signature: - -```typescript -declare function buildSelfDescribingEvent>(event: SelfDescribingEvent): PayloadBuilder; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | SelfDescribingEvent<T> | Contains the properties and schema location for the event | - -Returns: - -PayloadBuilder - -PayloadBuilder to be sent to - diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.buildsitesearch.md b/api-docs/docs/node-tracker/markdown/node-tracker.buildsitesearch.md deleted file mode 100644 index d974da411..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.buildsitesearch.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [buildSiteSearch](./node-tracker.buildsitesearch.md) - -## buildSiteSearch() function - -Build a Site Search Event Used when a user performs a search action on a page - -Signature: - -```typescript -declare function buildSiteSearch(event: SiteSearchEvent): PayloadBuilder; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | SiteSearchEvent | Contains the properties for the Site Search event | - -Returns: - -PayloadBuilder - -PayloadBuilder to be sent to - diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.buildsocialinteraction.md b/api-docs/docs/node-tracker/markdown/node-tracker.buildsocialinteraction.md deleted file mode 100644 index 1fe5f8d23..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.buildsocialinteraction.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [buildSocialInteraction](./node-tracker.buildsocialinteraction.md) - -## buildSocialInteraction() function - -Build a Social Interaction Event Social tracking will be used to track the way users interact with Facebook, Twitter and Google + widgets e.g. to capture “like this” or “tweet this” events. - -Signature: - -```typescript -declare function buildSocialInteraction(event: SocialInteractionEvent): PayloadBuilder; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | SocialInteractionEvent | Contains the properties for the Social Interaction event | - -Returns: - -PayloadBuilder - -PayloadBuilder to be sent to - diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.buildstructevent.md b/api-docs/docs/node-tracker/markdown/node-tracker.buildstructevent.md deleted file mode 100644 index a7d5ce436..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.buildstructevent.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [buildStructEvent](./node-tracker.buildstructevent.md) - -## buildStructEvent() function - -Build a Structured Event A classic style of event tracking, allows for easier movement between analytics systems. A loosely typed event, creating a Self Describing event is preferred, but useful for interoperability. - -Signature: - -```typescript -declare function buildStructEvent(event: StructuredEvent): PayloadBuilder; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | StructuredEvent | Contains the properties for the Structured event | - -Returns: - -PayloadBuilder - -PayloadBuilder to be sent to - diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.consentgrantedevent.description.md b/api-docs/docs/node-tracker/markdown/node-tracker.consentgrantedevent.description.md deleted file mode 100644 index 5a2897ce7..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.consentgrantedevent.description.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [ConsentGrantedEvent](./node-tracker.consentgrantedevent.md) > [description](./node-tracker.consentgrantedevent.description.md) - -## ConsentGrantedEvent.description property - -Description of the document granting consent - -Signature: - -```typescript -description?: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.consentgrantedevent.expiry.md b/api-docs/docs/node-tracker/markdown/node-tracker.consentgrantedevent.expiry.md deleted file mode 100644 index 7980124c9..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.consentgrantedevent.expiry.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [ConsentGrantedEvent](./node-tracker.consentgrantedevent.md) > [expiry](./node-tracker.consentgrantedevent.expiry.md) - -## ConsentGrantedEvent.expiry property - -When the consent expires - -Signature: - -```typescript -expiry?: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.consentgrantedevent.id.md b/api-docs/docs/node-tracker/markdown/node-tracker.consentgrantedevent.id.md deleted file mode 100644 index e97adbf21..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.consentgrantedevent.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [ConsentGrantedEvent](./node-tracker.consentgrantedevent.md) > [id](./node-tracker.consentgrantedevent.id.md) - -## ConsentGrantedEvent.id property - -Identifier for the document granting consent - -Signature: - -```typescript -id: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.consentgrantedevent.md b/api-docs/docs/node-tracker/markdown/node-tracker.consentgrantedevent.md deleted file mode 100644 index 9a8ca92aa..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.consentgrantedevent.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [ConsentGrantedEvent](./node-tracker.consentgrantedevent.md) - -## ConsentGrantedEvent interface - -A Consent Granted Event Used for tracking when a user grants their consent - -Signature: - -```typescript -interface ConsentGrantedEvent -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [description?](./node-tracker.consentgrantedevent.description.md) | string | (Optional) Description of the document granting consent | -| [expiry?](./node-tracker.consentgrantedevent.expiry.md) | string | (Optional) When the consent expires | -| [id](./node-tracker.consentgrantedevent.id.md) | string | Identifier for the document granting consent | -| [name?](./node-tracker.consentgrantedevent.name.md) | string | (Optional) Name of the document granting consent | -| [version](./node-tracker.consentgrantedevent.version.md) | string | Version of the document granting consent | - diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.consentgrantedevent.name.md b/api-docs/docs/node-tracker/markdown/node-tracker.consentgrantedevent.name.md deleted file mode 100644 index 2f5c1717c..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.consentgrantedevent.name.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [ConsentGrantedEvent](./node-tracker.consentgrantedevent.md) > [name](./node-tracker.consentgrantedevent.name.md) - -## ConsentGrantedEvent.name property - -Name of the document granting consent - -Signature: - -```typescript -name?: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.consentgrantedevent.version.md b/api-docs/docs/node-tracker/markdown/node-tracker.consentgrantedevent.version.md deleted file mode 100644 index f09fa300e..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.consentgrantedevent.version.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [ConsentGrantedEvent](./node-tracker.consentgrantedevent.md) > [version](./node-tracker.consentgrantedevent.version.md) - -## ConsentGrantedEvent.version property - -Version of the document granting consent - -Signature: - -```typescript -version: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.consentwithdrawnevent.all.md b/api-docs/docs/node-tracker/markdown/node-tracker.consentwithdrawnevent.all.md deleted file mode 100644 index 214968a3a..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.consentwithdrawnevent.all.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [ConsentWithdrawnEvent](./node-tracker.consentwithdrawnevent.md) > [all](./node-tracker.consentwithdrawnevent.all.md) - -## ConsentWithdrawnEvent.all property - -Specifies whether all consent should be withdrawn - -Signature: - -```typescript -all: boolean; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.consentwithdrawnevent.description.md b/api-docs/docs/node-tracker/markdown/node-tracker.consentwithdrawnevent.description.md deleted file mode 100644 index 721fd25f3..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.consentwithdrawnevent.description.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [ConsentWithdrawnEvent](./node-tracker.consentwithdrawnevent.md) > [description](./node-tracker.consentwithdrawnevent.description.md) - -## ConsentWithdrawnEvent.description property - -Description of the document withdrawing consent - -Signature: - -```typescript -description?: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.consentwithdrawnevent.id.md b/api-docs/docs/node-tracker/markdown/node-tracker.consentwithdrawnevent.id.md deleted file mode 100644 index 55ce74932..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.consentwithdrawnevent.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [ConsentWithdrawnEvent](./node-tracker.consentwithdrawnevent.md) > [id](./node-tracker.consentwithdrawnevent.id.md) - -## ConsentWithdrawnEvent.id property - -Identifier for the document withdrawing consent - -Signature: - -```typescript -id?: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.consentwithdrawnevent.md b/api-docs/docs/node-tracker/markdown/node-tracker.consentwithdrawnevent.md deleted file mode 100644 index 83ea1e980..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.consentwithdrawnevent.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [ConsentWithdrawnEvent](./node-tracker.consentwithdrawnevent.md) - -## ConsentWithdrawnEvent interface - -A Consent Withdrawn Event Used for tracking when a user withdraws their consent - -Signature: - -```typescript -interface ConsentWithdrawnEvent -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [all](./node-tracker.consentwithdrawnevent.all.md) | boolean | Specifies whether all consent should be withdrawn | -| [description?](./node-tracker.consentwithdrawnevent.description.md) | string | (Optional) Description of the document withdrawing consent | -| [id?](./node-tracker.consentwithdrawnevent.id.md) | string | (Optional) Identifier for the document withdrawing consent | -| [name?](./node-tracker.consentwithdrawnevent.name.md) | string | (Optional) Name of the document withdrawing consent | -| [version?](./node-tracker.consentwithdrawnevent.version.md) | string | (Optional) Version of the document withdrawing consent | - diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.consentwithdrawnevent.name.md b/api-docs/docs/node-tracker/markdown/node-tracker.consentwithdrawnevent.name.md deleted file mode 100644 index eb924a795..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.consentwithdrawnevent.name.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [ConsentWithdrawnEvent](./node-tracker.consentwithdrawnevent.md) > [name](./node-tracker.consentwithdrawnevent.name.md) - -## ConsentWithdrawnEvent.name property - -Name of the document withdrawing consent - -Signature: - -```typescript -name?: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.consentwithdrawnevent.version.md b/api-docs/docs/node-tracker/markdown/node-tracker.consentwithdrawnevent.version.md deleted file mode 100644 index 557356eca..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.consentwithdrawnevent.version.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [ConsentWithdrawnEvent](./node-tracker.consentwithdrawnevent.md) > [version](./node-tracker.consentwithdrawnevent.version.md) - -## ConsentWithdrawnEvent.version property - -Version of the document withdrawing consent - -Signature: - -```typescript -version?: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.contextevent.event.md b/api-docs/docs/node-tracker/markdown/node-tracker.contextevent.event.md deleted file mode 100644 index e7e6dacb8..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.contextevent.event.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [ContextEvent](./node-tracker.contextevent.md) > [event](./node-tracker.contextevent.event.md) - -## ContextEvent.event property - -The event payload - -Signature: - -```typescript -event: Payload; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.contextevent.eventschema.md b/api-docs/docs/node-tracker/markdown/node-tracker.contextevent.eventschema.md deleted file mode 100644 index 6dfc354d8..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.contextevent.eventschema.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [ContextEvent](./node-tracker.contextevent.md) > [eventSchema](./node-tracker.contextevent.eventschema.md) - -## ContextEvent.eventSchema property - -The event schema where one is available, or empty string - -Signature: - -```typescript -eventSchema: string; -``` - -## Example - -'iglu:com.snowplowanalytics.snowplow/ad\_impression/jsonschema/1-0-0' - diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.contextevent.eventtype.md b/api-docs/docs/node-tracker/markdown/node-tracker.contextevent.eventtype.md deleted file mode 100644 index ba6cc94cd..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.contextevent.eventtype.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [ContextEvent](./node-tracker.contextevent.md) > [eventType](./node-tracker.contextevent.eventtype.md) - -## ContextEvent.eventType property - -The event type - -Signature: - -```typescript -eventType: string; -``` - -## Example - -'page\_view' - diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.contextevent.md b/api-docs/docs/node-tracker/markdown/node-tracker.contextevent.md deleted file mode 100644 index 1c30d7d74..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.contextevent.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [ContextEvent](./node-tracker.contextevent.md) - -## ContextEvent interface - -Argument for [ContextGenerator](./node-tracker.contextgenerator.md) and [ContextFilter](./node-tracker.contextfilter.md) callback - -Signature: - -```typescript -interface ContextEvent -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [event](./node-tracker.contextevent.event.md) | Payload | The event payload | -| [eventSchema](./node-tracker.contextevent.eventschema.md) | string | The event schema where one is available, or empty string | -| [eventType](./node-tracker.contextevent.eventtype.md) | string | The event type | - diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.coreconfiguration.base64.md b/api-docs/docs/node-tracker/markdown/node-tracker.coreconfiguration.base64.md deleted file mode 100644 index fe7094e46..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.coreconfiguration.base64.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [CoreConfiguration](./node-tracker.coreconfiguration.md) > [base64](./node-tracker.coreconfiguration.base64.md) - -## CoreConfiguration.base64 property - -Signature: - -```typescript -base64?: boolean; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.coreconfiguration.callback.md b/api-docs/docs/node-tracker/markdown/node-tracker.coreconfiguration.callback.md deleted file mode 100644 index 56c5a063a..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.coreconfiguration.callback.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [CoreConfiguration](./node-tracker.coreconfiguration.md) > [callback](./node-tracker.coreconfiguration.callback.md) - -## CoreConfiguration.callback property - -Signature: - -```typescript -callback?: (PayloadData: PayloadBuilder) => void; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.coreconfiguration.coreplugins.md b/api-docs/docs/node-tracker/markdown/node-tracker.coreconfiguration.coreplugins.md deleted file mode 100644 index 99bbd569d..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.coreconfiguration.coreplugins.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [CoreConfiguration](./node-tracker.coreconfiguration.md) > [corePlugins](./node-tracker.coreconfiguration.coreplugins.md) - -## CoreConfiguration.corePlugins property - -Signature: - -```typescript -corePlugins?: Array; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.coreconfiguration.md b/api-docs/docs/node-tracker/markdown/node-tracker.coreconfiguration.md deleted file mode 100644 index 1db83da79..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.coreconfiguration.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [CoreConfiguration](./node-tracker.coreconfiguration.md) - -## CoreConfiguration interface - -The configuration object for the tracker core library - -Signature: - -```typescript -interface CoreConfiguration -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [base64?](./node-tracker.coreconfiguration.base64.md) | boolean | (Optional) | -| [callback?](./node-tracker.coreconfiguration.callback.md) | (PayloadData: PayloadBuilder) => void | (Optional) | -| [corePlugins?](./node-tracker.coreconfiguration.coreplugins.md) | Array<CorePlugin> | (Optional) | - diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.coreplugin.md b/api-docs/docs/node-tracker/markdown/node-tracker.coreplugin.md deleted file mode 100644 index 65e4f9ae4..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.coreplugin.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [CorePlugin](./node-tracker.coreplugin.md) - -## CorePlugin interface - -Interface which defines Core Plugins - -Signature: - -```typescript -interface CorePlugin -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [activateCorePlugin?](./node-tracker.coreplugin.activatecoreplugin.md) | (core: TrackerCore) => void | (Optional) Called when the plugin is initialised during the trackerCore construction | -| [afterTrack?](./node-tracker.coreplugin.aftertrack.md) | (payload: Payload) => void | (Optional) Called just after the trackerCore callback fires | -| [beforeTrack?](./node-tracker.coreplugin.beforetrack.md) | (payloadBuilder: PayloadBuilder) => void | (Optional) Called before the filter method is called and before the trackerCore callback fires (if the filter passes) | -| [contexts?](./node-tracker.coreplugin.contexts.md) | () => SelfDescribingJson\[\] | (Optional) Called when constructing the context for each event Useful for adding additional context to events | -| [deactivatePlugin?](./node-tracker.coreplugin.deactivateplugin.md) | (core: TrackerCore) => void | (Optional) Called when the tracker is being destroyed. Should be used to clean up any resources or listeners that the plugin has created. | -| [filter?](./node-tracker.coreplugin.filter.md) | (payload: Payload) => boolean | (Optional) Called before the payload is sent to the callback to decide whether to send the payload or skip it | -| [logger?](./node-tracker.coreplugin.logger.md) | (logger: Logger) => void | (Optional) Passed a logger instance which can be used to send log information to the active logger | - diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.corepluginconfiguration.plugin.md b/api-docs/docs/node-tracker/markdown/node-tracker.corepluginconfiguration.plugin.md deleted file mode 100644 index 2aaa9bf92..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.corepluginconfiguration.plugin.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [CorePluginConfiguration](./node-tracker.corepluginconfiguration.md) > [plugin](./node-tracker.corepluginconfiguration.plugin.md) - -## CorePluginConfiguration.plugin property - -Signature: - -```typescript -plugin: CorePlugin; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.customemitter.md b/api-docs/docs/node-tracker/markdown/node-tracker.customemitter.md deleted file mode 100644 index 2d4fa82f9..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.customemitter.md +++ /dev/null @@ -1,14 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [CustomEmitter](./node-tracker.customemitter.md) - -## CustomEmitter type - -Signature: - -```typescript -type CustomEmitter = { - /* Function returning custom Emitter or Emitter[] to be used. If set, other options are irrelevant */ - customEmitter: () => Emitter | Array; -}; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.devicetimestamp.md b/api-docs/docs/node-tracker/markdown/node-tracker.devicetimestamp.md deleted file mode 100644 index f0a53829d..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.devicetimestamp.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [DeviceTimestamp](./node-tracker.devicetimestamp.md) - -## DeviceTimestamp interface - -A representation of a Device Timestamp (dtm) - -Signature: - -```typescript -interface DeviceTimestamp -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [type](./node-tracker.devicetimestamp.type.md) | "dtm" | | -| [value](./node-tracker.devicetimestamp.value.md) | number | | - diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.devicetimestamp.type.md b/api-docs/docs/node-tracker/markdown/node-tracker.devicetimestamp.type.md deleted file mode 100644 index 8e307ef38..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.devicetimestamp.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [DeviceTimestamp](./node-tracker.devicetimestamp.md) > [type](./node-tracker.devicetimestamp.type.md) - -## DeviceTimestamp.type property - -Signature: - -```typescript -readonly type: "dtm"; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.devicetimestamp.value.md b/api-docs/docs/node-tracker/markdown/node-tracker.devicetimestamp.value.md deleted file mode 100644 index 573fa64f2..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.devicetimestamp.value.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [DeviceTimestamp](./node-tracker.devicetimestamp.md) > [value](./node-tracker.devicetimestamp.value.md) - -## DeviceTimestamp.value property - -Signature: - -```typescript -readonly value: number; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.ecommercetransactionevent.affiliation.md b/api-docs/docs/node-tracker/markdown/node-tracker.ecommercetransactionevent.affiliation.md deleted file mode 100644 index d994df3ee..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.ecommercetransactionevent.affiliation.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EcommerceTransactionEvent](./node-tracker.ecommercetransactionevent.md) > [affiliation](./node-tracker.ecommercetransactionevent.affiliation.md) - -## EcommerceTransactionEvent.affiliation property - -Transaction affiliation (e.g. store where sale took place) - -Signature: - -```typescript -affiliation?: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.ecommercetransactionevent.city.md b/api-docs/docs/node-tracker/markdown/node-tracker.ecommercetransactionevent.city.md deleted file mode 100644 index b8782e255..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.ecommercetransactionevent.city.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EcommerceTransactionEvent](./node-tracker.ecommercetransactionevent.md) > [city](./node-tracker.ecommercetransactionevent.city.md) - -## EcommerceTransactionEvent.city property - -Delivery address, city - -Signature: - -```typescript -city?: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.ecommercetransactionevent.country.md b/api-docs/docs/node-tracker/markdown/node-tracker.ecommercetransactionevent.country.md deleted file mode 100644 index cadfddea4..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.ecommercetransactionevent.country.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EcommerceTransactionEvent](./node-tracker.ecommercetransactionevent.md) > [country](./node-tracker.ecommercetransactionevent.country.md) - -## EcommerceTransactionEvent.country property - -Delivery address, country - -Signature: - -```typescript -country?: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.ecommercetransactionevent.currency.md b/api-docs/docs/node-tracker/markdown/node-tracker.ecommercetransactionevent.currency.md deleted file mode 100644 index dc6658910..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.ecommercetransactionevent.currency.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EcommerceTransactionEvent](./node-tracker.ecommercetransactionevent.md) > [currency](./node-tracker.ecommercetransactionevent.currency.md) - -## EcommerceTransactionEvent.currency property - -Currency of the transaction - -Signature: - -```typescript -currency?: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.ecommercetransactionevent.md b/api-docs/docs/node-tracker/markdown/node-tracker.ecommercetransactionevent.md deleted file mode 100644 index 4ad6238cc..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.ecommercetransactionevent.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EcommerceTransactionEvent](./node-tracker.ecommercetransactionevent.md) - -## EcommerceTransactionEvent interface - -An Ecommerce Transaction Event Allows for tracking common ecommerce events, this event is usually used when a customer completes a transaction. - -Signature: - -```typescript -interface EcommerceTransactionEvent -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [affiliation?](./node-tracker.ecommercetransactionevent.affiliation.md) | string | (Optional) Transaction affiliation (e.g. store where sale took place) | -| [city?](./node-tracker.ecommercetransactionevent.city.md) | string | (Optional) Delivery address, city | -| [country?](./node-tracker.ecommercetransactionevent.country.md) | string | (Optional) Delivery address, country | -| [currency?](./node-tracker.ecommercetransactionevent.currency.md) | string | (Optional) Currency of the transaction | -| [orderId](./node-tracker.ecommercetransactionevent.orderid.md) | string | An identifier for the order | -| [shipping?](./node-tracker.ecommercetransactionevent.shipping.md) | number | (Optional) The amount of shipping costs for this transaction | -| [state?](./node-tracker.ecommercetransactionevent.state.md) | string | (Optional) Delivery address, state | -| [tax?](./node-tracker.ecommercetransactionevent.tax.md) | number | (Optional) The amount of tax on the transaction | -| [total](./node-tracker.ecommercetransactionevent.total.md) | number | The total value of the order | - diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.ecommercetransactionevent.orderid.md b/api-docs/docs/node-tracker/markdown/node-tracker.ecommercetransactionevent.orderid.md deleted file mode 100644 index d18cc0704..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.ecommercetransactionevent.orderid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EcommerceTransactionEvent](./node-tracker.ecommercetransactionevent.md) > [orderId](./node-tracker.ecommercetransactionevent.orderid.md) - -## EcommerceTransactionEvent.orderId property - -An identifier for the order - -Signature: - -```typescript -orderId: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.ecommercetransactionevent.shipping.md b/api-docs/docs/node-tracker/markdown/node-tracker.ecommercetransactionevent.shipping.md deleted file mode 100644 index 2c15dbec8..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.ecommercetransactionevent.shipping.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EcommerceTransactionEvent](./node-tracker.ecommercetransactionevent.md) > [shipping](./node-tracker.ecommercetransactionevent.shipping.md) - -## EcommerceTransactionEvent.shipping property - -The amount of shipping costs for this transaction - -Signature: - -```typescript -shipping?: number; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.ecommercetransactionevent.state.md b/api-docs/docs/node-tracker/markdown/node-tracker.ecommercetransactionevent.state.md deleted file mode 100644 index ab136f265..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.ecommercetransactionevent.state.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EcommerceTransactionEvent](./node-tracker.ecommercetransactionevent.md) > [state](./node-tracker.ecommercetransactionevent.state.md) - -## EcommerceTransactionEvent.state property - -Delivery address, state - -Signature: - -```typescript -state?: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.ecommercetransactionevent.tax.md b/api-docs/docs/node-tracker/markdown/node-tracker.ecommercetransactionevent.tax.md deleted file mode 100644 index 59d0f6c6f..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.ecommercetransactionevent.tax.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EcommerceTransactionEvent](./node-tracker.ecommercetransactionevent.md) > [tax](./node-tracker.ecommercetransactionevent.tax.md) - -## EcommerceTransactionEvent.tax property - -The amount of tax on the transaction - -Signature: - -```typescript -tax?: number; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.ecommercetransactionevent.total.md b/api-docs/docs/node-tracker/markdown/node-tracker.ecommercetransactionevent.total.md deleted file mode 100644 index eec8b36bb..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.ecommercetransactionevent.total.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EcommerceTransactionEvent](./node-tracker.ecommercetransactionevent.md) > [total](./node-tracker.ecommercetransactionevent.total.md) - -## EcommerceTransactionEvent.total property - -The total value of the order - -Signature: - -```typescript -total: number; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.ecommercetransactionitemevent.category.md b/api-docs/docs/node-tracker/markdown/node-tracker.ecommercetransactionitemevent.category.md deleted file mode 100644 index 565961252..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.ecommercetransactionitemevent.category.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EcommerceTransactionItemEvent](./node-tracker.ecommercetransactionitemevent.md) > [category](./node-tracker.ecommercetransactionitemevent.category.md) - -## EcommerceTransactionItemEvent.category property - -The category the product belongs to - -Signature: - -```typescript -category?: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.ecommercetransactionitemevent.currency.md b/api-docs/docs/node-tracker/markdown/node-tracker.ecommercetransactionitemevent.currency.md deleted file mode 100644 index 9054c2e57..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.ecommercetransactionitemevent.currency.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EcommerceTransactionItemEvent](./node-tracker.ecommercetransactionitemevent.md) > [currency](./node-tracker.ecommercetransactionitemevent.currency.md) - -## EcommerceTransactionItemEvent.currency property - -The currency of the product for the transaction - -Signature: - -```typescript -currency?: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.ecommercetransactionitemevent.md b/api-docs/docs/node-tracker/markdown/node-tracker.ecommercetransactionitemevent.md deleted file mode 100644 index 726b48866..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.ecommercetransactionitemevent.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EcommerceTransactionItemEvent](./node-tracker.ecommercetransactionitemevent.md) - -## EcommerceTransactionItemEvent interface - -An Ecommerce Transaction Item Related to the [EcommerceTransactionEvent](./node-tracker.ecommercetransactionevent.md) Each Ecommerce Transaction may contain one or more EcommerceTransactionItem events - -Signature: - -```typescript -interface EcommerceTransactionItemEvent -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [category?](./node-tracker.ecommercetransactionitemevent.category.md) | string | (Optional) The category the product belongs to | -| [currency?](./node-tracker.ecommercetransactionitemevent.currency.md) | string | (Optional) The currency of the product for the transaction | -| [name?](./node-tracker.ecommercetransactionitemevent.name.md) | string | (Optional) The name of the product | -| [orderId](./node-tracker.ecommercetransactionitemevent.orderid.md) | string | An identifier for the order | -| [price](./node-tracker.ecommercetransactionitemevent.price.md) | number | The price of the product | -| [quantity?](./node-tracker.ecommercetransactionitemevent.quantity.md) | number | (Optional) The quanity of this product within the transaction | -| [sku](./node-tracker.ecommercetransactionitemevent.sku.md) | string | A Product Stock Keeping Unit (SKU) | - diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.ecommercetransactionitemevent.name.md b/api-docs/docs/node-tracker/markdown/node-tracker.ecommercetransactionitemevent.name.md deleted file mode 100644 index ea68d4a77..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.ecommercetransactionitemevent.name.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EcommerceTransactionItemEvent](./node-tracker.ecommercetransactionitemevent.md) > [name](./node-tracker.ecommercetransactionitemevent.name.md) - -## EcommerceTransactionItemEvent.name property - -The name of the product - -Signature: - -```typescript -name?: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.ecommercetransactionitemevent.orderid.md b/api-docs/docs/node-tracker/markdown/node-tracker.ecommercetransactionitemevent.orderid.md deleted file mode 100644 index e20a39c00..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.ecommercetransactionitemevent.orderid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EcommerceTransactionItemEvent](./node-tracker.ecommercetransactionitemevent.md) > [orderId](./node-tracker.ecommercetransactionitemevent.orderid.md) - -## EcommerceTransactionItemEvent.orderId property - -An identifier for the order - -Signature: - -```typescript -orderId: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.ecommercetransactionitemevent.price.md b/api-docs/docs/node-tracker/markdown/node-tracker.ecommercetransactionitemevent.price.md deleted file mode 100644 index 9cf674c15..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.ecommercetransactionitemevent.price.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EcommerceTransactionItemEvent](./node-tracker.ecommercetransactionitemevent.md) > [price](./node-tracker.ecommercetransactionitemevent.price.md) - -## EcommerceTransactionItemEvent.price property - -The price of the product - -Signature: - -```typescript -price: number; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.ecommercetransactionitemevent.quantity.md b/api-docs/docs/node-tracker/markdown/node-tracker.ecommercetransactionitemevent.quantity.md deleted file mode 100644 index 433b60092..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.ecommercetransactionitemevent.quantity.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EcommerceTransactionItemEvent](./node-tracker.ecommercetransactionitemevent.md) > [quantity](./node-tracker.ecommercetransactionitemevent.quantity.md) - -## EcommerceTransactionItemEvent.quantity property - -The quanity of this product within the transaction - -Signature: - -```typescript -quantity?: number; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.ecommercetransactionitemevent.sku.md b/api-docs/docs/node-tracker/markdown/node-tracker.ecommercetransactionitemevent.sku.md deleted file mode 100644 index 3178268ed..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.ecommercetransactionitemevent.sku.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EcommerceTransactionItemEvent](./node-tracker.ecommercetransactionitemevent.md) > [sku](./node-tracker.ecommercetransactionitemevent.sku.md) - -## EcommerceTransactionItemEvent.sku property - -A Product Stock Keeping Unit (SKU) - -Signature: - -```typescript -sku: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.emitter.md b/api-docs/docs/node-tracker/markdown/node-tracker.emitter.md deleted file mode 100644 index b09554040..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.emitter.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [Emitter](./node-tracker.emitter.md) - -## Emitter interface - -Emitter is responsible for sending events to the collector. It manages the event queue and sends events in batches depending on configuration. - -Signature: - -```typescript -interface Emitter -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [flush](./node-tracker.emitter.flush.md) | () => Promise<void> | Forces the emitter to send all events in the event store to the collector. | -| [input](./node-tracker.emitter.input.md) | (payload: Payload) => Promise<void> | Adds a payload to the event store or sends it to the collector. | -| [setAnonymousTracking](./node-tracker.emitter.setanonymoustracking.md) | (anonymous: boolean) => void | Sets the server anonymization flag. | -| [setBufferSize](./node-tracker.emitter.setbuffersize.md) | (bufferSize: number) => void | Updates the buffer size of the emitter. | -| [setCollectorUrl](./node-tracker.emitter.setcollectorurl.md) | (url: string) => void | Updates the collector URL to which events will be sent. | - diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.emitterconfiguration.endpoint.md b/api-docs/docs/node-tracker/markdown/node-tracker.emitterconfiguration.endpoint.md deleted file mode 100644 index 45a7d2da4..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.emitterconfiguration.endpoint.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EmitterConfiguration](./node-tracker.emitterconfiguration.md) > [endpoint](./node-tracker.emitterconfiguration.endpoint.md) - -## EmitterConfiguration.endpoint property - -Signature: - -```typescript -endpoint: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.emitterconfiguration.md b/api-docs/docs/node-tracker/markdown/node-tracker.emitterconfiguration.md deleted file mode 100644 index 44081c050..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.emitterconfiguration.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EmitterConfiguration](./node-tracker.emitterconfiguration.md) - -## EmitterConfiguration interface - -Signature: - -```typescript -interface EmitterConfiguration extends EmitterConfigurationBase -``` -Extends: EmitterConfigurationBase - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [endpoint](./node-tracker.emitterconfiguration.endpoint.md) | string | | -| [port?](./node-tracker.emitterconfiguration.port.md) | number | (Optional) | -| [protocol?](./node-tracker.emitterconfiguration.protocol.md) | "http" \| "https" | (Optional) | -| [serverAnonymization?](./node-tracker.emitterconfiguration.serveranonymization.md) | boolean | (Optional) | - diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.emitterconfiguration.port.md b/api-docs/docs/node-tracker/markdown/node-tracker.emitterconfiguration.port.md deleted file mode 100644 index 0b9115e49..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.emitterconfiguration.port.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EmitterConfiguration](./node-tracker.emitterconfiguration.md) > [port](./node-tracker.emitterconfiguration.port.md) - -## EmitterConfiguration.port property - -Signature: - -```typescript -port?: number; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.emitterconfiguration.protocol.md b/api-docs/docs/node-tracker/markdown/node-tracker.emitterconfiguration.protocol.md deleted file mode 100644 index 53ddd4abb..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.emitterconfiguration.protocol.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EmitterConfiguration](./node-tracker.emitterconfiguration.md) > [protocol](./node-tracker.emitterconfiguration.protocol.md) - -## EmitterConfiguration.protocol property - -Signature: - -```typescript -protocol?: "http" | "https"; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.emitterconfiguration.serveranonymization.md b/api-docs/docs/node-tracker/markdown/node-tracker.emitterconfiguration.serveranonymization.md deleted file mode 100644 index 99c586940..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.emitterconfiguration.serveranonymization.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EmitterConfiguration](./node-tracker.emitterconfiguration.md) > [serverAnonymization](./node-tracker.emitterconfiguration.serveranonymization.md) - -## EmitterConfiguration.serverAnonymization property - -Signature: - -```typescript -serverAnonymization?: boolean; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.emitterconfigurationbase.connectiontimeout.md b/api-docs/docs/node-tracker/markdown/node-tracker.emitterconfigurationbase.connectiontimeout.md deleted file mode 100644 index 3177ccdd8..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.emitterconfigurationbase.connectiontimeout.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EmitterConfigurationBase](./node-tracker.emitterconfigurationbase.md) > [connectionTimeout](./node-tracker.emitterconfigurationbase.connectiontimeout.md) - -## EmitterConfigurationBase.connectionTimeout property - -How long to wait before aborting requests to the collector - -Signature: - -```typescript -connectionTimeout?: number; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.emitterconfigurationbase.eventmethod.md b/api-docs/docs/node-tracker/markdown/node-tracker.emitterconfigurationbase.eventmethod.md deleted file mode 100644 index cd30544bf..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.emitterconfigurationbase.eventmethod.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EmitterConfigurationBase](./node-tracker.emitterconfigurationbase.md) > [eventMethod](./node-tracker.emitterconfigurationbase.eventmethod.md) - -## EmitterConfigurationBase.eventMethod property - -The preferred technique to use to send events - -Signature: - -```typescript -eventMethod?: EventMethod; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.emitterconfigurationbase.md b/api-docs/docs/node-tracker/markdown/node-tracker.emitterconfigurationbase.md deleted file mode 100644 index 4936a5559..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.emitterconfigurationbase.md +++ /dev/null @@ -1,35 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EmitterConfigurationBase](./node-tracker.emitterconfigurationbase.md) - -## EmitterConfigurationBase interface - -Signature: - -```typescript -interface EmitterConfigurationBase -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [bufferSize?](./node-tracker.emitterconfigurationbase.buffersize.md) | number | (Optional) The amount of events that should be buffered before sending Recommended to leave as 1 to reduce change of losing events | -| [connectionTimeout?](./node-tracker.emitterconfigurationbase.connectiontimeout.md) | number | (Optional) How long to wait before aborting requests to the collector | -| [credentials?](./node-tracker.emitterconfigurationbase.credentials.md) | "omit" \| "same-origin" \| "include" | (Optional) Controls whether or not the browser sends credentials (defaults to 'include') | -| [customFetch?](./node-tracker.emitterconfigurationbase.customfetch.md) | (input: Request, options?: RequestInit) => Promise<Response> | (Optional) Enables overriding the default fetch function with a custom implementation. | -| [customHeaders?](./node-tracker.emitterconfigurationbase.customheaders.md) | Record<string, string> | (Optional) An object of key value pairs which represent headers to attach when sending a POST request, only works for POST | -| [dontRetryStatusCodes?](./node-tracker.emitterconfigurationbase.dontretrystatuscodes.md) | number\[\] | (Optional) List of HTTP response status codes for which events sent to Collector should not be retried in future request. Only non-success status codes are considered (greater or equal to 300). The don't retry codes are only considered for GET and POST requests. By default, the tracker retries on all non-success status codes except for 400, 401, 403, 410, and 422 (these don't retry codes will remain even if you set your own dontRetryStatusCodes but can be changed using the retryStatusCodes). | -| [eventMethod?](./node-tracker.emitterconfigurationbase.eventmethod.md) | EventMethod | (Optional) The preferred technique to use to send events | -| [eventStore?](./node-tracker.emitterconfigurationbase.eventstore.md) | EventStore | (Optional) Enables providing a custom EventStore implementation to store events before sending them to the collector. | -| [idService?](./node-tracker.emitterconfigurationbase.idservice.md) | string | (Optional) Id service full URL. This URL will be added to the queue and will be called using a GET method. This option is there to allow the service URL to be called in order to set any required identifiers e.g. extra cookies.The request respects the anonymousTracking option, including the SP-Anonymous header if needed, and any additional custom headers from the customHeaders option. | -| [keepalive?](./node-tracker.emitterconfigurationbase.keepalive.md) | boolean | (Optional) Indicates that the request should be allowed to outlive the webpage that initiated it. Enables collector requests to complete even if the page is closed or navigated away from. Note: Browsers put a limit on keepalive requests of 64KB. In case of multiple keepalive requests in parallel (may happen in case of multiple trackers), the limit is shared. | -| [maxGetBytes?](./node-tracker.emitterconfigurationbase.maxgetbytes.md) | number | (Optional) The max size a GET request (its complete URL) can be. Requests over this size will be tried as a POST request. | -| [maxPostBytes?](./node-tracker.emitterconfigurationbase.maxpostbytes.md) | number | (Optional) The max size a POST request can be before the tracker will force send it Also dictates the max size of a POST request before a batch of events is split into multiple requests | -| [onRequestFailure?](./node-tracker.emitterconfigurationbase.onrequestfailure.md) | (data: RequestFailure, response?: Response) => void | (Optional) A callback function to be executed whenever a request fails to be sent to the collector. This is the inverse of the onRequestSuccess callback, so any non 2xx status code will trigger this callback. | -| [onRequestSuccess?](./node-tracker.emitterconfigurationbase.onrequestsuccess.md) | (data: EventBatch, response: Response) => void | (Optional) A callback function to be executed whenever a request is successfully sent to the collector. In practice this means any request which returns a 2xx status code will trigger this callback. | -| [postPath?](./node-tracker.emitterconfigurationbase.postpath.md) | string | (Optional) The post path which events will be sent to. Ensure your collector is configured to accept events on this post path | -| [retryFailedRequests?](./node-tracker.emitterconfigurationbase.retryfailedrequests.md) | boolean | (Optional) Whether to retry failed requests to the collector.Failed requests are requests that failed due to \[timeouts\](https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/timeout\_event), \[network errors\](https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/error\_event), and \[abort events\](https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/abort\_event).Takes precedent over retryStatusCodes and dontRetryStatusCodes. | -| [retryStatusCodes?](./node-tracker.emitterconfigurationbase.retrystatuscodes.md) | number\[\] | (Optional) List of HTTP response status codes for which events sent to Collector should be retried in future requests. Only non-success status codes are considered (greater or equal to 300). The retry codes are only considered for GET and POST requests. They take priority over the dontRetryStatusCodes option. By default, the tracker retries on all non-success status codes except for 400, 401, 403, 410, and 422. | -| [useStm?](./node-tracker.emitterconfigurationbase.usestm.md) | boolean | (Optional) Should the Sent Timestamp be attached to events. Only applies for GET events. | - diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.eventpayloadandcontext.event.md b/api-docs/docs/node-tracker/markdown/node-tracker.eventpayloadandcontext.event.md deleted file mode 100644 index 75e3aad07..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.eventpayloadandcontext.event.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EventPayloadAndContext](./node-tracker.eventpayloadandcontext.md) > [event](./node-tracker.eventpayloadandcontext.event.md) - -## EventPayloadAndContext.event property - -Tracker payload for the event data - -Signature: - -```typescript -event: PayloadBuilder; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.eventpayloadandcontext.md b/api-docs/docs/node-tracker/markdown/node-tracker.eventpayloadandcontext.md deleted file mode 100644 index 3f94b70a3..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.eventpayloadandcontext.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EventPayloadAndContext](./node-tracker.eventpayloadandcontext.md) - -## EventPayloadAndContext interface - -Interface for returning a built event (PayloadBuilder) and context (Array of SelfDescribingJson). - -Signature: - -```typescript -interface EventPayloadAndContext -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [context](./node-tracker.eventpayloadandcontext.context.md) | Array<SelfDescribingJson> | List of context entities to track along with the event | -| [event](./node-tracker.eventpayloadandcontext.event.md) | PayloadBuilder | Tracker payload for the event data | - diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.eventstore.md b/api-docs/docs/node-tracker/markdown/node-tracker.eventstore.md deleted file mode 100644 index 88b86e7c4..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.eventstore.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EventStore](./node-tracker.eventstore.md) - -## EventStore interface - -EventStore allows storing and retrieving events before they are sent to the collector - -Signature: - -```typescript -interface EventStore -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [add](./node-tracker.eventstore.add.md) | (payload: EventStorePayload) => Promise<number> | Add an event to the store | -| [count](./node-tracker.eventstore.count.md) | () => Promise<number> | Count all events in the store | -| [getAll](./node-tracker.eventstore.getall.md) | () => Promise<readonly EventStorePayload\[\]> | Retrieve all payloads including their meta configuration in the store | -| [getAllPayloads](./node-tracker.eventstore.getallpayloads.md) | () => Promise<readonly Payload\[\]> | Retrieve all pure payloads in the store | -| [iterator](./node-tracker.eventstore.iterator.md) | () => EventStoreIterator | Get an iterator over all events in the store | -| [removeHead](./node-tracker.eventstore.removehead.md) | (count: number) => Promise<void> | Remove the first count events from the store | - diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.eventstoreconfiguration.maxsize.md b/api-docs/docs/node-tracker/markdown/node-tracker.eventstoreconfiguration.maxsize.md deleted file mode 100644 index 52aaa8357..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.eventstoreconfiguration.maxsize.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EventStoreConfiguration](./node-tracker.eventstoreconfiguration.md) > [maxSize](./node-tracker.eventstoreconfiguration.maxsize.md) - -## EventStoreConfiguration.maxSize property - -The maximum amount of events that will be buffered in the event store - -This is useful to ensure the Tracker doesn't fill the 5MB or 10MB available to each website should the collector be unavailable due to lost connectivity. Will drop old events once the limit is hit - -Signature: - -```typescript -maxSize?: number; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.eventstoreconfiguration.md b/api-docs/docs/node-tracker/markdown/node-tracker.eventstoreconfiguration.md deleted file mode 100644 index 96bc0bee7..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.eventstoreconfiguration.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EventStoreConfiguration](./node-tracker.eventstoreconfiguration.md) - -## EventStoreConfiguration interface - -Signature: - -```typescript -interface EventStoreConfiguration -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [maxSize?](./node-tracker.eventstoreconfiguration.maxsize.md) | number | (Optional) The maximum amount of events that will be buffered in the event storeThis is useful to ensure the Tracker doesn't fill the 5MB or 10MB available to each website should the collector be unavailable due to lost connectivity. Will drop old events once the limit is hit | - diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.eventstoreiterator.md b/api-docs/docs/node-tracker/markdown/node-tracker.eventstoreiterator.md deleted file mode 100644 index 944e7f666..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.eventstoreiterator.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EventStoreIterator](./node-tracker.eventstoreiterator.md) - -## EventStoreIterator interface - -EventStoreIterator allows iterating over all events in the store. - -Signature: - -```typescript -interface EventStoreIterator -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [next](./node-tracker.eventstoreiterator.next.md) | () => Promise<EventStoreIteratorNextResult> | Retrieve the next event in the store | - diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.eventstorepayload.md b/api-docs/docs/node-tracker/markdown/node-tracker.eventstorepayload.md deleted file mode 100644 index df0cbeeae..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.eventstorepayload.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EventStorePayload](./node-tracker.eventstorepayload.md) - -## EventStorePayload interface - -Signature: - -```typescript -interface EventStorePayload -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [payload](./node-tracker.eventstorepayload.payload.md) | Payload | The event payload to be stored | -| [svrAnon?](./node-tracker.eventstorepayload.svranon.md) | boolean | (Optional) If the request should undergo server anonymization. | - diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.eventstorepayload.payload.md b/api-docs/docs/node-tracker/markdown/node-tracker.eventstorepayload.payload.md deleted file mode 100644 index 208ebd71f..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.eventstorepayload.payload.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EventStorePayload](./node-tracker.eventstorepayload.md) > [payload](./node-tracker.eventstorepayload.payload.md) - -## EventStorePayload.payload property - -The event payload to be stored - -Signature: - -```typescript -payload: Payload; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.eventstorepayload.svranon.md b/api-docs/docs/node-tracker/markdown/node-tracker.eventstorepayload.svranon.md deleted file mode 100644 index f35fbcff4..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.eventstorepayload.svranon.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EventStorePayload](./node-tracker.eventstorepayload.md) > [svrAnon](./node-tracker.eventstorepayload.svranon.md) - -## EventStorePayload.svrAnon property - -If the request should undergo server anonymization. - -Signature: - -```typescript -svrAnon?: boolean; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.formelement.md b/api-docs/docs/node-tracker/markdown/node-tracker.formelement.md deleted file mode 100644 index 1e8793c31..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.formelement.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [FormElement](./node-tracker.formelement.md) - -## FormElement type - -A representation of an element within a form - -Signature: - -```typescript -type FormElement = { - name: string; - value: string | null; - nodeName: string; - type?: string | null; -}; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.formfocusorchangeevent.elementclasses.md b/api-docs/docs/node-tracker/markdown/node-tracker.formfocusorchangeevent.elementclasses.md deleted file mode 100644 index 1a14e2505..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.formfocusorchangeevent.elementclasses.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [FormFocusOrChangeEvent](./node-tracker.formfocusorchangeevent.md) > [elementClasses](./node-tracker.formfocusorchangeevent.elementclasses.md) - -## FormFocusOrChangeEvent.elementClasses property - -The class names on the element - -Signature: - -```typescript -elementClasses?: Array | null; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.formfocusorchangeevent.elementid.md b/api-docs/docs/node-tracker/markdown/node-tracker.formfocusorchangeevent.elementid.md deleted file mode 100644 index 17e6a12c2..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.formfocusorchangeevent.elementid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [FormFocusOrChangeEvent](./node-tracker.formfocusorchangeevent.md) > [elementId](./node-tracker.formfocusorchangeevent.elementid.md) - -## FormFocusOrChangeEvent.elementId property - -The element ID which the user is interacting with - -Signature: - -```typescript -elementId: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.formfocusorchangeevent.formid.md b/api-docs/docs/node-tracker/markdown/node-tracker.formfocusorchangeevent.formid.md deleted file mode 100644 index bd2f9d9b3..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.formfocusorchangeevent.formid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [FormFocusOrChangeEvent](./node-tracker.formfocusorchangeevent.md) > [formId](./node-tracker.formfocusorchangeevent.formid.md) - -## FormFocusOrChangeEvent.formId property - -The ID of the form which the element belongs to - -Signature: - -```typescript -formId: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.formfocusorchangeevent.md b/api-docs/docs/node-tracker/markdown/node-tracker.formfocusorchangeevent.md deleted file mode 100644 index af684f575..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.formfocusorchangeevent.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [FormFocusOrChangeEvent](./node-tracker.formfocusorchangeevent.md) - -## FormFocusOrChangeEvent interface - -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. - -Signature: - -```typescript -interface FormFocusOrChangeEvent -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [elementClasses?](./node-tracker.formfocusorchangeevent.elementclasses.md) | Array<string> \| null | (Optional) The class names on the element | -| [elementId](./node-tracker.formfocusorchangeevent.elementid.md) | string | The element ID which the user is interacting with | -| [formId](./node-tracker.formfocusorchangeevent.formid.md) | string | The ID of the form which the element belongs to | -| [nodeName](./node-tracker.formfocusorchangeevent.nodename.md) | string | The name of the node ("INPUT", "TEXTAREA", "SELECT") | -| [schema](./node-tracker.formfocusorchangeevent.schema.md) | "change\_form" \| "focus\_form" | The schema which will be used for the event | -| [type?](./node-tracker.formfocusorchangeevent.type.md) | string \| null | (Optional) The type of element (e.g. "datetime", "text", "radio", etc.) | -| [value](./node-tracker.formfocusorchangeevent.value.md) | string \| null | The value of the element at the time of the event firing | - diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.formfocusorchangeevent.nodename.md b/api-docs/docs/node-tracker/markdown/node-tracker.formfocusorchangeevent.nodename.md deleted file mode 100644 index 74a541da3..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.formfocusorchangeevent.nodename.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [FormFocusOrChangeEvent](./node-tracker.formfocusorchangeevent.md) > [nodeName](./node-tracker.formfocusorchangeevent.nodename.md) - -## FormFocusOrChangeEvent.nodeName property - -The name of the node ("INPUT", "TEXTAREA", "SELECT") - -Signature: - -```typescript -nodeName: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.formfocusorchangeevent.schema.md b/api-docs/docs/node-tracker/markdown/node-tracker.formfocusorchangeevent.schema.md deleted file mode 100644 index 247eb8ead..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.formfocusorchangeevent.schema.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [FormFocusOrChangeEvent](./node-tracker.formfocusorchangeevent.md) > [schema](./node-tracker.formfocusorchangeevent.schema.md) - -## FormFocusOrChangeEvent.schema property - -The schema which will be used for the event - -Signature: - -```typescript -schema: "change_form" | "focus_form"; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.formfocusorchangeevent.value.md b/api-docs/docs/node-tracker/markdown/node-tracker.formfocusorchangeevent.value.md deleted file mode 100644 index a7f34f175..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.formfocusorchangeevent.value.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [FormFocusOrChangeEvent](./node-tracker.formfocusorchangeevent.md) > [value](./node-tracker.formfocusorchangeevent.value.md) - -## FormFocusOrChangeEvent.value property - -The value of the element at the time of the event firing - -Signature: - -```typescript -value: string | null; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.formsubmissionevent.elements.md b/api-docs/docs/node-tracker/markdown/node-tracker.formsubmissionevent.elements.md deleted file mode 100644 index b8b5badaf..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.formsubmissionevent.elements.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [FormSubmissionEvent](./node-tracker.formsubmissionevent.md) > [elements](./node-tracker.formsubmissionevent.elements.md) - -## FormSubmissionEvent.elements property - -The elements contained within the form - -Signature: - -```typescript -elements?: Array; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.formsubmissionevent.formclasses.md b/api-docs/docs/node-tracker/markdown/node-tracker.formsubmissionevent.formclasses.md deleted file mode 100644 index 52bc3040a..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.formsubmissionevent.formclasses.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [FormSubmissionEvent](./node-tracker.formsubmissionevent.md) > [formClasses](./node-tracker.formsubmissionevent.formclasses.md) - -## FormSubmissionEvent.formClasses property - -The class names on the form - -Signature: - -```typescript -formClasses?: Array; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.formsubmissionevent.formid.md b/api-docs/docs/node-tracker/markdown/node-tracker.formsubmissionevent.formid.md deleted file mode 100644 index c87c64433..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.formsubmissionevent.formid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [FormSubmissionEvent](./node-tracker.formsubmissionevent.md) > [formId](./node-tracker.formsubmissionevent.formid.md) - -## FormSubmissionEvent.formId property - -The ID of the form - -Signature: - -```typescript -formId: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.formsubmissionevent.md b/api-docs/docs/node-tracker/markdown/node-tracker.formsubmissionevent.md deleted file mode 100644 index 10a9b5f82..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.formsubmissionevent.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [FormSubmissionEvent](./node-tracker.formsubmissionevent.md) - -## FormSubmissionEvent interface - -A Form Submission Event Used to track when a user submits a form - -Signature: - -```typescript -interface FormSubmissionEvent -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [elements?](./node-tracker.formsubmissionevent.elements.md) | Array<FormElement> | (Optional) The elements contained within the form | -| [formClasses?](./node-tracker.formsubmissionevent.formclasses.md) | Array<string> | (Optional) The class names on the form | -| [formId](./node-tracker.formsubmissionevent.formid.md) | string | The ID of the form | - diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.linkclickevent.elementclasses.md b/api-docs/docs/node-tracker/markdown/node-tracker.linkclickevent.elementclasses.md deleted file mode 100644 index 1e6e5c891..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.linkclickevent.elementclasses.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [LinkClickEvent](./node-tracker.linkclickevent.md) > [elementClasses](./node-tracker.linkclickevent.elementclasses.md) - -## LinkClickEvent.elementClasses property - -An array of class names from the element clicked - -Signature: - -```typescript -elementClasses?: Array; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.linkclickevent.elementcontent.md b/api-docs/docs/node-tracker/markdown/node-tracker.linkclickevent.elementcontent.md deleted file mode 100644 index 3612c2946..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.linkclickevent.elementcontent.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [LinkClickEvent](./node-tracker.linkclickevent.md) > [elementContent](./node-tracker.linkclickevent.elementcontent.md) - -## LinkClickEvent.elementContent property - -The content of the element if present and enabled - -Signature: - -```typescript -elementContent?: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.linkclickevent.elementid.md b/api-docs/docs/node-tracker/markdown/node-tracker.linkclickevent.elementid.md deleted file mode 100644 index b755d563e..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.linkclickevent.elementid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [LinkClickEvent](./node-tracker.linkclickevent.md) > [elementId](./node-tracker.linkclickevent.elementid.md) - -## LinkClickEvent.elementId property - -The ID of the element clicked if present - -Signature: - -```typescript -elementId?: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.linkclickevent.elementtarget.md b/api-docs/docs/node-tracker/markdown/node-tracker.linkclickevent.elementtarget.md deleted file mode 100644 index 8a3f1e7be..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.linkclickevent.elementtarget.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [LinkClickEvent](./node-tracker.linkclickevent.md) > [elementTarget](./node-tracker.linkclickevent.elementtarget.md) - -## LinkClickEvent.elementTarget property - -The target value of the element if present - -Signature: - -```typescript -elementTarget?: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.linkclickevent.md b/api-docs/docs/node-tracker/markdown/node-tracker.linkclickevent.md deleted file mode 100644 index 4ec30914a..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.linkclickevent.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [LinkClickEvent](./node-tracker.linkclickevent.md) - -## LinkClickEvent interface - -A Link Click Event Used when a user clicks on a link on a webpage, typically an anchor tag `` - -Signature: - -```typescript -interface LinkClickEvent -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [elementClasses?](./node-tracker.linkclickevent.elementclasses.md) | Array<string> | (Optional) An array of class names from the element clicked | -| [elementContent?](./node-tracker.linkclickevent.elementcontent.md) | string | (Optional) The content of the element if present and enabled | -| [elementId?](./node-tracker.linkclickevent.elementid.md) | string | (Optional) The ID of the element clicked if present | -| [elementTarget?](./node-tracker.linkclickevent.elementtarget.md) | string | (Optional) The target value of the element if present | -| [targetUrl](./node-tracker.linkclickevent.targeturl.md) | string | The target URL of the link | - diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.linkclickevent.targeturl.md b/api-docs/docs/node-tracker/markdown/node-tracker.linkclickevent.targeturl.md deleted file mode 100644 index f31b90e57..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.linkclickevent.targeturl.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [LinkClickEvent](./node-tracker.linkclickevent.md) > [targetUrl](./node-tracker.linkclickevent.targeturl.md) - -## LinkClickEvent.targetUrl property - -The target URL of the link - -Signature: - -```typescript -targetUrl: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.logger.md b/api-docs/docs/node-tracker/markdown/node-tracker.logger.md deleted file mode 100644 index 9a8937ca1..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.logger.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [Logger](./node-tracker.logger.md) - -## Logger interface - -Signature: - -```typescript -interface Logger -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [debug](./node-tracker.logger.debug.md) | (message: string, ...extraParams: unknown\[\]) => void | | -| [error](./node-tracker.logger.error.md) | (message: string, error?: unknown, ...extraParams: unknown\[\]) => void | | -| [info](./node-tracker.logger.info.md) | (message: string, ...extraParams: unknown\[\]) => void | | -| [setLogLevel](./node-tracker.logger.setloglevel.md) | (level: LOG\_LEVEL) => void | | -| [warn](./node-tracker.logger.warn.md) | (message: string, error?: unknown, ...extraParams: unknown\[\]) => void | | - diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.logger.setloglevel.md b/api-docs/docs/node-tracker/markdown/node-tracker.logger.setloglevel.md deleted file mode 100644 index b08ef823c..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.logger.setloglevel.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [Logger](./node-tracker.logger.md) > [setLogLevel](./node-tracker.logger.setloglevel.md) - -## Logger.setLogLevel property - -Signature: - -```typescript -setLogLevel: (level: LOG_LEVEL) => void; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.md b/api-docs/docs/node-tracker/markdown/node-tracker.md deleted file mode 100644 index c93bdbcac..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.md +++ /dev/null @@ -1,110 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) - -## node-tracker package - -## Enumerations - -| Enumeration | Description | -| --- | --- | -| [LOG\_LEVEL](./node-tracker.log_level.md) | | - -## Functions - -| Function | Description | -| --- | --- | -| [buildAdClick(event)](./node-tracker.buildadclick.md) | Build a Ad Click Event Used to track an advertisement click | -| [buildAdConversion(event)](./node-tracker.buildadconversion.md) | Build a Ad Conversion Event Used to track an advertisement click | -| [buildAddToCart(event)](./node-tracker.buildaddtocart.md) | Build a Add To Cart Event For tracking users adding items from a cart on an ecommerce site. | -| [buildAdImpression(event)](./node-tracker.buildadimpression.md) | Build a Ad Impression Event Used to track an advertisement impression | -| [buildConsentGranted(event)](./node-tracker.buildconsentgranted.md) | Build a Consent Granted Event Used for tracking when a user grants their consent | -| [buildConsentWithdrawn(event)](./node-tracker.buildconsentwithdrawn.md) | Build a Consent Withdrawn Event Used for tracking when a user withdraws their consent | -| [buildEcommerceTransaction(event)](./node-tracker.buildecommercetransaction.md) | Build an Ecommerce Transaction Event Allows for tracking common ecommerce events, this event is usually used when a consumer completes a transaction. | -| [buildEcommerceTransactionItem(event)](./node-tracker.buildecommercetransactionitem.md) | Build an Ecommerce Transaction Item Event Related to the [buildEcommerceTransaction()](./node-tracker.buildecommercetransaction.md) Each Ecommerce Transaction may contain one or more EcommerceTransactionItem events | -| [buildFormFocusOrChange(event)](./node-tracker.buildformfocusorchange.md) | Build a Form Focus or Change Form Event based on schema property When a user focuses on a form element or when a user makes a change to a form element. | -| [buildFormSubmission(event)](./node-tracker.buildformsubmission.md) | Build a Form Submission Event Used to track when a user submits a form | -| [buildLinkClick(event)](./node-tracker.buildlinkclick.md) | Build a Link Click Event Used when a user clicks on a link on a webpage, typically an anchor tag <a> | -| [buildPagePing(event)](./node-tracker.buildpageping.md) | Build a Page Ping Event Fires when activity tracking is enabled in the browser. Tracks same information as the last tracked Page View and includes scroll information from the current page view | -| [buildPageView(event)](./node-tracker.buildpageview.md) | Build 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). | -| [buildRemoveFromCart(event)](./node-tracker.buildremovefromcart.md) | Build a Remove From Cart Event For tracking users removing items from a cart on an ecommerce site. | -| [buildScreenView(event)](./node-tracker.buildscreenview.md) | Build a Scren View Event Similar to a Page View but less focused on typical web properties Often used for mobile applications as the user is presented with new views as they performance navigation events | -| [buildSelfDescribingEvent(event)](./node-tracker.buildselfdescribingevent.md) | Build a self-describing event A custom event type, allowing for an event to be tracked using your own custom schema and a data object which conforms to the supplied schema | -| [buildSiteSearch(event)](./node-tracker.buildsitesearch.md) | Build a Site Search Event Used when a user performs a search action on a page | -| [buildSocialInteraction(event)](./node-tracker.buildsocialinteraction.md) | Build a Social Interaction Event Social tracking will be used to track the way users interact with Facebook, Twitter and Google + widgets e.g. to capture “like this” or “tweet this” events. | -| [buildStructEvent(event)](./node-tracker.buildstructevent.md) | Build a Structured Event A classic style of event tracking, allows for easier movement between analytics systems. A loosely typed event, creating a Self Describing event is preferred, but useful for interoperability. | -| [newTracker(trackerConfiguration, emitterConfiguration)](./node-tracker.newtracker.md) | | - -## Interfaces - -| Interface | Description | -| --- | --- | -| [AdClickEvent](./node-tracker.adclickevent.md) | An Ad Click Event Used to track an advertisement click | -| [AdConversionEvent](./node-tracker.adconversionevent.md) | An Ad Conversion Event Used to track an advertisement click | -| [AddToCartEvent](./node-tracker.addtocartevent.md) | An Add To Cart Event For tracking users adding items from a cart on an ecommerce site. | -| [AdImpressionEvent](./node-tracker.adimpressionevent.md) | An Ad Impression Event Used to track an advertisement impression | -| [ConsentGrantedEvent](./node-tracker.consentgrantedevent.md) | A Consent Granted Event Used for tracking when a user grants their consent | -| [ConsentWithdrawnEvent](./node-tracker.consentwithdrawnevent.md) | A Consent Withdrawn Event Used for tracking when a user withdraws their consent | -| [ContextEvent](./node-tracker.contextevent.md) | Argument for [ContextGenerator](./node-tracker.contextgenerator.md) and [ContextFilter](./node-tracker.contextfilter.md) callback | -| [CoreConfiguration](./node-tracker.coreconfiguration.md) | The configuration object for the tracker core library | -| [CorePlugin](./node-tracker.coreplugin.md) | Interface which defines Core Plugins | -| [CorePluginConfiguration](./node-tracker.corepluginconfiguration.md) | The configuration of the plugin to add | -| [DeviceTimestamp](./node-tracker.devicetimestamp.md) | A representation of a Device Timestamp (dtm) | -| [EcommerceTransactionEvent](./node-tracker.ecommercetransactionevent.md) | An Ecommerce Transaction Event Allows for tracking common ecommerce events, this event is usually used when a customer completes a transaction. | -| [EcommerceTransactionItemEvent](./node-tracker.ecommercetransactionitemevent.md) | An Ecommerce Transaction Item Related to the [EcommerceTransactionEvent](./node-tracker.ecommercetransactionevent.md) Each Ecommerce Transaction may contain one or more EcommerceTransactionItem events | -| [Emitter](./node-tracker.emitter.md) | Emitter is responsible for sending events to the collector. It manages the event queue and sends events in batches depending on configuration. | -| [EmitterConfiguration](./node-tracker.emitterconfiguration.md) | | -| [EmitterConfigurationBase](./node-tracker.emitterconfigurationbase.md) | | -| [EventPayloadAndContext](./node-tracker.eventpayloadandcontext.md) | Interface for returning a built event (PayloadBuilder) and context (Array of SelfDescribingJson). | -| [EventStore](./node-tracker.eventstore.md) | EventStore allows storing and retrieving events before they are sent to the collector | -| [EventStoreConfiguration](./node-tracker.eventstoreconfiguration.md) | | -| [EventStoreIterator](./node-tracker.eventstoreiterator.md) | EventStoreIterator allows iterating over all events in the store. | -| [EventStorePayload](./node-tracker.eventstorepayload.md) | | -| [FormFocusOrChangeEvent](./node-tracker.formfocusorchangeevent.md) | 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. | -| [FormSubmissionEvent](./node-tracker.formsubmissionevent.md) | A Form Submission Event Used to track when a user submits a form | -| [LinkClickEvent](./node-tracker.linkclickevent.md) | A Link Click Event Used when a user clicks on a link on a webpage, typically an anchor tag <a> | -| [Logger](./node-tracker.logger.md) | | -| [PagePingEvent](./node-tracker.pagepingevent.md) | A Page Ping Event Fires when activity tracking is enabled in the browser. Tracks same information as the last tracked Page View and includes scroll information from the current page view | -| [PageViewEvent](./node-tracker.pageviewevent.md) | 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](./node-tracker.payloadbuilder.md) | Interface for mutable object encapsulating tracker payload | -| [RemoveFromCartEvent](./node-tracker.removefromcartevent.md) | An Remove To Cart Event For tracking users removing items from a cart on an ecommerce site. | -| [RuleSet](./node-tracker.ruleset.md) | A ruleset has accept or reject properties that contain rules for matching Iglu schema URIs | -| [ScreenViewEvent](./node-tracker.screenviewevent.md) | A Screen View Event Similar to a Page View but less focused on typical web properties Often used for mobile applications as the user is presented with new views as they performance navigation events | -| [SelfDescribingEvent](./node-tracker.selfdescribingevent.md) | A Self Describing Event A custom event type, allowing for an event to be tracked using your own custom schema and a data object which conforms to the supplied schema | -| [SiteSearchEvent](./node-tracker.sitesearchevent.md) | A Site Search Event Used when a user performs a search action on a page | -| [SocialInteractionEvent](./node-tracker.socialinteractionevent.md) | A Social Interaction Event Social tracking will be used to track the way users interact with Facebook, Twitter and Google + widgets e.g. to capture “like this” or “tweet this” events. | -| [StructuredEvent](./node-tracker.structuredevent.md) | A Structured Event A classic style of event tracking, allows for easier movement between analytics systems. A loosely typed event, creating a Self Describing event is preferred, but useful for interoperability. | -| [Tracker](./node-tracker.tracker.md) | | -| [TrackerConfiguration](./node-tracker.trackerconfiguration.md) | | -| [TrackerCore](./node-tracker.trackercore.md) | Export interface containing all Core functions | -| [TrueTimestamp](./node-tracker.truetimestamp.md) | A representation of a True Timestamp (ttm) | - -## Variables - -| Variable | Description | -| --- | --- | -| [version](./node-tracker.version.md) | | - -## Type Aliases - -| Type Alias | Description | -| --- | --- | -| [ConditionalContextProvider](./node-tracker.conditionalcontextprovider.md) | 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](./node-tracker.contextfilter.md) | 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](./node-tracker.contextgenerator.md) | 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](./node-tracker.contextprimitive.md) | A context primitive is either a self-describing JSON or a context generator | -| [CustomEmitter](./node-tracker.customemitter.md) | | -| [EventBatch](./node-tracker.eventbatch.md) | A collection of event payloads which are sent to the collector. | -| [EventJson](./node-tracker.eventjson.md) | An array of tuples which represents the unprocessed JSON to be added to the Payload | -| [EventJsonWithKeys](./node-tracker.eventjsonwithkeys.md) | A tuple which represents the unprocessed JSON to be added to the Payload | -| [EventMethod](./node-tracker.eventmethod.md) | | -| [FilterProvider](./node-tracker.filterprovider.md) | 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) | -| [FormElement](./node-tracker.formelement.md) | A representation of an element within a form | -| [JsonProcessor](./node-tracker.jsonprocessor.md) | A function which will processor the Json onto the injected PayloadBuilder | -| [NodeEmitterConfiguration](./node-tracker.nodeemitterconfiguration.md) | | -| [Payload](./node-tracker.payload.md) | Type for a Payload dictionary | -| [RequestFailure](./node-tracker.requestfailure.md) | The data that will be available to the onRequestFailure callback | -| [RuleSetProvider](./node-tracker.rulesetprovider.md) | 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) | -| [SelfDescribingJson](./node-tracker.selfdescribingjson.md) | Export interface for any Self-Describing JSON such as context or Self Describing events | -| [Timestamp](./node-tracker.timestamp.md) | Algebraic datatype representing possible timestamp type choice | - diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.newtracker.md b/api-docs/docs/node-tracker/markdown/node-tracker.newtracker.md deleted file mode 100644 index 380cb6c16..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.newtracker.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [newTracker](./node-tracker.newtracker.md) - -## newTracker() function - -Signature: - -```typescript -declare function newTracker(trackerConfiguration: TrackerConfiguration, emitterConfiguration: NodeEmitterConfiguration | NodeEmitterConfiguration[]): Tracker; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| trackerConfiguration | TrackerConfiguration | | -| emitterConfiguration | NodeEmitterConfiguration \| NodeEmitterConfiguration\[\] | | - -Returns: - -Tracker - diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.nodeemitterconfiguration.md b/api-docs/docs/node-tracker/markdown/node-tracker.nodeemitterconfiguration.md deleted file mode 100644 index 258018399..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.nodeemitterconfiguration.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [NodeEmitterConfiguration](./node-tracker.nodeemitterconfiguration.md) - -## NodeEmitterConfiguration type - -Signature: - -```typescript -type NodeEmitterConfiguration = CustomEmitter | EmitterConfiguration; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.pagepingevent.maxxoffset.md b/api-docs/docs/node-tracker/markdown/node-tracker.pagepingevent.maxxoffset.md deleted file mode 100644 index d34b5f1ed..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.pagepingevent.maxxoffset.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [PagePingEvent](./node-tracker.pagepingevent.md) > [maxXOffset](./node-tracker.pagepingevent.maxxoffset.md) - -## PagePingEvent.maxXOffset property - -The maximum X scroll position for the current page view - -Signature: - -```typescript -maxXOffset?: number; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.pagepingevent.maxyoffset.md b/api-docs/docs/node-tracker/markdown/node-tracker.pagepingevent.maxyoffset.md deleted file mode 100644 index 06ccfd1fa..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.pagepingevent.maxyoffset.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [PagePingEvent](./node-tracker.pagepingevent.md) > [maxYOffset](./node-tracker.pagepingevent.maxyoffset.md) - -## PagePingEvent.maxYOffset property - -The maximum Y scroll position for the current page view - -Signature: - -```typescript -maxYOffset?: number; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.pagepingevent.md b/api-docs/docs/node-tracker/markdown/node-tracker.pagepingevent.md deleted file mode 100644 index 70195df4e..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.pagepingevent.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [PagePingEvent](./node-tracker.pagepingevent.md) - -## PagePingEvent interface - -A Page Ping Event Fires when activity tracking is enabled in the browser. Tracks same information as the last tracked Page View and includes scroll information from the current page view - -Signature: - -```typescript -interface PagePingEvent extends PageViewEvent -``` -Extends: PageViewEvent - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [maxXOffset?](./node-tracker.pagepingevent.maxxoffset.md) | number | (Optional) The maximum X scroll position for the current page view | -| [maxYOffset?](./node-tracker.pagepingevent.maxyoffset.md) | number | (Optional) The maximum Y scroll position for the current page view | -| [minXOffset?](./node-tracker.pagepingevent.minxoffset.md) | number | (Optional) The minimum X scroll position for the current page view | -| [minYOffset?](./node-tracker.pagepingevent.minyoffset.md) | number | (Optional) The minimum Y scroll position for the current page view | - diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.pagepingevent.minxoffset.md b/api-docs/docs/node-tracker/markdown/node-tracker.pagepingevent.minxoffset.md deleted file mode 100644 index 5b54313d6..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.pagepingevent.minxoffset.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [PagePingEvent](./node-tracker.pagepingevent.md) > [minXOffset](./node-tracker.pagepingevent.minxoffset.md) - -## PagePingEvent.minXOffset property - -The minimum X scroll position for the current page view - -Signature: - -```typescript -minXOffset?: number; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.pagepingevent.minyoffset.md b/api-docs/docs/node-tracker/markdown/node-tracker.pagepingevent.minyoffset.md deleted file mode 100644 index ea3e5a487..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.pagepingevent.minyoffset.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [PagePingEvent](./node-tracker.pagepingevent.md) > [minYOffset](./node-tracker.pagepingevent.minyoffset.md) - -## PagePingEvent.minYOffset property - -The minimum Y scroll position for the current page view - -Signature: - -```typescript -minYOffset?: number; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.pageviewevent.md b/api-docs/docs/node-tracker/markdown/node-tracker.pageviewevent.md deleted file mode 100644 index 68379fae6..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.pageviewevent.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [PageViewEvent](./node-tracker.pageviewevent.md) - -## PageViewEvent interface - -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). - -Signature: - -```typescript -interface PageViewEvent -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [pageTitle?](./node-tracker.pageviewevent.pagetitle.md) | string \| null | (Optional) The current page title in the users browser | -| [pageUrl?](./node-tracker.pageviewevent.pageurl.md) | string \| null | (Optional) The current URL visible in the users browser | -| [referrer?](./node-tracker.pageviewevent.referrer.md) | string \| null | (Optional) The URL of the referring page | - diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.pageviewevent.referrer.md b/api-docs/docs/node-tracker/markdown/node-tracker.pageviewevent.referrer.md deleted file mode 100644 index 510d0ba44..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.pageviewevent.referrer.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [PageViewEvent](./node-tracker.pageviewevent.md) > [referrer](./node-tracker.pageviewevent.referrer.md) - -## PageViewEvent.referrer property - -The URL of the referring page - -Signature: - -```typescript -referrer?: string | null; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.payloadbuilder.build.md b/api-docs/docs/node-tracker/markdown/node-tracker.payloadbuilder.build.md deleted file mode 100644 index da0bc05e3..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.payloadbuilder.build.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [PayloadBuilder](./node-tracker.payloadbuilder.md) > [build](./node-tracker.payloadbuilder.build.md) - -## PayloadBuilder.build property - -Builds and returns the Payload - -Signature: - -```typescript -build: () => Payload; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.payloadbuilder.getjson.md b/api-docs/docs/node-tracker/markdown/node-tracker.payloadbuilder.getjson.md deleted file mode 100644 index 515efac39..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.payloadbuilder.getjson.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [PayloadBuilder](./node-tracker.payloadbuilder.md) > [getJson](./node-tracker.payloadbuilder.getjson.md) - -## PayloadBuilder.getJson property - -Gets all JSON objects added to payload - -Signature: - -```typescript -getJson: () => EventJson; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.payloadbuilder.md b/api-docs/docs/node-tracker/markdown/node-tracker.payloadbuilder.md deleted file mode 100644 index ecda8875f..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.payloadbuilder.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [PayloadBuilder](./node-tracker.payloadbuilder.md) - -## PayloadBuilder interface - -Interface for mutable object encapsulating tracker payload - -Signature: - -```typescript -interface PayloadBuilder -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [add](./node-tracker.payloadbuilder.add.md) | (key: string, value: unknown) => void | Adds an entry to the Payload | -| [addContextEntity](./node-tracker.payloadbuilder.addcontextentity.md) | (entity: SelfDescribingJson) => void | Caches a context entity to be added to payload on build | -| [addDict](./node-tracker.payloadbuilder.adddict.md) | (dict: Payload) => void | Merges a payload into the existing payload | -| [addJson](./node-tracker.payloadbuilder.addjson.md) | (keyIfEncoded: string, keyIfNotEncoded: string, json: Record<string, unknown>) => void | Caches a JSON object to be added to payload on build | -| [build](./node-tracker.payloadbuilder.build.md) | () => Payload | Builds and returns the Payload | -| [getJson](./node-tracker.payloadbuilder.getjson.md) | () => EventJson | Gets all JSON objects added to payload | -| [getPayload](./node-tracker.payloadbuilder.getpayload.md) | () => Payload | Gets the current payload, before cached JSON is processed | -| [withJsonProcessor](./node-tracker.payloadbuilder.withjsonprocessor.md) | (jsonProcessor: JsonProcessor) => void | Adds a function which will be executed when building the payload to process the JSON which has been added to this payload | - diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.removefromcartevent.category.md b/api-docs/docs/node-tracker/markdown/node-tracker.removefromcartevent.category.md deleted file mode 100644 index 78fd85461..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.removefromcartevent.category.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [RemoveFromCartEvent](./node-tracker.removefromcartevent.md) > [category](./node-tracker.removefromcartevent.category.md) - -## RemoveFromCartEvent.category property - -The category of the product - -Signature: - -```typescript -category?: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.removefromcartevent.currency.md b/api-docs/docs/node-tracker/markdown/node-tracker.removefromcartevent.currency.md deleted file mode 100644 index 49749c5dc..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.removefromcartevent.currency.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [RemoveFromCartEvent](./node-tracker.removefromcartevent.md) > [currency](./node-tracker.removefromcartevent.currency.md) - -## RemoveFromCartEvent.currency property - -The currency of the product - -Signature: - -```typescript -currency?: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.removefromcartevent.md b/api-docs/docs/node-tracker/markdown/node-tracker.removefromcartevent.md deleted file mode 100644 index 2ce7163be..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.removefromcartevent.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [RemoveFromCartEvent](./node-tracker.removefromcartevent.md) - -## RemoveFromCartEvent interface - -An Remove To Cart Event For tracking users removing items from a cart on an ecommerce site. - -Signature: - -```typescript -interface RemoveFromCartEvent -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [category?](./node-tracker.removefromcartevent.category.md) | string | (Optional) The category of the product | -| [currency?](./node-tracker.removefromcartevent.currency.md) | string | (Optional) The currency of the product | -| [name?](./node-tracker.removefromcartevent.name.md) | string | (Optional) The name of the product | -| [quantity](./node-tracker.removefromcartevent.quantity.md) | number | The number removed from the cart | -| [sku](./node-tracker.removefromcartevent.sku.md) | string | A Product Stock Keeping Unit (SKU) | -| [unitPrice?](./node-tracker.removefromcartevent.unitprice.md) | number | (Optional) The price of the product | - diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.removefromcartevent.name.md b/api-docs/docs/node-tracker/markdown/node-tracker.removefromcartevent.name.md deleted file mode 100644 index f7fb450b1..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.removefromcartevent.name.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [RemoveFromCartEvent](./node-tracker.removefromcartevent.md) > [name](./node-tracker.removefromcartevent.name.md) - -## RemoveFromCartEvent.name property - -The name of the product - -Signature: - -```typescript -name?: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.removefromcartevent.quantity.md b/api-docs/docs/node-tracker/markdown/node-tracker.removefromcartevent.quantity.md deleted file mode 100644 index 718048c88..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.removefromcartevent.quantity.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [RemoveFromCartEvent](./node-tracker.removefromcartevent.md) > [quantity](./node-tracker.removefromcartevent.quantity.md) - -## RemoveFromCartEvent.quantity property - -The number removed from the cart - -Signature: - -```typescript -quantity: number; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.removefromcartevent.sku.md b/api-docs/docs/node-tracker/markdown/node-tracker.removefromcartevent.sku.md deleted file mode 100644 index f8314446e..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.removefromcartevent.sku.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [RemoveFromCartEvent](./node-tracker.removefromcartevent.md) > [sku](./node-tracker.removefromcartevent.sku.md) - -## RemoveFromCartEvent.sku property - -A Product Stock Keeping Unit (SKU) - -Signature: - -```typescript -sku: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.removefromcartevent.unitprice.md b/api-docs/docs/node-tracker/markdown/node-tracker.removefromcartevent.unitprice.md deleted file mode 100644 index db5c2bf06..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.removefromcartevent.unitprice.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [RemoveFromCartEvent](./node-tracker.removefromcartevent.md) > [unitPrice](./node-tracker.removefromcartevent.unitprice.md) - -## RemoveFromCartEvent.unitPrice property - -The price of the product - -Signature: - -```typescript -unitPrice?: number; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.ruleset.accept.md b/api-docs/docs/node-tracker/markdown/node-tracker.ruleset.accept.md deleted file mode 100644 index 2c29e5003..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.ruleset.accept.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [RuleSet](./node-tracker.ruleset.md) > [accept](./node-tracker.ruleset.accept.md) - -## RuleSet.accept property - -Signature: - -```typescript -accept?: Array | string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.ruleset.md b/api-docs/docs/node-tracker/markdown/node-tracker.ruleset.md deleted file mode 100644 index 451a5a5dd..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.ruleset.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [RuleSet](./node-tracker.ruleset.md) - -## RuleSet interface - -A ruleset has accept or reject properties that contain rules for matching Iglu schema URIs - -Signature: - -```typescript -interface RuleSet -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [accept?](./node-tracker.ruleset.accept.md) | Array<string> \| string | (Optional) | -| [reject?](./node-tracker.ruleset.reject.md) | Array<string> \| string | (Optional) | - diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.ruleset.reject.md b/api-docs/docs/node-tracker/markdown/node-tracker.ruleset.reject.md deleted file mode 100644 index 393a8b016..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.ruleset.reject.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [RuleSet](./node-tracker.ruleset.md) > [reject](./node-tracker.ruleset.reject.md) - -## RuleSet.reject property - -Signature: - -```typescript -reject?: Array | string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.screenviewevent.id.md b/api-docs/docs/node-tracker/markdown/node-tracker.screenviewevent.id.md deleted file mode 100644 index 5d48b9793..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.screenviewevent.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [ScreenViewEvent](./node-tracker.screenviewevent.md) > [id](./node-tracker.screenviewevent.id.md) - -## ScreenViewEvent.id property - -The identifier of the screen - -Signature: - -```typescript -id?: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.screenviewevent.md b/api-docs/docs/node-tracker/markdown/node-tracker.screenviewevent.md deleted file mode 100644 index 7ae8e119f..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.screenviewevent.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [ScreenViewEvent](./node-tracker.screenviewevent.md) - -## ScreenViewEvent interface - -A Screen View Event Similar to a Page View but less focused on typical web properties Often used for mobile applications as the user is presented with new views as they performance navigation events - -Signature: - -```typescript -interface ScreenViewEvent -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [id?](./node-tracker.screenviewevent.id.md) | string | (Optional) The identifier of the screen | -| [name?](./node-tracker.screenviewevent.name.md) | string | (Optional) The name of the screen | - diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.screenviewevent.name.md b/api-docs/docs/node-tracker/markdown/node-tracker.screenviewevent.name.md deleted file mode 100644 index 698ad7b77..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.screenviewevent.name.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [ScreenViewEvent](./node-tracker.screenviewevent.md) > [name](./node-tracker.screenviewevent.name.md) - -## ScreenViewEvent.name property - -The name of the screen - -Signature: - -```typescript -name?: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.selfdescribingevent.event.md b/api-docs/docs/node-tracker/markdown/node-tracker.selfdescribingevent.event.md deleted file mode 100644 index d66b67808..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.selfdescribingevent.event.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [SelfDescribingEvent](./node-tracker.selfdescribingevent.md) > [event](./node-tracker.selfdescribingevent.event.md) - -## SelfDescribingEvent.event property - -The Self Describing JSON which describes the event - -Signature: - -```typescript -event: SelfDescribingJson; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.selfdescribingevent.md b/api-docs/docs/node-tracker/markdown/node-tracker.selfdescribingevent.md deleted file mode 100644 index 47653d298..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.selfdescribingevent.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [SelfDescribingEvent](./node-tracker.selfdescribingevent.md) - -## SelfDescribingEvent interface - -A Self Describing Event A custom event type, allowing for an event to be tracked using your own custom schema and a data object which conforms to the supplied schema - -Signature: - -```typescript -interface SelfDescribingEvent> -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [event](./node-tracker.selfdescribingevent.event.md) | SelfDescribingJson<T> | The Self Describing JSON which describes the event | - diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.selfdescribingjson.md b/api-docs/docs/node-tracker/markdown/node-tracker.selfdescribingjson.md deleted file mode 100644 index 14c5d7379..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.selfdescribingjson.md +++ /dev/null @@ -1,16 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [SelfDescribingJson](./node-tracker.selfdescribingjson.md) - -## SelfDescribingJson type - -Export interface for any Self-Describing JSON such as context or Self Describing events - -Signature: - -```typescript -type SelfDescribingJson> = { - schema: string; - data: T extends any[] ? never : T extends {} ? T : never; -}; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.sitesearchevent.filters.md b/api-docs/docs/node-tracker/markdown/node-tracker.sitesearchevent.filters.md deleted file mode 100644 index e963f101d..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.sitesearchevent.filters.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [SiteSearchEvent](./node-tracker.sitesearchevent.md) > [filters](./node-tracker.sitesearchevent.filters.md) - -## SiteSearchEvent.filters property - -Any filters which have been applied to the search - -Signature: - -```typescript -filters?: Record; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.sitesearchevent.md b/api-docs/docs/node-tracker/markdown/node-tracker.sitesearchevent.md deleted file mode 100644 index b412bbd27..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.sitesearchevent.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [SiteSearchEvent](./node-tracker.sitesearchevent.md) - -## SiteSearchEvent interface - -A Site Search Event Used when a user performs a search action on a page - -Signature: - -```typescript -interface SiteSearchEvent -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [filters?](./node-tracker.sitesearchevent.filters.md) | Record<string, string \| boolean> | (Optional) Any filters which have been applied to the search | -| [pageResults?](./node-tracker.sitesearchevent.pageresults.md) | number | (Optional) The number of visible results on the page | -| [terms](./node-tracker.sitesearchevent.terms.md) | Array<string> | The terms of the search | -| [totalResults?](./node-tracker.sitesearchevent.totalresults.md) | number | (Optional) The total number of results for this search | - diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.sitesearchevent.pageresults.md b/api-docs/docs/node-tracker/markdown/node-tracker.sitesearchevent.pageresults.md deleted file mode 100644 index a30c5d6ed..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.sitesearchevent.pageresults.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [SiteSearchEvent](./node-tracker.sitesearchevent.md) > [pageResults](./node-tracker.sitesearchevent.pageresults.md) - -## SiteSearchEvent.pageResults property - -The number of visible results on the page - -Signature: - -```typescript -pageResults?: number; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.sitesearchevent.terms.md b/api-docs/docs/node-tracker/markdown/node-tracker.sitesearchevent.terms.md deleted file mode 100644 index 6f4a45ceb..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.sitesearchevent.terms.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [SiteSearchEvent](./node-tracker.sitesearchevent.md) > [terms](./node-tracker.sitesearchevent.terms.md) - -## SiteSearchEvent.terms property - -The terms of the search - -Signature: - -```typescript -terms: Array; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.sitesearchevent.totalresults.md b/api-docs/docs/node-tracker/markdown/node-tracker.sitesearchevent.totalresults.md deleted file mode 100644 index 7b79bd694..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.sitesearchevent.totalresults.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [SiteSearchEvent](./node-tracker.sitesearchevent.md) > [totalResults](./node-tracker.sitesearchevent.totalresults.md) - -## SiteSearchEvent.totalResults property - -The total number of results for this search - -Signature: - -```typescript -totalResults?: number; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.socialinteractionevent.action.md b/api-docs/docs/node-tracker/markdown/node-tracker.socialinteractionevent.action.md deleted file mode 100644 index b0f8c0975..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.socialinteractionevent.action.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [SocialInteractionEvent](./node-tracker.socialinteractionevent.md) > [action](./node-tracker.socialinteractionevent.action.md) - -## SocialInteractionEvent.action property - -Social action performed - -Signature: - -```typescript -action: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.socialinteractionevent.md b/api-docs/docs/node-tracker/markdown/node-tracker.socialinteractionevent.md deleted file mode 100644 index b079030fa..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.socialinteractionevent.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [SocialInteractionEvent](./node-tracker.socialinteractionevent.md) - -## SocialInteractionEvent interface - -A Social Interaction Event Social tracking will be used to track the way users interact with Facebook, Twitter and Google + widgets e.g. to capture “like this” or “tweet this” events. - -Signature: - -```typescript -interface SocialInteractionEvent -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [action](./node-tracker.socialinteractionevent.action.md) | string | Social action performed | -| [network](./node-tracker.socialinteractionevent.network.md) | string | Social network | -| [target?](./node-tracker.socialinteractionevent.target.md) | string | (Optional) Object social action is performed on | - diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.socialinteractionevent.network.md b/api-docs/docs/node-tracker/markdown/node-tracker.socialinteractionevent.network.md deleted file mode 100644 index a5301b629..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.socialinteractionevent.network.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [SocialInteractionEvent](./node-tracker.socialinteractionevent.md) > [network](./node-tracker.socialinteractionevent.network.md) - -## SocialInteractionEvent.network property - -Social network - -Signature: - -```typescript -network: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.socialinteractionevent.target.md b/api-docs/docs/node-tracker/markdown/node-tracker.socialinteractionevent.target.md deleted file mode 100644 index a809bc4bb..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.socialinteractionevent.target.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [SocialInteractionEvent](./node-tracker.socialinteractionevent.md) > [target](./node-tracker.socialinteractionevent.target.md) - -## SocialInteractionEvent.target property - -Object social action is performed on - -Signature: - -```typescript -target?: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.structuredevent.action.md b/api-docs/docs/node-tracker/markdown/node-tracker.structuredevent.action.md deleted file mode 100644 index 7ecfbb207..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.structuredevent.action.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [StructuredEvent](./node-tracker.structuredevent.md) > [action](./node-tracker.structuredevent.action.md) - -## StructuredEvent.action property - -Signature: - -```typescript -action: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.structuredevent.category.md b/api-docs/docs/node-tracker/markdown/node-tracker.structuredevent.category.md deleted file mode 100644 index 663b2514c..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.structuredevent.category.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [StructuredEvent](./node-tracker.structuredevent.md) > [category](./node-tracker.structuredevent.category.md) - -## StructuredEvent.category property - -Signature: - -```typescript -category: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.structuredevent.label.md b/api-docs/docs/node-tracker/markdown/node-tracker.structuredevent.label.md deleted file mode 100644 index c92653178..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.structuredevent.label.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [StructuredEvent](./node-tracker.structuredevent.md) > [label](./node-tracker.structuredevent.label.md) - -## StructuredEvent.label property - -Signature: - -```typescript -label?: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.structuredevent.md b/api-docs/docs/node-tracker/markdown/node-tracker.structuredevent.md deleted file mode 100644 index f42afa8ac..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.structuredevent.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [StructuredEvent](./node-tracker.structuredevent.md) - -## StructuredEvent interface - -A Structured Event A classic style of event tracking, allows for easier movement between analytics systems. A loosely typed event, creating a Self Describing event is preferred, but useful for interoperability. - -Signature: - -```typescript -interface StructuredEvent -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [action](./node-tracker.structuredevent.action.md) | string | | -| [category](./node-tracker.structuredevent.category.md) | string | | -| [label?](./node-tracker.structuredevent.label.md) | string | (Optional) | -| [property?](./node-tracker.structuredevent.property.md) | string | (Optional) | -| [value?](./node-tracker.structuredevent.value.md) | number | (Optional) | - diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.structuredevent.property.md b/api-docs/docs/node-tracker/markdown/node-tracker.structuredevent.property.md deleted file mode 100644 index 3cf1a6ba1..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.structuredevent.property.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [StructuredEvent](./node-tracker.structuredevent.md) > [property](./node-tracker.structuredevent.property.md) - -## StructuredEvent.property property - -Signature: - -```typescript -property?: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.structuredevent.value.md b/api-docs/docs/node-tracker/markdown/node-tracker.structuredevent.value.md deleted file mode 100644 index e1d1d056d..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.structuredevent.value.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [StructuredEvent](./node-tracker.structuredevent.md) > [value](./node-tracker.structuredevent.value.md) - -## StructuredEvent.value property - -Signature: - -```typescript -value?: number; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.tracker.flush.md b/api-docs/docs/node-tracker/markdown/node-tracker.tracker.flush.md deleted file mode 100644 index 44a151f1b..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.tracker.flush.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [Tracker](./node-tracker.tracker.md) > [flush](./node-tracker.tracker.flush.md) - -## Tracker.flush property - -Calls flush on all emitters in order to send all queued events to the collector - -Signature: - -```typescript -flush: () => Promise; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.tracker.md b/api-docs/docs/node-tracker/markdown/node-tracker.tracker.md deleted file mode 100644 index 04f6d564b..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.tracker.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [Tracker](./node-tracker.tracker.md) - -## Tracker interface - -Signature: - -```typescript -interface Tracker extends TrackerCore -``` -Extends: TrackerCore - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [flush](./node-tracker.tracker.flush.md) | () => Promise<void> | Calls flush on all emitters in order to send all queued events to the collector | -| [setDomainUserId](./node-tracker.tracker.setdomainuserid.md) | (userId: string) => void | Set the domain user ID | -| [setNetworkUserId](./node-tracker.tracker.setnetworkuserid.md) | (userId: string) => void | Set the network user ID | -| [setSessionId](./node-tracker.tracker.setsessionid.md) | (sessionId: string) => void | Set the session ID (domain_sessionid in the atomic events) | -| [setSessionIndex](./node-tracker.tracker.setsessionindex.md) | (sessionIndex: string \| number) => void | Set the session index (domain_sessionidx in the atomic events) | - diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.tracker.setdomainuserid.md b/api-docs/docs/node-tracker/markdown/node-tracker.tracker.setdomainuserid.md deleted file mode 100644 index afa5bbeca..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.tracker.setdomainuserid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [Tracker](./node-tracker.tracker.md) > [setDomainUserId](./node-tracker.tracker.setdomainuserid.md) - -## Tracker.setDomainUserId property - -Set the domain user ID - -Signature: - -```typescript -setDomainUserId: (userId: string) => void; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.tracker.setnetworkuserid.md b/api-docs/docs/node-tracker/markdown/node-tracker.tracker.setnetworkuserid.md deleted file mode 100644 index ae7ff4348..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.tracker.setnetworkuserid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [Tracker](./node-tracker.tracker.md) > [setNetworkUserId](./node-tracker.tracker.setnetworkuserid.md) - -## Tracker.setNetworkUserId property - -Set the network user ID - -Signature: - -```typescript -setNetworkUserId: (userId: string) => void; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.tracker.setsessionid.md b/api-docs/docs/node-tracker/markdown/node-tracker.tracker.setsessionid.md deleted file mode 100644 index 24cc52945..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.tracker.setsessionid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [Tracker](./node-tracker.tracker.md) > [setSessionId](./node-tracker.tracker.setsessionid.md) - -## Tracker.setSessionId property - -Set the session ID (`domain_sessionid` in the atomic events) - -Signature: - -```typescript -setSessionId: (sessionId: string) => void; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.tracker.setsessionindex.md b/api-docs/docs/node-tracker/markdown/node-tracker.tracker.setsessionindex.md deleted file mode 100644 index 0432007c2..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.tracker.setsessionindex.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [Tracker](./node-tracker.tracker.md) > [setSessionIndex](./node-tracker.tracker.setsessionindex.md) - -## Tracker.setSessionIndex property - -Set the session index (`domain_sessionidx` in the atomic events) - -Signature: - -```typescript -setSessionIndex: (sessionIndex: string | number) => void; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.trackerconfiguration.appid.md b/api-docs/docs/node-tracker/markdown/node-tracker.trackerconfiguration.appid.md deleted file mode 100644 index 2db6fb611..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.trackerconfiguration.appid.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [TrackerConfiguration](./node-tracker.trackerconfiguration.md) > [appId](./node-tracker.trackerconfiguration.appid.md) - -## TrackerConfiguration.appId property - -Signature: - -```typescript -appId: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.trackerconfiguration.md b/api-docs/docs/node-tracker/markdown/node-tracker.trackerconfiguration.md deleted file mode 100644 index a75af36b9..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.trackerconfiguration.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [TrackerConfiguration](./node-tracker.trackerconfiguration.md) - -## TrackerConfiguration interface - -Signature: - -```typescript -interface TrackerConfiguration -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [appId](./node-tracker.trackerconfiguration.appid.md) | string | | -| [encodeBase64?](./node-tracker.trackerconfiguration.encodebase64.md) | boolean | (Optional) Whether unstructured events and custom contexts should be base64 encoded. | -| [namespace](./node-tracker.trackerconfiguration.namespace.md) | string | | - diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.trackerconfiguration.namespace.md b/api-docs/docs/node-tracker/markdown/node-tracker.trackerconfiguration.namespace.md deleted file mode 100644 index fefc411bb..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.trackerconfiguration.namespace.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [TrackerConfiguration](./node-tracker.trackerconfiguration.md) > [namespace](./node-tracker.trackerconfiguration.namespace.md) - -## TrackerConfiguration.namespace property - -Signature: - -```typescript -namespace: string; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.trackercore.md b/api-docs/docs/node-tracker/markdown/node-tracker.trackercore.md deleted file mode 100644 index d63fc8419..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.trackercore.md +++ /dev/null @@ -1,47 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [TrackerCore](./node-tracker.trackercore.md) - -## TrackerCore interface - -Export interface containing all Core functions - -Signature: - -```typescript -interface TrackerCore -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [addPayloadPair](./node-tracker.trackercore.addpayloadpair.md) | (key: string, value: unknown) => void | Set a persistent key-value pair to be added to every payload | -| [track](./node-tracker.trackercore.track.md) | (pb: PayloadBuilder, context?: Array<SelfDescribingJson> \| null, timestamp?: Timestamp \| null) => Payload \| undefined | Call with a payload from a buildX function Adds context and payloadPairs name-value pairs to the payload Applies the callback to the built payload | - -## Methods - -| Method | Description | -| --- | --- | -| [addGlobalContexts(contexts)](./node-tracker.trackercore.addglobalcontexts.md) | Adds contexts globally, contexts added here will be attached to all applicable events | -| [addPayloadDict(dict)](./node-tracker.trackercore.addpayloaddict.md) | Merges a dictionary into payloadPairs | -| [addPlugin(configuration)](./node-tracker.trackercore.addplugin.md) | Add a plugin into the plugin collection after Core has already been initialised | -| [clearGlobalContexts()](./node-tracker.trackercore.clearglobalcontexts.md) | Removes all global contexts | -| [deactivate()](./node-tracker.trackercore.deactivate.md) | Deactivate tracker core including all plugins. This is useful for cleaning up resources or listeners that have been created. Once deactivated, the tracker won't be able to track any events. | -| [getBase64Encoding()](./node-tracker.trackercore.getbase64encoding.md) | Get current base64 encoding state | -| [removeGlobalContexts(contexts)](./node-tracker.trackercore.removeglobalcontexts.md) | Removes previously added global context, performs a deep comparison of the contexts or conditional contexts | -| [resetPayloadPairs(dict)](./node-tracker.trackercore.resetpayloadpairs.md) | Replace payloadPairs with a new dictionary | -| [setAppId(appId)](./node-tracker.trackercore.setappid.md) | Set the application ID | -| [setBase64Encoding(encode)](./node-tracker.trackercore.setbase64encoding.md) | Turn base 64 encoding on or off | -| [setColorDepth(depth)](./node-tracker.trackercore.setcolordepth.md) | Set the color depth | -| [setIpAddress(ip)](./node-tracker.trackercore.setipaddress.md) | Set the IP address | -| [setLang(lang)](./node-tracker.trackercore.setlang.md) | Set the language | -| [setPlatform(value)](./node-tracker.trackercore.setplatform.md) | Set the platform | -| [setScreenResolution(width, height)](./node-tracker.trackercore.setscreenresolution.md) | Set the screen resolution | -| [setTimezone(timezone)](./node-tracker.trackercore.settimezone.md) | Set the timezone | -| [setTrackerNamespace(name)](./node-tracker.trackercore.settrackernamespace.md) | Set the tracker namespace | -| [setTrackerVersion(version)](./node-tracker.trackercore.settrackerversion.md) | Set the tracker version | -| [setUseragent(useragent)](./node-tracker.trackercore.setuseragent.md) | Set the Useragent | -| [setUserId(userId)](./node-tracker.trackercore.setuserid.md) | Set the user ID | -| [setViewport(width, height)](./node-tracker.trackercore.setviewport.md) | Set the viewport dimensions | - diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.truetimestamp.md b/api-docs/docs/node-tracker/markdown/node-tracker.truetimestamp.md deleted file mode 100644 index d4b2ad656..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.truetimestamp.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [TrueTimestamp](./node-tracker.truetimestamp.md) - -## TrueTimestamp interface - -A representation of a True Timestamp (ttm) - -Signature: - -```typescript -interface TrueTimestamp -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [type](./node-tracker.truetimestamp.type.md) | "ttm" | | -| [value](./node-tracker.truetimestamp.value.md) | number | | - diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.truetimestamp.type.md b/api-docs/docs/node-tracker/markdown/node-tracker.truetimestamp.type.md deleted file mode 100644 index 1eb184bf3..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.truetimestamp.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [TrueTimestamp](./node-tracker.truetimestamp.md) > [type](./node-tracker.truetimestamp.type.md) - -## TrueTimestamp.type property - -Signature: - -```typescript -readonly type: "ttm"; -``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.truetimestamp.value.md b/api-docs/docs/node-tracker/markdown/node-tracker.truetimestamp.value.md deleted file mode 100644 index 0f8349f7b..000000000 --- a/api-docs/docs/node-tracker/markdown/node-tracker.truetimestamp.value.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [TrueTimestamp](./node-tracker.truetimestamp.md) > [value](./node-tracker.truetimestamp.value.md) - -## TrueTimestamp.value property - -Signature: - -```typescript -readonly value: number; -``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.applifecycleconfiguration.appbuild.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.applifecycleconfiguration.appbuild.md new file mode 100644 index 000000000..03a2ecbd5 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.applifecycleconfiguration.appbuild.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [AppLifecycleConfiguration](./react-native-tracker.applifecycleconfiguration.md) > [appBuild](./react-native-tracker.applifecycleconfiguration.appbuild.md) + +## AppLifecycleConfiguration.appBuild property + +Build name of the application e.g s9f2k2d or 1.1.0 beta + +Entity schema: `iglu:com.snowplowanalytics.mobile/application/jsonschema/1-0-0` + +Signature: + +```typescript +appBuild?: string; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.applifecycleconfiguration.appversion.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.applifecycleconfiguration.appversion.md new file mode 100644 index 000000000..06a720972 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.applifecycleconfiguration.appversion.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [AppLifecycleConfiguration](./react-native-tracker.applifecycleconfiguration.md) > [appVersion](./react-native-tracker.applifecycleconfiguration.appversion.md) + +## AppLifecycleConfiguration.appVersion property + +Version number of the application e.g 1.1.0 (semver or git commit hash). + +Entity schema if `appBuild` property is set: `iglu:com.snowplowanalytics.mobile/application/jsonschema/1-0-0` Entity schema if `appBuild` property is not set: `iglu:com.snowplowanalytics.snowplow/application/jsonschema/1-0-0` + +Signature: + +```typescript +appVersion?: string; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.applifecycleconfiguration.installautotracking.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.applifecycleconfiguration.installautotracking.md new file mode 100644 index 000000000..d052ad96e --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.applifecycleconfiguration.installautotracking.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [AppLifecycleConfiguration](./react-native-tracker.applifecycleconfiguration.md) > [installAutotracking](./react-native-tracker.applifecycleconfiguration.installautotracking.md) + +## AppLifecycleConfiguration.installAutotracking property + +Whether to automatically track app install event on first run. + +Schema: `iglu:com.snowplowanalytics.mobile/application_install/jsonschema/1-0-0` + +Signature: + +```typescript +installAutotracking?: boolean; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.applifecycleconfiguration.lifecycleautotracking.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.applifecycleconfiguration.lifecycleautotracking.md new file mode 100644 index 000000000..47c7faf07 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.applifecycleconfiguration.lifecycleautotracking.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [AppLifecycleConfiguration](./react-native-tracker.applifecycleconfiguration.md) > [lifecycleAutotracking](./react-native-tracker.applifecycleconfiguration.lifecycleautotracking.md) + +## AppLifecycleConfiguration.lifecycleAutotracking property + +Whether to automatically track app lifecycle events (app foreground and background events). Also adds a lifecycle context entity to all events. + +Foreground event schema: `iglu:com.snowplowanalytics.snowplow/application_foreground/jsonschema/1-0-0` Background event schema: `iglu:com.snowplowanalytics.snowplow/application_background/jsonschema/1-0-0` Context entity schema: `iglu:com.snowplowanalytics.mobile/application_lifecycle/jsonschema/1-0-0` + +Signature: + +```typescript +lifecycleAutotracking?: boolean; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.applifecycleconfiguration.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.applifecycleconfiguration.md new file mode 100644 index 000000000..bc402d9b3 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.applifecycleconfiguration.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [AppLifecycleConfiguration](./react-native-tracker.applifecycleconfiguration.md) + +## AppLifecycleConfiguration interface + +Configuration for app lifecycle tracking + +Signature: + +```typescript +export interface AppLifecycleConfiguration +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [appBuild?](./react-native-tracker.applifecycleconfiguration.appbuild.md) | string | (Optional) Build name of the application e.g s9f2k2d or 1.1.0 betaEntity schema: iglu:com.snowplowanalytics.mobile/application/jsonschema/1-0-0 | +| [appVersion?](./react-native-tracker.applifecycleconfiguration.appversion.md) | string | (Optional) Version number of the application e.g 1.1.0 (semver or git commit hash).Entity schema if appBuild property is set: iglu:com.snowplowanalytics.mobile/application/jsonschema/1-0-0 Entity schema if appBuild property is not set: iglu:com.snowplowanalytics.snowplow/application/jsonschema/1-0-0 | +| [installAutotracking?](./react-native-tracker.applifecycleconfiguration.installautotracking.md) | boolean | (Optional) Whether to automatically track app install event on first run.Schema: iglu:com.snowplowanalytics.mobile/application_install/jsonschema/1-0-0 | +| [lifecycleAutotracking?](./react-native-tracker.applifecycleconfiguration.lifecycleautotracking.md) | boolean | (Optional) Whether to automatically track app lifecycle events (app foreground and background events). Also adds a lifecycle context entity to all events.Foreground event schema: iglu:com.snowplowanalytics.snowplow/application_foreground/jsonschema/1-0-0 Background event schema: iglu:com.snowplowanalytics.snowplow/application_background/jsonschema/1-0-0 Context entity schema: iglu:com.snowplowanalytics.mobile/application_lifecycle/jsonschema/1-0-0 | + diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.conditionalcontextprovider.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.conditionalcontextprovider.md similarity index 70% rename from api-docs/docs/node-tracker/markdown/node-tracker.conditionalcontextprovider.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.conditionalcontextprovider.md index 4fea54096..ae264a7a2 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.conditionalcontextprovider.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.conditionalcontextprovider.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [ConditionalContextProvider](./node-tracker.conditionalcontextprovider.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [ConditionalContextProvider](./react-native-tracker.conditionalcontextprovider.md) ## ConditionalContextProvider type diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.contextfilter.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.contextfilter.md similarity index 69% rename from api-docs/docs/node-tracker/markdown/node-tracker.contextfilter.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.contextfilter.md index 6285a22da..b458e6646 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.contextfilter.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.contextfilter.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [ContextFilter](./node-tracker.contextfilter.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [ContextFilter](./react-native-tracker.contextfilter.md) ## ContextFilter type diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.contextgenerator.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.contextgenerator.md similarity index 70% rename from api-docs/docs/node-tracker/markdown/node-tracker.contextgenerator.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.contextgenerator.md index 1e2764916..0cbf292e9 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.contextgenerator.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.contextgenerator.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [ContextGenerator](./node-tracker.contextgenerator.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [ContextGenerator](./react-native-tracker.contextgenerator.md) ## ContextGenerator type diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.contextprimitive.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.contextprimitive.md similarity index 63% rename from api-docs/docs/node-tracker/markdown/node-tracker.contextprimitive.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.contextprimitive.md index 95819e7f0..e2fe51369 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.contextprimitive.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.contextprimitive.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [ContextPrimitive](./node-tracker.contextprimitive.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [ContextPrimitive](./react-native-tracker.contextprimitive.md) ## ContextPrimitive type diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.coreconfiguration.base64.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.coreconfiguration.base64.md new file mode 100644 index 000000000..0bceab7f6 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.coreconfiguration.base64.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [CoreConfiguration](./react-native-tracker.coreconfiguration.md) > [base64](./react-native-tracker.coreconfiguration.base64.md) + +## CoreConfiguration.base64 property + +Signature: + +```typescript +base64?: boolean; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.coreconfiguration.callback.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.coreconfiguration.callback.md new file mode 100644 index 000000000..1e771a210 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.coreconfiguration.callback.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [CoreConfiguration](./react-native-tracker.coreconfiguration.md) > [callback](./react-native-tracker.coreconfiguration.callback.md) + +## CoreConfiguration.callback property + +Signature: + +```typescript +callback?: (PayloadData: PayloadBuilder) => void; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.coreconfiguration.coreplugins.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.coreconfiguration.coreplugins.md new file mode 100644 index 000000000..01cb1e158 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.coreconfiguration.coreplugins.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [CoreConfiguration](./react-native-tracker.coreconfiguration.md) > [corePlugins](./react-native-tracker.coreconfiguration.coreplugins.md) + +## CoreConfiguration.corePlugins property + +Signature: + +```typescript +corePlugins?: Array; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.coreconfiguration.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.coreconfiguration.md new file mode 100644 index 000000000..1b3a10636 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.coreconfiguration.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [CoreConfiguration](./react-native-tracker.coreconfiguration.md) + +## CoreConfiguration interface + +The configuration object for the tracker core library + +Signature: + +```typescript +interface CoreConfiguration +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [base64?](./react-native-tracker.coreconfiguration.base64.md) | boolean | (Optional) | +| [callback?](./react-native-tracker.coreconfiguration.callback.md) | (PayloadData: PayloadBuilder) => void | (Optional) | +| [corePlugins?](./react-native-tracker.coreconfiguration.coreplugins.md) | Array<CorePlugin> | (Optional) | + diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.coreplugin.activatecoreplugin.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.coreplugin.activatecoreplugin.md similarity index 61% rename from api-docs/docs/node-tracker/markdown/node-tracker.coreplugin.activatecoreplugin.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.coreplugin.activatecoreplugin.md index 0af3894f6..90d55d741 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.coreplugin.activatecoreplugin.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.coreplugin.activatecoreplugin.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [CorePlugin](./node-tracker.coreplugin.md) > [activateCorePlugin](./node-tracker.coreplugin.activatecoreplugin.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [CorePlugin](./react-native-tracker.coreplugin.md) > [activateCorePlugin](./react-native-tracker.coreplugin.activatecoreplugin.md) ## CorePlugin.activateCorePlugin property diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.coreplugin.aftertrack.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.coreplugin.aftertrack.md similarity index 52% rename from api-docs/docs/node-tracker/markdown/node-tracker.coreplugin.aftertrack.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.coreplugin.aftertrack.md index e379642e3..d50881781 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.coreplugin.aftertrack.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.coreplugin.aftertrack.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [CorePlugin](./node-tracker.coreplugin.md) > [afterTrack](./node-tracker.coreplugin.aftertrack.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [CorePlugin](./react-native-tracker.coreplugin.md) > [afterTrack](./react-native-tracker.coreplugin.aftertrack.md) ## CorePlugin.afterTrack property diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.coreplugin.beforetrack.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.coreplugin.beforetrack.md similarity index 59% rename from api-docs/docs/node-tracker/markdown/node-tracker.coreplugin.beforetrack.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.coreplugin.beforetrack.md index fb031028f..a172901cf 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.coreplugin.beforetrack.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.coreplugin.beforetrack.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [CorePlugin](./node-tracker.coreplugin.md) > [beforeTrack](./node-tracker.coreplugin.beforetrack.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [CorePlugin](./react-native-tracker.coreplugin.md) > [beforeTrack](./react-native-tracker.coreplugin.beforetrack.md) ## CorePlugin.beforeTrack property diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.coreplugin.contexts.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.coreplugin.contexts.md similarity index 57% rename from api-docs/docs/node-tracker/markdown/node-tracker.coreplugin.contexts.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.coreplugin.contexts.md index 9ae49b41e..015b3117c 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.coreplugin.contexts.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.coreplugin.contexts.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [CorePlugin](./node-tracker.coreplugin.md) > [contexts](./node-tracker.coreplugin.contexts.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [CorePlugin](./react-native-tracker.coreplugin.md) > [contexts](./react-native-tracker.coreplugin.contexts.md) ## CorePlugin.contexts property diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.coreplugin.deactivateplugin.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.coreplugin.deactivateplugin.md similarity index 59% rename from api-docs/docs/node-tracker/markdown/node-tracker.coreplugin.deactivateplugin.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.coreplugin.deactivateplugin.md index 811a13c07..edbdd11ce 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.coreplugin.deactivateplugin.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.coreplugin.deactivateplugin.md @@ -1,13 +1,13 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [CorePlugin](./node-tracker.coreplugin.md) > [deactivatePlugin](./node-tracker.coreplugin.deactivateplugin.md) - -## CorePlugin.deactivatePlugin property - -Called when the tracker is being destroyed. Should be used to clean up any resources or listeners that the plugin has created. - -Signature: - -```typescript -deactivatePlugin?: (core: TrackerCore) => void; -``` + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [CorePlugin](./react-native-tracker.coreplugin.md) > [deactivatePlugin](./react-native-tracker.coreplugin.deactivateplugin.md) + +## CorePlugin.deactivatePlugin property + +Called when the tracker is being destroyed. Should be used to clean up any resources or listeners that the plugin has created. + +Signature: + +```typescript +deactivatePlugin?: (core: TrackerCore) => void; +``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.coreplugin.filter.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.coreplugin.filter.md similarity index 57% rename from api-docs/docs/node-tracker/markdown/node-tracker.coreplugin.filter.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.coreplugin.filter.md index 4ce80a4f4..7c621722c 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.coreplugin.filter.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.coreplugin.filter.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [CorePlugin](./node-tracker.coreplugin.md) > [filter](./node-tracker.coreplugin.filter.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [CorePlugin](./react-native-tracker.coreplugin.md) > [filter](./react-native-tracker.coreplugin.filter.md) ## CorePlugin.filter property diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.coreplugin.logger.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.coreplugin.logger.md similarity index 56% rename from api-docs/docs/node-tracker/markdown/node-tracker.coreplugin.logger.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.coreplugin.logger.md index d2430b4c0..65ad62785 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.coreplugin.logger.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.coreplugin.logger.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [CorePlugin](./node-tracker.coreplugin.md) > [logger](./node-tracker.coreplugin.logger.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [CorePlugin](./react-native-tracker.coreplugin.md) > [logger](./react-native-tracker.coreplugin.logger.md) ## CorePlugin.logger property diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.coreplugin.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.coreplugin.md new file mode 100644 index 000000000..85529ca8c --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.coreplugin.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [CorePlugin](./react-native-tracker.coreplugin.md) + +## CorePlugin interface + +Interface which defines Core Plugins + +Signature: + +```typescript +interface CorePlugin +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [activateCorePlugin?](./react-native-tracker.coreplugin.activatecoreplugin.md) | (core: TrackerCore) => void | (Optional) Called when the plugin is initialised during the trackerCore construction | +| [afterTrack?](./react-native-tracker.coreplugin.aftertrack.md) | (payload: Payload) => void | (Optional) Called just after the trackerCore callback fires | +| [beforeTrack?](./react-native-tracker.coreplugin.beforetrack.md) | (payloadBuilder: PayloadBuilder) => void | (Optional) Called before the filter method is called and before the trackerCore callback fires (if the filter passes) | +| [contexts?](./react-native-tracker.coreplugin.contexts.md) | () => SelfDescribingJson\[\] | (Optional) Called when constructing the context for each event Useful for adding additional context to events | +| [deactivatePlugin?](./react-native-tracker.coreplugin.deactivateplugin.md) | (core: TrackerCore) => void | (Optional) Called when the tracker is being destroyed. Should be used to clean up any resources or listeners that the plugin has created. | +| [filter?](./react-native-tracker.coreplugin.filter.md) | (payload: Payload) => boolean | (Optional) Called before the payload is sent to the callback to decide whether to send the payload or skip it | +| [logger?](./react-native-tracker.coreplugin.logger.md) | (logger: Logger) => void | (Optional) Passed a logger instance which can be used to send log information to the active logger | + diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.corepluginconfiguration.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.corepluginconfiguration.md similarity index 52% rename from api-docs/docs/node-tracker/markdown/node-tracker.corepluginconfiguration.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.corepluginconfiguration.md index a224d4cc0..e14a922ec 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.corepluginconfiguration.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.corepluginconfiguration.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [CorePluginConfiguration](./node-tracker.corepluginconfiguration.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [CorePluginConfiguration](./react-native-tracker.corepluginconfiguration.md) ## CorePluginConfiguration interface @@ -16,5 +16,5 @@ interface CorePluginConfiguration | Property | Type | Description | | --- | --- | --- | -| [plugin](./node-tracker.corepluginconfiguration.plugin.md) | CorePlugin | | +| [plugin](./react-native-tracker.corepluginconfiguration.plugin.md) | CorePlugin | | diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.corepluginconfiguration.plugin.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.corepluginconfiguration.plugin.md new file mode 100644 index 000000000..6ab300b27 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.corepluginconfiguration.plugin.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [CorePluginConfiguration](./react-native-tracker.corepluginconfiguration.md) > [plugin](./react-native-tracker.corepluginconfiguration.plugin.md) + +## CorePluginConfiguration.plugin property + +Signature: + +```typescript +plugin: CorePlugin; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.deeplinkconfiguration.deeplinkcontext.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.deeplinkconfiguration.deeplinkcontext.md new file mode 100644 index 000000000..ad1dc7387 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.deeplinkconfiguration.deeplinkcontext.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [DeepLinkConfiguration](./react-native-tracker.deeplinkconfiguration.md) > [deepLinkContext](./react-native-tracker.deeplinkconfiguration.deeplinkcontext.md) + +## DeepLinkConfiguration.deepLinkContext property + +Whether to track the deep link context entity with information from the deep link received event on the first screen view event. + +Signature: + +```typescript +deepLinkContext?: boolean; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.deeplinkconfiguration.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.deeplinkconfiguration.md new file mode 100644 index 000000000..506c7ed7a --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.deeplinkconfiguration.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [DeepLinkConfiguration](./react-native-tracker.deeplinkconfiguration.md) + +## DeepLinkConfiguration interface + +Configuration for deep link tracking + +Signature: + +```typescript +export interface DeepLinkConfiguration +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [deepLinkContext?](./react-native-tracker.deeplinkconfiguration.deeplinkcontext.md) | boolean | (Optional) Whether to track the deep link context entity with information from the deep link received event on the first screen view event. | + diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.deeplinkreceivedprops.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.deeplinkreceivedprops.md new file mode 100644 index 000000000..6a10e920c --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.deeplinkreceivedprops.md @@ -0,0 +1,16 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [DeepLinkReceivedProps](./react-native-tracker.deeplinkreceivedprops.md) + +## DeepLinkReceivedProps type + +DeepLinkReceived event properties schema: iglu:com.snowplowanalytics.mobile/deep\_link\_received/jsonschema/1-0-0 + +Signature: + +```typescript +export declare type DeepLinkReceivedProps = { + url: string; + referrer?: string; +}; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.devicetimestamp.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.devicetimestamp.md new file mode 100644 index 000000000..22804fc75 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.devicetimestamp.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [DeviceTimestamp](./react-native-tracker.devicetimestamp.md) + +## DeviceTimestamp interface + +A representation of a Device Timestamp (dtm) + +Signature: + +```typescript +interface DeviceTimestamp +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [type](./react-native-tracker.devicetimestamp.type.md) | "dtm" | | +| [value](./react-native-tracker.devicetimestamp.value.md) | number | | + diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.devicetimestamp.type.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.devicetimestamp.type.md new file mode 100644 index 000000000..b02eee053 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.devicetimestamp.type.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [DeviceTimestamp](./react-native-tracker.devicetimestamp.md) > [type](./react-native-tracker.devicetimestamp.type.md) + +## DeviceTimestamp.type property + +Signature: + +```typescript +readonly type: "dtm"; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.devicetimestamp.value.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.devicetimestamp.value.md new file mode 100644 index 000000000..2b5a2fb23 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.devicetimestamp.value.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [DeviceTimestamp](./react-native-tracker.devicetimestamp.md) > [value](./react-native-tracker.devicetimestamp.value.md) + +## DeviceTimestamp.value property + +Signature: + +```typescript +readonly value: number; +``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.emitter.flush.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.emitter.flush.md similarity index 55% rename from api-docs/docs/node-tracker/markdown/node-tracker.emitter.flush.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.emitter.flush.md index a64176e70..351d0e37e 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.emitter.flush.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.emitter.flush.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [Emitter](./node-tracker.emitter.md) > [flush](./node-tracker.emitter.flush.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [Emitter](./react-native-tracker.emitter.md) > [flush](./react-native-tracker.emitter.flush.md) ## Emitter.flush property diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.emitter.input.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.emitter.input.md similarity index 56% rename from api-docs/docs/node-tracker/markdown/node-tracker.emitter.input.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.emitter.input.md index 562cf2ccf..5f22e9b5c 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.emitter.input.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.emitter.input.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [Emitter](./node-tracker.emitter.md) > [input](./node-tracker.emitter.input.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [Emitter](./react-native-tracker.emitter.md) > [input](./react-native-tracker.emitter.input.md) ## Emitter.input property diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.emitter.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.emitter.md new file mode 100644 index 000000000..24f95cde0 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.emitter.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [Emitter](./react-native-tracker.emitter.md) + +## Emitter interface + +Emitter is responsible for sending events to the collector. It manages the event queue and sends events in batches depending on configuration. + +Signature: + +```typescript +interface Emitter +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [flush](./react-native-tracker.emitter.flush.md) | () => Promise<void> | Forces the emitter to send all events in the event store to the collector. | +| [input](./react-native-tracker.emitter.input.md) | (payload: Payload) => Promise<void> | Adds a payload to the event store or sends it to the collector. | +| [setAnonymousTracking](./react-native-tracker.emitter.setanonymoustracking.md) | (anonymous: boolean) => void | Sets the server anonymization flag. | +| [setBufferSize](./react-native-tracker.emitter.setbuffersize.md) | (bufferSize: number) => void | Updates the buffer size of the emitter. | +| [setCollectorUrl](./react-native-tracker.emitter.setcollectorurl.md) | (url: string) => void | Updates the collector URL to which events will be sent. | + diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.emitter.setanonymoustracking.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.emitter.setanonymoustracking.md similarity index 52% rename from api-docs/docs/node-tracker/markdown/node-tracker.emitter.setanonymoustracking.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.emitter.setanonymoustracking.md index bcaf2bafe..7de2afba3 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.emitter.setanonymoustracking.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.emitter.setanonymoustracking.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [Emitter](./node-tracker.emitter.md) > [setAnonymousTracking](./node-tracker.emitter.setanonymoustracking.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [Emitter](./react-native-tracker.emitter.md) > [setAnonymousTracking](./react-native-tracker.emitter.setanonymoustracking.md) ## Emitter.setAnonymousTracking property diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.emitter.setbuffersize.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.emitter.setbuffersize.md similarity index 52% rename from api-docs/docs/node-tracker/markdown/node-tracker.emitter.setbuffersize.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.emitter.setbuffersize.md index 8cee1c8fd..630e81e5e 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.emitter.setbuffersize.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.emitter.setbuffersize.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [Emitter](./node-tracker.emitter.md) > [setBufferSize](./node-tracker.emitter.setbuffersize.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [Emitter](./react-native-tracker.emitter.md) > [setBufferSize](./react-native-tracker.emitter.setbuffersize.md) ## Emitter.setBufferSize property diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.emitter.setcollectorurl.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.emitter.setcollectorurl.md similarity index 53% rename from api-docs/docs/node-tracker/markdown/node-tracker.emitter.setcollectorurl.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.emitter.setcollectorurl.md index ba73c3063..2d170a707 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.emitter.setcollectorurl.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.emitter.setcollectorurl.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [Emitter](./node-tracker.emitter.md) > [setCollectorUrl](./node-tracker.emitter.setcollectorurl.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [Emitter](./react-native-tracker.emitter.md) > [setCollectorUrl](./react-native-tracker.emitter.setcollectorurl.md) ## Emitter.setCollectorUrl property diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfiguration.endpoint.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfiguration.endpoint.md new file mode 100644 index 000000000..6e3c59555 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfiguration.endpoint.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EmitterConfiguration](./react-native-tracker.emitterconfiguration.md) > [endpoint](./react-native-tracker.emitterconfiguration.endpoint.md) + +## EmitterConfiguration.endpoint property + +Signature: + +```typescript +endpoint: string; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfiguration.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfiguration.md new file mode 100644 index 000000000..e8f5c3fc3 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfiguration.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EmitterConfiguration](./react-native-tracker.emitterconfiguration.md) + +## EmitterConfiguration interface + +Signature: + +```typescript +interface EmitterConfiguration extends EmitterConfigurationBase +``` +Extends: EmitterConfigurationBase + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [endpoint](./react-native-tracker.emitterconfiguration.endpoint.md) | string | | +| [port?](./react-native-tracker.emitterconfiguration.port.md) | number | (Optional) | +| [protocol?](./react-native-tracker.emitterconfiguration.protocol.md) | "http" \| "https" | (Optional) | +| [serverAnonymization?](./react-native-tracker.emitterconfiguration.serveranonymization.md) | boolean | (Optional) | + diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfiguration.port.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfiguration.port.md new file mode 100644 index 000000000..082b7ac51 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfiguration.port.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EmitterConfiguration](./react-native-tracker.emitterconfiguration.md) > [port](./react-native-tracker.emitterconfiguration.port.md) + +## EmitterConfiguration.port property + +Signature: + +```typescript +port?: number; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfiguration.protocol.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfiguration.protocol.md new file mode 100644 index 000000000..8a3715d36 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfiguration.protocol.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EmitterConfiguration](./react-native-tracker.emitterconfiguration.md) > [protocol](./react-native-tracker.emitterconfiguration.protocol.md) + +## EmitterConfiguration.protocol property + +Signature: + +```typescript +protocol?: "http" | "https"; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfiguration.serveranonymization.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfiguration.serveranonymization.md new file mode 100644 index 000000000..74628321b --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfiguration.serveranonymization.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EmitterConfiguration](./react-native-tracker.emitterconfiguration.md) > [serverAnonymization](./react-native-tracker.emitterconfiguration.serveranonymization.md) + +## EmitterConfiguration.serverAnonymization property + +Signature: + +```typescript +serverAnonymization?: boolean; +``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.emitterconfigurationbase.buffersize.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfigurationbase.buffersize.md similarity index 54% rename from api-docs/docs/node-tracker/markdown/node-tracker.emitterconfigurationbase.buffersize.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfigurationbase.buffersize.md index ddb5aa747..5141933a2 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.emitterconfigurationbase.buffersize.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfigurationbase.buffersize.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EmitterConfigurationBase](./node-tracker.emitterconfigurationbase.md) > [bufferSize](./node-tracker.emitterconfigurationbase.buffersize.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EmitterConfigurationBase](./react-native-tracker.emitterconfigurationbase.md) > [bufferSize](./react-native-tracker.emitterconfigurationbase.buffersize.md) ## EmitterConfigurationBase.bufferSize property diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfigurationbase.connectiontimeout.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfigurationbase.connectiontimeout.md new file mode 100644 index 000000000..01c13b8bc --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfigurationbase.connectiontimeout.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EmitterConfigurationBase](./react-native-tracker.emitterconfigurationbase.md) > [connectionTimeout](./react-native-tracker.emitterconfigurationbase.connectiontimeout.md) + +## EmitterConfigurationBase.connectionTimeout property + +How long to wait before aborting requests to the collector + +Signature: + +```typescript +connectionTimeout?: number; +``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.emitterconfigurationbase.credentials.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfigurationbase.credentials.md similarity index 53% rename from api-docs/docs/node-tracker/markdown/node-tracker.emitterconfigurationbase.credentials.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfigurationbase.credentials.md index 5535ee412..1219ad5b7 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.emitterconfigurationbase.credentials.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfigurationbase.credentials.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EmitterConfigurationBase](./node-tracker.emitterconfigurationbase.md) > [credentials](./node-tracker.emitterconfigurationbase.credentials.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EmitterConfigurationBase](./react-native-tracker.emitterconfigurationbase.md) > [credentials](./react-native-tracker.emitterconfigurationbase.credentials.md) ## EmitterConfigurationBase.credentials property diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.emitterconfigurationbase.customfetch.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfigurationbase.customfetch.md similarity index 55% rename from api-docs/docs/node-tracker/markdown/node-tracker.emitterconfigurationbase.customfetch.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfigurationbase.customfetch.md index 568ece696..3831bffeb 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.emitterconfigurationbase.customfetch.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfigurationbase.customfetch.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EmitterConfigurationBase](./node-tracker.emitterconfigurationbase.md) > [customFetch](./node-tracker.emitterconfigurationbase.customfetch.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EmitterConfigurationBase](./react-native-tracker.emitterconfigurationbase.md) > [customFetch](./react-native-tracker.emitterconfigurationbase.customfetch.md) ## EmitterConfigurationBase.customFetch property diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.emitterconfigurationbase.customheaders.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfigurationbase.customheaders.md similarity index 54% rename from api-docs/docs/node-tracker/markdown/node-tracker.emitterconfigurationbase.customheaders.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfigurationbase.customheaders.md index a143554d3..19bb72078 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.emitterconfigurationbase.customheaders.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfigurationbase.customheaders.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EmitterConfigurationBase](./node-tracker.emitterconfigurationbase.md) > [customHeaders](./node-tracker.emitterconfigurationbase.customheaders.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EmitterConfigurationBase](./react-native-tracker.emitterconfigurationbase.md) > [customHeaders](./react-native-tracker.emitterconfigurationbase.customheaders.md) ## EmitterConfigurationBase.customHeaders property diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.emitterconfigurationbase.dontretrystatuscodes.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfigurationbase.dontretrystatuscodes.md similarity index 71% rename from api-docs/docs/node-tracker/markdown/node-tracker.emitterconfigurationbase.dontretrystatuscodes.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfigurationbase.dontretrystatuscodes.md index ffc915ec3..899a420d2 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.emitterconfigurationbase.dontretrystatuscodes.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfigurationbase.dontretrystatuscodes.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EmitterConfigurationBase](./node-tracker.emitterconfigurationbase.md) > [dontRetryStatusCodes](./node-tracker.emitterconfigurationbase.dontretrystatuscodes.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EmitterConfigurationBase](./react-native-tracker.emitterconfigurationbase.md) > [dontRetryStatusCodes](./react-native-tracker.emitterconfigurationbase.dontretrystatuscodes.md) ## EmitterConfigurationBase.dontRetryStatusCodes property diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfigurationbase.eventmethod.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfigurationbase.eventmethod.md new file mode 100644 index 000000000..dfb2be7e8 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfigurationbase.eventmethod.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EmitterConfigurationBase](./react-native-tracker.emitterconfigurationbase.md) > [eventMethod](./react-native-tracker.emitterconfigurationbase.eventmethod.md) + +## EmitterConfigurationBase.eventMethod property + +The preferred technique to use to send events + +Signature: + +```typescript +eventMethod?: EventMethod; +``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.emitterconfigurationbase.eventstore.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfigurationbase.eventstore.md similarity index 53% rename from api-docs/docs/node-tracker/markdown/node-tracker.emitterconfigurationbase.eventstore.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfigurationbase.eventstore.md index eb6fbfaba..8c872a534 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.emitterconfigurationbase.eventstore.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfigurationbase.eventstore.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EmitterConfigurationBase](./node-tracker.emitterconfigurationbase.md) > [eventStore](./node-tracker.emitterconfigurationbase.eventstore.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EmitterConfigurationBase](./react-native-tracker.emitterconfigurationbase.md) > [eventStore](./react-native-tracker.emitterconfigurationbase.eventstore.md) ## EmitterConfigurationBase.eventStore property diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.emitterconfigurationbase.idservice.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfigurationbase.idservice.md similarity index 68% rename from api-docs/docs/node-tracker/markdown/node-tracker.emitterconfigurationbase.idservice.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfigurationbase.idservice.md index 353726343..c0a9d46b3 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.emitterconfigurationbase.idservice.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfigurationbase.idservice.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EmitterConfigurationBase](./node-tracker.emitterconfigurationbase.md) > [idService](./node-tracker.emitterconfigurationbase.idservice.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EmitterConfigurationBase](./react-native-tracker.emitterconfigurationbase.md) > [idService](./react-native-tracker.emitterconfigurationbase.idservice.md) ## EmitterConfigurationBase.idService property diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.emitterconfigurationbase.keepalive.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfigurationbase.keepalive.md similarity index 67% rename from api-docs/docs/node-tracker/markdown/node-tracker.emitterconfigurationbase.keepalive.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfigurationbase.keepalive.md index 480135076..01c8c2818 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.emitterconfigurationbase.keepalive.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfigurationbase.keepalive.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EmitterConfigurationBase](./node-tracker.emitterconfigurationbase.md) > [keepalive](./node-tracker.emitterconfigurationbase.keepalive.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EmitterConfigurationBase](./react-native-tracker.emitterconfigurationbase.md) > [keepalive](./react-native-tracker.emitterconfigurationbase.keepalive.md) ## EmitterConfigurationBase.keepalive property diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.emitterconfigurationbase.maxgetbytes.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfigurationbase.maxgetbytes.md similarity index 53% rename from api-docs/docs/node-tracker/markdown/node-tracker.emitterconfigurationbase.maxgetbytes.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfigurationbase.maxgetbytes.md index cba914977..f9dfdedc5 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.emitterconfigurationbase.maxgetbytes.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfigurationbase.maxgetbytes.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EmitterConfigurationBase](./node-tracker.emitterconfigurationbase.md) > [maxGetBytes](./node-tracker.emitterconfigurationbase.maxgetbytes.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EmitterConfigurationBase](./react-native-tracker.emitterconfigurationbase.md) > [maxGetBytes](./react-native-tracker.emitterconfigurationbase.maxgetbytes.md) ## EmitterConfigurationBase.maxGetBytes property diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.emitterconfigurationbase.maxpostbytes.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfigurationbase.maxpostbytes.md similarity index 58% rename from api-docs/docs/node-tracker/markdown/node-tracker.emitterconfigurationbase.maxpostbytes.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfigurationbase.maxpostbytes.md index 8cdcf05b5..1933473d1 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.emitterconfigurationbase.maxpostbytes.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfigurationbase.maxpostbytes.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EmitterConfigurationBase](./node-tracker.emitterconfigurationbase.md) > [maxPostBytes](./node-tracker.emitterconfigurationbase.maxpostbytes.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EmitterConfigurationBase](./react-native-tracker.emitterconfigurationbase.md) > [maxPostBytes](./react-native-tracker.emitterconfigurationbase.maxpostbytes.md) ## EmitterConfigurationBase.maxPostBytes property diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfigurationbase.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfigurationbase.md new file mode 100644 index 000000000..9aacc07ea --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfigurationbase.md @@ -0,0 +1,35 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EmitterConfigurationBase](./react-native-tracker.emitterconfigurationbase.md) + +## EmitterConfigurationBase interface + +Signature: + +```typescript +interface EmitterConfigurationBase +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [bufferSize?](./react-native-tracker.emitterconfigurationbase.buffersize.md) | number | (Optional) The amount of events that should be buffered before sending Recommended to leave as 1 to reduce change of losing events | +| [connectionTimeout?](./react-native-tracker.emitterconfigurationbase.connectiontimeout.md) | number | (Optional) How long to wait before aborting requests to the collector | +| [credentials?](./react-native-tracker.emitterconfigurationbase.credentials.md) | "omit" \| "same-origin" \| "include" | (Optional) Controls whether or not the browser sends credentials (defaults to 'include') | +| [customFetch?](./react-native-tracker.emitterconfigurationbase.customfetch.md) | (input: Request, options?: RequestInit) => Promise<Response> | (Optional) Enables overriding the default fetch function with a custom implementation. | +| [customHeaders?](./react-native-tracker.emitterconfigurationbase.customheaders.md) | Record<string, string> | (Optional) An object of key value pairs which represent headers to attach when sending a POST request, only works for POST | +| [dontRetryStatusCodes?](./react-native-tracker.emitterconfigurationbase.dontretrystatuscodes.md) | number\[\] | (Optional) List of HTTP response status codes for which events sent to Collector should not be retried in future request. Only non-success status codes are considered (greater or equal to 300). The don't retry codes are only considered for GET and POST requests. By default, the tracker retries on all non-success status codes except for 400, 401, 403, 410, and 422 (these don't retry codes will remain even if you set your own dontRetryStatusCodes but can be changed using the retryStatusCodes). | +| [eventMethod?](./react-native-tracker.emitterconfigurationbase.eventmethod.md) | EventMethod | (Optional) The preferred technique to use to send events | +| [eventStore?](./react-native-tracker.emitterconfigurationbase.eventstore.md) | EventStore | (Optional) Enables providing a custom EventStore implementation to store events before sending them to the collector. | +| [idService?](./react-native-tracker.emitterconfigurationbase.idservice.md) | string | (Optional) Id service full URL. This URL will be added to the queue and will be called using a GET method. This option is there to allow the service URL to be called in order to set any required identifiers e.g. extra cookies.The request respects the anonymousTracking option, including the SP-Anonymous header if needed, and any additional custom headers from the customHeaders option. | +| [keepalive?](./react-native-tracker.emitterconfigurationbase.keepalive.md) | boolean | (Optional) Indicates that the request should be allowed to outlive the webpage that initiated it. Enables collector requests to complete even if the page is closed or navigated away from. Note: Browsers put a limit on keepalive requests of 64KB. In case of multiple keepalive requests in parallel (may happen in case of multiple trackers), the limit is shared. | +| [maxGetBytes?](./react-native-tracker.emitterconfigurationbase.maxgetbytes.md) | number | (Optional) The max size a GET request (its complete URL) can be. Requests over this size will be tried as a POST request. | +| [maxPostBytes?](./react-native-tracker.emitterconfigurationbase.maxpostbytes.md) | number | (Optional) The max size a POST request can be before the tracker will force send it Also dictates the max size of a POST request before a batch of events is split into multiple requests | +| [onRequestFailure?](./react-native-tracker.emitterconfigurationbase.onrequestfailure.md) | (data: RequestFailure, response?: Response) => void | (Optional) A callback function to be executed whenever a request fails to be sent to the collector. This is the inverse of the onRequestSuccess callback, so any non 2xx status code will trigger this callback. | +| [onRequestSuccess?](./react-native-tracker.emitterconfigurationbase.onrequestsuccess.md) | (data: EventBatch, response: Response) => void | (Optional) A callback function to be executed whenever a request is successfully sent to the collector. In practice this means any request which returns a 2xx status code will trigger this callback. | +| [postPath?](./react-native-tracker.emitterconfigurationbase.postpath.md) | string | (Optional) The post path which events will be sent to. Ensure your collector is configured to accept events on this post path | +| [retryFailedRequests?](./react-native-tracker.emitterconfigurationbase.retryfailedrequests.md) | boolean | (Optional) Whether to retry failed requests to the collector.Failed requests are requests that failed due to \[timeouts\](https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/timeout\_event), \[network errors\](https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/error\_event), and \[abort events\](https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/abort\_event).Takes precedent over retryStatusCodes and dontRetryStatusCodes. | +| [retryStatusCodes?](./react-native-tracker.emitterconfigurationbase.retrystatuscodes.md) | number\[\] | (Optional) List of HTTP response status codes for which events sent to Collector should be retried in future requests. Only non-success status codes are considered (greater or equal to 300). The retry codes are only considered for GET and POST requests. They take priority over the dontRetryStatusCodes option. By default, the tracker retries on all non-success status codes except for 400, 401, 403, 410, and 422. | +| [useStm?](./react-native-tracker.emitterconfigurationbase.usestm.md) | boolean | (Optional) Should the Sent Timestamp be attached to events. Only applies for GET events. | + diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.emitterconfigurationbase.onrequestfailure.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfigurationbase.onrequestfailure.md similarity index 61% rename from api-docs/docs/node-tracker/markdown/node-tracker.emitterconfigurationbase.onrequestfailure.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfigurationbase.onrequestfailure.md index 2ded72a24..966c194ad 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.emitterconfigurationbase.onrequestfailure.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfigurationbase.onrequestfailure.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EmitterConfigurationBase](./node-tracker.emitterconfigurationbase.md) > [onRequestFailure](./node-tracker.emitterconfigurationbase.onrequestfailure.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EmitterConfigurationBase](./react-native-tracker.emitterconfigurationbase.md) > [onRequestFailure](./react-native-tracker.emitterconfigurationbase.onrequestfailure.md) ## EmitterConfigurationBase.onRequestFailure property diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.emitterconfigurationbase.onrequestsuccess.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfigurationbase.onrequestsuccess.md similarity index 61% rename from api-docs/docs/node-tracker/markdown/node-tracker.emitterconfigurationbase.onrequestsuccess.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfigurationbase.onrequestsuccess.md index 6f117725e..aa3a00827 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.emitterconfigurationbase.onrequestsuccess.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfigurationbase.onrequestsuccess.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EmitterConfigurationBase](./node-tracker.emitterconfigurationbase.md) > [onRequestSuccess](./node-tracker.emitterconfigurationbase.onrequestsuccess.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EmitterConfigurationBase](./react-native-tracker.emitterconfigurationbase.md) > [onRequestSuccess](./react-native-tracker.emitterconfigurationbase.onrequestsuccess.md) ## EmitterConfigurationBase.onRequestSuccess property diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.emitterconfigurationbase.postpath.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfigurationbase.postpath.md similarity index 53% rename from api-docs/docs/node-tracker/markdown/node-tracker.emitterconfigurationbase.postpath.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfigurationbase.postpath.md index 58fc97c56..f12cdb29b 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.emitterconfigurationbase.postpath.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfigurationbase.postpath.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EmitterConfigurationBase](./node-tracker.emitterconfigurationbase.md) > [postPath](./node-tracker.emitterconfigurationbase.postpath.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EmitterConfigurationBase](./react-native-tracker.emitterconfigurationbase.md) > [postPath](./react-native-tracker.emitterconfigurationbase.postpath.md) ## EmitterConfigurationBase.postPath property diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.emitterconfigurationbase.retryfailedrequests.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfigurationbase.retryfailedrequests.md similarity index 70% rename from api-docs/docs/node-tracker/markdown/node-tracker.emitterconfigurationbase.retryfailedrequests.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfigurationbase.retryfailedrequests.md index 7a32a9f98..133d36e9d 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.emitterconfigurationbase.retryfailedrequests.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfigurationbase.retryfailedrequests.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EmitterConfigurationBase](./node-tracker.emitterconfigurationbase.md) > [retryFailedRequests](./node-tracker.emitterconfigurationbase.retryfailedrequests.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EmitterConfigurationBase](./react-native-tracker.emitterconfigurationbase.md) > [retryFailedRequests](./react-native-tracker.emitterconfigurationbase.retryfailedrequests.md) ## EmitterConfigurationBase.retryFailedRequests property diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.emitterconfigurationbase.retrystatuscodes.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfigurationbase.retrystatuscodes.md similarity index 69% rename from api-docs/docs/node-tracker/markdown/node-tracker.emitterconfigurationbase.retrystatuscodes.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfigurationbase.retrystatuscodes.md index 06dac5047..2e275eb64 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.emitterconfigurationbase.retrystatuscodes.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfigurationbase.retrystatuscodes.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EmitterConfigurationBase](./node-tracker.emitterconfigurationbase.md) > [retryStatusCodes](./node-tracker.emitterconfigurationbase.retrystatuscodes.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EmitterConfigurationBase](./react-native-tracker.emitterconfigurationbase.md) > [retryStatusCodes](./react-native-tracker.emitterconfigurationbase.retrystatuscodes.md) ## EmitterConfigurationBase.retryStatusCodes property diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.emitterconfigurationbase.usestm.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfigurationbase.usestm.md similarity index 50% rename from api-docs/docs/node-tracker/markdown/node-tracker.emitterconfigurationbase.usestm.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfigurationbase.usestm.md index be353a69e..357628928 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.emitterconfigurationbase.usestm.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfigurationbase.usestm.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EmitterConfigurationBase](./node-tracker.emitterconfigurationbase.md) > [useStm](./node-tracker.emitterconfigurationbase.usestm.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EmitterConfigurationBase](./react-native-tracker.emitterconfigurationbase.md) > [useStm](./react-native-tracker.emitterconfigurationbase.usestm.md) ## EmitterConfigurationBase.useStm property diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.eventbatch.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.eventbatch.md similarity index 60% rename from api-docs/docs/node-tracker/markdown/node-tracker.eventbatch.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.eventbatch.md index c5d63edf2..3eda10ed8 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.eventbatch.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.eventbatch.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EventBatch](./node-tracker.eventbatch.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EventBatch](./react-native-tracker.eventbatch.md) ## EventBatch type diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.eventcontext.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.eventcontext.md new file mode 100644 index 000000000..9e3cbe32b --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.eventcontext.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EventContext](./react-native-tracker.eventcontext.md) + +## EventContext type + +EventContext type + +Signature: + +```typescript +export declare type EventContext = SelfDescribingJson; +``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.eventjson.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.eventjson.md similarity index 63% rename from api-docs/docs/node-tracker/markdown/node-tracker.eventjson.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.eventjson.md index 573a64802..6772b5486 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.eventjson.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.eventjson.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EventJson](./node-tracker.eventjson.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EventJson](./react-native-tracker.eventjson.md) ## EventJson type diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.eventjsonwithkeys.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.eventjsonwithkeys.md similarity index 66% rename from api-docs/docs/node-tracker/markdown/node-tracker.eventjsonwithkeys.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.eventjsonwithkeys.md index 39bfe8d8b..025ecd9e2 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.eventjsonwithkeys.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.eventjsonwithkeys.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EventJsonWithKeys](./node-tracker.eventjsonwithkeys.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EventJsonWithKeys](./react-native-tracker.eventjsonwithkeys.md) ## EventJsonWithKeys type diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.eventmethod.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.eventmethod.md similarity index 53% rename from api-docs/docs/node-tracker/markdown/node-tracker.eventmethod.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.eventmethod.md index 56f45e628..c76297fad 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.eventmethod.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.eventmethod.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EventMethod](./node-tracker.eventmethod.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EventMethod](./react-native-tracker.eventmethod.md) ## EventMethod type diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.eventpayloadandcontext.context.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.eventpayloadandcontext.context.md similarity index 50% rename from api-docs/docs/node-tracker/markdown/node-tracker.eventpayloadandcontext.context.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.eventpayloadandcontext.context.md index 450dac748..e4dfd9d8a 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.eventpayloadandcontext.context.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.eventpayloadandcontext.context.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EventPayloadAndContext](./node-tracker.eventpayloadandcontext.md) > [context](./node-tracker.eventpayloadandcontext.context.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EventPayloadAndContext](./react-native-tracker.eventpayloadandcontext.md) > [context](./react-native-tracker.eventpayloadandcontext.context.md) ## EventPayloadAndContext.context property diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.eventpayloadandcontext.event.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.eventpayloadandcontext.event.md new file mode 100644 index 000000000..4046b70a7 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.eventpayloadandcontext.event.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EventPayloadAndContext](./react-native-tracker.eventpayloadandcontext.md) > [event](./react-native-tracker.eventpayloadandcontext.event.md) + +## EventPayloadAndContext.event property + +Tracker payload for the event data + +Signature: + +```typescript +event: PayloadBuilder; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.eventpayloadandcontext.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.eventpayloadandcontext.md new file mode 100644 index 000000000..2d62a8d95 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.eventpayloadandcontext.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EventPayloadAndContext](./react-native-tracker.eventpayloadandcontext.md) + +## EventPayloadAndContext interface + +Interface for returning a built event (PayloadBuilder) and context (Array of SelfDescribingJson). + +Signature: + +```typescript +interface EventPayloadAndContext +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [context](./react-native-tracker.eventpayloadandcontext.context.md) | Array<SelfDescribingJson> | List of context entities to track along with the event | +| [event](./react-native-tracker.eventpayloadandcontext.event.md) | PayloadBuilder | Tracker payload for the event data | + diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.eventstore.add.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.eventstore.add.md similarity index 52% rename from api-docs/docs/node-tracker/markdown/node-tracker.eventstore.add.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.eventstore.add.md index b63a8d256..4df471956 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.eventstore.add.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.eventstore.add.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EventStore](./node-tracker.eventstore.md) > [add](./node-tracker.eventstore.add.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EventStore](./react-native-tracker.eventstore.md) > [add](./react-native-tracker.eventstore.add.md) ## EventStore.add property diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.eventstore.count.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.eventstore.count.md similarity index 50% rename from api-docs/docs/node-tracker/markdown/node-tracker.eventstore.count.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.eventstore.count.md index cd321fb5a..93ae88e58 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.eventstore.count.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.eventstore.count.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EventStore](./node-tracker.eventstore.md) > [count](./node-tracker.eventstore.count.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EventStore](./react-native-tracker.eventstore.md) > [count](./react-native-tracker.eventstore.count.md) ## EventStore.count property diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.eventstore.getall.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.eventstore.getall.md similarity index 56% rename from api-docs/docs/node-tracker/markdown/node-tracker.eventstore.getall.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.eventstore.getall.md index 353635c20..361437923 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.eventstore.getall.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.eventstore.getall.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EventStore](./node-tracker.eventstore.md) > [getAll](./node-tracker.eventstore.getall.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EventStore](./react-native-tracker.eventstore.md) > [getAll](./react-native-tracker.eventstore.getall.md) ## EventStore.getAll property diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.eventstore.getallpayloads.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.eventstore.getallpayloads.md similarity index 52% rename from api-docs/docs/node-tracker/markdown/node-tracker.eventstore.getallpayloads.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.eventstore.getallpayloads.md index 43bc85fb6..560ec1afd 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.eventstore.getallpayloads.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.eventstore.getallpayloads.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EventStore](./node-tracker.eventstore.md) > [getAllPayloads](./node-tracker.eventstore.getallpayloads.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EventStore](./react-native-tracker.eventstore.md) > [getAllPayloads](./react-native-tracker.eventstore.getallpayloads.md) ## EventStore.getAllPayloads property diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.eventstore.iterator.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.eventstore.iterator.md similarity index 52% rename from api-docs/docs/node-tracker/markdown/node-tracker.eventstore.iterator.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.eventstore.iterator.md index 0eace0e1c..cbe60f86a 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.eventstore.iterator.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.eventstore.iterator.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EventStore](./node-tracker.eventstore.md) > [iterator](./node-tracker.eventstore.iterator.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EventStore](./react-native-tracker.eventstore.md) > [iterator](./react-native-tracker.eventstore.iterator.md) ## EventStore.iterator property diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.eventstore.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.eventstore.md new file mode 100644 index 000000000..a93a671ec --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.eventstore.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EventStore](./react-native-tracker.eventstore.md) + +## EventStore interface + +EventStore allows storing and retrieving events before they are sent to the collector + +Signature: + +```typescript +interface EventStore +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [add](./react-native-tracker.eventstore.add.md) | (payload: EventStorePayload) => Promise<number> | Add an event to the store | +| [count](./react-native-tracker.eventstore.count.md) | () => Promise<number> | Count all events in the store | +| [getAll](./react-native-tracker.eventstore.getall.md) | () => Promise<readonly EventStorePayload\[\]> | Retrieve all payloads including their meta configuration in the store | +| [getAllPayloads](./react-native-tracker.eventstore.getallpayloads.md) | () => Promise<readonly Payload\[\]> | Retrieve all pure payloads in the store | +| [iterator](./react-native-tracker.eventstore.iterator.md) | () => EventStoreIterator | Get an iterator over all events in the store | +| [removeHead](./react-native-tracker.eventstore.removehead.md) | (count: number) => Promise<void> | Remove the first count events from the store | + diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.eventstore.removehead.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.eventstore.removehead.md similarity index 53% rename from api-docs/docs/node-tracker/markdown/node-tracker.eventstore.removehead.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.eventstore.removehead.md index 8bfe8ad87..5b1585196 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.eventstore.removehead.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.eventstore.removehead.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EventStore](./node-tracker.eventstore.md) > [removeHead](./node-tracker.eventstore.removehead.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EventStore](./react-native-tracker.eventstore.md) > [removeHead](./react-native-tracker.eventstore.removehead.md) ## EventStore.removeHead property diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.eventstoreconfiguration.maxeventstoresize.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.eventstoreconfiguration.maxeventstoresize.md new file mode 100644 index 000000000..ccc4debe4 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.eventstoreconfiguration.maxeventstoresize.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EventStoreConfiguration](./react-native-tracker.eventstoreconfiguration.md) > [maxEventStoreSize](./react-native-tracker.eventstoreconfiguration.maxeventstoresize.md) + +## EventStoreConfiguration.maxEventStoreSize property + +The maximum amount of events that will be buffered in the event store + +Will drop events once the limit is hit + +Signature: + +```typescript +maxEventStoreSize?: number; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.eventstoreconfiguration.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.eventstoreconfiguration.md new file mode 100644 index 000000000..c83885790 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.eventstoreconfiguration.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EventStoreConfiguration](./react-native-tracker.eventstoreconfiguration.md) + +## EventStoreConfiguration interface + +Configuration for the event store + +Signature: + +```typescript +export interface EventStoreConfiguration +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [maxEventStoreSize?](./react-native-tracker.eventstoreconfiguration.maxeventstoresize.md) | number | (Optional) The maximum amount of events that will be buffered in the event storeWill drop events once the limit is hit | +| [useAsyncStorageForEventStore?](./react-native-tracker.eventstoreconfiguration.useasyncstorageforeventstore.md) | boolean | (Optional) Whether to use the AsyncStorage library as the persistent event store for the event store | + diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.eventstoreconfiguration.useasyncstorageforeventstore.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.eventstoreconfiguration.useasyncstorageforeventstore.md new file mode 100644 index 000000000..275e64ede --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.eventstoreconfiguration.useasyncstorageforeventstore.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EventStoreConfiguration](./react-native-tracker.eventstoreconfiguration.md) > [useAsyncStorageForEventStore](./react-native-tracker.eventstoreconfiguration.useasyncstorageforeventstore.md) + +## EventStoreConfiguration.useAsyncStorageForEventStore property + +Whether to use the AsyncStorage library as the persistent event store for the event store + +Signature: + +```typescript +useAsyncStorageForEventStore?: boolean; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.eventstoreiterator.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.eventstoreiterator.md new file mode 100644 index 000000000..4b9d4e13b --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.eventstoreiterator.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EventStoreIterator](./react-native-tracker.eventstoreiterator.md) + +## EventStoreIterator interface + +EventStoreIterator allows iterating over all events in the store. + +Signature: + +```typescript +interface EventStoreIterator +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [next](./react-native-tracker.eventstoreiterator.next.md) | () => Promise<EventStoreIteratorNextResult> | Retrieve the next event in the store | + diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.eventstoreiterator.next.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.eventstoreiterator.next.md similarity index 51% rename from api-docs/docs/node-tracker/markdown/node-tracker.eventstoreiterator.next.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.eventstoreiterator.next.md index d1cd8e14e..c2e95a935 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.eventstoreiterator.next.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.eventstoreiterator.next.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EventStoreIterator](./node-tracker.eventstoreiterator.md) > [next](./node-tracker.eventstoreiterator.next.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EventStoreIterator](./react-native-tracker.eventstoreiterator.md) > [next](./react-native-tracker.eventstoreiterator.next.md) ## EventStoreIterator.next property diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.eventstorepayload.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.eventstorepayload.md new file mode 100644 index 000000000..472ba6f8f --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.eventstorepayload.md @@ -0,0 +1,19 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EventStorePayload](./react-native-tracker.eventstorepayload.md) + +## EventStorePayload interface + +Signature: + +```typescript +interface EventStorePayload +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [payload](./react-native-tracker.eventstorepayload.payload.md) | Payload | The event payload to be stored | +| [svrAnon?](./react-native-tracker.eventstorepayload.svranon.md) | boolean | (Optional) If the request should undergo server anonymization. | + diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.eventstorepayload.payload.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.eventstorepayload.payload.md new file mode 100644 index 000000000..76807caf0 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.eventstorepayload.payload.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EventStorePayload](./react-native-tracker.eventstorepayload.md) > [payload](./react-native-tracker.eventstorepayload.payload.md) + +## EventStorePayload.payload property + +The event payload to be stored + +Signature: + +```typescript +payload: Payload; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.eventstorepayload.svranon.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.eventstorepayload.svranon.md new file mode 100644 index 000000000..5db52ecfc --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.eventstorepayload.svranon.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EventStorePayload](./react-native-tracker.eventstorepayload.md) > [svrAnon](./react-native-tracker.eventstorepayload.svranon.md) + +## EventStorePayload.svrAnon property + +If the request should undergo server anonymization. + +Signature: + +```typescript +svrAnon?: boolean; +``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.filterprovider.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.filterprovider.md similarity index 72% rename from api-docs/docs/node-tracker/markdown/node-tracker.filterprovider.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.filterprovider.md index 20ce14b69..a58d155e1 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.filterprovider.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.filterprovider.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [FilterProvider](./node-tracker.filterprovider.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [FilterProvider](./react-native-tracker.filterprovider.md) ## FilterProvider type diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.formfocusorchangeevent.elementclasses.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.formfocusorchangeevent.elementclasses.md new file mode 100644 index 000000000..f5fcd4679 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.formfocusorchangeevent.elementclasses.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [FormFocusOrChangeEvent](./react-native-tracker.formfocusorchangeevent.md) > [elementClasses](./react-native-tracker.formfocusorchangeevent.elementclasses.md) + +## FormFocusOrChangeEvent.elementClasses property + +The class names on the element + +Signature: + +```typescript +elementClasses?: Array | null; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.formfocusorchangeevent.elementid.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.formfocusorchangeevent.elementid.md new file mode 100644 index 000000000..b0432e03b --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.formfocusorchangeevent.elementid.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [FormFocusOrChangeEvent](./react-native-tracker.formfocusorchangeevent.md) > [elementId](./react-native-tracker.formfocusorchangeevent.elementid.md) + +## FormFocusOrChangeEvent.elementId property + +The element ID which the user is interacting with + +Signature: + +```typescript +elementId: string; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.formfocusorchangeevent.formid.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.formfocusorchangeevent.formid.md new file mode 100644 index 000000000..2d90c18ee --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.formfocusorchangeevent.formid.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [FormFocusOrChangeEvent](./react-native-tracker.formfocusorchangeevent.md) > [formId](./react-native-tracker.formfocusorchangeevent.formid.md) + +## FormFocusOrChangeEvent.formId property + +The ID of the form which the element belongs to + +Signature: + +```typescript +formId: string; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.formfocusorchangeevent.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.formfocusorchangeevent.md new file mode 100644 index 000000000..534758912 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.formfocusorchangeevent.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [FormFocusOrChangeEvent](./react-native-tracker.formfocusorchangeevent.md) + +## FormFocusOrChangeEvent interface + +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. + +Signature: + +```typescript +interface FormFocusOrChangeEvent +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [elementClasses?](./react-native-tracker.formfocusorchangeevent.elementclasses.md) | Array<string> \| null | (Optional) The class names on the element | +| [elementId](./react-native-tracker.formfocusorchangeevent.elementid.md) | string | The element ID which the user is interacting with | +| [formId](./react-native-tracker.formfocusorchangeevent.formid.md) | string | The ID of the form which the element belongs to | +| [nodeName](./react-native-tracker.formfocusorchangeevent.nodename.md) | string | The name of the node ("INPUT", "TEXTAREA", "SELECT") | +| [schema](./react-native-tracker.formfocusorchangeevent.schema.md) | "change\_form" \| "focus\_form" | The schema which will be used for the event | +| [type?](./react-native-tracker.formfocusorchangeevent.type.md) | string \| null | (Optional) The type of element (e.g. "datetime", "text", "radio", etc.) | +| [value](./react-native-tracker.formfocusorchangeevent.value.md) | string \| null | The value of the element at the time of the event firing | + diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.formfocusorchangeevent.nodename.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.formfocusorchangeevent.nodename.md new file mode 100644 index 000000000..ee9f369ae --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.formfocusorchangeevent.nodename.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [FormFocusOrChangeEvent](./react-native-tracker.formfocusorchangeevent.md) > [nodeName](./react-native-tracker.formfocusorchangeevent.nodename.md) + +## FormFocusOrChangeEvent.nodeName property + +The name of the node ("INPUT", "TEXTAREA", "SELECT") + +Signature: + +```typescript +nodeName: string; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.formfocusorchangeevent.schema.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.formfocusorchangeevent.schema.md new file mode 100644 index 000000000..474e39187 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.formfocusorchangeevent.schema.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [FormFocusOrChangeEvent](./react-native-tracker.formfocusorchangeevent.md) > [schema](./react-native-tracker.formfocusorchangeevent.schema.md) + +## FormFocusOrChangeEvent.schema property + +The schema which will be used for the event + +Signature: + +```typescript +schema: "change_form" | "focus_form"; +``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.formfocusorchangeevent.type.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.formfocusorchangeevent.type.md similarity index 50% rename from api-docs/docs/node-tracker/markdown/node-tracker.formfocusorchangeevent.type.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.formfocusorchangeevent.type.md index cc6feca41..da56b8396 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.formfocusorchangeevent.type.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.formfocusorchangeevent.type.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [FormFocusOrChangeEvent](./node-tracker.formfocusorchangeevent.md) > [type](./node-tracker.formfocusorchangeevent.type.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [FormFocusOrChangeEvent](./react-native-tracker.formfocusorchangeevent.md) > [type](./react-native-tracker.formfocusorchangeevent.type.md) ## FormFocusOrChangeEvent.type property diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.formfocusorchangeevent.value.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.formfocusorchangeevent.value.md new file mode 100644 index 000000000..9af73bad8 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.formfocusorchangeevent.value.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [FormFocusOrChangeEvent](./react-native-tracker.formfocusorchangeevent.md) > [value](./react-native-tracker.formfocusorchangeevent.value.md) + +## FormFocusOrChangeEvent.value property + +The value of the element at the time of the event firing + +Signature: + +```typescript +value: string | null; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.getalltrackers.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.getalltrackers.md new file mode 100644 index 000000000..2d148726e --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.getalltrackers.md @@ -0,0 +1,19 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [getAllTrackers](./react-native-tracker.getalltrackers.md) + +## getAllTrackers() function + +Retrieves all initialized trackers + +Signature: + +```typescript +export declare function getAllTrackers(): ReactNativeTracker[]; +``` +Returns: + +[ReactNativeTracker](./react-native-tracker.reactnativetracker.md)\[\] + +All initialized trackers + diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.gettracker.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.gettracker.md new file mode 100644 index 000000000..7a3376ae2 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.gettracker.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [getTracker](./react-native-tracker.gettracker.md) + +## getTracker() function + +Retrieves an initialized tracker given its namespace + +Signature: + +```typescript +export declare function getTracker(trackerNamespace: string): ReactNativeTracker | undefined; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| trackerNamespace | string | Tracker namespace | + +Returns: + +[ReactNativeTracker](./react-native-tracker.reactnativetracker.md) \| undefined + +Tracker instance if exists + diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.getwebviewcallback.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.getwebviewcallback.md new file mode 100644 index 000000000..eb5648225 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.getwebviewcallback.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [getWebViewCallback](./react-native-tracker.getwebviewcallback.md) + +## getWebViewCallback() function + +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, set the `onMessage` attribute: `` + +Signature: + +```typescript +export declare function getWebViewCallback(): (message: { + nativeEvent: { + data: string; + }; +}) => void; +``` +Returns: + +(message: { nativeEvent: { data: string; }; }) => void + +Callback to subscribe for events from Web views tracked using the Snowplow WebView tracker. + diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.jsonprocessor.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.jsonprocessor.md similarity index 69% rename from api-docs/docs/node-tracker/markdown/node-tracker.jsonprocessor.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.jsonprocessor.md index cc2f190c2..35d77f46d 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.jsonprocessor.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.jsonprocessor.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [JsonProcessor](./node-tracker.jsonprocessor.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [JsonProcessor](./react-native-tracker.jsonprocessor.md) ## JsonProcessor type diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.listitemviewprops.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.listitemviewprops.md new file mode 100644 index 000000000..70e90a10f --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.listitemviewprops.md @@ -0,0 +1,18 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [ListItemViewProps](./react-native-tracker.listitemviewprops.md) + +## ListItemViewProps type + +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` + +Signature: + +```typescript +export declare type ListItemViewProps = { + index: number; + itemsCount?: number; +}; +``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.log_level.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.log_level.md similarity index 71% rename from api-docs/docs/node-tracker/markdown/node-tracker.log_level.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.log_level.md index 745f621c1..820f56307 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.log_level.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.log_level.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [LOG\_LEVEL](./node-tracker.log_level.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [LOG\_LEVEL](./react-native-tracker.log_level.md) ## LOG\_LEVEL enum diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.logger.debug.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.logger.debug.md similarity index 51% rename from api-docs/docs/node-tracker/markdown/node-tracker.logger.debug.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.logger.debug.md index f4617e1b8..a5470c124 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.logger.debug.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.logger.debug.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [Logger](./node-tracker.logger.md) > [debug](./node-tracker.logger.debug.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [Logger](./react-native-tracker.logger.md) > [debug](./react-native-tracker.logger.debug.md) ## Logger.debug property diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.logger.error.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.logger.error.md similarity index 53% rename from api-docs/docs/node-tracker/markdown/node-tracker.logger.error.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.logger.error.md index baec2704d..b13733fc3 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.logger.error.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.logger.error.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [Logger](./node-tracker.logger.md) > [error](./node-tracker.logger.error.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [Logger](./react-native-tracker.logger.md) > [error](./react-native-tracker.logger.error.md) ## Logger.error property diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.logger.info.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.logger.info.md similarity index 51% rename from api-docs/docs/node-tracker/markdown/node-tracker.logger.info.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.logger.info.md index ea9410890..27b3239e6 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.logger.info.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.logger.info.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [Logger](./node-tracker.logger.md) > [info](./node-tracker.logger.info.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [Logger](./react-native-tracker.logger.md) > [info](./react-native-tracker.logger.info.md) ## Logger.info property diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.logger.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.logger.md new file mode 100644 index 000000000..edbfd7edd --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.logger.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [Logger](./react-native-tracker.logger.md) + +## Logger interface + +Signature: + +```typescript +interface Logger +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [debug](./react-native-tracker.logger.debug.md) | (message: string, ...extraParams: unknown\[\]) => void | | +| [error](./react-native-tracker.logger.error.md) | (message: string, error?: unknown, ...extraParams: unknown\[\]) => void | | +| [info](./react-native-tracker.logger.info.md) | (message: string, ...extraParams: unknown\[\]) => void | | +| [setLogLevel](./react-native-tracker.logger.setloglevel.md) | (level: LOG\_LEVEL) => void | | +| [warn](./react-native-tracker.logger.warn.md) | (message: string, error?: unknown, ...extraParams: unknown\[\]) => void | | + diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.logger.setloglevel.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.logger.setloglevel.md new file mode 100644 index 000000000..700d5b330 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.logger.setloglevel.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [Logger](./react-native-tracker.logger.md) > [setLogLevel](./react-native-tracker.logger.setloglevel.md) + +## Logger.setLogLevel property + +Signature: + +```typescript +setLogLevel: (level: LOG_LEVEL) => void; +``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.logger.warn.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.logger.warn.md similarity index 53% rename from api-docs/docs/node-tracker/markdown/node-tracker.logger.warn.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.logger.warn.md index deb16cc0f..07bd67498 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.logger.warn.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.logger.warn.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [Logger](./node-tracker.logger.md) > [warn](./node-tracker.logger.warn.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [Logger](./react-native-tracker.logger.md) > [warn](./react-native-tracker.logger.warn.md) ## Logger.warn property diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.md new file mode 100644 index 000000000..977384fa6 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.md @@ -0,0 +1,94 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) + +## react-native-tracker package + +## Enumerations + +| Enumeration | Description | +| --- | --- | +| [LOG\_LEVEL](./react-native-tracker.log_level.md) | | +| [PlatformContextProperty](./react-native-tracker.platformcontextproperty.md) | | + +## Functions + +| Function | Description | +| --- | --- | +| [getAllTrackers()](./react-native-tracker.getalltrackers.md) | Retrieves all initialized trackers | +| [getTracker(trackerNamespace)](./react-native-tracker.gettracker.md) | Retrieves an initialized tracker given its namespace | +| [getWebViewCallback()](./react-native-tracker.getwebviewcallback.md) | 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, set the onMessage attribute: <WebView onMessage={getWebViewCallback()} ... /> | +| [newTracker(configuration)](./react-native-tracker.newtracker.md) | Creates a new tracker instance with the given configuration | +| [removeAllTrackers()](./react-native-tracker.removealltrackers.md) | Removes all initialized trackers | +| [removeTracker(trackerNamespace)](./react-native-tracker.removetracker.md) | Removes a tracker given its namespace | + +## Interfaces + +| Interface | Description | +| --- | --- | +| [AppLifecycleConfiguration](./react-native-tracker.applifecycleconfiguration.md) | Configuration for app lifecycle tracking | +| [CoreConfiguration](./react-native-tracker.coreconfiguration.md) | The configuration object for the tracker core library | +| [CorePlugin](./react-native-tracker.coreplugin.md) | Interface which defines Core Plugins | +| [CorePluginConfiguration](./react-native-tracker.corepluginconfiguration.md) | The configuration of the plugin to add | +| [DeepLinkConfiguration](./react-native-tracker.deeplinkconfiguration.md) | Configuration for deep link tracking | +| [DeviceTimestamp](./react-native-tracker.devicetimestamp.md) | A representation of a Device Timestamp (dtm) | +| [Emitter](./react-native-tracker.emitter.md) | Emitter is responsible for sending events to the collector. It manages the event queue and sends events in batches depending on configuration. | +| [EmitterConfiguration](./react-native-tracker.emitterconfiguration.md) | | +| [EmitterConfigurationBase](./react-native-tracker.emitterconfigurationbase.md) | | +| [EventPayloadAndContext](./react-native-tracker.eventpayloadandcontext.md) | Interface for returning a built event (PayloadBuilder) and context (Array of SelfDescribingJson). | +| [EventStore](./react-native-tracker.eventstore.md) | EventStore allows storing and retrieving events before they are sent to the collector | +| [EventStoreConfiguration](./react-native-tracker.eventstoreconfiguration.md) | Configuration for the event store | +| [EventStoreIterator](./react-native-tracker.eventstoreiterator.md) | EventStoreIterator allows iterating over all events in the store. | +| [EventStorePayload](./react-native-tracker.eventstorepayload.md) | | +| [FormFocusOrChangeEvent](./react-native-tracker.formfocusorchangeevent.md) | 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](./react-native-tracker.logger.md) | | +| [PageViewEvent](./react-native-tracker.pageviewevent.md) | 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](./react-native-tracker.payloadbuilder.md) | Interface for mutable object encapsulating tracker payload | +| [PlatformContextConfiguration](./react-native-tracker.platformcontextconfiguration.md) | | +| [PlatformContextRetriever](./react-native-tracker.platformcontextretriever.md) | Overrides for the values for properties of the platform context. | +| [RuleSet](./react-native-tracker.ruleset.md) | A ruleset has accept or reject properties that contain rules for matching Iglu schema URIs | +| [SessionConfiguration](./react-native-tracker.sessionconfiguration.md) | Configuration for session tracking | +| [SessionState](./react-native-tracker.sessionstate.md) | Current session state that is tracked in events. | +| [SubjectConfiguration](./react-native-tracker.subjectconfiguration.md) | Configuration of subject properties tracked with events | +| [TrackerConfiguration](./react-native-tracker.trackerconfiguration.md) | The configuration object for initialising the tracker | +| [TrackerCore](./react-native-tracker.trackercore.md) | Export interface containing all Core functions | +| [TrueTimestamp](./react-native-tracker.truetimestamp.md) | A representation of a True Timestamp (ttm) | + +## Variables + +| Variable | Description | +| --- | --- | +| [version](./react-native-tracker.version.md) | | + +## Type Aliases + +| Type Alias | Description | +| --- | --- | +| [ConditionalContextProvider](./react-native-tracker.conditionalcontextprovider.md) | 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](./react-native-tracker.contextfilter.md) | 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](./react-native-tracker.contextgenerator.md) | 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](./react-native-tracker.contextprimitive.md) | A context primitive is either a self-describing JSON or a context generator | +| [DeepLinkReceivedProps](./react-native-tracker.deeplinkreceivedprops.md) | DeepLinkReceived event properties schema: iglu:com.snowplowanalytics.mobile/deep\_link\_received/jsonschema/1-0-0 | +| [EventBatch](./react-native-tracker.eventbatch.md) | A collection of event payloads which are sent to the collector. | +| [EventContext](./react-native-tracker.eventcontext.md) | EventContext type | +| [EventJson](./react-native-tracker.eventjson.md) | An array of tuples which represents the unprocessed JSON to be added to the Payload | +| [EventJsonWithKeys](./react-native-tracker.eventjsonwithkeys.md) | A tuple which represents the unprocessed JSON to be added to the Payload | +| [EventMethod](./react-native-tracker.eventmethod.md) | | +| [FilterProvider](./react-native-tracker.filterprovider.md) | 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](./react-native-tracker.jsonprocessor.md) | A function which will processor the Json onto the injected PayloadBuilder | +| [ListItemViewProps](./react-native-tracker.listitemviewprops.md) | 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](./react-native-tracker.messagenotificationattachmentprops.md) | Attachment object that identify an attachment in the MessageNotification. | +| [MessageNotificationProps](./react-native-tracker.messagenotificationprops.md) | MessageNotification event properties schema: iglu:com.snowplowanalytics.mobile/message\_notification/jsonschema/1-0-0 | +| [Payload](./react-native-tracker.payload.md) | Type for a Payload dictionary | +| [ReactNativeTracker](./react-native-tracker.reactnativetracker.md) | The ReactNativeTracker type | +| [RequestFailure](./react-native-tracker.requestfailure.md) | The data that will be available to the onRequestFailure callback | +| [RuleSetProvider](./react-native-tracker.rulesetprovider.md) | 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](./react-native-tracker.screensize.md) | Screen size in pixels | +| [ScreenViewProps](./react-native-tracker.screenviewprops.md) | ScreenView event properties schema: iglu:com.snowplowanalytics.mobile/screen\_view/jsonschema/1-0-0 | +| [ScrollChangedProps](./react-native-tracker.scrollchangedprops.md) | 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](./react-native-tracker.selfdescribing.md) | Interface for any self-describing JSON such as context entities or self-describing events | +| [StructuredProps](./react-native-tracker.structuredprops.md) | 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](./react-native-tracker.timestamp.md) | Algebraic datatype representing possible timestamp type choice | +| [TimingProps](./react-native-tracker.timingprops.md) | Timing event properties | +| [Trigger](./react-native-tracker.trigger.md) | Trigger for MessageNotification event | + diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.messagenotificationattachmentprops.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.messagenotificationattachmentprops.md new file mode 100644 index 000000000..fe7d17288 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.messagenotificationattachmentprops.md @@ -0,0 +1,17 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [MessageNotificationAttachmentProps](./react-native-tracker.messagenotificationattachmentprops.md) + +## MessageNotificationAttachmentProps type + +Attachment object that identify an attachment in the MessageNotification. + +Signature: + +```typescript +export declare type MessageNotificationAttachmentProps = { + identifier: string; + type: string; + url: string; +}; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.messagenotificationprops.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.messagenotificationprops.md new file mode 100644 index 000000000..392fe4a38 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.messagenotificationprops.md @@ -0,0 +1,35 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [MessageNotificationProps](./react-native-tracker.messagenotificationprops.md) + +## MessageNotificationProps type + +MessageNotification event properties schema: iglu:com.snowplowanalytics.mobile/message\_notification/jsonschema/1-0-0 + +Signature: + +```typescript +export declare type MessageNotificationProps = { + action?: string; + attachments?: MessageNotificationAttachmentProps[]; + body: string; + bodyLocArgs?: string[]; + bodyLocKey?: string; + category?: string; + contentAvailable?: boolean; + group?: string; + icon?: string; + notificationCount?: number; + notificationTimestamp?: string; + sound?: string; + subtitle?: string; + tag?: string; + threadIdentifier?: string; + title: string; + titleLocArgs?: string[]; + titleLocKey?: string; + trigger: Trigger; +}; +``` +References: [MessageNotificationAttachmentProps](./react-native-tracker.messagenotificationattachmentprops.md), [Trigger](./react-native-tracker.trigger.md) + diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.newtracker.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.newtracker.md new file mode 100644 index 000000000..00c5af61d --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.newtracker.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [newTracker](./react-native-tracker.newtracker.md) + +## newTracker() function + +Creates a new tracker instance with the given configuration + +Signature: + +```typescript +export declare function newTracker(configuration: TrackerConfiguration & EmitterConfiguration & SessionConfiguration & SubjectConfiguration & EventStoreConfiguration & ScreenTrackingConfiguration & PlatformContextConfiguration & DeepLinkConfiguration & AppLifecycleConfiguration): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| configuration | [TrackerConfiguration](./react-native-tracker.trackerconfiguration.md) & EmitterConfiguration & [SessionConfiguration](./react-native-tracker.sessionconfiguration.md) & [SubjectConfiguration](./react-native-tracker.subjectconfiguration.md) & [EventStoreConfiguration](./react-native-tracker.eventstoreconfiguration.md) & ScreenTrackingConfiguration & [PlatformContextConfiguration](./react-native-tracker.platformcontextconfiguration.md) & [DeepLinkConfiguration](./react-native-tracker.deeplinkconfiguration.md) & [AppLifecycleConfiguration](./react-native-tracker.applifecycleconfiguration.md) | Configuration for the tracker | + +Returns: + +Promise<[ReactNativeTracker](./react-native-tracker.reactnativetracker.md)> + +Tracker instance + diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.pageviewevent.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.pageviewevent.md new file mode 100644 index 000000000..87f820cf5 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.pageviewevent.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [PageViewEvent](./react-native-tracker.pageviewevent.md) + +## PageViewEvent interface + +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). + +Signature: + +```typescript +interface PageViewEvent +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [pageTitle?](./react-native-tracker.pageviewevent.pagetitle.md) | string \| null | (Optional) The current page title in the users browser | +| [pageUrl?](./react-native-tracker.pageviewevent.pageurl.md) | string \| null | (Optional) The current URL visible in the users browser | +| [referrer?](./react-native-tracker.pageviewevent.referrer.md) | string \| null | (Optional) The URL of the referring page | + diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.pageviewevent.pagetitle.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.pageviewevent.pagetitle.md similarity index 50% rename from api-docs/docs/node-tracker/markdown/node-tracker.pageviewevent.pagetitle.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.pageviewevent.pagetitle.md index 45d440241..b7bf7a9e9 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.pageviewevent.pagetitle.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.pageviewevent.pagetitle.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [PageViewEvent](./node-tracker.pageviewevent.md) > [pageTitle](./node-tracker.pageviewevent.pagetitle.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [PageViewEvent](./react-native-tracker.pageviewevent.md) > [pageTitle](./react-native-tracker.pageviewevent.pagetitle.md) ## PageViewEvent.pageTitle property diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.pageviewevent.pageurl.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.pageviewevent.pageurl.md similarity index 50% rename from api-docs/docs/node-tracker/markdown/node-tracker.pageviewevent.pageurl.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.pageviewevent.pageurl.md index dff6ff16f..048e84af6 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.pageviewevent.pageurl.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.pageviewevent.pageurl.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [PageViewEvent](./node-tracker.pageviewevent.md) > [pageUrl](./node-tracker.pageviewevent.pageurl.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [PageViewEvent](./react-native-tracker.pageviewevent.md) > [pageUrl](./react-native-tracker.pageviewevent.pageurl.md) ## PageViewEvent.pageUrl property diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.pageviewevent.referrer.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.pageviewevent.referrer.md new file mode 100644 index 000000000..9796c0cd6 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.pageviewevent.referrer.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [PageViewEvent](./react-native-tracker.pageviewevent.md) > [referrer](./react-native-tracker.pageviewevent.referrer.md) + +## PageViewEvent.referrer property + +The URL of the referring page + +Signature: + +```typescript +referrer?: string | null; +``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.payload.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.payload.md similarity index 58% rename from api-docs/docs/node-tracker/markdown/node-tracker.payload.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.payload.md index 69b929d26..37d76b5ad 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.payload.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.payload.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [Payload](./node-tracker.payload.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [Payload](./react-native-tracker.payload.md) ## Payload type diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.payloadbuilder.add.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.payloadbuilder.add.md similarity index 50% rename from api-docs/docs/node-tracker/markdown/node-tracker.payloadbuilder.add.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.payloadbuilder.add.md index 979815d0b..74190086a 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.payloadbuilder.add.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.payloadbuilder.add.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [PayloadBuilder](./node-tracker.payloadbuilder.md) > [add](./node-tracker.payloadbuilder.add.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [PayloadBuilder](./react-native-tracker.payloadbuilder.md) > [add](./react-native-tracker.payloadbuilder.add.md) ## PayloadBuilder.add property diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.payloadbuilder.addcontextentity.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.payloadbuilder.addcontextentity.md similarity index 53% rename from api-docs/docs/node-tracker/markdown/node-tracker.payloadbuilder.addcontextentity.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.payloadbuilder.addcontextentity.md index 84929af64..4b6346ea6 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.payloadbuilder.addcontextentity.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.payloadbuilder.addcontextentity.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [PayloadBuilder](./node-tracker.payloadbuilder.md) > [addContextEntity](./node-tracker.payloadbuilder.addcontextentity.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [PayloadBuilder](./react-native-tracker.payloadbuilder.md) > [addContextEntity](./react-native-tracker.payloadbuilder.addcontextentity.md) ## PayloadBuilder.addContextEntity property diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.payloadbuilder.adddict.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.payloadbuilder.adddict.md similarity index 50% rename from api-docs/docs/node-tracker/markdown/node-tracker.payloadbuilder.adddict.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.payloadbuilder.adddict.md index a4fa7da8a..720e5fbea 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.payloadbuilder.adddict.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.payloadbuilder.adddict.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [PayloadBuilder](./node-tracker.payloadbuilder.md) > [addDict](./node-tracker.payloadbuilder.adddict.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [PayloadBuilder](./react-native-tracker.payloadbuilder.md) > [addDict](./react-native-tracker.payloadbuilder.adddict.md) ## PayloadBuilder.addDict property diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.payloadbuilder.addjson.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.payloadbuilder.addjson.md similarity index 57% rename from api-docs/docs/node-tracker/markdown/node-tracker.payloadbuilder.addjson.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.payloadbuilder.addjson.md index 0e572fb3c..fb29f5c20 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.payloadbuilder.addjson.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.payloadbuilder.addjson.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [PayloadBuilder](./node-tracker.payloadbuilder.md) > [addJson](./node-tracker.payloadbuilder.addjson.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [PayloadBuilder](./react-native-tracker.payloadbuilder.md) > [addJson](./react-native-tracker.payloadbuilder.addjson.md) ## PayloadBuilder.addJson property diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.payloadbuilder.build.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.payloadbuilder.build.md new file mode 100644 index 000000000..473ffa6d9 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.payloadbuilder.build.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [PayloadBuilder](./react-native-tracker.payloadbuilder.md) > [build](./react-native-tracker.payloadbuilder.build.md) + +## PayloadBuilder.build property + +Builds and returns the Payload + +Signature: + +```typescript +build: () => Payload; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.payloadbuilder.getjson.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.payloadbuilder.getjson.md new file mode 100644 index 000000000..0007e17f7 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.payloadbuilder.getjson.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [PayloadBuilder](./react-native-tracker.payloadbuilder.md) > [getJson](./react-native-tracker.payloadbuilder.getjson.md) + +## PayloadBuilder.getJson property + +Gets all JSON objects added to payload + +Signature: + +```typescript +getJson: () => EventJson; +``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.payloadbuilder.getpayload.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.payloadbuilder.getpayload.md similarity index 51% rename from api-docs/docs/node-tracker/markdown/node-tracker.payloadbuilder.getpayload.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.payloadbuilder.getpayload.md index 0c704fd6b..f76229127 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.payloadbuilder.getpayload.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.payloadbuilder.getpayload.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [PayloadBuilder](./node-tracker.payloadbuilder.md) > [getPayload](./node-tracker.payloadbuilder.getpayload.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [PayloadBuilder](./react-native-tracker.payloadbuilder.md) > [getPayload](./react-native-tracker.payloadbuilder.getpayload.md) ## PayloadBuilder.getPayload property diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.payloadbuilder.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.payloadbuilder.md new file mode 100644 index 000000000..656667e94 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.payloadbuilder.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [PayloadBuilder](./react-native-tracker.payloadbuilder.md) + +## PayloadBuilder interface + +Interface for mutable object encapsulating tracker payload + +Signature: + +```typescript +interface PayloadBuilder +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [add](./react-native-tracker.payloadbuilder.add.md) | (key: string, value: unknown) => void | Adds an entry to the Payload | +| [addContextEntity](./react-native-tracker.payloadbuilder.addcontextentity.md) | (entity: SelfDescribingJson) => void | Caches a context entity to be added to payload on build | +| [addDict](./react-native-tracker.payloadbuilder.adddict.md) | (dict: Payload) => void | Merges a payload into the existing payload | +| [addJson](./react-native-tracker.payloadbuilder.addjson.md) | (keyIfEncoded: string, keyIfNotEncoded: string, json: Record<string, unknown>) => void | Caches a JSON object to be added to payload on build | +| [build](./react-native-tracker.payloadbuilder.build.md) | () => Payload | Builds and returns the Payload | +| [getJson](./react-native-tracker.payloadbuilder.getjson.md) | () => EventJson | Gets all JSON objects added to payload | +| [getPayload](./react-native-tracker.payloadbuilder.getpayload.md) | () => Payload | Gets the current payload, before cached JSON is processed | +| [withJsonProcessor](./react-native-tracker.payloadbuilder.withjsonprocessor.md) | (jsonProcessor: JsonProcessor) => void | Adds a function which will be executed when building the payload to process the JSON which has been added to this payload | + diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.payloadbuilder.withjsonprocessor.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.payloadbuilder.withjsonprocessor.md similarity index 58% rename from api-docs/docs/node-tracker/markdown/node-tracker.payloadbuilder.withjsonprocessor.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.payloadbuilder.withjsonprocessor.md index 993c4d7af..247963bea 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.payloadbuilder.withjsonprocessor.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.payloadbuilder.withjsonprocessor.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [PayloadBuilder](./node-tracker.payloadbuilder.md) > [withJsonProcessor](./node-tracker.payloadbuilder.withjsonprocessor.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [PayloadBuilder](./react-native-tracker.payloadbuilder.md) > [withJsonProcessor](./react-native-tracker.payloadbuilder.withjsonprocessor.md) ## PayloadBuilder.withJsonProcessor property diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextconfiguration.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextconfiguration.md new file mode 100644 index 000000000..dbcbbbe9e --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextconfiguration.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [PlatformContextConfiguration](./react-native-tracker.platformcontextconfiguration.md) + +## PlatformContextConfiguration interface + +Signature: + +```typescript +export interface PlatformContextConfiguration +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [platformContext?](./react-native-tracker.platformcontextconfiguration.platformcontext.md) | boolean | (Optional) Whether to track the mobile context with information about the device. Note: Only some properties (osType, osVersion, deviceManufacturer, deviceModel, resolution, language, scale) will be tracked by default. Other properties can be assigned using the PlatformContextRetriever. | +| [platformContextProperties?](./react-native-tracker.platformcontextconfiguration.platformcontextproperties.md) | [PlatformContextProperty](./react-native-tracker.platformcontextproperty.md)\[\] | (Optional) List of properties of the platform context to track. If not passed and platformContext is enabled, all available properties will be tracked. The required osType, osVersion, deviceManufacturer, and deviceModel properties will be tracked in the entity regardless of this setting. | +| [platformContextRetriever?](./react-native-tracker.platformcontextconfiguration.platformcontextretriever.md) | [PlatformContextRetriever](./react-native-tracker.platformcontextretriever.md) | (Optional) Set of callbacks to be used to retrieve properties of the platform context. Overrides the tracker implementation for setting the properties. | + diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextconfiguration.platformcontext.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextconfiguration.platformcontext.md new file mode 100644 index 000000000..1bd9ded23 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextconfiguration.platformcontext.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [PlatformContextConfiguration](./react-native-tracker.platformcontextconfiguration.md) > [platformContext](./react-native-tracker.platformcontextconfiguration.platformcontext.md) + +## PlatformContextConfiguration.platformContext property + +Whether to track the mobile context with information about the device. Note: Only some properties (osType, osVersion, deviceManufacturer, deviceModel, resolution, language, scale) will be tracked by default. Other properties can be assigned using the PlatformContextRetriever. + +Signature: + +```typescript +platformContext?: boolean; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextconfiguration.platformcontextproperties.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextconfiguration.platformcontextproperties.md new file mode 100644 index 000000000..c8b5a4c0a --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextconfiguration.platformcontextproperties.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [PlatformContextConfiguration](./react-native-tracker.platformcontextconfiguration.md) > [platformContextProperties](./react-native-tracker.platformcontextconfiguration.platformcontextproperties.md) + +## PlatformContextConfiguration.platformContextProperties property + +List of properties of the platform context to track. If not passed and `platformContext` is enabled, all available properties will be tracked. The required `osType`, `osVersion`, `deviceManufacturer`, and `deviceModel` properties will be tracked in the entity regardless of this setting. + +Signature: + +```typescript +platformContextProperties?: PlatformContextProperty[]; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextconfiguration.platformcontextretriever.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextconfiguration.platformcontextretriever.md new file mode 100644 index 000000000..5200d1c37 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextconfiguration.platformcontextretriever.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [PlatformContextConfiguration](./react-native-tracker.platformcontextconfiguration.md) > [platformContextRetriever](./react-native-tracker.platformcontextconfiguration.platformcontextretriever.md) + +## PlatformContextConfiguration.platformContextRetriever property + +Set of callbacks to be used to retrieve properties of the platform context. Overrides the tracker implementation for setting the properties. + +Signature: + +```typescript +platformContextRetriever?: PlatformContextRetriever; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextproperty.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextproperty.md new file mode 100644 index 000000000..ecab1bfd9 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextproperty.md @@ -0,0 +1,37 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [PlatformContextProperty](./react-native-tracker.platformcontextproperty.md) + +## PlatformContextProperty enum + +Signature: + +```typescript +export declare enum PlatformContextProperty +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| AndroidIdfa | "androidIdfa" | Advertising identifier on Android. Note: This is not automatically assigned by the tracker as it may be considered as fingerprinting. You can assign it using the PlatformContextRetriever. | +| AppAvailableMemory | "appAvailableMemory" | Amount of memory in bytes available to the current app. The property is not tracked in the current version of the tracker due to the tracker not being able to access the API, see the issue here: https://github.com/snowplow/snowplow-ios-tracker/issues/772 Note: this property is not automatically assigned but can be assigned using the PlatformContextRetriever. | +| AppleIdfa | "appleIdfa" | Advertising identifier on iOS. Note: this property is not automatically assigned but can be assigned using the PlatformContextRetriever. | +| AppleIdfv | "appleIdfv" | UUID identifier for vendors on iOS. Note: this property is not automatically assigned but can be assigned using the PlatformContextRetriever. | +| AppSetId | "appSetId" | Android vendor ID scoped to the set of apps published under the same Google Play developer account (see https://developer.android.com/training/articles/app-set-id). Note: This is not automatically assigned by the tracker as it may be considered as fingerprinting. You can assign it using the PlatformContextRetriever. | +| AppSetIdScope | "appSetIdScope" | Scope of the appSetId. Can be scoped to the app or to a developer account on an app store (all apps from the same developer on the same device will have the same ID). Note: This is not automatically assigned by the tracker as it may be considered as fingerprinting. You can assign it using the PlatformContextRetriever. | +| AvailableStorage | "availableStorage" | Bytes of storage remaining. Note: This is not automatically assigned by the tracker as it may be considered as fingerprinting. You can assign it using the PlatformContextRetriever. | +| BatteryLevel | "batteryLevel" | Remaining battery level as an integer percentage of total battery capacity. Note: this property is not automatically assigned but can be assigned using the PlatformContextRetriever. | +| BatteryState | "batteryState" | Battery state for the device. Note: this property is not automatically assigned but can be assigned using the PlatformContextRetriever. | +| Carrier | "carrier" | The carrier of the SIM inserted in the device. Note: this property is not automatically assigned but can be assigned using the PlatformContextRetriever. | +| IsPortrait | "isPortrait" | A Boolean indicating whether the device orientation is portrait (either upright or upside down). Note: This is not automatically assigned by the tracker as it may be considered as fingerprinting. You can assign it using the PlatformContextRetriever. | +| Language | "language" | System language currently used on the device (ISO 639). | +| LowPowerMode | "lowPowerMode" | A Boolean indicating whether Low Power Mode is enabled. | +| NetworkTechnology | "networkTechnology" | Radio access technology that the device is using. Note: this property is not automatically assigned but can be assigned using the PlatformContextRetriever. | +| NetworkType | "networkType" | Type of network the device is connected to. Note: this property is not automatically assigned but can be assigned using the PlatformContextRetriever. | +| PhysicalMemory | "physicalMemory" | Total physical system memory in bytes. Note: this property is not automatically assigned but can be assigned using the PlatformContextRetriever. | +| Resolution | "resolution" | Screen resolution in pixels. Arrives in the form of WIDTHxHEIGHT (e.g., 1200x900). Doesn't change when device orientation changes. Note: This is not automatically assigned by the tracker as it may be considered as fingerprinting. You can assign it using the PlatformContextRetriever. | +| Scale | "scale" | Scale factor used to convert logical coordinates to device coordinates of the screen (uses UIScreen.scale on iOS). | +| SystemAvailableMemory | "systemAvailableMemory" | Available memory on the system in bytes (Android only). Note: This is not automatically assigned by the tracker as it may be considered as fingerprinting. You can assign it using the PlatformContextRetriever. | +| TotalStorage | "totalStorage" | Total size of storage in bytes. Note: This is not automatically assigned by the tracker as it may be considered as fingerprinting. You can assign it using the PlatformContextRetriever. | + diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getandroididfa.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getandroididfa.md new file mode 100644 index 000000000..ddb929aba --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getandroididfa.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [PlatformContextRetriever](./react-native-tracker.platformcontextretriever.md) > [getAndroidIdfa](./react-native-tracker.platformcontextretriever.getandroididfa.md) + +## PlatformContextRetriever.getAndroidIdfa property + +Advertising identifier on Android. + +Signature: + +```typescript +getAndroidIdfa?: () => Promise; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getappavailablememory.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getappavailablememory.md new file mode 100644 index 000000000..b3d16dd2c --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getappavailablememory.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [PlatformContextRetriever](./react-native-tracker.platformcontextretriever.md) > [getAppAvailableMemory](./react-native-tracker.platformcontextretriever.getappavailablememory.md) + +## PlatformContextRetriever.getAppAvailableMemory property + +Amount of memory in bytes available to the current app + +Signature: + +```typescript +getAppAvailableMemory?: () => Promise; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getappleidfa.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getappleidfa.md new file mode 100644 index 000000000..d7df9689b --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getappleidfa.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [PlatformContextRetriever](./react-native-tracker.platformcontextretriever.md) > [getAppleIdfa](./react-native-tracker.platformcontextretriever.getappleidfa.md) + +## PlatformContextRetriever.getAppleIdfa property + +Advertising identifier on iOS (UUID formatted string) + +Signature: + +```typescript +getAppleIdfa?: () => Promise; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getappleidfv.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getappleidfv.md new file mode 100644 index 000000000..708c2fab8 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getappleidfv.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [PlatformContextRetriever](./react-native-tracker.platformcontextretriever.md) > [getAppleIdfv](./react-native-tracker.platformcontextretriever.getappleidfv.md) + +## PlatformContextRetriever.getAppleIdfv property + +UUID identifier for vendors on iOS + +Signature: + +```typescript +getAppleIdfv?: () => Promise; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getappsetid.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getappsetid.md new file mode 100644 index 000000000..26883e060 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getappsetid.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [PlatformContextRetriever](./react-native-tracker.platformcontextretriever.md) > [getAppSetId](./react-native-tracker.platformcontextretriever.getappsetid.md) + +## PlatformContextRetriever.getAppSetId property + +Android vendor ID scoped to the set of apps published under the same Google Play developer account (see https://developer.android.com/training/articles/app-set-id). + +Signature: + +```typescript +getAppSetId?: () => Promise; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getappsetidscope.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getappsetidscope.md new file mode 100644 index 000000000..ba739a067 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getappsetidscope.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [PlatformContextRetriever](./react-native-tracker.platformcontextretriever.md) > [getAppSetIdScope](./react-native-tracker.platformcontextretriever.getappsetidscope.md) + +## PlatformContextRetriever.getAppSetIdScope property + +Scope of the `appSetId`. Can be scoped to the app or to a developer account on an app store (all apps from the same developer on the same device will have the same ID). + +Signature: + +```typescript +getAppSetIdScope?: () => Promise; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getavailablestorage.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getavailablestorage.md new file mode 100644 index 000000000..3e272c06d --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getavailablestorage.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [PlatformContextRetriever](./react-native-tracker.platformcontextretriever.md) > [getAvailableStorage](./react-native-tracker.platformcontextretriever.getavailablestorage.md) + +## PlatformContextRetriever.getAvailableStorage property + +Bytes of storage remaining + +Signature: + +```typescript +getAvailableStorage?: () => Promise; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getbatterylevel.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getbatterylevel.md new file mode 100644 index 000000000..903119131 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getbatterylevel.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [PlatformContextRetriever](./react-native-tracker.platformcontextretriever.md) > [getBatteryLevel](./react-native-tracker.platformcontextretriever.getbatterylevel.md) + +## PlatformContextRetriever.getBatteryLevel property + +Remaining battery level as an integer percentage of total battery capacity + +Signature: + +```typescript +getBatteryLevel?: () => Promise; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getbatterystate.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getbatterystate.md new file mode 100644 index 000000000..572cf8433 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getbatterystate.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [PlatformContextRetriever](./react-native-tracker.platformcontextretriever.md) > [getBatteryState](./react-native-tracker.platformcontextretriever.getbatterystate.md) + +## PlatformContextRetriever.getBatteryState property + +Battery state for the device + +Signature: + +```typescript +getBatteryState?: () => Promise<'unplugged' | 'charging' | 'full' | undefined>; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getcarrier.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getcarrier.md new file mode 100644 index 000000000..1e585d9e3 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getcarrier.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [PlatformContextRetriever](./react-native-tracker.platformcontextretriever.md) > [getCarrier](./react-native-tracker.platformcontextretriever.getcarrier.md) + +## PlatformContextRetriever.getCarrier property + +The carrier of the SIM inserted in the device + +Signature: + +```typescript +getCarrier?: () => Promise; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getdevicemanufacturer.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getdevicemanufacturer.md new file mode 100644 index 000000000..fd01882c8 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getdevicemanufacturer.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [PlatformContextRetriever](./react-native-tracker.platformcontextretriever.md) > [getDeviceManufacturer](./react-native-tracker.platformcontextretriever.getdevicemanufacturer.md) + +## PlatformContextRetriever.getDeviceManufacturer property + +The manufacturer of the product/hardware + +Signature: + +```typescript +getDeviceManufacturer?: () => Promise; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getdevicemodel.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getdevicemodel.md new file mode 100644 index 000000000..d4e678e30 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getdevicemodel.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [PlatformContextRetriever](./react-native-tracker.platformcontextretriever.md) > [getDeviceModel](./react-native-tracker.platformcontextretriever.getdevicemodel.md) + +## PlatformContextRetriever.getDeviceModel property + +The end-user-visible name for the end product + +Signature: + +```typescript +getDeviceModel?: () => Promise; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getlanguage.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getlanguage.md new file mode 100644 index 000000000..f898f2ee3 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getlanguage.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [PlatformContextRetriever](./react-native-tracker.platformcontextretriever.md) > [getLanguage](./react-native-tracker.platformcontextretriever.getlanguage.md) + +## PlatformContextRetriever.getLanguage property + +System language currently used on the device (ISO 639) + +Signature: + +```typescript +getLanguage?: () => Promise; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getlowpowermode.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getlowpowermode.md new file mode 100644 index 000000000..a977aee13 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getlowpowermode.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [PlatformContextRetriever](./react-native-tracker.platformcontextretriever.md) > [getLowPowerMode](./react-native-tracker.platformcontextretriever.getlowpowermode.md) + +## PlatformContextRetriever.getLowPowerMode property + +A Boolean indicating whether Low Power Mode is enabled + +Signature: + +```typescript +getLowPowerMode?: () => Promise; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getnetworktechnology.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getnetworktechnology.md new file mode 100644 index 000000000..aaea92c69 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getnetworktechnology.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [PlatformContextRetriever](./react-native-tracker.platformcontextretriever.md) > [getNetworkTechnology](./react-native-tracker.platformcontextretriever.getnetworktechnology.md) + +## PlatformContextRetriever.getNetworkTechnology property + +Radio access technology that the device is using + +Signature: + +```typescript +getNetworkTechnology?: () => Promise; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getnetworktype.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getnetworktype.md new file mode 100644 index 000000000..1890e85a6 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getnetworktype.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [PlatformContextRetriever](./react-native-tracker.platformcontextretriever.md) > [getNetworkType](./react-native-tracker.platformcontextretriever.getnetworktype.md) + +## PlatformContextRetriever.getNetworkType property + +Type of network the device is connected to + +Signature: + +```typescript +getNetworkType?: () => Promise<'mobile' | 'wifi' | 'offline' | undefined>; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getostype.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getostype.md new file mode 100644 index 000000000..3c2904a26 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getostype.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [PlatformContextRetriever](./react-native-tracker.platformcontextretriever.md) > [getOsType](./react-native-tracker.platformcontextretriever.getostype.md) + +## PlatformContextRetriever.getOsType property + +Operating system type (e.g., ios, tvos, watchos, osx, android) + +Signature: + +```typescript +getOsType?: () => Promise; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getosversion.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getosversion.md new file mode 100644 index 000000000..204cf64b2 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getosversion.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [PlatformContextRetriever](./react-native-tracker.platformcontextretriever.md) > [getOsVersion](./react-native-tracker.platformcontextretriever.getosversion.md) + +## PlatformContextRetriever.getOsVersion property + +The current version of the operating system + +Signature: + +```typescript +getOsVersion?: () => Promise; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getphysicalmemory.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getphysicalmemory.md new file mode 100644 index 000000000..333e960da --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getphysicalmemory.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [PlatformContextRetriever](./react-native-tracker.platformcontextretriever.md) > [getPhysicalMemory](./react-native-tracker.platformcontextretriever.getphysicalmemory.md) + +## PlatformContextRetriever.getPhysicalMemory property + +Total physical system memory in bytes + +Signature: + +```typescript +getPhysicalMemory?: () => Promise; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getresolution.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getresolution.md new file mode 100644 index 000000000..12ea40cc5 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getresolution.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [PlatformContextRetriever](./react-native-tracker.platformcontextretriever.md) > [getResolution](./react-native-tracker.platformcontextretriever.getresolution.md) + +## PlatformContextRetriever.getResolution property + +Screen resolution in pixels. Arrives in the form of WIDTHxHEIGHT (e.g., 1200x900). Doesn't change when device orientation changes + +Signature: + +```typescript +getResolution?: () => Promise; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getscale.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getscale.md new file mode 100644 index 000000000..3a4f0351a --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getscale.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [PlatformContextRetriever](./react-native-tracker.platformcontextretriever.md) > [getScale](./react-native-tracker.platformcontextretriever.getscale.md) + +## PlatformContextRetriever.getScale property + +Scale factor used to convert logical coordinates to device coordinates of the screen (uses UIScreen.scale on iOS) + +Signature: + +```typescript +getScale?: () => Promise; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getsystemavailablememory.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getsystemavailablememory.md new file mode 100644 index 000000000..43e158abc --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.getsystemavailablememory.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [PlatformContextRetriever](./react-native-tracker.platformcontextretriever.md) > [getSystemAvailableMemory](./react-native-tracker.platformcontextretriever.getsystemavailablememory.md) + +## PlatformContextRetriever.getSystemAvailableMemory property + +Available memory on the system in bytes (Android only). + +Signature: + +```typescript +getSystemAvailableMemory?: () => Promise; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.gettotalstorage.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.gettotalstorage.md new file mode 100644 index 000000000..af2f197c9 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.gettotalstorage.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [PlatformContextRetriever](./react-native-tracker.platformcontextretriever.md) > [getTotalStorage](./react-native-tracker.platformcontextretriever.gettotalstorage.md) + +## PlatformContextRetriever.getTotalStorage property + +Total size of storage in bytes + +Signature: + +```typescript +getTotalStorage?: () => Promise; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.isportrait.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.isportrait.md new file mode 100644 index 000000000..dcbcf2877 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.isportrait.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [PlatformContextRetriever](./react-native-tracker.platformcontextretriever.md) > [isPortrait](./react-native-tracker.platformcontextretriever.isportrait.md) + +## PlatformContextRetriever.isPortrait property + +A Boolean indicating whether the device orientation is portrait (either upright or upside down) + +Signature: + +```typescript +isPortrait?: () => Promise; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.md new file mode 100644 index 000000000..cbaea8df5 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.platformcontextretriever.md @@ -0,0 +1,43 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [PlatformContextRetriever](./react-native-tracker.platformcontextretriever.md) + +## PlatformContextRetriever interface + +Overrides for the values for properties of the platform context. + +Signature: + +```typescript +export interface PlatformContextRetriever +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [getAndroidIdfa?](./react-native-tracker.platformcontextretriever.getandroididfa.md) | () => Promise<string \| undefined> | (Optional) Advertising identifier on Android. | +| [getAppAvailableMemory?](./react-native-tracker.platformcontextretriever.getappavailablememory.md) | () => Promise<number \| undefined> | (Optional) Amount of memory in bytes available to the current app | +| [getAppleIdfa?](./react-native-tracker.platformcontextretriever.getappleidfa.md) | () => Promise<string \| undefined> | (Optional) Advertising identifier on iOS (UUID formatted string) | +| [getAppleIdfv?](./react-native-tracker.platformcontextretriever.getappleidfv.md) | () => Promise<string \| undefined> | (Optional) UUID identifier for vendors on iOS | +| [getAppSetId?](./react-native-tracker.platformcontextretriever.getappsetid.md) | () => Promise<string \| undefined> | (Optional) Android vendor ID scoped to the set of apps published under the same Google Play developer account (see https://developer.android.com/training/articles/app-set-id). | +| [getAppSetIdScope?](./react-native-tracker.platformcontextretriever.getappsetidscope.md) | () => Promise<string \| undefined> | (Optional) Scope of the appSetId. Can be scoped to the app or to a developer account on an app store (all apps from the same developer on the same device will have the same ID). | +| [getAvailableStorage?](./react-native-tracker.platformcontextretriever.getavailablestorage.md) | () => Promise<number \| undefined> | (Optional) Bytes of storage remaining | +| [getBatteryLevel?](./react-native-tracker.platformcontextretriever.getbatterylevel.md) | () => Promise<number \| undefined> | (Optional) Remaining battery level as an integer percentage of total battery capacity | +| [getBatteryState?](./react-native-tracker.platformcontextretriever.getbatterystate.md) | () => Promise<'unplugged' \| 'charging' \| 'full' \| undefined> | (Optional) Battery state for the device | +| [getCarrier?](./react-native-tracker.platformcontextretriever.getcarrier.md) | () => Promise<string \| undefined> | (Optional) The carrier of the SIM inserted in the device | +| [getDeviceManufacturer?](./react-native-tracker.platformcontextretriever.getdevicemanufacturer.md) | () => Promise<string> | (Optional) The manufacturer of the product/hardware | +| [getDeviceModel?](./react-native-tracker.platformcontextretriever.getdevicemodel.md) | () => Promise<string> | (Optional) The end-user-visible name for the end product | +| [getLanguage?](./react-native-tracker.platformcontextretriever.getlanguage.md) | () => Promise<string \| undefined> | (Optional) System language currently used on the device (ISO 639) | +| [getLowPowerMode?](./react-native-tracker.platformcontextretriever.getlowpowermode.md) | () => Promise<boolean \| undefined> | (Optional) A Boolean indicating whether Low Power Mode is enabled | +| [getNetworkTechnology?](./react-native-tracker.platformcontextretriever.getnetworktechnology.md) | () => Promise<string \| undefined> | (Optional) Radio access technology that the device is using | +| [getNetworkType?](./react-native-tracker.platformcontextretriever.getnetworktype.md) | () => Promise<'mobile' \| 'wifi' \| 'offline' \| undefined> | (Optional) Type of network the device is connected to | +| [getOsType?](./react-native-tracker.platformcontextretriever.getostype.md) | () => Promise<string> | (Optional) Operating system type (e.g., ios, tvos, watchos, osx, android) | +| [getOsVersion?](./react-native-tracker.platformcontextretriever.getosversion.md) | () => Promise<string> | (Optional) The current version of the operating system | +| [getPhysicalMemory?](./react-native-tracker.platformcontextretriever.getphysicalmemory.md) | () => Promise<number \| undefined> | (Optional) Total physical system memory in bytes | +| [getResolution?](./react-native-tracker.platformcontextretriever.getresolution.md) | () => Promise<string \| undefined> | (Optional) Screen resolution in pixels. Arrives in the form of WIDTHxHEIGHT (e.g., 1200x900). Doesn't change when device orientation changes | +| [getScale?](./react-native-tracker.platformcontextretriever.getscale.md) | () => Promise<number \| undefined> | (Optional) Scale factor used to convert logical coordinates to device coordinates of the screen (uses UIScreen.scale on iOS) | +| [getSystemAvailableMemory?](./react-native-tracker.platformcontextretriever.getsystemavailablememory.md) | () => Promise<number \| undefined> | (Optional) Available memory on the system in bytes (Android only). | +| [getTotalStorage?](./react-native-tracker.platformcontextretriever.gettotalstorage.md) | () => Promise<number \| undefined> | (Optional) Total size of storage in bytes | +| [isPortrait?](./react-native-tracker.platformcontextretriever.isportrait.md) | () => Promise<boolean \| undefined> | (Optional) A Boolean indicating whether the device orientation is portrait (either upright or upside down) | + diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.reactnativetracker.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.reactnativetracker.md new file mode 100644 index 000000000..c6354bb03 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.reactnativetracker.md @@ -0,0 +1,54 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [ReactNativeTracker](./react-native-tracker.reactnativetracker.md) + +## ReactNativeTracker type + +The ReactNativeTracker type + +Signature: + +```typescript +export declare type ReactNativeTracker = { + namespace: string; + readonly trackSelfDescribingEvent: = Record>(argmap: SelfDescribing, contexts?: EventContext[]) => void; + readonly trackScreenViewEvent: (argmap: ScreenViewProps, contexts?: EventContext[]) => void; + readonly trackScrollChangedEvent: (argmap: ScrollChangedProps, contexts?: EventContext[]) => void; + readonly trackListItemViewEvent: (argmap: ListItemViewProps, contexts?: EventContext[]) => void; + readonly trackStructuredEvent: (argmap: StructuredProps, contexts?: EventContext[]) => void; + readonly trackPageViewEvent: (argmap: PageViewEvent, contexts?: EventContext[]) => void; + readonly trackTimingEvent: (argmap: TimingProps, contexts?: EventContext[]) => void; + readonly trackDeepLinkReceivedEvent: (argmap: DeepLinkReceivedProps, contexts?: EventContext[]) => void; + readonly trackMessageNotificationEvent: (argmap: MessageNotificationProps, contexts?: EventContext[]) => void; + addGlobalContexts(contexts: Array | Record): void; + clearGlobalContexts(): void; + removeGlobalContexts(contexts: Array): void; + addPlugin(configuration: BrowserPluginConfiguration): void; + flush: () => Promise; + readonly setAppId: (appId: string) => void; + readonly setPlatform: (value: string) => void; + readonly setUserId: (newUid: string) => void; + readonly setNetworkUserId: (newNuid: string | undefined) => void; + readonly setDomainUserId: (newDuid: string | undefined) => void; + readonly setIpAddress: (newIp: string) => void; + readonly setUseragent: (newUagent: string) => void; + readonly setTimezone: (newTz: string) => void; + readonly setLanguage: (newLang: string) => void; + readonly setScreenResolution: (newRes: ScreenSize) => void; + readonly setScreenViewport: (newView: ScreenSize) => void; + readonly setColorDepth: (newLang: number) => void; + readonly setSubjectData: (config: SubjectConfiguration) => void; + readonly getSessionUserId: () => Promise; + readonly getSessionId: () => Promise; + readonly getSessionIndex: () => Promise; + readonly getSessionState: () => Promise; + readonly getIsInBackground: () => boolean | undefined; + readonly getBackgroundIndex: () => number | undefined; + readonly getForegroundIndex: () => number | undefined; + readonly enablePlatformContext: () => Promise; + readonly disablePlatformContext: () => void; + readonly refreshPlatformContext: () => Promise; +}; +``` +References: [SelfDescribing](./react-native-tracker.selfdescribing.md), [EventContext](./react-native-tracker.eventcontext.md), [ScreenViewProps](./react-native-tracker.screenviewprops.md), [ScrollChangedProps](./react-native-tracker.scrollchangedprops.md), [ListItemViewProps](./react-native-tracker.listitemviewprops.md), [StructuredProps](./react-native-tracker.structuredprops.md), [TimingProps](./react-native-tracker.timingprops.md), [DeepLinkReceivedProps](./react-native-tracker.deeplinkreceivedprops.md), [MessageNotificationProps](./react-native-tracker.messagenotificationprops.md), [ScreenSize](./react-native-tracker.screensize.md), [SubjectConfiguration](./react-native-tracker.subjectconfiguration.md), [SessionState](./react-native-tracker.sessionstate.md) + diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.removealltrackers.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.removealltrackers.md new file mode 100644 index 000000000..f89c21a42 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.removealltrackers.md @@ -0,0 +1,19 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [removeAllTrackers](./react-native-tracker.removealltrackers.md) + +## removeAllTrackers() function + +Removes all initialized trackers + +Signature: + +```typescript +export declare function removeAllTrackers(): void; +``` +Returns: + +void + +- A boolean promise + diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.removetracker.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.removetracker.md new file mode 100644 index 000000000..fd63a38eb --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.removetracker.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [removeTracker](./react-native-tracker.removetracker.md) + +## removeTracker() function + +Removes a tracker given its namespace + +Signature: + +```typescript +export declare function removeTracker(trackerNamespace: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| trackerNamespace | string | Tracker namespace | + +Returns: + +void + diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.requestfailure.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.requestfailure.md similarity index 66% rename from api-docs/docs/node-tracker/markdown/node-tracker.requestfailure.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.requestfailure.md index 63f977207..063d363fc 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.requestfailure.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.requestfailure.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [RequestFailure](./node-tracker.requestfailure.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [RequestFailure](./react-native-tracker.requestfailure.md) ## RequestFailure type diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.ruleset.accept.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.ruleset.accept.md new file mode 100644 index 000000000..d47792084 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.ruleset.accept.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [RuleSet](./react-native-tracker.ruleset.md) > [accept](./react-native-tracker.ruleset.accept.md) + +## RuleSet.accept property + +Signature: + +```typescript +accept?: Array | string; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.ruleset.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.ruleset.md new file mode 100644 index 000000000..157720f6c --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.ruleset.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [RuleSet](./react-native-tracker.ruleset.md) + +## RuleSet interface + +A ruleset has accept or reject properties that contain rules for matching Iglu schema URIs + +Signature: + +```typescript +interface RuleSet +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [accept?](./react-native-tracker.ruleset.accept.md) | Array<string> \| string | (Optional) | +| [reject?](./react-native-tracker.ruleset.reject.md) | Array<string> \| string | (Optional) | + diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.ruleset.reject.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.ruleset.reject.md new file mode 100644 index 000000000..a3b017794 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.ruleset.reject.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [RuleSet](./react-native-tracker.ruleset.md) > [reject](./react-native-tracker.ruleset.reject.md) + +## RuleSet.reject property + +Signature: + +```typescript +reject?: Array | string; +``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.rulesetprovider.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.rulesetprovider.md similarity index 71% rename from api-docs/docs/node-tracker/markdown/node-tracker.rulesetprovider.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.rulesetprovider.md index 41a471fb7..a9798a553 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.rulesetprovider.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.rulesetprovider.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [RuleSetProvider](./node-tracker.rulesetprovider.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [RuleSetProvider](./react-native-tracker.rulesetprovider.md) ## RuleSetProvider type diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.screensize.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.screensize.md new file mode 100644 index 000000000..fb7a11e45 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.screensize.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [ScreenSize](./react-native-tracker.screensize.md) + +## ScreenSize type + +Screen size in pixels + +Signature: + +```typescript +export declare type ScreenSize = [number, number]; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.screenviewprops.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.screenviewprops.md new file mode 100644 index 000000000..22ed34862 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.screenviewprops.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [ScreenViewProps](./react-native-tracker.screenviewprops.md) + +## ScreenViewProps type + +ScreenView event properties schema: iglu:com.snowplowanalytics.mobile/screen\_view/jsonschema/1-0-0 + +Signature: + +```typescript +export declare type ScreenViewProps = { + name: string; + id?: string; + type?: string; + previousName?: string; + previousId?: string; + previousType?: string; + transitionType?: string; +}; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.scrollchangedprops.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.scrollchangedprops.md new file mode 100644 index 000000000..32d3980b5 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.scrollchangedprops.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [ScrollChangedProps](./react-native-tracker.scrollchangedprops.md) + +## ScrollChangedProps type + +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` + +Signature: + +```typescript +export declare type ScrollChangedProps = { + yOffset?: number; + xOffset?: number; + viewHeight?: number; + viewWidth?: number; + contentHeight?: number; + contentWidth?: number; +}; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.selfdescribing.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.selfdescribing.md new file mode 100644 index 000000000..35c03afef --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.selfdescribing.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [SelfDescribing](./react-native-tracker.selfdescribing.md) + +## SelfDescribing type + +Interface for any self-describing JSON such as context entities or self-describing events + +Signature: + +```typescript +export declare type SelfDescribing> = SelfDescribingJson; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.sessionconfiguration.backgroundsessiontimeout.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.sessionconfiguration.backgroundsessiontimeout.md new file mode 100644 index 000000000..823f3e277 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.sessionconfiguration.backgroundsessiontimeout.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [SessionConfiguration](./react-native-tracker.sessionconfiguration.md) > [backgroundSessionTimeout](./react-native-tracker.sessionconfiguration.backgroundsessiontimeout.md) + +## SessionConfiguration.backgroundSessionTimeout property + +The amount of time in seconds before the session id is updated while the app is in the background + +Signature: + +```typescript +backgroundSessionTimeout?: number; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.sessionconfiguration.foregroundsessiontimeout.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.sessionconfiguration.foregroundsessiontimeout.md new file mode 100644 index 000000000..5282a3ef2 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.sessionconfiguration.foregroundsessiontimeout.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [SessionConfiguration](./react-native-tracker.sessionconfiguration.md) > [foregroundSessionTimeout](./react-native-tracker.sessionconfiguration.foregroundsessiontimeout.md) + +## SessionConfiguration.foregroundSessionTimeout property + +The amount of time in seconds before the session id is updated while the app is in the foreground + +Signature: + +```typescript +foregroundSessionTimeout?: number; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.sessionconfiguration.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.sessionconfiguration.md new file mode 100644 index 000000000..1123c753c --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.sessionconfiguration.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [SessionConfiguration](./react-native-tracker.sessionconfiguration.md) + +## SessionConfiguration interface + +Configuration for session tracking + +Signature: + +```typescript +export interface SessionConfiguration +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [backgroundSessionTimeout?](./react-native-tracker.sessionconfiguration.backgroundsessiontimeout.md) | number | (Optional) The amount of time in seconds before the session id is updated while the app is in the background | +| [foregroundSessionTimeout?](./react-native-tracker.sessionconfiguration.foregroundsessiontimeout.md) | number | (Optional) The amount of time in seconds before the session id is updated while the app is in the foreground | +| [sessionContext?](./react-native-tracker.sessionconfiguration.sessioncontext.md) | boolean | (Optional) Whether session context is attached to tracked events. | + diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.sessionconfiguration.sessioncontext.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.sessionconfiguration.sessioncontext.md new file mode 100644 index 000000000..080fd7c72 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.sessionconfiguration.sessioncontext.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [SessionConfiguration](./react-native-tracker.sessionconfiguration.md) > [sessionContext](./react-native-tracker.sessionconfiguration.sessioncontext.md) + +## SessionConfiguration.sessionContext property + +Whether session context is attached to tracked events. + +Signature: + +```typescript +sessionContext?: boolean; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.sessionstate.eventindex.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.sessionstate.eventindex.md new file mode 100644 index 000000000..2fcff3c89 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.sessionstate.eventindex.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [SessionState](./react-native-tracker.sessionstate.md) > [eventIndex](./react-native-tracker.sessionstate.eventindex.md) + +## SessionState.eventIndex property + +Optional index of the current event in the session + +Signature: + +```typescript +eventIndex?: number; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.sessionstate.firsteventid.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.sessionstate.firsteventid.md new file mode 100644 index 000000000..8cb3eb771 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.sessionstate.firsteventid.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [SessionState](./react-native-tracker.sessionstate.md) > [firstEventId](./react-native-tracker.sessionstate.firsteventid.md) + +## SessionState.firstEventId property + +The optional identifier of the first event for this session + +Signature: + +```typescript +firstEventId?: string; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.sessionstate.firsteventtimestamp.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.sessionstate.firsteventtimestamp.md new file mode 100644 index 000000000..8277b59f8 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.sessionstate.firsteventtimestamp.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [SessionState](./react-native-tracker.sessionstate.md) > [firstEventTimestamp](./react-native-tracker.sessionstate.firsteventtimestamp.md) + +## SessionState.firstEventTimestamp property + +Optional date-time timestamp of when the first event in the session was tracked + +Signature: + +```typescript +firstEventTimestamp?: string; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.sessionstate.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.sessionstate.md new file mode 100644 index 000000000..a0a5ec91c --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.sessionstate.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [SessionState](./react-native-tracker.sessionstate.md) + +## SessionState interface + +Current session state that is tracked in events. + +Signature: + +```typescript +export interface SessionState +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [eventIndex?](./react-native-tracker.sessionstate.eventindex.md) | number | (Optional) Optional index of the current event in the session | +| [firstEventId?](./react-native-tracker.sessionstate.firsteventid.md) | string | (Optional) The optional identifier of the first event for this session | +| [firstEventTimestamp?](./react-native-tracker.sessionstate.firsteventtimestamp.md) | string | (Optional) Optional date-time timestamp of when the first event in the session was tracked | +| [previousSessionId?](./react-native-tracker.sessionstate.previoussessionid.md) | string | (Optional) The previous session identifier for this user | +| [sessionId](./react-native-tracker.sessionstate.sessionid.md) | string | An identifier for the session | +| [sessionIndex](./react-native-tracker.sessionstate.sessionindex.md) | number | The index of the current session for this user | +| [storageMechanism](./react-native-tracker.sessionstate.storagemechanism.md) | string | The mechanism that the session information has been stored on the device | +| [userId](./react-native-tracker.sessionstate.userid.md) | string | An identifier for the user of the session | + diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.sessionstate.previoussessionid.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.sessionstate.previoussessionid.md new file mode 100644 index 000000000..bd7063348 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.sessionstate.previoussessionid.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [SessionState](./react-native-tracker.sessionstate.md) > [previousSessionId](./react-native-tracker.sessionstate.previoussessionid.md) + +## SessionState.previousSessionId property + +The previous session identifier for this user + +Signature: + +```typescript +previousSessionId?: string; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.sessionstate.sessionid.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.sessionstate.sessionid.md new file mode 100644 index 000000000..2a5411f66 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.sessionstate.sessionid.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [SessionState](./react-native-tracker.sessionstate.md) > [sessionId](./react-native-tracker.sessionstate.sessionid.md) + +## SessionState.sessionId property + +An identifier for the session + +Signature: + +```typescript +sessionId: string; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.sessionstate.sessionindex.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.sessionstate.sessionindex.md new file mode 100644 index 000000000..132af44a1 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.sessionstate.sessionindex.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [SessionState](./react-native-tracker.sessionstate.md) > [sessionIndex](./react-native-tracker.sessionstate.sessionindex.md) + +## SessionState.sessionIndex property + +The index of the current session for this user + +Signature: + +```typescript +sessionIndex: number; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.sessionstate.storagemechanism.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.sessionstate.storagemechanism.md new file mode 100644 index 000000000..be6f76270 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.sessionstate.storagemechanism.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [SessionState](./react-native-tracker.sessionstate.md) > [storageMechanism](./react-native-tracker.sessionstate.storagemechanism.md) + +## SessionState.storageMechanism property + +The mechanism that the session information has been stored on the device + +Signature: + +```typescript +storageMechanism: string; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.sessionstate.userid.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.sessionstate.userid.md new file mode 100644 index 000000000..9fd0de69e --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.sessionstate.userid.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [SessionState](./react-native-tracker.sessionstate.md) > [userId](./react-native-tracker.sessionstate.userid.md) + +## SessionState.userId property + +An identifier for the user of the session + +Signature: + +```typescript +userId: string; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.structuredprops.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.structuredprops.md new file mode 100644 index 000000000..4d0ea6262 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.structuredprops.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [StructuredProps](./react-native-tracker.structuredprops.md) + +## StructuredProps type + +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. + +Signature: + +```typescript +export declare type StructuredProps = StructuredEvent; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.subjectconfiguration.colordepth.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.subjectconfiguration.colordepth.md new file mode 100644 index 000000000..293d0019e --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.subjectconfiguration.colordepth.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [SubjectConfiguration](./react-native-tracker.subjectconfiguration.md) > [colorDepth](./react-native-tracker.subjectconfiguration.colordepth.md) + +## SubjectConfiguration.colorDepth property + +Color depth (integer) + +Signature: + +```typescript +colorDepth?: number; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.subjectconfiguration.domainuserid.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.subjectconfiguration.domainuserid.md new file mode 100644 index 000000000..ae25b158c --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.subjectconfiguration.domainuserid.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [SubjectConfiguration](./react-native-tracker.subjectconfiguration.md) > [domainUserId](./react-native-tracker.subjectconfiguration.domainuserid.md) + +## SubjectConfiguration.domainUserId property + +The domain user id (DUID) is a generated identifier that is stored in a first party cookie on Web. The React Native tracker does not assign it automatically. + +Signature: + +```typescript +domainUserId?: string; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.subjectconfiguration.ipaddress.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.subjectconfiguration.ipaddress.md new file mode 100644 index 000000000..9e2dbe11d --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.subjectconfiguration.ipaddress.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [SubjectConfiguration](./react-native-tracker.subjectconfiguration.md) > [ipAddress](./react-native-tracker.subjectconfiguration.ipaddress.md) + +## SubjectConfiguration.ipAddress property + +Override the IP address of the device + +Signature: + +```typescript +ipAddress?: string; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.subjectconfiguration.language.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.subjectconfiguration.language.md new file mode 100644 index 000000000..381bc4ec0 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.subjectconfiguration.language.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [SubjectConfiguration](./react-native-tracker.subjectconfiguration.md) > [language](./react-native-tracker.subjectconfiguration.language.md) + +## SubjectConfiguration.language property + +The language set in the device + +Signature: + +```typescript +language?: string; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.subjectconfiguration.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.subjectconfiguration.md new file mode 100644 index 000000000..142bbc301 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.subjectconfiguration.md @@ -0,0 +1,29 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [SubjectConfiguration](./react-native-tracker.subjectconfiguration.md) + +## SubjectConfiguration interface + +Configuration of subject properties tracked with events + +Signature: + +```typescript +export interface SubjectConfiguration +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [colorDepth?](./react-native-tracker.subjectconfiguration.colordepth.md) | number | (Optional) Color depth (integer) | +| [domainUserId?](./react-native-tracker.subjectconfiguration.domainuserid.md) | string | (Optional) The domain user id (DUID) is a generated identifier that is stored in a first party cookie on Web. The React Native tracker does not assign it automatically. | +| [ipAddress?](./react-native-tracker.subjectconfiguration.ipaddress.md) | string | (Optional) Override the IP address of the device | +| [language?](./react-native-tracker.subjectconfiguration.language.md) | string | (Optional) The language set in the device | +| [networkUserId?](./react-native-tracker.subjectconfiguration.networkuserid.md) | string | (Optional) Override the network user id (UUIDv4) that is assigned by the collector and stored in cookies | +| [screenResolution?](./react-native-tracker.subjectconfiguration.screenresolution.md) | [ScreenSize](./react-native-tracker.screensize.md) | (Optional) The screen resolution | +| [screenViewport?](./react-native-tracker.subjectconfiguration.screenviewport.md) | [ScreenSize](./react-native-tracker.screensize.md) | (Optional) The screen viewport size | +| [timezone?](./react-native-tracker.subjectconfiguration.timezone.md) | string | (Optional) The timezone label | +| [useragent?](./react-native-tracker.subjectconfiguration.useragent.md) | string | (Optional) The custom user-agent. It overrides the user-agent used by default. | +| [userId?](./react-native-tracker.subjectconfiguration.userid.md) | string | (Optional) Business-defined user ID for this user | + diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.subjectconfiguration.networkuserid.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.subjectconfiguration.networkuserid.md new file mode 100644 index 000000000..94be46858 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.subjectconfiguration.networkuserid.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [SubjectConfiguration](./react-native-tracker.subjectconfiguration.md) > [networkUserId](./react-native-tracker.subjectconfiguration.networkuserid.md) + +## SubjectConfiguration.networkUserId property + +Override the network user id (UUIDv4) that is assigned by the collector and stored in cookies + +Signature: + +```typescript +networkUserId?: string; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.subjectconfiguration.screenresolution.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.subjectconfiguration.screenresolution.md new file mode 100644 index 000000000..54cead3b9 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.subjectconfiguration.screenresolution.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [SubjectConfiguration](./react-native-tracker.subjectconfiguration.md) > [screenResolution](./react-native-tracker.subjectconfiguration.screenresolution.md) + +## SubjectConfiguration.screenResolution property + +The screen resolution + +Signature: + +```typescript +screenResolution?: ScreenSize; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.subjectconfiguration.screenviewport.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.subjectconfiguration.screenviewport.md new file mode 100644 index 000000000..76e8df0ac --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.subjectconfiguration.screenviewport.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [SubjectConfiguration](./react-native-tracker.subjectconfiguration.md) > [screenViewport](./react-native-tracker.subjectconfiguration.screenviewport.md) + +## SubjectConfiguration.screenViewport property + +The screen viewport size + +Signature: + +```typescript +screenViewport?: ScreenSize; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.subjectconfiguration.timezone.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.subjectconfiguration.timezone.md new file mode 100644 index 000000000..7e49640c4 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.subjectconfiguration.timezone.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [SubjectConfiguration](./react-native-tracker.subjectconfiguration.md) > [timezone](./react-native-tracker.subjectconfiguration.timezone.md) + +## SubjectConfiguration.timezone property + +The timezone label + +Signature: + +```typescript +timezone?: string; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.subjectconfiguration.useragent.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.subjectconfiguration.useragent.md new file mode 100644 index 000000000..cca9bdc93 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.subjectconfiguration.useragent.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [SubjectConfiguration](./react-native-tracker.subjectconfiguration.md) > [useragent](./react-native-tracker.subjectconfiguration.useragent.md) + +## SubjectConfiguration.useragent property + +The custom user-agent. It overrides the user-agent used by default. + +Signature: + +```typescript +useragent?: string; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.subjectconfiguration.userid.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.subjectconfiguration.userid.md new file mode 100644 index 000000000..6a64efa57 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.subjectconfiguration.userid.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [SubjectConfiguration](./react-native-tracker.subjectconfiguration.md) > [userId](./react-native-tracker.subjectconfiguration.userid.md) + +## SubjectConfiguration.userId property + +Business-defined user ID for this user + +Signature: + +```typescript +userId?: string; +``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.timestamp.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.timestamp.md similarity index 63% rename from api-docs/docs/node-tracker/markdown/node-tracker.timestamp.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.timestamp.md index 0092ffdc2..015586490 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.timestamp.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.timestamp.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [Timestamp](./node-tracker.timestamp.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [Timestamp](./react-native-tracker.timestamp.md) ## Timestamp type diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.timingprops.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.timingprops.md new file mode 100644 index 000000000..6aaee34f7 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.timingprops.md @@ -0,0 +1,18 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [TimingProps](./react-native-tracker.timingprops.md) + +## TimingProps type + +Timing event properties + +Signature: + +```typescript +export declare type TimingProps = { + category: string; + variable: string; + timing: number; + label?: string; +}; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.trackerconfiguration.appid.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.trackerconfiguration.appid.md new file mode 100644 index 000000000..fe9ce9c7b --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.trackerconfiguration.appid.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [TrackerConfiguration](./react-native-tracker.trackerconfiguration.md) > [appId](./react-native-tracker.trackerconfiguration.appid.md) + +## TrackerConfiguration.appId property + +The application ID + +Signature: + +```typescript +appId?: string; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.trackerconfiguration.deviceplatform.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.trackerconfiguration.deviceplatform.md new file mode 100644 index 000000000..524068eb4 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.trackerconfiguration.deviceplatform.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [TrackerConfiguration](./react-native-tracker.trackerconfiguration.md) > [devicePlatform](./react-native-tracker.trackerconfiguration.deviceplatform.md) + +## TrackerConfiguration.devicePlatform property + +The device platform the tracker runs on. + +Signature: + +```typescript +devicePlatform?: Platform; +``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.trackerconfiguration.encodebase64.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.trackerconfiguration.encodebase64.md similarity index 51% rename from api-docs/docs/node-tracker/markdown/node-tracker.trackerconfiguration.encodebase64.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.trackerconfiguration.encodebase64.md index 185fa5a9b..9e2fcafe8 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.trackerconfiguration.encodebase64.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.trackerconfiguration.encodebase64.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [TrackerConfiguration](./node-tracker.trackerconfiguration.md) > [encodeBase64](./node-tracker.trackerconfiguration.encodebase64.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [TrackerConfiguration](./react-native-tracker.trackerconfiguration.md) > [encodeBase64](./react-native-tracker.trackerconfiguration.encodebase64.md) ## TrackerConfiguration.encodeBase64 property diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.trackerconfiguration.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.trackerconfiguration.md new file mode 100644 index 000000000..957545535 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.trackerconfiguration.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [TrackerConfiguration](./react-native-tracker.trackerconfiguration.md) + +## TrackerConfiguration interface + +The configuration object for initialising the tracker + +Signature: + +```typescript +export interface TrackerConfiguration +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [appId?](./react-native-tracker.trackerconfiguration.appid.md) | string | (Optional) The application ID | +| [devicePlatform?](./react-native-tracker.trackerconfiguration.deviceplatform.md) | Platform | (Optional) The device platform the tracker runs on. | +| [encodeBase64?](./react-native-tracker.trackerconfiguration.encodebase64.md) | boolean | (Optional) Whether unstructured events and custom contexts should be base64 encoded. | +| [namespace](./react-native-tracker.trackerconfiguration.namespace.md) | string | The namespace of the tracker | +| [plugins?](./react-native-tracker.trackerconfiguration.plugins.md) | BrowserPlugin\[\] | (Optional) Inject plugins which will be evaluated for each event | + diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.trackerconfiguration.namespace.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.trackerconfiguration.namespace.md new file mode 100644 index 000000000..dc1b7c27b --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.trackerconfiguration.namespace.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [TrackerConfiguration](./react-native-tracker.trackerconfiguration.md) > [namespace](./react-native-tracker.trackerconfiguration.namespace.md) + +## TrackerConfiguration.namespace property + +The namespace of the tracker + +Signature: + +```typescript +namespace: string; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.trackerconfiguration.plugins.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.trackerconfiguration.plugins.md new file mode 100644 index 000000000..747583695 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.trackerconfiguration.plugins.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [TrackerConfiguration](./react-native-tracker.trackerconfiguration.md) > [plugins](./react-native-tracker.trackerconfiguration.plugins.md) + +## TrackerConfiguration.plugins property + +Inject plugins which will be evaluated for each event + +Signature: + +```typescript +plugins?: BrowserPlugin[]; +``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.trackercore.addglobalcontexts.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.addglobalcontexts.md similarity index 74% rename from api-docs/docs/node-tracker/markdown/node-tracker.trackercore.addglobalcontexts.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.addglobalcontexts.md index 3ba235436..4d7ef62ba 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.trackercore.addglobalcontexts.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.addglobalcontexts.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [TrackerCore](./node-tracker.trackercore.md) > [addGlobalContexts](./node-tracker.trackercore.addglobalcontexts.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [TrackerCore](./react-native-tracker.trackercore.md) > [addGlobalContexts](./react-native-tracker.trackercore.addglobalcontexts.md) ## TrackerCore.addGlobalContexts() method diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.trackercore.addpayloaddict.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.addpayloaddict.md similarity index 62% rename from api-docs/docs/node-tracker/markdown/node-tracker.trackercore.addpayloaddict.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.addpayloaddict.md index e57e6f3bd..5c5affebf 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.trackercore.addpayloaddict.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.addpayloaddict.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [TrackerCore](./node-tracker.trackercore.md) > [addPayloadDict](./node-tracker.trackercore.addpayloaddict.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [TrackerCore](./react-native-tracker.trackercore.md) > [addPayloadDict](./react-native-tracker.trackercore.addpayloaddict.md) ## TrackerCore.addPayloadDict() method diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.trackercore.addpayloadpair.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.addpayloadpair.md similarity index 54% rename from api-docs/docs/node-tracker/markdown/node-tracker.trackercore.addpayloadpair.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.addpayloadpair.md index 801ba6a44..9de08f3da 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.trackercore.addpayloadpair.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.addpayloadpair.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [TrackerCore](./node-tracker.trackercore.md) > [addPayloadPair](./node-tracker.trackercore.addpayloadpair.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [TrackerCore](./react-native-tracker.trackercore.md) > [addPayloadPair](./react-native-tracker.trackercore.addpayloadpair.md) ## TrackerCore.addPayloadPair property diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.trackercore.addplugin.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.addplugin.md similarity index 66% rename from api-docs/docs/node-tracker/markdown/node-tracker.trackercore.addplugin.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.addplugin.md index fc585d9cf..1df2fa1a7 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.trackercore.addplugin.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.addplugin.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [TrackerCore](./node-tracker.trackercore.md) > [addPlugin](./node-tracker.trackercore.addplugin.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [TrackerCore](./react-native-tracker.trackercore.md) > [addPlugin](./react-native-tracker.trackercore.addplugin.md) ## TrackerCore.addPlugin() method diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.trackercore.clearglobalcontexts.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.clearglobalcontexts.md similarity index 50% rename from api-docs/docs/node-tracker/markdown/node-tracker.trackercore.clearglobalcontexts.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.clearglobalcontexts.md index 76592d2d7..35a7fce36 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.trackercore.clearglobalcontexts.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.clearglobalcontexts.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [TrackerCore](./node-tracker.trackercore.md) > [clearGlobalContexts](./node-tracker.trackercore.clearglobalcontexts.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [TrackerCore](./react-native-tracker.trackercore.md) > [clearGlobalContexts](./react-native-tracker.trackercore.clearglobalcontexts.md) ## TrackerCore.clearGlobalContexts() method diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.trackercore.deactivate.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.deactivate.md similarity index 63% rename from api-docs/docs/node-tracker/markdown/node-tracker.trackercore.deactivate.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.deactivate.md index d3b1daf9f..cb5771396 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.trackercore.deactivate.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.deactivate.md @@ -1,17 +1,17 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [TrackerCore](./node-tracker.trackercore.md) > [deactivate](./node-tracker.trackercore.deactivate.md) - -## TrackerCore.deactivate() method - -Deactivate tracker core including all plugins. This is useful for cleaning up resources or listeners that have been created. Once deactivated, the tracker won't be able to track any events. - -Signature: - -```typescript -deactivate(): void; -``` -Returns: - -void - + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [TrackerCore](./react-native-tracker.trackercore.md) > [deactivate](./react-native-tracker.trackercore.deactivate.md) + +## TrackerCore.deactivate() method + +Deactivate tracker core including all plugins. This is useful for cleaning up resources or listeners that have been created. Once deactivated, the tracker won't be able to track any events. + +Signature: + +```typescript +deactivate(): void; +``` +Returns: + +void + diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.trackercore.getbase64encoding.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.getbase64encoding.md similarity index 51% rename from api-docs/docs/node-tracker/markdown/node-tracker.trackercore.getbase64encoding.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.getbase64encoding.md index 7b42a4140..6398bf5b1 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.trackercore.getbase64encoding.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.getbase64encoding.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [TrackerCore](./node-tracker.trackercore.md) > [getBase64Encoding](./node-tracker.trackercore.getbase64encoding.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [TrackerCore](./react-native-tracker.trackercore.md) > [getBase64Encoding](./react-native-tracker.trackercore.getbase64encoding.md) ## TrackerCore.getBase64Encoding() method diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.md new file mode 100644 index 000000000..d2e490b5c --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.md @@ -0,0 +1,47 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [TrackerCore](./react-native-tracker.trackercore.md) + +## TrackerCore interface + +Export interface containing all Core functions + +Signature: + +```typescript +interface TrackerCore +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [addPayloadPair](./react-native-tracker.trackercore.addpayloadpair.md) | (key: string, value: unknown) => void | Set a persistent key-value pair to be added to every payload | +| [track](./react-native-tracker.trackercore.track.md) | (pb: PayloadBuilder, context?: Array<SelfDescribingJson> \| null, timestamp?: Timestamp \| null) => Payload \| undefined | Call with a payload from a buildX function Adds context and payloadPairs name-value pairs to the payload Applies the callback to the built payload | + +## Methods + +| Method | Description | +| --- | --- | +| [addGlobalContexts(contexts)](./react-native-tracker.trackercore.addglobalcontexts.md) | Adds contexts globally, contexts added here will be attached to all applicable events | +| [addPayloadDict(dict)](./react-native-tracker.trackercore.addpayloaddict.md) | Merges a dictionary into payloadPairs | +| [addPlugin(configuration)](./react-native-tracker.trackercore.addplugin.md) | Add a plugin into the plugin collection after Core has already been initialised | +| [clearGlobalContexts()](./react-native-tracker.trackercore.clearglobalcontexts.md) | Removes all global contexts | +| [deactivate()](./react-native-tracker.trackercore.deactivate.md) | Deactivate tracker core including all plugins. This is useful for cleaning up resources or listeners that have been created. Once deactivated, the tracker won't be able to track any events. | +| [getBase64Encoding()](./react-native-tracker.trackercore.getbase64encoding.md) | Get current base64 encoding state | +| [removeGlobalContexts(contexts)](./react-native-tracker.trackercore.removeglobalcontexts.md) | Removes previously added global context, performs a deep comparison of the contexts or conditional contexts | +| [resetPayloadPairs(dict)](./react-native-tracker.trackercore.resetpayloadpairs.md) | Replace payloadPairs with a new dictionary | +| [setAppId(appId)](./react-native-tracker.trackercore.setappid.md) | Set the application ID | +| [setBase64Encoding(encode)](./react-native-tracker.trackercore.setbase64encoding.md) | Turn base 64 encoding on or off | +| [setColorDepth(depth)](./react-native-tracker.trackercore.setcolordepth.md) | Set the color depth | +| [setIpAddress(ip)](./react-native-tracker.trackercore.setipaddress.md) | Set the IP address | +| [setLang(lang)](./react-native-tracker.trackercore.setlang.md) | Set the language | +| [setPlatform(value)](./react-native-tracker.trackercore.setplatform.md) | Set the platform | +| [setScreenResolution(width, height)](./react-native-tracker.trackercore.setscreenresolution.md) | Set the screen resolution | +| [setTimezone(timezone)](./react-native-tracker.trackercore.settimezone.md) | Set the timezone | +| [setTrackerNamespace(name)](./react-native-tracker.trackercore.settrackernamespace.md) | Set the tracker namespace | +| [setTrackerVersion(version)](./react-native-tracker.trackercore.settrackerversion.md) | Set the tracker version | +| [setUseragent(useragent)](./react-native-tracker.trackercore.setuseragent.md) | Set the Useragent | +| [setUserId(userId)](./react-native-tracker.trackercore.setuserid.md) | Set the user ID | +| [setViewport(width, height)](./react-native-tracker.trackercore.setviewport.md) | Set the viewport dimensions | + diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.trackercore.removeglobalcontexts.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.removeglobalcontexts.md similarity index 71% rename from api-docs/docs/node-tracker/markdown/node-tracker.trackercore.removeglobalcontexts.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.removeglobalcontexts.md index 774aef674..c34c36ae9 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.trackercore.removeglobalcontexts.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.removeglobalcontexts.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [TrackerCore](./node-tracker.trackercore.md) > [removeGlobalContexts](./node-tracker.trackercore.removeglobalcontexts.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [TrackerCore](./react-native-tracker.trackercore.md) > [removeGlobalContexts](./react-native-tracker.trackercore.removeglobalcontexts.md) ## TrackerCore.removeGlobalContexts() method diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.trackercore.resetpayloadpairs.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.resetpayloadpairs.md similarity index 63% rename from api-docs/docs/node-tracker/markdown/node-tracker.trackercore.resetpayloadpairs.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.resetpayloadpairs.md index 8113180dd..7aa688a02 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.trackercore.resetpayloadpairs.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.resetpayloadpairs.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [TrackerCore](./node-tracker.trackercore.md) > [resetPayloadPairs](./node-tracker.trackercore.resetpayloadpairs.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [TrackerCore](./react-native-tracker.trackercore.md) > [resetPayloadPairs](./react-native-tracker.trackercore.resetpayloadpairs.md) ## TrackerCore.resetPayloadPairs() method diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.trackercore.setappid.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.setappid.md similarity index 62% rename from api-docs/docs/node-tracker/markdown/node-tracker.trackercore.setappid.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.setappid.md index e25c39c44..abd0a93a1 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.trackercore.setappid.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.setappid.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [TrackerCore](./node-tracker.trackercore.md) > [setAppId](./node-tracker.trackercore.setappid.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [TrackerCore](./react-native-tracker.trackercore.md) > [setAppId](./react-native-tracker.trackercore.setappid.md) ## TrackerCore.setAppId() method diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.trackercore.setbase64encoding.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.setbase64encoding.md similarity index 60% rename from api-docs/docs/node-tracker/markdown/node-tracker.trackercore.setbase64encoding.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.setbase64encoding.md index 7a6317ef0..dba55d738 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.trackercore.setbase64encoding.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.setbase64encoding.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [TrackerCore](./node-tracker.trackercore.md) > [setBase64Encoding](./node-tracker.trackercore.setbase64encoding.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [TrackerCore](./react-native-tracker.trackercore.md) > [setBase64Encoding](./react-native-tracker.trackercore.setbase64encoding.md) ## TrackerCore.setBase64Encoding() method diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.trackercore.setcolordepth.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.setcolordepth.md similarity index 60% rename from api-docs/docs/node-tracker/markdown/node-tracker.trackercore.setcolordepth.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.setcolordepth.md index b63a709dd..112999575 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.trackercore.setcolordepth.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.setcolordepth.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [TrackerCore](./node-tracker.trackercore.md) > [setColorDepth](./node-tracker.trackercore.setcolordepth.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [TrackerCore](./react-native-tracker.trackercore.md) > [setColorDepth](./react-native-tracker.trackercore.setcolordepth.md) ## TrackerCore.setColorDepth() method diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.trackercore.setipaddress.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.setipaddress.md similarity index 59% rename from api-docs/docs/node-tracker/markdown/node-tracker.trackercore.setipaddress.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.setipaddress.md index 3b67872fb..31498859f 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.trackercore.setipaddress.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.setipaddress.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [TrackerCore](./node-tracker.trackercore.md) > [setIpAddress](./node-tracker.trackercore.setipaddress.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [TrackerCore](./react-native-tracker.trackercore.md) > [setIpAddress](./react-native-tracker.trackercore.setipaddress.md) ## TrackerCore.setIpAddress() method diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.trackercore.setlang.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.setlang.md similarity index 60% rename from api-docs/docs/node-tracker/markdown/node-tracker.trackercore.setlang.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.setlang.md index 899bca60d..7100dc2ee 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.trackercore.setlang.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.setlang.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [TrackerCore](./node-tracker.trackercore.md) > [setLang](./node-tracker.trackercore.setlang.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [TrackerCore](./react-native-tracker.trackercore.md) > [setLang](./react-native-tracker.trackercore.setlang.md) ## TrackerCore.setLang() method diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.trackercore.setplatform.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.setplatform.md similarity index 60% rename from api-docs/docs/node-tracker/markdown/node-tracker.trackercore.setplatform.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.setplatform.md index 88e822f73..6c1ba1297 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.trackercore.setplatform.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.setplatform.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [TrackerCore](./node-tracker.trackercore.md) > [setPlatform](./node-tracker.trackercore.setplatform.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [TrackerCore](./react-native-tracker.trackercore.md) > [setPlatform](./react-native-tracker.trackercore.setplatform.md) ## TrackerCore.setPlatform() method diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.trackercore.setscreenresolution.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.setscreenresolution.md similarity index 63% rename from api-docs/docs/node-tracker/markdown/node-tracker.trackercore.setscreenresolution.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.setscreenresolution.md index a911fd57c..b24ab49f7 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.trackercore.setscreenresolution.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.setscreenresolution.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [TrackerCore](./node-tracker.trackercore.md) > [setScreenResolution](./node-tracker.trackercore.setscreenresolution.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [TrackerCore](./react-native-tracker.trackercore.md) > [setScreenResolution](./react-native-tracker.trackercore.setscreenresolution.md) ## TrackerCore.setScreenResolution() method diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.trackercore.settimezone.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.settimezone.md similarity index 59% rename from api-docs/docs/node-tracker/markdown/node-tracker.trackercore.settimezone.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.settimezone.md index ae1538649..3268c1374 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.trackercore.settimezone.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.settimezone.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [TrackerCore](./node-tracker.trackercore.md) > [setTimezone](./node-tracker.trackercore.settimezone.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [TrackerCore](./react-native-tracker.trackercore.md) > [setTimezone](./react-native-tracker.trackercore.settimezone.md) ## TrackerCore.setTimezone() method diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.trackercore.settrackernamespace.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.settrackernamespace.md similarity index 59% rename from api-docs/docs/node-tracker/markdown/node-tracker.trackercore.settrackernamespace.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.settrackernamespace.md index 58263903b..a07eb93af 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.trackercore.settrackernamespace.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.settrackernamespace.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [TrackerCore](./node-tracker.trackercore.md) > [setTrackerNamespace](./node-tracker.trackercore.settrackernamespace.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [TrackerCore](./react-native-tracker.trackercore.md) > [setTrackerNamespace](./react-native-tracker.trackercore.settrackernamespace.md) ## TrackerCore.setTrackerNamespace() method diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.trackercore.settrackerversion.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.settrackerversion.md similarity index 60% rename from api-docs/docs/node-tracker/markdown/node-tracker.trackercore.settrackerversion.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.settrackerversion.md index 1b8824e87..a2abc9b95 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.trackercore.settrackerversion.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.settrackerversion.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [TrackerCore](./node-tracker.trackercore.md) > [setTrackerVersion](./node-tracker.trackercore.settrackerversion.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [TrackerCore](./react-native-tracker.trackercore.md) > [setTrackerVersion](./react-native-tracker.trackercore.settrackerversion.md) ## TrackerCore.setTrackerVersion() method diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.trackercore.setuseragent.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.setuseragent.md similarity index 60% rename from api-docs/docs/node-tracker/markdown/node-tracker.trackercore.setuseragent.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.setuseragent.md index ca24eafb3..eb86f389d 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.trackercore.setuseragent.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.setuseragent.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [TrackerCore](./node-tracker.trackercore.md) > [setUseragent](./node-tracker.trackercore.setuseragent.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [TrackerCore](./react-native-tracker.trackercore.md) > [setUseragent](./react-native-tracker.trackercore.setuseragent.md) ## TrackerCore.setUseragent() method diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.trackercore.setuserid.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.setuserid.md similarity index 59% rename from api-docs/docs/node-tracker/markdown/node-tracker.trackercore.setuserid.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.setuserid.md index 4fe139f63..e0b1a998c 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.trackercore.setuserid.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.setuserid.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [TrackerCore](./node-tracker.trackercore.md) > [setUserId](./node-tracker.trackercore.setuserid.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [TrackerCore](./react-native-tracker.trackercore.md) > [setUserId](./react-native-tracker.trackercore.setuserid.md) ## TrackerCore.setUserId() method diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.trackercore.setviewport.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.setviewport.md similarity index 63% rename from api-docs/docs/node-tracker/markdown/node-tracker.trackercore.setviewport.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.setviewport.md index ef6eff820..b7fffbf25 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.trackercore.setviewport.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.setviewport.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [TrackerCore](./node-tracker.trackercore.md) > [setViewport](./node-tracker.trackercore.setviewport.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [TrackerCore](./react-native-tracker.trackercore.md) > [setViewport](./react-native-tracker.trackercore.setviewport.md) ## TrackerCore.setViewport() method diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.trackercore.track.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.track.md similarity index 66% rename from api-docs/docs/node-tracker/markdown/node-tracker.trackercore.track.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.track.md index 30162bf17..c6787defc 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.trackercore.track.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.trackercore.track.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [TrackerCore](./node-tracker.trackercore.md) > [track](./node-tracker.trackercore.track.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [TrackerCore](./react-native-tracker.trackercore.md) > [track](./react-native-tracker.trackercore.track.md) ## TrackerCore.track property diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.trigger.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.trigger.md new file mode 100644 index 000000000..649a12dbe --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.trigger.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [Trigger](./react-native-tracker.trigger.md) + +## Trigger type + +Trigger for MessageNotification event + +Signature: + +```typescript +export declare type Trigger = 'push' | 'location' | 'calendar' | 'timeInterval' | 'other'; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.truetimestamp.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.truetimestamp.md new file mode 100644 index 000000000..5f72c3dc2 --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.truetimestamp.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [TrueTimestamp](./react-native-tracker.truetimestamp.md) + +## TrueTimestamp interface + +A representation of a True Timestamp (ttm) + +Signature: + +```typescript +interface TrueTimestamp +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [type](./react-native-tracker.truetimestamp.type.md) | "ttm" | | +| [value](./react-native-tracker.truetimestamp.value.md) | number | | + diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.truetimestamp.type.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.truetimestamp.type.md new file mode 100644 index 000000000..0c5f08f1d --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.truetimestamp.type.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [TrueTimestamp](./react-native-tracker.truetimestamp.md) > [type](./react-native-tracker.truetimestamp.type.md) + +## TrueTimestamp.type property + +Signature: + +```typescript +readonly type: "ttm"; +``` diff --git a/api-docs/docs/node-tracker/markdown/react-native-tracker.truetimestamp.value.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.truetimestamp.value.md new file mode 100644 index 000000000..0adbe9cae --- /dev/null +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.truetimestamp.value.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [TrueTimestamp](./react-native-tracker.truetimestamp.md) > [value](./react-native-tracker.truetimestamp.value.md) + +## TrueTimestamp.value property + +Signature: + +```typescript +readonly value: number; +``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.version.md b/api-docs/docs/node-tracker/markdown/react-native-tracker.version.md similarity index 51% rename from api-docs/docs/node-tracker/markdown/node-tracker.version.md rename to api-docs/docs/node-tracker/markdown/react-native-tracker.version.md index 6d17a1434..2614e08f0 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.version.md +++ b/api-docs/docs/node-tracker/markdown/react-native-tracker.version.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [version](./node-tracker.version.md) +[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [version](./react-native-tracker.version.md) ## version variable