Skip to content

Commit d170327

Browse files
Applying documentation updates.
1 parent cebce74 commit d170327

4 files changed

+18
-2
lines changed

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,5 @@ Get the current page view ID
99
<b>Signature:</b>
1010

1111
```typescript
12-
getPageViewId: () => void;
12+
getPageViewId: () => string;
1313
```
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; [getTabId](./browser-tracker.browsertracker.gettabid.md)
4+
5+
## BrowserTracker.getTabId property
6+
7+
Get the current browser tab ID
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
getTabId: () => string | null;
13+
```

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

+2-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,8 @@ interface BrowserTracker
3131
| [getDomainSessionIndex](./browser-tracker.browsertracker.getdomainsessionindex.md) | () =&gt; void | Get the domain session index also known as current memorized visit count. |
3232
| [getDomainUserId](./browser-tracker.browsertracker.getdomainuserid.md) | () =&gt; void | Get visitor ID (from first party cookie) |
3333
| [getDomainUserInfo](./browser-tracker.browsertracker.getdomainuserinfo.md) | () =&gt; void | Get the visitor information (from first party cookie) |
34-
| [getPageViewId](./browser-tracker.browsertracker.getpageviewid.md) | () =&gt; void | Get the current page view ID |
34+
| [getPageViewId](./browser-tracker.browsertracker.getpageviewid.md) | () =&gt; string | Get the current page view ID |
35+
| [getTabId](./browser-tracker.browsertracker.gettabid.md) | () =&gt; string \| null | Get the current browser tab ID |
3536
| [getUserId](./browser-tracker.browsertracker.getuserid.md) | () =&gt; void | Get the current user ID (as set previously with setUserId()). |
3637
| [id](./browser-tracker.browsertracker.id.md) | string | The unique identifier of this tracker |
3738
| [namespace](./browser-tracker.browsertracker.namespace.md) | string | The tracker namespace |

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

+2
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,7 @@ type BuiltInContexts = RequireAtLeastOne<{
1212
webPage: boolean;
1313
/* Toggles the session context */
1414
session: boolean;
15+
/* Toggles the browser context */
16+
browser: boolean;
1517
}> | Record<string, never>;
1618
```

0 commit comments

Comments
 (0)