From 3e86988d2099cecd32af2d25c6d66e5bc9c657b8 Mon Sep 17 00:00:00 2001 From: Sam Stern Date: Fri, 18 May 2018 09:26:33 -0700 Subject: [PATCH] 4.0.0 docs Change-Id: I49ba7416bbeecaf21ada7c24f42cb4cbd82a8b54 --- .opensource/project.json | 3 +- README.md | 29 +- .../3.3.1_to_4.0.0/compat_report.html | 897 ++++++++++++++++ .../3.3.1_to_4.0.0/compat_report.html | 653 ++++++++++++ .../3.3.1_to_4.0.0/compat_report.html | 969 ++++++++++++++++++ .../3.3.1_to_4.0.0/compat_report.html | 453 ++++++++ docs/upgrade-to-4.0.md | 30 + 7 files changed, 3017 insertions(+), 17 deletions(-) create mode 100644 docs/compat_reports/firebase-ui-auth/3.3.1_to_4.0.0/compat_report.html create mode 100644 docs/compat_reports/firebase-ui-database/3.3.1_to_4.0.0/compat_report.html create mode 100644 docs/compat_reports/firebase-ui-firestore/3.3.1_to_4.0.0/compat_report.html create mode 100644 docs/compat_reports/firebase-ui-storage/3.3.1_to_4.0.0/compat_report.html create mode 100644 docs/upgrade-to-4.0.md diff --git a/.opensource/project.json b/.opensource/project.json index b756e295a..ab51045f5 100644 --- a/.opensource/project.json +++ b/.opensource/project.json @@ -20,7 +20,8 @@ "storage/README.md", "firestore/README.md", "docs/upgrade-to-2.0.md", - "docs/upgrade-to-3.0.md" + "docs/upgrade-to-3.0.md", + "docs/upgrade-to-4.0.md" ], // Related projects on Github, in the format $owner/$repo[/$subproject] diff --git a/README.md b/README.md index ae5145744..98c730599 100644 --- a/README.md +++ b/README.md @@ -70,6 +70,7 @@ After the project is synchronized, we're ready to start using Firebase functiona If you are using an old version of FirebaseUI and upgrading, please see the appropriate migration guide: +* [Upgrade from 3.3.1 to 4.x.x](./docs/upgrade-to-4.0.md) * [Upgrade from 2.3.0 to 3.x.x](./docs/upgrade-to-3.0.md) * [Upgrade from 1.2.0 to 2.x.x](./docs/upgrade-to-2.0.md) @@ -93,24 +94,20 @@ firebase-ui-storage |--- com.google.firebase:firebase-storage ``` -Each version of FirebaseUI has dependency on a fixed version of these libraries, defined as the variable `firebase_version` -in `common/constants.gradle`. If you are using any dependencies in your app of the form -`implementation 'com.google.firebase:firebase-*:x.y.z'` or -`implementation 'com.google.android.gms:play-services-*:x.y.z'` -you need to make sure that you use the same version that your chosen version of FirebaseUI requires. +As of version `15.0.0`, Firebase and Google Play services libraries have independent, semantic +versions. This means that FirebaseUI has independent dependencies on each of the libraries above. +For best results, your app should depend on a version of each dependency with the same major +version number as the version used by FirebaseUI. -For convenience, here are some recent examples: - -| FirebaseUI Version | Firebase/Play Services Version | -|--------------------|--------------------------------| -| 3.3.1 | 15.0.0 | -| 3.3.0 | 12.0.1 | -| 3.2.2 | 11.8.0 | -| 3.1.3 | 11.8.0 | -| 3.0.0 | 11.4.2 | -| 2.4.0 | 11.4.0 | -| 1.1.1 | 10.0.0 or 10.0.1 | +As of version `4.0.0`, FirebaseUI has the following dependency versions: +| Library | Version | +|----------------------|--------------------------------| +| `firebase-auth` | 15.1.0 | +| `play-services-auth` | 15.0.1 | +| `firebase-database` | 15.0.1 | +| `firebase-firestore` | 16.0.0 | +| `firebase-storage` | 15.0.2 | ### Upgrading dependencies diff --git a/docs/compat_reports/firebase-ui-auth/3.3.1_to_4.0.0/compat_report.html b/docs/compat_reports/firebase-ui-auth/3.3.1_to_4.0.0/compat_report.html new file mode 100644 index 000000000..517420665 --- /dev/null +++ b/docs/compat_reports/firebase-ui-auth/3.3.1_to_4.0.0/compat_report.html @@ -0,0 +1,897 @@ + + + + + + + + +Codestin Search App + + + +

