Skip to content

Commit

Permalink
docs: adding Kochava docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dansiegel committed Nov 1, 2024
1 parent 9d5d517 commit 3eeb643
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 3 deletions.
1 change: 1 addition & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"cSpell.words": [
"Kochava",
"MVVM",
"Xunit"
]
Expand Down
2 changes: 2 additions & 0 deletions docs/plugins/logging/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,9 @@ Prism provides a number of logging providers available out of the box for you wi
- [AppCenter](xref:Plugins.Logging.AppCenter)
- [Console](xref:Plugins.Logging.Console)
- [Debug](xref:Plugins.Logging.Debug)
- [Firebase](xref:Plugins.Logging.Firebase)
- [Graylog (GELF)](xref:Plugins.Logging.Gelf)
- [Kochava](xref:Plugins.Logging.Kochava)
- [Raygun](xref:Plugins.Logging.Raygun)
- [Sentry](xref:Plugins.Logging.Sentry)
- [Testing](xref:Plugins.Logging.Testing)
Expand Down
21 changes: 18 additions & 3 deletions docs/plugins/logging/providers/kochava.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,22 @@ uid: Plugins.Logging.Kochava

# Kochava

Coming Soon
By installing the `Prism.Plugin.Logging.Kochava` package you get access to the Kochava Logging provider.

> [!NOTE]
> Due to the platform restrictions of Kochava this is only brought in for Android, iOS, & MacCatalyst. The AddProvider method is perfectly safe to use across any platform as the Kochava dependency isn't referenced on outside of those runtimes and is not actually registered with the container.
```cs
containerRegistry.UsePrismLogging(logging => {
logging.AddKochava("{app secret}");
});
```

## Limitations & Considerations

Kochava is best utilized for application Analytics.

### API

Only the `TrackEvent` API has been implemented for Kochava. As a result there is no need to try to disable the Error Tracking or generic Logging.

### Supported Platforms

Kochava is only available on Android, iOS, & MacCatalyst. The `Prism.Plugin.Logging.Kochava` package can safely be used across any other targets you may have without the need to put a compiler directive around it. Adding the provider outside of the supported platforms will not result in any additional provider being added and you will not have a Kochava reference in your code.

0 comments on commit 3eeb643

Please sign in to comment.