aace::addressBook::AddressBook Class Reference

Classes
class	IAddressBookEntriesFactory

Public Member Functions
bool	addAddressBook (const std::string &addressBookSourceId, const std::string &name, AddressBookType type)
bool	removeAddressBook (const std::string &addressBookSourceId)
virtual bool	getEntries (const std::string &addressBookSourceId, std::weak_ptr< IAddressBookEntriesFactory > factory)=0

Detailed Description

Deprecated:

This platform interface is deprecated. Use the Alexa Auto Services Bridge (AASB) message broker to publish and subscribe to AASB messages instead.

See also

aace::core::MessageBroker

Member Function Documentation

addAddressBook()

bool aace::addressBook::AddressBook::addAddressBook	(	const std::string &	addressBookSourceId,
		const std::string &	name,
		AddressBookType	type
	)

Notifies the engine on an availability of an address book

Parameters

[in]	addressBookSourceId	A unique identifier for an address book.
[in]	name	Friendly name of the address book, or an empty string if not available.
[in]	type	Type of the address book AddressBookType.

Returns

false if address book was already added or some internal error otherwise true on successful.

removeAddressBook()

bool aace::addressBook::AddressBook::removeAddressBook

(

const std::string &

addressBookSourceId

)

Notifies the engine on a non-availability of an already available address book.

Parameters

[in]

addressBookSourceId

A unique identifier for an address book. Set this to empty string for engine to remove all uploaded address books.

Returns

false if address book does not already added or some internal error otherwise true on successful.

getEntries()

virtual bool aace::addressBook::AddressBook::getEntries ( const std::string &  addressBookSourceId, std::weak_ptr< IAddressBookEntriesFactory >  factory  )

pure virtual

Notifies the platform implementation to ingest address book entries using factory methods. Please note that engine may call this function multiple times to get the entries of the same address book.

Parameters

[in]	addressBookSourceId	A unique identifier for an address book added using addAddressBook
[in]	factory	Factory class for ingesting address book entries.

Returns

Return true if platform implementation has successfully ingested all the entries of the address book otherwise false.