API compatibility report for the firebase-ui-auth library between 3.3.1 and 4.0.0 versions

+
+Binary
Compatibility +Source
Compatibility +
+
+

Test Info

+ + + + + +
Library Namefirebase-ui-auth
Version #13.3.1
Version #24.0.0
SubjectBinary Compatibility
+

Test Results

+ + + + + + +
Total JARs1
Total Methods / Classes105 / 31
Compatibility74.5%
+

Problem Summary

+ + + + + + + + + + +
SeverityCount
Added Methods-3
Removed MethodsHigh9
Problems with
Data Types		High3
Medium2
Low1
Problems with
Methods		High1
Medium0
Low0
+ +

Added Methods  3 

+classes.jar, CountryListSpinner.class
+package com.firebase.ui.auth.ui.phone
+ +CountryListSpinner.getSelectedCountryInfo ( )  :  CountryInfo +
+ + + +CountryListSpinner.onRestoreInstanceState ( Parcelable state )  :  void +
+ + + +CountryListSpinner.onSaveInstanceState ( )  :  Parcelable +
+ + +
+to the top
+

Removed Methods  9 

+classes.jar, Builder.class
+package com.firebase.ui.auth
+ +AuthUI.IdpConfig.Builder.setParams ( Bundle params )  :  AuthUI.IdpConfig.Builder *DEPRECATED* +
+ + + +AuthUI.IdpConfig.Builder.setPermissions ( List<String> permissions )  :  AuthUI.IdpConfig.Builder *DEPRECATED* +
+ + +
+classes.jar, FacebookBuilder.class
+package com.firebase.ui.auth
+ +AuthUI.IdpConfig.FacebookBuilder.setPermissions ( List p1 )  :  AuthUI.IdpConfig.Builder +
+ + +
+classes.jar, IdpConfig.class
+package com.firebase.ui.auth
+ +AuthUI.IdpConfig.getScopes ( )  :  List<String> *DEPRECATED* +
+ + +
+classes.jar, IdpResponse.class
+package com.firebase.ui.auth
+ +IdpResponse.getErrorCode ( )  :  int *DEPRECATED* +
+ + +
+classes.jar, PlayServicesHelper.class
+package com.firebase.ui.auth.util
+ +PlayServicesHelper.getGoogleApiAvailability ( ) [static]  :  GoogleApiAvailability *DEPRECATED* +
+ + + +PlayServicesHelper.makePlayServicesAvailable ( Activity activity, int requestCode, DialogInterface.OnCancelListener cancelListener ) [static]  :  boolean *DEPRECATED* +
+ + + +PlayServicesHelper.PlayServicesHelper ( ) +
+ + +
+classes.jar, SignInIntentBuilder.class
+package com.firebase.ui.auth
+ +AuthUI.SignInIntentBuilder.setAllowNewEmailAccounts ( boolean enabled )  :  AuthUI.SignInIntentBuilder *DEPRECATED* +
+ + +
+to the top
+ +

Problems with Data Types, High Severity  3 

+classes.jar
+package com.firebase.ui.auth
+ +[+] class AuthUI.IdpConfig  1  +
+ + + +[+] class ResultCodes  1  +
+ + +
classes.jar
+package com.firebase.ui.auth.util
+ +[+] class PlayServicesHelper  1  +
+ + +
to the top
+ +

Problems with Methods, High Severity  1 

+classes.jar, Builder.class
+package com.firebase.ui.auth
+ +[+] AuthUI.IdpConfig.Builder.AuthUI.IdpConfig.Builder ( String providerId ) *DEPRECATED*  1  +
+ + +
to the top
+ +

Problems with Data Types, Medium Severity  2 

