Amazon Developer

as

Settings
Sign out
Notifications
Alexa
Amazon Appstore
Ring
AWS
Documentation
Support
Contact Us
My Cases
Get Started
Design and Develop
Publish
Reference
Support
Native
Skip to main content

Interface IPhoneBookClientDevice2

interface IPhoneBookClientDevice2
Extends IPhoneBookClientDevice Enhanced phonebook client device interface that extends IPhoneBookClientDevice to provide access to enhanced contact information including email addresses and company information. This interface maintains full backward compatibility while adding new functionality for retrieving extended contact data.

Methods

getPhoneBook2()

PhoneBookContactCard2*[] getPhoneBook2(PhoneBookFolder* folder)
Send a request to get phonebook with enhanced contact information from the remote device. This method pulls phonebook entries with extended information including email addresses and company information when available from the remote device. This is a blocking call that extends the functionality of the base getPhoneBook() method by requesting additional contact properties. The method gracefully handles phones that don’t support extended properties by returning PhoneBookContactCard2 objects with empty email and company fields. The ownership of the PhoneBookContactCard2 list is transferred to the client upon the return of this method. Privilege: com.amazon.bluetooth.privilege.phonebook_client

Parameters

folder
PhoneBookFolder* — Required Phonebook folder PhoneBookFolder.

Returns

PhoneBookContactCard2*[] Returns list of references to PhoneBookContactCard2.

Throws

  • BluetoothBusy — if the pull request is already in progress.
  • BluetoothFail — if the phonebook is empty from the remote device. Clients are expected to notify the user to allow user consent for contacts on the phone Bluetooth settings. Also, if phonebook failed to fetch intermediately from the remote device. Clients are expected to retry again.
  • BluetoothMaxBuffer — if out of resource to allocate for phonebook entries on client’s process.
  • BluetoothNotConnected — if the request is made without a profile connection.

Last modified on October 29, 2026