Merge pull request #264 from smartdevicelink/develop

SDL Core Release 8.1.0

docs/BasicCommunication/ActivateApp/index.md

@@ -40,7 +40,7 @@ If `level` is `FULL` or `LIMITED`:
   * Apply [UI.SetGlobalProperties](../../UI/SetGlobalProperties) associated with the named `appID`, if any
   * Apply [UI.AddSubMenu](../../UI/AddSubMenu) associated with the named `appID`, if any
   * Display the web page view in the main window of the application, in case the application `AppHMIType` is `WEB_VIEW` and a template has not yet been set.
-  2. Make <abbr title="Voice Recognition">VR</abbr> commands accessible from previous [VR.AddCommand](../VR/AddCommand) for the named `appID` during the same ignition cycle
+  2. Make <abbr title="Voice Recognition">VR</abbr> commands accessible from previous [VR.AddCommand](../../vr/addcommand/) for the named `appID` during the same ignition cycle
   3. Apply [TTS.SetGlobalProperties](../../TTS/SetGlobalProperties) associated with the `appID` in case previously requested since application registration
   4. Assign priority based on the `priority` parameter received. If the parameter is omitted, the HMI must assign a priority of `NONE` by default
   5. Respond with `SUCCESS` result code after the previous requirements have been met

docs/BasicCommunication/OnPutFile/index.md

@@ -51,7 +51,6 @@ The list of RPCs and data structures that `OnPutFile` affects are:
 |offset|Integer|false|minvalue: 0<br>maxvalue: 100000000000|
 |length|Integer|false|minvalue: 0<br>maxvalue: 100000000000|
 |fileSize|Integer|false|minvalue: 0<br>maxvalue: 100000000000|
-|FileName|String|true|maxlength: 255|
 |syncFileName|String|true|maxlength: 255|
 |fileType|[Common.FileType](../../common/enums/#filetype)|true||
 |persistentFile|Boolean|false|defvalue: false|
@@ -60,6 +59,12 @@ The list of RPCs and data structures that `OnPutFile` affects are:
 
 ### Sequence Diagrams
 
+!!! NOTE
+
+In the context of `PutFile` and `OnPutFile`, each of these diagrams use the term `FileName` to refer to the value of the `syncFileName` parameter
+
+!!!
+
 |||
 Put File used before referencing RPC
 ![OnPutFile](./assets/OnPutFileBeforeRPC.png)

docs/BasicCommunication/OnSystemCapabilityUpdated/index.md

@@ -11,7 +11,7 @@ Purpose
 
 ### Notification
 
-1. HMI sends OnSystemCapabilityUpdated notification to SDL after creating a widget _(see also [CreateWindow](../../UI/CreateWindow/index.md))_.
+1. HMI sends OnSystemCapabilityUpdated notification to SDL after creating a widget _(see also [CreateWindow](../../ui/createwindow/))_.
 2. HMI sends OnSystemCapabilityUpdated notification after receiving UI.Show(templateConfiguration) request manipulating the content presented of main window or widgets.
 3. HMI should not send `WEB_VIEW` template in `WindowCapability` for any widgets, and applications with `AppHMIType` other than `WEB_VIEW`.
 4. If the application changes template to `WEB_VIEW`, HMI should send OnSystemCapabilityUpdated with the following `textFields` restrictions in `WindowCapability`:

docs/Buttons/OnButtonPress/index.md

@@ -9,7 +9,7 @@ Sender
 Purpose
 : Inform SDL about a Button Press
 
-If the HMI reports to SDL via [Buttons.GetCapabilities](../getcapabilities) that it supports long and/or short button press modes, SDL expects the HMI to send the Buttons.OnButtonPress notification but buttons that have been subscribed via [Buttons.OnButtonSubscription](../onbuttonsubscription) and custom buttons added in other RPCs as Soft Buttons.
+If the HMI reports to SDL via [Buttons.GetCapabilities](../getcapabilities) that it supports long and/or short button press modes, SDL expects the HMI to send the Buttons.OnButtonPress notification but buttons that have been subscribed via [Buttons.SubscribeButton](../../buttons/subscribebutton/) and custom buttons added in other RPCs as Soft Buttons.
 
 !!! must
 

docs/SDL/ActivateApp/assets/ActivateAppRevokedPermissions.txt

@@ -0,0 +1,30 @@
+participant SDL
+
+participant HMI
+
+note over HMI: <align:center>appID_1 app is registered and is\npresent in the 'List of registered\napps' on HMI</align>
+
+note over HMI: <align:center>The User chooses to activate appID_1\napp (manually or by voice)</align>
+
+SDL<-HMI: SDL.ActiveApp{appID_1}
+
+
+note over SDL: <align:center>PT stores the device\nas consented</align>
+
+note over SDL: <align:center>PT Update comes ->\nappID_1 gets NULL\npermissions</align>
+
+SDL-->HMI:<align:center> SDL.ActiveApp\n{code:4, isSDLAllowed:true, isAppRevoked:true}
+
+note over HMI: <align:center>Do NOT activate the\nappID_1 app</align>
+
+SDL<-HMI: <align:center> SDL.GetUserFriendlyMessage\n{messageCodes: "AppUnauthorized", params}
+
+note over SDL: <align:center>Takes the information\nfrom PT</align>
+
+SDL-->HMI: SDL.GetUserFriendlyMessage {params}
+
+note over SDL:<align:center>SDL will never allow the\n appID_1 (WEB_VIEW) app\n that has NULL permissions\nto register afterwards</align>
+
+note over HMI:<align:center>Display the popup\nwith "AppUnauthorized"\nmessage</align>
+
+note over SDL:<align:center> Apps with other AppHMIType can be registered,\nbut are not allowed to be activated

docs/SDL/OnStatusUpdate/index.md

@@ -20,7 +20,7 @@ Inform the User about the status of PTU by updating the appropriate UI screens.
 !!! note
 
 SDL operates with the following PTU statuses:
-- `UPDATE_NEEDED` - one of the triggers for PTU occurs (see [BC.PolicyUpdate](../../BasicCommunication/PolicyUpdate/index.md#Request))
+- `UPDATE_NEEDED` - one of the triggers for PTU occurs (see [BC.PolicyUpdate](../../basiccommunication/policyupdate/))
 - `UPDATING` - SDL starts the PTU flow by creating the Snapshot of Local Policy Table (after receiving a successful SDL.PolicyUpdate response from HMI)
 - `UP_TO_DATE` - SDL merges the Updated Policy Table to the Local one
 

docs/TTS/GetCapabilities/index.md

@@ -34,7 +34,7 @@ This RPC has no additional parameter requirements
   1. TEXT - Plain text format. TTSChunks with this type provide plain text to be spoken in the `text` field
   2. SAPI_PHONEMES - Microsoft Speech API Format. TTSChunks with this type provide a group of phonemes with this format in the `text` field
   3. LHPLUS_PHONEMES - LH+ Phoneme format. TTSChunks with this type provide a group of phonemes with this format in the `text` field
-  4. PRE_RECORDED - Prerecorded sounds. TTSChunks with this type provide a value from [Common.PrerecordedSpeech](../../common/enums/index.md#prerecordedspeech) in the `text` field
+  4. PRE_RECORDED - Prerecorded sounds. TTSChunks with this type provide a value from [Common.PrerecordedSpeech](../../common/enums/#prerecordedspeech) in the `text` field
   5. SILENCE - Definite amount of time. TTSChunks with this type provide amount of time HMI must keep silence.
   6. FILE - Uploaded audio files. TTSChunks with this type provide a filename pointing to an audio file previously uploaded through a PutFile RPC in the `text` field
       * These audio files can be in one of the following file types/specifications, all must be supported in order for the HMI to support the `FILE` option:

docs/UI/AddCommand/index.md

@@ -17,7 +17,7 @@ UI.AddCommand represents a request from an application to add a command to the a
   2. The user must be able to enter the Menu while the related application is in the FULL state.
   3. Store the data provided in this RPC with the requesting application's appID.
   4. Add the command to the application's menu at the position specified in the `menuParams`.
-  5. If driver distraction state is enabled, the number of shown items should be limited by the driver distraction system capability parameter [menuLength](../../common/struct/#driverdistractioncapability).
+  5. If driver distraction state is enabled, the number of shown items should be limited by the driver distraction system capability parameter [menuLength](../../common/structs/#driverdistractioncapability).
   6. Renew the timeout via sending `BC.OnResetTimeout` notification to SDL in case more time for processing `UI.AddSubMenu` request is needed.
 
 !!!

docs/UI/SetDisplayLayout/index.md

@@ -9,6 +9,11 @@ Sender
 Purpose
 : Set the display template for the specified application's persistent display.
 
+!!! NOTE
+This RPC is no longer used as of SDL version 8.1.0. 
+
+SDL now transforms incoming `SetDisplayLayout` requests from mobile into [UI.Show](../Show) requests with the `templateConfiguration` parameter to change the display layout.
+!!!
 ### Request
 
 !!! must