Skip to content

Commit

Permalink
Applying documentation updates.
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Aug 10, 2023
1 parent 9fdad42 commit f717666
Show file tree
Hide file tree
Showing 6 changed files with 78 additions and 0 deletions.
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) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [BrowserTracker](./browser-tracker.browsertracker.md) &gt; [disableActivityTracking](./browser-tracker.browsertracker.disableactivitytracking.md)

## BrowserTracker.disableActivityTracking property

Disables page activity tracking.

<b>Signature:</b>

```typescript
disableActivityTracking: () => void;
```
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) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [BrowserTracker](./browser-tracker.browsertracker.md) &gt; [disableActivityTrackingCallback](./browser-tracker.browsertracker.disableactivitytrackingcallback.md)

## BrowserTracker.disableActivityTrackingCallback property

Disables page activity tracking callback.

<b>Signature:</b>

```typescript
disableActivityTrackingCallback: () => void;
```
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ interface BrowserTracker
| [clearUserData](./browser-tracker.browsertracker.clearuserdata.md) | (configuration?: ClearUserDataConfiguration) =&gt; void | Clears all cookies and local storage containing user and session identifiers |
| [core](./browser-tracker.browsertracker.core.md) | TrackerCore | The instance of the core library which this tracker has initialised |
| [crossDomainLinker](./browser-tracker.browsertracker.crossdomainlinker.md) | (crossDomainLinkerCriterion: (elt: HTMLAnchorElement \| HTMLAreaElement) =&gt; boolean) =&gt; void | Enable querystring decoration for links passing a filter |
| [disableActivityTracking](./browser-tracker.browsertracker.disableactivitytracking.md) | () =&gt; void | Disables page activity tracking. |
| [disableActivityTrackingCallback](./browser-tracker.browsertracker.disableactivitytrackingcallback.md) | () =&gt; void | Disables page activity tracking callback. |
| [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. |
| [discardBrace](./browser-tracker.browsertracker.discardbrace.md) | (enableFilter: boolean) =&gt; void | Strip braces from URL |
| [discardHashTag](./browser-tracker.browsertracker.discardhashtag.md) | (enableFilter: boolean) =&gt; void | Strip hash tag (or anchor) from URL |
Expand Down
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) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [disableActivityTracking](./browser-tracker.disableactivitytracking.md)

## disableActivityTracking() function

Disables page activity tracking.

<b>Signature:</b>

```typescript
declare function disableActivityTracking(trackers?: Array<string>): void;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| trackers | Array&lt;string&gt; | The tracker identifiers the activity tracking will be disabled. |

<b>Returns:</b>

void

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) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [disableActivityTrackingCallback](./browser-tracker.disableactivitytrackingcallback.md)

## disableActivityTrackingCallback() function

Disables page activity tracking callback.

<b>Signature:</b>

```typescript
declare function disableActivityTrackingCallback(trackers?: Array<string>): void;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| trackers | Array&lt;string&gt; | The tracker identifiers the activity tracking callback will be disabled. |

<b>Returns:</b>

void

2 changes: 2 additions & 0 deletions trackers/browser-tracker/docs/markdown/browser-tracker.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@
| [clearGlobalContexts(trackers)](./browser-tracker.clearglobalcontexts.md) | Clear all global contexts that are sent with events |
| [clearUserData(configuration, trackers)](./browser-tracker.clearuserdata.md) | Clears all cookies and local storage containing user and session identifiers |
| [crossDomainLinker(crossDomainLinkerCriterion, trackers)](./browser-tracker.crossdomainlinker.md) | Enable querystring decoration for links pasing a filter |
| [disableActivityTracking(trackers)](./browser-tracker.disableactivitytracking.md) | Disables page activity tracking. |
| [disableActivityTrackingCallback(trackers)](./browser-tracker.disableactivitytrackingcallback.md) | Disables page activity tracking callback. |
| [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. |
| [discardBrace(enable, trackers)](./browser-tracker.discardbrace.md) | Strip braces from URL |
| [discardHashTag(enable, trackers)](./browser-tracker.discardhashtag.md) | Strip hash tag (or anchor) from URL |
Expand Down

0 comments on commit f717666

Please sign in to comment.