Skip to content

Commit

Permalink
Update wording for Lifecycle sessionTimeout configuration (#457)
Browse files Browse the repository at this point in the history
* Update wording for Lifecycle sessionTimeout config.
Update wording of Lifecycle sessionTimeout configuration to state the timeout is applied from when the application is sent to the background to the next application launch. The current wording implies the timeout is applied from the current session start to the next launch, which is not corret.

* Change wording for clarity.

* Workaround build failue, set sharp version 0.33.0
  • Loading branch information
kevinlind authored Dec 14, 2023
1 parent 601032f commit d7fe8f7
Show file tree
Hide file tree
Showing 4 changed files with 280 additions and 191 deletions.
4 changes: 4 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@
"react": "^18.2.0",
"react-dom": "^17.0.2"
},
"resolutions": {
"sharp": "0.33.0",
"gatsby-sharp": "1.12.0"
},
"scripts": {
"start": "gatsby build && gatsby serve",
"start:prefix": "gatsby build --prefix-paths && gatsby serve --prefix-paths",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ keywords:

This configuration setting is only used in the Analytics use case, when using the [Lifecycle data content response](./event-reference.md#lifecycle-data-content-response) event to determine session length. <br/><br/> In the Platform use case, events are dispatched based on [Lifecycle Application Foreground](./event-reference.md#lifecycle-application-foreground) and [Lifecycle Application Background](./event-reference.md#lifecycle-application-background) and not on a set session timeout.

Specifies the length of time, in seconds, that must elapse between the time the app is launched and before the launch is considered to be a new session. This timeout also applies when your application is sent to the background and reactivated.
Number of seconds that must elapse between the app entering the background and subsequently re-entering the foreground in order for the SDK to create a new session.

The default value is 300 seconds (5 minutes).

Expand Down
2 changes: 1 addition & 1 deletion src/pages/home/base/mobile-core/lifecycle/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,4 +120,4 @@ The time that your app spends in the background is not included in the session l

| Key | Description |
| :--- | :-------- |
| `lifecycle.sessionTimeout` | Time, in seconds, that must elapse between the time the app is launched and before the launch is considered to be a new session. This timeout also applies when your application is sent to the background and reactivated.<br/><br/> The default value is 300 seconds (5 minutes). |
| `lifecycle.sessionTimeout` | Number of seconds that must elapse between the app entering the background and subsequently re-entering the foreground in order for the SDK to create a new session.<br/><br/> The default value is 300 seconds (5 minutes). |
Loading

0 comments on commit d7fe8f7

Please sign in to comment.