Skip to content

feat(android): Implement capacitor bridge #3

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.

Sign up for GitHub

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 15 commits into from
Feb 26, 2025
Merged

feat(android): Implement capacitor bridge #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
0235145
feat: New android bridge in Kotlin
OS-pedrogustavobilro Feb 20, 2025
c7bffac
chore: Add android native library
OS-pedrogustavobilro Feb 20, 2025
cd9a5d5
docs: update Directory definitions
OS-pedrogustavobilro Feb 21, 2025
bbe2671
chore: Add flag on sample app manifest
OS-pedrogustavobilro Feb 21, 2025
7395d0f
chore: Unify errors
OS-pedrogustavobilro Feb 21, 2025
fe0227d
fix: readFileInChunks callback in Android
OS-pedrogustavobilro Feb 21, 2025
0520bee
chore: Remove unused files
OS-pedrogustavobilro Feb 21, 2025
6163250
refactor: minor readability improvements
OS-pedrogustavobilro Feb 21, 2025
80f447d
Merge branch 'development' into feat/android-bridge
OS-pedrogustavobilro Feb 25, 2025
6d20e1a
fix: error message
OS-pedrogustavobilro Feb 25, 2025
29daba4
chore: Update android build configuration
OS-pedrogustavobilro Feb 25, 2025
856eda3
chore: fix typo
OS-pedrogustavobilro Feb 25, 2025
d3d5b41
docs: Update directories description
OS-pedrogustavobilro Feb 26, 2025
970bcc7
refactor: Minor readability improvements
OS-pedrogustavobilro Feb 26, 2025
64e2311
refactor: Minor improvements
OS-pedrogustavobilro Feb 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions packages/capacitor-plugin/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -589,17 +589,17 @@ Callback for receiving chunks read from a file, or error if something went wrong

#### Directory

| Members | Value | Description | Since |
| --------------------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- |
| **`Documents`** | <code>'DOCUMENTS'</code> | The Documents directory. On iOS it's the app's documents directory. Use this directory to store user-generated content. On Android it's the Public Documents folder, so it's accessible from other apps. It's not accesible on Android 10 unless the app enables legacy External Storage by adding `android:requestLegacyExternalStorage="true"` in the `application` tag in the `AndroidManifest.xml`. On Android 11 or newer the app can only access the files/folders the app created. | 1.0.0 |
| **`Data`** | <code>'DATA'</code> | The Data directory. On iOS it will use the Documents directory. On Android it's the directory holding application files. Files will be deleted when the application is uninstalled. | 1.0.0 |
| **`Library`** | <code>'LIBRARY'</code> | The Library directory. On iOS it will use the Library directory. On Android it's the directory holding application files. Files will be deleted when the application is uninstalled. | 1.1.0 |
| **`Cache`** | <code>'CACHE'</code> | The Cache directory. Can be deleted in cases of low memory, so use this directory to write app-specific files. that your app can re-create easily. | 1.0.0 |
| **`External`** | <code>'EXTERNAL'</code> | The external directory. On iOS it will use the Documents directory. On Android it's the directory on the primary shared/external storage device where the application can place persistent files it owns. These files are internal to the applications, and not typically visible to the user as media. Files will be deleted when the application is uninstalled. | 1.0.0 |
| **`ExternalStorage`** | <code>'EXTERNAL_STORAGE'</code> | The external storage directory. On iOS it will use the Documents directory. On Android it's the primary shared/external storage directory. It's not accesible on Android 10 unless the app enables legacy External Storage by adding `android:requestLegacyExternalStorage="true"` in the `application` tag in the `AndroidManifest.xml`. It's not accesible on Android 11 or newer. | 1.0.0 |
| **`ExternalCache`** | <code>'EXTERNAL_CACHE'</code> | The external cache directory. Android ONly On Android it's the primary shared/external cache. It's not accesible on Android 10 unless the app enables legacy External Storage by adding `android:requestLegacyExternalStorage="true"` in the `application` tag in the `AndroidManifest.xml`. It's not accesible on Android 11 or newer. | 7.1.0 |
| **`LibraryNoCloud`** | <code>'LIBRARY_NO_CLOUD'</code> | iOS only It maps to Library/NoCloud directory Files will be deleted when the application is uninstalled. | 7.1.0 |
| **`Temporary`** | <code>'TEMPORARY'</code> | iOS only The tmp/ directory. Files will be deleted when the application is uninstalled. | 7.1.0 |
| Members | Value | Description | Since |
| --------------------- | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----- |
| **`Documents`** | <code>'DOCUMENTS'</code> | The Documents directory. On iOS it's the app's documents directory. Use this directory to store user-generated content. On Android it's the Public Documents folder, so it's accessible from other apps. It's not accessible on Android 10 unless the app enables legacy External Storage by adding `android:requestLegacyExternalStorage="true"` in the `application` tag in the `AndroidManifest.xml`. On Android 11 or newer the app can only access the files/folders the app created. | 1.0.0 |
| **`Data`** | <code>'DATA'</code> | The Data directory. On iOS it will use the Documents directory. On Android it's the directory holding application files. Files will be deleted when the application is uninstalled. | 1.0.0 |
| **`Library`** | <code>'LIBRARY'</code> | The Library directory. On iOS it will use the Library directory. On Android it's the directory holding application files. Files will be deleted when the application is uninstalled. | 1.1.0 |
| **`Cache`** | <code>'CACHE'</code> | The Cache directory. Can be deleted in cases of low memory, so use this directory to write app-specific files. that your app can re-create easily. | 1.0.0 |
| **`External`** | <code>'EXTERNAL'</code> | The external directory. On iOS it will use the Documents directory. On Android it's the directory on the primary shared/external storage device where the application can place persistent files it owns. These files are internal to the applications, and not typically visible to the user as media. Files will be deleted when the application is uninstalled. | 1.0.0 |
| **`ExternalStorage`** | <code>'EXTERNAL_STORAGE'</code> | The external storage directory. On iOS it will use the Documents directory. On Android it's the primary shared/external storage directory. It's not accessible on Android 10 unless the app enables legacy External Storage by adding `android:requestLegacyExternalStorage="true"` in the `application` tag in the `AndroidManifest.xml`. It's not accessible on Android 11 or newer. | 1.0.0 |
| **`ExternalCache`** | <code>'EXTERNAL_CACHE'</code> | The external cache directory. On iOS it will use the Documents directory. On Android it's the primary shared/external cache. | 7.1.0 |
| **`LibraryNoCloud`** | <code>'LIBRARY_NO_CLOUD'</code> | The Library directory without cloud backup. Used in iOS. On Android it's the directory holding application files. | 7.1.0 |
| **`Temporary`** | <code>'TEMPORARY'</code> | A temporary directory for iOS. On Android it's the directory holding the application cache. | 7.1.0 |


