Alexa Auto SDK  2.0.0
Public Member Functions | List of all members
aace::addressBook::AddressBook::IAddressBookEntriesFactory Class Referenceabstract

Public Member Functions

virtual bool addName (const std::string &entryId, const std::string &name)=0
 
virtual bool addName (const std::string &entryId, const std::string &firstName, const std::string &lastName)=0
 
virtual bool addName (const std::string &entryId, const std::string &firstName, const std::string &lastName, const std::string &nickname)=0
 
virtual bool addPhone (const std::string &entryId, const std::string &label, const std::string &number)=0
 
virtual bool addPostalAddress (const std::string &entryId, const std::string &label, const std::string &addressLine1, const std::string &addressLine2, const std::string &addressLine3, const std::string &city, const std::string &stateOrRegion, const std::string &districtOrCounty, const std::string &postalCode, const std::string &country, float latitudeInDegrees, float longitudeInDegrees, float accuracyInMeters)=0
 

Detailed Description

Factory class for ingesting the AddressBook Entries.

Member Function Documentation

◆ addName() [1/3]

virtual bool aace::addressBook::AddressBook::IAddressBookEntriesFactory::addName ( const std::string &  entryId,
const std::string &  name 
)
pure virtual

Add name.

Parameters
[in]entryIdA unique identifier of entry in an address book.
[in]nameName of the entry, or an empty string if not available.
Returns
true on successful or false when name for the id was already added or if entryId is empty.

◆ addName() [2/3]

virtual bool aace::addressBook::AddressBook::IAddressBookEntriesFactory::addName ( const std::string &  entryId,
const std::string &  firstName,
const std::string &  lastName 
)
pure virtual

Add first and last name.

Parameters
[in]entryIdA unique identifier of entry in an address book.
[in]firstNameFirst name of the entry, or an empty string if not available.
[in]lastNameLast name of the entry, or an empty string if not available.
Returns
true on successful or false when name for the id was already added or if entryId is empty.

◆ addName() [3/3]

virtual bool aace::addressBook::AddressBook::IAddressBookEntriesFactory::addName ( const std::string &  entryId,
const std::string &  firstName,
const std::string &  lastName,
const std::string &  nickname 
)
pure virtual

Add first, last and nick name.

Parameters
[in]entryIdA unique identifier of entry in an address book.
[in]firstNameFirst name of the entry, or an empty string if not available.
[in]lastNameLast name of the entry, or an empty string if not available.
[in]nickNameNick name of the entry, or an empty string if not available.
Returns
true on successful or false when name for the id was already added or if entryId is empty.

◆ addPhone()

virtual bool aace::addressBook::AddressBook::IAddressBookEntriesFactory::addPhone ( const std::string &  entryId,
const std::string &  label,
const std::string &  number 
)
pure virtual

Add phone number(s).

Parameters
[in]entryIdA unique identifier of entry in an address book.
[in]labelAlphanumeric phone label (Example: HOME, MOBILE), or an empty string if not available.
[in]numberNumeric phone number, or an empty string if not available.
Returns
true on successful or false when reached the max allowed per entryId or if entryId is empty.

◆ addPostalAddress()

virtual bool aace::addressBook::AddressBook::IAddressBookEntriesFactory::addPostalAddress ( const std::string &  entryId,
const std::string &  label,
const std::string &  addressLine1,
const std::string &  addressLine2,
const std::string &  addressLine3,
const std::string &  city,
const std::string &  stateOrRegion,
const std::string &  districtOrCounty,
const std::string &  postalCode,
const std::string &  country,
float  latitudeInDegrees,
float  longitudeInDegrees,
float  accuracyInMeters 
)
pure virtual

Add postal address(es).

Parameters
[in]entryIdA unique identifier of entry in an address book.
[in]labelAlphanumeric postal address label (Example: HOME, WORK), or an empty string if not available.
[in]addressLine1First line of the postal address, or an empty string if not available.
[in]addressLine2Second line of the postal address, or an empty string if not available.
[in]addressLine3Third line of the postal address, or an empty string if not available.
[in]cityCity name, or an empty string if not available.
[in]stateOrRegionState or Region name, or an empty string if not available.
[in]districtOrCountyDistrict or County name, or an empty string if not available.
[in]postalCodePostal code or Zip code, or an empty string if not available.
[in]countryCountry name, or an empty string if not available.
[in]latitudeInDegreesGeo latitude in degrees.
[in]longitudeInDegreesGeo longitute in degrees.
[in]accuracyInMetersAccuracy in meters, or zero if not available.
Returns
true on successful or false when reached the max allowed per id or if entryId is empty.

Alexa Auto SDK 2.0.0 - Copyright 2017-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0