@anuradev/capacitor-contacts v1.0.6

@anuradev/capacitor-contacts

Capacitor plugin to get and modify mobile contacts

Install

npm install @anuradev/capacitor-contacts
npx cap sync

API

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

checkPermissions()

checkPermissions() => Promise<PermissionStatus>

Returns: Promise<PermissionStatus>

requestPermissions()

requestPermissions() => Promise<PermissionStatus>

Returns: Promise<PermissionStatus>

getContacts()

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

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

createContact(...)

createContact(data: { name?: string; number: string; }) => Promise<void>

addToExistingContact(...)

addToExistingContact(data: { name?: string; number: string; }) => Promise<void>

deleteContact(...)

deleteContact(data: { contactId: string; }) => Promise<void>

getGroups()

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

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

getContactGroups()

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

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

Interfaces

PermissionStatus

Contact

PhoneNumber

EmailAddress

Group

Type Aliases

PermissionState

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