Add deprecation tagging to SafetyNetAppCheckProviderFactory.
#4686
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Javadoc Changes:--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/appcheck/safetynet/SafetyNetAppCheckProviderFactory.html 2023-02-15 21:56:24.046218518 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/appcheck/safetynet/SafetyNetAppCheckProviderFactory.html 2023-02-15 21:54:43.734830283 +0000
@@ -10,6 +10,9 @@
<pre>public class SafetyNetAppCheckProviderFactory implements <a href="/docs/reference/android/com/google/firebase/appcheck/AppCheckProviderFactory.html">AppCheckProviderFactory</a></pre>
</p>
<hr>
+ <aside class="caution"><strong>This class is deprecated.</strong><br>
+ <p>Use <code>PlayIntegrityAppCheckProviderFactory</code> instead.</p>
+ </aside>
<p>Implementation of an <code><a href="/docs/reference/android/com/google/firebase/appcheck/AppCheckProviderFactory.html">AppCheckProviderFactory</a></code> that builds SafetyNetAppCheckProviders. This is the default implementation.</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
@@ -39,14 +42,16 @@
<tr>
<td width="40%"><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/appcheck/AppCheckProvider.html">AppCheckProvider</a></code></td>
<td>
- <div><code><a href="/docs/reference/android/com/google/firebase/appcheck/safetynet/SafetyNetAppCheckProviderFactory.html#create(com.google.firebase.FirebaseApp)">create</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/FirebaseApp.html">FirebaseApp</a> firebaseApp)</code></div>
+ <div><code><span><del><a href="/docs/reference/android/com/google/firebase/appcheck/safetynet/SafetyNetAppCheckProviderFactory.html#create(com.google.firebase.FirebaseApp)">create</a></del></span>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/FirebaseApp.html">FirebaseApp</a> firebaseApp)</code></div>
</td>
</tr>
<tr>
<td width="40%"><code>static @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/appcheck/safetynet/SafetyNetAppCheckProviderFactory.html">SafetyNetAppCheckProviderFactory</a></code></td>
<td>
- <div><code><a href="/docs/reference/android/com/google/firebase/appcheck/safetynet/SafetyNetAppCheckProviderFactory.html#getInstance()">getInstance</a>()</code></div>
- <p>Gets an instance of this class for installation into a instance.</p>
+ <div><code><span><del><a href="/docs/reference/android/com/google/firebase/appcheck/safetynet/SafetyNetAppCheckProviderFactory.html#getInstance()">getInstance</a></del></span>()</code></div>
+ <p><strong>This method is deprecated.</strong>
+ <p>Use <code>PlayIntegrityAppCheckProviderFactory#getInstance</code> instead.</p>
+ </p>
</td>
</tr>
</tbody>
@@ -60,11 +65,14 @@
<h2>Public methods</h2>
<div><a name="create-com.google.firebase.FirebaseApp-"></a><a name="create"></a>
<h3 class="api-name" id="create(com.google.firebase.FirebaseApp)">create</h3>
- <pre class="api-signature no-pretty-print">public @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/appcheck/AppCheckProvider.html">AppCheckProvider</a> <a href="/docs/reference/android/com/google/firebase/appcheck/safetynet/SafetyNetAppCheckProviderFactory.html#create(com.google.firebase.FirebaseApp)">create</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/FirebaseApp.html">FirebaseApp</a> firebaseApp)</pre>
+ <pre class="api-signature no-pretty-print">public @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/appcheck/AppCheckProvider.html">AppCheckProvider</a> <span><del><a href="/docs/reference/android/com/google/firebase/appcheck/safetynet/SafetyNetAppCheckProviderFactory.html#create(com.google.firebase.FirebaseApp)">create</a></del></span>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/FirebaseApp.html">FirebaseApp</a> firebaseApp)</pre>
</div>
<div><a name="getInstance--"></a><a name="getinstance"></a>
<h3 class="api-name" id="getInstance()">getInstance</h3>
- <pre class="api-signature no-pretty-print">public static @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/appcheck/safetynet/SafetyNetAppCheckProviderFactory.html">SafetyNetAppCheckProviderFactory</a> <a href="/docs/reference/android/com/google/firebase/appcheck/safetynet/SafetyNetAppCheckProviderFactory.html#getInstance()">getInstance</a>()</pre>
+ <pre class="api-signature no-pretty-print">public static @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/appcheck/safetynet/SafetyNetAppCheckProviderFactory.html">SafetyNetAppCheckProviderFactory</a> <span><del><a href="/docs/reference/android/com/google/firebase/appcheck/safetynet/SafetyNetAppCheckProviderFactory.html#getInstance()">getInstance</a></del></span>()</pre>
+ <aside class="caution"><strong>This method is deprecated.</strong><br>
+ <p>Use <code>PlayIntegrityAppCheckProviderFactory#getInstance</code> instead.</p>
+ </aside>
<p>Gets an instance of this class for installation into a instance.</p>
</div>
</body>--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/appcheck/safetynet/package-summary.html 2023-02-15 21:56:24.046218518 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/appcheck/safetynet/package-summary.html 2023-02-15 21:54:43.738830259 +0000
@@ -13,7 +13,9 @@
<tr>
<td width="40%"><code><a href="/docs/reference/android/com/google/firebase/appcheck/safetynet/SafetyNetAppCheckProviderFactory.html">SafetyNetAppCheckProviderFactory</a></code></td>
<td>
- <p>Implementation of an <code><a href="/docs/reference/android/com/google/firebase/appcheck/AppCheckProviderFactory.html">AppCheckProviderFactory</a></code> that builds SafetyNetAppCheckProviders.</p>
+ <p><strong>This class is deprecated.</strong>
+ <p>Use <code>PlayIntegrityAppCheckProviderFactory</code> instead.</p>
+ </p>
</td>
</tr>
</tbody>--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/appcheck/safetynet/SafetyNetAppCheckProviderFactory.html 2023-02-15 21:56:24.066218397 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/appcheck/safetynet/SafetyNetAppCheckProviderFactory.html 2023-02-15 21:54:43.770830067 +0000
@@ -10,6 +10,9 @@
<pre>class SafetyNetAppCheckProviderFactory : <a href="/docs/reference/kotlin/com/google/firebase/appcheck/AppCheckProviderFactory.html">AppCheckProviderFactory</a></pre>
</p>
<hr>
+ <aside class="caution"><strong>This class is deprecated.</strong><br>
+ <p>Use <code>PlayIntegrityAppCheckProviderFactory</code> instead.</p>
+ </aside>
<p>Implementation of an <code><a href="/docs/reference/kotlin/com/google/firebase/appcheck/AppCheckProviderFactory.html">AppCheckProviderFactory</a></code> that builds SafetyNetAppCheckProviders. This is the default implementation.</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
@@ -39,14 +42,16 @@
<tr>
<td width="40%"><code><a href="/docs/reference/kotlin/com/google/firebase/appcheck/AppCheckProvider.html">AppCheckProvider</a></code></td>
<td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/appcheck/safetynet/SafetyNetAppCheckProviderFactory.html#create(com.google.firebase.FirebaseApp)">create</a>(firebaseApp: <a href="/docs/reference/kotlin/com/google/firebase/FirebaseApp.html">FirebaseApp</a>)</code></div>
+ <div><code><span><del><a href="/docs/reference/kotlin/com/google/firebase/appcheck/safetynet/SafetyNetAppCheckProviderFactory.html#create(com.google.firebase.FirebaseApp)">create</a></del></span>(firebaseApp: <a href="/docs/reference/kotlin/com/google/firebase/FirebaseApp.html">FirebaseApp</a>)</code></div>
</td>
</tr>
<tr>
<td width="40%"><code>java-static <a href="/docs/reference/kotlin/com/google/firebase/appcheck/safetynet/SafetyNetAppCheckProviderFactory.html">SafetyNetAppCheckProviderFactory</a></code></td>
<td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/appcheck/safetynet/SafetyNetAppCheckProviderFactory.html#getInstance()">getInstance</a>()</code></div>
- <p>Gets an instance of this class for installation into a instance.</p>
+ <div><code><span><del><a href="/docs/reference/kotlin/com/google/firebase/appcheck/safetynet/SafetyNetAppCheckProviderFactory.html#getInstance()">getInstance</a></del></span>()</code></div>
+ <p><strong>This function is deprecated.</strong>
+ <p>Use <code>PlayIntegrityAppCheckProviderFactory#getInstance</code> instead.</p>
+ </p>
</td>
</tr>
</tbody>
@@ -60,11 +65,14 @@
<h2>Public functions</h2>
<div><a name="create-com.google.firebase.FirebaseApp-"></a><a name="create"></a>
<h3 class="api-name" id="create(com.google.firebase.FirebaseApp)">create</h3>
- <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/appcheck/safetynet/SafetyNetAppCheckProviderFactory.html#create(com.google.firebase.FirebaseApp)">create</a>(firebaseApp: <a href="/docs/reference/kotlin/com/google/firebase/FirebaseApp.html">FirebaseApp</a>): <a href="/docs/reference/kotlin/com/google/firebase/appcheck/AppCheckProvider.html">AppCheckProvider</a></pre>
+ <pre class="api-signature no-pretty-print">fun <span><del><a href="/docs/reference/kotlin/com/google/firebase/appcheck/safetynet/SafetyNetAppCheckProviderFactory.html#create(com.google.firebase.FirebaseApp)">create</a></del></span>(firebaseApp: <a href="/docs/reference/kotlin/com/google/firebase/FirebaseApp.html">FirebaseApp</a>): <a href="/docs/reference/kotlin/com/google/firebase/appcheck/AppCheckProvider.html">AppCheckProvider</a></pre>
</div>
<div><a name="getInstance--"></a><a name="getinstance"></a>
<h3 class="api-name" id="getInstance()">getInstance</h3>
- <pre class="api-signature no-pretty-print">java-static fun <a href="/docs/reference/kotlin/com/google/firebase/appcheck/safetynet/SafetyNetAppCheckProviderFactory.html#getInstance()">getInstance</a>(): <a href="/docs/reference/kotlin/com/google/firebase/appcheck/safetynet/SafetyNetAppCheckProviderFactory.html">SafetyNetAppCheckProviderFactory</a></pre>
+ <pre class="api-signature no-pretty-print">java-static fun <span><del><a href="/docs/reference/kotlin/com/google/firebase/appcheck/safetynet/SafetyNetAppCheckProviderFactory.html#getInstance()">getInstance</a></del></span>(): <a href="/docs/reference/kotlin/com/google/firebase/appcheck/safetynet/SafetyNetAppCheckProviderFactory.html">SafetyNetAppCheckProviderFactory</a></pre>
+ <aside class="caution"><strong>This function is deprecated.</strong><br>
+ <p>Use <code>PlayIntegrityAppCheckProviderFactory#getInstance</code> instead.</p>
+ </aside>
<p>Gets an instance of this class for installation into a instance.</p>
</div>
</body>--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/appcheck/safetynet/package-summary.html 2023-02-15 21:56:24.066218397 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/appcheck/safetynet/package-summary.html 2023-02-15 21:54:43.770830067 +0000
@@ -13,7 +13,9 @@
<tr>
<td width="40%"><code><a href="/docs/reference/kotlin/com/google/firebase/appcheck/safetynet/SafetyNetAppCheckProviderFactory.html">SafetyNetAppCheckProviderFactory</a></code></td>
<td>
- <p>Implementation of an <code><a href="/docs/reference/kotlin/com/google/firebase/appcheck/AppCheckProviderFactory.html">AppCheckProviderFactory</a></code> that builds SafetyNetAppCheckProviders.</p>
+ <p><strong>This class is deprecated.</strong>
+ <p>Use <code>PlayIntegrityAppCheckProviderFactory</code> instead.</p>
+ </p>
</td>
</tr>
</tbody> |
📝 PRs merging into main branchOur main branch should always be in a releasable state. If you are working on a larger change, or if you don't want this change to see the light of the day just yet, consider using a feature branch first, and only merge into the main branch when the code complete and ready to be released. Add the 'main-merge-ack' label to your PR to confirm merging into the main branch is intended. |
Coverage Report 1Affected Products
Test Logs |
Size Report 1Affected Products
Test Logs |
Startup Time Report 1Note: Layout is sometimes suboptimal due to limited formatting support on GitHub. Please check this report on GCS. Startup time comparison between the CI merge commit (7064085) and the base commit (6071e9d) are not available. No macrobenchmark data found for the base commit (6071e9d). Analysis for the CI merge commit (7064085) can be found at: |
rlazo
approved these changes
Feb 15, 2023
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Per discussion, add deprecation tags to the App Check SafetyNet SDK.