@expo/contact-utils
Tools for working with Expo.Contacts
Last updated 2 years ago by evanbacon .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install @expo/contact-utils 
SYNC missed versions from official npm registry.

expo-contact-utils

NPM

Methods

parseDate

parseDate({ year, month, day, format }): Date

Return a JS Date given a native calendar date.

Parameters

Name Type Description
calendarFormat CalendarFormat The shape containing calendar information.

Returns

Name Type Description
date Date A javascript date.

Example

const date = ContactUtils.parseDate({ year, month, day, format });

formatAddress

formatAddress(address: Address): string

Return a readable name from native address information.

Parameters

Name Type Description
address Address The shape containing postal address information.

Returns

Name Type Description
formatAddress string A readable address name.

Example

const address = ContactUtils.formatAddress({
  city,
  country,
  postalCode,
  region,
  street,
});

nameForFieldAsync

nameForFieldAsync(key: ContactField, strings = STRINGS): ?string

Get a localized name for a Contact.Fields key.

Only supported language is en (US-English) currently.

Parameters

Name Type Description
key ContactField The field you want to get a name for.
strings { [en]: { [ContactField]: string } } An alternative list of localized strings.

Returns

Name Type Description
name ?string The name of a supplied ContactField.

Example

const name = await nameForFieldAsync(Contacts.Fields.FirstName);

getPrimaryEntry

getPrimaryEntry(items: Array): ?Object

Given a list of contact entries, (like emails) this will find the primary entry.

Parameters

Name Type Description
items Array<{ label, id, isPrimary, ...data }> An array of contact entry data.

Returns

Name Type Description
item ?{ label, id, isPrimary, ...data } A contact field entry that is the assumed primary value.

Example

const primary = getPrimaryEntry(phoneNumbers);

getGroupWithNameAsync

iOS only

getGroupWithNameAsync(groupName: string): Promise<?Group>

Gets the first group with a given name.

Parameters

Name Type Description
groupName string Name of the group you want to query.

Returns

Name Type Description
group ?Group A group with a name matching the provided query.

Example

const contactGroup = await getGroupWithNameAsync("Expo Programmers")

duplicateContactWithIdAsync

iOS only

duplicateContactWithIdAsync(contactId: string): Promise<string>

Creates a clone of an existing system contact.

Parameters

Name Type Description
contactId string ID of the existing contact you want to duplicate.

Returns

Name Type Description
contactId string ID of the new contact.

Example

const cloneId = await duplicateContactWithIdAsync(contactId)

ensureGroupWithNameExistsAsync

iOS only

ensureGroupWithNameExistsAsync(groupName: string): Promise<string>

Tries to retrieve a contact group, if it cannot be found, create a new contact group with the provided name.

Parameters

Name Type Description
groupName string Name of the group you wish to get.

Returns

Name Type Description
groupId string ID of the group you ensured.

Example

const groupId = await ensureGroupWithNameExistsAsync("Expo programmers")

deleteGroupWithNameAsync

iOS only

deleteGroupWithNameAsync(groupName: string): Promise<any>

Query a group by name, and delete it.

Parameters

Name Type Description
groupName string Name of the group you want to delete.

Example

await deleteGroupWithNameAsync("Xamarin programmers")

removeAllChildrenFromGroupWithNameAsync

iOS only

removeAllChildrenFromGroupWithNameAsync(groupName: string): Promise<any>

Delete all the contacts from a group.

Parameters

Name Type Description
groupName string Name of the target group.

Example

await removeAllChildrenFromGroupWithNameAsync("Xamarin Devs")

presentNewContactFormAsync

presentNewContactFormAsync(options: ContactFormOptions): Promise<any>

Present a native modal for adding a new system contact.

Parameters

Name Type Description
options ContactFormOptions The configuration used for customizing the modal.

Example

await presentNewContactFormAsync({ contact, options })

presentUnknownContactFormAsync

presentUnknownContactFormAsync(options: ContactFormOptions): Promise<any>

Present a native modal for an unknown contact.

Parameters

Name Type Description
options ContactFormOptions The configuration used for customizing the modal.

Example

const data = await presentUnknownContactFormAsync({ contact, options })

presentContactInfoFormAsync

presentContactInfoFormAsync(options: ContactFormOptions): Promise<any>

Present a native modal for inspecting contact information.

Parameters

Name Type Description
options ContactFormOptions The configuration used for customizing the modal.

Example

await presentContactInfoFormAsync({ contact, options })

Types

ContactFormOptions

Name Type Description
contact Contact Contact information for the modal.
options Object Configuration data for the modal.

Current Tags

  • 0.0.0                                ...           latest (2 years ago)

1 Versions

  • 0.0.0                                ...           2 years ago
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 1
Dependencies (0)
None
Dev Dependencies (13)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |