An open API service indexing awesome lists of open source software.

https://github.com/huafu/cordova-contact-adapter

An adapter and model for use with cordova contacts plugin
https://github.com/huafu/cordova-contact-adapter

Last synced: 3 months ago
JSON representation

An adapter and model for use with cordova contacts plugin

Awesome Lists containing this project

README

        

# cordova-contact-adapter

An adapter and model for use with cordova contacts plugin

## Installation

* `npm install --save-dev cordova-contact-adapter`
* or with the latest `ember-cli`: `ember install:addon cordova-contact-adapter`

## Using

* Simply use the `cordova-contact` model as you'd simply do with any other `ember-data` model:

```js
// file: app/routes/contacts.js
import Ember from 'ember';

export default Ember.Route.extend({
model: function () {
return this.store.find('cordova-contact');
}
});
```

* When querying for specific contacts on multiple fields, be sure to use the same filter value for all the query parameters:

```js
this.store.find('cordova-contact', {name: 'huafu', nickname: 'huafu', displayName: 'huafu'});
```

Available fields for searching are the same as `cordova.contacts.fieldType`:
- `addresses`
- `birthday`
- `categories`
- `country`
- `department`
- `displayName`
- `emails`
- `familyName`
- `formatted`
- `givenName`
- `honorificPrefix`
- `honorificSuffix`
- `id`
- `ims`
- `locality`
- `middleName`
- `name`
- `nickname`
- `note`
- `organizations`
- `phoneNumbers`
- `photos`
- `postalCode`
- `region`
- `streetAddress`
- `title`
- `urls`

* There are 2 special properties on each model as well as the core ones from cordova contacts plugin:

- `anyName`: to access to the first available name of the contact between all fields from cordova
- `anyPhotoUrl`: to access the first available photo as an URL (normally `file://`)
- `anyPhoneNumber`: to access the first available phone number
- `anyURL`: to access the first available URL
- `anyEmail`: to access the first available email address

## Running Tests

* `ember test`
* `ember test --server`

---
For more information on using ember-cli, visit [http://www.ember-cli.com/](http://www.ember-cli.com/).