#### Encoding
Expand Down
8 changes: 3 additions & 5 deletions packages/capacitor-plugin/android/build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ ext {
androidxAppCompatVersion = project.hasProperty('androidxAppCompatVersion') ? rootProject.ext.androidxAppCompatVersion : '1.7.0'
androidxJunitVersion = project.hasProperty('androidxJunitVersion') ? rootProject.ext.androidxJunitVersion : '1.2.1'
androidxEspressoCoreVersion = project.hasProperty('androidxEspressoCoreVersion') ? rootProject.ext.androidxEspressoCoreVersion : '3.6.1'
playServicesLocationVersion = project.hasProperty('playServicesLocationVersion') ? rootProject.ext.playServicesLocationVersion : '21.3.0'
}

buildscript {
Expand All @@ -22,7 +21,7 @@ apply plugin: 'com.android.library'
apply plugin: 'kotlin-android'

android {
namespace "com.capacitorjs.plugins.geolocation"
namespace "com.capacitorjs.plugins.filesystem"
compileSdk project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 35
defaultConfig {
minSdkVersion project.hasProperty('minSdkVersion') ? rootProject.ext.minSdkVersion : 23
Expand Down Expand Up @@ -59,12 +58,11 @@ repositories {
dependencies {
implementation fileTree(dir: 'libs', include: ['*.jar'])
//implementation("io.ionic.libs:ionfilesystem-android:1.0.0")
implementation project(':tmp-native-lib-android')
implementation project(':capacitor-android')
implementation "androidx.appcompat:appcompat:$androidxAppCompatVersion"

implementation 'com.google.code.gson:gson:2.10.1'
implementation("org.jetbrains.kotlinx:kotlinx-coroutines-play-services:1.6.4")
implementation "com.google.android.gms:play-services-location:$playServicesLocationVersion"
implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.6.4")

testImplementation "junit:junit:$junitVersion"
androidTestImplementation "androidx.test.ext:junit:$androidxJunitVersion"
Expand Down
4 changes: 4 additions & 0 deletions packages/capacitor-plugin/android/settings.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,6 @@
include ':capacitor-android'
project(':capacitor-android').projectDir = new File('../node_modules/@capacitor/android/capacitor')

// this is here until native library is published; TODO remove this once that happens.
include ':tmp-native-lib-android'
project(':tmp-native-lib-android').projectDir = new File('../../tmp_native_lib_android')
Loading
Loading