+classes.jar
+package com.firebase.ui.auth.ui.credentials
+ +[+] class CredentialSaveActivity  1  +
+ + +
classes.jar
+package com.firebase.ui.auth.ui.idp
+ +[+] class SingleSignInActivity  1  +
+ + +
to the top
+ +

Problems with Data Types, Low Severity  1 

+classes.jar
+package com.firebase.ui.auth
+ +[+] class BuildConfig  1  +
+ + +
to the top
+

Java Archives  1 

+
+classes.jar
+

to the top
+


+

Test Info

+ + + + + +
Library Namefirebase-ui-auth
Version #13.3.1
Version #24.0.0
SubjectSource Compatibility
+

Test Results

+ + + + + + +
Total JARs1
Total Methods / Classes105 / 31
Compatibility74.5%
+

Problem Summary

+ + + + + + + + + + +
SeverityCount
Added Methods-3
Removed MethodsHigh9
Problems with
Data Types		High3
Medium2
Low0
Problems with
Methods		High1
Medium0
Low0
+ +

Added Methods  3 

+classes.jar, CountryListSpinner.class
+package com.firebase.ui.auth.ui.phone
+ +CountryListSpinner.getSelectedCountryInfo ( )  :  CountryInfo +
+ + + +CountryListSpinner.onRestoreInstanceState ( Parcelable state )  :  void +
+ + + +CountryListSpinner.onSaveInstanceState ( )  :  Parcelable +
+ + +
+to the top
+

Removed Methods  9 

+classes.jar, Builder.class
+package com.firebase.ui.auth
+ +AuthUI.IdpConfig.Builder.setParams ( Bundle params )  :  AuthUI.IdpConfig.Builder *DEPRECATED* +
+ + + +AuthUI.IdpConfig.Builder.setPermissions ( List<String> permissions )  :  AuthUI.IdpConfig.Builder *DEPRECATED* +
+ + +
+classes.jar, FacebookBuilder.class
+package com.firebase.ui.auth
+ +AuthUI.IdpConfig.FacebookBuilder.setPermissions ( List p1 )  :  AuthUI.IdpConfig.Builder +
+ + +
+classes.jar, IdpConfig.class
+package com.firebase.ui.auth
+ +AuthUI.IdpConfig.getScopes ( )  :  List<String> *DEPRECATED* +
+ + +
+classes.jar, IdpResponse.class
+package com.firebase.ui.auth
+ +IdpResponse.getErrorCode ( )  :  int *DEPRECATED* +
+ + +
+classes.jar, PlayServicesHelper.class
+package com.firebase.ui.auth.util
+ +PlayServicesHelper.getGoogleApiAvailability ( ) [static]  :  GoogleApiAvailability *DEPRECATED* +
+ + + +PlayServicesHelper.makePlayServicesAvailable ( Activity activity, int requestCode, DialogInterface.OnCancelListener cancelListener ) [static]  :  boolean *DEPRECATED* +
+ + + +PlayServicesHelper.PlayServicesHelper ( ) +
+ + +
+classes.jar, SignInIntentBuilder.class
+package com.firebase.ui.auth
+ +AuthUI.SignInIntentBuilder.setAllowNewEmailAccounts ( boolean enabled )  :  AuthUI.SignInIntentBuilder *DEPRECATED* +
+ + +
+to the top
+ +

Problems with Data Types, High Severity  3 

+classes.jar
+package com.firebase.ui.auth
+ +[+] class AuthUI.IdpConfig  1  +
+ + + +[+] class ResultCodes  1  +
+ + +
classes.jar
+package com.firebase.ui.auth.util
+ +[+] class PlayServicesHelper  1  +
+ + +
to the top
+ +

Problems with Methods, High Severity  1 

+classes.jar, Builder.class
+package com.firebase.ui.auth
+ +[+] AuthUI.IdpConfig.Builder.AuthUI.IdpConfig.Builder ( String providerId ) *DEPRECATED*  1  +
+ + +
to the top
+ +

Problems with Data Types, Medium Severity  2 

+classes.jar
+package com.firebase.ui.auth.ui.credentials
+ +[+] class CredentialSaveActivity  1  +
+ + +
classes.jar
+package com.firebase.ui.auth.ui.idp
+ +[+] class SingleSignInActivity  1  +
+ + +
to the top
+

