AttachmentManager
Developed by Zaid Mirza and contributors
You can use this lightweight library to implement the attachment feature (taking pictures using the camera, picking up files/images from gallery or file system, or google drive). The library helps you to simplify all the processes related to picking files without worrying about system permissions
Language Support
- English
- Arabic
Warning!
-
This library is build using AndroidX.So, I recommend you to migrate your project to AndroidX otherwise it may cause problem using both androidx and support libs togather.
-
You might face error
Invoke-customs are only supported starting with android 0 --min-api 26.To solve this add below lines in app level build.gradle file.
compileOptions {
sourceCompatibility JavaVersion.VERSION_1_8
targetCompatibility JavaVersion.VERSION_1_8
}Prerequisite
- Add permissions and provider in AndroidManifest.xml
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.CAMERA" /> <provider
android:name="androidx.core.content.FileProvider"
android:authorities="${applicationId}.attachmentmanager"
android:exported="false"
android:grantUriPermissions="true"
tools:replace="android:authorities">
<meta-data
android:name="android.support.FILE_PROVIDER_PATHS"
android:resource="@xml/file_provider"
tools:replace="android:resource" />
</provider>- Create file_provider.xml in res/xml
<?xml version="1.0" encoding="utf-8"?>
<paths>
<external-path
name="myApp"
path="Download/" />
<external-files-path
name="images"
path="Pictures" />
</paths>- If you are targeting Android 11+, you need to add following queries in AndroidManifest.xml
<queries>
<intent>
<action android:name="android.intent.action.OPEN_DOCUMENT" />
<!-- If you don't know the MIME type in advance, set "mimeType" to "*/*". -->
<data android:mimeType="*/*" />
</intent>
<intent>
<action android:name="android.intent.action.PICK" />
<!-- If you don't know the MIME type in advance, set "mimeType" to "*/*". -->
<data android:mimeType="*/*" />
</intent>
</queries>
- Update project level build.gradle file.
allprojects {
repositories {
jcenter()
maven { url "https://jitpack.io" } //Make sure to add this in your project
}
} implementation 'com.github.Zaid-Mirza:AttachmentManager:2.0.1'Usage
- Initiate AttachmentManager object using builder pattern
Kotlin
private var attachmentManager: AttachmentManager? = null
var gallery = arrayOf("image/png",
"image/jpg",
"image/jpeg")
var files = arrayOf("application/msword",
"application/vnd.openxmlformats-officedocument.wordprocessingml.document", // .ppt & .pptx
"application/pdf")
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
setContentView(R.layout.activity_main)
attachmentManager = AttachmentManager.AttachmentBuilder(this) // must pass Context
.fragment(null) // pass fragment reference if you are in fragment
.setUiTitle("Choose File") // title of dialog or bottom sheet
.allowMultiple(false) // set true if you want make multiple selection, default is false
.asBottomSheet(true) // set true if you need to show selection as bottom sheet, default is as Dialog
.setOptionsTextColor(android.R.color.holo_green_light) // change text color
.setImagesColor(R.color.colorAccent) // change icon color
.hide(HideOption.DOCUMENT) // You can hide any option do you want
.setMaxPhotoSize(200000) // Set max photo size in bytes
.galleryMimeTypes(gallery) // mime types for gallery
.filesMimeTypes(files) // mime types for files
.build(); // Hide any of the three options
}
Java
private AttachmentManager attachmentManager = null;
String[] gallery = {"image/png",
"image/jpg",
"image/jpeg"};
String[] files = { "application/msword",
"application/vnd.openxmlformats-officedocument.wordprocessingml.document", // .ppt & .pptx
"application/pdf"};
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
attachmentManager = new AttachmentManager.AttachmentBuilder(this) // must pass Context
.fragment(null) // pass fragment reference if you are in fragment
.setUiTitle("Choose File") // title of dialog or bottom sheet
.allowMultiple(false) // set true if you want make multiple selection, default is false
.asBottomSheet(true) // set true if you need to show selection as bottom sheet, default is as Dialog
.setOptionsTextColor(android.R.color.holo_green_light) // change text color
.setImagesColor(R.color.colorAccent) // change icon color
.hide(HideOption.DOCUMENT) // You can hide any option do you want
.setMaxPhotoSize(200000) // Set max photo size in bytes
.galleryMimeTypes(gallery) // mime types for gallery
.filesMimeTypes(files) // mime types for files
.build(); // Hide any of the three options
}- Declare registerForActivityResult
Kotlin
private var mLauncher = registerForActivityResult(StartActivityForResult()) { result ->
val list = attachmentManager?.manipulateAttachments(this,result.resultCode,result.data)
Toast.makeText(this, list?.size.toString(), Toast.LENGTH_LONG).show()
}Java
ActivityResultLauncher<Intent> mLauncher = registerForActivityResult(new ActivityResultContracts.StartActivityForResult(), result -> {
ArrayList<AttachmentDetail> list = attachmentManager.manipulateAttachments(this,result.getResultCode(),result.getData());
});- Call openSelection() method to show selection UI and pass ActivityResultLauncher
Kotlin
attachmentManager?.openSelection(mLauncher)Java
attachmentManager.openSelection(mLauncher);- Override onRequestPermissionsResult (Optional)
Kotlin
override fun onRequestPermissionsResult(requestCode: Int, permissions: Array<out String>, grantResults: IntArray) {
attachmentManager?.handlePermissionResponse(requestCode, permissions, grantResults)
}
Java
@Override
public void onRequestPermissionsResult(int requestCode, @NonNull String[] permissions, @NonNull int[] grantResults) {
super.onRequestPermissionsResult(requestCode, permissions, grantResults);
attachmentManager.handlePermissionResponse(requestCode,permissions,grantResults);
}Other Usage
- You can open gallery,camera or file system directly without showing selection UI to user
Kotlin
attachmentManager?.startCamera(mLauncher)
// OR
attachmentManager?.openGallery(mLauncher)
// OR
attachmentManager?.openFilSystem(mLauncher)Java
attachmentManager.startCamera(mLauncher);
// OR
attachmentManager.openGallery(mLauncher);
// OR
attachmentManager.openFilSystem(mLauncher);Note
Any kind of improvements and suggestions are welcomed. Also, if you are using this library in your project then please do provide me your app url. I will list your app here.