From f71766614f59eb90eaab6bf9141aed0b9255683d Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 10 Aug 2023 14:01:44 +0000 Subject: [PATCH] Applying documentation updates. --- ....browsertracker.disableactivitytracking.md | 13 ++++++++++ ...tracker.disableactivitytrackingcallback.md | 13 ++++++++++ .../browser-tracker.browsertracker.md | 2 ++ ...browser-tracker.disableactivitytracking.md | 24 +++++++++++++++++++ ...tracker.disableactivitytrackingcallback.md | 24 +++++++++++++++++++ .../docs/markdown/browser-tracker.md | 2 ++ 6 files changed, 78 insertions(+) create mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.disableactivitytracking.md create mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.disableactivitytrackingcallback.md create mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.disableactivitytracking.md create mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.disableactivitytrackingcallback.md diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.disableactivitytracking.md b/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.disableactivitytracking.md new file mode 100644 index 000000000..6b80aec01 --- /dev/null +++ b/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.disableactivitytracking.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserTracker](./browser-tracker.browsertracker.md) > [disableActivityTracking](./browser-tracker.browsertracker.disableactivitytracking.md) + +## BrowserTracker.disableActivityTracking property + +Disables page activity tracking. + +Signature: + +```typescript +disableActivityTracking: () => void; +``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.disableactivitytrackingcallback.md b/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.disableactivitytrackingcallback.md new file mode 100644 index 000000000..056a79fb0 --- /dev/null +++ b/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.disableactivitytrackingcallback.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserTracker](./browser-tracker.browsertracker.md) > [disableActivityTrackingCallback](./browser-tracker.browsertracker.disableactivitytrackingcallback.md) + +## BrowserTracker.disableActivityTrackingCallback property + +Disables page activity tracking callback. + +Signature: + +```typescript +disableActivityTrackingCallback: () => void; +``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.md b/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.md index 8938242be..abbf32f60 100644 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.md +++ b/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.md @@ -20,6 +20,8 @@ interface BrowserTracker | [clearUserData](./browser-tracker.browsertracker.clearuserdata.md) | (configuration?: ClearUserDataConfiguration) => 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) => boolean) => void | Enable querystring decoration for links passing a filter | +| [disableActivityTracking](./browser-tracker.browsertracker.disableactivitytracking.md) | () => void | Disables page activity tracking. | +| [disableActivityTrackingCallback](./browser-tracker.browsertracker.disableactivitytrackingcallback.md) | () => void | Disables page activity tracking callback. | | [disableAnonymousTracking](./browser-tracker.browsertracker.disableanonymoustracking.md) | (configuration?: DisableAnonymousTrackingConfiguration) => void | Disables anonymous tracking if active (ie. tracker initialized with anonymousTracking) 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) => void | Strip braces from URL | | [discardHashTag](./browser-tracker.browsertracker.discardhashtag.md) | (enableFilter: boolean) => void | Strip hash tag (or anchor) from URL | diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.disableactivitytracking.md b/trackers/browser-tracker/docs/markdown/browser-tracker.disableactivitytracking.md new file mode 100644 index 000000000..be17fdb57 --- /dev/null +++ b/trackers/browser-tracker/docs/markdown/browser-tracker.disableactivitytracking.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [disableActivityTracking](./browser-tracker.disableactivitytracking.md) + +## disableActivityTracking() function + +Disables page activity tracking. + +Signature: + +```typescript +declare function disableActivityTracking(trackers?: Array): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| trackers | Array<string> | The tracker identifiers the activity tracking will be disabled. | + +Returns: + +void + diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.disableactivitytrackingcallback.md b/trackers/browser-tracker/docs/markdown/browser-tracker.disableactivitytrackingcallback.md new file mode 100644 index 000000000..9b15963b1 --- /dev/null +++ b/trackers/browser-tracker/docs/markdown/browser-tracker.disableactivitytrackingcallback.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [disableActivityTrackingCallback](./browser-tracker.disableactivitytrackingcallback.md) + +## disableActivityTrackingCallback() function + +Disables page activity tracking callback. + +Signature: + +```typescript +declare function disableActivityTrackingCallback(trackers?: Array): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| trackers | Array<string> | The tracker identifiers the activity tracking callback will be disabled. | + +Returns: + +void + diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.md b/trackers/browser-tracker/docs/markdown/browser-tracker.md index 48b3032bc..66ea8d974 100644 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.md +++ b/trackers/browser-tracker/docs/markdown/browser-tracker.md @@ -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 anonymousTracking) 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 |