Java Archives  1 

+
+classes.jar
+

to the top
+


Generated by Java API Compliance Checker 2.1  

+ \ No newline at end of file diff --git a/docs/compat_reports/firebase-ui-database/3.3.1_to_4.0.0/compat_report.html b/docs/compat_reports/firebase-ui-database/3.3.1_to_4.0.0/compat_report.html new file mode 100644 index 000000000..0fb45ae32 --- /dev/null +++ b/docs/compat_reports/firebase-ui-database/3.3.1_to_4.0.0/compat_report.html @@ -0,0 +1,653 @@ + + + + + + + + +Codestin Search App + + + +

API compatibility report for the firebase-ui-database library between 3.3.1 and 4.0.0 versions

+
+Binary
Compatibility +Source
Compatibility +
+
+

Test Info

+ + + + + +
Library Namefirebase-ui-database
Version #13.3.1
Version #24.0.0
SubjectBinary Compatibility
+

Test Results

+ + + + + + +
Total JARs1
Total Methods / Classes81 / 15
Compatibility71.6%
+

Problem Summary

+ + + + + + + + + + +
SeverityCount
Added Methods-0
Removed MethodsHigh1
Problems with
Data Types		High4
Medium0
Low1
Problems with
Methods		High0
Medium0
Low0
+ +

Removed Methods  1 

+classes.jar, ObservableSnapshotArray.class
+package com.firebase.ui.database
+ +ObservableSnapshotArray<T>.notifyListenersOnCancelled ( DatabaseError error )  :  void *DEPRECATED* +
+ + +
+to the top
+ +

Problems with Data Types, High Severity  4 

+classes.jar
+package com.firebase.ui.database
+ +[+] class FirebaseListOptions.Builder<T>  1  +
+ + + +[+] class FirebaseListOptions<T>  1  +
+ + + +[+] class FirebaseRecyclerOptions.Builder<T>  1  +
+ + + +[+] class FirebaseRecyclerOptions<T>  1  +
+ + +
to the top
+ +

Problems with Data Types, Low Severity  1 

+classes.jar
+package com.firebase.ui.database
+ +[+] class BuildConfig  1  +
+ + +
to the top
+

Java Archives  1 

+
+classes.jar
+

to the top
+


+

Test Info

+ + + + + +
Library Namefirebase-ui-database
Version #13.3.1
Version #24.0.0
SubjectSource Compatibility
+

Test Results

+ + + + + + +
Total JARs1
Total Methods / Classes81 / 15
Compatibility71.6%
+

Problem Summary

+ + + + + + + + + + +
SeverityCount
Added Methods-0
Removed MethodsHigh1
Problems with
Data Types		High4
Medium0
Low0
Problems with
Methods		High0
Medium0
Low0
+ +

Removed Methods  1 

+classes.jar, ObservableSnapshotArray.class
+package com.firebase.ui.database
+ +ObservableSnapshotArray<T>.notifyListenersOnCancelled ( DatabaseError error )  :  void *DEPRECATED* +
+ + +
+to the top
+ +

Problems with Data Types, High Severity  4 

+classes.jar
+package com.firebase.ui.database
+ +[+] class FirebaseListOptions.Builder<T>  1  +
+ + + +[+] class FirebaseListOptions<T>  1  +
+ + + +[+] class FirebaseRecyclerOptions.Builder<T>  1  +
+ + + +[+] class FirebaseRecyclerOptions<T>  1  +
+ + +
to the top
+

Java Archives  1 

+
+classes.jar
+

to the top
+


Generated by Java API Compliance Checker 2.1  

+ \ No newline at end of file diff --git a/docs/compat_reports/firebase-ui-firestore/3.3.1_to_4.0.0/compat_report.html b/docs/compat_reports/firebase-ui-firestore/3.3.1_to_4.0.0/compat_report.html new file mode 100644 index 000000000..db61790a7 --- /dev/null +++ b/docs/compat_reports/firebase-ui-firestore/3.3.1_to_4.0.0/compat_report.html @@ -0,0 +1,969 @@ + + + + + + + + +Codestin Search App + + + +

API compatibility report for the firebase-ui-firestore library between 3.3.1 and 4.0.0 versions

+
+Binary
Compatibility +Source
Compatibility +
+
+

Test Info

+ + + + + +
Library Namefirebase-ui-firestore
Version #13.3.1
Version #24.0.0
SubjectBinary Compatibility
+

Test Results

+ + + + + + +
Total JARs1
Total Methods / Classes66 / 16
Compatibility71.8%
+

Problem Summary

+ + + + + + + + + + +
SeverityCount
Added Methods-27
Removed MethodsHigh3
Problems with
Data Types		High2
Medium0
Low1
Problems with
Methods		High0
Medium0
Low0
+ +

Added Methods  27 

+classes.jar, Builder.class
+package com.firebase.ui.firestore
+ +FirestoreRecyclerOptions.Builder<T>.setQuery ( Query query, MetadataChanges changes, Class<T> modelClass )  :  FirestoreRecyclerOptions.Builder<T> +
+ + + +FirestoreRecyclerOptions.Builder<T>.setQuery ( Query query, MetadataChanges changes, SnapshotParser<T> parser )  :  FirestoreRecyclerOptions.Builder<T> +
+ + +
+classes.jar, Builder.class
+package com.firebase.ui.firestore.paging
+ +FirestorePagingOptions.Builder<T>.build ( )  :  FirestorePagingOptions<T> +
+ + + +FirestorePagingOptions.Builder<T>.FirestorePagingOptions.Builder ( )  :  public +
+ + + +FirestorePagingOptions.Builder<T>.setDiffCallback ( DiffUtil.ItemCallback<DocumentSnapshot> diffCallback )  :  FirestorePagingOptions.Builder<T> +
+ + + +FirestorePagingOptions.Builder<T>.setLifecycleOwner ( LifecycleOwner owner )  :  FirestorePagingOptions.Builder<T> +
+ + + +FirestorePagingOptions.Builder<T>.setQuery ( Query query, PagedList.Config config, Class<T> modelClass )  :  FirestorePagingOptions.Builder<T> +
+ + + +FirestorePagingOptions.Builder<T>.setQuery ( Query query, PagedList.Config config, SnapshotParser<T> parser )  :  FirestorePagingOptions.Builder<T> +
+ + + +FirestorePagingOptions.Builder<T>.setQuery ( Query query, Source source, PagedList.Config config, Class<T> modelClass )  :  FirestorePagingOptions.Builder<T> +
+ + + +FirestorePagingOptions.Builder<T>.setQuery ( Query query, Source source, PagedList.Config config, SnapshotParser<T> parser )  :  FirestorePagingOptions.Builder<T> +
+ + +
+classes.jar, Factory.class
+package com.firebase.ui.firestore.paging
+ +FirestoreDataSource.Factory.create ( )  :  DataSource<PageKey,DocumentSnapshot> +
+ + + +FirestoreDataSource.Factory.FirestoreDataSource.Factory ( Query query, Source source ) +
+ + +
+classes.jar, FirestoreArray.class
+package com.firebase.ui.firestore
+ +FirestoreArray<T>.FirestoreArray ( Query query, MetadataChanges changes, SnapshotParser<T> parser )  :  public +
+ + +
+classes.jar, FirestorePagingAdapter.class
+package com.firebase.ui.firestore.paging
+ +FirestorePagingAdapter<T,VH>.FirestorePagingAdapter ( FirestorePagingOptions<T> options )  :  public +
+ + + +FirestorePagingAdapter<T,VH>.onBindViewHolder ( VH holder, int position )  :  void +
+ + + +FirestorePagingAdapter<T,VH>.onBindViewHolder ( VH p1, int p2, T p3 ) [abstract]  :  void +
+ + + +FirestorePagingAdapter<T,VH>.onLoadingStateChanged ( LoadingState state )  :  void +
+ + + +FirestorePagingAdapter<T,VH>.retry ( )  :  void +
+ + + +FirestorePagingAdapter<T,VH>.startListening ( )  :  void +
+ + + +FirestorePagingAdapter<T,VH>.stopListening ( )  :  void +
+ + +
+classes.jar, FirestorePagingAdapter_LifecycleAdapter.class
+package com.firebase.ui.firestore.paging
+ +FirestorePagingAdapter_LifecycleAdapter.callMethods ( LifecycleOwner owner, Lifecycle.Event event, boolean onAny, MethodCallsLogger logger )  :  void +
+ + +
+classes.jar, FirestorePagingOptions.class
+package com.firebase.ui.firestore.paging
+ +FirestorePagingOptions<T>.getData ( )  :  LiveData<PagedList<DocumentSnapshot>> +
+ + + +FirestorePagingOptions<T>.getDiffCallback ( )  :  DiffUtil.ItemCallback<DocumentSnapshot> +
+ + + +FirestorePagingOptions<T>.getOwner ( )  :  LifecycleOwner +
+ + + +FirestorePagingOptions<T>.getParser ( )  :  SnapshotParser<T> +
+ + +
+classes.jar, LoadingState.class
+package com.firebase.ui.firestore.paging
+ +LoadingState.valueOf ( String name ) [static]  :  LoadingState +
+ + + +LoadingState.values ( ) [static]  :  LoadingState[ ] +
+ + +
+to the top
+

