-
Notifications
You must be signed in to change notification settings - Fork 40
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Create behavior reference for Lifecycle for Edge Network extension #649
Create behavior reference for Lifecycle for Edge Network extension #649
Conversation
class E incorrectBox; | ||
--> | ||
|
||
## Expected Lifecycle scenarios |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd suggest to swap the ordering of this section with the previous "Consecutive Lifecycle API Calls" so the expected scenarios are listed first.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you! I think that organization makes more sense - swapped their positions
|
||
This scenario shows the standard Lifecycle workflow, with expected Lifecycle API calls. | ||
|
||
![](./assets/index/lifecycle-app-launch-and-close.svg) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In this image lifecycle-app-launch-and-close.svg
, can you include "(Close type close)" under "Application Close (Background)", similar to how you have "(Close type unknown)" in the lifecycle-crash.svg
image?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated! I also added a colon to help emphasize that close
and unknown
are values of Close type
|
||
As a consequence of this shift in not relying on a session timeout window to consider new sessions, the potential Lifecycle states are greatly simplified: | ||
|
||
### Consecutive Lifecycle API calls |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The heading size here is confusing.
Is Consecutive Lifecycle API calls under General behavior?
Why it is
"##"
"####"
"###"?
For
"As a consequence of this shift in not relying on a session timeout window to consider new sessions, the potential Lifecycle states are greatly simplified:"
Is it part of Data payloads? I can't tell by reading with the headings.
I wonder if there is a way to identify between the lifecycleStart or Pause was dispatched by result of an API and the lifecycleStart or Pause was dispatched by SDK due to other reasons. (may be different text color?) |
Add additional context for some diagrams
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the reviews @cacheung and @kevinlind! Updated based on feedback - hopefully the organization and diagrams are more clear
class E incorrectBox; | ||
--> | ||
|
||
## Expected Lifecycle scenarios |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you! I think that organization makes more sense - swapped their positions
|
||
This scenario shows the standard Lifecycle workflow, with expected Lifecycle API calls. | ||
|
||
![](./assets/index/lifecycle-app-launch-and-close.svg) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated! I also added a colon to help emphasize that close
and unknown
are values of Close type
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
Description
This PR creates a new Lifecycle for Edge Network reference doc that explains in depth the different lifecycle event flows and pitfalls commonly seen when implementing Lifecycle for Edge Network.
It is similar to the Lifecycle behavior reference created in #568, but for Lifecycle for Edge Network's specific behavior.
Related Issue
Motivation and Context
How Has This Been Tested?
Screenshots (if appropriate):
Types of changes
Checklist: