Draft of possible api change #6137
Draft
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/crashlytics/FirebaseCrashlytics.html 2024-08-06 16:03:43.610710215 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/crashlytics/FirebaseCrashlytics.html 2024-08-06 16:01:20.385904100 +0000
@@ -44,7 +44,16 @@
<tr>
<td><code>boolean</code></td>
<td>
- <div><code><a href="/docs/reference/android/com/google/firebase/crashlytics/FirebaseCrashlytics.html#didCrashOnPreviousExecution()">didCrashOnPreviousExecution</a>()</code></div>
+ <div><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/Discouraged.html">Discouraged</a>(message = "May not be current. Use didCrashOnPreviousRun instead.")<br><span><del><a href="/docs/reference/android/com/google/firebase/crashlytics/FirebaseCrashlytics.html#didCrashOnPreviousExecution()">didCrashOnPreviousExecution</a></del></span>()</code></div>
+ <p><strong>This method is deprecated.</strong>
+ <p>May not be current.</p>
+ </p>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="https://developers.google.com/android/reference/com/google/android/gms/tasks/Task.html">Task</a><<a href="https://developer.android.com/reference/kotlin/java/lang/Boolean.html">Boolean</a>></code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/crashlytics/FirebaseCrashlytics.html#didCrashOnPreviousRun()">didCrashOnPreviousRun</a>()</code></div>
<p>Checks whether the app crashed on its previous run.</p>
</td>
</tr>
@@ -56,7 +65,7 @@
</td>
</tr>
<tr>
- <td><code>boolean</code></td>
+ <td><code><a href="https://developers.google.com/android/reference/com/google/android/gms/tasks/Task.html">Task</a><<a href="https://developer.android.com/reference/kotlin/java/lang/Boolean.html">Boolean</a>></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/crashlytics/FirebaseCrashlytics.html#isCrashlyticsCollectionEnabled()">isCrashlyticsCollectionEnabled</a>()</code></div>
<p>Indicates whether or not automatic data collection is enabled</p>
@@ -220,7 +229,10 @@
</div>
<div class="api-item"><a name="didCrashOnPreviousExecution--"></a><a name="didcrashonpreviousexecution"></a>
<h3 class="api-name" id="didCrashOnPreviousExecution()">didCrashOnPreviousExecution</h3>
- <pre class="api-signature no-pretty-print">public boolean <a href="/docs/reference/android/com/google/firebase/crashlytics/FirebaseCrashlytics.html#didCrashOnPreviousExecution()">didCrashOnPreviousExecution</a>()</pre>
+ <pre class="api-signature no-pretty-print">@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/Discouraged.html">Discouraged</a>(message = "May not be current. Use didCrashOnPreviousRun instead.")<br>public boolean <span><del><a href="/docs/reference/android/com/google/firebase/crashlytics/FirebaseCrashlytics.html#didCrashOnPreviousExecution()">didCrashOnPreviousExecution</a></del></span>()</pre>
+ <aside class="caution"><strong>This method is deprecated.</strong><br>
+ <p>May not be current. Use didCrashOnPreviousRun instead. Will be removed in Q2 2025.</p>
+ </aside>
<p>Checks whether the app crashed on its previous run.</p>
<div class="devsite-table-wrapper">
<table class="responsive">
@@ -237,7 +249,33 @@
<tr>
<td><code>boolean</code></td>
<td>
- <p>true if a crash was recorded during the previous run of the app.</p>
+ <p>true if a crash was recorded during the previous run of the app. May not be current.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </div>
+ <div class="api-item"><a name="didCrashOnPreviousRun--"></a><a name="didcrashonpreviousrun"></a>
+ <h3 class="api-name" id="didCrashOnPreviousRun()">didCrashOnPreviousRun</h3>
+ <pre class="api-signature no-pretty-print">public <a href="https://developers.google.com/android/reference/com/google/android/gms/tasks/Task.html">Task</a><<a href="https://developer.android.com/reference/kotlin/java/lang/Boolean.html">Boolean</a>> <a href="/docs/reference/android/com/google/firebase/crashlytics/FirebaseCrashlytics.html#didCrashOnPreviousRun()">didCrashOnPreviousRun</a>()</pre>
+ <p>Checks whether the app crashed on its previous run.</p>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%">Returns</th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><code><a href="https://developers.google.com/android/reference/com/google/android/gms/tasks/Task.html">Task</a><<a href="https://developer.android.com/reference/kotlin/java/lang/Boolean.html">Boolean</a>></code></td>
+ <td>
+ <p>A Task that resolves to true if a crash was recorded during the previous run of the app</p>
</td>
</tr>
</tbody>
@@ -252,7 +290,7 @@
</div>
<div class="api-item"><a name="isCrashlyticsCollectionEnabled--"></a><a name="iscrashlyticscollectionenabled"></a>
<h3 class="api-name" id="isCrashlyticsCollectionEnabled()">isCrashlyticsCollectionEnabled</h3>
- <pre class="api-signature no-pretty-print">public boolean <a href="/docs/reference/android/com/google/firebase/crashlytics/FirebaseCrashlytics.html#isCrashlyticsCollectionEnabled()">isCrashlyticsCollectionEnabled</a>()</pre>
+ <pre class="api-signature no-pretty-print">public <a href="https://developers.google.com/android/reference/com/google/android/gms/tasks/Task.html">Task</a><<a href="https://developer.android.com/reference/kotlin/java/lang/Boolean.html">Boolean</a>> <a href="/docs/reference/android/com/google/firebase/crashlytics/FirebaseCrashlytics.html#isCrashlyticsCollectionEnabled()">isCrashlyticsCollectionEnabled</a>()</pre>
<p>Indicates whether or not automatic data collection is enabled</p>
<div class="devsite-table-wrapper">
<table class="responsive">
@@ -267,9 +305,9 @@
</thead>
<tbody class="list">
<tr>
- <td><code>boolean</code></td>
+ <td><code><a href="https://developers.google.com/android/reference/com/google/android/gms/tasks/Task.html">Task</a><<a href="https://developer.android.com/reference/kotlin/java/lang/Boolean.html">Boolean</a>></code></td>
<td>
- <p>In order of priority: </p>
+ <p>A Task that resolved in order of priority: </p>
<p>If <code><a href="/docs/reference/android/com/google/firebase/crashlytics/FirebaseCrashlytics.html#setCrashlyticsCollectionEnabled(boolean)">setCrashlyticsCollectionEnabled</a></code> is called with a value, use it </p>
<p>If the <b>firebase_crashlytics_collection_enabled</b> key is in your app’s AndroidManifest.xml, use it </p>
<p>Otherwise, use the default <code><a href="/docs/reference/android/com/google/firebase/FirebaseApp.html#isDataCollectionDefaultEnabled()">isDataCollectionDefaultEnabled</a></code> in FirebaseApp</p>--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/crashlytics/FirebaseCrashlytics.html 2024-08-06 16:03:43.626710302 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/crashlytics/FirebaseCrashlytics.html 2024-08-06 16:01:20.385904100 +0000
@@ -44,7 +44,16 @@
<tr>
<td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></code></td>
<td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/crashlytics/FirebaseCrashlytics.html#didCrashOnPreviousExecution()">didCrashOnPreviousExecution</a>()</code></div>
+ <div><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/Discouraged.html">Discouraged</a>(message = "May not be current. Use didCrashOnPreviousRun instead.")<br><span><del><a href="/docs/reference/kotlin/com/google/firebase/crashlytics/FirebaseCrashlytics.html#didCrashOnPreviousExecution()">didCrashOnPreviousExecution</a></del></span>()</code></div>
+ <p><strong>This function is deprecated.</strong>
+ <p>May not be current.</p>
+ </p>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="https://developers.google.com/android/reference/com/google/android/gms/tasks/Task.html">Task</a><<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a>!>!</code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/crashlytics/FirebaseCrashlytics.html#didCrashOnPreviousRun()">didCrashOnPreviousRun</a>()</code></div>
<p>Checks whether the app crashed on its previous run.</p>
</td>
</tr>
@@ -56,7 +65,7 @@
</td>
</tr>
<tr>
- <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></code></td>
+ <td><code><a href="https://developers.google.com/android/reference/com/google/android/gms/tasks/Task.html">Task</a><<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a>!>!</code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/crashlytics/FirebaseCrashlytics.html#isCrashlyticsCollectionEnabled()">isCrashlyticsCollectionEnabled</a>()</code></div>
<p>Indicates whether or not automatic data collection is enabled</p>
@@ -220,7 +229,10 @@
</div>
<div class="api-item"><a name="didCrashOnPreviousExecution--"></a><a name="didcrashonpreviousexecution"></a>
<h3 class="api-name" id="didCrashOnPreviousExecution()">didCrashOnPreviousExecution</h3>
- <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/crashlytics/FirebaseCrashlytics.html#didCrashOnPreviousExecution()">didCrashOnPreviousExecution</a>(): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></pre>
+ <pre class="api-signature no-pretty-print">@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/Discouraged.html">Discouraged</a>(message = "May not be current. Use didCrashOnPreviousRun instead.")<br>fun <span><del><a href="/docs/reference/kotlin/com/google/firebase/crashlytics/FirebaseCrashlytics.html#didCrashOnPreviousExecution()">didCrashOnPreviousExecution</a></del></span>(): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></pre>
+ <aside class="caution"><strong>This function is deprecated.</strong><br>
+ <p>May not be current. Use didCrashOnPreviousRun instead. Will be removed in Q2 2025.</p>
+ </aside>
<p>Checks whether the app crashed on its previous run.</p>
<div class="devsite-table-wrapper">
<table class="responsive">
@@ -237,7 +249,33 @@
<tr>
<td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></code></td>
<td>
- <p>true if a crash was recorded during the previous run of the app.</p>
+ <p>true if a crash was recorded during the previous run of the app. May not be current.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </div>
+ <div class="api-item"><a name="didCrashOnPreviousRun--"></a><a name="didcrashonpreviousrun"></a>
+ <h3 class="api-name" id="didCrashOnPreviousRun()">didCrashOnPreviousRun</h3>
+ <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/crashlytics/FirebaseCrashlytics.html#didCrashOnPreviousRun()">didCrashOnPreviousRun</a>(): <a href="https://developers.google.com/android/reference/com/google/android/gms/tasks/Task.html">Task</a><<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a>!>!</pre>
+ <p>Checks whether the app crashed on its previous run.</p>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%">Returns</th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><code><a href="https://developers.google.com/android/reference/com/google/android/gms/tasks/Task.html">Task</a><<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a>!>!</code></td>
+ <td>
+ <p>A Task that resolves to true if a crash was recorded during the previous run of the app</p>
</td>
</tr>
</tbody>
@@ -252,7 +290,7 @@
</div>
<div class="api-item"><a name="isCrashlyticsCollectionEnabled--"></a><a name="iscrashlyticscollectionenabled"></a>
<h3 class="api-name" id="isCrashlyticsCollectionEnabled()">isCrashlyticsCollectionEnabled</h3>
- <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/crashlytics/FirebaseCrashlytics.html#isCrashlyticsCollectionEnabled()">isCrashlyticsCollectionEnabled</a>(): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></pre>
+ <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/crashlytics/FirebaseCrashlytics.html#isCrashlyticsCollectionEnabled()">isCrashlyticsCollectionEnabled</a>(): <a href="https://developers.google.com/android/reference/com/google/android/gms/tasks/Task.html">Task</a><<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a>!>!</pre>
<p>Indicates whether or not automatic data collection is enabled</p>
<div class="devsite-table-wrapper">
<table class="responsive">
@@ -267,9 +305,9 @@
</thead>
<tbody class="list">
<tr>
- <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></code></td>
+ <td><code><a href="https://developers.google.com/android/reference/com/google/android/gms/tasks/Task.html">Task</a><<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a>!>!</code></td>
<td>
- <p>In order of priority: </p>
+ <p>A Task that resolved in order of priority: </p>
<p>If <code><a href="/docs/reference/kotlin/com/google/firebase/crashlytics/FirebaseCrashlytics.html#setCrashlyticsCollectionEnabled(boolean)">setCrashlyticsCollectionEnabled</a></code> is called with a value, use it </p>
<p>If the <b>firebase_crashlytics_collection_enabled</b> key is in your app’s AndroidManifest.xml, use it </p>
<p>Otherwise, use the default <code><a href="/docs/reference/kotlin/com/google/firebase/FirebaseApp.html#isDataCollectionDefaultEnabled()">isDataCollectionDefaultEnabled</a></code> in FirebaseApp</p> |
Coverage Report 1Affected Products
Test Logs |
|
The public api surface has changed for the subproject firebase-crashlytics_api.txt: Please update the api.txt files for the subprojects being affected by this change by running ./gradlew ${subproject}:generateApiTxtFile. Also perform a major/minor bump accordingly. |
Unit Test Results 8 files + 4 8 suites +4 29s ⏱️ +26s Results for commit 26338c7. ± Comparison against base commit 0605925. This pull request removes 50 and adds 22 tests. Note that renamed tests count towards both.♻️ This comment has been updated with latest results. |
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. Notes
Startup Times
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.