android-contact-extractor-library

KO | EN

gitlite — search

#ai-agents #typescript #llm #python #claude-code #ai #mcp #cli #developer-tools #claude #macos #rust

android-contact-extractor-library

★ 20 Open GitHub ↗

Android contact extractor library is entitled to provide, simple contacts extraction API's to fetch contact from 'Contact' application

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Android-Contact-Extractor-Library

[![platform](https://img.shields.io/badge/platform-Android-yellow.svg)](https://www.android.com)
[![API](https://img.shields.io/badge/API-15%2B-brightgreen.svg?style=plastic)](https://android-arsenal.com/api?level=15)
[![License](https://img.shields.io/badge/license-Apache%202-4EB1BA.svg?style=flat-square)](https://www.apache.org/licenses/LICENSE-2.0.html)

Extract all the contacts from android 'Contacts' application by using simple easy-to-use apis. It helps to remove the overhead of querying contact content provider.

## Prerequisites

Add permission in AndriodManifest.xml:

```
<uses-permission android:name="android.permission.READ_CONTACTS"/>
```

## Dependency

Add this to your module's `build.gradle`

Gradle
```
dependencies {
	...
	implementation 'com.coderconsole.cextracter:contact-extractor:1.0.0'
}
```

Maven
```
<dependency>
  <groupId>com.coderconsole.cextracter</groupId>
  <artifactId>contact-extractor</artifactId>
  <version>1.0.0</version>
  <type>pom</type>
</dependency>
```

Ivy
```
<dependency org='com.coderconsole.cextracter' name='contact-extractor' rev='1.0.0'>
  <artifact name='contact-extractor' ext='pom' ></artifact>
</dependency>
```

# Output

Extract all the contacts from android 'Contacts' application by using simple easy-to-use apis. It helps to remove the overhead of querying contact content provider.

Name             |  Phone
:-------------------------:|:-------------------------:
![name](https://cloud.githubusercontent.com/assets/10304040/25949742/35328eec-3676-11e7-84b2-a864b30269ea.png) | ![phone](https://cloud.githubusercontent.com/assets/10304040/25949859/a4cb69f4-3676-11e7-96bf-8231f3694792.png)

## Examples:

###### Extract all the PHONE - Its contains home/work/phone/other contacts within as ``HashSet<String>``

CQuery cQuery = CQuery.getInstance(getActivity());
        cQuery.filter(ICFilter.ONLY_PHONE);
        cQuery.build(new IContact() {
            @Override
            public void onContactSuccess(List<CList> cList) {
                if (cList != null && cList.size() > 0) {
                    CPhone cPhone = cList.getcPhone();
                    HashSet<String> home = cPhone.getHome();
                    HashSet<String> work = cPhone.getWork();
                    HashSet<String> mobile = cPhone.getMobile();
                    HashSet<String> other = cPhone.getOther();
                }

}

@Override
            public void onContactError(Throwable throwable) {

}
        });
        
###### Extract all the Email - It contains home/work/phone/other contacts as simple ``HashSet<String>``

CQuery cQuery = CQuery.getInstance(getActivity());
        cQuery.filter(ICFilter.ONLY_EMAIL);
        cQuery.build(new IContact() {
            @Override
            public void onContactSuccess(List<CList> cList) {
                if (cList != null && cList.size() > 0) {
                      CEmail cEmail = cList.getcEmail();
                      HashSet<String> home = cEmail.getHome();
                      HashSet<String> work = cEmail.getWork();
                      HashSet<String> mobile = cEmail.getMobile();
                      HashSet<String> other = cEmail.getOther();
                }

}

@Override
            public void onContactError(Throwable throwable) {

}
        });
        
###### Extract all the Account - It name and its type e.g name - ``nitiwari.dev@gmail.com/ type - com.google.com``

CQuery cQuery = CQuery.getInstance(getActivity());
        cQuery.filter(ICFilter.ONLY_ACCOUNT);
        cQuery.build(new IContact() {
            @Override
            public void onContactSuccess(List<CList> cList) {
                if (cList != null && cList.size() > 0) {
                       CAccount cAccount = cList.getcAccount();
                }

}

@Override
            public void onContactError(Throwable throwable) {

}
        });

Bingo Thats it !!!. Just change filter types and get the contact information accordingly.

## Acknowledgement
[RxAndroid](https://github.com/ReactiveX/RxAndroid)

## Thank You
Please do follows us on [TWITTER](https://twitter.com/coderconsole) and check out [BLOG](http://www.coderconsole.com/).
#codingIsAnArt

## Licence
        Copyright (C) 2021 Nitesh Tiwari.
  
        Licensed under the Apache License, Version 2.0 (the "License");
        you may not use this file except in compliance with the License.
        You may obtain a copy of the License at
 
                http://www.apache.org/licenses/LICENSE-2.0
 
        Unless required by applicable law or agreed to in writing, software
        distributed under the License is distributed on an "AS IS" BASIS,
        WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
        See the License for the specific language governing permissions and
        limitations under the License.

android-contact-extractor-library

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README