|  | Alexa Auto SDK
    2.3.0
    | 
| Public Member Functions | |
| virtual bool | cancelNavigation ()=0 | 
| virtual std::string | getNavigationState ()=0 | 
| virtual void | startNavigation (const std::string &payload)=0 | 
| virtual void | announceManeuver (const std::string &payload)=0 | 
| virtual void | announceRoadRegulation (RoadRegulation roadRegulation)=0 | 
| void | navigationEvent (EventName event) | 
| void | navigationError (ErrorType type, ErrorCode code, const std::string &description) | 
| void | showAlternativeRoutesSucceeded (const std::string &payload) | 
Navigation should be extended to handle navigation directives from the Engine.
| 
 | pure virtual | 
Notifies the platform implementation to cancel navigation
true if the platform implementation successfully handled the call, else false | 
 | pure virtual | 
Retrieve the navigation state from the platform. NOTE: You may return an empty string to default the payload to NOT_NAVIGATING
| 
 | pure virtual | 
Notifies the platform implementation to start the navigation
| [in] | payload | JSON data containing the destination information ) "transportationMode":"{{STRING}}", "waypoints":[    {        "type":"{{STRING}}",        "estimatedTimeOfArrival":{            "ideal":"{{STRING}}", //ISO-8601 time format            "predicted":"{{STRING}}" //ISO-8601 time format        },        "address": {            "addressLine1": "{{STRING}}", //Address line 1            "addressLine2": "{{STRING}}", //Address line 2            "addressLine3": "{{STRING}}", //Address line 3            "city": "{{STRING}}", //city            "districtOrCounty": "{{STRING}}", //district or county            "stateOrRegion": "{{STRING}}", // state or region            "countryCode": "{{STRING}}", //3 letter country code            "postalCode": "{{STRING}}", // postal code        },        "coordinate":[            "{{LATITUDE_DOUBLE}}",            "{{LONGITUDE_DOUBLE}}"        ],        "name":"{{STRING}}"    },    {        "type":"{{STRING}}",        "estimatedTimeOfArrival":{            "ideal":"{{STRING}}",            "predicted":"{{STRING}}"        },        "address":"{{STRING}}",        "coordinate":[            "{{LATITUDE_DOUBLE}}",            "{{LONGITUDE_DOUBLE}}"        ],        "name":"{{STRING}}"        "poiOfInterest":{            "id":"{{STRING}}",            "hoursOfOperation":[                {                "dayOfWeek":"{{STRING}}",                "hours":[                    {                        "open":"{{STRING}}",                        "close":"{{STRING}}"                    }                ],                "type":"{{STRING}}"                }            ],            "phoneNumber":"{{STRING}}"        }    } ] 
 | 
| 
 | pure virtual | 
Notifies the platform implementation to give details about a maneuver to next waypoint on the route or a completely different waypoint off route.
| [in] | payload | JSON data containing the manueuver information ) "maneuverType": "{{STRING}}", // requested maneuver type "queryTarget" : {     "name": "{{STRING}}" // name of the requested location     "address": { // address of requested location         "addressLine1": "{{STRING}}", //Address line 1         "addressLine2": "{{STRING}}", //Address line 2         "addressLine3": "{{STRING}}", //Address line 3         "city": "{{STRING}}", //city         "districtOrCounty": "{{STRING}}", //district or county         "stateOrRegion": "{{STRING}}", // state or region         "countryCode": "{{STRING}}", //3 letter country code         "postalCode": "{{STRING}}", // postal code     },     "coordinate": [{{LATITUDE_DOUBLE}},{{LONGITUDE_DOUBLE}}]  } 
 | 
| 
 | pure virtual | 
Notifies the platform implementation to give details about road regulations about the road segments that the user is on
| [in] | roadRegulation | Type of road regulation requested.(Values: SPEED_LIMIT, CARPOOL_RULES) | 
| void aace::navigation::Navigation::navigationEvent | ( | EventName | event | ) | 
Notifies the Engine of successful handling of a Navigation directive.
| [in] | event | EventName describing which operation was successful. 
 | 
| void aace::navigation::Navigation::navigationError | ( | ErrorType | type, | 
| ErrorCode | code, | ||
| const std::string & | description | ||
| ) | 
Notifies the Engine of error in handling a Navigation directive.
| type | ErrorType describing which operation failed. 
 | 
| code | ErrorCode describing the type of failure. (Values: INTERNAL_SERVICE_ERROR, ROUTE_NOT_FOUND, NO_PREVIOUS_WAYPOINTS, NOT_SUPPORTED, NOT_ALLOWED) | 
| description | String providing additional information. | 
| void aace::navigation::Navigation::showAlternativeRoutesSucceeded | ( | const std::string & | payload | ) | 
Notifies AVS of successful showing of alternative routes to the user
| [in] | payload | JSON data containing the alternative route information ) "inquiryType": "{{STRING}}" // DEFAULT, SHORTER_TIME, SHORTER_DISTANCE "alternateRoute":   {       "labels": ["{{STRING}}"],       "savings": [           {               "type": "{{STRING}}", // DISTANCE, TIME               "amount": "{{FLOAT}}",               "unit": "{{STRING}}" // MINUTE, HOUR, YARD, FOOT, MILE, METER, KILOMETER           }       ]                 } 
 | 
Alexa Auto SDK 2.3.0 - Copyright 2017-2020 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0