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 IPhoneBookClient

interface IPhoneBookClient
Extends com.amazon.apmf.IStandard Defines phonebook client interface. This is main interface to access Bluetooth PBAP features. The Phone Book Access Profile (PBAP) specification defines the procedures and protocols to exchange Phone Book objects between devices. It is especially tailored for the automotive Hands-Free use case where an onboard terminal device (typically a Car-Kit installed in the car) retrieves Phone Book objects from a mobile device (typically a mobile phone or an embedded phone).

Methods

getOrMakePhoneBookClientDevice()

IPhoneBookClientDevice* getOrMakePhoneBookClientDevice(IDevice* device)
Create a phonebook client connection interface for a specific device. This interface only creates the object (creating a IPhoneBookClientDevice object), it does NOT create a profile-level phonebook client connection automatically. If an interface already exists for the specified device, it is returned by this interface. For outgoing connections: The IPhoneBookClientDevice::connect() function must be called to initiate the profile connection. Bluetooth phonebook client profile is not a listening service for connections. There can’t be incoming connections from the remote device.

Parameters

device
IDevice* — Required The device to create the interface for.

Returns

IPhoneBookClientDevice* Returns a device interface, see IPhoneBookClientDevice.

getConnectedDevices()

IDevice*[] getConnectedDevices()
Get the list of devices currently connected with the phoneboook client profile. This returns an array of IDevice objects that have active connections only. If there is no phonebook client profile connection active, it is not included in this list. To interact with a device, the IPhoneBookClient::getOrMakePhoneBookClientDevice() function needs to be called on each device to retrieve the IPhoneBookClientDevice interface. To register for events related to the device, a call to IPhoneBookClientDevice::addListener is required to register the IPhoneBookClientDeviceListener. Privilege: com.amazon.bluetooth.privilege.access

Returns

IDevice*[] Returns array of connected devices. Empty if no devices connected.
Last modified on October 29, 2026