open-index/open-npm huggingface dataset:
npm package: @nadavhalfon/capacitor-native-contacts
Description: Capacitor plugin for picking contact from native contacts list
Author: Nadav Halfon
Latest version: 6.0.0

# capacitor-native-contacts

Capacitor plugin for picking contact from native contacts list

## Install

```bash
npm install capacitor-native-contacts
npx cap sync
```

## API

<docgen-index>

* [`echo(...)`](#echo)
* [`open()`](#open)
* [Interfaces](#interfaces)

</docgen-index>

<docgen-api>
<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->

### echo(...)

```typescript
echo(options: { value: string; }) => Promise<{ value: string; }>
```

| Param         | Type                            |
| ------------- | ------------------------------- |
| **`options`** | <code>{ value: string; }</code> |

**Returns:** <code>Promise&lt;{ value: string; }&gt;</code>

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


### open()

```typescript
open() => Promise<{ value: Contact | null; }>
```

**Returns:** <code>Promise&lt;{ value: <a href="#contact">Contact</a> | null; }&gt;</code>

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


### Interfaces


#### Contact

| Prop                   | Type                  |
| ---------------------- | --------------------- |
| **`identifier`**       | <code>string</code>   |
| **`fullName`**         | <code>string</code>   |
| **`givenName`**        | <code>string</code>   |
| **`familyName`**       | <code>string</code>   |
| **`nickname`**         | <code>string</code>   |
| **`jobTitle`**         | <code>string</code>   |
| **`departmentName`**   | <code>string</code>   |
| **`organizationName`** | <code>string</code>   |
| **`note`**             | <code>string</code>   |
| **`phoneNumbers`**     | <code>string[]</code> |
| **`emailAddresses`**   | <code>string[]</code> |

</docgen-api>
npm package: @nadavhalfon/capacitor-native-multi-contacts
Description: Capacitor plugin for picking multiple contacts from native contacts list - works on ios only
Author: NH
Latest version: 1.1.2

# capacitor-native-contacts

Capacitor plugin for picking multiple contacts from native contacts list - work on ios only, android does not support it and features picking one contact only

## Install

```bash
npm install @nadavhalfon/capacitor-native-multi-contacts
npx cap sync
```

## API

<docgen-index>

* [`getPermissions()`](#getpermissions)
* [`getContacts()`](#getcontacts)
* [Interfaces](#interfaces)

</docgen-index>

<docgen-api>
<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->

### getPermissions()

```typescript
getPermissions() => Promise<PermissionStatus>
```

**Returns:** <code>Promise&lt;<a href="#permissionstatus">PermissionStatus</a>&gt;</code>

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


### getContacts()

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

**Returns:** <code>Promise&lt;{ contacts: Contact[] | null; }&gt;</code>

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


### Interfaces


#### PermissionStatus

| Prop          | Type                 |
| ------------- | -------------------- |
| **`granted`** | <code>boolean</code> |


#### Contact

| Prop                   | Type                        |
| ---------------------- | --------------------------- |
| **`contactId`**        | <code>string</code>         |
| **`displayName`**      | <code>string</code>         |
| **`givenName`**        | <code>string</code>         |
| **`familyName`**       | <code>string</code>         |
| **`phoneNumbers`**     | <code>PhoneNumber[]</code>  |
| **`emails`**           | <code>EmailAddress[]</code> |
| **`photoThumbnail`**   | <code>string</code>         |
| **`organizationName`** | <code>string</code>         |
| **`organizationRole`** | <code>string</code>         |
| **`birthday`**         | <code>string</code>         |


#### PhoneNumber

| Prop         | Type                |
| ------------ | ------------------- |
| **`label`**  | <code>string</code> |
| **`number`** | <code>string</code> |


#### EmailAddress

| Prop          | Type                |
| ------------- | ------------------- |
| **`label`**   | <code>string</code> |
| **`address`** | <code>string</code> |

</docgen-api>