![]() |
Alexa Auto SDK
2.0.0
|
Classes | |
enum | CallError |
enum | CallingDeviceConfigurationProperty |
enum | CallState |
enum | ConnectionState |
enum | DTMFError |
Public Member Functions | |
boolean | dial (String payload) |
boolean | redial (String payload) |
void | answer (String payload) |
void | stop (String payload) |
void | sendDTMF (String payload) |
Protected Member Functions | |
final void | connectionStateChanged (ConnectionState state) |
final void | callStateChanged (CallState state, String callId) |
final void | callStateChanged (CallState state, String callId, String callerId) |
final void | callFailed (String callId, CallError code) |
final void | callFailed (String callId, CallError code, String message) |
final void | callerIdReceived (String callId, String callerId) |
final void | sendDTMFSucceeded (String callId) |
final void | sendDTMFFailed (String callId, DTMFError code) |
final void | sendDTMFFailed (String callId, DTMFError code, String message) |
final void | deviceConfigurationUpdated (HashMap< CallingDeviceConfigurationProperty, Boolean > configurationMap) |
final String | createCallId () |
PhoneCallController should be extended to allow a user to use Alexa to interact with a calling device such as a connected mobile phone. It provides interfaces for controlling inbound and outbound calls and for notifying the Engine of the state of a call session and the state of platform connection to a calling device.
The platform implementation is responsible for managing the lifecycle and user experience of a call session and connection to the calling device.
boolean com.amazon.aace.phonecontrol.PhoneCallController.dial | ( | String | payload | ) |
Notifies the platform implementation to initiate an outgoing phone call to the destination address
payload | Details of the dial request in structured JSON format. See the following payload structure and the description of each field: { "callId": "{{STRING}}", "callee": { "details": "{{STRING}}", "defaultContactAddress": { "protocol": "{{STRING}}", "format": "{{STRING}}", "value": "{{STRING}}" }, "alternativeContactAddresses": [{ "protocol": "{{STRING}}", "format": "{{STRING}}", "value": {{STRING}} }] }, } }
|
true
if the platform implementation successfully handled the call boolean com.amazon.aace.phonecontrol.PhoneCallController.redial | ( | String | payload | ) |
Notifies the platform implementation to redial the last called phone number.
After returning true
, if no stored number is available to be redialed, PhoneCallController::callFailed
with CallError::NO_NUMBER_FOR_REDIAL
should be called.
payload | Details of the redial request in structured JSON format. See the following payload structure and the description of each field: { "callId": "{{STRING}}" }
|
true
if the platform implementation successfully handled the call void com.amazon.aace.phonecontrol.PhoneCallController.answer | ( | String | payload | ) |
Notifies the platform implementation to answer an inbound call
payload | Details of the answer request in structured JSON format. See the following payload structure and the description of each field: { "callId": "{{STRING}}", }
|
void com.amazon.aace.phonecontrol.PhoneCallController.stop | ( | String | payload | ) |
Notifies the platform implementation to end an ongoing call or stop inbound or outbound call setup
payload | Details of the stop request in structured JSON format. See the following payload structure and the description of each field: { "callId": "{{STRING}}" }
|
void com.amazon.aace.phonecontrol.PhoneCallController.sendDTMF | ( | String | payload | ) |
Notifies the platform implementation to send a DTMF signal to the calling device
payload | Details of the DTMF request in structured JSON format. See the following payload structure and the description of each field: { "callId": "{{STRING}}", "signal": "{{STRING}}" }
|
|
protected |
Notifies the Engine of a change in connection to a calling device
state | The state of connection to a calling device |
|
protected |
Notifies the Engine of a change in the state of an ongoing call
state | The state of the call |
callId | The unique identifier associated with the call |
|
protected |
Notifies the Engine of a change in the state of an ongoing call
state | The state of the call |
callId | The unique identifier associated with the call |
callerId | The identifier for a contact. May be included for CallState::CALL_RECEIVED |
|
protected |
Notifies the Engine of an error related to a call
callId | The unique identifier for the call associated with the error |
code | The error type |
|
protected |
Notifies the Engine of an error related to a call
callId | The unique identifier for the call associated with the error |
code | The error type |
message | A description of the error |
|
protected |
Notifies the Engine that a caller id was received for an inbound call
callId | The unique identifier for the call associated with the callId |
callerId | The caller's identifier or phone number |
|
protected |
Notifies the Engine that sending the DTMF signal succeeded.
callId | The unique identifier for the associated call |
|
protected |
Notifies the Engine that the DTMF signal could not be delivered to the remote party
callId | The unique identifier for the associated call |
code | The error type |
|
protected |
Notifies the Engine that the DTMF signal could not be delivered to the remote party
callId | The unique identifier for the associated call |
code | The error type |
message | A description of the error |
|
protected |
Notifies the Engine of the calling feature configuration of the connected calling device. The configuration data may change if, for example, the connection mechanism to the calling device changes. The provided configuration will override the default or previous configuration.
See PhoneCallController::CallingDeviceConfigurationProperty
for a description of each configurable feature
configurationMap | A map of configuration properties to the boolean state of the properties |
|
protected |
Generates a unique identifier for a call
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