-
Notifications
You must be signed in to change notification settings - Fork 627
Restructure docs for KTX #314
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
# Firebase Android SDK | ||
|
||
The Firebase SDK for Android is the official way to add Firebase to your | ||
Android app. To get started, visit the [setup instructions][android-setup]. | ||
|
||
## Open Source | ||
|
||
This repository includes the following Firebase SDKs for Android: | ||
|
||
* `firebase-common` | ||
* `firebase-database` | ||
* `firebase-firestore` | ||
* `firebase-functions` | ||
* `firebase-inappmessaging-display` | ||
* `firebase-storage` | ||
|
||
For more information on building the SDKs from source or contributing, | ||
visit the [main README][main-readme]. | ||
|
||
## Kotlin Extensions | ||
|
||
The following Firebase SDKs for Android have Kotlin extension libraries | ||
that allow you to write more idiomatic Kotlin code when using Firebase | ||
in your app: | ||
|
||
* [`firebase-common`](./ktx/common.md) | ||
* [`firebase-firestore`](./ktx/firestore.md) | ||
|
||
[android-setup]: https://firebase.google.com/docs/android/setup | ||
[main-readme]: https://github.com/firebase/firebase-android-sdk/blob/master/README.md |
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
# Firebase Common Kotlin Extensions | ||
|
||
## Getting Started | ||
|
||
To use the Firebase Common Android SDK with Kotlin Extensions, add the following | ||
to your app's `build.gradle` file: | ||
|
||
```groovy | ||
// See maven.google.com for the latest versions | ||
// This library transitively includes the firebase-common library | ||
implementation 'com.google.firebase:firebase-common-ktx:$VERSION' | ||
``` | ||
|
||
## Features | ||
|
||
### Get the default FirebaseApp and FirebaseOptions | ||
|
||
**Kotlin** | ||
```kotlin | ||
val defaultApp = FirebaseApp.getInstance() | ||
val defaultOptions = defaultApp.options | ||
``` | ||
|
||
**Kotlin + KTX** | ||
```kotlin | ||
val defaultApp = Firebase.app | ||
val defaultOptions = Firebase.options | ||
``` | ||
|
||
### Initialize a FirebaseApp | ||
|
||
**Kotlin** | ||
```kotlin | ||
val options = FirebaseApp.getInstance().options | ||
val anotherApp = FirebaseApp.initializeApp(context, options, "myApp") | ||
``` | ||
|
||
**Kotlin + KTX** | ||
```kotlin | ||
var anotherApp = Firebase.initialize(context, Firebase.options, "myApp") | ||
``` | ||
|
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,70 @@ | ||
# Firestore Kotlin Extensions | ||
|
||
## Getting Started | ||
|
||
To use the Cloud Firestore Android SDK with Kotlin Extensions, add the following | ||
to your app's `build.gradle` file: | ||
|
||
```groovy | ||
// See maven.google.com for the latest versions | ||
// This library transitively includes the firebase-firestore library | ||
implementation 'com.google.firebase:firebase-firestore-ktx:$VERSION' | ||
``` | ||
|
||
## Features | ||
|
||
### Get an instance of FirebaseFirestore | ||
|
||
**Kotlin** | ||
```kotlin | ||
val firestore = FirebaseFirestore.getInstance() | ||
val anotherFirestore = FirebaseFirestore.getInstance(FirebaseApp.getInstance("myApp")) | ||
``` | ||
|
||
**Kotlin + KTX** | ||
```kotlin | ||
val firestore = Firebase.firestore | ||
val anotherFirestore = Firebase.firestore(Firebase.app("myApp")) | ||
``` | ||
|
||
### Convert a DocumentSnapshot field to a POJO | ||
|
||
**Kotlin** | ||
```kotlin | ||
val snapshot: DocumentSnapshot = ... | ||
val myObject = snapshot.get("fieldPath", MyClass::class.java) | ||
``` | ||
|
||
**Kotlin + KTX** | ||
```kotlin | ||
val snapshot: DocumentSnapshot = ... | ||
val myObject = snapshot.get<MyClass>("fieldPath") | ||
``` | ||
|
||
### Convert a DocumentSnapshot to a POJO | ||
|
||
**Kotlin** | ||
```kotlin | ||
val snapshot: DocumentSnapshot = ... | ||
val myObject = snapshot.toObject(MyClass::class.java) | ||
``` | ||
|
||
**Kotlin + KTX** | ||
```kotlin | ||
val snapshot: DocumentSnapshot = ... | ||
val myObject = snapshot.toObject<MyClass>() | ||
``` | ||
|
||
### Convert a QuerySnapshot to a list of POJOs | ||
|
||
**Kotlin** | ||
```kotlin | ||
val snapshot: QuerySnapshot = ... | ||
val objectList = snapshot.toObjects(MyClass::class.java) | ||
``` | ||
|
||
**Kotlin + KTX** | ||
```kotlin | ||
val snapshot: QuerySnapshot = ... | ||
val objectList = snapshot.toObjects<MyClass>() | ||
``` |
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.
Uh oh!
There was an error while loading. Please reload this page.