From 3eeb643a1eca234b05266b2174f3672de01bfe5d Mon Sep 17 00:00:00 2001 From: Dan Siegel Date: Fri, 1 Nov 2024 10:26:07 -0600 Subject: [PATCH] docs: adding Kochava docs --- .vscode/settings.json | 1 + docs/plugins/logging/index.md | 2 ++ docs/plugins/logging/providers/kochava.md | 21 ++++++++++++++++++--- 3 files changed, 21 insertions(+), 3 deletions(-) diff --git a/.vscode/settings.json b/.vscode/settings.json index c9c39da..df7427c 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -1,5 +1,6 @@ { "cSpell.words": [ + "Kochava", "MVVM", "Xunit" ] diff --git a/docs/plugins/logging/index.md b/docs/plugins/logging/index.md index 73ce2fb..9cf14e6 100644 --- a/docs/plugins/logging/index.md +++ b/docs/plugins/logging/index.md @@ -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) diff --git a/docs/plugins/logging/providers/kochava.md b/docs/plugins/logging/providers/kochava.md index da845cc..3f5e804 100644 --- a/docs/plugins/logging/providers/kochava.md +++ b/docs/plugins/logging/providers/kochava.md @@ -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.