Update wording for Lifecycle sessionTimeout configuration #457
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
kevinlind
requested review from
calebk1,
sbenedicadb,
cdhoffmann and
emdobrin
sbenedicadb
reviewed
Nov 28, 2023
| @@ -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. | |||
| Specifies the length of time, in seconds, that must elapse between the time the app is sent to the background and before the next launch is considered to be a new session. | |||
There was a problem hiding this comment.
new wording isn't quite flowing for me - it's a lot to try and communicate in one sentence 😄
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.
?
sbenedicadb
approved these changes
Dec 14, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
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 correct.
Related Issue
Motivation and Context
How Has This Been Tested?
Screenshots (if appropriate):
Types of changes
Checklist: