Skip to content

Commit 899cf16

Browse files
github-actions[bot]github-actions[bot]
committed
Applying documentation updates.
1 parent 53d8497 commit 899cf16

14 files changed

+162
-0
lines changed

‎trackers/browser-tracker/docs/markdown/browser-tracker.clientsession.eventindex.md‎

Lines changed: 13 additions & 0 deletions
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; [ClientSession](./browser-tracker.clientsession.md) &gt; [eventIndex](./browser-tracker.clientsession.eventindex.md)
4+
5+
## ClientSession.eventIndex property
6+
7+
Index of the current event in the session
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
eventIndex: number;
13+
```

‎trackers/browser-tracker/docs/markdown/browser-tracker.clientsession.firsteventid.md‎

Lines changed: 13 additions & 0 deletions
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; [ClientSession](./browser-tracker.clientsession.md) &gt; [firstEventId](./browser-tracker.clientsession.firsteventid.md)
4+
5+
## ClientSession.firstEventId property
6+
7+
Identifier of the first event for this session
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
firstEventId: string | null;
13+
```

‎trackers/browser-tracker/docs/markdown/browser-tracker.clientsession.firsteventtimestamp.md‎

Lines changed: 13 additions & 0 deletions
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; [ClientSession](./browser-tracker.clientsession.md) &gt; [firstEventTimestamp](./browser-tracker.clientsession.firsteventtimestamp.md)
4+
5+
## ClientSession.firstEventTimestamp property
6+
7+
Date-time timestamp of when the first event in the session was tracked
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
firstEventTimestamp: string | null;
13+
```

‎trackers/browser-tracker/docs/markdown/browser-tracker.clientsession.md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
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; [ClientSession](./browser-tracker.clientsession.md)
4+
5+
## ClientSession interface
6+
7+
Schema for client client session context entity
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
interface ClientSession extends Record<string, unknown>
13+
```
14+
<b>Extends:</b> Record&lt;string, unknown&gt;
15+
16+
## Properties
17+
18+
| Property | Type | Description |
19+
| --- | --- | --- |
20+
| [eventIndex](./browser-tracker.clientsession.eventindex.md) | number | Index of the current event in the session |
21+
| [firstEventId](./browser-tracker.clientsession.firsteventid.md) | string \| null | Identifier of the first event for this session |
22+
| [firstEventTimestamp](./browser-tracker.clientsession.firsteventtimestamp.md) | string \| null | Date-time timestamp of when the first event in the session was tracked |
23+
| [previousSessionId](./browser-tracker.clientsession.previoussessionid.md) | string \| null | The previous session identifier for this user |
24+
| [sessionId](./browser-tracker.clientsession.sessionid.md) | string | An identifier for the session (same as domain\_sessionid) |
25+
| [sessionIndex](./browser-tracker.clientsession.sessionindex.md) | number | The index of the current session for this user (same as domain\_sessionidx) |
26+
| [storageMechanism](./browser-tracker.clientsession.storagemechanism.md) | string | The mechanism that the session information has been stored on the device |
27+
| [userId](./browser-tracker.clientsession.userid.md) | string | An identifier for the user of the session (same as domain\_userid) |
28+

‎trackers/browser-tracker/docs/markdown/browser-tracker.clientsession.previoussessionid.md‎

Lines changed: 13 additions & 0 deletions
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; [ClientSession](./browser-tracker.clientsession.md) &gt; [previousSessionId](./browser-tracker.clientsession.previoussessionid.md)
4+
5+
## ClientSession.previousSessionId property
6+
7+
The previous session identifier for this user
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
previousSessionId: string | null;
13+
```

‎trackers/browser-tracker/docs/markdown/browser-tracker.clientsession.sessionid.md‎

Lines changed: 13 additions & 0 deletions
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; [ClientSession](./browser-tracker.clientsession.md) &gt; [sessionId](./browser-tracker.clientsession.sessionid.md)
4+
5+
## ClientSession.sessionId property
6+
7+
An identifier for the session (same as domain\_sessionid)
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
sessionId: string;
13+
```

‎trackers/browser-tracker/docs/markdown/browser-tracker.clientsession.sessionindex.md‎

Lines changed: 13 additions & 0 deletions
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; [ClientSession](./browser-tracker.clientsession.md) &gt; [sessionIndex](./browser-tracker.clientsession.sessionindex.md)
4+
5+
## ClientSession.sessionIndex property
6+
7+
The index of the current session for this user (same as domain\_sessionidx)
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
sessionIndex: number;
13+
```

‎trackers/browser-tracker/docs/markdown/browser-tracker.clientsession.storagemechanism.md‎

Lines changed: 13 additions & 0 deletions
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; [ClientSession](./browser-tracker.clientsession.md) &gt; [storageMechanism](./browser-tracker.clientsession.storagemechanism.md)
4+
5+
## ClientSession.storageMechanism property
6+
7+
The mechanism that the session information has been stored on the device
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
storageMechanism: string;
13+
```

‎trackers/browser-tracker/docs/markdown/browser-tracker.clientsession.userid.md‎

Lines changed: 13 additions & 0 deletions
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; [ClientSession](./browser-tracker.clientsession.md) &gt; [userId](./browser-tracker.clientsession.userid.md)
4+
5+
## ClientSession.userId property
6+
7+
An identifier for the user of the session (same as domain\_userid)
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
userId: string;
13+
```

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@
5252
| [BrowserPluginConfiguration](./browser-tracker.browserpluginconfiguration.md) | The configuration of the plugin to add |
5353
| [BrowserTracker](./browser-tracker.browsertracker.md) | The Browser Tracker |
5454
| [ClearUserDataConfiguration](./browser-tracker.clearuserdataconfiguration.md) | The configuration that can be changed when enabling anonymous tracking |
55+
| [ClientSession](./browser-tracker.clientsession.md) | Schema for client client session context entity |
5556
| [CommonEventProperties](./browser-tracker.commoneventproperties.md) | Additional data points to set when tracking an event |
5657
| [ContextEvent](./browser-tracker.contextevent.md) | Argument for [ContextGenerator](./browser-tracker.contextgenerator.md) and [ContextFilter](./browser-tracker.contextfilter.md) callback |
5758
| [DisableAnonymousTrackingConfiguration](./browser-tracker.disableanonymoustrackingconfiguration.md) | The configuration that can be changed when disabling anonymous tracking |

0 commit comments

Comments
 (0)