-
Notifications
You must be signed in to change notification settings - Fork 182
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update the device.app.lifecycle event description
- Update to manually generated markdown
- Loading branch information
Showing
4 changed files
with
126 additions
and
94 deletions.
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| # Use this changelog template to create an entry for release notes. | ||
| # | ||
| # If your change doesn't affect end users you should instead start | ||
| # your pull request title with [chore] or use the "Skip Changelog" label. | ||
|
|
||
| # One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix' | ||
| change_type: bug_fix | ||
|
|
||
| # The name of the area of concern in the attributes-registry, (e.g. http, cloud, db) | ||
| component: device.app.lifecycle | ||
|
|
||
| # A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). | ||
| note: Reformat and update the `device.app.lifecycle` event description adds constraints for the possible values of the `android.state` and `ios.state`. | ||
|
|
||
| # Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists. | ||
| # The values here must be integers. | ||
| issues: [794] | ||
|
|
||
| # (Optional) One or more lines of additional information to render under the primary note. | ||
| # These lines will be padded with 2 spaces and then inserted directly into the document. | ||
| # Use pipe (|) for multiline entries. | ||
| subtext: |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -7,6 +7,7 @@ | |
| .project | ||
| .settings | ||
| bin | ||
| .vs | ||
|
|
||
| # NetBeans | ||
| /.nb-gradle | ||
|
|
||
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,72 +1,71 @@ | ||
| groups: | ||
| - id: ios.lifecycle.events | ||
| - id: device.app.lifecycle | ||
| type: event | ||
| prefix: ios | ||
| name: device.app.lifecycle | ||
| brief: > | ||
| This event represents an occurrence of a lifecycle transition on the iOS platform. | ||
| attributes: | ||
| - id: state | ||
| requirement_level: "required" | ||
| note: > | ||
| The iOS lifecycle states are defined in the [UIApplicationDelegate documentation](https://developer.apple.com/documentation/uikit/uiapplicationdelegate#1656902), | ||
| and from which the `OS terminology` column values are derived. | ||
| brief: > | ||
| This attribute represents the state the application has transitioned into at the occurrence of the event. | ||
| type: | ||
| allow_custom_values: false | ||
| members: | ||
| - id: active | ||
| value: 'active' | ||
| brief: > | ||
| The app has become `active`. Associated with UIKit notification `applicationDidBecomeActive`. | ||
| - id: inactive | ||
| value: 'inactive' | ||
| brief: > | ||
| The app is now `inactive`. Associated with UIKit notification `applicationWillResignActive`. | ||
| - id: background | ||
| value: 'background' | ||
| brief: > | ||
| The app is now in the background. | ||
| This value is associated with UIKit notification `applicationDidEnterBackground`. | ||
| - id: foreground | ||
| value: 'foreground' | ||
| brief: > | ||
| The app is now in the foreground. | ||
| This value is associated with UIKit notification `applicationWillEnterForeground`. | ||
| - id: terminate | ||
| value: 'terminate' | ||
| brief: > | ||
| The app is about to terminate. Associated with UIKit notification `applicationWillTerminate`. | ||
| - id: android.lifecycle.events | ||
| type: event | ||
| prefix: android | ||
| name: device.app.lifecycle | ||
| brief: > | ||
| This event represents an occurrence of a lifecycle transition on the Android platform. | ||
| attributes: | ||
| - id: state | ||
| requirement_level: required | ||
| brief: > | ||
| This attribute represents the state the application has transitioned into at the occurrence of the event. | ||
| note: > | ||
| The Android lifecycle states are defined in [Activity lifecycle callbacks](https://developer.android.com/guide/components/activities/activity-lifecycle#lc), | ||
| and from which the `OS identifiers` are derived. | ||
| type: | ||
| allow_custom_values: false | ||
| members: | ||
| - id: created | ||
| value: 'created' | ||
| brief: > | ||
| Any time before Activity.onResume() or, if the app has no Activity, Context.startService() | ||
| has been called in the app for the first time. | ||
| - id: background | ||
| value: 'background' | ||
| brief: > | ||
| Any time after Activity.onPause() or, if the app has no Activity, | ||
| Context.stopService() has been called when the app was in the foreground state. | ||
| - id: foreground | ||
| value: 'foreground' | ||
| brief: > | ||
| Any time after Activity.onResume() or, if the app has no Activity, | ||
| Context.startService() has been called when the app was in either the created or background states. | ||
| This event represents an occurrence of a lifecycle transition on Android or iOS platform. | ||
| note: > | ||
| This events identifies the fields that are common to all lifecycle events for android and iOS using | ||
| the `android.state` and `ios.state` attributes. The `android.state` and `ios.state` attributes are | ||
| mutually exclusive. | ||
| # body: | ||
| # fields: | ||
| # - id: ios.state | ||
| # note: > | ||
| # The iOS lifecycle states are defined in the [UIApplicationDelegate documentation](https://developer.apple.com/documentation/uikit/uiapplicationdelegate#1656902), | ||
| # and from which the `OS terminology` column values are derived. | ||
| # brief: > | ||
| # This attribute represents the state the application has transitioned into at the occurrence of the event. | ||
| # type: | ||
| # allow_custom_values: false | ||
| # members: | ||
| # - id: active | ||
| # value: 'active' | ||
| # brief: > | ||
| # The app has become `active`. Associated with UIKit notification `applicationDidBecomeActive`. | ||
| # - id: inactive | ||
| # value: 'inactive' | ||
| # brief: > | ||
| # The app is now `inactive`. Associated with UIKit notification `applicationWillResignActive`. | ||
| # - id: background | ||
| # value: 'background' | ||
| # brief: > | ||
| # The app is now in the background. | ||
| # This value is associated with UIKit notification `applicationDidEnterBackground`. | ||
| # - id: foreground | ||
| # value: 'foreground' | ||
| # brief: > | ||
| # The app is now in the foreground. | ||
| # This value is associated with UIKit notification `applicationWillEnterForeground`. | ||
| # - id: terminate | ||
| # value: 'terminate' | ||
| # brief: > | ||
| # The app is about to terminate. Associated with UIKit notification `applicationWillTerminate`. | ||
| # - id: android.state | ||
| # brief: > | ||
| # This attribute represents the state the application has transitioned into at the occurrence of the event. | ||
| # note: > | ||
| # The Android lifecycle states are defined in [Activity lifecycle callbacks](https://developer.android.com/guide/components/activities/activity-lifecycle#lc), | ||
| # and from which the `OS identifiers` are derived. | ||
| # type: | ||
| # allow_custom_values: false | ||
| # members: | ||
| # - id: created | ||
| # value: 'created' | ||
| # brief: > | ||
| # Any time before Activity.onResume() or, if the app has no Activity, Context.startService() | ||
| # has been called in the app for the first time. | ||
| # - id: background | ||
| # value: 'background' | ||
| # brief: > | ||
| # Any time after Activity.onPause() or, if the app has no Activity, | ||
| # Context.stopService() has been called when the app was in the foreground state. | ||
| # - id: foreground | ||
| # value: 'foreground' | ||
| # brief: > | ||
| # Any time after Activity.onResume() or, if the app has no Activity, | ||
| # Context.startService() has been called when the app was in either the created or background states. | ||
| # constraints: | ||
| # - any_of: | ||
| # - "ios.state" | ||
| # - "android.state" |