diff options
Diffstat (limited to 'src/components/interfaces/MOBILE_API.xml')
| -rw-r--r-- | src/components/interfaces/MOBILE_API.xml | 174 |
1 files changed, 166 insertions, 8 deletions
diff --git a/src/components/interfaces/MOBILE_API.xml b/src/components/interfaces/MOBILE_API.xml index 185b9d8773..f1ec069882 100644 --- a/src/components/interfaces/MOBILE_API.xml +++ b/src/components/interfaces/MOBILE_API.xml @@ -2620,6 +2620,7 @@ <element name="PublishAppServiceID" value="52" hexvalue="34" since="5.1" /> <element name="GetAppServiceDataID" value="53" hexvalue="35" since="5.1" /> <element name="PerformAppServiceInteractionID" value="55" hexvalue="37" since="5.1" /> + <element name="GetFileID" value="54" hexvalue="36" since="5.1" /> <!-- Base Notifications @@ -3702,6 +3703,7 @@ <enum name="AppServiceType" since="5.1"> <element name="MEDIA"/> <element name="WEATHER"/> + <element name="NAVIGATION"/> </enum> <struct name="MediaServiceManifest" since="5.1"> @@ -3890,6 +3892,110 @@ </param> </struct> + <struct name="NavigationServiceManifest"> + <param name="acceptsWayPoints" type="Boolean" mandatory="false"> + <description> Informs the subscriber if this service can actually accept way points. </description> + </param> + </struct> + + <enum name="NavigationAction"> + <element name="TURN"> + <description> Using this action plus a supplied direction can give the type of turn. </description> + </element> + <element name="EXIT"/> + <element name="STAY"/> + <element name="MERGE"/> + <element name="FERRY"/> + <element name="CAR_SHUTTLE_TRAIN"/> + <element name="WAYPOINT"/> + </enum> + + <enum name="NavigationJunction"> + <element name="REGULAR"> + <description> A junction that represents a standard intersection with a single road crossing another. </description> + </element> + <element name="BIFURCATION"> + <description> A junction where the road splits off into two paths; a fork in the road. </description> + </element> + <element name="MULTI_CARRIAGEWAY"> + <description> A junction that has multiple intersections and paths. </description> + </element> + <element name="ROUNDABOUT"> + <description> A junction where traffic moves in a single direction around a central, non-traversable point to reach one of the connecting roads. </description> + </element> + <element name="TRAVERSABLE_ROUNDABOUT"> + <description> Similar to a roundabout, however the center of the roundabout is fully traversable. Also known as a mini-roundabout. </description> + </element> + <element name="JUGHANDLE"> + <description> A junction where lefts diverge to the right, then curve to the left, converting a left turn to a crossing maneuver. </description> + </element> + <element name="ALL_WAY_YIELD"> + <description> Multiple way intersection that allows traffic to flow based on priority; most commonly right of way and first in, first out. </description> + </element> + <element name="TURN_AROUND"> + <description> A junction designated for traffic turn arounds. </description> + </element> + </enum> + + <enum name="Direction"> + <element name="LEFT"/> + <element name="RIGHT"/> + </enum> + + <struct name="NavigationInstruction"> + <param name="locationDetails" type="LocationDetails" mandatory="true"/> + + <param name="action" type="NavigationAction" mandatory="true"/> + + <param name="eta" type="DateTime" mandatory="false"/> + + <param name="bearing" type="Integer" minvalue="0" maxvalue="359" mandatory="false"> + <description> The angle at which this instruction takes place. For example, 0 would mean straight, less than 45 is bearing right, greater than 135 is sharp right, between 45 and 135 is a regular right, and 180 is a U-Turn, etc. </description> + </param> + + <param name="junctionType" type="NavigationJunction" mandatory="false"/> + + <param name="drivingSide" type="Direction" mandatory="false"> + <description> Used to infer which side of the road this instruction takes place. For a U-Turn (Action=Turn, direction=180) this will determine which direction the turn should take place. </description> + </param> + + <param name="details" type="String" mandatory="false"> + <description> This is a string representation of this instruction, used to display instructions to the users. This is not intended to be read aloud to the users, see the param prompt in NavigationServiceData for that. </description> + </param> + + <param name="image" type="Image" mandatory="false"> + <description> An image representation of this instruction. </description> + </param> + </struct> + + <struct name="NavigationServiceData"> + <description> This data is related to what a navigation service would provide.</description> + + <param name="timeStamp" type="DateTime" mandatory="true"> + <description> This is the timestamp of when the data was generated. This is to ensure any time or distance given in the data can accurately be adjusted if necessary. </description> + </param> + + <param name="origin" type="LocationDetails" mandatory="false"/> + <param name="destination" type="LocationDetails" mandatory="false"/> + <param name="destinationETA" type="DateTime" mandatory="false"/> + + <param name="instructions" type="NavigationInstruction" array="true" mandatory="false"> + <description> This array should be ordered with all remaining instructions. The start of this array should always contain the next instruction.</description> + </param> + + <param name="nextInstructionETA" type="DateTime" mandatory="false"/> + <param name="nextInstructionDistance" type="Float" mandatory="false"> + <description>The distance to this instruction from current location. This should only be updated ever .1 unit of distance. For more accuracy the consumer can use the GPS location of itself and the next instruction. </description> + </param> + <param name="nextInstructionDistanceScale" type="Float" mandatory="false"> + <description>Distance till next maneuver (starting from) from previous maneuver.</description> + </param> + + <param name="prompt" type="String" mandatory="false"> + <description>This is a prompt message that should be conveyed to the user through either display or voice (TTS). This param will change often as it should represent the following: approaching instruction, post instruction, alerts that affect the current navigation session, etc.</description> + </param> + </struct> + <struct name="AppServiceManifest" since="5.1"> <description> This manifest contains all the information necessary for the service to be published, activated, and consumers able to interact with it </description> @@ -3909,14 +4015,6 @@ <description> If true, app service consumers beyond the IVI system will be able to access this service. If false, only the IVI system will be able consume the service. If not provided, it is assumed to be false. </description> </param> - <param name="uriPrefix" type="String" mandatory="false"> - <description> The URI prefix for this service. If provided, all PerformAppServiceInteraction requests must start with it. </description> - </param> - - <param name="uriScheme" type="String" mandatory="false"> - <description> This is a custom schema for this service. SDL will not do any verification on this param past that it has a correctly formated JSON Object as its base. The uriScheme should contain all available actions to be taken through a PerformAppServiceInteraction request from an app service consumer. </description> - </param> - <param name="rpcSpecVersion" type="SyncMsgVersion" mandatory="false"> <description> This is the max RPC Spec version the app service understands. This is important during the RPC passthrough functionality. If not included, it is assumed the max version of the module is acceptable. </description> </param> @@ -3927,6 +4025,7 @@ <param name="mediaServiceManifest" type="MediaServiceManifest" mandatory="false"/> <param name="weatherServiceManifest" type="WeatherServiceManifest" mandatory="false"/> + <param name="navigationServiceManifest" type="NavigationServiceManifest" mandatory="false"/> </struct> <struct name="AppServiceRecord" since="5.1"> @@ -3957,6 +4056,7 @@ <param name="mediaServiceData" type="MediaServiceData" mandatory="false"/> <param name="weatherServiceData" type="WeatherServiceData" mandatory="false"/> + <param name="navigationServiceData" type="NavigationServiceData" mandatory="false"/> </struct> <enum name="ServiceUpdateReason" since="5.1"> @@ -6349,6 +6449,64 @@ </param> </function> + <function name ="GetFile" functionID="GetFileID" messagetype="request"> + <description>This request is sent to the module to retrieve a file</description> + <param name="fileName" type="String" maxlength="255" mandatory="true"> + <description>File name that should be retrieved</description> + </param> + <param name="appServiceId" type="String" mandatory="false"> + <description>ID of the service that should have uploaded the requested file.</description> + </param> + <param name="fileType" type="FileType" mandatory="false"> + <description>Selected file type.</description> + </param> + <param name="offset" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="false"> + <description>Optional offset in bytes for resuming partial data chunks</description> + </param> + <param name="length" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="false"> + <description>Optional length in bytes for resuming partial data chunks if offset is set to 0, then length is the total length of the file to be downloaded</description> + </param> + </function> + + <function name="GetFile" functionID="GetFileID" messagetype="response"> + <description>This response includes the data that is requested from the specific service</description> + <param name="success" type="Boolean" platform="documentation" mandatory="true"> + <description> true, if successful; false, if failed </description> + </param> + <param name="resultCode" type="Result" platform="documentation" mandatory="true"> + <description>See Result</description> + <element name="SUCCESS"/> + <element name="REJECTED"/> + <element name="DISALLOWED"/> + <element name="INVALID_DATA"/> + <element name="OUT_OF_MEMORY"/> + <element name="TOO_MANY_PENDING_REQUESTS"/> + <element name="APPLICATION_NOT_REGISTERED"/> + <element name="GENERIC_ERROR"/> + <element name="FILE_NOT_FOUND"/> + </param> + <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> + <description>Provides additional human readable info regarding the result.</description> + </param> + + <!-- Specific response data --> + <param name="offset" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="false"> + <description>Optional offset in bytes for resuming partial data chunks</description> + </param> + + <param name="length" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="false"> + <description>Optional length in bytes for resuming partial data chunks if offset is set to 0, then length is the total length of the file to be downloaded</description> + </param> + + <param name="fileType" type="FileType" mandatory="false"> + <description>File type that is being sent in response.</description> + </param> + + <param name="crc" type="Integer" minvalue="0" maxvalue="4294967295" mandatory="false"> + <description>Additional CRC32 checksum to protect data integrity up to 512 Mbits</description> + </param> + </function> + <function name="DeleteFile" functionID="DeleteFileID" messagetype="request" since="3.0"> <description> Used to delete a file resident on the module in the app's local cache. |