0.0.2 • Published 2 years ago

a-capacitor-contacts v0.0.2

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

capacitor-contacts

read, write, delete contacts

Install

npm install a-capacitor-contacts
npx cap sync

API

getContacts(...)

getContacts(options?: getContactsOpt | undefined) => Promise<{ results: any[]; }>
ParamType
optionsgetContactsOpt

Returns: Promise<{ results: any[]; }>


getContactByName(...)

getContactByName(options: getContactsByNameOpt) => Promise<{ results: any[]; }>
ParamType
optionsgetContactsByNameOpt

Returns: Promise<{ results: any[]; }>


addNewContact(...)

addNewContact(options: addNewContact) => Promise<{ results: any[]; }>
ParamType
optionsaddNewContact

Returns: Promise<{ results: any[]; }>


deleteContact(...)

deleteContact(options: contactUid) => Promise<{ results: any[]; }>
ParamType
optionscontactUid

Returns: Promise<{ results: any[]; }>


Interfaces

getContactsOpt

PropTypeDescription
getEmailbooleangetEmail if pass true its also search saved email address along with mobile number
getPhotobooleanreturn saved photo in base64 string

getContactsByNameOpt

PropTypeDescription
namestring
getEmailbooleangetEmail if pass true its also search saved email address along with mobile number
getPhotobooleanreturn saved photo in base64 string

addNewContact

PropTypeDescription
displayNamestringDisplay contact name
mobileNumberstringmobile number
homeNumberstring
workNumberstring
emailIDstring
companystring
jobTitlestring

contactUid

PropType
contactIDstring
0.0.2

2 years ago

0.0.1

2 years ago