diff --git a/model/device/events.yaml b/model/device/events.yaml index dbf3abceeb..6b980e0334 100644 --- a/model/device/events.yaml +++ b/model/device/events.yaml @@ -9,66 +9,69 @@ groups: This event identifies the fields that are common to all lifecycle events for android and iOS using the `android.state` and `ios.state` fields. The `android.state` and `ios.state` attributes are mutually exclusive. - # Future Note: When the build tools support this definition please uncomment and validate the details - # included here and what has been added to the manual markdown table - # body: - # fields: - # - id: ios.state - # stability: experimental - # requirement_level: - # conditional_required: if and only if `os.name` is `ios` - # 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: - # 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 - # stability: experimental - # requirement_level: - # conditional_required: if and only if `os.name` is `android` - # 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: - # 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. + body: + id: device_lifecycle_state + type: map + requirement_level: required + fields: + - id: ios.state + stability: experimental + requirement_level: + conditionally_required: if and only if `os.name` is `ios` + 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. + examples: ["active"] + type: enum + 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 + stability: experimental + requirement_level: + conditionally_required: if and only if `os.name` is `android` + 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. + examples: ["created"] + type: enum + 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.