ContactsManager.getProperties()

Draft
This page is not complete.

Secure context
This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

The getProperties() method of the ContactsManager interface returns a Promise which resolves with an Array of strings indicating which contact properties are available.

Syntax

var ContactProperties = ContactsManager.getProperties();

Parameters

This method receives no parameters.

Return value

Returns a Promise which when resolved returns an Array of available contact properties as strings.

Properties can be any of the following:

  • 'name': The contact's name.
  • 'tel': The telephone number(s) of the contact.
  • 'email': The email address of the contact.
  • 'address': The contact's postal address.
  • 'icon': The avatar of the contact.

Exceptions

No exceptions are thrown.

Examples

The following asynchronous function uses the getProperties method to check for supported properties.

async function checkProperties() {
  const supportedProperties = await navigator.contacts.getProperties();
  if (supportedProperties.includes('name')) {
    // run code for name support
  }
  if (supportedProperties.includes('email')) {
    // run code for email support
  }
  if (supportedProperties.includes('tel')) {
    // run code for telephone number support
  }
  if (supportedProperties.includes('address')) {
    // run code for address support
  }
  if (supportedProperties.includes('icon')) {
    // run code for avatar support
  }
}

Specifications

Specification Status Comment
Unknown
The definition of 'getProperties' in that specification.
Unknown Initial definition.

Browser compatibility

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome for AndroidFirefox for AndroidOpera for AndroidSafari on iOSSamsung Internet
getProperties
ExperimentalNon-standard
Chrome Full support 80Edge Full support 80Firefox No support NoIE No support NoOpera Full support YesSafari No support NoWebView Android Full support 80Chrome Android Full support 80Firefox Android No support NoOpera Android Full support YesSafari iOS No support NoSamsung Internet Android Full support 13.0

Legend

Full support  
Full support
No support  
No support
Experimental. Expect behavior to change in the future.
Experimental. Expect behavior to change in the future.
Non-standard. Expect poor cross-browser support.
Non-standard. Expect poor cross-browser support.