Removed Methods  3 

+classes.jar, Builder.class
+package com.firebase.ui.firestore
+ +FirestoreRecyclerOptions.Builder<T>.setQuery ( Query query, QueryListenOptions options, Class<T> modelClass )  :  FirestoreRecyclerOptions.Builder<T> +
+ + + +FirestoreRecyclerOptions.Builder<T>.setQuery ( Query query, QueryListenOptions options, SnapshotParser<T> parser )  :  FirestoreRecyclerOptions.Builder<T> +
+ + +
+classes.jar, FirestoreArray.class
+package com.firebase.ui.firestore
+ +FirestoreArray<T>.FirestoreArray ( Query query, QueryListenOptions options, SnapshotParser<T> parser )  :  public +
+ + +
+to the top
+ +

Problems with Data Types, High Severity  2 

+classes.jar
+package com.firebase.ui.firestore
+ +[+] class FirestoreRecyclerOptions.Builder<T>  1  +
+ + + +[+] class FirestoreRecyclerOptions<T>  1  +
+ + +
to the top
+ +

Problems with Data Types, Low Severity  1 

+classes.jar
+package com.firebase.ui.firestore
+ +[+] class BuildConfig  1  +
+ + +
to the top
+

Java Archives  1 

+
+classes.jar
+

to the top
+


+

Test Info

+ + + + + +
Library Namefirebase-ui-firestore
Version #13.3.1
Version #24.0.0
SubjectSource Compatibility
+

Test Results

+ + + + + + +
Total JARs1
Total Methods / Classes66 / 16
Compatibility71.8%
+

Problem Summary

+ + + + + + + + + + +
SeverityCount
Added Methods-27
Removed MethodsHigh3
Problems with
Data Types		High2
Medium0
Low0
Problems with
Methods		High0
Medium0
Low0
+ +

Added Methods  27 

+classes.jar, Builder.class
+package com.firebase.ui.firestore
+ +FirestoreRecyclerOptions.Builder<T>.setQuery ( Query query, MetadataChanges changes, Class<T> modelClass )  :  FirestoreRecyclerOptions.Builder<T> +
+ + + +FirestoreRecyclerOptions.Builder<T>.setQuery ( Query query, MetadataChanges changes, SnapshotParser<T> parser )  :  FirestoreRecyclerOptions.Builder<T> +
+ + +
+classes.jar, Builder.class
+package com.firebase.ui.firestore.paging
+ +FirestorePagingOptions.Builder<T>.build ( )  :  FirestorePagingOptions<T> +
+ + + +FirestorePagingOptions.Builder<T>.FirestorePagingOptions.Builder ( )  :  public +
+ + + +FirestorePagingOptions.Builder<T>.setDiffCallback ( DiffUtil.ItemCallback<DocumentSnapshot> diffCallback )  :  FirestorePagingOptions.Builder<T> +
+ + + +FirestorePagingOptions.Builder<T>.setLifecycleOwner ( LifecycleOwner owner )  :  FirestorePagingOptions.Builder<T> +
+ + + +FirestorePagingOptions.Builder<T>.setQuery ( Query query, PagedList.Config config, Class<T> modelClass )  :  FirestorePagingOptions.Builder<T> +
+ + + +FirestorePagingOptions.Builder<T>.setQuery ( Query query, PagedList.Config config, SnapshotParser<T> parser )  :  FirestorePagingOptions.Builder<T> +
+ + + +FirestorePagingOptions.Builder<T>.setQuery ( Query query, Source source, PagedList.Config config, Class<T> modelClass )  :  FirestorePagingOptions.Builder<T> +
+ + + +FirestorePagingOptions.Builder<T>.setQuery ( Query query, Source source, PagedList.Config config, SnapshotParser<T> parser )  :  FirestorePagingOptions.Builder<T> +
+ + +
+classes.jar, Factory.class
+package com.firebase.ui.firestore.paging
+ +FirestoreDataSource.Factory.create ( )  :  DataSource<PageKey,DocumentSnapshot> +
+ + + +FirestoreDataSource.Factory.FirestoreDataSource.Factory ( Query query, Source source ) +
+ + +
+classes.jar, FirestoreArray.class
+package com.firebase.ui.firestore
+ +FirestoreArray<T>.FirestoreArray ( Query query, MetadataChanges changes, SnapshotParser<T> parser )  :  public +
+ + +
+classes.jar, FirestorePagingAdapter.class
+package com.firebase.ui.firestore.paging
+ +FirestorePagingAdapter<T,VH>.FirestorePagingAdapter ( FirestorePagingOptions<T> options )  :  public +
+ + + +FirestorePagingAdapter<T,VH>.onBindViewHolder ( VH holder, int position )  :  void +
+ + + +FirestorePagingAdapter<T,VH>.onBindViewHolder ( VH p1, int p2, T p3 ) [abstract]  :  void +
+ + + +FirestorePagingAdapter<T,VH>.onLoadingStateChanged ( LoadingState state )  :  void +
+ + + +FirestorePagingAdapter<T,VH>.retry ( )  :  void +
+ + + +FirestorePagingAdapter<T,VH>.startListening ( )  :  void +
+ + + +FirestorePagingAdapter<T,VH>.stopListening ( )  :  void +
+ + +
+classes.jar, FirestorePagingAdapter_LifecycleAdapter.class
+package com.firebase.ui.firestore.paging
+ +FirestorePagingAdapter_LifecycleAdapter.callMethods ( LifecycleOwner owner, Lifecycle.Event event, boolean onAny, MethodCallsLogger logger )  :  void +
+ + +
+classes.jar, FirestorePagingOptions.class
+package com.firebase.ui.firestore.paging
+ +FirestorePagingOptions<T>.getData ( )  :  LiveData<PagedList<DocumentSnapshot>> +
+ + + +FirestorePagingOptions<T>.getDiffCallback ( )  :  DiffUtil.ItemCallback<DocumentSnapshot> +
+ + + +FirestorePagingOptions<T>.getOwner ( )  :  LifecycleOwner +
+ + + +FirestorePagingOptions<T>.getParser ( )  :  SnapshotParser<T> +
+ + +
+classes.jar, LoadingState.class
+package com.firebase.ui.firestore.paging
+ +LoadingState.valueOf ( String name ) [static]  :  LoadingState +
+ + + +LoadingState.values ( ) [static]  :  LoadingState[ ] +
+ + +
+to the top
+

Removed Methods  3 

+classes.jar, Builder.class
+package com.firebase.ui.firestore
+ +FirestoreRecyclerOptions.Builder<T>.setQuery ( Query query, QueryListenOptions options, Class<T> modelClass )  :  FirestoreRecyclerOptions.Builder<T> +
+ + + +FirestoreRecyclerOptions.Builder<T>.setQuery ( Query query, QueryListenOptions options, SnapshotParser<T> parser )  :  FirestoreRecyclerOptions.Builder<T> +
+ + +
+classes.jar, FirestoreArray.class
+package com.firebase.ui.firestore
+ +FirestoreArray<T>.FirestoreArray ( Query query, QueryListenOptions options, SnapshotParser<T> parser )  :  public +
+ + +
+to the top
+ +

Problems with Data Types, High Severity  2 

+classes.jar
+package com.firebase.ui.firestore
+ +[+] class FirestoreRecyclerOptions.Builder<T>  1  +
+ + + +[+] class FirestoreRecyclerOptions<T>  1  +
+ + +
to the top
+

Java Archives  1 

+
+classes.jar
+

to the top
+


Generated by Java API Compliance Checker 2.1  

+ \ No newline at end of file diff --git a/docs/compat_reports/firebase-ui-storage/3.3.1_to_4.0.0/compat_report.html b/docs/compat_reports/firebase-ui-storage/3.3.1_to_4.0.0/compat_report.html new file mode 100644 index 000000000..1e925bd81 --- /dev/null +++ b/docs/compat_reports/firebase-ui-storage/3.3.1_to_4.0.0/compat_report.html @@ -0,0 +1,453 @@ + + + + + + + + +Codestin Search App + + + +

API compatibility report for the firebase-ui-storage library between 3.3.1 and 4.0.0 versions

+
+Binary
Compatibility +Source
Compatibility +
+
+

Test Info

+ + + + + +
Library Namefirebase-ui-storage
Version #13.3.1
Version #24.0.0
SubjectBinary Compatibility
+

Test Results

+ + + + + + +
Total JARs1
Total Methods / Classes9 / 3
Compatibility100%
+

Problem Summary

+ + + + + + + + + + +
SeverityCount
Added Methods-0
Removed MethodsHigh0
Problems with
Data Types		High0
Medium0
Low1
Problems with
Methods		High0
Medium0
Low0
+ + +

Problems with Data Types, Low Severity  1 

+classes.jar
+package com.firebase.ui.storage
+ +[+] class BuildConfig  1  +
+ + +
to the top
+

Java Archives  1 

+
+classes.jar
+

to the top
+


+

Test Info

+ + + + + +
Library Namefirebase-ui-storage
Version #13.3.1
Version #24.0.0
SubjectSource Compatibility
+

Test Results

+ + + + + + +
Total JARs1
Total Methods / Classes9 / 3
Compatibility100%
+

Problem Summary

+ + + + + + + + + + +
SeverityCount
Added Methods-0
Removed MethodsHigh0
Problems with
Data Types		High0
Medium0
Low0
Problems with
Methods		High0
Medium0
Low0
+ +

Java Archives  1 

+
+classes.jar
+

to the top
+


Generated by Java API Compliance Checker 2.1  

+ \ No newline at end of file diff --git a/docs/upgrade-to-4.0.md b/docs/upgrade-to-4.0.md new file mode 100644 index 000000000..558cb9072 --- /dev/null +++ b/docs/upgrade-to-4.0.md @@ -0,0 +1,30 @@ +# Upgrading to FirebaseUI 4.0 + +This document outlines the key _breaking_ changes made between versions `3.3.1` and `4.0.0` as well +as suggested upgrade paths. This is not a comprehensive list of all features or bug fixes, please +reference the [release notes][release-notes] for that information. + +For a full, machine-generated compatibility report see the `docs/compat_reports` folder. + +## Auth + +* Removed all previously `@Deprecated` methods on `AuthUI.IdpConfig.Builder`, `AuthUI.IdpConfig`, + `IdpResponse`, and `AuthUI.SignInIntentBuilder`. Most of the deprecated methods have to do + with configuring the FirebaseUI sign-in Intent and the replacements can be seen in the `README`. + +## Realtime Database + +* No breaking changes. + +## Cloud Firestore + +* Adopt the breaking changes from the `firebase-firestore` library version `16.0.0`. The primary + breaking change is the removal of `QueryListenOptions`, which has been replaced by the + `MetadataChanges` enum. See the [firebase release notes][firebase-0502] for more information. + +## Cloud Storage + +* No breaking changes. + +[firebase-0502]: https://firebase.google.com/support/release-notes/android#20180502 +[release-notes]: https://github.com/firebase/FirebaseUI-Android/releases/tag/4.0.0