Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revise SDL-0242 Subtle Alert Style - Add SubtleAlert Response #1056

Merged
merged 4 commits into from
Aug 5, 2020
+37 −3
Merged

Revise SDL-0242 Subtle Alert Style - Add SubtleAlert Response #1056

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
53c4278
Add SubtleAlert response
joeljfischer Jul 28, 2020
4cd698e
Add JavaScript Suite as an affected platform
joeljfischer Jul 28, 2020
eb848cc
Merge branch 'master' into 0242-subtle-alert-style-revisions
joeljfischer Jul 28, 2020
cc9bdd8
Update proposals/0242-alert-style-subtle.md
joeljfischer Aug 5, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 37 additions & 3 deletions proposals/0242-alert-style-subtle.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
* Proposal: [SDL-0242](0242-alert-style-subtle.md)
* Author: [Joel Fischer](https://github.com/joeljfischer)
* Status: **Accepted with Revisions**
* Impacted Platforms: [Core / iOS / Java Suite / HMI / Policy Server / RPC]
* Impacted Platforms: [Core / iOS / Java Suite / JavaScript Suite / Policy Server / HMI / RPC]

## Introduction
This feature adds the `SubtleAlert` RPC, which presents a style of alert: the "subtle" alert. This is a "notification style" alert that does not take over the entire screen.
Expand Down Expand Up @@ -43,7 +43,7 @@ The proposed solution is to create a new RPC `SubtleAlert` that can be sent by d

#### Subtle Alert
```xml
<function name="SubtleAlert" functionID="SubtleAlertID" messagetype="request">
<function name="SubtleAlert" functionID="SubtleAlertID" messagetype="request" since="X.X">
<description>Shows an alert which typically consists of text-to-speech message and text on the display. At least either alertText1, alertText2 or TTSChunks need to be provided.</description>

<param name="alertText1" type="String" maxlength="500" mandatory="false">
Expand Down Expand Up @@ -90,7 +90,41 @@ The proposed solution is to create a new RPC `SubtleAlert` that can be sent by d
</param>
</function>

<function name="OnSubtleAlertPressed" functionID="OnSubtleAlertPressedID" messagetype="notification">
<function name="SubtleAlert" messagetype="response" since="X.X">
<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="INVALID_DATA"/>
<element name="OUT_OF_MEMORY"/>
<element name="TOO_MANY_PENDING_REQUESTS"/>
<element name="APPLICATION_NOT_REGISTERED"/>
<element name="GENERIC_ERROR"/>
<element name="REJECTED"/>
<element name="ABORTED"/>
<element name="DISALLOWED"/>
<element name="USER_DISALLOWED"/>
<element name="UNSUPPORTED_RESOURCE"/>
<element name="WARNINGS"/>
</param>

<param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation">
<description>Provides additional human readable info regarding the result.</description>
</param>

<param name="tryAgainTime" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="false">
<description>
Amount of time (in seconds) that an app must wait before resending an alert.
If provided, another system event or overlay currently has a higher priority than this alert.
An app must not send an alert without waiting at least the amount of time dictated.
</description>
</param>
</function>

<function name="OnSubtleAlertPressed" functionID="OnSubtleAlertPressedID" messagetype="notification" since="X.X">
<description>
Sent when the alert itself is touched (outside of a soft button). Touching (or otherwise selecting) the alert should open the app before sending this notification.
</description>
Expand Down