-
Notifications
You must be signed in to change notification settings - Fork 222
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
c8e742b
commit 879d40c
Showing
15 changed files
with
151 additions
and
2 deletions.
There are no files selected for viewing
13 changes: 13 additions & 0 deletions
13
api-docs/docs/node-tracker/markdown/node-tracker.coreplugin.deactivateplugin.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[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. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
deactivatePlugin?: (core: TrackerCore) => void; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
17 changes: 17 additions & 0 deletions
17
api-docs/docs/node-tracker/markdown/node-tracker.trackercore.deactivate.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[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. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
deactivate(): void; | ||
``` | ||
<b>Returns:</b> | ||
|
||
void | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
13 changes: 13 additions & 0 deletions
13
...act-native-tracker/markdown/react-native-tracker.coreplugin.deactivateplugin.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[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. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
deactivatePlugin?: (core: TrackerCore) => void; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
26 changes: 26 additions & 0 deletions
26
api-docs/docs/react-native-tracker/markdown/react-native-tracker.gettracker.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[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 | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export declare function getTracker(trackerNamespace: string): ReactNativeTracker | undefined; | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| trackerNamespace | string | Tracker namespace | | ||
|
||
<b>Returns:</b> | ||
|
||
[ReactNativeTracker](./react-native-tracker.reactnativetracker.md) \| undefined | ||
|
||
Tracker instance if exists | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
19 changes: 19 additions & 0 deletions
19
...cs/docs/react-native-tracker/markdown/react-native-tracker.removealltrackers.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [removeAllTrackers](./react-native-tracker.removealltrackers.md) | ||
|
||
## removeAllTrackers() function | ||
|
||
Removes all initialized trackers | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export declare function removeAllTrackers(): void; | ||
``` | ||
<b>Returns:</b> | ||
|
||
void | ||
|
||
- A boolean promise | ||
|
24 changes: 24 additions & 0 deletions
24
api-docs/docs/react-native-tracker/markdown/react-native-tracker.removetracker.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[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 | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export declare function removeTracker(trackerNamespace: string): void; | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| trackerNamespace | string | Tracker namespace | | ||
|
||
<b>Returns:</b> | ||
|
||
void | ||
|
17 changes: 17 additions & 0 deletions
17
...cs/react-native-tracker/markdown/react-native-tracker.trackercore.deactivate.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[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. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
deactivate(): void; | ||
``` | ||
<b>Returns:</b> | ||
|
||
void | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters