Skip to content

Commit 77829ae

Browse files
Applying documentation updates.
1 parent f366027 commit 77829ae

31 files changed

+107
-51
lines changed

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

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,13 @@
66

77
Called when the plugin is initialised during the Tracker construction
88

9-
Use to capture the specific Tracker instance for each instance of a Browser Plugin
10-
119
<b>Signature:</b>
1210

1311
```typescript
1412
activateBrowserPlugin?: (tracker: BrowserTracker) => void;
1513
```
14+
15+
## Remarks
16+
17+
Use to capture the specific Tracker instance for each instance of a Browser Plugin
18+

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,5 +17,5 @@ interface BrowserPlugin extends CorePlugin
1717
1818
| Property | Type | Description |
1919
| --- | --- | --- |
20-
| [activateBrowserPlugin?](./browser-tracker.browserplugin.activatebrowserplugin.md) | (tracker: BrowserTracker) =&gt; void | <i>(Optional)</i> Called when the plugin is initialised during the Tracker construction<!-- -->Use to capture the specific Tracker instance for each instance of a Browser Plugin |
20+
| [activateBrowserPlugin?](./browser-tracker.browserplugin.activatebrowserplugin.md) | (tracker: BrowserTracker) =&gt; void | <i>(Optional)</i> Called when the plugin is initialised during the Tracker construction |
2121

trackers/node-tracker/docs/markdown/node-tracker.adclickevent.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,16 @@
66

77
An Ad Click Event Used to track an advertisement click
88

9-
If you provide the cost field, you must also provide one of 'cpa', 'cpc', and 'cpm' for the costModel field.
10-
119
<b>Signature:</b>
1210

1311
```typescript
1412
interface AdClickEvent
1513
```
1614

15+
## Remarks
16+
17+
If you provide the cost field, you must also provide one of 'cpa', 'cpc', and 'cpm' for the costModel field.
18+
1719
## Properties
1820

1921
| Property | Type | Description |

trackers/node-tracker/docs/markdown/node-tracker.adconversionevent.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,16 @@
66

77
An Ad Conversion Event Used to track an advertisement click
88

9-
If you provide the cost field, you must also provide one of 'cpa', 'cpc', and 'cpm' for the costModel field.
10-
119
<b>Signature:</b>
1210

1311
```typescript
1412
interface AdConversionEvent
1513
```
1614

15+
## Remarks
16+
17+
If you provide the cost field, you must also provide one of 'cpa', 'cpc', and 'cpm' for the costModel field.
18+
1719
## Properties
1820

1921
| Property | Type | Description |

trackers/node-tracker/docs/markdown/node-tracker.adimpressionevent.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,16 @@
66

77
An Ad Impression Event Used to track an advertisement impression
88

9-
If you provide the cost field, you must also provide one of 'cpa', 'cpc', and 'cpm' for the costModel field.
10-
119
<b>Signature:</b>
1210

1311
```typescript
1412
interface AdImpressionEvent
1513
```
1614

15+
## Remarks
16+
17+
If you provide the cost field, you must also provide one of 'cpa', 'cpc', and 'cpm' for the costModel field.
18+
1719
## Properties
1820

1921
| Property | Type | Description |

trackers/node-tracker/docs/markdown/node-tracker.buildadclick.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,6 @@
66

77
Build a Ad Click Event Used to track an advertisement click
88

9-
If you provide the cost field, you must also provide one of 'cpa', 'cpc', and 'cpm' for the costModel field.
10-
119
<b>Signature:</b>
1210

1311
```typescript
@@ -18,9 +16,15 @@ declare function buildAdClick(event: AdClickEvent): PayloadBuilder;
1816

1917
| Parameter | Type | Description |
2018
| --- | --- | --- |
21-
| event | AdClickEvent | Contains the properties for the Ad Click event PayloadBuilder to be sent to |
19+
| event | AdClickEvent | Contains the properties for the Ad Click event |
2220

2321
<b>Returns:</b>
2422

2523
PayloadBuilder
2624

25+
PayloadBuilder to be sent to
26+
27+
## Remarks
28+
29+
If you provide the cost field, you must also provide one of 'cpa', 'cpc', and 'cpm' for the costModel field.
30+

trackers/node-tracker/docs/markdown/node-tracker.buildadconversion.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,6 @@
66

77
Build a Ad Conversion Event Used to track an advertisement click
88

9-
If you provide the cost field, you must also provide one of 'cpa', 'cpc', and 'cpm' for the costModel field.
10-
119
<b>Signature:</b>
1210

1311
```typescript
@@ -18,9 +16,15 @@ declare function buildAdConversion(event: AdConversionEvent): PayloadBuilder;
1816

1917
| Parameter | Type | Description |
2018
| --- | --- | --- |
21-
| event | AdConversionEvent | Contains the properties for the Ad Conversion event PayloadBuilder to be sent to |
19+
| event | AdConversionEvent | Contains the properties for the Ad Conversion event |
2220

2321
<b>Returns:</b>
2422

2523
PayloadBuilder
2624

25+
PayloadBuilder to be sent to
26+
27+
## Remarks
28+
29+
If you provide the cost field, you must also provide one of 'cpa', 'cpc', and 'cpm' for the costModel field.
30+

trackers/node-tracker/docs/markdown/node-tracker.buildaddtocart.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,11 @@ declare function buildAddToCart(event: AddToCartEvent): PayloadBuilder;
1616

1717
| Parameter | Type | Description |
1818
| --- | --- | --- |
19-
| event | AddToCartEvent | Contains the properties for the Add To Cart event PayloadBuilder to be sent to |
19+
| event | AddToCartEvent | Contains the properties for the Add To Cart event |
2020

2121
<b>Returns:</b>
2222

2323
PayloadBuilder
2424

25+
PayloadBuilder to be sent to
26+

trackers/node-tracker/docs/markdown/node-tracker.buildadimpression.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,6 @@
66

77
Build a Ad Impression Event Used to track an advertisement impression
88

9-
If you provide the cost field, you must also provide one of 'cpa', 'cpc', and 'cpm' for the costModel field.
10-
119
<b>Signature:</b>
1210

1311
```typescript
@@ -18,9 +16,15 @@ declare function buildAdImpression(event: AdImpressionEvent): PayloadBuilder;
1816

1917
| Parameter | Type | Description |
2018
| --- | --- | --- |
21-
| event | AdImpressionEvent | Contains the properties for the Ad Impression event PayloadBuilder to be sent to |
19+
| event | AdImpressionEvent | Contains the properties for the Ad Impression event |
2220

2321
<b>Returns:</b>
2422

2523
PayloadBuilder
2624

25+
PayloadBuilder to be sent to
26+
27+
## Remarks
28+
29+
If you provide the cost field, you must also provide one of 'cpa', 'cpc', and 'cpm' for the costModel field.
30+

trackers/node-tracker/docs/markdown/node-tracker.buildconsentgranted.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,11 @@ declare function buildConsentGranted(event: ConsentGrantedEvent): {
2222

2323
| Parameter | Type | Description |
2424
| --- | --- | --- |
25-
| event | ConsentGrantedEvent | Contains the properties for the Consent Granted event An object containing the PayloadBuilder to be sent to and a 'consent\_document' context |
25+
| event | ConsentGrantedEvent | Contains the properties for the Consent Granted event |
2626

2727
<b>Returns:</b>
2828

2929
{ event: PayloadBuilder; context: { schema: string; data: Record&lt;string, unknown&gt;; }\[\]; }
3030

31+
An object containing the PayloadBuilder to be sent to and a 'consent\_document' context
32+

trackers/node-tracker/docs/markdown/node-tracker.buildconsentwithdrawn.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,11 @@ declare function buildConsentWithdrawn(event: ConsentWithdrawnEvent): {
2222

2323
| Parameter | Type | Description |
2424
| --- | --- | --- |
25-
| event | ConsentWithdrawnEvent | Contains the properties for the Consent Withdrawn event An object containing the PayloadBuilder to be sent to and a 'consent\_document' context |
25+
| event | ConsentWithdrawnEvent | Contains the properties for the Consent Withdrawn event |
2626

2727
<b>Returns:</b>
2828

2929
{ event: PayloadBuilder; context: { schema: string; data: Record&lt;string, unknown&gt;; }\[\]; }
3030

31+
An object containing the PayloadBuilder to be sent to and a 'consent\_document' context
32+

trackers/node-tracker/docs/markdown/node-tracker.buildecommercetransaction.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,11 @@ declare function buildEcommerceTransaction(event: EcommerceTransactionEvent): Pa
1616

1717
| Parameter | Type | Description |
1818
| --- | --- | --- |
19-
| event | EcommerceTransactionEvent | Contains the properties for the Ecommerce Transactoion event PayloadBuilder to be sent to |
19+
| event | EcommerceTransactionEvent | Contains the properties for the Ecommerce Transactoion event |
2020

2121
<b>Returns:</b>
2222

2323
PayloadBuilder
2424

25+
PayloadBuilder to be sent to
26+

trackers/node-tracker/docs/markdown/node-tracker.buildecommercetransactionitem.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,11 @@ declare function buildEcommerceTransactionItem(event: EcommerceTransactionItemEv
1616

1717
| Parameter | Type | Description |
1818
| --- | --- | --- |
19-
| event | EcommerceTransactionItemEvent | Contains the properties for the Ecommerce Transaction Item event PayloadBuilder to be sent to |
19+
| event | EcommerceTransactionItemEvent | Contains the properties for the Ecommerce Transaction Item event |
2020

2121
<b>Returns:</b>
2222

2323
PayloadBuilder
2424

25+
PayloadBuilder to be sent to
26+

trackers/node-tracker/docs/markdown/node-tracker.buildformfocusorchange.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,11 @@ declare function buildFormFocusOrChange(event: FormFocusOrChangeEvent): PayloadB
1616

1717
| Parameter | Type | Description |
1818
| --- | --- | --- |
19-
| event | FormFocusOrChangeEvent | Contains the properties for the Form Focus or Change Form event PayloadBuilder to be sent to |
19+
| event | FormFocusOrChangeEvent | Contains the properties for the Form Focus or Change Form event |
2020

2121
<b>Returns:</b>
2222

2323
PayloadBuilder
2424

25+
PayloadBuilder to be sent to
26+

trackers/node-tracker/docs/markdown/node-tracker.buildformsubmission.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,11 @@ declare function buildFormSubmission(event: FormSubmissionEvent): PayloadBuilder
1616

1717
| Parameter | Type | Description |
1818
| --- | --- | --- |
19-
| event | FormSubmissionEvent | Contains the properties for the Form Submission event PayloadBuilder to be sent to |
19+
| event | FormSubmissionEvent | Contains the properties for the Form Submission event |
2020

2121
<b>Returns:</b>
2222

2323
PayloadBuilder
2424

25+
PayloadBuilder to be sent to
26+

trackers/node-tracker/docs/markdown/node-tracker.buildlinkclick.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,11 @@ declare function buildLinkClick(event: LinkClickEvent): PayloadBuilder;
1616

1717
| Parameter | Type | Description |
1818
| --- | --- | --- |
19-
| event | LinkClickEvent | Contains the properties for the Link Click event PayloadBuilder to be sent to |
19+
| event | LinkClickEvent | Contains the properties for the Link Click event |
2020

2121
<b>Returns:</b>
2222

2323
PayloadBuilder
2424

25+
PayloadBuilder to be sent to
26+

trackers/node-tracker/docs/markdown/node-tracker.buildpageping.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,11 @@ declare function buildPagePing(event: PagePingEvent): PayloadBuilder;
1616

1717
| Parameter | Type | Description |
1818
| --- | --- | --- |
19-
| event | PagePingEvent | Contains the properties for the Page Ping event PayloadBuilder to be sent to |
19+
| event | PagePingEvent | Contains the properties for the Page Ping event |
2020

2121
<b>Returns:</b>
2222

2323
PayloadBuilder
2424

25+
PayloadBuilder to be sent to
26+

trackers/node-tracker/docs/markdown/node-tracker.buildpageview.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,11 @@ declare function buildPageView(event: PageViewEvent): PayloadBuilder;
1616

1717
| Parameter | Type | Description |
1818
| --- | --- | --- |
19-
| event | PageViewEvent | Contains the properties for the Page View event PayloadBuilder to be sent to |
19+
| event | PageViewEvent | Contains the properties for the Page View event |
2020

2121
<b>Returns:</b>
2222

2323
PayloadBuilder
2424

25+
PayloadBuilder to be sent to
26+

trackers/node-tracker/docs/markdown/node-tracker.buildremovefromcart.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,11 @@ declare function buildRemoveFromCart(event: RemoveFromCartEvent): PayloadBuilder
1616

1717
| Parameter | Type | Description |
1818
| --- | --- | --- |
19-
| event | RemoveFromCartEvent | Contains the properties for the Remove From Cart event PayloadBuilder to be sent to |
19+
| event | RemoveFromCartEvent | Contains the properties for the Remove From Cart event |
2020

2121
<b>Returns:</b>
2222

2323
PayloadBuilder
2424

25+
PayloadBuilder to be sent to
26+

trackers/node-tracker/docs/markdown/node-tracker.buildscreenview.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,11 @@ declare function buildScreenView(event: ScreenViewEvent): PayloadBuilder;
1616

1717
| Parameter | Type | Description |
1818
| --- | --- | --- |
19-
| event | ScreenViewEvent | Contains the properties for the Screen View event. One or more properties must be included. PayloadBuilder to be sent to |
19+
| event | ScreenViewEvent | Contains the properties for the Screen View event. One or more properties must be included. |
2020

2121
<b>Returns:</b>
2222

2323
PayloadBuilder
2424

25+
PayloadBuilder to be sent to
26+

trackers/node-tracker/docs/markdown/node-tracker.buildselfdescribingevent.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,11 @@ declare function buildSelfDescribingEvent(event: SelfDescribingEvent): PayloadBu
1616

1717
| Parameter | Type | Description |
1818
| --- | --- | --- |
19-
| event | SelfDescribingEvent | Contains the properties and schema location for the event PayloadBuilder to be sent to |
19+
| event | SelfDescribingEvent | Contains the properties and schema location for the event |
2020

2121
<b>Returns:</b>
2222

2323
PayloadBuilder
2424

25+
PayloadBuilder to be sent to
26+

trackers/node-tracker/docs/markdown/node-tracker.buildsitesearch.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,11 @@ declare function buildSiteSearch(event: SiteSearchEvent): PayloadBuilder;
1616

1717
| Parameter | Type | Description |
1818
| --- | --- | --- |
19-
| event | SiteSearchEvent | Contains the properties for the Site Search event PayloadBuilder to be sent to |
19+
| event | SiteSearchEvent | Contains the properties for the Site Search event |
2020

2121
<b>Returns:</b>
2222

2323
PayloadBuilder
2424

25+
PayloadBuilder to be sent to
26+

trackers/node-tracker/docs/markdown/node-tracker.buildsocialinteraction.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
## buildSocialInteraction() function
66

7-
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.
7+
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.
88

99
<b>Signature:</b>
1010

@@ -16,9 +16,11 @@ declare function buildSocialInteraction(event: SocialInteractionEvent): PayloadB
1616

1717
| Parameter | Type | Description |
1818
| --- | --- | --- |
19-
| event | SocialInteractionEvent | Contains the properties for the Social Interaction event PayloadBuilder to be sent to |
19+
| event | SocialInteractionEvent | Contains the properties for the Social Interaction event |
2020

2121
<b>Returns:</b>
2222

2323
PayloadBuilder
2424

25+
PayloadBuilder to be sent to
26+

trackers/node-tracker/docs/markdown/node-tracker.buildstructevent.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,11 @@ declare function buildStructEvent(event: StructuredEvent): PayloadBuilder;
1616

1717
| Parameter | Type | Description |
1818
| --- | --- | --- |
19-
| event | StructuredEvent | Contains the properties for the Structured event PayloadBuilder to be sent to |
19+
| event | StructuredEvent | Contains the properties for the Structured event |
2020

2121
<b>Returns:</b>
2222

2323
PayloadBuilder
2424

25+
PayloadBuilder to be sent to
26+

trackers/node-tracker/docs/markdown/node-tracker.coreplugin.activatecoreplugin.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,13 @@
66

77
Called when the plugin is initialised during the trackerCore construction
88

9-
Use to capture the specific core instance for each instance of a core plugin
10-
119
<b>Signature:</b>
1210

1311
```typescript
1412
activateCorePlugin?: (core: TrackerCore) => void;
1513
```
14+
15+
## Remarks
16+
17+
Use to capture the specific core instance for each instance of a core plugin
18+

trackers/node-tracker/docs/markdown/node-tracker.coreplugin.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ interface CorePlugin
1616

1717
| Property | Type | Description |
1818
| --- | --- | --- |
19-
| [activateCorePlugin?](./node-tracker.coreplugin.activatecoreplugin.md) | (core: TrackerCore) =&gt; void | <i>(Optional)</i> Called when the plugin is initialised during the trackerCore construction Use to capture the specific core instance for each instance of a core plugin |
19+
| [activateCorePlugin?](./node-tracker.coreplugin.activatecoreplugin.md) | (core: TrackerCore) =&gt; void | <i>(Optional)</i> Called when the plugin is initialised during the trackerCore construction |
2020
| [afterTrack?](./node-tracker.coreplugin.aftertrack.md) | (payload: Payload) =&gt; void | <i>(Optional)</i> Called just after the trackerCore callback fires |
2121
| [beforeTrack?](./node-tracker.coreplugin.beforetrack.md) | (payloadBuilder: PayloadBuilder) =&gt; void | <i>(Optional)</i> Called just before the trackerCore callback fires |
2222
| [contexts?](./node-tracker.coreplugin.contexts.md) | () =&gt; SelfDescribingJson\[\] | <i>(Optional)</i> Called when constructing the context for each event Useful for adding additional context to events |

0 commit comments

Comments
 (0)