Skip to content

Commit 209ee0c

Browse files
authored
update deprecation message for common (#5389)
1 parent 87e5965 commit 209ee0c

File tree

35 files changed

+173
-175
lines changed

35 files changed

+173
-175
lines changed

appcheck/firebase-appcheck/CHANGELOG.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22
* [changed] Added Kotlin extensions (KTX) APIs from `com.google.firebase:firebase-appcheck-ktx`
33
to `com.google.firebase:firebase-appcheck` under the `com.google.firebase.appcheck` package.
44
For details, see the
5-
[FAQ about this initiative](https://firebase.google.com/docs/android/ktx-apis-to-main-modules)
5+
[FAQ about this initiative](https://firebase.google.com/docs/android/kotlin-migration)
66

77
* [deprecated] All the APIs from `com.google.firebase:firebase-appcheck-ktx` have been added to
88
`com.google.firebase:firebase-appcheck` under the `com.google.firebase.appcheck` package,
99
and all the Kotlin extensions (KTX) APIs in `com.google.firebase:firebase-appcheck-ktx` are
1010
now deprecated. As early as April 2024, we'll no longer release KTX modules. For details, see the
11-
[FAQ about this initiative](https://firebase.google.com/docs/android/ktx-apis-to-main-modules)
11+
[FAQ about this initiative](https://firebase.google.com/docs/android/kotlin-migration)
1212

1313

1414

appcheck/firebase-appcheck/src/main/java/com/google/firebase/appcheck/ktx/FirebaseAppCheck.kt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ import com.google.firebase.ktx.app
2828
* respective main modules, and the Kotlin extension (KTX) APIs in
2929
* `com.google.firebase.firebase-appcheck-ktx` are now deprecated. As early as April 2024, we'll no
3030
* longer release KTX modules. For details, see the
31-
* [FAQ about this initiative.](https://firebase.google.com/docs/android/ktx-apis-to-main-modules)
31+
* [FAQ about this initiative.](https://firebase.google.com/docs/android/kotlin-migration)
3232
*/
3333
@Deprecated(
3434
"Use `com.google.firebase.appcheck.Firebase.appCheck` from the main module instead.",
@@ -46,7 +46,7 @@ val Firebase.appCheck: FirebaseAppCheck
4646
* respective main modules, and the Kotlin extension (KTX) APIs in
4747
* `com.google.firebase.firebase-appcheck-ktx` are now deprecated. As early as April 2024, we'll no
4848
* longer release KTX modules. For details, see the
49-
* [FAQ about this initiative.](https://firebase.google.com/docs/android/ktx-apis-to-main-modules)
49+
* [FAQ about this initiative.](https://firebase.google.com/docs/android/kotlin-migration)
5050
*/
5151
@Deprecated(
5252
"Use `com.google.firebase.appcheck.Firebase.appCheck(app)` from the main module instead.",
@@ -65,7 +65,7 @@ fun Firebase.appCheck(app: FirebaseApp) = FirebaseAppCheck.getInstance(app)
6565
* respective main modules, and the Kotlin extension (KTX) APIs in
6666
* `com.google.firebase.firebase-appcheck-ktx` are now deprecated. As early as April 2024, we'll no
6767
* longer release KTX modules. For details, see the
68-
* [FAQ about this initiative.](https://firebase.google.com/docs/android/ktx-apis-to-main-modules)
68+
* [FAQ about this initiative.](https://firebase.google.com/docs/android/kotlin-migration)
6969
*/
7070
@Deprecated(
7171
"Use `com.google.firebase.appcheck.AppCheckToken.component1` from the main module instead.",
@@ -81,7 +81,7 @@ operator fun AppCheckToken.component1() = token
8181
* respective main modules, and the Kotlin extension (KTX) APIs in
8282
* `com.google.firebase.firebase-appcheck-ktx` are now deprecated. As early as April 2024, we'll no
8383
* longer release KTX modules. For details, see the
84-
* [FAQ about this initiative.](https://firebase.google.com/docs/android/ktx-apis-to-main-modules)
84+
* [FAQ about this initiative.](https://firebase.google.com/docs/android/kotlin-migration)
8585
*/
8686
@Deprecated(
8787
"Use `com.google.firebase.appcheck.AppCheckToken.component2` from the main module instead.",
@@ -95,7 +95,7 @@ operator fun AppCheckToken.component2() = expireTimeMillis
9595
* respective main modules, and the Kotlin extension (KTX) APIs in
9696
* `com.google.firebase.firebase-appcheck-ktx` are now deprecated. As early as April 2024, we'll no
9797
* longer release KTX modules. For details, see the
98-
* [FAQ about this initiative.](https://firebase.google.com/docs/android/ktx-apis-to-main-modules)
98+
* [FAQ about this initiative.](https://firebase.google.com/docs/android/kotlin-migration)
9999
*/
100100
@Deprecated(
101101
"Use `com.google.firebase.appcheck.FirebaseAppCheckKtxRegistrar` from the main module instead.",

firebase-appdistribution-api/CHANGELOG.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
to `com.google.firebase:firebase-appdistribution-api` under the
55
`com.google.firebase.appdistribution` package.
66
For details, see the
7-
[FAQ about this initiative](https://firebase.google.com/docs/android/ktx-apis-to-main-modules)
7+
[FAQ about this initiative](https://firebase.google.com/docs/android/kotlin-migration)
88

99
* [deprecated] All the APIs from `com.google.firebase:firebase-appdistribution-api-ktx` have been
1010
added to
@@ -13,7 +13,7 @@
1313
and all the Kotlin extensions (KTX) APIs in `com.google.firebase:firebase-appdistribution-api-ktx`
1414
are now deprecated. As early as April 2024, we'll no longer release KTX modules. For details,
1515
see the
16-
[FAQ about this initiative](https://firebase.google.com/docs/android/ktx-apis-to-main-modules)
16+
[FAQ about this initiative](https://firebase.google.com/docs/android/kotlin-migration)
1717

1818
# 16.0.0-beta09
1919
* [feature] Improved development mode to allow all API calls to be made without having to sign in.

firebase-appdistribution-api/src/main/java/com/google/firebase/appdistribution/ktx/FirebaseAppDistribution.kt

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ import com.google.firebase.ktx.Firebase
2929
* respective main modules, and the Kotlin extension (KTX) APIs in
3030
* `com.google.firebase:firebase-appdistribution-api-ktx` are now deprecated. As early as April
3131
* 2024, we'll no longer release KTX modules. For details, see the
32-
* [FAQ about this initiative.](https://firebase.google.com/docs/android/ktx-apis-to-main-modules)
32+
* [FAQ about this initiative.](https://firebase.google.com/docs/android/kotlin-migration)
3333
*/
3434
@Deprecated(
3535
"Use `com.google.firebase.Firebase.appDistribution` from the main module instead.",
@@ -50,7 +50,7 @@ val Firebase.appDistribution: FirebaseAppDistribution
5050
* respective main modules, and the Kotlin extension (KTX) APIs in
5151
* `com.google.firebase:firebase-appdistribution-api-ktx` are now deprecated. As early as April
5252
* 2024, we'll no longer release KTX modules. For details, see the
53-
* [FAQ about this initiative.](https://firebase.google.com/docs/android/ktx-apis-to-main-modules)
53+
* [FAQ about this initiative.](https://firebase.google.com/docs/android/kotlin-migration)
5454
*/
5555
@Deprecated(
5656
"Use `com.google.firebase.appdistribution.AppDistributionRelease.component1()` from the main module instead.",
@@ -69,7 +69,7 @@ operator fun AppDistributionRelease.component1() = binaryType
6969
* respective main modules, and the Kotlin extension (KTX) APIs in
7070
* `com.google.firebase:firebase-appdistribution-api-ktx` are now deprecated. As early as April
7171
* 2024, we'll no longer release KTX modules. For details, see the
72-
* [FAQ about this initiative.](https://firebase.google.com/docs/android/ktx-apis-to-main-modules)
72+
* [FAQ about this initiative.](https://firebase.google.com/docs/android/kotlin-migration)
7373
*/
7474
@Deprecated(
7575
"Use `com.google.firebase.appdistribution.AppDistributionRelease.component2()` from the main module instead.",
@@ -88,7 +88,7 @@ operator fun AppDistributionRelease.component2() = displayVersion
8888
* respective main modules, and the Kotlin extension (KTX) APIs in
8989
* `com.google.firebase:firebase-appdistribution-api-ktx` are now deprecated. As early as April
9090
* 2024, we'll no longer release KTX modules. For details, see the
91-
* [FAQ about this initiative.](https://firebase.google.com/docs/android/ktx-apis-to-main-modules)
91+
* [FAQ about this initiative.](https://firebase.google.com/docs/android/kotlin-migration)
9292
*/
9393
@Deprecated(
9494
"Use `com.google.firebase.appdistribution.AppDistributionRelease.component3()` from the main module instead.",
@@ -107,7 +107,7 @@ operator fun AppDistributionRelease.component3() = versionCode
107107
* respective main modules, and the Kotlin extension (KTX) APIs in
108108
* `com.google.firebase:firebase-appdistribution-api-ktx` are now deprecated. As early as April
109109
* 2024, we'll no longer release KTX modules. For details, see the
110-
* [FAQ about this initiative.](https://firebase.google.com/docs/android/ktx-apis-to-main-modules)
110+
* [FAQ about this initiative.](https://firebase.google.com/docs/android/kotlin-migration)
111111
*/
112112
@Deprecated(
113113
"Use `com.google.firebase.appdistribution.AppDistributionRelease.component4()` from the main module instead.",
@@ -126,7 +126,7 @@ operator fun AppDistributionRelease.component4() = releaseNotes
126126
* respective main modules, and the Kotlin extension (KTX) APIs in
127127
* `com.google.firebase:firebase-appdistribution-api-ktx` are now deprecated. As early as April
128128
* 2024, we'll no longer release KTX modules. For details, see the
129-
* [FAQ about this initiative.](https://firebase.google.com/docs/android/ktx-apis-to-main-modules)
129+
* [FAQ about this initiative.](https://firebase.google.com/docs/android/kotlin-migration)
130130
*/
131131
@Deprecated(
132132
"Use `com.google.firebase.appdistribution.UpdateProgress.component1()` from the main module instead.",
@@ -145,7 +145,7 @@ operator fun UpdateProgress.component1() = apkBytesDownloaded
145145
* respective main modules, and the Kotlin extension (KTX) APIs in
146146
* `com.google.firebase:firebase-appdistribution-api-ktx` are now deprecated. As early as April
147147
* 2024, we'll no longer release KTX modules. For details, see the
148-
* [FAQ about this initiative.](https://firebase.google.com/docs/android/ktx-apis-to-main-modules)
148+
* [FAQ about this initiative.](https://firebase.google.com/docs/android/kotlin-migration)
149149
*/
150150
@Deprecated(
151151
"Use `com.google.firebase.appdistribution.UpdateProgress.component2()` from the main module instead.",
@@ -164,7 +164,7 @@ operator fun UpdateProgress.component2() = apkFileTotalBytes
164164
* respective main modules, and the Kotlin extension (KTX) APIs in
165165
* `com.google.firebase:firebase-appdistribution-api-ktx` are now deprecated. As early as April
166166
* 2024, we'll no longer release KTX modules. For details, see the
167-
* [FAQ about this initiative.](https://firebase.google.com/docs/android/ktx-apis-to-main-modules)
167+
* [FAQ about this initiative.](https://firebase.google.com/docs/android/kotlin-migration)
168168
*/
169169
@Deprecated(
170170
"Use `com.google.firebase.appdistribution.UpdateProgress.component3()` from the main module instead.",
@@ -181,7 +181,7 @@ operator fun UpdateProgress.component3() = updateStatus
181181
* respective main modules, and the Kotlin extension (KTX) APIs in
182182
* `com.google.firebase:firebase-appdistribution-api-ktx` are now deprecated. As early as April
183183
* 2024, we'll no longer release KTX modules. For details, see the
184-
* [FAQ about this initiative.](https://firebase.google.com/docs/android/ktx-apis-to-main-modules)
184+
* [FAQ about this initiative.](https://firebase.google.com/docs/android/kotlin-migration)
185185
*/
186186
@Deprecated(
187187
"Use `com.google.firebase.appdistribution.FirebaseAppDistributionKtxRegistrar` from the main module instead.",

firebase-common/CHANGELOG.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22
* [changed] Added Kotlin extensions (KTX) APIs from `com.google.firebase:firebase-common-ktx`
33
to `com.google.firebase:firebase-common` under the `com.google.firebase` package.
44
For details, see the
5-
[FAQ about this initiative](https://firebase.google.com/docs/android/ktx-apis-to-main-modules)
5+
[FAQ about this initiative](https://firebase.google.com/docs/android/kotlin-migration)
66

77
## Kotlin
88
* [deprecated] All the APIs from `com.google.firebase:firebase-common-ktx` have been added to
99
`com.google.firebase:firebase-common` under the `com.google.firebase package`, and all the
1010
Kotlin extensions (KTX) APIs in `com.google.firebase:firebase-common-ktx` are now deprecated.
1111
As early as April 2024, we'll no longer release KTX modules. For details, see the
1212
FAQ about this initiative.
13-
[FAQ about this initiative](https://firebase.google.com/docs/android/ktx-apis-to-main-modules)
13+
[FAQ about this initiative](https://firebase.google.com/docs/android/kotlin-migration)
1414

1515
# 20.3.3
1616
* [fixed] Addressed issue with C++ being absent in user agent.

firebase-common/src/main/java/com/google/firebase/ktx/Firebase.kt

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -30,19 +30,17 @@ import kotlinx.coroutines.CoroutineDispatcher
3030
import kotlinx.coroutines.asCoroutineDispatcher
3131

3232
/**
33-
* Single access point to all firebase SDKs from Kotlin.
33+
* All fields in this object are deprecated; Use `com.google.firebase.Firebase` instead.
34+
*
35+
* Single access point to all firebase SDKs from Kotlin. Acts as a target for extension methods
36+
* provided by sdks.
3437
*
35-
* <p>Acts as a target for extension methods provided by sdks.
3638
* @deprecated **Deprecation Notice:** The Kotlin extensions (KTX) APIs have been added to their
3739
* respective main modules, and the Kotlin extension (KTX) APIs in
3840
* `com.google.firebase.firebase-common-ktx` are now deprecated. As early as April 2024, we'll no
3941
* longer release KTX modules. For details, see the
40-
* [FAQ about this initiative.](https://firebase.google.com/docs/android/ktx-apis-to-main-modules)
42+
* [FAQ about this initiative.](https://firebase.google.com/docs/android/kotlin-migration)
4143
*/
42-
@Deprecated(
43-
"Use `com.google.firebase.Firebase` from the main module instead.",
44-
ReplaceWith(expression = "Firebase", imports = ["com.google.firebase.Firebase"])
45-
)
4644
object Firebase
4745

4846
/**
@@ -51,7 +49,7 @@ object Firebase
5149
* respective main modules, and the Kotlin extension (KTX) APIs in
5250
* `com.google.firebase.firebase-common-ktx` are now deprecated. As early as April 2024, we'll no
5351
* longer release KTX modules. For details, see the
54-
* [FAQ about this initiative.](https://firebase.google.com/docs/android/ktx-apis-to-main-modules).
52+
* [FAQ about this initiative.](https://firebase.google.com/docs/android/kotlin-migration).
5553
*/
5654
@Deprecated(
5755
"Use `com.google.firebase.Firebase.app` from the main module instead.",
@@ -69,7 +67,7 @@ val Firebase.app: FirebaseApp
6967
* respective main modules, and the Kotlin extension (KTX) APIs in
7068
* `com.google.firebase.firebase-common-ktx` are now deprecated. As early as April 2024, we'll no
7169
* longer release KTX modules. For details, see the
72-
* [FAQ about this initiative.](https://firebase.google.com/docs/android/ktx-apis-to-main-modules).
70+
* [FAQ about this initiative.](https://firebase.google.com/docs/android/kotlin-migration).
7371
*/
7472
@Deprecated(
7573
"Use `com.google.firebase.Firebase.app(name)` from the main module instead.",
@@ -86,7 +84,7 @@ fun Firebase.app(name: String): FirebaseApp = FirebaseApp.getInstance(name)
8684
* respective main modules, and the Kotlin extension (KTX) APIs in
8785
* `com.google.firebase.firebase-common-ktx` are now deprecated. As early as April 2024, we'll no
8886
* longer release KTX modules. For details, see the
89-
* [FAQ about this initiative.](https://firebase.google.com/docs/android/ktx-apis-to-main-modules)
87+
* [FAQ about this initiative.](https://firebase.google.com/docs/android/kotlin-migration)
9088
*/
9189
@Deprecated(
9290
"Use `com.google.firebase.Firebase.initialize(context)` from the main module instead.",
@@ -103,7 +101,7 @@ fun Firebase.initialize(context: Context): FirebaseApp? = FirebaseApp.initialize
103101
* respective main modules, and the Kotlin extension (KTX) APIs in
104102
* `com.google.firebase.firebase-common-ktx` are now deprecated. As early as April 2024, we'll no
105103
* longer release KTX modules. For details, see the
106-
* [FAQ about this initiative.](https://firebase.google.com/docs/android/ktx-apis-to-main-modules)
104+
* [FAQ about this initiative.](https://firebase.google.com/docs/android/kotlin-migration)
107105
*/
108106
@Deprecated(
109107
"Use `com.google.firebase.Firebase.initialize(context, options)` from the main module instead.",
@@ -121,7 +119,7 @@ fun Firebase.initialize(context: Context, options: FirebaseOptions): FirebaseApp
121119
* respective main modules, and the Kotlin extension (KTX) APIs in
122120
* `com.google.firebase.firebase-common-ktx` are now deprecated. As early as April 2024, we'll no
123121
* longer release KTX modules. For details, see the
124-
* [FAQ about this initiative.](https://firebase.google.com/docs/android/ktx-apis-to-main-modules)
122+
* [FAQ about this initiative.](https://firebase.google.com/docs/android/kotlin-migration)
125123
*/
126124
@Deprecated(
127125
"Use `com.google.firebase.Firebase.initialize(context, options, name)` from the main module instead.",
@@ -139,7 +137,7 @@ fun Firebase.initialize(context: Context, options: FirebaseOptions, name: String
139137
* respective main modules, and the Kotlin extension (KTX) APIs in
140138
* `com.google.firebase.firebase-common-ktx` are now deprecated. As early as April 2024, we'll no
141139
* longer release KTX modules. For details, see the
142-
* [FAQ about this initiative.](https://firebase.google.com/docs/android/ktx-apis-to-main-modules)
140+
* [FAQ about this initiative.](https://firebase.google.com/docs/android/kotlin-migration)
143141
*/
144142
@Deprecated(
145143
"Use `com.google.firebase.Firebase.options` from the main module instead.",

firebase-config/CHANGELOG.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22
* [changed] Added Kotlin extensions (KTX) APIs from `com.google.firebase:firebase-config-ktx`
33
to `com.google.firebase:firebase-config` under the `com.google.firebase.remoteconfig` package.
44
For details, see the
5-
[FAQ about this initiative](https://firebase.google.com/docs/android/ktx-apis-to-main-modules)
5+
[FAQ about this initiative](https://firebase.google.com/docs/android/kotlin-migration)
66

77
* [deprecated] All the APIs from `com.google.firebase:firebase-config-ktx` have been added to
88
`com.google.firebase:firebase-config` under the `com.google.firebase.remoteconfig` package,
99
and all the Kotlin extensions (KTX) APIs in `com.google.firebase:firebase-config-ktx` are
1010
now deprecated. As early as April 2024, we'll no longer release KTX modules. For details, see the
11-
[FAQ about this initiative](https://firebase.google.com/docs/android/ktx-apis-to-main-modules)
11+
[FAQ about this initiative](https://firebase.google.com/docs/android/kotlin-migration)
1212

1313

1414
# 21.4.1

0 commit comments

Comments
 (0)