@anuradev/capacitor-contacts

Capacitor plugin to get and modify mobile contacts

Install

``bash
npm install @anuradev/capacitor-contacts
npx cap sync
`

API

* checkPermissions()
* requestPermissions()
* getContacts()
* createContact(...)
* addToExistingContact(...)
* deleteContact(...)
* getGroups()
* getContactGroups()
* Interfaces
* Type Aliases

$3

`typescript
checkPermissions() => Promise
`

Returns: Promise<PermissionStatus>

--------------------

$3

`typescript
requestPermissions() => Promise
`

Returns: Promise<PermissionStatus>

--------------------

$3

`typescript
getContacts() => Promise<{ contacts: Contact[]; }>
`

Returns: Promise<{ contacts: Contact[]; }>

--------------------

$3

`typescript
createContact(data: { name?: string; number: string; }) => Promise
`

| Param | Type |
| ---------- | ----------------------------------------------- |
| data | { name?: string; number: string; } |

--------------------

$3

`typescript
addToExistingContact(data: { name?: string; number: string; }) => Promise
`

| Param | Type |
| ---------- | ----------------------------------------------- |
| data | { name?: string; number: string; } |

--------------------

$3

`typescript
deleteContact(data: { contactId: string; }) => Promise
`

| Param | Type |
| ---------- | ----------------------------------- |
| data | { contactId: string; } |

--------------------

$3

`typescript
getGroups() => Promise<{ groups: Group[]; }>
`

Returns: Promise<{ groups: Group[]; }>

--------------------

$3

`typescript
getContactGroups() => Promise<{ [key: string]: Group[]; }>
`

Returns: Promise<{ [key: string]: Group[]; }>

--------------------

$3


#### PermissionStatus

| Prop | Type |
| ------------- | ----------------------------------------------------------- |
| display | PermissionState |


#### Contact

| Prop | Type |
| ---------------------- | --------------------------- |
| contactId | string |
| displayName | string |
| phoneNumbers | PhoneNumber[] |
| emails | EmailAddress[] |
| photoThumbnail | string |
| organizationName | string |
| organizationRole | string |
| birthday | string |


#### PhoneNumber

| Prop | Type |
| ------------ | ------------------- |
| label | string |
| number | string |


#### EmailAddress

| Prop | Type |
| ------------- | ------------------- |
| label | string |
| address | string |


#### Group

| Prop | Type |
| ----------------- | ------------------- |
| groupId | string |
| accountType | string |
| accountName | string |
| title` | string |

$3

#### PermissionState

'prompt' | 'prompt-with-rationale' | 'granted' | 'denied'