From 8715335000221b25d1c387f2f903b171fc8d3cfc Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 8 Mar 2024 08:16:29 +0000 Subject: [PATCH] Applying documentation updates. --- ...er-tracker.browsertracker.getcookiename.md | 2 +- ...er.browsertracker.getdomainsessionindex.md | 2 +- ...-tracker.browsertracker.getdomainuserid.md | 2 +- ...racker.browsertracker.getdomainuserinfo.md | 2 +- ...rowser-tracker.browsertracker.getuserid.md | 2 +- .../browser-tracker.browsertracker.md | 10 ++++---- .../markdown/browser-tracker.md | 1 + .../browser-tracker.parsedidcookie.md | 25 +++++++++++++++++++ 8 files changed, 36 insertions(+), 10 deletions(-) create mode 100644 api-docs/docs/browser-tracker/markdown/browser-tracker.parsedidcookie.md diff --git a/api-docs/docs/browser-tracker/markdown/browser-tracker.browsertracker.getcookiename.md b/api-docs/docs/browser-tracker/markdown/browser-tracker.browsertracker.getcookiename.md index b0336fc04..a7fc42852 100644 --- a/api-docs/docs/browser-tracker/markdown/browser-tracker.browsertracker.getcookiename.md +++ b/api-docs/docs/browser-tracker/markdown/browser-tracker.browsertracker.getcookiename.md @@ -9,5 +9,5 @@ Get the cookie name as cookieNamePrefix + basename + . + domain. Signature: ```typescript -getCookieName: (basename: string) => void; +getCookieName: (basename: string) => string; ``` diff --git a/api-docs/docs/browser-tracker/markdown/browser-tracker.browsertracker.getdomainsessionindex.md b/api-docs/docs/browser-tracker/markdown/browser-tracker.browsertracker.getdomainsessionindex.md index 4afdaae42..da89d162b 100644 --- a/api-docs/docs/browser-tracker/markdown/browser-tracker.browsertracker.getdomainsessionindex.md +++ b/api-docs/docs/browser-tracker/markdown/browser-tracker.browsertracker.getdomainsessionindex.md @@ -9,5 +9,5 @@ Get the domain session index also known as current memorized visit count. Signature: ```typescript -getDomainSessionIndex: () => void; +getDomainSessionIndex: () => number; ``` diff --git a/api-docs/docs/browser-tracker/markdown/browser-tracker.browsertracker.getdomainuserid.md b/api-docs/docs/browser-tracker/markdown/browser-tracker.browsertracker.getdomainuserid.md index bf289ede0..e5f63239f 100644 --- a/api-docs/docs/browser-tracker/markdown/browser-tracker.browsertracker.getdomainuserid.md +++ b/api-docs/docs/browser-tracker/markdown/browser-tracker.browsertracker.getdomainuserid.md @@ -9,5 +9,5 @@ Get visitor ID (from first party cookie) Signature: ```typescript -getDomainUserId: () => void; +getDomainUserId: () => string; ``` diff --git a/api-docs/docs/browser-tracker/markdown/browser-tracker.browsertracker.getdomainuserinfo.md b/api-docs/docs/browser-tracker/markdown/browser-tracker.browsertracker.getdomainuserinfo.md index a18733008..2b2830b3a 100644 --- a/api-docs/docs/browser-tracker/markdown/browser-tracker.browsertracker.getdomainuserinfo.md +++ b/api-docs/docs/browser-tracker/markdown/browser-tracker.browsertracker.getdomainuserinfo.md @@ -9,5 +9,5 @@ Get the visitor information (from first party cookie) Signature: ```typescript -getDomainUserInfo: () => void; +getDomainUserInfo: () => ParsedIdCookie; ``` diff --git a/api-docs/docs/browser-tracker/markdown/browser-tracker.browsertracker.getuserid.md b/api-docs/docs/browser-tracker/markdown/browser-tracker.browsertracker.getuserid.md index 7a32e09d6..768528327 100644 --- a/api-docs/docs/browser-tracker/markdown/browser-tracker.browsertracker.getuserid.md +++ b/api-docs/docs/browser-tracker/markdown/browser-tracker.browsertracker.getuserid.md @@ -9,5 +9,5 @@ Get the current user ID (as set previously with setUserId()). Signature: ```typescript -getUserId: () => void; +getUserId: () => string | null | undefined; ``` diff --git a/api-docs/docs/browser-tracker/markdown/browser-tracker.browsertracker.md b/api-docs/docs/browser-tracker/markdown/browser-tracker.browsertracker.md index abbf32f60..84a94454c 100644 --- a/api-docs/docs/browser-tracker/markdown/browser-tracker.browsertracker.md +++ b/api-docs/docs/browser-tracker/markdown/browser-tracker.browsertracker.md @@ -29,13 +29,13 @@ interface BrowserTracker | [enableActivityTrackingCallback](./browser-tracker.browsertracker.enableactivitytrackingcallback.md) | (configuration: ActivityTrackingConfiguration & ActivityTrackingConfigurationCallback) => void | Enables page activity tracking (replaces collector ping with callback). | | [enableAnonymousTracking](./browser-tracker.browsertracker.enableanonymoustracking.md) | (configuration?: EnableAnonymousTrackingConfiguration) => void | Enables anonymous tracking (ie. tracker initialized without anonymousTracking) | | [flushBuffer](./browser-tracker.browsertracker.flushbuffer.md) | (configuration?: FlushBufferConfiguration) => 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) => void | Get the cookie name as cookieNamePrefix + basename + . + domain. | -| [getDomainSessionIndex](./browser-tracker.browsertracker.getdomainsessionindex.md) | () => void | Get the domain session index also known as current memorized visit count. | -| [getDomainUserId](./browser-tracker.browsertracker.getdomainuserid.md) | () => void | Get visitor ID (from first party cookie) | -| [getDomainUserInfo](./browser-tracker.browsertracker.getdomainuserinfo.md) | () => void | Get the visitor information (from first party cookie) | +| [getCookieName](./browser-tracker.browsertracker.getcookiename.md) | (basename: string) => string | Get the cookie name as cookieNamePrefix + basename + . + domain. | +| [getDomainSessionIndex](./browser-tracker.browsertracker.getdomainsessionindex.md) | () => number | Get the domain session index also known as current memorized visit count. | +| [getDomainUserId](./browser-tracker.browsertracker.getdomainuserid.md) | () => string | Get visitor ID (from first party cookie) | +| [getDomainUserInfo](./browser-tracker.browsertracker.getdomainuserinfo.md) | () => ParsedIdCookie | Get the visitor information (from first party cookie) | | [getPageViewId](./browser-tracker.browsertracker.getpageviewid.md) | () => string | Get the current page view ID | | [getTabId](./browser-tracker.browsertracker.gettabid.md) | () => string \| null | Get the current browser tab ID | -| [getUserId](./browser-tracker.browsertracker.getuserid.md) | () => void | Get the current user ID (as set previously with setUserId()). | +| [getUserId](./browser-tracker.browsertracker.getuserid.md) | () => 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) | () => void | Expires current session and starts a new session. | diff --git a/api-docs/docs/browser-tracker/markdown/browser-tracker.md b/api-docs/docs/browser-tracker/markdown/browser-tracker.md index 85850d638..ef4d923a7 100644 --- a/api-docs/docs/browser-tracker/markdown/browser-tracker.md +++ b/api-docs/docs/browser-tracker/markdown/browser-tracker.md @@ -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 id 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 onRequestFailure callback | diff --git a/api-docs/docs/browser-tracker/markdown/browser-tracker.parsedidcookie.md b/api-docs/docs/browser-tracker/markdown/browser-tracker.parsedidcookie.md new file mode 100644 index 000000000..b3db25344 --- /dev/null +++ b/api-docs/docs/browser-tracker/markdown/browser-tracker.parsedidcookie.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [ParsedIdCookie](./browser-tracker.parsedidcookie.md) + +## ParsedIdCookie type + +The format of state elements stored in the `id` cookie. + +Signature: + +```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 +]; +```