Skip to content

Commit 0ba0b7f

Browse files
committed
docs: enhance session management method documentation in IterableEmbeddedManager
1 parent 1bee2d6 commit 0ba0b7f

File tree

1 file changed

+26
-2
lines changed

1 file changed

+26
-2
lines changed

src/embedded/classes/IterableEmbeddedManager.ts

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,22 +28,46 @@ export class IterableEmbeddedManager {
2828
}
2929

3030
/**
31-
* Starts a session, or a period of time when a user is on a screen or page
32-
* that can display embedded messages.
31+
* Starts a session.
32+
*
33+
* As session is a period of time when a user is on a screen or page that can
34+
* display embedded messages.
35+
*
36+
* When a user comes to a screen or page in your app where embedded messages
37+
* are displayed (in one or more placements), a session should be started.
38+
*
39+
* @example
40+
* ```typescript
41+
* IterableEmbeddedManager.startSession();
42+
* ```
3343
*/
3444
startSession() {
3545
IterableLogger.log('IterableEmbeddedManager.startSession');
3646
}
3747

3848
/**
3949
* Ends a session.
50+
*
51+
* When a user leaves a screen in your app where embedded messages are
52+
* displayed, the session should be ended. This causes the SDK to send
53+
* session and impression data back to the server.
54+
*
55+
* @example
56+
* ```typescript
57+
* IterableEmbeddedManager.endSession();
58+
* ```
4059
*/
4160
endSession() {
4261
IterableLogger.log('IterableEmbeddedManager.endSession');
4362
}
4463

4564
/**
4665
* Tracks an embedded session.
66+
*
67+
* @example
68+
* ```typescript
69+
* IterableEmbeddedManager.trackSession();
70+
* ```
4771
*/
4872
trackSession() {
4973
IterableLogger.log('IterableEmbeddedManager.trackSession');

0 commit comments

Comments
 (0)