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
Merge pull request #64 from TelemetryDeck/feat/remove-dependency-on-application
[BREAKING] The pre-Grand Rename APIs have been removed from the library.
[BREAKING] The Kotlin SDK now expects to be started with just a Context (the applicationContext).
[BREAKING] TelemetryDeckProvider interface has changed to accept a Context instead of Application - providers may still retain a weak reference, so this should be the applicationContext.
@@ -302,7 +302,8 @@ You can also completely disable or override the default providers with your own.
302
302
-`SessionActivityProvider` - Emits signals for application and activity lifecycle events. This provider is not enabled by default.
303
303
-`EnvironmentParameterProvider` - Adds environment and device information to outgoing Signals. This provider overrides the `enrich` method in order to append additional metadata for all signals before sending them.
304
304
-`PlatformContextProvider` - Adds environment and device information which may change over time like the current timezone and screen metrics.
305
-
305
+
-`AccessibilityProvider` - Adds parameters describing the currently active accessibility options.
306
+
-
306
307
For a complete list, check the `com.telemetrydeck.sdk.providers` package.
307
308
308
309
```kotlin
@@ -339,6 +340,12 @@ Please note that the logger implementation should be thread safe as it may be in
339
340
- Gradle 6.8.3–8.8\*
340
341
- AGP 7.1.3–8.5
341
342
343
+
## Migrating providers to 5.0+
344
+
345
+
* The provider interface `TelemetryDeckProvider` has changed to accept a `Context` instance instead of an `Application`.
346
+
* The deprecated fallback provider callbacks are no longer used and the functionality has been removed.
347
+
* Providers can now optionally override the `transform` method in order to modify any component of the signal.
348
+
342
349
## Migrating providers to 3.0+
343
350
344
351
If you had Kotlin SDK for TelemetryDeck added to your app, you will notice that `TelemetryManager` and related classes have been deprecated.
@@ -391,7 +398,7 @@ Your custom providers must replace `TelemetryProvider` with `TelemetryDeckProvid
391
398
392
399
To adopt the new interface:
393
400
394
-
- Adapt the signature of the `register` method to `register(ctx: Application?, client: TelemetryDeckSignalProcessor)`
401
+
- Adapt the signature of the `register` method to `register(ctx: Context?, client: TelemetryDeckSignalProcessor)`
395
402
396
403
The `TelemetryDeckSignalProcessor` interface offers a subset of the `TelemetryDeck` client API which gives you access to:
0 commit comments