You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+10-5
Original file line number
Diff line number
Diff line change
@@ -5,9 +5,11 @@
5
5
6
6
# react-native-device-activity
7
7
8
-
Provides access to Apples DeviceActivity API. It does require a Custom Dev Client to work with Expo.
8
+
Provides direct access to Apples Screen Time, Device Activity and Shielding APIs.
9
9
10
-
Please note that it only supports iOS (and requires iOS 15 or higher). For Android I'd probably look into [UsageStats](https://developer.android.com/reference/android/app/usage/UsageStats), which seems provide more granularity.
10
+
⚠️ Before planning and starting using these APIs it is highly recommended to familiarize yourself with the [special approval and entitlements required](https://github.com/Kingstinct/react-native-device-activity#family-controls-distribution-entitlement-requires-approval-from-apple).
11
+
12
+
Please note that it only supports iOS (and requires iOS 15 or higher) and requires a Custom Dev Client to work with Expo. For Android I'd probably look into [UsageStats](https://developer.android.com/reference/android/app/usage/UsageStats), which seems provide more granularity.
For [managed](https://docs.expo.dev/archive/managed-vs-bare/) Expo projects, please follow the installation instructions in the [API documentation for the latest stable release](#api-documentation). If you follow the link and there is no documentation available then this library is not yet usable within managed projects — it is likely to be included in an upcoming Expo SDK release.
80
82
81
83
The package requires native code, which includes a custom app target. Currently it requires targeting iOS 15 or higher, so populate app.json/app.config.json as follows:
84
+
82
85
```
83
86
"plugins": [
84
87
[
@@ -97,7 +100,7 @@ The package requires native code, which includes a custom app target. Currently
97
100
}
98
101
]
99
102
],
100
-
```
103
+
```
101
104
102
105
The Swift files for the iOS target will be copied to your local `/targets` directory. You might want to add it to your .gitignore (or if you have other targets in there, you might want to specifically add the three targets added by this library).
Run `npx pod-install` after installing the npm package.
123
126
124
127
## Family Controls (distribution) entitlement requires approval from Apple
128
+
125
129
As early as possible you want to [request approval from Apple](https://developer.apple.com/contact/request/family-controls-distribution), since it can take time to get approved.
126
130
127
131
Note that until you have approval for all bundleIdentifiers you want to use, you are stuck with local development builds in XCode. I.e. you can't even build an Expo Dev Client.
128
132
129
133
For every base bundleIdentifier you need approval for 4 bundleIdentifiers:
134
+
130
135
- com.your-bundleIdentifier
131
136
- com.your-bundleIdentifier.ActivityMonitor
132
137
- com.your-bundleIdentifier.ShieldAction
@@ -137,11 +142,11 @@ Once you've gotten approval you need to manually add the "Family Controls (Distr
137
142
⚠️ If you don't do all the above you will run in to a lot of strange provisioning errors.
138
143
139
144
## Limitations and weird/notable things
145
+
140
146
- The DeviceActivitySelectionView is prone to crashes, which is outside of our control. The best we can do is provide fallback views that allows the user to know what's happening and reload the view.
141
147
- If you've asked about the authorization status once and the user after that revokes it outside the app, the native APIs won't reflect this until the app is restarted.
142
148
- requestAuthorization() can be called multiple times, even when the user has already denied permission.
143
149
144
-
145
150
# Contributing
146
151
147
-
Contributions are very welcome! Please refer to guidelines described in the [contributing guide](https://github.com/expo/expo#contributing).
152
+
Contributions are very welcome! Please refer to guidelines described in the [contributing guide](https://github.com/expo/expo#contributing).
0 commit comments