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-0329 OnDataResumed Notification #1129

Conversation

Jack-Byrne
Copy link
Contributor

@Jack-Byrne Jack-Byrne commented Mar 29, 2021

Introduction

This revises SDL 0329 according to the reviewed comments when this proposal was first created. Original discussion can be found here

Motivation

Revision summarized from SDLC review can be found in this comment

Proposed solution

Reduce the verbosity of the OnDataResumed notification. Instead of sending all resumed data back to the app, simply respond if the resumed data was successfully resumed or not.

If the app did not use a particular resumption data item, that value will be omitted from the notification. For example if an app resumes and was not using Remote Control subscriptions, the remoteControlSubscriptionsResumed parameter would be omitted.

<function name="OnDataResumed" functionID="OnDataResumed" messagetype="notification" since="x.x">
    <description>
        Relays resumption status to registering applicaiton. 
        Parameters will be: 
          - True if resumption was successful.
          - False if resumption was failed.
          - Omitted if no resumption data exists.
    </description>

    <param name="choiceSetsResumed" type="Bool" mandatory="false">
    </param>

    <param name="mainMenuResumed" type="Bool" mandatory="false">
    </param>

    <param name="ephemeralFilesResumed" type="Bool" mandatory="false">
    </param>

    <param name="globalPropertiesResumed" type="Bool" mandatory="false">
    </param>

    <param name="vehicleDataSubscriptionsResumed" type="Bool" mandatory="false">
    </param>

    <param name="remoteControlSubscriptionsResumed" type="Bool" mandatory="false">
    </param>

    <param name="windowInfoResumed" type="Bool" mandatory="false">
    </param>
</function>

Potential Downsides

Proposal does not alter the behavior of SDL Core to allow for partial resumption.

Alternatives considered

An alternate solution would be to include this information in the RegisterAppInterface Response since the resumption state is known before SDL Core sends the RegisterAppInterfaceResponse to an app. The author did not choose this path due to the current size of the RegisterAppInterFace response.

Other alternates considered would be to change this notification to a request so an app can request this info when necessary, or to implement a more robust resumption manager into the App Library.

@Jack-Byrne
Copy link
Contributor Author

@jordynmackool Ready for review

Copy link
Contributor

@jordynmackool jordynmackool left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @JackLivio, I have completed my review, please see my requested changes and let me know if you have any questions. Thanks!

proposals/0329-on-data-resumed.md Outdated Show resolved Hide resolved
proposals/0329-on-data-resumed.md Outdated Show resolved Hide resolved
proposals/0329-on-data-resumed.md Outdated Show resolved Hide resolved
proposals/0329-on-data-resumed.md Outdated Show resolved Hide resolved
proposals/0329-on-data-resumed.md Outdated Show resolved Hide resolved
proposals/0329-on-data-resumed.md Outdated Show resolved Hide resolved
proposals/0329-on-data-resumed.md Outdated Show resolved Hide resolved
Co-authored-by: Jordyn Mackool <42153846+jordynmackool@users.noreply.github.com>
@Jack-Byrne
Copy link
Contributor Author

@jordynmackool Ready for review

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.

2 participants