summaryrefslogtreecommitdiffstats
path: root/src/plugins/capabilities/communication/include/PhoneControlMessages.h
diff options
context:
space:
mode:
authorNaveen Bobbili <nbobbili@amazon.com>2019-02-25 17:24:29 -0800
committerNaveen Bobbili <nbobbili@amazon.com>2019-02-25 20:55:05 -0800
commit9eb3a90df3681586b58146b47eea7f3848c348a0 (patch)
tree9c507e13c233fb649d04c6a45d152f7ec12185f8 /src/plugins/capabilities/communication/include/PhoneControlMessages.h
parent143363b9e864ea465c927057ce7214f124a984cb (diff)
Refactored VSHL into vshl-core and vshl-capabilities.
vshl-core: This API is responsible for request arbitration. Verbs exposed are 1. startListening 2. cancelListening 3. subscribe 4. enumerateVoiceAgents 5. setDefaultVoiceAgent Used by applications to subscribe to dialog, connection and auth states of underlying low level voiceagent bindings. Used by applications to trigger voice recognition routine of the underlying low level voiceagent binding. vshl-capabilities: This API exposes publish and subscribe methods for all the speech framework domains/capabilities. For eg. navigation, phonecontrol etc. This API is used by apps and low level voice agent binding to subscribe and publish these capability messages whenever applicable. The code for this is agl-service-voice-high-capabilities repository. This specific commit is for vshl-core API. Change-Id: I1101db19b57ee918482a178843641b088508ac5d Signed-off-by: Naveen Bobbili <nbobbili@amazon.com>
Diffstat (limited to 'src/plugins/capabilities/communication/include/PhoneControlMessages.h')
-rw-r--r--src/plugins/capabilities/communication/include/PhoneControlMessages.h128
1 files changed, 0 insertions, 128 deletions
diff --git a/src/plugins/capabilities/communication/include/PhoneControlMessages.h b/src/plugins/capabilities/communication/include/PhoneControlMessages.h
deleted file mode 100644
index 4c68455..0000000
--- a/src/plugins/capabilities/communication/include/PhoneControlMessages.h
+++ /dev/null
@@ -1,128 +0,0 @@
-/*
- * Copyright 2018-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
- *
- * Licensed under the Apache License, Version 2.0 (the "License").
- * You may not use this file except in compliance with the License.
- * A copy of the License is located at
- *
- * http://aws.amazon.com/apache2.0/
- *
- * or in the "license" file accompanying this file. This file is distributed
- * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
- * express or implied. See the License for the specific language governing
- * permissions and limitations under the License.
- */
-#ifndef VSHL_CAPABILITIES_PHONECONTROL_MESSAGES_H_
-#define VSHL_CAPABILITIES_PHONECONTROL_MESSAGES_H_
-
-#include <list>
-#include <string>
-
-using namespace std;
-
-namespace vshl {
-namespace capabilities {
-namespace phonecontrol {
-
-static string NAME = "phonecontrol";
-
-// Supported actions from VA -> Apps
-/* Dial message sent from VA to app handling the calling.
- *
- * Payload
- * {
- * "callId": "{{STRING}}",
- * "callee": {
- * "details": "{{STRING}}",
- * "defaultAddress": {
- * "protocol": "{{STRING}}",
- * "format": "{{STRING}}",
- * "value": "{{STRING}}"
- * },
- * "alternativeAddresses": [{
- * "protocol": "{{STRING}}",
- * "format": "{{STRING}}",
- * "value": {{STRING}}
- * }]
- * }
- * }
- * }
- *
- * callId (required): A unique identifier for the call
- * callee (required): The destination of the outgoing call
- * callee.details (optional): Descriptive information about the callee
- * callee.defaultAddress (required): The default address to use for calling the callee
- * callee.alternativeAddresses (optional): An array of alternate addresses for the existing callee
- * address.protocol (required): The protocol for this address of the callee (e.g. PSTN, SIP, H323, etc.)
- * address.format (optional): The format for this address of the callee (e.g. E.164, E.163, E.123, DIN5008, etc.)
- * address.value (required): The address of the callee.
- *
- */
-static string PHONECONTROL_DIAL = "dial";
-
-// Supported actions from Apps -> VA
-/*
- * App notifies the voiceagents of a change in connection state of a calling device.
- *
- * Payload
- * {
- * "state" : "{{STRING}}" // CONNECTED or DISCONNECTED
- * }
- */
-static string PHONECONTROL_CONNECTIONSTATE_CHANGED = "connection_state_changed";
-/*
- * App notifies the voiceagents that call is activated
- *
- * callId must match the one that is sent by VA with DIAL message above.
- *
- * Payload
- * {
- * "callId" : "{{STRING}}"
- * }
- */
-static string PHONECONTROL_CALL_ACTIVATED = "call_activated";
-/*
- * App notifies the voiceagents of an error in initiating or maintaining a
- * call on a calling device
- *
- * callId must match the one that is sent by VA with DIAL message above.
- * error: below status codes.
- * 4xx: Validation failure for the input from the DIAL message
- * 500: Internal error on the platform unrelated to the cellular network
- * 503: Error on the platform related to the cellular network
- *
- * Payload
- * {
- * "callId" : "{{STRING}}"
- * "error" : "{{STRING}}"
- * }
- */
-static string PHONECONTROL_CALL_FAILED = "call_failed";
-/*
- * App notifies the voiceagents that call is terminated
- *
- * callId must match the one that is sent by VA with DIAL message above.
- *
- * Payload
- * {
- * "callId" : "{{STRING}}"
- * }
- */
-static string PHONECONTROL_CALL_TERMINATED = "call_terminated";
-
-// List of actions that are delivered from VA -> Apps
-static list<string> PHONECONTROL_UPSTREAM_ACTIONS = {
- PHONECONTROL_DIAL,
-};
-
-// List of actions that are delivered from Apps -> VA
-static list<string> PHONECONTROL_DOWNSTREAM_ACTIONS = {PHONECONTROL_CONNECTIONSTATE_CHANGED,
- PHONECONTROL_CALL_ACTIVATED,
- PHONECONTROL_CALL_FAILED,
- PHONECONTROL_CALL_TERMINATED};
-
-} // namespace phonecontrol
-} // namespace capabilities
-} // namespace vshl
-
-#endif // VSHL_CAPABILITIES_PHONECONTROL_MESSAGES_H_