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 Mar 8, 2024
1 parent b7e0f9b commit 8715335
Show file tree
Hide file tree
Showing 8 changed files with 36 additions and 10 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ Get the cookie name as cookieNamePrefix + basename + . + domain.
<b>Signature:</b>

```typescript
getCookieName: (basename: string) => void;
getCookieName: (basename: string) => string;
```
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ Get the domain session index also known as current memorized visit count.
<b>Signature:</b>

```typescript
getDomainSessionIndex: () => void;
getDomainSessionIndex: () => number;
```
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ Get visitor ID (from first party cookie)
<b>Signature:</b>

```typescript
getDomainUserId: () => void;
getDomainUserId: () => string;
```
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ Get the visitor information (from first party cookie)
<b>Signature:</b>

```typescript
getDomainUserInfo: () => void;
getDomainUserInfo: () => ParsedIdCookie;
```
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ Get the current user ID (as set previously with setUserId()).
<b>Signature:</b>

```typescript
getUserId: () => void;
getUserId: () => string | null | undefined;
```
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,13 @@ interface BrowserTracker
| [enableActivityTrackingCallback](./browser-tracker.browsertracker.enableactivitytrackingcallback.md) | (configuration: ActivityTrackingConfiguration &amp; ActivityTrackingConfigurationCallback) =&gt; void | Enables page activity tracking (replaces collector ping with callback). |
| [enableAnonymousTracking](./browser-tracker.browsertracker.enableanonymoustracking.md) | (configuration?: EnableAnonymousTrackingConfiguration) =&gt; void | Enables anonymous tracking (ie. tracker initialized without <code>anonymousTracking</code>) |
| [flushBuffer](./browser-tracker.browsertracker.flushbuffer.md) | (configuration?: FlushBufferConfiguration) =&gt; void | Send all events in the outQueue Only need to use this when sending events with a bufferSize of at least 2 |
| [getCookieName](./browser-tracker.browsertracker.getcookiename.md) | (basename: string) =&gt; void | Get the cookie name as cookieNamePrefix + basename + . + domain. |
| [getDomainSessionIndex](./browser-tracker.browsertracker.getdomainsessionindex.md) | () =&gt; void | Get the domain session index also known as current memorized visit count. |
| [getDomainUserId](./browser-tracker.browsertracker.getdomainuserid.md) | () =&gt; void | Get visitor ID (from first party cookie) |
| [getDomainUserInfo](./browser-tracker.browsertracker.getdomainuserinfo.md) | () =&gt; void | Get the visitor information (from first party cookie) |
| [getCookieName](./browser-tracker.browsertracker.getcookiename.md) | (basename: string) =&gt; string | Get the cookie name as cookieNamePrefix + basename + . + domain. |
| [getDomainSessionIndex](./browser-tracker.browsertracker.getdomainsessionindex.md) | () =&gt; number | Get the domain session index also known as current memorized visit count. |
| [getDomainUserId](./browser-tracker.browsertracker.getdomainuserid.md) | () =&gt; string | Get visitor ID (from first party cookie) |
| [getDomainUserInfo](./browser-tracker.browsertracker.getdomainuserinfo.md) | () =&gt; ParsedIdCookie | Get the visitor information (from first party cookie) |
| [getPageViewId](./browser-tracker.browsertracker.getpageviewid.md) | () =&gt; string | Get the current page view ID |
| [getTabId](./browser-tracker.browsertracker.gettabid.md) | () =&gt; string \| null | Get the current browser tab ID |
| [getUserId](./browser-tracker.browsertracker.getuserid.md) | () =&gt; void | Get the current user ID (as set previously with setUserId()). |
| [getUserId](./browser-tracker.browsertracker.getuserid.md) | () =&gt; string \| null \| undefined | Get the current user ID (as set previously with setUserId()). |
| [id](./browser-tracker.browsertracker.id.md) | string | The unique identifier of this tracker |
| [namespace](./browser-tracker.browsertracker.namespace.md) | string | The tracker namespace |
| [newSession](./browser-tracker.browsertracker.newsession.md) | () =&gt; void | Expires current session and starts a new session. |
Expand Down
1 change: 1 addition & 0 deletions api-docs/docs/browser-tracker/markdown/browser-tracker.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,7 @@
| [ExtendedCrossDomainLinkerOptions](./browser-tracker.extendedcrossdomainlinkeroptions.md) | |
| [FilterProvider](./browser-tracker.filterprovider.md) | A filter provider is a tuple that has two parts: a context filter and the context primitive(s) If the context filter evaluates to true, the tracker will attach the context primitive(s) |
| [GetBatch](./browser-tracker.getbatch.md) | A collection of GET events which are sent to the collector. This will be a collection of query strings. |
| [ParsedIdCookie](./browser-tracker.parsedidcookie.md) | The format of state elements stored in the <code>id</code> cookie. |
| [Platform](./browser-tracker.platform.md) | |
| [PostBatch](./browser-tracker.postbatch.md) | A collection of POST events which are sent to the collector. This will be a collection of JSON objects. |
| [RequestFailure](./browser-tracker.requestfailure.md) | The data that will be available to the <code>onRequestFailure</code> callback |
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [ParsedIdCookie](./browser-tracker.parsedidcookie.md)

## ParsedIdCookie type

The format of state elements stored in the `id` cookie.

<b>Signature:</b>

```typescript
type ParsedIdCookie = [
cookieDisabled: string,
domainUserId: string,
cookieCreateTs: number,
visitCount: number,
nowTs: number,
lastVisitTs: number | undefined,
sessionId: string,
previousSessionId: string,
firstEventId: string,
firstEventTs: number | undefined,
eventIndex: number
];
```

0 comments on commit 8715335

Please sign in to comment.