Skip to content

Commit f717666

Browse files
Applying documentation updates.
1 parent 9fdad42 commit f717666

6 files changed

+78
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [BrowserTracker](./browser-tracker.browsertracker.md) &gt; [disableActivityTracking](./browser-tracker.browsertracker.disableactivitytracking.md)
4+
5+
## BrowserTracker.disableActivityTracking property
6+
7+
Disables page activity tracking.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
disableActivityTracking: () => void;
13+
```
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [BrowserTracker](./browser-tracker.browsertracker.md) &gt; [disableActivityTrackingCallback](./browser-tracker.browsertracker.disableactivitytrackingcallback.md)
4+
5+
## BrowserTracker.disableActivityTrackingCallback property
6+
7+
Disables page activity tracking callback.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
disableActivityTrackingCallback: () => void;
13+
```

trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.md

+2
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ interface BrowserTracker
2020
| [clearUserData](./browser-tracker.browsertracker.clearuserdata.md) | (configuration?: ClearUserDataConfiguration) =&gt; void | Clears all cookies and local storage containing user and session identifiers |
2121
| [core](./browser-tracker.browsertracker.core.md) | TrackerCore | The instance of the core library which this tracker has initialised |
2222
| [crossDomainLinker](./browser-tracker.browsertracker.crossdomainlinker.md) | (crossDomainLinkerCriterion: (elt: HTMLAnchorElement \| HTMLAreaElement) =&gt; boolean) =&gt; void | Enable querystring decoration for links passing a filter |
23+
| [disableActivityTracking](./browser-tracker.browsertracker.disableactivitytracking.md) | () =&gt; void | Disables page activity tracking. |
24+
| [disableActivityTrackingCallback](./browser-tracker.browsertracker.disableactivitytrackingcallback.md) | () =&gt; void | Disables page activity tracking callback. |
2325
| [disableAnonymousTracking](./browser-tracker.browsertracker.disableanonymoustracking.md) | (configuration?: DisableAnonymousTrackingConfiguration) =&gt; void | Disables anonymous tracking if active (ie. tracker initialized with <code>anonymousTracking</code>) For stateStorageStrategy override, uses supplied value first, falls back to one defined in initial config, otherwise uses cookieAndLocalStorage. |
2426
| [discardBrace](./browser-tracker.browsertracker.discardbrace.md) | (enableFilter: boolean) =&gt; void | Strip braces from URL |
2527
| [discardHashTag](./browser-tracker.browsertracker.discardhashtag.md) | (enableFilter: boolean) =&gt; void | Strip hash tag (or anchor) from URL |
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [disableActivityTracking](./browser-tracker.disableactivitytracking.md)
4+
5+
## disableActivityTracking() function
6+
7+
Disables page activity tracking.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
declare function disableActivityTracking(trackers?: Array<string>): void;
13+
```
14+
15+
## Parameters
16+
17+
| Parameter | Type | Description |
18+
| --- | --- | --- |
19+
| trackers | Array&lt;string&gt; | The tracker identifiers the activity tracking will be disabled. |
20+
21+
<b>Returns:</b>
22+
23+
void
24+
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [disableActivityTrackingCallback](./browser-tracker.disableactivitytrackingcallback.md)
4+
5+
## disableActivityTrackingCallback() function
6+
7+
Disables page activity tracking callback.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
declare function disableActivityTrackingCallback(trackers?: Array<string>): void;
13+
```
14+
15+
## Parameters
16+
17+
| Parameter | Type | Description |
18+
| --- | --- | --- |
19+
| trackers | Array&lt;string&gt; | The tracker identifiers the activity tracking callback will be disabled. |
20+
21+
<b>Returns:</b>
22+
23+
void
24+

trackers/browser-tracker/docs/markdown/browser-tracker.md

+2
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@
1313
| [clearGlobalContexts(trackers)](./browser-tracker.clearglobalcontexts.md) | Clear all global contexts that are sent with events |
1414
| [clearUserData(configuration, trackers)](./browser-tracker.clearuserdata.md) | Clears all cookies and local storage containing user and session identifiers |
1515
| [crossDomainLinker(crossDomainLinkerCriterion, trackers)](./browser-tracker.crossdomainlinker.md) | Enable querystring decoration for links pasing a filter |
16+
| [disableActivityTracking(trackers)](./browser-tracker.disableactivitytracking.md) | Disables page activity tracking. |
17+
| [disableActivityTrackingCallback(trackers)](./browser-tracker.disableactivitytrackingcallback.md) | Disables page activity tracking callback. |
1618
| [disableAnonymousTracking(configuration, trackers)](./browser-tracker.disableanonymoustracking.md) | Disables anonymous tracking if active (ie. tracker initialized with <code>anonymousTracking</code>) For stateStorageStrategy override, uses supplied value first, falls back to one defined in initial config, otherwise uses cookieAndLocalStorage. |
1719
| [discardBrace(enable, trackers)](./browser-tracker.discardbrace.md) | Strip braces from URL |
1820
| [discardHashTag(enable, trackers)](./browser-tracker.discardhashtag.md) | Strip hash tag (or anchor) from URL |

0 commit comments

Comments
 (0)