Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Nov 1, 2024
1 parent 6e956a4 commit 0f121c2
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 5 deletions.
2 changes: 2 additions & 0 deletions docs/plugins/logging/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -765,7 +765,9 @@ <h2 id="logging-providers">Logging Providers</h2>
<li><a class="xref" href="providers/appcenter.html">AppCenter</a></li>
<li><a class="xref" href="providers/console.html">Console</a></li>
<li><a class="xref" href="providers/debug.html">Debug</a></li>
<li><a class="xref" href="providers/firebase.html">Firebase</a></li>
<li><a class="xref" href="providers/gelf.html">Graylog (GELF)</a></li>
<li><a class="xref" href="providers/kochava.html">Kochava</a></li>
<li><a class="xref" href="providers/raygun.html">Raygun</a></li>
<li><a class="xref" href="providers/sentry.html">Sentry</a></li>
<li><a class="xref" href="providers/testing.html">Testing</a></li>
Expand Down
13 changes: 10 additions & 3 deletions docs/plugins/logging/providers/kochava.html
Original file line number Diff line number Diff line change
Expand Up @@ -693,9 +693,16 @@
<article class="content wrap" id="_content" data-uid="Plugins.Logging.Kochava">
<h1 id="kochava">Kochava</h1>

<p>Coming Soon</p>
<div class="NOTE"><h5>Note</h5><p>Due to the platform restrictions of Kochava this is only brought in for Android, iOS, &amp; MacCatalyst. The AddProvider method is perfectly safe to use across any platform as the Kochava dependency isn&#39;t referenced on outside of those runtimes and is not actually registered with the container.</p>
</div>
<p>By installing the <code>Prism.Plugin.Logging.Kochava</code> package you get access to the Kochava Logging provider.</p>
<pre><code class="lang-cs">containerRegistry.UsePrismLogging(logging =&gt; {
logging.AddKochava(&quot;{app secret}&quot;);
});
</code></pre><h2 id="limitations-amp-considerations">Limitations &amp; Considerations</h2>
<p>Kochava is best utilized for application Analytics.</p>
<h3 id="api">API</h3>
<p>Only the <code>TrackEvent</code> API has been implemented for Kochava. As a result there is no need to try to disable the Error Tracking or generic Logging.</p>
<h3 id="supported-platforms">Supported Platforms</h3>
<p>Kochava is only available on Android, iOS, &amp; MacCatalyst. The <code>Prism.Plugin.Logging.Kochava</code> 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.</p>
</article>
</div>

Expand Down
4 changes: 2 additions & 2 deletions manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -2177,7 +2177,7 @@
"output": {
".html": {
"relative_path": "docs/plugins/logging/index.html",
"hash": "n5uJJUcqmUa9T6yWJnn2NA=="
"hash": "nxPcsNwfkDekf6uzDxsITA=="
}
},
"is_incremental": false,
Expand Down Expand Up @@ -2273,7 +2273,7 @@
"output": {
".html": {
"relative_path": "docs/plugins/logging/providers/kochava.html",
"hash": "EPjkKcEECry2m8PHnT+a1A=="
"hash": "2V9aP9MOjekGIMFekvp+aQ=="
}
},
"is_incremental": false,
Expand Down

0 comments on commit 0f121c2

Please sign in to comment.