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.

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

Conversation

joeljfischer
Copy link
Contributor

Introduction

This revision adds the SubtleAlert response, which was missing from the original proposal

Motivation

Every request needs a response and this request also has an additional parameter that should be added.

Proposed solution

Add a SubtleAlert response including all the basic response parameters as well as an additional one: tryAgainTime, equivalent to the Alert parameter.

<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>

Potential downsides

None were identified

Impact on existing code

This is a fix to the proposal and no additional impact was identified

Alternatives considered

The author could not identify any alternatives

@joeljfischer
Copy link
Contributor Author

@theresalech This is ready for review

Co-authored-by: Shobhit Adlakha <ShobhitAd@users.noreply.github.com>
@joeljfischer
Copy link
Contributor Author

@theresalech This has been updated with the needed changes

@theresalech theresalech merged commit 6fd180e into smartdevicelink:master Aug 5, 2020
@joeljfischer joeljfischer deleted the 0242-subtle-alert-style-revisions branch November 1, 2021 19:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants