diff options
| author | Bilal Alsharifi <599206+bilal-alsharifi@users.noreply.github.com> | 2020-09-03 16:32:00 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-09-03 16:32:00 -0400 |
| commit | 0bb42e3275615049697228c323a84ae3124d75ab (patch) | |
| tree | 69c1ff5f26d8d5fd93d3ffbc9ba54be2720e9c90 | |
| parent | 3466f07d4ad53285145997b1dcc6ca7d9855e023 (diff) | |
| download | sdl_android-0bb42e3275615049697228c323a84ae3124d75ab.tar.gz | |
[SDL 0311] Make RPC Setters Chainable (#1467)
* Make RPCs chainable (part 1)
* Make RPCs chainable (part 2)
* Add testParamsSettersAndGetters()
* Add isMandatory to Parameter
* Remove duplicate code in RPCConstructorsTests
* Fix some issues in RPCConstructorsTests
* Add more assertions to RPCConstructorsTests
* Fix failing case in RPCConstructorsTests
* Rename RPCConstructorsTests to RPCGenericTests
* Extract TEST_VALUES_CLASS var
* Update error messages in RPCGenericTests
* Use MOBILE_API.XML from rpc_spec module in RPCGenericTests
* Fix androidTest.assets.srcDirs path
* Remove MOBILE_API.xml
223 files changed, 6094 insertions, 13032 deletions
diff --git a/android/sdl_android/build.gradle b/android/sdl_android/build.gradle index d35b06c49..e92009c2a 100644 --- a/android/sdl_android/build.gradle +++ b/android/sdl_android/build.gradle @@ -35,6 +35,7 @@ android { sourceSets { main.java.srcDirs += '../../base/src/main/java' + androidTest.assets.srcDirs += '../../generator/rpc_spec/' } } diff --git a/android/sdl_android/src/androidTest/assets/xml/MOBILE_API.xml b/android/sdl_android/src/androidTest/assets/xml/MOBILE_API.xml deleted file mode 100644 index 86cfe4f5c..000000000 --- a/android/sdl_android/src/androidTest/assets/xml/MOBILE_API.xml +++ /dev/null @@ -1,8429 +0,0 @@ -<?xml version="1.0" standalone="no"?> -<?xml-stylesheet type="text/xml" href="protocol2html.xsl"?> - -<interface name="SmartDeviceLink RAPI" version="6.0.0" minVersion="1.0" date="2019-03-19"> - <enum name="Result" internal_scope="base" since="1.0"> - <element name="SUCCESS"> - <description>The request succeeded</description> - </element> - <element name="UNSUPPORTED_REQUEST"> - <description>The request is not supported by the headunit</description> - </element> - <element name="UNSUPPORTED_RESOURCE"> - <description> - A button that was requested for subscription is not supported under the current system. - </description> - </element> - <element name="DISALLOWED"> - <description>RPC is not authorized in local policy table.</description> - </element> - <element name="REJECTED"> - <description> - The requested command was rejected, e.g. because mobile app is in background and cannot perform any HMI commands. - Or an HMI command (e.g. Speak) is rejected because a higher priority HMI command (e.g. Alert) is playing. - </description> - </element> - <element name="ABORTED"> - <description> - A command was aborted, for example due to user interaction (e.g. user pressed button). - Or an HMI command (e.g. Speak) is aborted because a higher priority HMI command (e.g. Alert) was requested. - </description> - </element> - <element name="IGNORED"> - <description> - A command was ignored, because the intended result is already in effect. - For example, SetMediaClockTimer was used to pause the media clock although the clock is paused already. - NOTE: potentially replaces SUBSCRIBED_ALREADY - </description> - </element> - <element name="RETRY"> - <description>The user interrupted the RPC (e.g. PerformAudioPassThru) and indicated to start over. Note, the app must issue the new RPC.</description> - </element> - <element name="IN_USE"> - <description> - The data may not be changed, because it is currently in use. - For example when trying to delete a command set that is currently involved in an interaction. - </description> - </element> - <element name="VEHICLE_DATA_NOT_AVAILABLE" since="2.0"> - <description>The requested vehicle data is not available on this vehicle or is not published.</description> - </element> - <element name="TIMED_OUT"> - <description>Overlay reached the maximum timeout and closed.</description> - </element> - <element name="INVALID_DATA"> - <description> - The data sent is invalid. For example: - Invalid Json syntax - Parameters out of bounds (number or enum range) - Mandatory parameters not provided - Parameter provided with wrong type - Invalid characters - Empty string - </description> - </element> - <element name="CHAR_LIMIT_EXCEEDED"></element> - <element name="INVALID_ID"> - <description> - One of the provided IDs is not valid. For example - This applies to CorrelationID, SubscriptionID, CommandID, MenuID, etc. - </description> - </element> - <element name="DUPLICATE_NAME"> - <description>There was a conflict with an registered name (application or menu item) or vr command</description> - </element> - <element name="APPLICATION_NOT_REGISTERED"> - <description>An command can not be executed because no application has been registered with RegisterApplication.</description> - </element> - <element name="WRONG_LANGUAGE"> - <description> - The requested language is currently not supported. - Might be because of a mismatch of the currently active language on the headunit and the requested language - </description> - </element> - <element name="OUT_OF_MEMORY"> - <description>The system could not process the request because the necessary memory couldn't be allocated</description> - </element> - <element name="TOO_MANY_PENDING_REQUESTS"> - <description>There are too many requests pending (means, that the response has not been delivered, yet).There may be a maximum of 1000 pending requests at a time.</description> - </element> - <element name="TOO_MANY_APPLICATIONS"> - <description>There are already too many registered applications</description> - </element> - <element name="APPLICATION_REGISTERED_ALREADY"> - <description>RegisterApplication has been called again, after a RegisterApplication was successful before.</description> - </element> - <element name="WARNINGS"> - <description>The RPC (e.g. SubscribeVehicleData) executed successfully but one or more items have a warning or failure.</description> - </element> - <element name="GENERIC_ERROR"> - <description>Provided data is valid but something went wrong in the lower layers.</description> - </element> - <element name="USER_DISALLOWED" since="2.0"> - <description>RPC is included in a functional group explicitly blocked by the user.</description> - </element> - <element name="TRUNCATED_DATA"> - <description>The RPC (e.g. ReadDID) executed successfully but the data exceeded the platform maximum threshold and thus, only part of the data is available.</description> - </element> - <element name="UNSUPPORTED_VERSION" since="2.0"> - <description>Sync doesn't support the protocol that is requested by the mobile application</description> - </element> - <element name="VEHICLE_DATA_NOT_ALLOWED" since="2.0"> - <description>The user has turned off access to vehicle data, and it is globally unavailable to mobile applications.</description> - </element> - <element name="FILE_NOT_FOUND" since="3.0"> - <description>A specified file could not be found on the headunit.</description> - </element> - <element name="CANCEL_ROUTE"> - <description>User selected to Cancel Route.</description> - </element> - <element name="SAVED" since="2.0"> - <description>The RPC (e.g. Slider) executed successfully and the user elected to save the current position / value.</description> - </element> - <element name="INVALID_CERT" since="3.0"> - <description>The certificate provided during authentication is invalid.</description> - </element> - <element name="EXPIRED_CERT" since="3.0"> - <description>The certificate provided during authentication is expired.</description> - </element> - <element name="RESUME_FAILED" since="3.0"> - <description>The provided hash ID does not match the hash of the current set of registered data or the core could not resume the previous data.</description> - </element> - <element name="DATA_NOT_AVAILABLE" since="4.5"> - <description>The requested information is currently not available. This is different than UNSUPPORTED_RESOURCE because it implies the data is at some point available. </description> - </element> - <element name="READ_ONLY" since="4.5"> - <description>The value being set is read only</description> - </element> - <element name="CORRUPTED_DATA" since="5.0"> - <description>The data sent failed to pass CRC check in receiver end</description> - </element> - <element name="ENCRYPTION_NEEDED" since="6.0"> - <description>SDL receives an un-encrypted RPC request that needs protection. </description> - </element> - </enum> - - <enum name="ButtonPressMode" since="1.0"> - <element name="LONG"> - <description> - A button was released, after it was pressed for a long time - Actual timing is defined by the headunit and may vary - </description> - </element> - <element name="SHORT"> - <description> - A button was released, after it was pressed for a short time - Actual timing is defined by the headunit and may vary - </description> - </element> - </enum> - - <enum name="ButtonEventMode" since="1.0"> - <element name="BUTTONUP"> - <description>A button has been released up</description> - </element> - <element name="BUTTONDOWN"> - <description>A button has been pressed down</description> - </element> - </enum> - - <enum name="Language" since="1.0"> - <element name="EN-US" internal_name="EN_US"> - <description>English - US</description> - </element> - <element name="ES-MX" internal_name="ES_MX"> - <description>Spanish - Mexico</description> - </element> - <element name="FR-CA" internal_name="FR_CA"> - <description>French - Canada</description> - </element> - <element name="DE-DE" internal_name="DE_DE" since="2.0"> - <description>German - Germany</description> - </element> - <element name="ES-ES" internal_name="ES_ES" since="2.0"> - <description>Spanish - Spain</description> - </element> - <element name="EN-GB" internal_name="EN_GB" since="2.0"> - <description>English - GB</description> - </element> - <element name="RU-RU" internal_name="RU_RU" since="2.0"> - <description>Russian - Russia</description> - </element> - <element name="TR-TR" internal_name="TR_TR" since="2.0"> - <description>Turkish - Turkey</description> - </element> - <element name="PL-PL" internal_name="PL_PL" since="2.0"> - <description>Polish - Poland</description> - </element> - <element name="FR-FR" internal_name="FR_FR" since="2.0"> - <description>French - France</description> - </element> - <element name="IT-IT" internal_name="IT_IT" since="2.0"> - <description>Italian - Italy</description> - </element> - <element name="SV-SE" internal_name="SV_SE" since="2.0"> - <description>Swedish - Sweden</description> - </element> - <element name="PT-PT" internal_name="PT_PT" since="2.0"> - <description>Portuguese - Portugal</description> - </element> - <element name="NL-NL" internal_name="NL_NL" since="2.0"> - <description>Dutch (Standard) - Netherlands</description> - </element> - <element name="EN-AU" internal_name="EN_AU" since="2.0"> - <description>English - Australia</description> - </element> - <element name="ZH-CN" internal_name="ZH_CN" since="2.0"> - <description>Mandarin - China</description> - </element> - <element name="ZH-TW" internal_name="ZH_TW" since="2.0"> - <description>Mandarin - Taiwan</description> - </element> - <element name="JA-JP" internal_name="JA_JP" since="2.0"> - <description>Japanese - Japan</description> - </element> - <element name="AR-SA" internal_name="AR_SA" since="2.0"> - <description>Arabic - Saudi Arabia</description> - </element> - <element name="KO-KR" internal_name="KO_KR" since="2.0"> - <description>Korean - South Korea</description> - </element> - <element name="PT-BR" internal_name="PT_BR" since="2.0"> - <description>Portuguese - Brazil</description> - </element> - <element name="CS-CZ" internal_name="CS_CZ" since="2.0"> - <description>Czech - Czech Republic</description> - </element> - <element name="DA-DK" internal_name="DA_DK" since="2.0"> - <description>Danish - Denmark</description> - </element> - <element name="NO-NO" internal_name="NO_NO" since="2.0"> - <description>Norwegian - Norway</description> - </element> - <element name="NL-BE" internal_name="NL_BE" since="2.0"> - <description>Dutch (Flemish) - Belgium</description> - </element> - <element name="EL-GR" internal_name="EL_GR" since="2.0"> - <description>Greek - Greece</description> - </element> - <element name="HU-HU" internal_name="HU_HU" since="2.0"> - <description>Hungarian - Hungary</description> - </element> - <element name="FI-FI" internal_name="FI_FI" since="2.0"> - <description>Finnish - Finland</description> - </element> - <element name="SK-SK" internal_name="SK_SK" since="2.0"> - <description>Slovak - Slovakia</description> - </element> - <element name="EN-IN" internal_name="EN_IN" since="4.5"> - <description>English - India</description> - </element> - <element name="TH-TH" internal_name="TH_TH" since="4.5"> - <description>Thai - Thailand</description> - </element> - <element name="EN-SA" internal_name="EN_SA" since="4.5"> - <description>English - Middle East</description> - </element> - <element name="HE-IL" internal_name="HE_IL" since="4.5"> - <description>Hebrew - Israel</description> - </element> - <element name="RO-RO" internal_name="RO_RO" since="4.5"> - <description>Romanian - Romania</description> - </element> - <element name="UK-UA" internal_name="UK_UA" since="4.5"> - <description>Ukrainian - Ukraine</description> - </element> - <element name="ID-ID" internal_name="ID_ID" since="4.5"> - <description>Indonesian - Indonesia</description> - </element> - <element name="VI-VN" internal_name="VI_VN" since="4.5"> - <description>Vietnamese - Vietnam</description> - </element> - <element name="MS-MY" internal_name="MS_MY" since="4.5"> - <description>Malay - Malaysia</description> - </element> - <element name="HI-IN" internal_name="HI_IN" since="4.5"> - <description>Hindi - India</description> - </element> - </enum> - - <enum name="UpdateMode" since="1.0"> - <description>Describes how the media clock timer should behave on the platform</description> - <element name="COUNTUP" > - <description>Starts the media clock timer counting upwards, as in time elapsed.</description> - </element> - <element name="COUNTDOWN" > - <description>Starts the media clock timer counting downwards, as in time remaining.</description> - </element> - <element name="PAUSE" > - <description>Pauses the media clock timer</description> - </element> - <element name="RESUME" > - <description>Resume the media clock timer</description> - </element> - <element name="CLEAR" > - <description>Clears the media clock timer (previously done through Show->mediaClock)</description> - </element> - </enum> - - <enum name="TimerMode" since="1.0"> - <element name="UP" > - <description>Causes the media clock timer to update from 0:00 to a specified time</description> - </element> - <element name="DOWN" > - <description>Causes the media clock timer to update from a specified time to 0:00</description> - </element> - <element name="NONE" > - <description>Indicates to not use the media clock timer</description> - </element> - </enum> - - <enum name="InteractionMode" since="1.0"> - <description>For application-requested interactions, this mode indicates the method in which the user is notified and uses the interaction.</description> - <element name="MANUAL_ONLY" > - <description>This mode causes the interaction to only occur on the display, meaning the choices are provided only via the display. No Voice Interaction.</description> - </element> - <element name="VR_ONLY" > - <description>This mode causes the interaction to only occur using the headunits VR system. Selections are made by saying the command.</description> - </element> - <element name="BOTH" > - <description>This mode causes both a VR and display selection option for an interaction. The user will first be asked via Voice Interaction (if available). If this is unsuccessful, the system will switch to manual input.</description> - </element> - </enum> - - <enum name="LayoutMode" since="3.0"> - <description>For touchscreen interactions, the mode of how the choices are presented.</description> - <element name="ICON_ONLY" > - <description>This mode causes the interaction to display the previous set of choices as icons.</description> - </element> - <element name="ICON_WITH_SEARCH" > - <description>This mode causes the interaction to display the previous set of choices as icons along with a search field in the HMI.</description> - </element> - <element name="LIST_ONLY" > - <description>This mode causes the interaction to display the previous set of choices as a list.</description> - </element> - <element name="LIST_WITH_SEARCH" > - <description>This mode causes the interaction to display the previous set of choices as a list along with a search field in the HMI.</description> - </element> - <element name="KEYBOARD" > - <description>This mode causes the interaction to immediately display a keyboard entry through the HMI.</description> - </element> - </enum> - - <enum name="WindowType" since="6.0"> - <element name="MAIN"> - <description> - This window type describes the main window on a display. - </description> - </element> - <element name="WIDGET"> - <description> - A widget is a small window that the app can create to provide information and soft buttons for quick app control. - </description> - </element> - </enum> - - <enum name="PredefinedWindows" since="6.0"> - <element name="DEFAULT_WINDOW" value="0"> - <description>The default window is a main window pre-created on behalf of the app.</description> - </element> - <element name="PRIMARY_WIDGET" value="1"> - <description>The primary widget of the app.</description> - </element> - </enum> - - <enum name="HMILevel" since="1.0"> - <description>Enumeration that describes current levels of HMI.</description> - <element name="FULL" internal_name="HMI_FULL" /> - <element name="LIMITED" internal_name="HMI_LIMITED" /> - <element name="BACKGROUND" internal_name="HMI_BACKGROUND" /> - <element name="NONE" internal_name="HMI_NONE" /> - </enum> - - <enum name="AudioStreamingState" since="1.0"> - <description>Enumeration that describes possible states of audio streaming.</description> - <element name="AUDIBLE" /> - <element name="ATTENUATED" /> - <element name="NOT_AUDIBLE" /> - </enum> - - <enum name="SystemAction" since="1.0"> - <description>Enumeration that describes system actions that can be triggered.</description> - <element name="DEFAULT_ACTION"> - <description>Default action occurs. Standard behavior (e.g. SoftButton clears overlay).</description> - </element> - <element name="STEAL_FOCUS"> - <description>App is brought into HMI_FULL.</description> - </element> - <element name="KEEP_CONTEXT"> - <description>Current system context is maintained. An overlay is persisted even though a SoftButton has been pressed and the notification sent.</description> - </element> - </enum> - - <enum name="SystemContext" since="1.0"> - <description>Enumeration that describes possible contexts an app's HMI might be in. Communicated to whichever app is in HMI FULL, except Alert.</description> - <element name="MAIN" internal_name="SYSCTXT_MAIN"> - <description>The app's persistent display (whether media/non-media/navigation) is fully visible onscreen.</description> - </element> - <element name="VRSESSION" internal_name="SYSCTXT_VRSESSION"> - <description>The system is currently in a VR session (with whatever dedicated VR screen being overlaid onscreen).</description> - </element> - <element name="MENU" internal_name="SYSCTXT_MENU"> - <description>The system is currently displaying an in-App menu onscreen.</description> - </element> - <element name="HMI_OBSCURED" internal_name="SYSCTXT_HMI_OBSCURED"> - <description>The app's display HMI is currently being obscured by either a system or other app's overlay.</description> - </element> - <element name="ALERT" internal_name="SYSCTXT_ALERT"> - <description>Broadcast only to whichever app has an alert currently being displayed.</description> - </element> - </enum> - - <enum name="VideoStreamingState" since="5.0"> - <description>Enumeration that describes possible states of video streaming. </description> - <element name="STREAMABLE" /> - <element name="NOT_STREAMABLE" /> - </enum> - - <enum name="SoftButtonType" since="2.0"> - <description>Contains information about the SoftButton capabilities.</description> - <element name="TEXT" internal_name="SBT_TEXT"/> - <element name="IMAGE" internal_name="SBT_IMAGE"/> - <element name="BOTH" internal_name="SBT_BOTH"/> - </enum> - - <enum name="AppInterfaceUnregisteredReason" since="1.0"> - <description>Error code, which comes from the module side.</description> - <!-- Deprecate - <element name="USER_EXIT" /> - --> - <element name="IGNITION_OFF" /> - <element name="BLUETOOTH_OFF" /> - <element name="USB_DISCONNECTED" /> - <element name="REQUEST_WHILE_IN_NONE_HMI_LEVEL" /> - <element name="TOO_MANY_REQUESTS" /> - <element name="DRIVER_DISTRACTION_VIOLATION" /> - <element name="LANGUAGE_CHANGE" /> - <element name="MASTER_RESET" /> - <element name="FACTORY_DEFAULTS" /> - <element name="APP_UNAUTHORIZED" since="2.0" /> - <element name="PROTOCOL_VIOLATION" since="4.0" /> - <element name="UNSUPPORTED_HMI_RESOURCE" since="4.1" /> - </enum> - - <enum name="TriggerSource" since="1.0"> - <description>Indicates the source from where the command was triggered.</description> - <element name="MENU" internal_name="TS_MENU" /> - <element name="VR" internal_name="TS_VR" /> - <element name="KEYBOARD" internal_name="TS_KEYBOARD" since="3.0" /> - </enum> - - <enum name="HmiZoneCapabilities" since="1.0"> - <description>Contains information about the HMI zone capabilities.</description> - <description>For future use.</description> - <element name="FRONT" /> - <element name="BACK" /> - </enum> - - <enum name="SpeechCapabilities" since="1.0"> - <description>Contains information about the TTS capabilities.</description> - <element name="TEXT" internal_name="SC_TEXT"/> - <element name="SAPI_PHONEMES" /> - <element name="LHPLUS_PHONEMES" /> - <element name="PRE_RECORDED" /> - <element name="SILENCE" /> - <element name="FILE" since="5.0" /> - </enum> - - <enum name="VrCapabilities" since="1.0"> - <description>Contains information about the VR capabilities.</description> - <element name="TEXT" internal_name="VR_TEXT"/> - </enum> - - <enum name="PrerecordedSpeech" since="1.0"> - <description>Contains a list of prerecorded speech items present on the platform.</description> - <element name="HELP_JINGLE" /> - <element name="INITIAL_JINGLE" /> - <element name="LISTEN_JINGLE" /> - <element name="POSITIVE_JINGLE" /> - <element name="NEGATIVE_JINGLE" /> - </enum> - - <enum name="SamplingRate" since="2.0"> - <description>Describes different sampling options for PerformAudioPassThru.</description> - <element name="8KHZ" internal_name="SamplingRate_8KHZ"> - <description>Sampling rate of 8000 Hz.</description> - </element> - <element name="16KHZ" internal_name="SamplingRate_16KHZ"> - <description>Sampling rate of 16000 Hz.</description> - </element> - <element name="22KHZ" internal_name="SamplingRate_22KHZ"> - <description>Sampling rate of 22050 Hz.</description> - </element> - <element name="44KHZ" internal_name="SamplingRate_44KHZ"> - <description>Sampling rate of 44100 Hz.</description> - </element> - </enum> - - <enum name="BitsPerSample" since="2.0"> - <description>Describes different quality options for PerformAudioPassThru.</description> - <element name="8_BIT" internal_name="BitsPerSample_8_BIT"> - <description>Audio sample is 8 bits wide, unsigned.</description> - </element> - <element name="16_BIT" internal_name="BitsPerSample_16_BIT"> - <description>Audio sample is 16 bits wide, signed, and in little endian.</description> - </element> - </enum> - - <enum name="AudioType" since="2.0"> - <description>Describes different audio type options for PerformAudioPassThru.</description> - <element name="PCM"> - <description>Linear PCM.</description> - </element> - </enum> - - <struct name="AudioPassThruCapabilities" since="2.0"> - <description> - Describes different audio type configurations for PerformAudioPassThru. - e.g. {8kHz,8-bit,PCM} - The audio is recorded in monaural. - </description> - <param name="samplingRate" type="SamplingRate" mandatory="true"/> - <param name="bitsPerSample" type="BitsPerSample" mandatory="true"/> - <param name="audioType" type="AudioType" mandatory="true"/> - </struct> - - <enum name="VehicleDataType" since="2.0"> - <description>Defines the data types that can be published and subscribed to.</description> - <element name="VEHICLEDATA_GPS"> - <description>Notifies GPSData may be subscribed</description> - </element> - <element name="VEHICLEDATA_SPEED" /> - <element name="VEHICLEDATA_RPM" /> - <element name="VEHICLEDATA_FUELLEVEL" /> - <element name="VEHICLEDATA_FUELLEVEL_STATE" /> - <element name="VEHICLEDATA_FUELCONSUMPTION" /> - <element name="VEHICLEDATA_EXTERNTEMP" /> - <element name="VEHICLEDATA_VIN" /> - <element name="VEHICLEDATA_PRNDL" /> - <element name="VEHICLEDATA_TIREPRESSURE" /> - <element name="VEHICLEDATA_ODOMETER" /> - <element name="VEHICLEDATA_BELTSTATUS" /> - <element name="VEHICLEDATA_BODYINFO" /> - <element name="VEHICLEDATA_DEVICESTATUS" /> - <element name="VEHICLEDATA_ECALLINFO" /> - <element name="VEHICLEDATA_AIRBAGSTATUS" /> - <element name="VEHICLEDATA_EMERGENCYEVENT" /> - <element name="VEHICLEDATA_CLUSTERMODESTATUS" /> - <element name="VEHICLEDATA_MYKEY" /> - <element name="VEHICLEDATA_BRAKING" /> - <element name="VEHICLEDATA_WIPERSTATUS" /> - <element name="VEHICLEDATA_HEADLAMPSTATUS" /> - <element name="VEHICLEDATA_BATTVOLTAGE" /> - <element name="VEHICLEDATA_ENGINETORQUE" /> - <element name="VEHICLEDATA_ACCPEDAL" /> - <element name="VEHICLEDATA_STEERINGWHEEL" /> - <element name="VEHICLEDATA_TURNSIGNAL" since="5.0" /> - <element name="VEHICLEDATA_FUELRANGE" since="5.0" /> - <element name="VEHICLEDATA_ENGINEOILLIFE" since="5.0" /> - <element name="VEHICLEDATA_ELECTRONICPARKBRAKESTATUS" since="5.0" /> - <element name="VEHICLEDATA_CLOUDAPPVEHICLEID" since="5.1"/> - <element name="VEHICLEDATA_OEM_CUSTOM_DATA" since="6.0"/> - </enum> - - <enum name="HybridAppPreference" since="5.1"> - <description>Enumeration for the user's preference of which app type to use when both are available</description> - <element name="MOBILE" /> - <element name="CLOUD" /> - <element name="BOTH" /> - </enum> - - <struct name="CloudAppProperties" since="5.1"> - <param name="nicknames" type="String" minlength="0" maxlength="100" array="true" minsize="0" maxsize="100" mandatory="false"> - <description>An array of app names a cloud app is allowed to register with. If included in a SetCloudAppProperties request, this value will overwrite the existing "nicknames" field in the app policies section of the policy table.</description> - </param> - <param name="appID" type="String" maxlength="100" mandatory="true"/> - <param name="enabled" type="Boolean" mandatory="false"> - <description>If true, cloud app will be included in HMI RPC UpdateAppList</description> - </param> - <param name="authToken" type="String" maxlength="65535" mandatory="false"> - <description>Used to authenticate websocket connection on app activation</description> - </param> - <param name="cloudTransportType" type="String" maxlength="100" mandatory="false"> - <description>Specifies the connection type Core should use</description> - </param> - <param name="hybridAppPreference" type="HybridAppPreference" mandatory="false"> - <description>Specifies the user preference to use the cloud app version or mobile app version when both are available</description> - </param> - <param name="endpoint" type="String" maxlength="65535" mandatory="false"> - <description>Specifies the endpoint which Core will attempt to connect to when this app is selected</description> - </param> - </struct> - - <enum name="ButtonName" since="1.0"> - <description>Defines the hard (physical) and soft (touchscreen) buttons available from the module</description> - <element name="OK" /> - <element name="PLAY_PAUSE" since="5.0"> - <description> - The button name for the physical Play/Pause - toggle that can be used by media apps. - </description> - <warning> - Please use the physical OK button in order to - use a Play/Pause toggle for versions < 4.5.0. - </warning> - </element> - <element name="SEEKLEFT" /> - <element name="SEEKRIGHT" /> - <element name="TUNEUP" /> - <element name="TUNEDOWN" /> - <element name="PRESET_0" /> - <element name="PRESET_1" /> - <element name="PRESET_2" /> - <element name="PRESET_3" /> - <element name="PRESET_4" /> - <element name="PRESET_5" /> - <element name="PRESET_6" /> - <element name="PRESET_7" /> - <element name="PRESET_8" /> - <element name="PRESET_9" /> - <element name="CUSTOM_BUTTON" /> - <element name="SEARCH" /> - <!-- Climate Buttons --> - <element name="AC_MAX" since="4.5" /> - <element name="AC" since="4.5" /> - <element name="RECIRCULATE" since="4.5" /> - <element name="FAN_UP" since="4.5" /> - <element name="FAN_DOWN" since="4.5" /> - <element name="TEMP_UP" since="4.5" /> - <element name="TEMP_DOWN" since="4.5" /> - <element name="DEFROST_MAX" since="4.5" /> - <element name="DEFROST" since="4.5" /> - <element name="DEFROST_REAR" since="4.5" /> - <element name="UPPER_VENT" since="4.5" /> - <element name="LOWER_VENT" since="4.5" /> - <!-- Radio Buttons --> - <element name="VOLUME_UP" since="4.5" /> - <element name="VOLUME_DOWN" since="4.5" /> - <element name="EJECT" since="4.5" /> - <element name="SOURCE" since="4.5" /> - <element name="SHUFFLE" since="4.5" /> - <element name="REPEAT" since="4.5" /> - <!-- Navigation Buttons --> - <element name="NAV_CENTER_LOCATION" since="6.0" /> - <element name="NAV_ZOOM_IN" since="6.0" /> - <element name="NAV_ZOOM_OUT" since="6.0" /> - <element name="NAV_PAN_UP" since="6.0" /> - <element name="NAV_PAN_UP_RIGHT" since="6.0" /> - <element name="NAV_PAN_RIGHT" since="6.0" /> - <element name="NAV_PAN_DOWN_RIGHT" since="6.0" /> - <element name="NAV_PAN_DOWN" since="6.0" /> - <element name="NAV_PAN_DOWN_LEFT" since="6.0" /> - <element name="NAV_PAN_LEFT" since="6.0" /> - <element name="NAV_PAN_UP_LEFT" since="6.0" /> - <element name="NAV_TILT_TOGGLE" since="6.0" > - <description>If supported, this toggles between a top-down view and an angled/3D view. If your app supports different, but substantially similar options, then you may implement those. If you don't implement these or similar options, do not subscribe to this button.</description> - </element> - <element name="NAV_ROTATE_CLOCKWISE" since="6.0" /> - <element name="NAV_ROTATE_COUNTERCLOCKWISE" since="6.0" /> - <element name="NAV_HEADING_TOGGLE" since="6.0" > - <description>If supported, this toggles between locking the orientation to north or to the vehicle's heading. If your app supports different, but substantially similar options, then you may implement those. If you don't implement these or similar options, do not subscribe to this button.</description> - </element> - </enum> - - <enum name="MediaClockFormat" since="1.0"> - <element name="CLOCK1"> - <description> - minutesFieldWidth = 2;minutesFieldMax = 19;secondsFieldWidth = 2;secondsFieldMax = 99;maxHours = 19;maxMinutes = 59;maxSeconds = 59; - used for Type II and CID headunits - </description> - </element> - <element name="CLOCK2"> - <description> - minutesFieldWidth = 3;minutesFieldMax = 199;secondsFieldWidth = 2;secondsFieldMax = 99;maxHours = 59;maxMinutes = 59;maxSeconds = 59; - used for Type V headunit - </description> - </element> - <element name="CLOCK3" since="2.0"> - <description> - minutesFieldWidth = 2;minutesFieldMax = 59;secondsFieldWidth = 2;secondsFieldMax = 59;maxHours = 9;maxMinutes = 59;maxSeconds = 59; - used for GEN1.1 MFD3/4/5 headunits - </description> - </element> - <element name="CLOCKTEXT1"> - <description> - 5 characters possible - Format: 1|sp c :|sp c c - 1|sp : digit "1" or space - c : character out of following character set: sp|0-9|[letters, see TypeII column in XLS. See [@TODO: create file ref]] - :|sp : colon or space - used for Type II headunit - </description> - </element> - <element name="CLOCKTEXT2"> - <description> - 5 chars possible - Format: 1|sp c :|sp c c - 1|sp : digit "1" or space - c : character out of following character set: sp|0-9|[letters, see CID column in XLS. See [@TODO: create file ref]] - :|sp : colon or space - used for CID headunit - NOTE: difference between CLOCKTEXT1 and CLOCKTEXT2 is the supported character set - </description> - </element> - <element name="CLOCKTEXT3"> - <description> - 6 chars possible - Format: 1|sp c c :|sp c c - 1|sp : digit "1" or space - c : character out of following character set: sp|0-9|[letters, see Type 5 column in XLS]. See [@TODO: create file ref] - :|sp : colon or space - used for Type V headunit - </description> - </element> - <element name="CLOCKTEXT4" since="2.0"> - <description> - 6 chars possible - Format: c :|sp c c : c c - :|sp : colon or space - c : character out of following character set: sp|0-9|[letters]. - used for GEN1.1 MFD3/4/5 headunits - </description> - </element> - </enum> - - <enum name="DisplayType" deprecated="true" since="5.0"> - <description>See DAES for further infos regarding the displays</description> - <element name="CID"/> - <element name="TYPE2" /> - <element name="TYPE5" /> - <element name="NGN" /> - <element name="GEN2_8_DMA" since="3.0" /> - <element name="GEN2_6_DMA" since="3.0" /> - <element name="MFD3" since="2.0" /> - <element name="MFD4" since="2.0" /> - <element name="MFD5" since="2.0" /> - <element name="GEN3_8-INCH" internal_name="GEN3_8_INCH" since="3.0" /> - <element name="SDL_GENERIC" since="4.0" /> - <history> - <enum name="DisplayType" since="1.0" until="5.0"/> - </history> - </enum> - - <enum name="TextFieldName" since="1.0"> - <element name="mainField1"> - <description>The first line of first set of main fields of the persistent display; applies to "Show"</description> - </element> - - <element name="mainField2"> - <description>The second line of first set of main fields of the persistent display; applies to "Show"</description> - </element> - - <element name="mainField3"> - <description>The first line of second set of main fields of persistent display; applies to "Show"</description> - </element> - - <element name="mainField4"> - <description>The second line of second set of main fields of the persistent display; applies to "Show"</description> - </element> - - <element name="statusBar"> - <description>The status bar on NGN; applies to "Show"</description> - </element> - - <element name="mediaClock"> - <description>Text value for MediaClock field; applies to "Show"</description> - </element> - - <element name="mediaTrack"> - <description>The track field of NGN and GEN1.1 MFD displays. This field is only available for media applications; applies to "Show"</description> - </element> - - <element name="templateTitle" since="6.0"> - <description>The title of the new template that will be displayed; applies to "Show"</description> - </element> - - <element name="alertText1"> - <description>The first line of the alert text field; applies to "Alert"</description> - </element> - - <element name="alertText2" since="2.0"> - <description>The second line of the alert text field; applies to "Alert"</description> - </element> - - <element name="alertText3" since="2.0"> - <description>The third line of the alert text field; applies to "Alert"</description> - </element> - - <element name="scrollableMessageBody" since="2.0"> - <description>Long form body of text that can include newlines and tabs; applies to "ScrollableMessage"</description> - </element> - - <element name="initialInteractionText" since="2.0"> - <description> First line suggestion for a user response (in the case of VR enabled interaction)</description> - </element> - - <element name="navigationText1" since="2.0"> - <description> First line of navigation text</description> - </element> - - <element name="navigationText2" since="2.0"> - <description> Second line of navigation text</description> - </element> - - <element name="ETA" since="2.0"> - <description> Estimated Time of Arrival time for navigation</description> - </element> - - <element name="totalDistance" since="2.0"> - <description> Total distance to destination for navigation</description> - </element> - - <element name="audioPassThruDisplayText1" since="2.0"> - <description> First line of text for audio pass thru</description> - </element> - - <element name="audioPassThruDisplayText2" since="2.0"> - <description> Second line of text for audio pass thru</description> - </element> - - <element name="sliderHeader" since="2.0"> - <description> Header text for slider</description> - </element> - - <element name="sliderFooter" since="2.0"> - <description> Footer text for slider</description> - </element> - - <element name="menuName"> - <description> Primary text for Choice</description> - </element> - - <element name="secondaryText"> - <description> Secondary text for Choice</description> - </element> - - <element name="tertiaryText"> - <description> Tertiary text for Choice</description> - </element> - - <element name="menuTitle"> - <description> Optional text to label an app menu button (for certain touchscreen platforms).</description> - </element> - - <element name="locationName" since="4.0"> - <description> Optional name / title of intended location for SendLocation.</description> - </element> - - <element name="locationDescription" since="4.0"> - <description> Optional description of intended location / establishment (if applicable) for SendLocation.</description> - </element> - - <element name="addressLines" since="4.0"> - <description> Optional location address (if applicable) for SendLocation.</description> - </element> - - <element name="phoneNumber" since="4.0"> - <description> Optional hone number of intended location / establishment (if applicable) for SendLocation.</description> - </element> - - </enum> - - <enum name="ImageFieldName" since="3.0"> - <element name="softButtonImage"> - <description>The image field for SoftButton</description> - </element> - - <element name="choiceImage"> - <description>The first image field for Choice</description> - </element> - - <element name="choiceSecondaryImage"> - <description>The secondary image field for Choice</description> - </element> - - <element name="vrHelpItem"> - <description>The image field for vrHelpItem</description> - </element> - - <element name="turnIcon"> - <description>The image field for Turn</description> - </element> - - <element name="menuIcon"> - <description>The image field for the menu icon in SetGlobalProperties</description> - </element> - - <element name="cmdIcon"> - <description>The image field for AddCommand</description> - </element> - - <element name="appIcon"> - <description>The image field for the app icon (set by setAppIcon)</description> - </element> - - <element name="graphic"> - <description>The primary image field for Show</description> - </element> - - <element name="secondaryGraphic" since="5.0"> - <description>The secondary image field for Show</description> - </element> - - <element name="showConstantTBTIcon"> - <description>The primary image field for ShowConstantTBT</description> - </element> - - <element name="showConstantTBTNextTurnIcon"> - <description>The secondary image field for ShowConstantTBT</description> - </element> - - <element name="locationImage" since="4.0"> - <description>The optional image of a destination / location</description> - </element> - - <element name="alertIcon" since="6.0"> - <description>The image field for Alert</description> - </element> - - </enum> - - <enum name="CharacterSet" since="1.0"> - <description>The list of potential character sets</description> - <element name="TYPE2SET"> - <description>See [@TODO: create file ref]</description> - </element> - <element name="TYPE5SET"> - <description>See [@TODO: create file ref]</description> - </element> - <element name="CID1SET"> - <description>See [@TODO: create file ref]</description> - </element> - <element name="CID2SET"> - <description>See [@TODO: create file ref]</description> - </element> - </enum> - - <enum name="TextAlignment" since="1.0"> - <description>The list of possible alignments, left, right, or centered</description> - <element name="LEFT_ALIGNED" /> - <element name="RIGHT_ALIGNED" /> - <element name="CENTERED" /> - </enum> - - <enum name="TBTState" since="2.0"> - <description>Enumeration that describes possible states of turn-by-turn client or SmartDeviceLink app.</description> - <element name="ROUTE_UPDATE_REQUEST" /> - <element name="ROUTE_ACCEPTED" /> - <element name="ROUTE_REFUSED" /> - <element name="ROUTE_CANCELLED" /> - <element name="ETA_REQUEST" /> - <element name="NEXT_TURN_REQUEST" /> - <element name="ROUTE_STATUS_REQUEST" /> - <element name="ROUTE_SUMMARY_REQUEST" /> - <element name="TRIP_STATUS_REQUEST" /> - <element name="ROUTE_UPDATE_REQUEST_TIMEOUT" /> - </enum> - - <enum name="DriverDistractionState" since="2.0"> - <description>Enumeration that describes possible states of driver distraction.</description> - <element name="DD_ON" /> - <element name="DD_OFF" /> - </enum> - - <enum name="ImageType" since="2.0"> - <description>Contains information about the type of image.</description> - <element name="STATIC" /> - <element name="DYNAMIC" /> - </enum> - - <enum name="DeliveryMode" since="4.1"> - <description>The mode in which the SendLocation request is sent</description> - <element name="PROMPT" /> - <element name="DESTINATION" /> - <element name="QUEUE" /> - </enum> - - <enum name="VideoStreamingProtocol" since="4.5"> - <description>Enum for each type of video streaming protocol type.</description> - <element name="RAW"> - <description>Raw stream bytes that contains no timestamp data and is the lowest supported video streaming</description> - </element> - <element name="RTP"> - <description>RTP facilitates the transfer of real-time data. Information provided by this protocol include timestamps (for synchronization), sequence numbers (for packet loss and reordering detection) and the payload format which indicates the encoded format of the data.</description> - </element> - <element name="RTSP"> - <description>The transmission of streaming data itself is not a task of RTSP. Most RTSP servers use the Real-time Transport Protocol (RTP) in conjunction with Real-time Control Protocol (RTCP) for media stream delivery. However, some vendors implement proprietary transport protocols. </description> - </element> - <element name="RTMP"> - <description> Real-Time Messaging Protocol (RTMP) was initially a proprietary protocol developed by Macromedia for streaming audio, video and data over the Internet, between a Flash player and a server. Macromedia is now owned by Adobe, which has released an incomplete version of the specification of the protocol for public use.</description> - </element> - <element name="WEBM"> - <description>The WebM container is based on a profile of Matroska. WebM initially supported VP8 video and Vorbis audio streams. In 2013 it was updated to accommodate VP9 video and Opus audio.</description> - </element> - </enum> - - <enum name="VideoStreamingCodec" since="4.5"> - <description>Enum for each type of video streaming codec.</description> - <element name="H264"> - <description>A block-oriented motion-compensation-based video compression standard. As of 2014 it is one of the most commonly used formats for the recording, compression, and distribution of video content.</description> - </element> - <element name="H265"> - <description>High Efficiency Video Coding (HEVC), also known as H.265 and MPEG-H Part 2, is a video compression standard, one of several potential successors to the widely used AVC (H.264 or MPEG-4 Part 10). In comparison to AVC, HEVC offers about double the data compression ratio at the same level of video quality, or substantially improved video quality at the same bit rate. It supports resolutions up to 8192x4320, including 8K UHD.</description> - </element> - <element name="Theora"> - <description>Theora is derived from the formerly proprietary VP3 codec, released into the public domain by On2 Technologies. It is broadly comparable in design and bitrate efficiency to MPEG-4 Part 2, early versions of Windows Media Video, and RealVideo while lacking some of the features present in some of these other codecs. It is comparable in open standards philosophy to the BBC's Dirac codec.</description> - </element> - <element name="VP8"> - <description>VP8 can be multiplexed into the Matroska-based container format WebM along with Vorbis and Opus audio. The image format WebP is based on VP8's intra-frame coding. VP8's direct successor, VP9, and the emerging royalty-free internet video format AV1 from the Alliance for Open Media (AOMedia) are based on VP8.</description> - </element> - <element name="VP9"> - <description>Similar to VP8, but VP9 is customized for video resolutions beyond high-definition video (UHD) and also enables lossless compression.</description> - </element> - </enum> - - <enum name="AudioStreamingIndicator" since="5.0"> - <element name="PLAY_PAUSE"> - <description> - Default playback indicator. - By default the playback indicator should be PLAY_PAUSE when: - - the media app is newly registered on the head unit (after RegisterAppInterface) - - the media app was closed by the user (App enters HMI_NONE) - - the app sends SetMediaClockTimer with audioStreamingIndicator not set to any value - </description> - </element> - <element name="PLAY"> - <description>Indicates that a button press of the Play/Pause button starts the audio playback.</description> - </element> - <element name="PAUSE"> - <description>Indicates that a button press of the Play/Pause button pauses the current audio playback.</description> - </element> - <element name="STOP"> - <description>Indicates that a button press of the Play/Pause button stops the current audio playback.</description> - </element> - </enum> - - <struct name="Image" since="2.0"> - <param name="value" minlength="0" maxlength="65535" type="String" mandatory="true"> - <description>Either the static hex icon value or the binary image file name identifier (sent by PutFile).</description> - </param> - <param name="imageType" type="ImageType" mandatory="true"> - <description>Describes, whether it is a static or dynamic image.</description> - </param> - <param name="isTemplate" type="Boolean" mandatory="false" since="5.0"> - <description>If true, the image is a template image and can be recolored by the HMI</description> - </param> - </struct> - - <struct name="SoftButton" since="2.0"> - <param name="type" type="SoftButtonType" mandatory="true"> - <description>Describes, whether it is text, highlighted text, icon, or dynamic image. See softButtonType</description> - </param> - <param name="text" minlength="0" maxlength="500" type="String" mandatory="false"> - <description>Optional text to display (if defined as TEXT or BOTH)</description> - </param> - <param name="image" type="Image" mandatory="false"> - <description>Optional image struct for SoftButton (if defined as IMAGE or BOTH)</description> - </param> - <param name="isHighlighted" type="Boolean" defvalue="false" mandatory="false"> - <description> - True, if highlighted - False, if not highlighted - </description> - </param> - <param name="softButtonID" type="Integer" minvalue="0" maxvalue="65535" mandatory="true"> - <description>Value which is returned via OnButtonPress / OnButtonEvent</description> - </param> - <param name="systemAction" type="SystemAction" defvalue="DEFAULT_ACTION" mandatory="false"> - <description>Parameter indicating whether selecting a SoftButton shall call a specific system action. This is intended to allow Notifications to bring the callee into full / focus; or in the case of persistent overlays, the overlay can persist when a SoftButton is pressed.</description> - </param> - </struct> - - <struct name="Choice" since="1.0"> - <description>A choice is an option given to the user, which can be selected either by menu, or through voice recognition system.</description> - <param name="choiceID" type="Integer" minvalue="0" maxvalue="65535" mandatory="true"/> - <param name="menuName" type="String" maxlength="500" mandatory="true"/> - <param name="vrCommands" type="String" minsize="1" maxsize="100" maxlength="99" array="true" mandatory="false" since="5.0"> - <history> - <param name="vrCommands" type="String" minsize="1" maxsize="100" maxlength="99" array="true" mandatory="true" since="1.0" until="5.0"/> - </history> - </param> - <param name="image" type="Image" mandatory="false" since="2.0" /> - <param name="secondaryText" maxlength="500" type="String" mandatory="false" since="3.0"> - <description>Optional secondary text to display; e.g. address of POI in a search result entry</description> - </param> - <param name="tertiaryText" maxlength="500" type="String" mandatory="false" since="3.0"> - <description>Optional tertiary text to display; e.g. distance to POI for a search result entry</description> - </param> - <param name="secondaryImage" type="Image" mandatory="false" since="3.0"> - <description>Optional secondary image struct for choice</description> - </param> - </struct> - - <struct name="VrHelpItem" since="2.0"> - <param name="text" maxlength="500" type="String" mandatory="true"> - <description>Text to display for VR Help item</description> - </param> - <param name="image" type="Image" mandatory="false"> - <description>Image struct for VR Help item</description> - </param> - <param name="position" type="Integer" minvalue="1" maxvalue="100" mandatory="true"> - <description>Position to display item in VR Help list</description> - </param> - </struct> - - <struct name="SyncMsgVersion" since="1.0"> - <description>Specifies the version number of the SmartDeviceLink protocol that is supported by the mobile application</description> - - <param name="majorVersion" type="Integer" minvalue="1" maxvalue="10" mandatory="true"> - <description>The major version indicates versions that is not-compatible to previous versions.</description> - </param> - <param name="minorVersion" type="Integer" minvalue="0" maxvalue="1000" mandatory="true"> - <description>The minor version indicates a change to a previous version that should still allow to be run on an older version (with limited functionality)</description> - </param> - <param name="patchVersion" type="Integer" minvalue="0" maxvalue="1000" mandatory="false" since="4.3"> - <description>The patch version indicates a fix to existing functionality in a previous version that should still be able to be run on an older version </description> - </param> - </struct> - - <enum name="GlobalProperty" since="1.0"> - <description>The different global properties.</description> - <element name="USER_LOCATION" since="6.0"> - <description>Location of the user's seat of setGlobalProperties</description> - </element> - <element name="HELPPROMPT" since="1.0"> - <description>The property helpPrompt of setGlobalProperties</description> - </element> - <element name="TIMEOUTPROMPT" since="1.0"> - <description>The property timeoutPrompt of setGlobalProperties</description> - </element> - <element name="VRHELPTITLE" since="2.0"> - <description>The property vrHelpTitle of setGlobalProperties</description> - </element> - <element name="VRHELPITEMS" since="2.0"> - <description>The property array of vrHelp of setGlobalProperties</description> - </element> - <element name="MENUNAME" since="3.0"> - <description>The property in-app menu name of setGlobalProperties</description> - </element> - <element name="MENUICON" since="3.0"> - <description>The property in-app menu icon of setGlobalProperties</description> - </element> - <element name="KEYBOARDPROPERTIES" since="3.0"> - <description>The on-screen keyboard configuration of setGlobalProperties</description> - </element> - </enum> - - <enum name="CompassDirection" since="2.0"> - <description>The list of potential compass directions</description> - <element name="NORTH"> - </element> - <element name="NORTHWEST"> - </element> - <element name="WEST"> - </element> - <element name="SOUTHWEST"> - </element> - <element name="SOUTH"> - </element> - <element name="SOUTHEAST"> - </element> - <element name="EAST"> - </element> - <element name="NORTHEAST"> - </element> - </enum> - - <enum name="Dimension" since="2.0"> - <description>The supported dimensions of the GPS</description> - <element name="NO_FIX" internal_name="Dimension_NO_FIX"> - <description>No GPS at all</description> - </element> - <element name="2D" internal_name="Dimension_2D"> - <description>Longitude and latitude</description> - </element> - <element name="3D" internal_name="Dimension_3D"> - <description>Longitude and latitude and altitude</description> - </element> - </enum> - - <enum name="PRNDL" since="2.0"> - <description>The selected gear.</description> - <element name="PARK"> - <description>Parking</description> - </element> - <element name="REVERSE"> - <description>Reverse gear</description> - </element> - <element name="NEUTRAL"> - <description>No gear</description> - </element> - <element name="DRIVE"> - </element> - <element name="SPORT"> - <description>Drive Sport mode</description> - </element> - <element name="LOWGEAR"> - <description>1st gear hold</description> - </element> - <element name="FIRST"> - </element> - <element name="SECOND"> - </element> - <element name="THIRD"> - </element> - <element name="FOURTH"> - </element> - <element name="FIFTH"> - </element> - <element name="SIXTH"> - </element> - <element name="SEVENTH"> - </element> - <element name="EIGHTH"> - </element> - <element name="UNKNOWN"> - </element> - <element name="FAULT"> - </element> - </enum> - - <enum name="ComponentVolumeStatus" since="2.0"> - <description>The volume status of a vehicle component.</description> - <element name="UNKNOWN" internal_name="CVS_UNKNOWN"> - </element> - <element name="NORMAL" internal_name="CVS_NORMAL"> - </element> - <element name="LOW" internal_name="CVS_LOW"> - </element> - <element name="FAULT" internal_name="CVS_FAULT"> - </element> - <element name="ALERT" internal_name="CVS_ALERT"> - </element> - <element name="NOT_SUPPORTED" internal_name="CVS_NOT_SUPPORTED"> - </element> - </enum> - - <enum name="TPMS" since="5.0"> - <element name="UNKNOWN"> - <description>If set the status of the tire is not known.</description> - </element> - <element name="SYSTEM_FAULT"> - <description>TPMS does not function.</description> - </element> - <element name="SENSOR_FAULT"> - <description>The sensor of the tire does not function.</description> - </element> - <element name="LOW"> - <description>TPMS is reporting a low tire pressure for the tire.</description> - </element> - <element name="SYSTEM_ACTIVE"> - <description>TPMS is active and the tire pressure is monitored.</description> - </element> - <element name="TRAIN"> - <description>TPMS is reporting that the tire must be trained.</description> - </element> - <element name="TRAINING_COMPLETE"> - <description>TPMS reports the training for the tire is completed.</description> - </element> - <element name="NOT_TRAINED"> - <description>TPMS reports the tire is not trained.</description> - </element> - </enum> - - <enum name="FuelType" since="5.0"> - <element name="GASOLINE" /> - <element name="DIESEL" /> - <element name="CNG"> - <description> - For vehicles using compressed natural gas. - </description> - </element> - <element name="LPG"> - <description> - For vehicles using liquefied petroleum gas. - </description> - </element> - <element name="HYDROGEN"> - <description>For FCEV (fuel cell electric vehicle).</description> - </element> - <element name="BATTERY"> - <description>For BEV (Battery Electric Vehicle), PHEV (Plug-in Hybrid Electric Vehicle), solar vehicles and other vehicles which run on a battery.</description> - </element> - </enum> - - <struct name="FuelRange" since="5.0"> - <param name="type" type="FuelType" mandatory="false"/> - <param name="range" type="Float" minvalue="0" maxvalue="10000" mandatory="false"> - <description> - The estimate range in KM the vehicle can travel based on fuel level and consumption. - </description> - </param> - </struct> - - <enum name="ElectronicParkBrakeStatus" since="5.0"> - <element name="CLOSED"> - <description> - Park brake actuators have been fully applied. - </description> - </element> - <element name="TRANSITION"> - <description> - Park brake actuators are transitioning to either Apply/Closed or Release/Open state. - </description> - </element> - <element name="OPEN"> - <description> - Park brake actuators are released. - </description> - </element> - <element name="DRIVE_ACTIVE"> - <description> - When driver pulls the Electronic Park Brake switch while driving "at speed". - </description> - </element> - <element name="FAULT"> - <description> - When system has a fault or is under maintenance. - </description> - </element> - </enum> - - <struct name="SingleTireStatus" since="2.0"> - <param name="status" type="ComponentVolumeStatus" mandatory="true"> - <description>See ComponentVolumeStatus.</description> - </param> - <param name="tpms" type="TPMS" mandatory="false" since="5.0"> - <description> - The status of TPMS according to the particular tire. - </description> - </param> - <param name="pressure" type="Float" mandatory="false" minvalue="0" maxvalue="2000" since="5.0"> - <description>The pressure value of the particular tire in kilo pascal.</description> - </param> - </struct> - - <enum name="WarningLightStatus" since="2.0"> - <description>Reflects the status of a cluster instrument warning light.</description> - <element name="OFF" internal_name="WLS_OFF"> - </element> - <element name="ON" internal_name="WLS_ON"> - </element> - <element name="FLASH" internal_name="WLS_FLASH"> - </element> - <element name="NOT_USED" internal_name="WLS_NOT_USED"> - </element> - </enum> - - <enum name="VehicleDataNotificationStatus" since="2.0"> - <description>Reflects the status of a vehicle data notification.</description> - <element name="NOT_SUPPORTED" internal_name="VDNS_NOT_SUPPORTED"> - </element> - <element name="NORMAL" internal_name="VDNS_NORMAL"> - </element> - <element name="ACTIVE" internal_name="VDNS_ACTIVE"> - </element> - <element name="NOT_USED" internal_name="VDNS_NOT_USED"> - </element> - </enum> - - <enum name="IgnitionStableStatus" since="2.0"> - <description>Reflects the ignition switch stability.</description> - <element name="IGNITION_SWITCH_NOT_STABLE"> - </element> - <element name="IGNITION_SWITCH_STABLE"> - </element> - <element name="MISSING_FROM_TRANSMITTER"> - </element> - </enum> - - <enum name="IgnitionStatus" since="2.0"> - <description>Reflects the status of ignition.</description> - <element name="UNKNOWN" internal_name="IS_UNKNOWN"> - </element> - <element name="OFF" internal_name="IS_OFF"> - </element> - <element name="ACCESSORY" internal_name="IS_ACCESSORY"> - </element> - <element name="RUN" internal_name="IS_RUN"> - </element> - <element name="START" internal_name="IS_START"> - </element> - <element name="INVALID" internal_name="IS_INVALID"> - </element> - </enum> - - <enum name="VehicleDataEventStatus" since="2.0"> - <description>Reflects the status of a vehicle data event; e.g. a seat belt event status.</description> - <element name="NO_EVENT" internal_name="VDES_NO_EVENT"> - </element> - <element name="NO" internal_name="VDES_NO"> - </element> - <element name="YES" internal_name="VDES_YES"> - </element> - <element name="NOT_SUPPORTED" internal_name="VDES_NOT_SUPPORTED"> - </element> - <element name="FAULT" internal_name="VDES_FAULT"> - </element> - </enum> - - <enum name="DeviceLevelStatus" since="2.0"> - <description>Reflects the reported battery status of the connected device, if reported.</description> - <element name="ZERO_LEVEL_BARS"> - </element> - <element name="ONE_LEVEL_BARS"> - </element> - <element name="TWO_LEVEL_BARS"> - </element> - <element name="THREE_LEVEL_BARS"> - </element> - <element name="FOUR_LEVEL_BARS"> - </element> - <element name="NOT_PROVIDED"> - </element> - </enum> - - <enum name="PrimaryAudioSource" since="2.0"> - <description>Reflects the current primary audio source (if selected).</description> - <element name="NO_SOURCE_SELECTED"> - </element> - <element name="CD" since="5.0"> - </element> - <element name="USB"> - </element> - <element name="USB2"> - </element> - <element name="BLUETOOTH_STEREO_BTST"> - </element> - <element name="LINE_IN"> - </element> - <element name="IPOD"> - </element> - <element name="MOBILE_APP"> - </element> - <element name="AM" since="5.0"> - </element> - <element name="FM" since="5.0"> - </element> - <element name="XM" since="5.0"> - </element> - <element name="DAB" since="5.0"> - </element> - </enum> - - <enum name="WiperStatus" since="2.0"> - <description>Reflects the status of the wipers.</description> - <element name="OFF" /> - <element name="AUTO_OFF" /> - <element name="OFF_MOVING" /> - <element name="MAN_INT_OFF" /> - <element name="MAN_INT_ON" /> - <element name="MAN_LOW" /> - <element name="MAN_HIGH" /> - <element name="MAN_FLICK" /> - <element name="WASH" /> - <element name="AUTO_LOW" /> - <element name="AUTO_HIGH" /> - <element name="COURTESYWIPE" /> - <element name="AUTO_ADJUST" /> - <element name="STALLED" /> - <element name="NO_DATA_EXISTS" /> - </enum> - - <enum name="VehicleDataStatus" since="2.0"> - <description>Reflects the status of a binary vehicle data item.</description> - <element name="NO_DATA_EXISTS" internal_name="VDS_NO_DATA_EXISTS"> - </element> - <element name="OFF" internal_name="VDS_OFF"> - </element> - <element name="ON" internal_name="VDS_ON"> - </element> - </enum> - - <enum name="MaintenanceModeStatus" since="2.0"> - <description>Reflects the status of a vehicle maintenance mode.</description> - <element name="NORMAL" internal_name="MMS_NORMAL"> - </element> - <element name="NEAR" internal_name="MMS_NEAR"> - </element> - <element name="ACTIVE" internal_name="MMS_ACTIVE"> - </element> - <element name="FEATURE_NOT_PRESENT" internal_name="MMS_FEATURE_NOT_PRESENT"> - </element> - </enum> - - <enum name="VehicleDataActiveStatus" since="2.0"> - <description>Reflects the status of given vehicle component.</description> - <element name="INACTIVE_NOT_CONFIRMED" internal_name="VDAS_INACTIVE_NOT_CONFIRMED"> - </element> - <element name="INACTIVE_CONFIRMED" internal_name="VDAS_INACTIVE_CONFIRMED"> - </element> - <element name="ACTIVE_NOT_CONFIRMED" internal_name="VDAS_ACTIVE_NOT_CONFIRMED"> - </element> - <element name="ACTIVE_CONFIRMED" internal_name="VDAS_ACTIVE_CONFIRMED"> - </element> - <element name="FAULT" internal_name="VDAS_FAULT"> - </element> - </enum> - - <enum name="AmbientLightStatus" since="2.0"> - <description>Reflects the status of the ambient light sensor.</description> - <element name="NIGHT" /> - <element name="TWILIGHT_1" /> - <element name="TWILIGHT_2" /> - <element name="TWILIGHT_3" /> - <element name="TWILIGHT_4" /> - <element name="DAY" /> - <element name="UNKNOWN" internal_name="ALS_UNKNOWN" /> - <element name="INVALID" /> - </enum> - - <enum name="ModuleType" since="4.5"> - <element name="CLIMATE"/> - <element name="RADIO"/> - <element name="SEAT" since="5.0"/> - <element name="AUDIO" since="5.0"/> - <element name="LIGHT" since="5.0"/> - <element name="HMI_SETTINGS" since="5.0"/> - </enum> - - <enum name="DefrostZone" since="4.5"> - <element name="FRONT"/> - <element name="REAR"/> - <element name="ALL"/> - <element name="NONE"/> - </enum> - - <enum name="VentilationMode" since="4.5"> - <element name="UPPER"/> - <element name="LOWER"/> - <element name="BOTH"/> - <element name="NONE"/> - </enum> - - <enum name="RadioBand" since="4.5"> - <element name="AM"/> - <element name="FM"/> - <element name="XM"/> - </enum> - - <enum name="RadioState" since="4.5"> - <element name="ACQUIRING"/> - <element name="ACQUIRED"/> - <element name="MULTICAST"/> - <element name="NOT_FOUND"/> - </enum> - - <enum name="TemperatureUnit" since="4.5"> - <element name="FAHRENHEIT"/> - <element name="CELSIUS"/> - </enum> - - <struct name="BeltStatus" since="2.0"> - <param name="driverBeltDeployed" type="VehicleDataEventStatus" mandatory="true"> - <description>References signal "VedsDrvBelt_D_Ltchd". See VehicleDataEventStatus.</description> - </param> - <param name="passengerBeltDeployed" type="VehicleDataEventStatus" mandatory="true"> - <description>References signal "VedsPasBelt_D_Ltchd". See VehicleDataEventStatus.</description> - </param> - <param name="passengerBuckleBelted" type="VehicleDataEventStatus" mandatory="true"> - <description>References signal "VedsRw1PasBckl_D_Ltchd". See VehicleDataEventStatus.</description> - </param> - <param name="driverBuckleBelted" type="VehicleDataEventStatus" mandatory="true"> - <description>References signal "VedsRw1DrvBckl_D_Ltchd". See VehicleDataEventStatus.</description> - </param> - <param name="leftRow2BuckleBelted" type="VehicleDataEventStatus" mandatory="true"> - <description>References signal "VedsRw2lBckl_D_Ltchd". See VehicleDataEventStatus.</description> - </param> - <param name="passengerChildDetected" type="VehicleDataEventStatus" mandatory="true"> - <description>References signal "VedsRw1PasChld_D_Ltchd". See VehicleDataEventStatus.</description> - </param> - <param name="rightRow2BuckleBelted" type="VehicleDataEventStatus" mandatory="true"> - <description>References signal "VedsRw2rBckl_D_Ltchd". See VehicleDataEventStatus.</description> - </param> - <param name="middleRow2BuckleBelted" type="VehicleDataEventStatus" mandatory="true"> - <description>References signal "VedsRw2mBckl_D_Ltchd". See VehicleDataEventStatus.</description> - </param> - <param name="middleRow3BuckleBelted" type="VehicleDataEventStatus" mandatory="true"> - <description>References signal "VedsRw3mBckl_D_Ltchd". See VehicleDataEventStatus.</description> - </param> - <param name="leftRow3BuckleBelted" type="VehicleDataEventStatus" mandatory="true"> - <description>References signal "VedsRw3lBckl_D_Ltchd". See VehicleDataEventStatus.</description> - </param> - <param name="rightRow3BuckleBelted" type="VehicleDataEventStatus" mandatory="true"> - <description>References signal "VedsRw3rBckl_D_Ltchd". See VehicleDataEventStatus.</description> - </param> - <param name="leftRearInflatableBelted" type="VehicleDataEventStatus" mandatory="true"> - <description>References signal "VedsRw2lRib_D_Ltchd". See VehicleDataEventStatus.</description> - </param> - <param name="rightRearInflatableBelted" type="VehicleDataEventStatus" mandatory="true"> - <description>References signal "VedsRw2rRib_D_Ltchd". See VehicleDataEventStatus.</description> - </param> - <param name="middleRow1BeltDeployed" type="VehicleDataEventStatus" mandatory="true"> - <description>References signal "VedsRw1mBelt_D_Ltchd". See VehicleDataEventStatus.</description> - </param> - <param name="middleRow1BuckleBelted" type="VehicleDataEventStatus" mandatory="true"> - <description>References signal "VedsRw1mBckl_D_Ltchd". See VehicleDataEventStatus.</description> - </param> - </struct> - - <struct name="BodyInformation" since="2.0"> - <param name="parkBrakeActive" type="Boolean" mandatory="true"> - <description>References signal "PrkBrkActv_B_Actl".</description> - </param> - <param name="ignitionStableStatus" type="IgnitionStableStatus" mandatory="true"> - <description>References signal "Ignition_Switch_Stable". See IgnitionStableStatus.</description> - </param> - <param name="ignitionStatus" type="IgnitionStatus" mandatory="true"> - <description>References signal "Ignition_status". See IgnitionStatus.</description> - </param> - <param name="driverDoorAjar" type="Boolean" mandatory="false"> - <description>References signal "DrStatDrv_B_Actl".</description> - </param> - <param name="passengerDoorAjar" type="Boolean" mandatory="false"> - <description>References signal "DrStatPsngr_B_Actl".</description> - </param> - <param name="rearLeftDoorAjar" type="Boolean" mandatory="false"> - <description>References signal "DrStatRl_B_Actl".</description> - </param> - <param name="rearRightDoorAjar" type="Boolean" mandatory="false"> - <description>References signal "DrStatRr_B_Actl".</description> - </param> - </struct> - - <struct name="DeviceStatus" since="2.0"> - <param name="voiceRecOn" type="Boolean" mandatory="true"> - <description>References signal "CPM_VoiceRec_STAT".</description> - </param> - <param name="btIconOn" type="Boolean" mandatory="true"> - <description>References signal "BT_ICON".</description> - </param> - <param name="callActive" type="Boolean" mandatory="true"> - <description>References signal "CPM_Call_Active_STAT".</description> - </param> - <param name="phoneRoaming" type="Boolean" mandatory="true"> - <description>References signal "CPM_Phone_Roaming_STAT".</description> - </param> - <param name="textMsgAvailable" type="Boolean" mandatory="true"> - <description>References signal "CPM_TextMsg_AVAL".</description> - </param> - <param name="battLevelStatus" type="DeviceLevelStatus" mandatory="true"> - <description>Device battery level status. References signal "CPM_Batt_Level_STAT". See DeviceLevelStatus.</description> - </param> - <param name="stereoAudioOutputMuted" type="Boolean" mandatory="true"> - <description>References signal "CPM_Stereo_Audio_Output".</description> - </param> - <param name="monoAudioOutputMuted" type="Boolean" mandatory="true"> - <description>References signal "CPM_Mono_Audio_Output".</description> - </param> - <param name="signalLevelStatus" type="DeviceLevelStatus" mandatory="true"> - <description>Device signal level status. References signal "CPM_Signal_Strength_STAT". See DeviceLevelStatus.</description> - </param> - <param name="primaryAudioSource" type="PrimaryAudioSource" mandatory="true"> - <description>References signal "CPM_Stereo_PAS_Source". See PrimaryAudioSource.</description> - </param> - <param name="eCallEventActive" type="Boolean" mandatory="true"> - <description>References signal "eCall_Event".</description> - </param> - </struct> - - <struct name="HeadLampStatus" since="2.0"> - <param name="lowBeamsOn" type="Boolean" mandatory="true"> - <description>Status of the low beam lamps. References signal "HeadLampLoActv_B_Stat".</description> - </param> - <param name="highBeamsOn" type="Boolean" mandatory="true"> - <description>Status of the high beam lamps. References signal "HeadLghtHiOn_B_Stat".</description> - </param> - <param name="ambientLightSensorStatus" type="AmbientLightStatus" mandatory="false"> - <description>Status of the ambient light sensor.</description> - </param> - </struct> - - <struct name="AppInfo" since="4.2"> - <description>Contains detailed information about the registered application.</description> - - <param name="appDisplayName" type="String" maxlength="100" mandatory="true"> - <description>The name displayed for the mobile application on the mobile device (can differ from the app name set in the initial RAI request).</description> - </param> - - <param name="appBundleID" type="String" maxlength="256" mandatory="true"> - <description>The AppBundleID of an iOS application or package name of the Android application. This supports App Launch strategies for each platform.</description> - </param> - - <param name="appVersion" type="String" maxlength="256" mandatory="true"> - <description>Represents the build version number of this particular mobile app.</description> - </param> - - <param name="appIcon" type="String" maxlength="500" mandatory="false"> - <description>A file reference to the icon utilized by this app (simplifies the process of setting an app icon during app registration).</description> - </param> - </struct> - - <enum name="FileType" since="2.0"> - <description>Enumeration listing possible file types.</description> - <element name="GRAPHIC_BMP" /> - <element name="GRAPHIC_JPEG" /> - <element name="GRAPHIC_PNG" /> - <element name="AUDIO_WAVE" /> - <element name="AUDIO_MP3" /> - <element name="AUDIO_AAC" /> - <element name="BINARY" /> - <element name="JSON" /> - </enum> - - <enum name="FuelCutoffStatus" since="2.0"> - <description>Reflects the status of the RCM fuel cutoff.</description> - <element name="TERMINATE_FUEL" internal_name="FCS_TERMINATE_FUEL"> - </element> - <element name="NORMAL_OPERATION" internal_name="FCS_NORMAL_OPERATION"> - </element> - <element name="FAULT" internal_name="FCS_FAULT"> - </element> - </enum> - - <enum name="EmergencyEventType" since="2.0"> - <description>Reflects the emergency event status of the vehicle.</description> - <element name="NO_EVENT" internal_name="EET_NO_EVENT"> - </element> - <element name="FRONTAL" internal_name="EET_FRONTAL"> - </element> - <element name="SIDE" internal_name="EET_SIDE"> - </element> - <element name="REAR" internal_name="EET_REAR"> - </element> - <element name="ROLLOVER" internal_name="EET_ROLLOVER"> - </element> - <element name="NOT_SUPPORTED" internal_name="EET_NOT_SUPPORTED"> - </element> - <element name="FAULT" internal_name="EET_FAULT"> - </element> - </enum> - - <enum name="ECallConfirmationStatus" since="2.0"> - <description>Reflects the status of the eCall Notification.</description> - <element name="NORMAL" internal_name="ECCS_NORMAL"> - </element> - <element name="CALL_IN_PROGRESS" internal_name="ECCS_CALL_IN_PROGRESS"> - </element> - <element name="CALL_CANCELLED" internal_name="ECCS_CALL_CANCELLED"> - </element> - <element name="CALL_COMPLETED"> - </element> - <element name="CALL_UNSUCCESSFUL" internal_name="ECCS_CALL_UNSUCCESSFUL"> - </element> - <element name="ECALL_CONFIGURED_OFF" internal_name="ECCS_ECALL_CONFIGURED_OFF"> - </element> - <element name="CALL_COMPLETE_DTMF_TIMEOUT" internal_name="ECCS_CALL_COMPLETE_DTMF_TIMEOUT"> - </element> - </enum> - - <enum name="PowerModeQualificationStatus" since="2.0"> - <description>Reflects the status of the current power mode qualification.</description> - <element name="POWER_MODE_UNDEFINED"> - </element> - <element name="POWER_MODE_EVALUATION_IN_PROGRESS"> - </element> - <element name="NOT_DEFINED"> - </element> - <element name="POWER_MODE_OK"> - </element> - </enum> - - <enum name="PowerModeStatus" since="2.0"> - <description>Reflects the status of the current power mode.</description> - <element name="KEY_OUT"> - </element> - <element name="KEY_RECENTLY_OUT"> - </element> - <element name="KEY_APPROVED_0"> - </element> - <element name="POST_ACCESORY_0"> - </element> - <element name="ACCESORY_1"> - </element> - <element name="POST_IGNITION_1"> - </element> - <element name="IGNITION_ON_2"> - </element> - <element name="RUNNING_2"> - </element> - <element name="CRANK_3"> - </element> - </enum> - - <enum name="CarModeStatus" since="2.0"> - <description>Reflects the status of the current car mode.</description> - <element name="NORMAL" internal_name="CMS_NORMAL"> - </element> - <element name="FACTORY" internal_name="CMS_FACTORY"> - </element> - <element name="TRANSPORT" internal_name="CMS_TRANSPORT"> - </element> - <element name="CRASH" internal_name="CMS_CRASH"> - </element> - </enum> - - <struct name="ECallInfo" since="2.0"> - <param name="eCallNotificationStatus" type="VehicleDataNotificationStatus" mandatory="true"> - <description>References signal "eCallNotification_4A". See VehicleDataNotificationStatus.</description> - </param> - <param name="auxECallNotificationStatus" type="VehicleDataNotificationStatus" mandatory="true"> - <description>References signal "eCallNotification". See VehicleDataNotificationStatus.</description> - </param> - <param name="eCallConfirmationStatus" type="ECallConfirmationStatus" mandatory="true"> - <description>References signal "eCallConfirmation". See ECallConfirmationStatus.</description> - </param> - </struct> - - <struct name="AirbagStatus" since="2.0"> - <param name="driverAirbagDeployed" type="VehicleDataEventStatus" mandatory="true"> - <description>References signal "VedsDrvBag_D_Ltchd". See VehicleDataEventStatus.</description> - </param> - <param name="driverSideAirbagDeployed" type="VehicleDataEventStatus" mandatory="true"> - <description>References signal "VedsDrvSideBag_D_Ltchd". See VehicleDataEventStatus.</description> - </param> - <param name="driverCurtainAirbagDeployed" type="VehicleDataEventStatus" mandatory="true"> - <description>References signal "VedsDrvCrtnBag_D_Ltchd". See VehicleDataEventStatus.</description> - </param> - <param name="passengerAirbagDeployed" type="VehicleDataEventStatus" mandatory="true"> - <description>References signal "VedsPasBag_D_Ltchd". See VehicleDataEventStatus.</description> - </param> - <param name="passengerCurtainAirbagDeployed" type="VehicleDataEventStatus" mandatory="true"> - <description>References signal "VedsPasCrtnBag_D_Ltchd". See VehicleDataEventStatus.</description> - </param> - <param name="driverKneeAirbagDeployed" type="VehicleDataEventStatus" mandatory="true"> - <description>References signal "VedsKneeDrvBag_D_Ltchd". See VehicleDataEventStatus.</description> - </param> - <param name="passengerSideAirbagDeployed" type="VehicleDataEventStatus" mandatory="true"> - <description>References signal "VedsPasSideBag_D_Ltchd". See VehicleDataEventStatus.</description> - </param> - <param name="passengerKneeAirbagDeployed" type="VehicleDataEventStatus" mandatory="true"> - <description>References signal "VedsKneePasBag_D_Ltchd". See VehicleDataEventStatus.</description> - </param> - </struct> - - <struct name="EmergencyEvent" since="2.0"> - <param name="emergencyEventType" type="EmergencyEventType" mandatory="true"> - <description>References signal "VedsEvntType_D_Ltchd". See EmergencyEventType.</description> - </param> - <param name="fuelCutoffStatus" type="FuelCutoffStatus" mandatory="true"> - <description>References signal "RCM_FuelCutoff". See FuelCutoffStatus.</description> - </param> - <param name="rolloverEvent" type="VehicleDataEventStatus" mandatory="true"> - <description>References signal "VedsEvntRoll_D_Ltchd". See VehicleDataEventStatus.</description> - </param> - - <param name="maximumChangeVelocity" type="Integer" minvalue="0" maxvalue="255" mandatory="true"> - <description> - References signal "VedsMaxDeltaV_D_Ltchd". Change in velocity in KPH. Additional reserved values: - 0x00 No event - 0xFE Not supported - 0xFF Fault - </description> - </param> - <param name="multipleEvents" type="VehicleDataEventStatus" mandatory="true"> - <description>References signal "VedsMultiEvnt_D_Ltchd". See VehicleDataEventStatus.</description> - </param> - </struct> - - <struct name="ClusterModeStatus" since="2.0"> - <param name="powerModeActive" type="Boolean" mandatory="true"> - <description>References signal "PowerMode_UB".</description> - </param> - <param name="powerModeQualificationStatus" type="PowerModeQualificationStatus" mandatory="true"> - <description>References signal "PowerModeQF". See PowerModeQualificationStatus.</description> - </param> - <param name="carModeStatus" type="CarModeStatus" mandatory="true"> - <description>References signal "CarMode". See CarMode.</description> - </param> - <param name="powerModeStatus" type="PowerModeStatus" mandatory="true"> - <description>References signal "PowerMode". See PowerMode.</description> - </param> - </struct> - - <struct name="MyKey" since="2.0"> - <param name="e911Override" type="VehicleDataStatus" mandatory="true"> - <description>Indicates whether e911 override is on. References signal "MyKey_e911Override_St". See VehicleDataStatus.</description> - </param> - </struct> - - <enum name="VehicleDataResultCode" since="2.0"> - <description>Enumeration that describes possible result codes of a vehicle data entry request.</description> - <element name="SUCCESS" internal_name="VDRC_SUCCESS"> - <description>Individual vehicle data item / DTC / DID request or subscription successful</description> - </element> - <element name="TRUNCATED_DATA" internal_name="VDRC_TRUNCATED_DATA"> - <description>DTC / DID request successful, however, not all active DTCs or full contents of DID location available</description> - </element> - <element name="DISALLOWED" internal_name="VDRC_DISALLOWED"> - <description>This vehicle data item is not allowed for this app by the OEM/Manufactorer of the connected module.</description> - </element> - <element name="USER_DISALLOWED" internal_name="VDRC_USER_DISALLOWED"> - <description>The user has not granted access to this type of vehicle data item at this time.</description> - </element> - <element name="INVALID_ID" internal_name="VDRC_INVALID_ID"> - <description>The ECU ID referenced is not a valid ID on the bus / system.</description> - </element> - <element name="VEHICLE_DATA_NOT_AVAILABLE" internal_name="VDRC_DATA_NOT_AVAILABLE"> - <description>The requested vehicle data item / DTC / DID is not currently available or responding on the bus / system.</description> - </element> - <element name="DATA_ALREADY_SUBSCRIBED" internal_name="VDRC_DATA_ALREADY_SUBSCRIBED"> - <description>The vehicle data item is already subscribed.</description> - </element> - <element name="DATA_NOT_SUBSCRIBED" internal_name="VDRC_DATA_NOT_SUBSCRIBED"> - <description>The vehicle data item cannot be unsubscribed because it is not currently subscribed.</description> - </element> - <element name="IGNORED" internal_name="VDRC_IGNORED"> - <description>The request for this item is ignored because it is already in progress.</description> - </element> - </enum> - - <struct name="TireStatus" since="2.0"> - <description>The status and pressure of the tires.</description> - - <param name="pressureTelltale" type="WarningLightStatus" mandatory="true"> - <description>Status of the Tire Pressure Telltale. See WarningLightStatus.</description> - </param> - <param name="leftFront" type="SingleTireStatus" mandatory="true"> - <description>The status of the left front tire.</description> - </param> - <param name="rightFront" type="SingleTireStatus" mandatory="true"> - <description>The status of the right front tire.</description> - </param> - <param name="leftRear" type="SingleTireStatus" mandatory="true"> - <description>The status of the left rear tire.</description> - </param> - <param name="rightRear" type="SingleTireStatus" mandatory="true"> - <description>The status of the right rear tire.</description> - </param> - <param name="innerLeftRear" type="SingleTireStatus" mandatory="true"> - <description>The status of the inner left rear.</description> - </param> - <param name="innerRightRear" type="SingleTireStatus" mandatory="true"> - <description>The status of the inner right rear.</description> - </param> - </struct> - - <enum name="TurnSignal" since="5.0"> - <description>Enumeration that describes the status of the turn light indicator.</description> - <element name="OFF"> - <description>Turn signal is OFF</description> - </element> - <element name="LEFT"> - <description>Left turn signal is on</description> - </element> - <element name="RIGHT"> - <description>Right turn signal is on</description> - </element> - <element name="BOTH"> - <description>Both signals (left and right) are on.</description> - </element> - </enum> - - <enum name="MenuLayout" since="6.0"> - <description>How the main menu or submenu is laid out on screen</description> - <element name="LIST" /> - <element name="TILES" /> - </enum> - - <struct name="GPSData" since="2.0"> - <description>Struct with the GPS data.</description> - <param name="longitudeDegrees" type="Float" minvalue="-180" maxvalue="180" mandatory="true"> - </param> - <param name="latitudeDegrees" type="Float" minvalue="-90" maxvalue="90" mandatory="true"> - </param> - <param name="utcYear" type="Integer" minvalue="2010" maxvalue="2100" mandatory="false" since="5.0"> - <description>The current UTC year.</description> - <history> - <param name="utcYear" type="Integer" minvalue="2010" maxvalue="2100" mandatory="true" since="2.0" until="5.0"/> - </history> - </param> - <param name="utcMonth" type="Integer" minvalue="1" maxvalue="12" mandatory="false" since="5.0"> - <description>The current UTC month.</description> - <history> - <param name="utcMonth" type="Integer" minvalue="1" maxvalue="12" mandatory="true" since="2.0" until="5.0"/> - </history> - </param> - <param name="utcDay" type="Integer" minvalue="1" maxvalue="31" mandatory="false" since="5.0"> - <description>The current UTC day.</description> - <history> - <param name="utcDay" type="Integer" minvalue="1" maxvalue="31" mandatory="true" since="2.0" until="5.0"/> - </history> - </param> - <param name="utcHours" type="Integer" minvalue="0" maxvalue="23" mandatory="false" since="5.0"> - <description>The current UTC hour.</description> - <history> - <param name="utcHours" type="Integer" minvalue="0" maxvalue="23" mandatory="true" since="2.0" until="5.0"/> - </history> - </param> - <param name="utcMinutes" type="Integer" minvalue="0" maxvalue="59" mandatory="false" since="5.0"> - <description>The current UTC minute.</description> - <history> - <param name="utcMinutes" type="Integer" minvalue="0" maxvalue="59" mandatory="true" since="2.0" until="5.0"/> - </history> - </param> - <param name="utcSeconds" type="Integer" minvalue="0" maxvalue="59" mandatory="false" since="5.0"> - <description>The current UTC second.</description> - <history> - <param name="utcSeconds" type="Integer" minvalue="0" maxvalue="59" mandatory="true" since="2.0" until="5.0"/> - </history> - </param> - <param name="compassDirection" type="CompassDirection" mandatory="false" since="5.0"> - <description>See CompassDirection.</description> - <history> - <param name="compassDirection" type="CompassDirection" mandatory="true" since="2.0" until="5.0"/> - </history> - </param> - <param name="pdop" type="Float" minvalue="0" maxvalue="1000" defvalue="0" mandatory="false" since="5.0"> - <description>PDOP. If undefined or unavailable, then value shall be set to 0.</description> - <history> - <param name="pdop" type="Float" minvalue="0" maxvalue="10" defvalue="0" mandatory="true" since="2.0" until="5.0"/> - </history> - </param> - <param name="hdop" type="Float" minvalue="0" maxvalue="1000" defvalue="0" mandatory="false" since="5.0"> - <description>HDOP. If value is unknown, value shall be set to 0.</description> - <history> - <param name="hdop" type="Float" minvalue="0" maxvalue="10" defvalue="0" mandatory="true" since="2.0" until="5.0"/> - </history> - </param> - <param name="vdop" type="Float" minvalue="0" maxvalue="1000" defvalue="0" mandatory="false" since="5.0"> - <description>VDOP. If value is unknown, value shall be set to 0.</description> - <history> - <param name="vdop" type="Float" minvalue="0" maxvalue="10" defvalue="0" mandatory="true" since="2.0" until="5.0"/> - </history> - </param> - <param name="actual" type="Boolean" mandatory="false" since="5.0"> - <description> - True, if actual. - False, if inferred. - </description> - <history> - <param name="actual" type="Boolean" mandatory="true" since="2.0" until="5.0"/> - </history> - </param> - <param name="satellites" type="Integer" minvalue="0" maxvalue="31" mandatory="false" since="5.0"> - <description>Number of satellites in view</description> - <history> - <param name="satellites" type="Integer" minvalue="0" maxvalue="31" mandatory="true" since="2.0" until="5.0"/> - </history> - </param> - <param name="dimension" type="Dimension" mandatory="false" since="5.0"> - <description>See Dimension</description> - <history> - <param name="dimension" type="Dimension" mandatory="true" since="2.0" until="5.0"/> - </history> - </param> - <param name="altitude" type="Float" minvalue="-10000" maxvalue="10000" mandatory="false" since="5.0"> - <description>Altitude in meters</description> - <history> - <param name="altitude" type="Float" minvalue="-10000" maxvalue="10000" mandatory="true" since="2.0" until="5.0"/> - </history> - </param> - <param name="heading" type="Float" minvalue="0" maxvalue="359.99" mandatory="false" since="5.0"> - <description>The heading. North is 0. Resolution is 0.01</description> - <history> - <param name="heading" type="Float" minvalue="0" maxvalue="359.99" mandatory="true" since="2.0" until="5.0"/> - </history> - </param> - <param name="speed" type="Float" minvalue="0" maxvalue="500" mandatory="false" since="5.0"> - <description>The speed in KPH</description> - <history> - <param name="speed" type="Float" minvalue="0" maxvalue="500" mandatory="true" since="2.0" until="5.0"/> - </history> - </param> - <param name="shifted" type="Boolean" mandatory="false" since="6.0"> - <description> - True, if GPS lat/long, time, and altitude have been purposefully shifted (requires a proprietary algorithm to unshift). - False, if the GPS data is raw and un-shifted. - If not provided, then value is assumed False. - </description> - </param> - </struct> - - <struct name="VehicleDataResult" since="2.0"> - <description>Individual published data request result</description> - <param name="dataType" type="VehicleDataType" mandatory="true"> - <description>Defined published data element type.</description> - </param> - <param name="resultCode" type="VehicleDataResultCode" mandatory="true"> - <description>Published data result code.</description> - </param> - <param name="oemCustomDataType" type="String" mandatory="false" since="6.0"> - <description>Type of requested oem specific parameter </description> - </param> - </struct> - - <struct name="DIDResult" since="2.0"> - <description>Individual requested DID result and data</description> - <param name="resultCode" type="VehicleDataResultCode" mandatory="true"> - <description>Individual DID result code.</description> - </param> - <param name="didLocation" type="Integer" minvalue="0" maxvalue="65535" mandatory="true"> - <description>Location of raw data from vehicle data DID</description> - </param> - <param name="data" type="String" maxlength="5000" mandatory="false"> - <description>Raw DID-based data returned for requested element.</description> - </param> - </struct> - - <struct name="StartTime" since="1.0"> - <param name="hours" type="Integer" minvalue="0" maxvalue="59" mandatory="true"> - <description> - The hour of the media clock. - Some radios only support a max of 19 hours. If out of range, it will be rejected. - </description> - </param> - <param name="minutes" type="Integer" minvalue="0" maxvalue="59" mandatory="true"/> - <param name="seconds" type="Integer" minvalue="0" maxvalue="59" mandatory="true"/> - </struct> - - <struct name="TextField" since="1.0"> - <param name="name" type="TextFieldName" mandatory="true"> - <description>The name that identifies the field. See TextFieldName.</description> - </param> - <param name="characterSet" type="CharacterSet" mandatory="true"> - <description>The character set that is supported in this field. See CharacterSet.</description> - </param> - <param name="width" type="Integer" minvalue="1" maxvalue="500" mandatory="true"> - <description>The number of characters in one row of this field.</description> - </param> - <param name="rows" type="Integer" minvalue="1" maxvalue="8" mandatory="true"> - <description>The number of rows of this field.</description> - </param> - </struct> - - <struct name="ImageResolution" since="3.0"> - <param name="resolutionWidth" type="Integer" minvalue="1" maxvalue="10000" mandatory="true"> - <description>The image resolution width.</description> - </param> - <param name="resolutionHeight" type="Integer" minvalue="1" maxvalue="10000" mandatory="true"> - <description>The image resolution height.</description> - </param> - </struct> - - <struct name="ImageField" since="3.0"> - <param name="name" type="ImageFieldName" mandatory="true"> - <description>The name that identifies the field. See ImageFieldName.</description> - </param> - <param name="imageTypeSupported" type="FileType" minsize="1" maxsize="100" array="true" mandatory="true"> - <description>The image types that are supported in this field. See FileType.</description> - </param> - <param name="imageResolution" type="ImageResolution" mandatory="false"> - <description>The image resolution of this field.</description> - </param> - </struct> - - <struct name="TouchCoord" since="3.0"> - <param name="x" type="Integer" mandatory="true" minvalue="0" maxvalue="10000"> - <description>The x coordinate of the touch.</description> - </param> - <param name="y" type="Integer" mandatory="true" minvalue="0" maxvalue="10000"> - <description>The y coordinate of the touch.</description> - </param> - </struct> - - <enum name="TouchType" since="3.0"> - <element name="BEGIN"/> - <element name="MOVE"/> - <element name="END"/> - <element name="CANCEL" since="4.5"/> - </enum> - - <struct name="TouchEvent" since="3.0"> - <param name="id" type="Integer" mandatory="true" minvalue="0" maxvalue="9"> - <description> - A touch's unique identifier. The application can track the current touch events by id. - If a touch event has type begin, the id should be added to the set of touches. - If a touch event has type end, the id should be removed from the set of touches. - </description> - </param> - <param name="ts" type="Integer" mandatory="true" array="true" minvalue="0" maxvalue="2000000000" minsize="1" maxsize="1000"> - <description> - The time that the touch was recorded. This number can the time since the beginning of the session or something else as long as the units are in milliseconds. - The timestamp is used to determined the rate of change of position of a touch. - The application also uses the time to verify whether two touches, with different ids, are part of a single action by the user. - If there is only a single timestamp in this array, it is the same for every coordinate in the coordinates array. - </description> - </param> - <param name="c" type="TouchCoord" mandatory="true" array="true" minsize="1" maxsize="1000"> - </param> - </struct> - - <struct name="TouchEventCapabilities" since="3.0"> - <param name="pressAvailable" type="Boolean" mandatory="true"> - </param> - <param name="multiTouchAvailable" type="Boolean" mandatory="true"> - </param> - <param name="doublePressAvailable" type="Boolean" mandatory="true"> - </param> - </struct> - - <struct name="ScreenParams" since="3.0"> - <param name="resolution" type="ImageResolution" mandatory="true"> - <description>The resolution of the prescribed screen area.</description> - </param> - <param name="touchEventAvailable" type="TouchEventCapabilities" mandatory="false"> - <description>Types of screen touch events available in screen area.</description> - </param> - </struct> - - <enum name="PermissionStatus" since="2.0"> - <description>Enumeration that describes possible permission states of a policy table entry.</description> - <element name="ALLOWED" internal_name="PS_ALLOWED"/> - <element name="DISALLOWED" internal_name="PS_DISALLOWED"/> - <element name="USER_DISALLOWED" internal_name="PS_USER_DISALLOWED"/> - <element name="USER_CONSENT_PENDING" internal_name="PS_USER_CONSENT_PENDING"/> - </enum> - - <struct name="HMIPermissions" since="2.0"> - <param name="allowed" type="HMILevel" minsize="0" maxsize="100" array="true" mandatory="true"> - <description>A set of all HMI levels that are permitted for this given RPC.</description> - </param> - <param name="userDisallowed" type="HMILevel" minsize="0" maxsize="100" array="true" mandatory="true"> - <description>A set of all HMI levels that are prohibited for this given RPC.</description> - </param> - </struct> - - <struct name="ParameterPermissions" since="2.0"> - <param name="allowed" type="String" minsize="0" maxsize="100" maxlength = "100" array="true" mandatory="true"> - <description>A set of all parameters that are permitted for this given RPC.</description> - </param> - <param name="userDisallowed" type="String" minsize="0" maxsize="100" maxlength = "100" array="true" mandatory="true"> - <description>A set of all parameters that are prohibited for this given RPC.</description> - </param> - </struct> - - <struct name="PermissionItem" since="2.0"> - <param name="rpcName" type="String" maxlength="100" mandatory="true"> - <description>Name of the individual RPC in the policy table.</description> - </param> - <param name="hmiPermissions" type="HMIPermissions" mandatory="true"/> - <param name="parameterPermissions" type="ParameterPermissions" mandatory="true"/> - <param name="requireEncryption" type="Boolean" mandatory="false" since="6.0"/> - </struct> - - <struct name="DisplayCapabilities" deprecated="true" since="6.0"> - <history> - <struct name="DisplayCapabilities" since="1.0" until="6.0"/> - </history> - <description>Contains information about the display capabilities. This struct is deprecated; please see the new SystemCapability DISPLAYS and corresponding struct DisplayCapability </description> - <param name="displayType" type="DisplayType" mandatory="true" deprecated="true" since="5.0"> - <description>The type of the display. See DisplayType</description> - <history> - <param name="displayType" type="DisplayType" mandatory="true" since="1.0" until="5.0"/> - </history> - </param> - <param name="displayName" type="String" mandatory="false" since="5.0"> - <description>The name of the display the app is connected to.</description> - </param> - <param name="textFields" type="TextField" minsize="1" maxsize="100" array="true" mandatory="true"> - <description>A set of all fields that support text data. See TextField</description> - </param> - <param name="imageFields" type="ImageField" minsize="1" maxsize="100" array="true" mandatory="false"> - <description>A set of all fields that support images. See ImageField</description> - </param> - <param name="mediaClockFormats" type="MediaClockFormat" minsize="0" maxsize="100" array="true" mandatory="true"> - <description>A set of all supported formats of the media clock. See MediaClockFormat</description> - </param> - <param name="graphicSupported" type="Boolean" mandatory="true" since="2.0"> - <description>The display's persistent screen supports referencing a static or dynamic image.</description> - </param> - <param name="templatesAvailable" type="String" minsize="0" maxsize="100" maxlength="100" array="true" mandatory="false" since="3.0"> - <description>A set of all predefined persistent display templates available on headunit. To be referenced in SetDisplayLayout.</description> - </param> - <param name="screenParams" type="ScreenParams" mandatory="false" since="3.0"> - <description>A set of all parameters related to a prescribed screen area (e.g. for video / touch input).</description> - </param> - <param name="numCustomPresetsAvailable" type="Integer" minvalue="1" maxvalue="100" mandatory="false" since="3.0"> - <description>The number of on-screen custom presets available (if any); otherwise omitted.</description> - </param> - <!-- TODO: Add pixel density? --> - </struct> - - <struct name="Grid" since="6.0"> - <description>Describes a location (origin coordinates and span) of a vehicle component.</description> - <param name="col" type="Integer" mandatory="true" minvalue="-1" maxvalue="100"> - </param> - <param name="row" type="Integer" mandatory="true" minvalue="-1" maxvalue="100"> - </param> - <param name="level" type="Integer" mandatory="false" defvalue="0" minvalue="-1" maxvalue="100" > - </param> - <param name="colspan" type="Integer" mandatory="false" defvalue="1" minvalue="1" maxvalue="100"> - </param> - <param name="rowspan" type="Integer" mandatory="false" defvalue="1" minvalue="1" maxvalue="100"> - </param> - <param name="levelspan" type="Integer" mandatory="false" defvalue="1" minvalue="1" maxvalue="100"> - </param> - </struct> - - <struct name="ModuleInfo" since="6.0"> - <description>Information about a RC module</description> - <param name="moduleId" type="String" maxlength="100" mandatory="true"> - <description> uuid of a module. "moduleId + moduleType" uniquely identify a module.</description> - </param> - <param name="location" type="Grid" mandatory="false"> - <description>Location of a module.</description> - </param> - <param name="serviceArea" type="Grid" mandatory="false"> - <description>Service area of a module. </description> - </param> - <param name="allowMultipleAccess" type="Boolean" mandatory="false" defvalue="true"> - <description>allow multiple users/apps to access the module or not </description> - </param> - </struct> - - <struct name="ButtonCapabilities" since="1.0"> - <description>Contains information about a button's capabilities.</description> - <param name="name" type="ButtonName" mandatory="true"> - <description>The name of the button. See ButtonName.</description> - </param> - <param name="moduleInfo" type="ModuleInfo" mandatory="false" since="6.0"> - <description>Information about a RC module, including its id. </description> - </param> - <param name="shortPressAvailable" type="Boolean" mandatory="true"> - <description> - The button supports a short press. - Whenever the button is pressed short, onButtonPressed( SHORT) will be invoked. - </description> - </param> - <param name="longPressAvailable" type="Boolean" mandatory="true"> - <description> - The button supports a LONG press. - Whenever the button is pressed long, onButtonPressed( LONG) will be invoked. - </description> - </param> - <param name="upDownAvailable" type="Boolean" mandatory="true"> - <description> - The button supports "button down" and "button up". - Whenever the button is pressed, onButtonEvent( DOWN) will be invoked. - Whenever the button is released, onButtonEvent( UP) will be invoked. - </description> - </param> - </struct> - - <struct name="SoftButtonCapabilities" since="2.0"> - <description>Contains information about a SoftButton's capabilities.</description> - <param name="shortPressAvailable" type="Boolean" mandatory="true"> - <description> - The button supports a short press. - Whenever the button is pressed short, onButtonPressed( SHORT) will be invoked. - </description> - </param> - <param name="longPressAvailable" type="Boolean" mandatory="true"> - <description> - The button supports a LONG press. - Whenever the button is pressed long, onButtonPressed( LONG) will be invoked. - </description> - </param> - <param name="upDownAvailable" type="Boolean" mandatory="true"> - <description> - The button supports "button down" and "button up". - Whenever the button is pressed, onButtonEvent( DOWN) will be invoked. - Whenever the button is released, onButtonEvent( UP) will be invoked. - </description> - </param> - <param name="imageSupported" type="Boolean" mandatory="true"> - <description>The button supports referencing a static or dynamic image.</description> - </param> - <param name="textSupported" type="Boolean" mandatory="false" since="6.0"> - <description> - The button supports the use of text. - If not included, the default value should be considered true that the button will support text. - </description> - </param> - </struct> - - <struct name="PresetBankCapabilities" since="2.0"> - <description>Contains information about on-screen preset capabilities.</description> - <param name="onScreenPresetsAvailable" type="Boolean" mandatory="true"> - <description>Onscreen custom presets are available.</description> - </param> - </struct> - - <struct name="WindowCapability" since="6.0"> - <param name="windowID" type="Integer" mandatory="false"> - <description> - The specified ID of the window. This ID is either one used when sending the CreateWindow request, - or one of the predefined window ID values from the enum PredefinedWindows. If ommited, value is - assumed to be the main window on the main display. - </description> - </param> - <param name="textFields" type="TextField" minsize="1" maxsize="100" array="true" mandatory="false"> - <description>A set of all fields that support text data. See TextField</description> - </param> - <param name="imageFields" type="ImageField" minsize="1" maxsize="100" array="true" mandatory="false"> - <description>A set of all fields that support images. See ImageField</description> - </param> - <param name="imageTypeSupported" type="ImageType" array="true" minsize="0" maxsize="1000" mandatory="false"> - <description>Provides information about image types supported by the system.</description> - </param> - <param name="templatesAvailable" type="String" minsize="0" maxsize="100" maxlength="100" array="true" mandatory="false"> - <description>A set of all window templates available on the head unit.</description> - </param> - <param name="numCustomPresetsAvailable" type="Integer" minvalue="1" maxvalue="100" mandatory="false"> - <description>The number of on-window custom presets available (if any); otherwise omitted.</description> - </param> - <param name="buttonCapabilities" type="ButtonCapabilities" minsize="1" maxsize="100" array="true" mandatory="false"> - <description>The number of buttons and the capabilities of each on-window button.</description> - </param> - <param name="softButtonCapabilities" type="SoftButtonCapabilities" minsize="1" maxsize="100" array="true" mandatory="false"> - <description>The number of soft buttons available on-window and the capabilities for each button.</description> - </param> - <param name="menuLayoutsAvailable" type="MenuLayout" array="true" minsize="1" maxsize="1000" mandatory="false" since="6.0"> - <description>An array of available menu layouts. If this parameter is not provided, only the `LIST` layout is assumed to be available</description> - </param> - </struct> - - <struct name="WindowTypeCapabilities" since="6.0"> - <param name="type" type="WindowType" mandatory="true" /> - <param name="maximumNumberOfWindows" type="Integer" mandatory="true" /> - </struct> - - <struct name="DisplayCapability" since="6.0"> - <param name="displayName" type="String" mandatory="false" /> - <param name="windowTypeSupported" type="WindowTypeCapabilities" array="true" minsize="1" mandatory="false"> - <description> - Informs the application how many windows the app is allowed to create per type. - </description> - </param> - <param name="windowCapabilities" type="WindowCapability" array="true" minsize="1" maxsize="1000" mandatory="false"> - <description> - Contains a list of capabilities of all windows related to the app. - Once the app has registered the capabilities of all windows are provided. - GetSystemCapability still allows requesting window capabilities of all windows. - After registration, only windows with capabilities changed will be included. Following cases will cause only affected windows to be included: - 1. App creates a new window. After the window is created, a system capability notification will be sent related only to the created window. - 2. App sets a new layout to the window. The new layout changes window capabilties. The notification will reflect those changes to the single window. - </description> - </param> - </struct> - - <struct name="HMICapabilities" since="3.0"> - <param name="navigation" type="Boolean" mandatory="false"> - <description>Availability of build in Nav. True: Available, False: Not Available</description> - </param> - <param name="phoneCall" type="Boolean" mandatory="false"> - <description>Availability of build in phone. True: Available, False: Not Available </description> - </param> - <param name="videoStreaming" type="Boolean" mandatory="false" since="4.5"> - <description>Availability of video streaming. </description> - </param> - <param name="remoteControl" type="Boolean" mandatory="false" since="4.5"> - <description>Availability of remote control feature. True: Available, False: Not Available</description> - </param> - <param name="appServices" type="Boolean" mandatory="false" since="6.0"> - <description>Availability of App Services functionality. True: Available, False: Not Available</description> - </param> - <param name="displays" type="Boolean" mandatory="false" since="6.0"> - <description>Availability of displays capability. True: Available, False: Not Available</description> - </param> - <param name="seatLocation" type="Boolean" mandatory="false" since="6.0"> - <description>Availability of seat location feature. True: Available, False: Not Available</description> - </param> - </struct> - - <struct name="MenuParams" since="1.0"> - <param name="parentID" type="Integer" minvalue="0" maxvalue="2000000000" defvalue="0" mandatory="false"> - <description> - unique ID of the sub menu, the command will be added to. - If not provided, it will be provided to the top level of the in application menu. - </description> - </param> - <param name="position" type="Integer" minvalue="0" maxvalue="1000" mandatory="false"> - <description> - Position within the items that are are at top level of the in application menu. - 0 will insert at the front. - 1 will insert at the second position. - if position is greater or equal than the number of items on top level, the sub menu will be appended to the end. - If this param was omitted the entry will be added at the end. - </description> - </param> - <param name="menuName" type="String" maxlength="500" mandatory="true"> - <description>Text to show in the menu for this sub menu.</description> - </param> - </struct> - - <struct name="TTSChunk" since="1.0"> - <description>A TTS chunk, that consists of text/phonemes to speak or the name of a file to play, and a TTS type (like text or SAPI)</description> - <param name="text" minlength="0" maxlength="500" type="String" mandatory="true"> - <description> - The text or phonemes to speak, or the name of the audio file to play. - May not be empty. - </description> - </param> - - <param name="type" type="SpeechCapabilities" mandatory="true"> - <description>Describes whether the TTS chunk is plain text, a specific phoneme set, or an audio file. See SpeechCapabilities</description> - </param> - </struct> - - <struct name="Turn" since="2.0"> - <param name="navigationText" type="String" maxlength="500" mandatory="false"> - <description>Individual turn text. Must provide at least text or icon for a given turn.</description> - </param> - <param name="turnIcon" type="Image" mandatory="false"> - <description>Individual turn icon. Must provide at least text or icon for a given turn.</description> - </param> - </struct> - - <struct name="VehicleType" since="2.0"> - <param name="make" type="String" maxlength="500" mandatory="false"> - <description>Make of the vehicle, e.g. Ford</description> - </param> - <param name="model" type="String" maxlength="500" mandatory="false"> - <description>Model of the vehicle, e.g. Fiesta</description> - </param> - <param name="modelYear" type="String" maxlength="500" mandatory="false"> - <description>Model Year of the vehicle, e.g. 2013</description> - </param> - <param name="trim" type="String" maxlength="500" mandatory="false"> - <description>Trim of the vehicle, e.g. SE</description> - </param> - </struct> - - <enum name="KeyboardLayout" since="3.0"> - <description>Enumeration listing possible keyboard layouts.</description> - <element name="QWERTY" /> - <element name="QWERTZ" /> - <element name="AZERTY" /> - </enum> - - <enum name="KeyboardEvent" since="3.0"> - <description>Enumeration listing possible keyboard events.</description> - <element name="KEYPRESS" /> - <element name="ENTRY_SUBMITTED" /> - <element name="ENTRY_VOICE" /> - <element name="ENTRY_CANCELLED" /> - <element name="ENTRY_ABORTED" /> - </enum> - - <enum name="KeypressMode" since="3.0"> - <description>Enumeration listing possible keyboard events.</description> - <element name="SINGLE_KEYPRESS"> - <description>Each keypress is individually sent as the user presses the keyboard keys.</description> - </element> - <element name="QUEUE_KEYPRESSES"> - <description>The keypresses are queued and a string is eventually sent once the user chooses to submit their entry.</description> - </element> - <element name="RESEND_CURRENT_ENTRY"> - <description>The keypresses are queue and a string is sent each time the user presses a keyboard key; the string contains the entire current entry.</description> - </element> - </enum> - - <struct name="KeyboardProperties" since="3.0"> - <description>Configuration of on-screen keyboard (if available).</description> - <param name="language" type="Language" mandatory="false"> - <description>The keyboard language.</description> - </param> - <param name="keyboardLayout" type="KeyboardLayout" mandatory="false" > - <description>Desired keyboard layout.</description> - </param> - <param name="keypressMode" type="KeypressMode" mandatory="false" > - <description> - Desired keypress mode. - If omitted, this value will be set to RESEND_CURRENT_ENTRY. - </description> - </param> - <param name="limitedCharacterList" type="String" maxlength="1" minsize="1" maxsize="100" array="true" mandatory="false"> - <description>Array of keyboard characters to enable.</description> - <description>All omitted characters will be greyed out (disabled) on the keyboard.</description> - <description>If omitted, the entire keyboard will be enabled.</description> - </param> - <param name="autoCompleteText" type="String" maxlength="1000" mandatory="false" deprecated="true" since="6.0"> - <description>Deprecated, use autoCompleteList instead.</description> - <history> - <param name="autoCompleteText" type="String" maxlength="1000" mandatory="false" since="3.0" until="6.0" /> - </history> - </param> - <param name="autoCompleteList" type="String" maxlength="1000" minsize="0" maxsize="100" array="true" mandatory="false" since="6.0"> - <description> - Allows an app to prepopulate the text field with a list of suggested or completed entries as the user types. - If empty, the auto-complete list will be removed from the screen. - </description> - </param> - </struct> - - <struct name="DeviceInfo" since="3.0"> - <description>Various information about connecting device.</description> - <param name="hardware" type="String" minlength="0" maxlength="500" mandatory="false"> - <description>Device model</description> - </param> - <param name="firmwareRev" type="String" minlength="0" maxlength="500" mandatory="false"> - <description>Device firmware revision</description> - </param> - <param name="os" type="String" minlength="0" maxlength="500" mandatory="false"> - <description>Device OS</description> - </param> - <param name="osVersion" type="String" minlength="0" maxlength="500" mandatory="false"> - <description>Device OS version</description> - </param> - <param name="carrier" type="String" minlength="0" maxlength="500" mandatory="false"> - <description>Device mobile carrier (if applicable)</description> - </param> - <param name="maxNumberRFCOMMPorts" type="Integer" minvalue="0" maxvalue="100" mandatory="false"> - <description>Omitted if connected not via BT.</description> - </param> - </struct> - - <enum name="RequestType" since="3.0"> - <description>Enumeration listing possible asynchronous requests.</description> - <element name="HTTP" /> - <element name="FILE_RESUME" /> - <element name="AUTH_REQUEST" /> - <element name="AUTH_CHALLENGE" /> - <element name="AUTH_ACK" /> - <element name="PROPRIETARY" /> - <element name="QUERY_APPS" /> - <element name="LAUNCH_APP" /> - <element name="LOCK_SCREEN_ICON_URL" /> - <element name="TRAFFIC_MESSAGE_CHANNEL" /> - <element name="DRIVER_PROFILE" /> - <element name="VOICE_SEARCH" /> - <element name="NAVIGATION" /> - <element name="PHONE" /> - <element name="CLIMATE" /> - <element name="SETTINGS" /> - <element name="VEHICLE_DIAGNOSTICS" /> - <element name="EMERGENCY" /> - <element name="MEDIA" /> - <element name="FOTA" /> - <element name="OEM_SPECIFIC" since="5.0" /> - <element name="ICON_URL" since="5.1" /> - </enum> - - <enum name="AppHMIType" since="2.0"> - <description>Enumeration listing possible app types.</description> - <element name="DEFAULT" /> - <element name="COMMUNICATION" /> - <element name="MEDIA" /> - <element name="MESSAGING" /> - <element name="NAVIGATION" /> - <element name="INFORMATION" /> - <element name="SOCIAL" /> - <element name="BACKGROUND_PROCESS" /> - <element name="TESTING" /> - <element name="SYSTEM" /> - <element name="PROJECTION" since="4.5" /> - <element name="REMOTE_CONTROL" since="4.5" /> - </enum> - - <enum name="PredefinedLayout" platform="documentation" since="3.0"> - <description>Predefined screen layout.</description> - <element name="DEFAULT" rootscreen="true"> - <description> - Default media / non-media screen. - Can be set as a root screen. - </description> - </element> - <element name="MEDIA" rootscreen="true"> - <description> - Default Media screen. - Can be set as a root screen. - </description> - </element> - <element name="NON-MEDIA" internal_name="NON_MEDIA" rootscreen="true"> - <description> - Default Non-media screen. - Can be set as a root screen. - </description> - </element> - <element name="ONSCREEN_PRESETS" rootscreen="true"> - <description> - Custom root media screen containing app-defined onscreen presets. - Can be set as a root screen. - </description> - </element> - <element name="NAV_FULLSCREEN_MAP" rootscreen="true" > - <description> - Custom root template screen containing full screen map with navigation controls. - Can be set as a root screen. - </description> - </element> - <element name="NAV_LIST" rootscreen="true" > - <description> - Custom root template screen containing video represented list. - Can be set as a root screen. - </description> - </element> - <element name="NAV_KEYBOARD" rootscreen="true" > - <description> - Custom root template screen containing video represented keyboard. - Can be set as a root screen. - </description> - </element> - <element name="GRAPHIC_WITH_TEXT" rootscreen="true"> - <description> - Custom root template screen containing half-screen graphic with lines of text. - Can be set as a root screen. - </description> - </element> - <element name="TEXT_WITH_GRAPHIC" rootscreen="true"> - <description> - Custom root template screen containing lines of text with half-screen graphic. - Can be set as a root screen. - </description> - </element> - <element name="TILES_ONLY" rootscreen="true"> - <description> - Custom root template screen containing only tiled SoftButtons. - Can be set as a root screen. - </description> - </element> - <element name="TEXTBUTTONS_ONLY" rootscreen="true"> - <description> - Custom root template screen containing only text SoftButtons. - Can be set as a root screen. - </description> - </element> - <element name="GRAPHIC_WITH_TILES" rootscreen="true"> - <description> - Custom root template screen containing half-screen graphic with tiled SoftButtons. - Can be set as a root screen. - </description> - </element> - <element name="TILES_WITH_GRAPHIC" rootscreen="true"> - <description> - Custom root template screen containing tiled SoftButtons with half-screen graphic. - Can be set as a root screen. - </description> - </element> - <element name="GRAPHIC_WITH_TEXT_AND_SOFTBUTTONS" rootscreen="true"> - <description> - Custom root template screen containing half-screen graphic with text and SoftButtons. - Can be set as a root screen. - </description> - </element> - <element name="TEXT_AND_SOFTBUTTONS_WITH_GRAPHIC" rootscreen="true"> - <description> - Custom root template screen containing text and SoftButtons with half-screen graphic. - Can be set as a root screen. - </description> - </element> - <element name="GRAPHIC_WITH_TEXTBUTTONS" rootscreen="true"> - <description> - Custom root template screen containing half-screen graphic with text only SoftButtons. - Can be set as a root screen. - </description> - </element> - <element name="TEXTBUTTONS_WITH_GRAPHIC" rootscreen="true"> - <description> - Custom root template screen containing text only SoftButtons with half-screen graphic. - Can be set as a root screen. - </description> - </element> - <element name="LARGE_GRAPHIC_WITH_SOFTBUTTONS" rootscreen="true"> - <description> - Custom root template screen containing a large graphic and SoftButtons. - Can be set as a root screen. - </description> - </element> - <element name="DOUBLE_GRAPHIC_WITH_SOFTBUTTONS" rootscreen="true"> - <description> - Custom root template screen containing two graphics and SoftButtons. - Can be set as a root screen. - </description> - </element> - <element name="LARGE_GRAPHIC_ONLY" rootscreen="true"> - <description> - Custom root template screen containing only a large graphic. - Can be set as a root screen. - </description> - </element> - </enum> - - <enum name="FunctionID" internal_scope="base" since="1.0"> - <description>Enumeration linking function names with function IDs in SmartDeviceLink protocol. Assumes enumeration starts at value 0.</description> - <element name="RESERVED" value="0" since="1.0" /> - <!-- - Base Request / Response RPCs - Range = 0x 0000 0001 - 0x 0000 7FFF - --> - <element name="RegisterAppInterfaceID" value="1" hexvalue="1" since="1.0" /> - <element name="UnregisterAppInterfaceID" value="2" hexvalue="2" since="1.0" /> - <element name="SetGlobalPropertiesID" value="3" hexvalue="3" since="1.0" /> - <element name="ResetGlobalPropertiesID" value="4" hexvalue="4" since="1.0" /> - <element name="AddCommandID" value="5" hexvalue="5" since="1.0" /> - <element name="DeleteCommandID" value="6" hexvalue="6" since="1.0" /> - <element name="AddSubMenuID" value="7" hexvalue="7" since="1.0" /> - <element name="DeleteSubMenuID" value="8" hexvalue="8" since="1.0" /> - <element name="CreateInteractionChoiceSetID" value="9" hexvalue="9" since="1.0" /> - <element name="PerformInteractionID" value="10" hexvalue="A" since="1.0" /> - <element name="DeleteInteractionChoiceSetID" value="11" hexvalue="B" since="1.0" /> - <element name="AlertID" value="12" hexvalue="C" since="1.0" /> - <element name="ShowID" value="13" hexvalue="D" since="1.0" /> - <element name="SpeakID" value="14" hexvalue="E" since="1.0" /> - <element name="SetMediaClockTimerID" value="15" hexvalue="F" since="1.0" /> - <element name="PerformAudioPassThruID" value="16" hexvalue="10" since="2.0" /> - <element name="EndAudioPassThruID" value="17" hexvalue="11" since="2.0" /> - <element name="SubscribeButtonID" value="18" hexvalue="12" since="1.0" /> - <element name="UnsubscribeButtonID" value="19" hexvalue="13" since="1.0" /> - <element name="SubscribeVehicleDataID" value="20" hexvalue="14" since="2.0" /> - <element name="UnsubscribeVehicleDataID" value="21" hexvalue="15" since="2.0" /> - <element name="GetVehicleDataID" value="22" hexvalue="16" since="2.0" /> - <element name="ReadDIDID" value="23" hexvalue="17" since="2.0" /> - <element name="GetDTCsID" value="24" hexvalue="18" since="2.0" /> - <element name="ScrollableMessageID" value="25" hexvalue="19" since="2.0" /> - <element name="SliderID" value="26" hexvalue="1A" since="2.0" /> - <element name="ShowConstantTBTID" value="27" hexvalue="1B" since="2.0" /> - <element name="AlertManeuverID" value="28" hexvalue="1C" since="2.0" /> - <element name="UpdateTurnListID" value="29" hexvalue="1D" since="2.0" /> - <element name="ChangeRegistrationID" value="30" hexvalue="1E" since="2.0" /> - <element name="GenericResponseID" value="31" hexvalue="1F" since="1.0" /> - <element name="PutFileID" value="32" hexvalue="20" since="3.0" /> - <element name="DeleteFileID" value="33" hexvalue="21" since="3.0" /> - <element name="ListFilesID" value="34" hexvalue="22" since="3.0" /> - <element name="SetAppIconID" value="35" hexvalue="23" since="3.0" /> - <element name="SetDisplayLayoutID" value="36" hexvalue="24" since="3.0" /> - <element name="DiagnosticMessageID" value="37" hexvalue="25" since="3.0" /> - <element name="SystemRequestID" value="38" hexvalue="26" since="3.0" /> - <element name="SendLocationID" value="39" hexvalue="27" since="3.0" /> - <element name="DialNumberID" value="40" hexvalue="28" since="3.0" /> - <element name="ButtonPressID" value="41" hexvalue="29" since="4.5" /> - <element name="GetInteriorVehicleDataID" value="43" hexvalue="2B" since="4.5" /> - <element name="SetInteriorVehicleDataID" value="44" hexvalue="2C" since="4.5" /> - <element name="GetWayPointsID" value="45" hexvalue="2D" since="4.1" /> - <element name="SubscribeWayPointsID" value="46" hexvalue="2E" since="4.1" /> - <element name="UnsubscribeWayPointsID" value="47" hexvalue="2F" since="4.1" /> - <element name="GetSystemCapabilityID" value="48" hexvalue="30" since="4.5" /> - <element name="SendHapticDataID" value="49" hexvalue="31" since="4.5" /> - <element name="SetCloudAppPropertiesID" value="50" hexvalue="32" since="5.1" /> - <element name="GetCloudAppPropertiesID" value="51" hexvalue="33" since="5.1" /> - <element name="PublishAppServiceID" value="52" hexvalue="34" since="5.1" /> - <element name="GetAppServiceDataID" value="53" hexvalue="35" since="5.1" /> - <element name="GetFileID" value="54" hexvalue="36" since="5.1" /> - <element name="PerformAppServiceInteractionID" value="55" hexvalue="37" since="5.1" /> - <element name="UnpublishAppServiceID" value="56" hexvalue="38" since="6.0" /> - <element name="CancelInteractionID" value="57" hexvalue="39" since="6.0" /> - <element name="CloseApplicationID" value="58" hexvalue="3A" since="6.0" /> - <element name="ShowAppMenuID" value="59" hexvalue="3B" since="6.0" /> - <element name="CreateWindowID" value="60" hexvalue="3C" since="6.0" /> - <element name="DeleteWindowID" value="61" hexvalue="3D" since="6.0" /> - <element name="GetInteriorVehicleDataConsentID" value="62" hexvalue="3E" since="6.0" /> - <element name="ReleaseInteriorVehicleDataModuleID" value="63" hexvalue="3F" since="6.0" /> - - <!-- - Base Notifications - Range = 0x 0000 8000 - 0x 0000 FFFF - --> - - <element name="OnHMIStatusID" value="32768" hexvalue="8000" since="1.0" /> - <element name="OnAppInterfaceUnregisteredID" value="32769" hexvalue="8001" since="1.0" /> - <element name="OnButtonEventID" value="32770" hexvalue="8002" since="1.0" /> - <element name="OnButtonPressID" value="32771" hexvalue="8003" since="1.0" /> - <element name="OnVehicleDataID" value="32772" hexvalue="8004" since="2.0" /> - <element name="OnCommandID" value="32773" hexvalue="8005" since="1.0" /> - <element name="OnTBTClientStateID" value="32774" hexvalue="8006" since="1.0" /> - <element name="OnDriverDistractionID" value="32775" hexvalue="8007" since="1.0" /> - <element name="OnPermissionsChangeID" value="32776" hexvalue="8008" since="2.0" /> - <element name="OnAudioPassThruID" value="32777" hexvalue="8009" since="2.0" /> - <element name="OnLanguageChangeID" value="32778" hexvalue="800A" since="2.0" /> - <element name="OnKeyboardInputID" value="32779" hexvalue="800B" since="3.0" /> - <element name="OnTouchEventID" value="32780" hexvalue="800C" since="3.0" /> - <element name="OnSystemRequestID" value="32781" hexvalue="800D" since="3.0" /> - <element name="OnHashChangeID" value="32782" hexvalue="800E" since="3.0" /> - <element name="OnInteriorVehicleDataID" value="32783" hexvalue="800F" since="4.5" /> - <element name="OnWayPointChangeID" value="32784" hexvalue="8010" since="4.1" /> - <element name="OnRCStatusID" value="32785" hexvalue="8011" since="5.0" /> - <element name="OnAppServiceDataID" value="32786" hexvalue="8012" since="5.1" /> - <element name="OnSystemCapabilityUpdatedID" value="32787" hexvalue="8013" since="5.1" /> - - <!-- - Ford Specific Request / Response RPCs - Range = 0x 0001 0000 - 0x 0001 7FFF - --> - - <element name="EncodedSyncPDataID" value="65536" hexvalue="10000" since="1.0" /> - <element name="SyncPDataID" value="65537" hexvalue="10001" since="1.0" /> - - <!-- - Ford Specific Notifications - Range = 0x 0001 8000 - 0x 0001 FFFF - --> - - <element name="OnEncodedSyncPDataID" value="98304" hexvalue="18000" since="1.0" /> - <element name="OnSyncPDataID" value="98305" hexvalue="18001" since="1.0" /> - </enum> - - <enum name="messageType" since="1.0"> - <description> - Enumeration linking message types with function types in WiPro protocol. - Assumes enumeration starts at value 0. - </description> - <element name="request" value="0" /> - <element name="response" value="1" /> - <element name="notification" value="2" /> - </enum> - - <struct name="DateTime" since="4.1"> - <param name="millisecond" type="Integer" minvalue="0" maxvalue="999" mandatory="false" since="4.2.2"> - <description>Milliseconds </description> - </param> - <param name="second" type="Integer" minvalue="0" maxvalue="60" mandatory="false" since="4.2.2"> - <description>Seconds part of time</description> - <history> - <param name="second" type="Integer" minvalue="0" maxvalue="60" mandatory="true" since="4.1" until="4.2.1" /> - </history> - </param> - <param name="minute" type="Integer" minvalue="0" maxvalue="59" mandatory="false" since="4.2.2"> - <description>Minutes part of time</description> - <history> - <param name="minute" type="Integer" minvalue="0" maxvalue="59" mandatory="true" since="4.1" until="4.2.1" /> - </history> - </param> - <param name="hour" type="Integer" minvalue="0" maxvalue="23" mandatory="false" since="4.2.2"> - <description>Hours part of time. Note that this structure accepts time only in 24 Hr format</description> - <history> - <param name="hour" type="Integer" minvalue="0" maxvalue="23" mandatory="true" since="4.1" until="4.2.1" /> - </history> - </param> - <param name="day" type="Integer" minvalue="1" maxvalue="31" mandatory="false" since="4.2.2"> - <description>Day of the month</description> - <history> - <param name="day" type="Integer" minvalue="1" maxvalue="31" mandatory="true" since="4.1" until="4.2.1" /> - </history> - </param> - <param name="month" type="Integer" minvalue="1" maxvalue="12" mandatory="false" since="4.2.2"> - <description>Month of the year</description> - <history> - <param name="month" type="Integer" minvalue="1" maxvalue="12" mandatory="true" since="4.1" until="4.2.1" /> - </history> - </param> - <param name="year" type="Integer" maxvalue="4095" mandatory="false" since="4.2.2"> - <description>The year in YYYY format</description> - <history> - <param name="year" type="Integer" maxvalue="4095" mandatory="true" since="4.1" until="4.2.1" /> - </history> - </param> - <param name="tz_hour" type="Integer" minvalue="-12" maxvalue="14" defvalue="0" mandatory="false" since="4.2.2"> - <description>Time zone offset in Hours wrt UTC.</description> - <history> - <param name="tz_hour" type="Integer" minvalue="-12" maxvalue="14" defvalue="0" mandatory="true" since="4.1" until="4.2.1" /> - </history> - </param> - <param name="tz_minute" type="Integer" minvalue="0" maxvalue="59" defvalue="0" mandatory="false" since="4.2.2"> - <description>Time zone offset in Min wrt UTC.</description> - <history> - <param name="tz_minute" type="Integer" minvalue="0" maxvalue="59" defvalue="0" mandatory="true" since="4.1" until="4.2.1" /> - </history> - </param> - </struct> - - <enum name="WayPointType" since="4.1"> - <description>Describes what kind of waypoint is requested/provided.</description> - <element name="ALL" /> - <element name="DESTINATION" /> - </enum> - - <struct name="Coordinate" since="4.1"> - <param name="latitudeDegrees" minvalue="-90" maxvalue="90" type="Float" mandatory="true"> - <description>Latitude of the location.</description> - </param> - <param name="longitudeDegrees" minvalue="-180" maxvalue="180" type="Float" mandatory="true"> - <description>Longitude of the location.</description> - </param> - </struct> - - <struct name="OASISAddress" since="4.1"> - <param name="countryName" minlength="0" maxlength="200" type="String" mandatory="false"> - <description>Name of the country (localized)</description> - </param> - <param name="countryCode" minlength="0" maxlength="50" type="String" mandatory="false"> - <description>Name of country (ISO 3166-2)</description> - </param> - <param name="postalCode" minlength="0" maxlength="16" type="String" mandatory="false"> - <description>(PLZ, ZIP, PIN, CAP etc.)</description> - </param> - <param name="administrativeArea" minlength="0" maxlength="200" type="String" mandatory="false"> - <description>Portion of country (e.g. state)</description> - </param> - <param name="subAdministrativeArea" minlength="0" maxlength="200" type="String" mandatory="false"> - <description>Portion of e.g. state (e.g. county)</description> - </param> - <param name="locality" minlength="0" maxlength="200" type="String" mandatory="false"> - <description>Hypernym for e.g. city/village</description> - </param> - <param name="subLocality" minlength="0" maxlength="200" type="String" mandatory="false"> - <description>Hypernym for e.g. district</description> - </param> - <param name="thoroughfare" minlength="0" maxlength="200" type="String" mandatory="false"> - <description>Hypernym for street, road etc.</description> - </param> - <param name="subThoroughfare" minlength="0" maxlength="200" type="String" mandatory="false"> - <description>Portion of thoroughfare e.g. house number</description> - </param> - </struct> - - <struct name="LocationDetails" since="4.1"> - <param name="coordinate" type="Coordinate" mandatory="false"> - <description>Latitude/Longitude of the location.</description> - </param> - <param name="locationName" type="String" maxlength="500" mandatory="false"> - <description>Name of location.</description> - </param> - <param name="addressLines" type="String" maxlength="500" minsize="0" maxsize="4" array="true" mandatory="false"> - <description>Location address for display purposes only</description> - </param> - <param name="locationDescription" type="String" maxlength="500" mandatory="false"> - <description>Description intended location / establishment (if applicable)</description> - </param> - <param name="phoneNumber" type="String" maxlength="500" mandatory="false"> - <description>Phone number of location / establishment.</description> - </param> - <param name="locationImage" type="Image" mandatory="false"> - <description>Image / icon of intended location.</description> - </param> - <param name="searchAddress" type="OASISAddress" mandatory="false"> - <description>Address to be used by navigation engines for search</description> - </param> - </struct> - - <enum name="SystemCapabilityType" since="4.5"> - <description>Enumerations of all available system capability types</description> - <element name="NAVIGATION"/> - <element name="PHONE_CALL"/> - <element name="VIDEO_STREAMING"/> - <element name="REMOTE_CONTROL"/> - <element name="APP_SERVICES" since="5.1"/> - <element name="SEAT_LOCATION" since="6.0"/> - <element name="DISPLAYS" since="6.0"/> - </enum> - - <struct name="NavigationCapability" since="4.5"> - <description>Extended capabilities for an onboard navigation system</description> - <param name="sendLocationEnabled" type="Boolean" mandatory="false"> - <description>If the module has the ability to add locations to the onboard nav</description> - </param> - <param name="getWayPointsEnabled" type="Boolean" mandatory="false"> - <description>If the module has the ability to return way points from onboard nav</description> - </param> - </struct> - - <struct name="PhoneCapability" since="4.5"> - <description>Extended capabilities of the module's phone feature</description> - <param name="dialNumberEnabled" type="Boolean" mandatory="false"> - <description>If the module has the ability to perform dial number</description> - </param> - </struct> - - <struct name="VideoStreamingFormat" since="4.5"> - <description>Video streaming formats and their specifications.</description> - <param name="protocol" type="VideoStreamingProtocol" mandatory="true"> - <description>Protocol type, see VideoStreamingProtocol</description> - </param> - <param name="codec" type="VideoStreamingCodec" mandatory="true"> - <description>Codec type, see VideoStreamingCodec</description> - </param> - </struct> - - <struct name="VideoStreamingCapability" since="4.5"> - <description>Contains information about this system's video streaming capabilities.</description> - <param name="preferredResolution" type="ImageResolution" mandatory="false"> - <description>The preferred resolution of a video stream for decoding and rendering on HMI.</description> - </param> - <param name="maxBitrate" type="Integer" minvalue="0" maxvalue="2147483647" mandatory="false"> - <description>The maximum bitrate of video stream that is supported, in kbps.</description> - </param> - <param name="supportedFormats" type="VideoStreamingFormat" array="true" mandatory="false"> - <description>Detailed information on each format supported by this system, in its preferred order (i.e. the first element in the array is most preferable to the system). Each object will contain a VideoStreamingFormat that describes what can be expected.</description> - </param> - <param name="hapticSpatialDataSupported" type="Boolean" mandatory="false"> - <description>True if the system can utilize the haptic spatial data from the source being streamed. If not included, it can be assumed the module doesn't support haptic spatial data'. </description> - </param> - <param name="diagonalScreenSize" type="Float" minvalue="0" mandatory="false" since="6.0"> - <description>The diagonal screen size in inches.</description> - </param> - <param name="pixelPerInch" type="Float" minvalue="0" mandatory="false" since="6.0"> - <description>PPI is the diagonal resolution in pixels divided by the diagonal screen size in inches.</description> - </param> - <param name="scale" type="Float" minvalue="1" maxvalue="10" mandatory="false" since="6.0"> - <description>The scaling factor the app should use to change the size of the projecting view.</description> - </param> - </struct> - - <struct name="RGBColor" since="5.0"> - <param name="red" type="Integer" minvalue="0" maxvalue="255" mandatory="true" /> - <param name="green" type="Integer" minvalue="0" maxvalue="255" mandatory="true" /> - <param name="blue" type="Integer" minvalue="0" maxvalue="255" mandatory="true" /> - </struct> - - <struct name="TemplateColorScheme" since="5.0"> - <description> - A color scheme for all display layout templates. - </description> - <param name="primaryColor" type="RGBColor" mandatory="false"> - <description>The primary "accent" color</description> - </param> - <param name="secondaryColor" type="RGBColor" mandatory="false"> - <description>The secondary "accent" color</description> - </param> - <param name="backgroundColor" type="RGBColor" mandatory="false"> - <description>The color of the background</description> - </param> - </struct> - - <struct name="TemplateConfiguration" since="6.0"> - <param name="template" type="String" maxlength="500" mandatory="true"> - <description> - Predefined or dynamically created window template. - Currently only predefined window template layouts are defined. - </description> - </param> - <param name="dayColorScheme" type="TemplateColorScheme" mandatory="false" /> - <param name="nightColorScheme" type="TemplateColorScheme" mandatory="false" /> - </struct> - - <!---Remote control --> - - <struct name="SeatLocation" since="6.0"> - <description>Describes the location of a seat.</description> - <param name="grid" type="Grid" mandatory="false"> - </param> - </struct> - - <struct name="SeatLocationCapability" since="6.0"> - <description>Contains information about the locations of each seat</description> - <param name="rows" type="Integer" minvalue="1" maxvalue="100" mandatory="false"></param> - <param name="columns" type="Integer" minvalue="1" maxvalue="100" mandatory="false"></param> - <param name="levels" type="Integer" minvalue="1" maxvalue="100" defvalue="1" mandatory="false"> - </param> - <param name="seats" type="SeatLocation" array="true" mandatory="false"> - <description>Contains a list of SeatLocation in the vehicle</description> - </param> - </struct> - - <enum name="MassageZone" since="5.0"> - <description>List possible zones of a multi-contour massage seat.</description> - <element name="LUMBAR"> - <description>The back of a multi-contour massage seat. or SEAT_BACK</description> - </element> - <element name="SEAT_CUSHION"> - <description>The bottom a multi-contour massage seat. or SEAT_BOTTOM </description> - </element> - </enum> - - <enum name="MassageMode" since="5.0"> - <description>List possible modes of a massage zone.</description> - <element name="OFF"/> - <element name="LOW"/> - <element name="HIGH"/> - </enum> - - <struct name="MassageModeData" since="5.0"> - <description>Specify the mode of a massage zone.</description> - <param name="massageZone" type="MassageZone" mandatory="true"></param> - <param name="massageMode" type="MassageMode" mandatory="true"></param> - </struct> - - <enum name="MassageCushion" since="5.0"> - <description>List possible cushions of a multi-contour massage seat.</description> - <element name="TOP_LUMBAR"/> - <element name="MIDDLE_LUMBAR"/> - <element name="BOTTOM_LUMBAR"/> - <element name="BACK_BOLSTERS"/> - <element name="SEAT_BOLSTERS"/> - </enum> - - <struct name="MassageCushionFirmness" since="5.0"> - <description>The intensity or firmness of a cushion.</description> - <param name="cushion" type="MassageCushion" mandatory="true"></param> - <param name="firmness" type="Integer" minvalue="0" maxvalue="100" mandatory="true"></param> - </struct> - - <enum name="SeatMemoryActionType" since="5.0"> - <element name="SAVE"> - <description>Save current seat postions and settings to seat memory.</description> - </element> - <element name="RESTORE"> - <description>Restore / apply the seat memory settings to the current seat. </description> - </element> - <element name="NONE"> - <description>No action to be performed.</description> - </element> - </enum> - - <struct name="SeatMemoryAction" since="5.0"> - <param name="id" type="Integer" minvalue="1" maxvalue="10" mandatory="true"/> - <param name="label" type="String" maxlength="100" mandatory="false"/> - <param name="action" type="SeatMemoryActionType" mandatory="true"/> - </struct> - - <enum name="SupportedSeat" deprecated="true" since="6.0"> - <description>List possible seats that is a remote controllable seat.</description> - <history> - <enum name="SupportedSeat" since="5.0" until="6.0"/> - </history> - <element name="DRIVER"/> - <element name="FRONT_PASSENGER"/> - </enum> - - <struct name="SeatControlData" since="5.0"> - <description>Seat control data corresponds to "SEAT" ModuleType. </description> - <param name="id" type="SupportedSeat" mandatory="true" deprecated="true" since="6.0"> - <history> - <param name="id" type="SupportedSeat" mandatory="true" since="5.0" until="6.0"/> - </history> - </param> - - <param name="heatingEnabled" type="Boolean" mandatory="false"></param> - <param name="coolingEnabled" type="Boolean" mandatory="false"></param> - <param name="heatingLevel" type="Integer" minvalue="0" maxvalue="100" mandatory="false"></param> - <param name="coolingLevel" type="Integer" minvalue="0" maxvalue="100" mandatory="false"></param> - - <param name="horizontalPosition" type="Integer" minvalue="0" maxvalue="100" mandatory="false"></param> - <param name="verticalPosition" type="Integer" minvalue="0" maxvalue="100" mandatory="false"></param> - <param name="frontVerticalPosition" type="Integer" minvalue="0" maxvalue="100" mandatory="false"></param> - <param name="backVerticalPosition" type="Integer" minvalue="0" maxvalue="100" mandatory="false"></param> - <param name="backTiltAngle" type="Integer" minvalue="0" maxvalue="100" mandatory="false"></param> - - <param name="headSupportHorizontalPosition" type="Integer" minvalue="0" maxvalue="100" mandatory="false"></param> - <param name="headSupportVerticalPosition" type="Integer" minvalue="0" maxvalue="100" mandatory="false"></param> - - <param name="massageEnabled" type="Boolean" mandatory="false"></param> - <param name="massageMode" type="MassageModeData" minsize="1" maxsize="2" array="true" mandatory="false"></param> - <param name="massageCushionFirmness" type="MassageCushionFirmness" minsize="1" maxsize="5" array="true" mandatory="false"></param> - - <param name="memory" type="SeatMemoryAction" mandatory="false"></param> - </struct> - - <struct name="SeatControlCapabilities" since="5.0"> - <param name="moduleName" type="String" maxlength="100" mandatory="true"> - <description> - The short friendly name of the light control module. - It should not be used to identify a module by mobile application. - </description> - </param> - <param name="moduleInfo" type="ModuleInfo" mandatory="false" since="6.0"> - <description>Information about a RC module, including its id. </description> - </param> - <param name="heatingEnabledAvailable" type="Boolean" mandatory="false"> - </param> - <param name="coolingEnabledAvailable" type="Boolean" mandatory="false"> - </param> - <param name="heatingLevelAvailable" type="Boolean" mandatory="false"> - </param> - <param name="coolingLevelAvailable" type="Boolean" mandatory="false"> - </param> - <param name="horizontalPositionAvailable" type="Boolean" mandatory="false"> - </param> - <param name="verticalPositionAvailable" type="Boolean" mandatory="false"> - </param> - <param name="frontVerticalPositionAvailable" type="Boolean" mandatory="false"> - </param> - <param name="backVerticalPositionAvailable" type="Boolean" mandatory="false"> - </param> - <param name="backTiltAngleAvailable" type="Boolean" mandatory="false"> - </param> - <param name="headSupportHorizontalPositionAvailable" type="Boolean" mandatory="false"> - </param> - <param name="headSupportVerticalPositionAvailable" type="Boolean" mandatory="false"> - </param> - <param name="massageEnabledAvailable" type="Boolean" mandatory="false"> - </param> - <param name="massageModeAvailable" type="Boolean" mandatory="false"> - </param> - <param name="massageCushionFirmnessAvailable" type="Boolean" mandatory="false"> - </param> - <param name="memoryAvailable" type="Boolean" mandatory="false"> - </param> - </struct> - - <struct name="Temperature" since="4.5"> - <param name="unit" type="TemperatureUnit" mandatory="true"> - <description>Temperature Unit</description> - </param> - <param name="value" type="Float" mandatory="true"> - <description>Temperature Value in TemperatureUnit specified unit. Range depends on OEM and is not checked by SDL.</description> - </param> - </struct> - - <struct name="RdsData" since="4.5"> - <param name="PS" type="String" minlength="0" maxlength="8" mandatory="false"> - <description>Program Service Name</description> - </param> - <param name="RT" type="String" minlength="0" maxlength="64" mandatory="false"> - <description>Radio Text</description> - </param> - <param name="CT" type="String" minlength="24" maxlength="24" mandatory="false"> - <description>The clock text in UTC format as YYYY-MM-DDThh:mm:ss.sTZD</description> - </param> - <param name="PI" type="String" minlength="0" maxlength="6" mandatory="false"> - <description>Program Identification - the call sign for the radio station</description> - </param> - <param name="PTY" type="Integer" minvalue="0" maxvalue="31" mandatory="false"> - <description>The program type - The region should be used to differentiate between EU and North America program types</description> - </param> - <param name="TP" type="Boolean" mandatory="false"> - <description>Traffic Program Identification - Identifies a station that offers traffic</description> - </param> - <param name="TA" type="Boolean" mandatory="false"> - <description>Traffic Announcement Identification - Indicates an ongoing traffic announcement</description> - </param> - <param name="REG" type="String" mandatory="false"> - <description>Region</description> - </param> - </struct> - - <struct name="StationIDNumber" since="5.0"> - <param name="countryCode" type="Integer" minvalue="0" maxvalue="999" mandatory="false"> - <description>Binary Representation of ITU Country Code. USA Code is 001.</description> - </param> - <param name="fccFacilityId" type="Integer" minvalue="0" maxvalue="999999" mandatory="false"> - <description>Binary representation of unique facility ID assigned by the FCC; FCC controlled for U.S. territory</description> - </param> - </struct> - - <struct name="SisData" since="5.0"> - <param name="stationShortName" type="String" minlength="4" maxlength="7" mandatory="false"> - <description>Identifies the 4-alpha-character station call sign plus an optional (-FM) extension</description> - </param> - <param name="stationIDNumber" type="StationIDNumber" mandatory="false"> - <description>Used for network Application. Consists of Country Code and FCC Facility ID.</description> - </param> - <param name="stationLongName" type="String" minlength="0" maxlength="56" mandatory="false"> - <description>Identifies the station call sign or other identifying information in the long format.</description> - </param> - <param name="stationLocation" type="GPSData" mandatory="false"> - <description>Provides the 3-dimensional geographic station location.</description> - </param> - <param name="stationMessage" type="String" minlength="0" maxlength="56" mandatory="false"> - <description>May be used to convey textual information of general interest to the consumer such as weather forecasts or public service announcements. Includes a high priority delivery feature to convey emergencies that may be in the listening area.</description> - </param> - </struct> - - <struct name="RadioControlData" since="4.5"> - <param name="frequencyInteger" type="Integer" minvalue="0" maxvalue="1710" mandatory="false"> - <description>The integer part of the frequency ie for 101.7 this value should be 101</description> - </param> - <param name="frequencyFraction" type="Integer" minvalue="0" maxvalue="9" mandatory="false"> - <description>The fractional part of the frequency for 101.7 is 7</description> - </param> - <param name="band" type="RadioBand" mandatory="false"> - </param> - <param name="rdsData" type="RdsData" mandatory="false"> - </param> - <param name="hdRadioEnable" type="Boolean" mandatory="false" since="5.0"> - <description> True if the hd radio is on, false if the radio is off</description> - </param> - <param name="availableHDs" type="Integer" minvalue="1" maxvalue="7" mandatory="false" deprecated="true" since="6.0"> - <description>Number of HD sub-channels if available</description> - <history> - <param name="availableHDs" type="Integer" minvalue="1" maxvalue="3" mandatory="false" since="4.5" until="5.0"/> - <param name="availableHDs" type="Integer" minvalue="1" maxvalue="7" mandatory="false" since="5.0" until="6.0"/> - </history> - </param> - <param name="availableHdChannels" type="Integer" minvalue="0" maxvalue="7" array="true" minsize="0" maxsize="8" mandatory="false" since="6.0"> - <description>The list of available HD sub-channel indexes. Empty list means no Hd channel is available. Read-only. </description> - </param> - <param name="hdChannel" type="Integer" minvalue="0" maxvalue="7" mandatory="false" since="6.0"> - <description>Current HD sub-channel if available</description> - <history> - <param name="hdChannel" type="Integer" minvalue="1" maxvalue="3" mandatory="false" since="4.5" until="5.0"/> - <param name="hdChannel" type="Integer" minvalue="1" maxvalue="7" mandatory="false" since="5.0" until="6.0"/> - </history> - </param> - <param name="signalStrength" type="Integer" minvalue="0" maxvalue="100" mandatory="false"> - </param> - <param name="signalChangeThreshold" type="Integer" minvalue="0" maxvalue="100" mandatory="false"> - <description>If the signal strength falls below the set value for this parameter, the radio will tune to an alternative frequency</description> - </param> - <param name="radioEnable" type="Boolean" mandatory="false"> - <description> True if the radio is on, false if the radio is off. If set to false, no other data will be included.</description> - </param> - <param name="state" type="RadioState" mandatory="false"> - </param> - <param name="sisData" type="SisData" mandatory="false" since="5.0"> - <description>Read-only Station Information Service (SIS) data provides basic information about the station such as call sign, as well as information not displayable to the consumer such as the station identification number</description> - </param> - </struct> - - <struct name="ClimateControlData" since="4.5"> - <param name="fanSpeed" type="Integer" minvalue="0" maxvalue="100" mandatory="false"> - </param> - <param name="currentTemperature" type="Temperature" mandatory="false"> - </param> - <param name="desiredTemperature" type="Temperature" mandatory="false"> - </param> - <param name="acEnable" type="Boolean" mandatory="false"> - </param> - <param name="circulateAirEnable" type="Boolean" mandatory="false"> - </param> - <param name="autoModeEnable" type="Boolean" mandatory="false"> - </param> - <param name="defrostZone" type="DefrostZone" mandatory="false"> - </param> - <param name="dualModeEnable" type="Boolean" mandatory="false"> - </param> - <param name="acMaxEnable" type="Boolean" mandatory="false"> - </param> - <param name="ventilationMode" type="VentilationMode" mandatory="false"> - </param> - <param name="heatedSteeringWheelEnable" type="Boolean" mandatory="false" since="5.0"> - <description>value false means disabled/turn off, value true means enabled/turn on.</description> - </param> - <param name="heatedWindshieldEnable" type="Boolean" mandatory="false" since="5.0"> - <description>value false means disabled, value true means enabled.</description> - </param> - <param name="heatedRearWindowEnable" type="Boolean" mandatory="false" since="5.0"> - <description>value false means disabled, value true means enabled.</description> - </param> - <param name="heatedMirrorsEnable" type="Boolean" mandatory="false" since="5.0"> - <description>value false means disabled, value true means enabled.</description> - </param> - <param name="climateEnable" type="Boolean" mandatory="false" since="6.0"> - <description>True if the climate module is on, false if the climate module is off</description> - </param> - </struct> - - <struct name="RadioControlCapabilities" since="4.5"> - <description>Contains information about a radio control module's capabilities.</description> - <param name="moduleName" type="String" maxlength="100" mandatory="true"> - <description> - The short friendly name of the climate control module. - It should not be used to identify a module by mobile application. - </description> - </param> - <param name="moduleInfo" type="ModuleInfo" mandatory="false" since="6.0"> - <description>Information about a RC module, including its id. </description> - </param> - <param name="radioEnableAvailable" type="Boolean" mandatory="false"> - <description> - Availability of the control of enable/disable radio. - True: Available, False: Not Available, Not present: Not Available. - </description> - </param> - <param name="radioBandAvailable" type="Boolean" mandatory="false"> - <description> - Availability of the control of radio band. - True: Available, False: Not Available, Not present: Not Available. - </description> - </param> - <param name="radioFrequencyAvailable" type="Boolean" mandatory="false"> - <description> - Availability of the control of radio frequency. - True: Available, False: Not Available, Not present: Not Available. - </description> - </param> - <param name="hdChannelAvailable" type="Boolean" mandatory="false"> - <description> - Availability of the control of HD radio channel. - True: Available, False: Not Available, Not present: Not Available. - </description> - </param> - <param name="rdsDataAvailable" type="Boolean" mandatory="false"> - <description> - Availability of the getting Radio Data System (RDS) data. - True: Available, False: Not Available, Not present: Not Available. - </description> - </param> - <param name="availableHDsAvailable" type="Boolean" mandatory="false" deprecated="true" since="6.0"> - <description> - Availability of the getting the number of available HD channels. - True: Available, False: Not Available, Not present: Not Available. - </description> - <history> - <param name="availableHDsAvailable" type="Boolean" mandatory="false" since="4.5" until="6.0"/> - </history> - </param> - <param name="availableHdChannelsAvailable" type="Boolean" mandatory="false" since="6.0"> - <description> - Availability of the list of available HD sub-channel indexes. - True: Available, False: Not Available, Not present: Not Available. - </description> - </param> - <param name="stateAvailable" type="Boolean" mandatory="false"> - <description> - Availability of the getting the Radio state. - True: Available, False: Not Available, Not present: Not Available. - </description> - </param> - <param name="signalStrengthAvailable" type="Boolean" mandatory="false"> - <description> - Availability of the getting the signal strength. - True: Available, False: Not Available, Not present: Not Available. - </description> - </param> - <param name="signalChangeThresholdAvailable" type="Boolean" mandatory="false"> - <description> - Availability of the getting the signal Change Threshold. - True: Available, False: Not Available, Not present: Not Available. - </description> - </param> - <param name="sisDataAvailable" type="Boolean" mandatory="false" since="5.0"> - <description> - Availability of the getting HD radio Station Information Service (SIS) data. - True: Available, False: Not Available, Not present: Not Available. - </description> - </param> - <param name="hdRadioEnableAvailable" type="Boolean" mandatory="false" since="5.0"> - <description> - Availability of the control of enable/disable HD radio. - True: Available, False: Not Available, Not present: Not Available. - </description> - </param> - <param name="siriusxmRadioAvailable" type="Boolean" mandatory="false" since="5.0"> - <description> - Availability of sirius XM radio. - True: Available, False: Not Available, Not present: Not Available. - </description> - </param> - </struct> - - <struct name="ClimateControlCapabilities" since="4.5"> - <description>Contains information about a climate control module's capabilities.</description> - <param name="moduleName" type="String" maxlength="100" mandatory="true"> - <description>The short friendly name of the climate control module. - It should not be used to identify a module by mobile application.</description> - </param> - <param name="moduleInfo" type="ModuleInfo" mandatory="false" since="6.0"> - <description>Information about a RC module, including its id. </description> - </param> - <param name="currentTemperatureAvailable" type="Boolean" mandatory="false" since="5.0"> - <description> - Availability of the reading of current temperature. - True: Available, False: Not Available, Not present: Not Available. - </description> - </param> - <param name="fanSpeedAvailable" type="Boolean" mandatory="false"> - <description> - Availability of the control of fan speed. - True: Available, False: Not Available, Not present: Not Available. - </description> - </param> - <param name="desiredTemperatureAvailable" type="Boolean" mandatory="false"> - <description> - Availability of the control of desired temperature. - True: Available, False: Not Available, Not present: Not Available. - </description> - </param> - <param name="acEnableAvailable" type="Boolean" mandatory="false"> - <description> - Availability of the control of turn on/off AC. - True: Available, False: Not Available, Not present: Not Available. - </description> - </param> - <param name="acMaxEnableAvailable" type="Boolean" mandatory="false"> - <description> - Availability of the control of enable/disable air conditioning is ON on the maximum level. - True: Available, False: Not Available, Not present: Not Available. - </description> - </param> - <param name="circulateAirEnableAvailable" type="Boolean" mandatory="false"> - <description> - Availability of the control of enable/disable circulate Air mode. - True: Available, False: Not Available, Not present: Not Available. - </description> - </param> - <param name="autoModeEnableAvailable" type="Boolean" mandatory="false"> - <description> - Availability of the control of enable/disable auto mode. - True: Available, False: Not Available, Not present: Not Available. - </description> - </param> - <param name="dualModeEnableAvailable" type="Boolean" mandatory="false"> - <description> - Availability of the control of enable/disable dual mode. - True: Available, False: Not Available, Not present: Not Available. - </description> - </param> - <param name="defrostZoneAvailable" type="Boolean" mandatory="false"> - <description> - Availability of the control of defrost zones. - True: Available, False: Not Available, Not present: Not Available. - </description> - </param> - <param name="defrostZone" type="DefrostZone" minsize="1" maxsize="100" array="true" mandatory="false"> - <description> - A set of all defrost zones that are controllable. - </description> - </param> - <param name="ventilationModeAvailable" type="Boolean" mandatory="false"> - <description> - Availability of the control of air ventilation mode. - True: Available, False: Not Available, Not present: Not Available. - </description> - </param> - <param name="ventilationMode" type="VentilationMode" minsize="1" maxsize="100" array="true" mandatory="false"> - <description> - A set of all ventilation modes that are controllable. - </description> - </param> - <param name="heatedSteeringWheelAvailable" type="Boolean" mandatory="false" since="5.0"> - <description> - Availability of the control (enable/disable) of heated Steering Wheel. - True: Available, False: Not Available, Not present: Not Available. - </description> - </param> - <param name="heatedWindshieldAvailable" type="Boolean" mandatory="false" since="5.0"> - <description> - Availability of the control (enable/disable) of heated Windshield. - True: Available, False: Not Available, Not present: Not Available. - </description> - </param> - <param name="heatedRearWindowAvailable" type="Boolean" mandatory="false" since="5.0"> - <description> - Availability of the control (enable/disable) of heated Rear Window. - True: Available, False: Not Available, Not present: Not Available. - </description> - </param> - <param name="heatedMirrorsAvailable" type="Boolean" mandatory="false" since="5.0"> - <description> - Availability of the control (enable/disable) of heated Mirrors. - True: Available, False: Not Available, Not present: Not Available. - </description> - </param> - <param name="climateEnableAvailable" type="Boolean" mandatory="false" since="6.0"> - <description> - Availability of the control of enable/disable climate control. - True: Available, False: Not Available, Not present: Not Available. - </description> - </param> - </struct> - - <struct name="EqualizerSettings" since="5.0"> - <description>Defines the each Equalizer channel settings.</description> - <param name="channelId" type="Integer" minvalue="1" maxvalue="100" mandatory="true"></param> - <param name="channelName" type="String" mandatory="false" maxlength="50"> - <description>read-only channel / frequency name (e.i. "Treble, Midrange, Bass" or "125 Hz")</description> - </param> - <param name="channelSetting" type="Integer" minvalue="0" maxvalue="100" mandatory="true"> - <description>Reflects the setting, from 0%-100%.</description> - </param> - </struct> - - <struct name="AudioControlData" since="5.0"> - <param name="source" type="PrimaryAudioSource" mandatory="false"> - <description> - In a getter response or a notification, it is the current primary audio source of the system. - In a setter request, it is the target audio source that the system shall switch to. - If the value is MOBILE_APP, the system shall switch to the mobile media app that issues the setter RPC. - </description> - </param> - <param name="keepContext" type="Boolean" mandatory="false"> - <description> - This parameter shall not be present in any getter responses or notifications. - This parameter is optional in a setter request. The default value is false if it is not included. - If it is false, the system not only changes the audio source but also brings the default application or - system UI associated with the audio source to foreground. - If it is true, the system only changes the audio source, but keeps the current application in foreground. - </description> - </param> - <param name="volume" type="Integer" mandatory="false" minvalue="0" maxvalue="100"> - <description>Reflects the volume of audio, from 0%-100%.</description> - </param> - <param name="equalizerSettings" type="EqualizerSettings" minsize="1" maxsize="100" mandatory="false" array="true"> - <description>Defines the list of supported channels (band) and their current/desired settings on HMI</description> - </param> - </struct> - - <struct name="AudioControlCapabilities" since="5.0"> - <param name="moduleName" type="String" maxlength="100" mandatory="true"> - <description> - The short friendly name of the light control module. - It should not be used to identify a module by mobile application. - </description> - </param> - <param name="moduleInfo" type="ModuleInfo" mandatory="false" since="6.0"> - <description>Information about a RC module, including its id. </description> - </param> - <param name="sourceAvailable" type="Boolean" mandatory="false"> - <description>Availability of the control of audio source. </description> - </param> - <param name="keepContextAvailable" type="Boolean" mandatory="false"> - <description>Availability of the keepContext parameter. </description> - </param> - <param name="volumeAvailable" type="Boolean" mandatory="false"> - <description>Availability of the control of audio volume.</description> - </param> - <param name="equalizerAvailable" type="Boolean" mandatory="false"> - <description>Availability of the control of Equalizer Settings.</description> - </param> - <param name="equalizerMaxChannelId" type="Integer" minvalue="1" maxvalue="100" mandatory="false"> - <description>Must be included if equalizerAvailable=true, and assume all IDs starting from 1 to this value are valid</description> - </param> - </struct> - - <enum name="LightName" since="5.0"> - <!-- Common Single Light 0~500 --> - <element name="FRONT_LEFT_HIGH_BEAM" value="0"/> - <element name="FRONT_RIGHT_HIGH_BEAM" value="1"/> - <element name="FRONT_LEFT_LOW_BEAM" value="2"/> - <element name="FRONT_RIGHT_LOW_BEAM" value="3"/> - <element name="FRONT_LEFT_PARKING_LIGHT" value="4"/> - <element name="FRONT_RIGHT_PARKING_LIGHT" value="5"/> - <element name="FRONT_LEFT_FOG_LIGHT" value="6"/> - <element name="FRONT_RIGHT_FOG_LIGHT" value="7"/> - <element name="FRONT_LEFT_DAYTIME_RUNNING_LIGHT" value="8"/> - <element name="FRONT_RIGHT_DAYTIME_RUNNING_LIGHT" value="9"/> - <element name="FRONT_LEFT_TURN_LIGHT" value="10"/> - <element name="FRONT_RIGHT_TURN_LIGHT" value="11"/> - <element name="REAR_LEFT_FOG_LIGHT" value="12"/> - <element name="REAR_RIGHT_FOG_LIGHT" value="13"/> - <element name="REAR_LEFT_TAIL_LIGHT" value="14"/> - <element name="REAR_RIGHT_TAIL_LIGHT" value="15"/> - <element name="REAR_LEFT_BRAKE_LIGHT" value="16"/> - <element name="REAR_RIGHT_BRAKE_LIGHT" value="17"/> - <element name="REAR_LEFT_TURN_LIGHT" value="18"/> - <element name="REAR_RIGHT_TURN_LIGHT" value="19"/> - <element name="REAR_REGISTRATION_PLATE_LIGHT" value="20"/> - - <!-- Exterior Lights by common function groups 501~800 --> - <element name="HIGH_BEAMS" value="501"> - <description>Include all high beam lights: front_left and front_right.</description> - </element> - <element name="LOW_BEAMS" value="502"> - <description>Include all low beam lights: front_left and front_right.</description> - </element> - <element name="FOG_LIGHTS" value="503"> - <description>Include all fog lights: front_left, front_right, rear_left and rear_right.</description> - </element> - <element name="RUNNING_LIGHTS" value="504"> - <description>Include all daytime running lights: front_left and front_right.</description> - </element> - <element name="PARKING_LIGHTS" value="505"> - <description>Include all parking lights: front_left and front_right.</description> - </element> - <element name="BRAKE_LIGHTS" value="506"> - <description>Include all brake lights: rear_left and rear_right.</description> - </element> - <element name="REAR_REVERSING_LIGHTS" value="507"/> - <element name="SIDE_MARKER_LIGHTS" value="508"/> - <element name="LEFT_TURN_LIGHTS" value="509"> - <description>Include all left turn signal lights: front_left, rear_left, left_side and mirror_mounted.</description> - </element> - <element name="RIGHT_TURN_LIGHTS" value="510"> - <description>Include all right turn signal lights: front_right, rear_right, right_side and mirror_mounted.</description> - </element> - <element name="HAZARD_LIGHTS" value="511"> - <description>Include all hazard lights: front_left, front_right, rear_left and rear_right.</description> - </element> - <element name="REAR_CARGO_LIGHTS" value="512"> - <description>Cargo lamps illuminate the cargo area.</description> - </element> - <element name="REAR_TRUCK_BED_LIGHTS" value="513"> - <description>Truck bed lamps light up the bed of the truck.</description> - </element> - <element name="REAR_TRAILER_LIGHTS" value="514"> - <description>Trailer lights are lamps mounted on a trailer hitch.</description> - </element> - <element name="LEFT_SPOT_LIGHTS" value="515"> - <description>It is the spotlights mounted on the left side of a vehicle.</description> - </element> - <element name="RIGHT_SPOT_LIGHTS" value="516"> - <description>It is the spotlights mounted on the right side of a vehicle.</description> - </element> - <element name="LEFT_PUDDLE_LIGHTS" value="517"> - <description>Puddle lamps illuminate the ground beside the door as the customer is opening or approaching the door.</description> - </element> - <element name="RIGHT_PUDDLE_LIGHTS" value="518"> - <description>Puddle lamps illuminate the ground beside the door as the customer is opening or approaching the door.</description> - </element> - - <!-- Interior Lights by common function groups 801~900 --> - <element name="AMBIENT_LIGHTS" value="801"/> - <element name="OVERHEAD_LIGHTS" value="802"/> - <element name="READING_LIGHTS" value="803"/> - <element name="TRUNK_LIGHTS" value="804"/> - - <!-- Lights by location 901~1000--> - <element name="EXTERIOR_FRONT_LIGHTS" value="901"> - <description>Include exterior lights located in front of the vehicle. For example, fog lights and low beams.</description> - </element> - <element name="EXTERIOR_REAR_LIGHTS" value="902"> - <description>Include exterior lights located at the back of the vehicle. For example, license plate lights, reverse lights, cargo lights, bed lights and trailer assist lights.</description> - </element> - <element name="EXTERIOR_LEFT_LIGHTS" value="903"> - <description>Include exterior lights located at the left side of the vehicle. For example, left puddle lights and spot lights.</description> - </element> - <element name="EXTERIOR_RIGHT_LIGHTS" value="904"> - <description>Include exterior lights located at the right side of the vehicle. For example, right puddle lights and spot lights.</description> - </element> - <element name="EXTERIOR_ALL_LIGHTS" value="905"> - <description> Include all exterior lights around the vehicle.</description> - </element> - </enum> - - <enum name="LightStatus" since="5.0"> - <element name="ON"/> - <element name="OFF"/> - <element name="RAMP_UP"/> - <element name="RAMP_DOWN"/> - <element name="UNKNOWN"/> - <element name="INVALID"/> - </enum> - - <struct name="LightCapabilities" since="5.0"> - <param name="name" type="LightName" mandatory="true" /> - <param name="statusAvailable" type="Boolean" mandatory="false"> - <description> - Indicates if the status (ON/OFF) can be set remotely. App shall not use read-only values (RAMP_UP/RAMP_DOWN/UNKNOWN/INVALID) in a setInteriorVehicleData request. - </description> - </param> - <param name="densityAvailable" type="Boolean" mandatory="false"> - <description> - Indicates if the light's density can be set remotely (similar to a dimmer). - </description> - </param> - <param name="rgbColorSpaceAvailable" type="Boolean" mandatory="false"> - <description> - Indicates if the light's color can be set remotely by using the sRGB color space. - </description> - </param> - </struct> - - <struct name="LightControlCapabilities" since="5.0"> - <param name="moduleName" type="String" maxlength="100" mandatory="true"> - <description> - The short friendly name of the light control module. - It should not be used to identify a module by mobile application. - </description> - </param> - <param name="moduleInfo" type="ModuleInfo" mandatory="false" since="6.0"> - <description>Information about a RC module, including its id. </description> - </param> - <param name="supportedLights" type="LightCapabilities" minsize="1" maxsize="100" array="true" mandatory="true"> - <description> An array of available LightCapabilities that are controllable. </description> - </param> - </struct> - - <struct name="LightState" since="5.0"> - <param name="id" type="LightName" mandatory="true"> - <description>The name of a light or a group of lights. </description> - </param> - <param name="status" type="LightStatus" mandatory="true"/> - <param name="density" type="Float" minvalue="0" maxvalue="1" mandatory="false" /> - <param name="color" type="RGBColor" mandatory="false" /> - </struct> - - <struct name="LightControlData" since="5.0"> - <param name="lightState" type="LightState" mandatory="true" minsize="1" maxsize="100" array="true"> - <description>An array of LightNames and their current or desired status. No change to the status of the LightNames that are not listed in the array.</description> - </param> - </struct> - - <enum name="DisplayMode" since="5.0"> - <element name="DAY"/> - <element name="NIGHT"/> - <element name="AUTO"/> - </enum> - - <enum name="DistanceUnit" since="5.0"> - <element name="MILES"/> - <element name="KILOMETERS"/> - </enum> - - <struct name="HMISettingsControlData" since="5.0"> - <description>Corresponds to "HMI_SETTINGS" ModuleType</description> - <param name="displayMode" type="DisplayMode" mandatory="false"></param> - <param name="temperatureUnit" type="TemperatureUnit" mandatory="false"></param> - <param name="distanceUnit" type="DistanceUnit" mandatory="false"></param> - </struct> - - <struct name="HMISettingsControlCapabilities" since="5.0"> - <param name="moduleName" type="String" maxlength="100" mandatory="true"> - <description> - The short friendly name of the hmi setting module. - It should not be used to identify a module by mobile application. - </description> - </param> - <param name="moduleInfo" type="ModuleInfo" mandatory="false" since="6.0"> - <description>Information about a RC module, including its id. </description> - </param> - <param name="distanceUnitAvailable" type="Boolean" mandatory="false"> - <description>Availability of the control of distance unit. </description> - </param> - <param name="temperatureUnitAvailable" type="Boolean" mandatory="false"> - <description>Availability of the control of temperature unit. </description> - </param> - <param name="displayModeUnitAvailable" type="Boolean" mandatory="false"> - <description>Availability of the control of HMI display mode. </description> - </param> - </struct> - - <struct name="ModuleData" since="4.5"> - <description>The moduleType indicates which type of data should be changed and identifies which data object exists in this struct. For example, if the moduleType is CLIMATE then a "climateControlData" should exist</description> - <param name="moduleType" type="ModuleType" mandatory="true"> - </param> - <param name="moduleId" type="String" maxlength="100" mandatory="false" since="6.0"> - <description>Id of a module, published by System Capability. </description> - </param> - <param name="radioControlData" type="RadioControlData" mandatory="false"> - </param> - <param name="climateControlData" type="ClimateControlData" mandatory="false"> - </param> - <param name="seatControlData" type="SeatControlData" mandatory="false" since="5.0"> - </param> - <param name="audioControlData" type="AudioControlData" mandatory="false" since="5.0"> - </param> - <param name="lightControlData" type="LightControlData" mandatory="false" since="5.0"> - </param> - <param name="hmiSettingsControlData" type="HMISettingsControlData" mandatory="false" since="5.0"> - </param> - </struct> - - <struct name="RemoteControlCapabilities" since="4.5"> - <param name="climateControlCapabilities" type="ClimateControlCapabilities" mandatory="false" minsize="1" maxsize="100" array="true"> - <description>If included, the platform supports RC climate controls. For this baseline version, maxsize=1. i.e. only one climate control module is supported.</description> - </param> - <param name="radioControlCapabilities" type="RadioControlCapabilities" mandatory="false" minsize="1" maxsize="100" array="true"> - <description>If included, the platform supports RC radio controls.For this baseline version, maxsize=1. i.e. only one radio control module is supported.</description> - </param> - <param name="buttonCapabilities" type="ButtonCapabilities" mandatory="false" minsize="1" maxsize="100" array="true"> - <description>If included, the platform supports RC button controls with the included button names.</description> - </param> - <param name="audioControlCapabilities" type="AudioControlCapabilities" mandatory="false" minsize="1" maxsize="100" array="true" since="5.0"> - <description>If included, the platform supports audio controls.</description> - </param> - <param name="hmiSettingsControlCapabilities" type="HMISettingsControlCapabilities" mandatory="false" since="5.0"> - <description>If included, the platform supports hmi setting controls.</description> - </param> - <param name="lightControlCapabilities" type="LightControlCapabilities" mandatory="false" since="5.0"> - <description>If included, the platform supports light controls.</description> - </param> - <param name="seatControlCapabilities" type="SeatControlCapabilities" mandatory="false" minsize="1" maxsize="100" array="true" since="5.0"> - <description>If included, the platform supports seat controls.</description> - </param> - </struct> - - <!-- End of RC --> - - <enum name="MetadataType" since="4.5"> - <element name="mediaTitle"> - <description>The data in this field contains the title of the currently playing audio track.</description> - </element> - <element name="mediaArtist"> - <description>The data in this field contains the artist or creator of the currently playing audio track.</description> - </element> - <element name="mediaAlbum"> - <description>The data in this field contains the album title of the currently playing audio track.</description> - </element> - <element name="mediaYear"> - <description>The data in this field contains the creation year of the currently playing audio track.</description> - </element> - <element name="mediaGenre"> - <description>The data in this field contains the genre of the currently playing audio track.</description> - </element> - <element name="mediaStation"> - <description>The data in this field contains the name of the current source for the media.</description> - </element> - <element name="rating"> - <description>The data in this field is a rating.</description> - </element> - <element name="currentTemperature"> - <description>The data in this field is the current temperature.</description> - </element> - <element name="maximumTemperature"> - <description>The data in this field is the maximum temperature for the day.</description> - </element> - <element name="minimumTemperature"> - <description>The data in this field is the minimum temperature for the day.</description> - </element> - <element name="weatherTerm"> - <description>The data in this field describes the current weather (ex. cloudy, clear, etc.).</description> - </element> - <element name="humidity"> - <description>The data in this field describes the current humidity value.</description> - </element> - </enum> - - <struct name="MetadataTags" since="4.5"> - <param name="mainField1" type="MetadataType" minsize="0" maxsize="5" array="true" mandatory="false"> - <description>The type of data contained in the "mainField1" text field.</description> - </param> - <param name="mainField2" type="MetadataType" minsize="0" maxsize="5" array="true" mandatory="false"> - <description>The type of data contained in the "mainField2" text field.</description> - </param> - <param name="mainField3" type="MetadataType" minsize="0" maxsize="5" array="true" mandatory="false"> - <description>The type of data contained in the "mainField3" text field.</description> - </param> - <param name="mainField4" type="MetadataType" minsize="0" maxsize="5" array="true" mandatory="false"> - <description>The type of data contained in the "mainField4" text field.</description> - </param> - </struct> - - <struct name="Rectangle" since="4.5"> - <param name="x" type="Float" mandatory="true"> - <description>The upper left X-coordinate of the rectangle</description> - </param> - <param name="y" type="Float" mandatory="true"> - <description>The upper left Y-coordinate of the rectangle</description> - </param> - <param name="width" type="Float" mandatory="true"> - <description>The width of the rectangle</description> - </param> - <param name="height" type="Float" mandatory="true"> - <description>The height of the rectangle</description> - </param> - </struct> - - <struct name="HapticRect" since="4.5"> - <description>Defines haptic data for each user control object for video streaming application</description> - <param name="id" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="true"> - <description>A user control spatial identifier</description> - </param> - <param name="rect" type="Rectangle" mandatory="true"> - <description>The position of the haptic rectangle to be highlighted. The center of this rectangle will be "touched" when a press occurs.</description> - </param> - </struct> - - <!-- App Services --> - - <enum name="AppServiceType" platform="documentation" since="5.1"> - <element name="MEDIA"/> - <element name="WEATHER"/> - <element name="NAVIGATION"/> - </enum> - - <struct name="MediaServiceManifest" since="5.1"> - </struct> - - <enum name="MediaType" since="5.1"> - <element name="MUSIC"/> - <element name="PODCAST"/> - <element name="AUDIOBOOK"/> - <element name="OTHER"/> - </enum> - - <struct name="MediaServiceData" since="5.1"> - <description>This data is related to what a media service should provide</description> - - <param name="mediaType" type="MediaType" mandatory="false"> - <description>The type of the currently playing or paused track.</description> - </param> - - <param name="mediaTitle" type="String" mandatory="false"> - <description> - Music: The name of the current track - Podcast: The name of the current episode - Audiobook: The name of the current chapter - </description> - </param> - - <param name="mediaArtist" type="String" mandatory="false"> - <description> - Music: The name of the current album artist - Podcast: The provider of the podcast (hosts, network, company) - Audiobook: The book author's name - </description> - </param> - - <param name="mediaAlbum" type="String" mandatory="false"> - <description> - Music: The name of the current album - Podcast: The name of the current podcast show - Audiobook: The name of the current book - </description> - </param> - - <param name="playlistName" type="String" mandatory="false"> - <description> - Music: The name of the playlist or radio station, if the user is playing from a playlist, otherwise, Null - Podcast: The name of the playlist, if the user is playing from a playlist, otherwise, Null - Audiobook: Likely not applicable, possibly a collection or "playlist" of books - </description> - </param> - - <param name="isExplicit" type="Boolean" mandatory="false"> - <description> Whether or not the content currently playing (e.g. the track, episode, or book) contains explicit content</description> - </param> - - <param name="trackPlaybackProgress" type="Integer" mandatory="false"> - <description> - Music: The current progress of the track in seconds - Podcast: The current progress of the episode in seconds - Audiobook: The current progress of the current segment (e.g. the chapter) in seconds - </description> - </param> - - <param name="trackPlaybackDuration" type="Integer" mandatory="false"> - <description> - Music: The total duration of the track in seconds - Podcast: The total duration of the episode in seconds - Audiobook: The total duration of the current segment (e.g. the chapter) in seconds - </description> - </param> - - <param name="queuePlaybackProgress" type="Integer" mandatory="false"> - <description> - Music: The current progress of the playback queue in seconds - Podcast: The current progress of the playback queue in seconds - Audiobook: The current progress of the playback queue (e.g. the book) in seconds - </description> - </param> - - <param name="queuePlaybackDuration" type="Integer" mandatory="false"> - <description> - Music: The total duration of the playback queue in seconds - Podcast: The total duration of the playback queue in seconds - Audiobook: The total duration of the playback queue (e.g. the book) in seconds - </description> - </param> - - <param name="queueCurrentTrackNumber" type="Integer" mandatory="false"> - <description> - Music: The current number (1 based) of the track in the playback queue - Podcast: The current number (1 based) of the episode in the playback queue - Audiobook: The current number (1 based) of the episode in the playback queue (e.g. the chapter number in the book) - </description> - </param> - - <param name="queueTotalTrackCount" type="Integer" mandatory="false"> - <description> - Music: The total number of tracks in the playback queue - Podcast: The total number of episodes in the playback queue - Audiobook: The total number of sections in the playback queue (e.g. the number of chapters in the book) - </description> - </param> - <param name="mediaImage" type="Image" mandatory="false" since="6.0"> - <description> - Music: The album art of the current track - Podcast: The podcast or chapter artwork of the current podcast episode - Audiobook: The book or chapter artwork of the current audiobook - </description> - </param> - </struct> - - <struct name="WeatherServiceManifest" since="5.1"> - <param name="currentForecastSupported" type="Boolean" mandatory="false"/> - <param name="maxMultidayForecastAmount" type="Integer" mandatory="false"/> - <param name="maxHourlyForecastAmount" type="Integer" mandatory="false"/> - <param name="maxMinutelyForecastAmount" type="Integer" mandatory="false"/> - <param name="weatherForLocationSupported" type="Boolean" mandatory="false"/> - </struct> - - <struct name="WeatherAlert" since="5.1"> - <param name="title" type="String" mandatory="false"/> - <param name="summary" type="String" mandatory="false"/> - <param name="expires" type="DateTime" mandatory="false"/> - <param name="regions" type="String" array="true" minsize="1" maxsize="99" mandatory="false"/> - <param name="severity" type="String" mandatory="false"/> - <param name="timeIssued" type="DateTime" mandatory="false"/> - </struct> - - <struct name="WeatherData" since="5.1"> - <param name="currentTemperature" type="Temperature" mandatory="false"/> - <param name="temperatureHigh" type="Temperature" mandatory="false"/> - <param name="temperatureLow" type="Temperature" mandatory="false"/> - <param name="apparentTemperature" type="Temperature" mandatory="false"/> - <param name="apparentTemperatureHigh" type="Temperature" mandatory="false"/> - <param name="apparentTemperatureLow" type="Temperature" mandatory="false"/> - - <param name="weatherSummary" type="String" mandatory="false"/> - <param name="time" type="DateTime" mandatory="false"/> - <param name="humidity" type="Float" minvalue="0" maxvalue="1" mandatory="false"> - <description> 0 to 1, percentage humidity </description> - </param> - <param name="cloudCover" type="Float" minvalue="0" maxvalue="1" mandatory="false"> - <description> 0 to 1, percentage cloud cover </description> - </param> - <param name="moonPhase" type="Float" minvalue="0" maxvalue="1" mandatory="false"> - <description> 0 to 1, percentage of the moon seen, e.g. 0 = no moon, 0.25 = quarter moon </description> - </param> - - <param name="windBearing" type="Integer" mandatory="false"> - <description> In degrees, true north at 0 degrees </description> - </param> - <param name="windGust" type="Float" mandatory="false"> - <description> km/hr </description> - </param> - <param name="windSpeed" type="Float" mandatory="false"> - <description> km/hr </description> - </param> - - <param name="nearestStormBearing" type="Integer" mandatory="false"> - <description> In degrees, true north at 0 degrees </description> - </param> - <param name="nearestStormDistance" type="Integer" mandatory="false"> - <description> In km </description> - </param> - <param name="precipAccumulation" type="Float" mandatory="false"> - <description> cm </description> - </param> - <param name="precipIntensity" type="Float" mandatory="false"> - <description> cm of water per hour </description> - </param> - <param name="precipProbability" type="Float" minvalue="0" maxvalue="1" mandatory="false"> - <description> 0 to 1, percentage chance </description> - </param> - <param name="precipType" type="String" mandatory="false"> - <description> e.g. "rain", "snow", "sleet", "hail" </description> - </param> - <param name="visibility" type="Float" mandatory="false"> - <description> In km </description> - </param> - - <param name="weatherIcon" type="Image" mandatory="false"/> - </struct> - - <struct name="WeatherServiceData" since="5.1"> - <description> This data is related to what a weather service would provide</description> - <param name="location" type="LocationDetails" mandatory="true"/> - <param name="currentForecast" type="WeatherData" mandatory="false"/> - <param name="minuteForecast" type="WeatherData" array="true" minsize="15" maxsize="60" mandatory="false"/> - <param name="hourlyForecast" type="WeatherData" array="true" minsize="1" maxsize="96" mandatory="false"/> - <param name="multidayForecast" type="WeatherData" array="true" minsize="1" maxsize="30" mandatory="false"/> - <param name="alerts" type="WeatherAlert" array="true" minsize="1" maxsize="10" mandatory="false"> - <description> This array should be ordered with the first object being the current day</description> - </param> - </struct> - - <struct name="NavigationServiceManifest" since="5.1"> - <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" since="5.1"> - <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" since="5.1"> - <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" since="5.1"> - <element name="LEFT"/> - <element name="RIGHT"/> - </enum> - - <struct name="NavigationInstruction" since="5.1"> - <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, bearing=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" since="5.1"> - <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> - - <param name="serviceName" type="String" mandatory="false"> - <description> Unique name of this service </description> - </param> - - <param name="serviceType" type="String" mandatory="true"> - <description> The type of service that is to be offered by this app. See AppServiceType for known enum equivalent types. Parameter is a string to allow for new service types to be used by apps on older versions of SDL Core. </description> - </param> - - <param name="serviceIcon" type="Image" mandatory="false"> - <description> The icon to be associated with this service. Most likely the same as the appIcon.</description> - </param> - - <param name="allowAppConsumers" type="Boolean" mandatory="false" defvalue="false"> - <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="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> - - <param name="handledRPCs" type="Integer" array="true" mandatory="false"> - <description> This field contains the Function IDs for the RPCs that this service intends to handle correctly. This means the service will provide meaningful responses. </description> - </param> - - <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"> - <description> This is the record of an app service publisher that the module has. It should contain the most up to date information including the service's active state</description> - - <param name="serviceID" type="String" mandatory="true"> - <description> A unique ID tied to this specific service record. The ID is supplied by the module that services publish themselves. </description> - </param> - - <param name="serviceManifest" type="AppServiceManifest" mandatory="true"> - <description> Manifest for the service that this record is for.</description> - </param> - - <param name="servicePublished" type="Boolean" mandatory="true"> - <description> If true, the service is published and available. If false, the service has likely just been unpublished, and should be considered unavailable.</description> - </param> - - <param name="serviceActive" type="Boolean" mandatory="true"> - <description> If true, the service is the active primary service of the supplied service type. It will receive all potential RPCs that are passed through to that service type. If false, it is not the primary service of the supplied type. See servicePublished for its availability. </description> - </param> - </struct> - - <struct name="AppServiceData" since="5.1"> - <description> Contains all the current data of the app service. The serviceType will link to which of the service data objects are included in this object (e.g. if the service type is MEDIA, the mediaServiceData param should be included).</description> - - <param name="serviceType" type="String" mandatory="true"> - <description>The type of service that is to be offered by this app. See AppServiceType for known enum equivalent types. Parameter is a string to allow for new service types to be used by apps on older versions of SDL Core.</description> - </param> - <param name="serviceID" type="String" mandatory="true"/> - - <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"> - <element name="PUBLISHED"> - <description> The service has just been published with the module and once activated to the primary service of its type, it will be ready for possible consumption.</description> - </element> - <element name="REMOVED"> - <description> The service has just been unpublished with the module and is no longer accessible</description> - </element> - <element name="ACTIVATED"> - <description> The service is activated as the primary service of this type. All requests dealing with this service type will be handled by this service.</description> - </element> - <element name="DEACTIVATED"> - <description> The service has been deactivated as the primary service of its type</description> - </element> - <element name="MANIFEST_UPDATE"> - <description> The service has updated its manifest. This could imply updated capabilities</description> - </element> - </enum> - - <struct name="AppServiceCapability" since="5.1"> - <param name="updateReason" type="ServiceUpdateReason" mandatory="false"> - <description> Only included in OnSystemCapabilityUpdated. Update reason for service record.</description> - </param> - <param name="updatedAppServiceRecord" type="AppServiceRecord" mandatory="true"> - <description>Service record for a specific app service provider</description> - </param> - </struct> - - <struct name="AppServicesCapabilities" since="5.1"> - <description>Capabilities of app services including what service types are supported and the current state of services.</description> - <param name="appServices" type="AppServiceCapability" array="true" mandatory="false"> - <description>An array of currently available services. If this is an update to the capability the affected services will include an update reason in that item</description> - </param> - </struct> - - <!-- End App Services --> - - <struct name="SystemCapability" since="4.5"> - <description>The systemCapabilityType identifies which data object exists in this struct. For example, if the SystemCapability Type is NAVIGATION then a "navigationCapability" should exist</description> - <param name="systemCapabilityType" type="SystemCapabilityType" mandatory="true"> - <description>Used as a descriptor of what data to expect in this struct. The corresponding param to this enum should be included and the only other param included.</description> - </param> - <param name="navigationCapability" type="NavigationCapability" mandatory="false"> - <description>Describes extended capabilities for onboard navigation system </description> - </param> - <param name="phoneCapability" type="PhoneCapability" mandatory="false"> - <description>Describes extended capabilities of the module's phone feature</description> - </param> - <param name="videoStreamingCapability" type="VideoStreamingCapability" mandatory="false"> - <description>Describes extended capabilities of the module's phone feature</description> - </param> - <param name="remoteControlCapability" type="RemoteControlCapabilities" mandatory="false"> - <description>Describes extended capabilities of the module's phone feature</description> - </param> - <param name="appServicesCapabilities" type="AppServicesCapabilities" mandatory="false" since="5.1"> - <description>An array of currently available services. If this is an update to the capability the affected services will include an update reason in that item</description> - </param> - <param name="seatLocationCapability" type="SeatLocationCapability" mandatory="false" since="6.0"> - <description>Contains information about the locations of each seat</description> - </param> - <param name="displayCapabilities" type="DisplayCapability" array="true" minsize="1" maxsize="1000" mandatory="false" since="6.0"/> - </struct> - - <!-- Requests/Responses --> - - <function name="RegisterAppInterface" functionID="RegisterAppInterfaceID" messagetype="request" since="1.0"> - <description> - Establishes an interface with a mobile application. - Before registerAppInterface no other commands will be accepted/executed. - </description> - - <param name="syncMsgVersion" type="SyncMsgVersion" mandatory="true" since="1.0"> - <description>See SyncMsgVersion</description> - </param> - - <param name="appName" type="String" maxlength="100" mandatory="true" since="1.0"> - <description> - The mobile application name, e.g. "My SDL App". - Needs to be unique over all applications from the same device. - May not be empty. - May not start with a new line character. - May not interfere with any name or synonym of previously registered applications from the same device and any predefined blacklist of words (global commands) - Additional applications with the same name from the same device will be rejected. - Only characters from char set [@TODO: Create char set (character/hex value) for each ACM and refer to] are supported. - </description> - </param> - - <param name="ttsName" type="TTSChunk" minsize="1" maxsize="100" array="true" mandatory="false" since="2.0"> - <description> - TTS string for VR recognition of the mobile application name, e.g. "My S D L App". - Meant to overcome any failing on speech engine in properly pronouncing / understanding app name. - Needs to be unique over all applications from the same device. - May not be empty. - May not start with a new line character. - Only characters from char set [@TODO: Create char set (character/hex value) for each ACM and refer to] are supported. - </description> - </param> - - <param name="ngnMediaScreenAppName" type="String" maxlength="100" mandatory="false" since="1.0"> - <description> - Provides an abbreviated version of the app name (if needed), that will be displayed on the NGN media screen. - If not provided, the appName is used instead (and will be truncated if too long) - Only characters from char set [@TODO: Create char set (character/hex value) for each ACM and refer to] are supported. - </description> - </param> - - <param name="vrSynonyms" type="String" maxlength="40" minsize="1" maxsize="100" array="true" mandatory="false" since="1.0"> - <description> - Defines an additional voice recognition command. - May not interfere with any app name of previously registered applications from the same device and any predefined blacklist of words (global commands) - Only characters from char set [@TODO: Create char set (character/hex value) for each ACM and refer to] are supported. - </description> - </param> - - <param name="isMediaApplication" type="Boolean" mandatory="true" since="1.0"> - <description> - Indicates if the application is a media or a non-media application. - Only media applications will be able to stream audio to the module that is audible outside of the BT media source. - </description> - </param> - <param name="languageDesired" type="Language" mandatory="true" since="1.0"> - <description> - See Language - Current app's expected VR+TTS language - If there is a mismatch with the module, the app will be able to change this registration with changeRegistration prior to app being brought into focus. - </description> - </param> - <param name="hmiDisplayLanguageDesired" type="Language" mandatory="true" since="2.0"> - <description> - See Language - Current app's expected display language - If there is a mismatch with the module, the app will be able to change this registration with changeRegistration prior to app being brought into focus. - </description> - </param> - - <param name="appHMIType" type="AppHMIType" minsize="1" maxsize="100" array="true" mandatory="false" since="2.0"> - <description> - See AppHMIType - List of all applicable app HMI types stating which HMI classifications to be given to the app. - </description> - </param> - - <param name="hashID" type="String" maxlength="100" mandatory="false" since="3.0"> - <description> - ID used to uniquely identify current state of all app data that can persist through connection cycles (e.g. ignition cycles). - This registered data (commands, submenus, choice sets, etc.) can be reestablished without needing to explicitly reregister each piece. - If omitted, then the previous state of an app's commands, etc. will not be restored. - When sending hashID, all RegisterAppInterface parameters should still be provided (e.g. ttsName, etc.). - </description> - </param> - <param name="deviceInfo" type="DeviceInfo" mandatory="false" since="3.0"> - <description> - See DeviceInfo. - </description> - </param> - <param name="appID" type="String" maxlength="100" mandatory="true" since="2.0"> - <description>ID used to validate app with policy table entries</description> - </param> - <param name="fullAppID" type="String" maxlength="100" mandatory="false" since="5.0"> - <description>ID used to validate app with policy table entries</description> - </param> - <param name="appInfo" type="AppInfo" mandatory="false" since="2.0"> - <description> - See AppInfo. - </description> - </param> - <param name="dayColorScheme" type="TemplateColorScheme" mandatory="false" since="5.0"/> - <param name="nightColorScheme" type="TemplateColorScheme" mandatory="false" since="5.0"/> - </function> - - <function name="RegisterAppInterface" functionID="RegisterAppInterfaceID" messagetype="response" since="1.0"> - <description>The response to registerAppInterface</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="INVALID_DATA"/> - <element name="OUT_OF_MEMORY"/> - <element name="TOO_MANY_PENDING_REQUESTS"/> - <element name="GENERIC_ERROR"/> - <element name="DUPLICATE_NAME"/> - <element name="TOO_MANY_APPLICATIONS"/> - <element name="APPLICATION_REGISTERED_ALREADY"/> - <element name="UNSUPPORTED_VERSION"/> - <element name="WRONG_LANGUAGE"/> - <element name="DISALLOWED"/> - <element name="WARNINGS"/> - <element name="RESUME_FAILED"/> - </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="syncMsgVersion" type="SyncMsgVersion" mandatory="false"> - <description>See SyncMsgVersion</description> - </param> - - <param name="language" type="Language" mandatory="false"> - <description>The currently active VR+TTS language on the module. See "Language" for options.</description> - </param> - - <param name="hmiDisplayLanguage" type="Language" mandatory="false" since="2.0"> - <description>The currently active display language on the module. See "Language" for options.</description> - </param> - - <param name="displayCapabilities" type="DisplayCapabilities" mandatory="false" deprecated="true" since="6.0"> - <description> - See DisplayCapabilities. This parameter is deprecated and replaced by SystemCapability using DISPLAYS. - </description> - <history> - <param name="displayCapabilities" type="DisplayCapabilities" mandatory="false" since="2.0" until="6.0"/> - </history> - </param> - - <param name="buttonCapabilities" type="ButtonCapabilities" minsize="1" maxsize="100" array="true" mandatory="false" deprecated="true" since="6.0"> - <description> - See ButtonCapabilities. This parameter is deprecated and replaced by SystemCapability using DISPLAYS. - </description> - <history> - <param name="buttonCapabilities" type="ButtonCapabilities" minsize="1" maxsize="100" array="true" mandatory="false" since="2.0" until="6.0"/> - </history> - </param> - - <param name="softButtonCapabilities" type="SoftButtonCapabilities" minsize="1" maxsize="100" array="true" mandatory="false" deprecated="true" since="6.0"> - <description> - If returned, the platform supports on-screen SoftButtons; see SoftButtonCapabilities. - This parameter is deprecated and replaced by SystemCapability using DISPLAYS. - </description> - <history> - <param name="softButtonCapabilities" type="SoftButtonCapabilities" minsize="1" maxsize="100" array="true" mandatory="false" since="2.0" until="6.0"/> - </history> - </param> - - <param name="presetBankCapabilities" type="PresetBankCapabilities" mandatory="false" deprecated="true" since="6.0"> - <description> - If returned, the platform supports custom on-screen Presets; see PresetBankCapabilities. - This parameter is deprecated and replaced by SystemCapability using DISPLAYS. - </description> - <history> - <param name="presetBankCapabilities" type="PresetBankCapabilities" mandatory="false" since="2.0" until="6.0"/> - </history> - </param> - - <param name="hmiZoneCapabilities" type="HmiZoneCapabilities" minsize="1" maxsize="100" array="true" mandatory="false" since="1.0"> - <description>See HmiZoneCapabilities</description> - </param> - <param name="speechCapabilities" type="SpeechCapabilities" minsize="1" maxsize="100" array="true" mandatory="false" since="1.0"> - <description>See SpeechCapabilities</description> - </param> - - <param name="prerecordedSpeech" type="PrerecordedSpeech" minsize="1" maxsize="100" array="true" mandatory="false" since="3.0"> - <description>See PrerecordedSpeech</description> - </param> - - <param name="vrCapabilities" type="VrCapabilities" minsize="1" maxsize="100" array="true" mandatory="false" since="1.0"> - <description>See VrCapabilities</description> - </param> - - <param name="audioPassThruCapabilities" type="AudioPassThruCapabilities" minsize="1" maxsize="100" array="true" mandatory="false" since="2.0"> - <description>See AudioPassThruCapability</description> - </param> - - <param name="pcmStreamCapabilities" type="AudioPassThruCapabilities" array="false" mandatory="false" since="4.1"> - <description>See AudioPassThruCapability</description> - </param> - - <param name="vehicleType" type="VehicleType" mandatory="false" since="2.0"> - <description>Specifies the vehicle's type. See VehicleType.</description> - </param> - - <param name="supportedDiagModes" type="Integer" minvalue="0" maxvalue="255" array="true" minsize="1" maxsize="100" mandatory="false" since="3.0"> - <description> - Specifies the white-list of supported diagnostic modes (0x00-0xFF) capable for DiagnosticMessage requests. - If a mode outside this list is requested, it will be rejected. - </description> - </param> - - <param name="hmiCapabilities" type="HMICapabilities" mandatory="false" since="3.0"> - <description>Specifies the HMI's capabilities. See HMICapabilities.</description> - </param> - - <param name="sdlVersion" type="String" maxlength="100" mandatory="false" platform="documentation" since="3.0"> - <description>The SmartDeviceLink version.</description> - </param> - - <param name="systemSoftwareVersion" type="String" maxlength="100" mandatory="false" platform="documentation" since="3.0"> - <description>The software version of the system that implements the SmartDeviceLink core.</description> - </param> - - <param name="iconResumed" type="Boolean" mandatory="false" since="5.0"> - <description> - Existence of apps icon at system. If true, apps icon - was resumed at system. If false, apps icon is not resumed at system - </description> - </param> - </function> - - <function name="UnregisterAppInterface" functionID="UnregisterAppInterfaceID" messagetype="request" since="1.0"> - <description> - Closes an interface from a mobile application. - After unregisterAppInterface, no commands other than registerAppInterface will be accepted/executed. - Will fail, if no registerAppInterface was completed successfully before. - </description> - </function> - - <function name="UnregisterAppInterface" functionID="UnregisterAppInterfaceID" messagetype="response" since="1.0"> - - <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"/> - </param> - - <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> - <description>Provides additional human readable info regarding the result.</description> - </param> - - </function> - - <function name="CreateWindow" functionID="CreateWindowID" messagetype="request" since="6.0"> - <description> - Create a new window on the display with the specified window type. - </description> - <param name="windowID" type="Integer" mandatory="true"> - <description> - A unique ID to identify the window. The value of '0' will always be the default main window on the main display and should not be used in this context as it will already be created for the app. See PredefinedWindows enum. Creating a window with an ID that is already in use will be rejected with `INVALID_ID`. - </description> - </param> - - <param name="windowName" type="String" maxlength="100" mandatory="true"> - <description> - The window name to be used by the HMI. The name of the pre-created default window will match the app name. - Multiple apps can share the same window name except for the default main window. - Creating a window with a name which is already in use by the app will result in `DUPLICATE_NAME`. - </description> - </param> - - <param name="type" type="WindowType" mandatory="true"> - <description>The type of the window to be created. Main window or widget.</description> - </param> - - <param name="associatedServiceType" type="String" mandatory="false"> - <description> - Allows an app to create a widget related to a specific service type. - As an example if a `MEDIA` app becomes active, this app becomes audible and is allowed to play audio. Actions such as skip or play/pause will be - directed to this active media app. In case of widgets, the system can provide a single "media" widget which will act as a placeholder for the active media app. - - It is only allowed to have one window per service type. This means that a media app can only have a single MEDIA widget. Still the app can create widgets omitting this parameter. Those widgets would be available as app specific widgets that are permanently included in the HMI. - - This parameter is related to widgets only. The default main window, which is pre-created during app registration, will be created based on the HMI types specified in the app registration request. - </description> - </param> - <param name="duplicateUpdatesFromWindowID" type="Integer" mandatory="false"> - <description> - Optional parameter. Specify whether the content sent to an existing window - should be duplicated to the created window. - If there isn't a window with the ID, the request will be rejected with `INVALID_DATA`. - </description> - </param> - </function> - - <function name="CreateWindow" functionID="CreateWindowID" messagetype="response" since="6.0"> - <param name="success" type="Boolean" platform="documentation" mandatory="true"> - <description> true if successful; false, if failed.</description> - </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="resultCode" type="Result" platform="documentation" mandatory="true"> - <description>See Result</description> - <element name="SUCCESS"/> - <element name="REJECTED"/> - <element name="INVALID_DATA"/> - <element name="INVALID_ID"/> - <element name="DUPLICATE_NAME"/> - <element name="DISALLOWED"/> - <element name="OUT_OF_MEMORY"/> - <element name="TOO_MANY_PENDING_REQUESTS"/> - <element name="APPLICATION_NOT_REGISTERED"/> - <element name="GENERIC_ERROR"/> - </param> - </function> - - <function name="DeleteWindow" functionID="DeleteWindowID" messagetype="request" since="6.0"> - <description> - Deletes previously created window of the SDL application. - </description> - <param name="windowID" type="Integer" mandatory="true"> - <description> - A unique ID to identify the window. The value of '0' will always be the default main window on the main display and cannot be deleted. - See PredefinedWindows enum. - </description> - </param> - </function> - - <function name="DeleteWindow" functionID="DeleteWindowID" messagetype="response" since="6.0"> - <param name="success" type="Boolean" platform="documentation" mandatory="true"> - <description> true if successful; false, if failed.</description> - </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="resultCode" type="Result" platform="documentation" mandatory="true"> - <description>See Result</description> - <element name="SUCCESS"/> - <element name="REJECTED"/> - <element name="INVALID_DATA"/> - <element name="INVALID_ID"/> - <element name="DUPLICATE_NAME"/> - <element name="DISALLOWED"/> - <element name="OUT_OF_MEMORY"/> - <element name="TOO_MANY_PENDING_REQUESTS"/> - <element name="APPLICATION_NOT_REGISTERED"/> - <element name="GENERIC_ERROR"/> - </param> - </function> - - <function name="SetGlobalProperties" functionID="SetGlobalPropertiesID" messagetype="request" since="1.0"> - <description>Allows setting global properties.</description> - <param name="userLocation" type="SeatLocation" mandatory="false" since="6.0"> - <description>Location of the user's seat. Default is driver's seat location if it is not set yet.</description> - </param> - <param name="helpPrompt" type="TTSChunk" minsize="1" maxsize="100" array="true" mandatory="false" since="1.0"> - <description> - The help prompt. - An array of text chunks of type TTSChunk. See TTSChunk. - The array must have at least one item. - </description> - </param> - - <param name="timeoutPrompt" type="TTSChunk" minsize="1" maxsize="100" array="true" mandatory="false" since="1.0"> - <description> - Help text for a wait timeout. - An array of text chunks of type TTSChunk. See TTSChunk. - The array must have at least one item. - </description> - </param> - - <param name="vrHelpTitle" type="String" maxlength="500" mandatory="false" since="2.0"> - <description> - VR Help Title text. - If omitted on supported displays, the default module help title shall be used. - If omitted and one or more vrHelp items are provided, the request will be rejected. - </description> - </param> - - <param name="vrHelp" type="VrHelpItem" minsize="1" maxsize="100" array="true" mandatory="false" since="2.0"> - <description> - VR Help Items. - If omitted on supported displays, the default SmartDeviceLink VR help / What Can I Say? screen shall be used. - If the list of VR Help Items contains nonsequential positions (e.g. [1,2,4]), the RPC shall be rejected. - If omitted and a vrHelpTitle is provided, the request will be rejected. - </description> - </param> - <param name="menuTitle" maxlength="500" type="String" mandatory="false" since="3.0"> - <description>Optional text to label an app menu button (for certain touchscreen platforms).</description> - </param> - - <param name="menuIcon" type="Image" mandatory="false" since="3.0"> - <description>Optional icon to draw on an app menu button (for certain touchscreen platforms).</description> - </param> - - <param name="keyboardProperties" type="KeyboardProperties" mandatory="false" since="3.0"> - <description>On-screen keyboard configuration (if available).</description> - </param> - - <param name="menuLayout" type="MenuLayout" mandatory="false" since="6.0"> - <description>Sets the layout of the main menu screen. If this is sent while a menu is already on-screen, the head unit will change the display to the new layout type.</description> - </param> - </function> - - <function name="SetGlobalProperties" functionID="SetGlobalPropertiesID" messagetype="response" since="1.0"> - - <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="UNSUPPORTED_RESOURCE"/> - <element name="WARNINGS"/> - <element name="DISALLOWED"/> - </param> - - <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> - <description>Provides additional human readable info regarding the result.</description> - </param> - - </function> - - <function name="ResetGlobalProperties" functionID="ResetGlobalPropertiesID" messagetype="request" since="1.0"> - <description>Allows resetting global properties.</description> - - <param name="properties" type="GlobalProperty" minsize="1" maxsize="100" array="true" mandatory="true"> - <description>Contains the names of all global properties (like timeoutPrompt) that should be unset. Resetting means, that they have the same value as at start up (default)</description> - </param> - </function> - - <function name="ResetGlobalProperties" functionID="ResetGlobalPropertiesID" messagetype="response" since="1.0"> - - <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="DISALLOWED"/> - </param> - - <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> - <description>Provides additional human readable info regarding the result.</description> - </param> - </function> - - <function name="AddCommand" functionID="AddCommandID" messagetype="request" since="1.0"> - <description> - Adds a command to the in application menu. - Either menuParams or vrCommands must be provided. - </description> - - <param name="cmdID" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="true"> - <description>unique ID of the command to add.</description> - </param> - - <param name="menuParams" type="MenuParams" mandatory="false"> - <description>Optional sub value containing menu parameters</description> - </param> - - <param name="vrCommands" type="String" minsize="1" maxsize="100" maxlength="99" array="true" mandatory="false"> - <description> - An array of strings to be used as VR synonyms for this command. - If this array is provided, it may not be empty. - </description> - </param> - - <param name="cmdIcon" type="Image" mandatory="false" since="2.0"> - <description> - Image struct determining whether static or dynamic icon. - If omitted on supported displays, no (or the default if applicable) icon shall be displayed. - </description> - </param> - - </function> - - <function name="AddCommand" functionID="AddCommandID" messagetype="response" since="1.0"> - - <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="INVALID_ID"/> - <element name="DUPLICATE_NAME"/> - <element name="UNSUPPORTED_RESOURCE"/> - <element name="DISALLOWED"/> - <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> - - </function> - - <function name="DeleteCommand" functionID="DeleteCommandID" messagetype="request" since="1.0"> - <description>Deletes all commands from the in-application menu with the specified command id.</description> - - <param name="cmdID" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="true"> - <description>ID of the command(s) to delete.</description> - </param> - - </function> - - <function name="DeleteCommand" functionID="DeleteCommandID" messagetype="response" since="1.0"> - <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="INVALID_ID"/> - <element name="IN_USE"/> - </param> - - <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> - <description>Provides additional human readable info regarding the result.</description> - </param> - - </function> - - <function name="AddSubMenu" functionID="AddSubMenuID" messagetype="request" since="1.0"> - <description>Adds a sub menu to the in-application menu.</description> - - <param name="menuID" type="Integer" minvalue="1" maxvalue="2000000000" mandatory="true"> - <description>unique ID of the sub menu to add.</description> - </param> - - <param name="position" type="Integer" minvalue="0" maxvalue="1000" defvalue="1000" mandatory="false"> - <description> - Position within the items that are are at top level of the in application menu. - 0 will insert at the front. - 1 will insert at the second position. - If position is greater or equal than the number of items on top level, the sub menu will be appended to the end. - Position of any submenu will always be located before the return and exit options - If this param was omitted the entry will be added at the end. - </description> - </param> - - <param name="menuName" maxlength="500" type="String" mandatory="true"> - <description>Text to show in the menu for this sub menu.</description> - </param> - - <param name="menuIcon" type="Image" mandatory="false" since="5.0"> - <description>The image field for AddSubMenu</description> - </param> - - <param name="menuLayout" type="MenuLayout" mandatory="false" since="6.0"> - <description>Sets the layout of the submenu screen.</description> - </param> - </function> - - <function name="AddSubMenu" functionID="AddSubMenuID" messagetype="response" since="1.0"> - <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="INVALID_ID"/> - <element name="DUPLICATE_NAME"/> - </param> - - <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> - <description>Provides additional human readable info regarding the result.</description> - </param> - </function> - - <function name="DeleteSubMenu" functionID="DeleteSubMenuID" messagetype="request" since="1.0"> - <description>Deletes a submenu from the in-application menu.</description> - - <param name="menuID" type="Integer" minvalue="1" maxvalue="2000000000" mandatory="true"> - <description>The "menuID" of the submenu to delete. (See addSubMenu.menuID)</description> - </param> - - </function> - - <function name="DeleteSubMenu" functionID="DeleteSubMenuID" messagetype="response" since="1.0"> - - <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="INVALID_ID"/> - <element name="IN_USE"/> - </param> - - <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> - <description>Provides additional human readable info regarding the result.</description> - </param> - - </function> - - <function name="ShowAppMenu" functionID="ShowAppMenuID" messagetype="request" since="6.0"> - <description>Shows the built in menu view</description> - - <param name="menuID" type="Integer" minvalue="1" maxvalue="2000000000" mandatory="false"> - <description> - If omitted the HMI opens the app's menu. - If set to a sub-menu ID the HMI opens the corresponding sub-menu previously added using `AddSubMenu`. - </description> - </param> - - </function> - - <function name="ShowAppMenu" functionID="ShowAppMenuID" messagetype="response" since="6.0"> - - <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="INVALID_ID"/> - <element name="IN_USE"/> - </param> - - <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> - <description>Provides additional human readable info regarding the result.</description> - </param> - - </function> - - <function name="CreateInteractionChoiceSet" functionID="CreateInteractionChoiceSetID" messagetype="request" since="1.0"> - <description>creates interaction choice set to be used later by performInteraction</description> - - <param name="interactionChoiceSetID" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="true"> - <description>Unique ID used for this interaction choice set.</description> - </param> - - <param name="choiceSet" type="Choice" minsize="1" maxsize="100" array="true" mandatory="true"/> - </function> - - <function name="CreateInteractionChoiceSet" functionID="CreateInteractionChoiceSetID" messagetype="response" since="1.0"> - <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="INVALID_ID"/> - <element name="DUPLICATE_NAME"/> - <element name="UNSUPPORTED_RESOURCE"/> - </param> - - <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> - <description>Provides additional human readable info regarding the result.</description> - </param> - </function> - - <function name="PerformInteraction" functionID="PerformInteractionID" messagetype="request" since="1.0"> - <description>Triggers an interaction (e.g. "Permit GPS?" - Yes, no, Always Allow).</description> - - <param name="initialText" type="String" maxlength="500" mandatory="true"> - <description> - Text to be displayed first. - </description> - </param> - - <param name="initialPrompt" type="TTSChunk" minsize="1" maxsize="100" array="true" mandatory="false"> - <description> - This is the initial prompt spoken to the user at the start of an interaction. - An array of text chunks of type TTSChunk. See TTSChunk. - The array must have at least one item. - </description> - </param> - - <param name="interactionMode" type="InteractionMode" mandatory="true"> - <description>See InteractionMode.</description> - </param> - - <param name="interactionChoiceSetIDList" type="Integer" minsize="0" maxsize="100" minvalue="0" maxvalue="2000000000" array="true" mandatory="true"> - <description>List of interaction choice set IDs to use with an interaction.</description> - </param> - - <param name="helpPrompt" type="TTSChunk" minsize="1" maxsize="100" array="true" mandatory="false"> - <description> - Help text. This is the spoken string when a user speaks "help" when the interaction is occurring. - An array of text chunks of type TTSChunk. See TTSChunk. - The array must have at least one item. - </description> - </param> - - <param name="timeoutPrompt" type="TTSChunk" minsize="1" maxsize="100" array="true" mandatory="false"> - <description> - Timeout text. This text is spoken when a VR interaction times out. - An array of text chunks of type TTSChunk. See TTSChunk. - The array must have at least one item. - </description> - </param> - - <param name="timeout" type="Integer" minvalue="5000" maxvalue="100000" defvalue="10000" mandatory="false"> - <description> - Timeout in milliseconds. - If omitted a standard value of 10000 milliseconds is used. - Applies only to the menu portion of the interaction. The VR timeout will be handled by the platform. - </description> - </param> - - <param name="vrHelp" type="VrHelpItem" minsize="1" maxsize="100" array="true" mandatory="false" since="2.0"> - <description> - Ability to send suggested VR Help Items to display on-screen during Perform Interaction. - If omitted on supported displays, the default generated list of suggested choices shall be displayed. - </description> - </param> - - <param name="interactionLayout" type="LayoutMode" mandatory="false" since="3.0"> - <description>See LayoutMode.</description> - </param> - - <param name="cancelID" type="Integer" mandatory="false" since="6.0"> - <description> - An ID for this specific PerformInteraction to allow cancellation through the `CancelInteraction` RPC. - </description> - </param> - - </function> - - <function name="PerformInteraction" functionID="PerformInteractionID" messagetype="response" since="1.0"> - <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="INVALID_ID"/> - <element name="DUPLICATE_NAME"/> - <element name="TIMED_OUT"/> - <element name="ABORTED"/> - <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="choiceID" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="false"> - <description> - ID of the choice that was selected in response to PerformInteraction. - Only is valid if general result is "success:true". - </description> - </param> - - <param name="manualTextEntry" type="String" maxlength="500" mandatory="false" since="3.0"> - <description> - Manually entered text selection, e.g. through keyboard - Can be returned in lieu of choiceID, depending on trigger source - </description> - </param> - - <param name="triggerSource" type="TriggerSource" mandatory="false"> - <description> - See TriggerSource - Only is valid if resultCode is SUCCESS. - </description> - </param> - - </function> - - <function name="DeleteInteractionChoiceSet" functionID="DeleteInteractionChoiceSetID" messagetype="request" since="1.0"> - <description>Deletes interaction choice set that has been created with "CreateInteractionChoiceSet".</description> - <description>The interaction may only be deleted when not currently in use by a "performInteraction".</description> - - <param name="interactionChoiceSetID" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="true"> - <description>ID of the interaction choice set to delete.</description> - </param> - </function> - - <function name="DeleteInteractionChoiceSet" functionID="DeleteInteractionChoiceSetID" messagetype="response" since="1.0"> - <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="INVALID_ID"/> - <element name="IN_USE"/> - </param> - - <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> - <description>Provides additional human readable info regarding the result.</description> - </param> - </function> - - <function name="Alert" functionID="AlertID" messagetype="request" since="1.0"> - <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"> - <description>The first line of the alert text field</description> - </param> - - <param name="alertText2" type="String" maxlength="500" mandatory="false"> - <description>The second line of the alert text field</description> - </param> - - <param name="alertText3" type="String" maxlength="500" mandatory="false" since="2.0"> - <description>The optional third line of the alert text field</description> - </param> - - <param name="ttsChunks" type="TTSChunk" minsize="1" maxsize="100" array="true" mandatory="false"> - <description> - An array of text chunks of type TTSChunk. See TTSChunk. - The array must have at least one item. - </description> - </param> - - <param name="duration" type="Integer" minvalue="3000" maxvalue="10000" defvalue="5000" mandatory="false"> - <description> - Timeout in milliseconds. - Typical timeouts are 3-5 seconds. - If omitted, timeout is set to 5s. - </description> - </param> - - <param name="playTone" type="Boolean" mandatory="false"> - <description> - Defines if tone should be played. Tone is played before TTS. - If omitted, no tone is played. - </description> - </param> - - <param name="progressIndicator" type="Boolean" mandatory="false" since="3.0"> - <description> - If supported on the given platform, the alert GUI will include some sort of animation indicating that loading of a feature is progressing. e.g. a spinning wheel or hourglass, etc. - </description> - </param> - - <param name="softButtons" type="SoftButton" minsize="0" maxsize="4" array="true" mandatory="false" since="2.0"> - <description> - App defined SoftButtons. - If omitted on supported displays, the displayed alert shall not have any SoftButtons. - </description> - </param> - - <param name="alertIcon" type="Image" mandatory="false" since="6.0"> - <description> - Image struct determining whether static or dynamic icon. - If omitted on supported displays, no (or the default if applicable) icon should be displayed. - </description> - </param> - - <param name="cancelID" type="Integer" mandatory="false" since="6.0"> - <description> - An ID for this specific alert to allow cancellation through the `CancelInteraction` RPC. - </description> - </param> - - </function> - - <function name="Alert" functionID="AlertID" messagetype="response" since="1.0"> - - <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" since="2.0"> - <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="Show" functionID="ShowID" messagetype="request" since="1.0"> - <description>Updates the persistent display. Supported fields depend on display capabilities.</description> - - <param name="mainField1" type="String" minlength="0" maxlength="500" mandatory="false" since="1.0"> - <description> - The text that should be displayed in a single or upper display line. - If this text is not set, the text of mainField1 stays unchanged. - If this text is empty "", the field will be cleared. - </description> - </param> - - <param name="mainField2" type="String" minlength="0" maxlength="500" mandatory="false" since="1.0"> - <description> - The text that should be displayed on the second display line. - If this text is not set, the text of mainField2 stays unchanged. - If this text is empty "", the field will be cleared. - </description> - </param> - - <param name="mainField3" type="String" minlength="0" maxlength="500" mandatory="false" since="2.0"> - <description> - The text that should be displayed on the second "page" first display line. - If this text is not set, the text of mainField3 stays unchanged. - If this text is empty "", the field will be cleared. - </description> - </param> - - <param name="mainField4" type="String" minlength="0" maxlength="500" mandatory="false" since="2.0"> - <description> - The text that should be displayed on the second "page" second display line. - If this text is not set, the text of mainField4 stays unchanged. - If this text is empty "", the field will be cleared. - </description> - </param> - - <param name="alignment" type="TextAlignment" mandatory="false" since="1.0"> - <description> - Specifies how mainField1 and mainField2 texts should be aligned on display. - If omitted, texts will be centered. - </description> - </param> - - <param name="statusBar" type="String" minlength="0" maxlength="500" mandatory="false" since="1.0"> - <description>Requires investigation regarding the nav display capabilities. Potentially lower lowerStatusBar, upperStatusBar, titleBar, etc.</description> - </param> - - <param name="mediaClock" type="String" minlength="0" maxlength="500" mandatory="false" since="1.0"> - <description> - Text value for MediaClock field. Has to be properly formatted by Mobile App according to the module's capabilities. - If this text is set, any automatic media clock updates previously set with SetMediaClockTimer will be stopped. - </description> - </param> - - <param name="mediaTrack" type="String" minlength="0" maxlength="500" mandatory="false" since="1.0"> - <description> - The text that should be displayed in the track field. - If this text is not set, the text of mediaTrack stays unchanged. - If this text is empty "", the field will be cleared. - </description> - </param> - - <param name="graphic" type="Image" mandatory="false" since="3.0"> - <description> - Image struct determining whether static or dynamic image to display in app. - If omitted on supported displays, the displayed graphic shall not change. - </description> - </param> - - <param name="secondaryGraphic" type="Image" mandatory="false" since="3.0"> - <description> - Image struct determining whether static or dynamic secondary image to display in app. - If omitted on supported displays, the displayed secondary graphic shall not change. - </description> - </param> - - <param name="softButtons" type="SoftButton" minsize="0" maxsize="8" array="true" mandatory="false" since="2.0"> - <description> - App defined SoftButtons. - If omitted on supported displays, the currently displayed SoftButton values will not change. - </description> - </param> - - <param name="customPresets" type="String" maxlength="500" minsize="0" maxsize="10" array="true" mandatory="false" since="3.0"> - <description> - App labeled on-screen presets (i.e. on-screen media presets or dynamic search suggestions). - If omitted on supported displays, the presets will be shown as not defined. - </description> - </param> - - <param name="metadataTags" type="MetadataTags" mandatory="false" since="4.5"> - <description> - App defined metadata information. See MetadataStruct. Uses mainField1, mainField2, mainField3, mainField4. - If omitted on supported displays, the currently set metadata tags will not change. - If any text field contains no tags or the none tag, the metadata tag for that textfield should be removed. - </description> - </param> - - <param name="templateTitle" type="String" minlength="0" maxlength="100" mandatory="false" since="6.0"> - <description> - The title of the new template that will be displayed. - How this will be displayed is dependent on the OEM design and implementation of the template. - </description> - </param> - <param name="windowID" type="Integer" mandatory="false" since="6.0" > - <description> - This is the unique ID assigned to the window that this RPC is intended. If this param is not included, - it will be assumed that this request is specifically for the main window on the main display. - See PredefinedWindows enum. - </description> - </param> - - <param name="templateConfiguration" type="TemplateConfiguration" mandatory="false" since="6.0"> - <description> - Used to set an alternate template layout to a window. - </description> - </param> - </function> - - <function name="Show" functionID="ShowID" messagetype="response" since="1.0"> - - <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="DISALLOWED"/> - <element name="UNSUPPORTED_RESOURCE"/> - <element name="WARNINGS"/> - <element name="ABORTED"/> - </param> - - <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> - <description>Provides additional human readable info regarding the result.</description> - </param> - </function> - - <function name="Speak" functionID="SpeakID" messagetype="request" since="1.0"> - <description>Speaks a text.</description> - - <param name="ttsChunks" type="TTSChunk" minsize="1" maxsize="100" array="true" mandatory="true"> - <description> - An array of text chunks of type TTSChunk. See TTSChunk. - The array must have at least one item. - </description> - </param> - - </function> - - <function name="Speak" functionID="SpeakID" messagetype="response" since="1.0"> - - <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="DISALLOWED"/> - <element name="ABORTED"/> - <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> - - </function> - - <function name="SetMediaClockTimer" functionID="SetMediaClockTimerID" messagetype="request" since="1.0"> - <description>Sets the initial media clock value and automatic update method.</description> - - <param name="startTime" type="StartTime" mandatory="false"> - <description> - See StartTime. - startTime must be provided for "COUNTUP" and "COUNTDOWN". - startTime will be ignored for "RESUME", and "CLEAR" - startTime can be sent for "PAUSE", in which case it will update the paused startTime - </description> - </param> - - <param name="endTime" type="StartTime" mandatory="false" since="3.0"> - <description> - See StartTime. - endTime can be provided for "COUNTUP" and "COUNTDOWN"; to be used to calculate any visual progress bar (if not provided, this feature is ignored) - If endTime is greater then startTime for COUNTDOWN or less than startTime for COUNTUP, then the request will return an INVALID_DATA. - endTime will be ignored for "RESUME", and "CLEAR" - endTime can be sent for "PAUSE", in which case it will update the paused endTime - </description> - </param> - - <param name="updateMode" type="UpdateMode" mandatory="true"> - <description> - Enumeration to control the media clock. - In case of pause, resume, or clear, the start time value is ignored and shall be left out. For resume, the time continues with the same value as it was when paused. - </description> - </param> - - <param name="audioStreamingIndicator" type="AudioStreamingIndicator" mandatory="false" since="5.0"> - <description> - Enumeration for the indicator icon on a play/pause button. see AudioStreamingIndicator. - </description> - </param> - </function> - - <function name="SetMediaClockTimer" functionID="SetMediaClockTimerID" messagetype="response" since="1.0"> - <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="IGNORED"/> - </param> - - <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> - <description>Provides additional human readable info regarding the result.</description> - </param> - </function> - - <function name="PerformAudioPassThru" functionID="PerformAudioPassThruID" messagetype="request" since="2.0"> - <description>Starts audio pass thru session </description> - <param name="initialPrompt" type="TTSChunk" minsize="1" maxsize="100" array="true" mandatory="false"> - <description> - The module will speak this prompt before opening the audio pass thru session. - An array of text chunks of type TTSChunk. See TTSChunk. - The array must have at least one item. - If omitted, then no initial prompt is spoken. - </description> - </param> - <param name="audioPassThruDisplayText1" type="String" mandatory="false" maxlength="500"> - <description>First line of text displayed during audio capture.</description> - </param> - <param name="audioPassThruDisplayText2" type="String" mandatory="false" maxlength="500"> - <description>Second line of text displayed during audio capture.</description> - </param> - <param name="samplingRate" type="SamplingRate" mandatory="true"> - <description> This value shall be allowed at 8 kHz or 16 or 22 or 44 kHz.</description> - </param> - <param name="maxDuration" type="Integer" minvalue="1" maxvalue="1000000" mandatory="true"> - <description>The maximum duration of audio recording in milliseconds. </description> - </param> - <param name="bitsPerSample" type="BitsPerSample" mandatory="true"> - <description>Specifies the quality the audio is recorded. Currently 8 bit or 16 bit.</description> - </param> - <param name="audioType" type="AudioType" mandatory="true"> - <description>Specifies the type of audio data being requested.</description> - </param> - <param name="muteAudio" type="Boolean" mandatory="false"> - <description> - Defines if the current audio source should be muted during the APT session. If not, the audio source will play without interruption. - If omitted, the value is set to true. - </description> - </param> - </function> - - <function name="PerformAudioPassThru" functionID="PerformAudioPassThruID" messagetype="response" since="2.0"> - <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="DISALLOWED"/> - <element name="REJECTED"/> - <element name="ABORTED"/> - <element name="RETRY"/> - <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> - </function> - - <function name="EndAudioPassThru" functionID="EndAudioPassThruID" messagetype="request" since="2.0"> - <description>When this request is invoked, the audio capture stops.</description> - </function> - - <function name="EndAudioPassThru" functionID="EndAudioPassThruID" messagetype="response" since="2.0"> - <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="DISALLOWED"/> - </param> - - <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> - <description>Provides additional human readable info regarding the result.</description> - </param> - </function> - - <function name="SubscribeButton" functionID="SubscribeButtonID" messagetype="request" since="1.0"> - <description> - Subscribes to built-in HMI buttons. - The application will be notified by the OnButtonEvent and OnButtonPress. - To unsubscribe the notifications, use unsubscribeButton. - </description> - - <param name="buttonName" type="ButtonName" mandatory="true"> - <description>Name of the button to subscribe.</description> - </param> - </function> - - <function name="SubscribeButton" functionID="SubscribeButtonID" messagetype="response" since="1.0"> - <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="UNSUPPORTED_RESOURCE" /> - <element name="IGNORED" /> - <element name="REJECTED"/> - </param> - - <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> - <description>Provides additional human readable info regarding the result.</description> - </param> - </function> - - <function name="UnsubscribeButton" functionID="UnsubscribeButtonID" messagetype="request" since="1.0"> - <description>Unsubscribes from built-in HMI buttons.</description> - - <param name="buttonName" type="ButtonName" mandatory="true"> - <description>Name of the button to unsubscribe.</description> - </param> - </function> - - <function name="UnsubscribeButton" functionID="UnsubscribeButtonID" messagetype="response" since="1.0"> - <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="UNSUPPORTED_RESOURCE" /> - <element name="IGNORED" /> - <element name="REJECTED"/> - </param> - - <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> - <description>Provides additional human readable info regarding the result.</description> - </param> - </function> - - <function name="SubscribeVehicleData" functionID="SubscribeVehicleDataID" messagetype="request" since="2.0"> - <description> - Subscribes for specific published data items. - The data will be only sent if it has changed. - The application will be notified by the onVehicleData notification whenever new data is available. - To unsubscribe the notifications, use unsubscribe with the same subscriptionType. - </description> - - <param name="gps" type="Boolean" mandatory="false"> - <description>See GPSData</description> - </param> - <param name="speed" type="Boolean" mandatory="false"> - <description>The vehicle speed in kilometers per hour</description> - </param> - <param name="rpm" type="Boolean" mandatory="false"> - <description>The number of revolutions per minute of the engine</description> - </param> - <param name="fuelLevel" type="Boolean" mandatory="false"> - <description>The fuel level in the tank (percentage)</description> - </param> - <param name="fuelLevel_State" type="Boolean" mandatory="false"> - <description>The fuel level state</description> - </param> - <param name="instantFuelConsumption" type="Boolean" mandatory="false"> - <description>The instantaneous fuel consumption in microlitres</description> - </param> - <param name="fuelRange" type="Boolean" mandatory="false" since="5.0"> - <description>The estimate range in KM the vehicle can travel based on fuel level and consumption</description> - </param> - <param name="externalTemperature" type="Boolean" mandatory="false"> - <description>The external temperature in degrees celsius</description> - </param> - <param name="turnSignal" type="Boolean" mandatory="false" since="5.0"> - <description>See TurnSignal</description> - </param> - <param name="prndl" type="Boolean" mandatory="false"> - <description>See PRNDL</description> - </param> - <param name="tirePressure" type="Boolean" mandatory="false"> - <description>See TireStatus</description> - </param> - <param name="odometer" type="Boolean" mandatory="false"> - <description>Odometer in km</description> - </param> - <param name="beltStatus" type="Boolean" mandatory="false"> - <description>The status of the seat belts</description> - </param> - <param name="bodyInformation" type="Boolean" mandatory="false"> - <description>The body information including power modes</description> - </param> - <param name="deviceStatus" type="Boolean" mandatory="false"> - <description>The device status including signal and battery strength</description> - </param> - <param name="driverBraking" type="Boolean" mandatory="false"> - <description>The status of the brake pedal</description> - </param> - <param name="wiperStatus" type="Boolean" mandatory="false"> - <description>The status of the wipers</description> - </param> - <param name="headLampStatus" type="Boolean" mandatory="false"> - <description>Status of the head lamps</description> - </param> - <param name="engineTorque" type="Boolean" mandatory="false"> - <description>Torque value for engine (in Nm) on non-diesel variants</description> - </param> - <param name="accPedalPosition" type="Boolean" mandatory="false"> - <description>Accelerator pedal position (percentage depressed)</description> - </param> - <param name="steeringWheelAngle" type="Boolean" mandatory="false"> - <description>Current angle of the steering wheel (in deg)</description> - </param> - <param name="engineOilLife" type="Boolean" mandatory="false" since="5.0"> - <description>The estimated percentage of remaining oil life of the engine.</description> - </param> - <param name="electronicParkBrakeStatus" type="Boolean" mandatory="false" since="5.0"> - <description>The status of the park brake as provided by Electric Park Brake (EPB) system.</description> - </param> - <param name="cloudAppVehicleID" type="Boolean" mandatory="false" since="5.1"> - <description>Parameter used by cloud apps to identify a head unit</description> - </param> - <param name="eCallInfo" type="Boolean" mandatory="false"> - <description>Emergency Call notification and confirmation data</description> - </param> - <param name="airbagStatus" type="Boolean" mandatory="false"> - <description>The status of the air bags</description> - </param> - <param name="emergencyEvent" type="Boolean" mandatory="false"> - <description>Information related to an emergency event (and if it occurred)</description> - </param> - <param name="clusterModeStatus" type="Boolean" mandatory="false"> - <description>The status modes of the cluster</description> - </param> - <param name="myKey" type="Boolean" mandatory="false"> - <description>Information related to the MyKey feature</description> - </param> - - - </function> - - <function name="SubscribeVehicleData" functionID="SubscribeVehicleDataID" messagetype="response" since="2.0"> - <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="WARNINGS"/> - <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="IGNORED" /> - <element name="DISALLOWED"/> - <element name="USER_DISALLOWED"/> - </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="gps" type="VehicleDataResult" mandatory="false"> - <description>See GPSData</description> - </param> - <param name="speed" type="VehicleDataResult" mandatory="false"> - <description>The vehicle speed in kilometers per hour</description> - </param> - <param name="rpm" type="VehicleDataResult" mandatory="false"> - <description>The number of revolutions per minute of the engine</description> - </param> - <param name="fuelLevel" type="VehicleDataResult" mandatory="false"> - <description>The fuel level in the tank (percentage)</description> - </param> - <param name="fuelLevel_State" type="VehicleDataResult" mandatory="false"> - <description>The fuel level state</description> - </param> - <param name="instantFuelConsumption" type="VehicleDataResult" mandatory="false"> - <description>The instantaneous fuel consumption in microlitres</description> - </param> - <param name="fuelRange" type="VehicleDataResult" mandatory="false" since="5.0"> - <description>The estimate range in KM the vehicle can travel based on fuel level and consumption</description> - </param> - <param name="externalTemperature" type="VehicleDataResult" mandatory="false"> - <description>The external temperature in degrees celsius.</description> - </param> - <param name="turnSignal" type="VehicleDataResult" mandatory="false" since="5.0"> - <description>See TurnSignal</description> - </param> - <param name="prndl" type="VehicleDataResult" mandatory="false"> - <description>See PRNDL</description> - </param> - <param name="tirePressure" type="VehicleDataResult" mandatory="false"> - <description>See TireStatus</description> - </param> - <param name="odometer" type="VehicleDataResult" mandatory="false"> - <description>Odometer in km</description> - </param> - <param name="beltStatus" type="VehicleDataResult" mandatory="false"> - <description>The status of the seat belts</description> - </param> - <param name="bodyInformation" type="VehicleDataResult" mandatory="false"> - <description>The body information including power modes</description> - </param> - <param name="deviceStatus" type="VehicleDataResult" mandatory="false"> - <description>The device status including signal and battery strength</description> - </param> - <param name="driverBraking" type="VehicleDataResult" mandatory="false"> - <description>The status of the brake pedal</description> - </param> - <param name="wiperStatus" type="VehicleDataResult" mandatory="false"> - <description>The status of the wipers</description> - </param> - <param name="headLampStatus" type="VehicleDataResult" mandatory="false"> - <description>Status of the head lamps</description> - </param> - <param name="engineTorque" type="VehicleDataResult" mandatory="false"> - <description>Torque value for engine (in Nm) on non-diesel variants</description> - </param> - <param name="accPedalPosition" type="VehicleDataResult" mandatory="false"> - <description>Accelerator pedal position (percentage depressed)</description> - </param> - <param name="steeringWheelAngle" type="VehicleDataResult" mandatory="false"> - <description>Current angle of the steering wheel (in deg)</description> - </param> - <param name="engineOilLife" type="VehicleDataResult" mandatory="false" since="5.0"> - <description>The estimated percentage of remaining oil life of the engine.</description> - </param> - <param name="electronicParkBrakeStatus" type="VehicleDataResult" mandatory="false" since="5.0"> - <description>The status of the park brake as provided by Electric Park Brake (EPB) system.</description> - </param> - <param name="cloudAppVehicleID" type="VehicleDataResult" mandatory="false" since="5.1"> - <description>Parameter used by cloud apps to identify a head unit</description> - </param> - <param name="eCallInfo" type="VehicleDataResult" mandatory="false"> - <description>Emergency Call notification and confirmation data</description> - </param> - <param name="airbagStatus" type="VehicleDataResult" mandatory="false"> - <description>The status of the air bags</description> - </param> - <param name="emergencyEvent" type="VehicleDataResult" mandatory="false"> - <description>Information related to an emergency event (and if it occurred)</description> - </param> - <param name="clusterModes" type="VehicleDataResult" mandatory="false"> - <description>The status modes of the cluster</description> - </param> - <param name="myKey" type="VehicleDataResult" mandatory="false"> - <description>Information related to the MyKey feature</description> - </param> - </function> - - <function name="UnsubscribeVehicleData" functionID="UnsubscribeVehicleDataID" messagetype="request" since="2.0"> - <description>This function is used to unsubscribe the notifications from the subscribeVehicleData function.</description> - - <param name="gps" type="Boolean" mandatory="false"> - <description>See GPSData</description> - </param> - <param name="speed" type="Boolean" mandatory="false"> - <description>The vehicle speed in kilometers per hour</description> - </param> - <param name="rpm" type="Boolean" mandatory="false"> - <description>The number of revolutions per minute of the engine</description> - </param> - <param name="fuelLevel" type="Boolean" mandatory="false"> - <description>The fuel level in the tank (percentage)</description> - </param> - <param name="fuelLevel_State" type="Boolean" mandatory="false"> - <description>The fuel level state</description> - </param> - <param name="instantFuelConsumption" type="Boolean" mandatory="false"> - <description>The instantaneous fuel consumption in microlitres</description> - </param> - <param name="fuelRange" type="Boolean" mandatory="false" since="5.0"> - <description>The estimate range in KM the vehicle can travel based on fuel level and consumption</description> - </param> - <param name="externalTemperature" type="Boolean" mandatory="false"> - <description>The external temperature in degrees celsius.</description> - </param> - <param name="turnSignal" type="Boolean" mandatory="false" since="5.0"> - <description>See TurnSignal</description> - </param> - <param name="prndl" type="Boolean" mandatory="false"> - <description>See PRNDL</description> - </param> - <param name="tirePressure" type="Boolean" mandatory="false"> - <description>See TireStatus</description> - </param> - <param name="odometer" type="Boolean" mandatory="false"> - <description>Odometer in km</description> - </param> - <param name="beltStatus" type="Boolean" mandatory="false"> - <description>The status of the seat belts</description> - </param> - <param name="bodyInformation" type="Boolean" mandatory="false"> - <description>The body information including power modes</description> - </param> - <param name="deviceStatus" type="Boolean" mandatory="false"> - <description>The device status including signal and battery strength</description> - </param> - <param name="driverBraking" type="Boolean" mandatory="false"> - <description>The status of the brake pedal</description> - </param> - <param name="wiperStatus" type="Boolean" mandatory="false"> - <description>The status of the wipers</description> - </param> - <param name="headLampStatus" type="Boolean" mandatory="false"> - <description>Status of the head lamps</description> - </param> - <param name="engineTorque" type="Boolean" mandatory="false"> - <description>Torque value for engine (in Nm) on non-diesel variants</description> - </param> - <param name="accPedalPosition" type="Boolean" mandatory="false"> - <description>Accelerator pedal position (percentage depressed)</description> - </param> - <param name="steeringWheelAngle" type="Boolean" mandatory="false"> - <description>Current angle of the steering wheel (in deg)</description> - </param> - <param name="engineOilLife" type="Boolean" mandatory="false" since="5.0"> - <description>The estimated percentage of remaining oil life of the engine.</description> - </param> - <param name="electronicParkBrakeStatus" type="Boolean" mandatory="false" since="5.0"> - <description>The status of the park brake as provided by Electric Park Brake (EPB) system.</description> - </param> - <param name="cloudAppVehicleID" type="Boolean" mandatory="false" since="5.1"> - <description>Parameter used by cloud apps to identify a head unit</description> - </param> - <param name="eCallInfo" type="Boolean" mandatory="false"> - <description>Emergency Call notification and confirmation data</description> - </param> - <param name="airbagStatus" type="Boolean" mandatory="false"> - <description>The status of the air bags</description> - </param> - <param name="emergencyEvent" type="Boolean" mandatory="false"> - <description>Information related to an emergency event (and if it occurred)</description> - </param> - <param name="clusterModeStatus" type="Boolean" mandatory="false"> - <description>The status modes of the cluster</description> - </param> - <param name="myKey" type="Boolean" mandatory="false"> - <description>Information related to the MyKey feature</description> - </param> - </function> - - <function name="UnsubscribeVehicleData" functionID="UnsubscribeVehicleDataID" messagetype="response" since="2.0"> - <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="WARNINGS"/> - <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="IGNORED" /> - <element name="DISALLOWED"/> - </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="gps" type="VehicleDataResult" mandatory="false"> - <description>See GPSData</description> - </param> - <param name="speed" type="VehicleDataResult" mandatory="false"> - <description>The vehicle speed in kilometers per hour</description> - </param> - <param name="rpm" type="VehicleDataResult" mandatory="false"> - <description>The number of revolutions per minute of the engine</description> - </param> - <param name="fuelLevel" type="VehicleDataResult" mandatory="false"> - <description>The fuel level in the tank (percentage)</description> - </param> - <param name="fuelLevel_State" type="VehicleDataResult" mandatory="false"> - <description>The fuel level state</description> - </param> - <param name="instantFuelConsumption" type="VehicleDataResult" mandatory="false"> - <description>The instantaneous fuel consumption in microlitres</description> - </param> - <param name="fuelRange" type="VehicleDataResult" mandatory="false" since="5.0"> - <description>The estimate range in KM the vehicle can travel based on fuel level and consumption</description> - </param> - <param name="externalTemperature" type="VehicleDataResult" mandatory="false"> - <description>The external temperature in degrees celsius</description> - </param> - <param name="turnSignal" type="VehicleDataResult" mandatory="false" since="5.0"> - <description>See TurnSignal</description> - </param> - <param name="prndl" type="VehicleDataResult" mandatory="false"> - <description>See PRNDL</description> - </param> - <param name="tirePressure" type="VehicleDataResult" mandatory="false"> - <description>See TireStatus</description> - </param> - <param name="odometer" type="VehicleDataResult" mandatory="false"> - <description>Odometer in km</description> - </param> - <param name="beltStatus" type="VehicleDataResult" mandatory="false"> - <description>The status of the seat belts</description> - </param> - <param name="bodyInformation" type="VehicleDataResult" mandatory="false"> - <description>The body information including power modes</description> - </param> - <param name="deviceStatus" type="VehicleDataResult" mandatory="false"> - <description>The device status including signal and battery strength</description> - </param> - <param name="driverBraking" type="VehicleDataResult" mandatory="false"> - <description>The status of the brake pedal</description> - </param> - <param name="wiperStatus" type="VehicleDataResult" mandatory="false"> - <description>The status of the wipers</description> - </param> - <param name="headLampStatus" type="VehicleDataResult" mandatory="false"> - <description>Status of the head lamps</description> - </param> - <param name="engineTorque" type="VehicleDataResult" mandatory="false"> - <description>Torque value for engine (in Nm) on non-diesel variants</description> - </param> - <param name="accPedalPosition" type="VehicleDataResult" mandatory="false"> - <description>Accelerator pedal position (percentage depressed)</description> - </param> - <param name="steeringWheelAngle" type="VehicleDataResult" mandatory="false"> - <description>Current angle of the steering wheel (in deg)</description> - </param> - <param name="engineOilLife" type="VehicleDataResult" mandatory="false" since="5.0"> - <description>The estimated percentage of remaining oil life of the engine.</description> - </param> - <param name="electronicParkBrakeStatus" type="VehicleDataResult" mandatory="false" since="5.0"> - <description>The status of the park brake as provided by Electric Park Brake (EPB) system.</description> - </param> - <param name="cloudAppVehicleID" type="VehicleDataResult" mandatory="false" since="5.1"> - <description>Parameter used by cloud apps to identify a head unit</description> - </param> - <param name="eCallInfo" type="VehicleDataResult" mandatory="false"> - <description>Emergency Call notification and confirmation data</description> - </param> - <param name="airbagStatus" type="VehicleDataResult" mandatory="false" > - <description>The status of the air bags</description> - </param> - <param name="emergencyEvent" type="VehicleDataResult" mandatory="false"> - <description>Information related to an emergency event (and if it occurred)</description> - </param> - <param name="clusterModes" type="VehicleDataResult" mandatory="false"> - <description>The status modes of the cluster</description> - </param> - <param name="myKey" type="VehicleDataResult" mandatory="false"> - <description>Information related to the MyKey feature</description> - </param> - </function> - - <function name="GetVehicleData" functionID="GetVehicleDataID" messagetype="request" since="2.0"> - <description>Non periodic vehicle data read request.</description> - - <param name="gps" type="Boolean" mandatory="false"> - <description>See GPSData</description> - </param> - <param name="speed" type="Boolean" mandatory="false"> - <description>The vehicle speed in kilometers per hour</description> - </param> - <param name="rpm" type="Boolean" mandatory="false"> - <description>The number of revolutions per minute of the engine</description> - </param> - <param name="fuelLevel" type="Boolean" mandatory="false"> - <description>The fuel level in the tank (percentage)</description> - </param> - <param name="fuelLevel_State" type="Boolean" mandatory="false"> - <description>The fuel level state</description> - </param> - <param name="instantFuelConsumption" type="Boolean" mandatory="false"> - <description>The instantaneous fuel consumption in microlitres</description> - </param> - <param name="fuelRange" type="Boolean" mandatory="false" since="5.0"> - <description>The estimate range in KM the vehicle can travel based on fuel level and consumption</description> - </param> - <param name="externalTemperature" type="Boolean" mandatory="false"> - <description>The external temperature in degrees celsius</description> - </param> - <param name="turnSignal" type="Boolean" mandatory="false" since="5.0"> - <description>See TurnSignal</description> - </param> - <param name="vin" type="Boolean" mandatory="false"> - <description>Vehicle identification number</description> - </param> - <param name="prndl" type="Boolean" mandatory="false"> - <description>See PRNDL</description> - </param> - <param name="tirePressure" type="Boolean" mandatory="false"> - <description>See TireStatus</description> - </param> - <param name="odometer" type="Boolean" mandatory="false"> - <description>Odometer in km</description> - </param> - <param name="beltStatus" type="Boolean" mandatory="false"> - <description>The status of the seat belts</description> - </param> - <param name="bodyInformation" type="Boolean" mandatory="false"> - <description>The body information including ignition status and internal temp</description> - </param> - <param name="deviceStatus" type="Boolean" mandatory="false"> - <description>The device status including signal and battery strength</description> - </param> - <param name="driverBraking" type="Boolean" mandatory="false"> - <description>The status of the brake pedal</description> - </param> - <param name="wiperStatus" type="Boolean" mandatory="false"> - <description>The status of the wipers</description> - </param> - <param name="headLampStatus" type="Boolean" mandatory="false"> - <description>Status of the head lamps</description> - </param> - <param name="engineTorque" type="Boolean" mandatory="false"> - <description>Torque value for engine (in Nm) on non-diesel variants</description> - </param> - <param name="accPedalPosition" type="Boolean" mandatory="false"> - <description>Accelerator pedal position (percentage depressed)</description> - </param> - <param name="steeringWheelAngle" type="Boolean" mandatory="false"> - <description>Current angle of the steering wheel (in deg)</description> - </param> - <param name="engineOilLife" type="Boolean" mandatory="false" since="5.0"> - <description>The estimated percentage of remaining oil life of the engine.</description> - </param> - <param name="electronicParkBrakeStatus" type="Boolean" mandatory="false" since="5.0"> - <description>The status of the park brake as provided by Electric Park Brake (EPB) system.</description> - </param> - <param name="cloudAppVehicleID" type="Boolean" mandatory="false" since="5.1"> - <description>Parameter used by cloud apps to identify a head unit</description> - </param> - <param name="eCallInfo" type="Boolean" mandatory="false"> - <description>Emergency Call notification and confirmation data</description> - </param> - <param name="airbagStatus" type="Boolean" mandatory="false"> - <description>The status of the air bags</description> - </param> - <param name="emergencyEvent" type="Boolean" mandatory="false"> - <description>Information related to an emergency event (and if it occurred)</description> - </param> - <param name="clusterModeStatus" type="Boolean" mandatory="false"> - <description>The status modes of the cluster</description> - </param> - <param name="myKey" type="Boolean" mandatory="false"> - <description>Information related to the MyKey feature</description> - </param> - </function> - - <function name="GetVehicleData" functionID="GetVehicleDataID" messagetype="response" since="2.0"> - - <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="VEHICLE_DATA_NOT_ALLOWED"/> - <element name="VEHICLE_DATA_NOT_AVAILABLE"/> - <element name="USER_DISALLOWED"/> - </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="gps" type="GPSData" mandatory="false"> - <description>See GPSData</description> - </param> - <param name="speed" type="Float" minvalue="0" maxvalue="700" mandatory="false"> - <description>The vehicle speed in kilometers per hour</description> - </param> - <param name="rpm" type="Integer" minvalue="0" maxvalue="20000" mandatory="false"> - <description>The number of revolutions per minute of the engine</description> - </param> - <param name="fuelLevel" type="Float" minvalue="-6" maxvalue="106" mandatory="false"> - <description>The fuel level in the tank (percentage)</description> - </param> - <param name="fuelLevel_State" type="ComponentVolumeStatus" mandatory="false"> - <description>The fuel level state</description> - </param> - <param name="instantFuelConsumption" type="Float" minvalue="0" maxvalue="25575" mandatory="false"> - <description>The instantaneous fuel consumption in microlitres</description> - </param> - <param name="fuelRange" type="FuelRange" minsize="0" maxsize="100" array="true" mandatory="false" since="5.0"> - <description>The estimate range in KM the vehicle can travel based on fuel level and consumption</description> - </param> - <param name="externalTemperature" type="Float" minvalue="-40" maxvalue="100" mandatory="false"> - <description>The external temperature in degrees celsius</description> - </param> - <param name="turnSignal" type="TurnSignal" mandatory="false" since="5.0"> - <description>See TurnSignal</description> - </param> - <param name="vin" type="String" maxlength="17" mandatory="false"> - <description>Vehicle identification number</description> - </param> - <param name="prndl" type="PRNDL" mandatory="false"> - <description>See PRNDL</description> - </param> - <param name="tirePressure" type="TireStatus" mandatory="false"> - <description>See TireStatus</description> - </param> - <param name="odometer" type="Integer" minvalue="0" maxvalue="17000000" mandatory="false"> - <description>Odometer in km</description> - </param> - <param name="beltStatus" type="BeltStatus" mandatory="false"> - <description>The status of the seat belts</description> - </param> - <param name="bodyInformation" type="BodyInformation" mandatory="false"> - <description>The body information including power modes</description> - </param> - <param name="deviceStatus" type="DeviceStatus" mandatory="false"> - <description>The device status including signal and battery strength</description> - </param> - <param name="driverBraking" type="VehicleDataEventStatus" mandatory="false"> - <description>The status of the brake pedal</description> - </param> - <param name="wiperStatus" type="WiperStatus" mandatory="false"> - <description>The status of the wipers</description> - </param> - <param name="headLampStatus" type="HeadLampStatus" mandatory="false"> - <description>Status of the head lamps</description> - </param> - <param name="engineTorque" type="Float" minvalue="-1000" maxvalue="2000" mandatory="false"> - <description>Torque value for engine (in Nm) on non-diesel variants</description> - </param> - <param name="accPedalPosition" type="Float" minvalue="0" maxvalue="100" mandatory="false"> - <description>Accelerator pedal position (percentage depressed)</description> - </param> - <param name="steeringWheelAngle" type="Float" minvalue="-2000" maxvalue="2000" mandatory="false"> - <description>Current angle of the steering wheel (in deg)</description> - </param> - <param name="engineOilLife" type="Float" minvalue="0" maxvalue="100" mandatory="false" since="5.0"> - <description>The estimated percentage of remaining oil life of the engine.</description> - </param> - <param name="electronicParkBrakeStatus" type="ElectronicParkBrakeStatus" mandatory="false" since="5.0"> - <description>The status of the park brake as provided by Electric Park Brake (EPB) system.</description> - </param> - <param name="cloudAppVehicleID" type="String" mandatory="false" since="5.1"> - <description>Parameter used by cloud apps to identify a head unit</description> - </param> - <param name="eCallInfo" type="ECallInfo" mandatory="false"> - <description>Emergency Call notification and confirmation data</description> - </param> - <param name="airbagStatus" type="AirbagStatus" mandatory="false"> - <description>The status of the air bags</description> - </param> - <param name="emergencyEvent" type="EmergencyEvent" mandatory="false"> - <description>Information related to an emergency event (and if it occurred)</description> - </param> - <param name="clusterModeStatus" type="ClusterModeStatus" mandatory="false"> - <description>The status modes of the cluster</description> - </param> - <param name="myKey" type="MyKey" mandatory="false"> - <description>Information related to the MyKey feature</description> - </param> - </function> - - <function name="ReadDID" functionID="ReadDIDID" messagetype="request" since="2.0"> - <description>Non periodic vehicle data read request</description> - - <param name="ecuName" type="Integer" minvalue="0" maxvalue="65535" mandatory="true"> - <description>Name of ECU.</description> - </param> - <param name="didLocation" type="Integer" minvalue="0" maxvalue="65535" minsize="1" maxsize="1000" array="true" mandatory="true"> - <description>Get raw data from vehicle data DID location(s)</description> - </param> - </function> - - <function name="ReadDID" functionID="ReadDIDID" messagetype="response" since="2.0"> - - <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="DISALLOWED"/> - <element name="USER_DISALLOWED"/> - <element name="TRUNCATED_DATA"/> - </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="didResult" type="DIDResult" minsize="0" maxsize="1000" array="true" mandatory="false"> - <description>Array of requested DID results (with data if available).</description> - </param> - - </function> - - <function name="GetDTCs" functionID="GetDTCsID" messagetype="request" since="2.0"> - <description>Vehicle module diagnostic trouble code request.</description> - - <param name="ecuName" type="Integer" minvalue="0" maxvalue="65535" mandatory="true"> - <description>Name of ECU.</description> - </param> - - <param name="dtcMask" type="Integer" minvalue="0" maxvalue="255" mandatory="false"> - <description>DTC Mask Byte to be sent in diagnostic request to module .</description> - </param> - - </function> - - <function name="GetDTCs" functionID="GetDTCsID" messagetype="response" since="2.0"> - - <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="DISALLOWED"/> - <element name="USER_DISALLOWED"/> - <element name="TRUNCATED_DATA"/> - </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="ecuHeader" type="Integer" minvalue="0" maxvalue="65535" mandatory="false"> - <description>2 byte ECU Header for DTC response (as defined in VHR_Layout_Specification_DTCs.pdf)</description> - </param> - - <param name="dtc" type="String" mandatory="false" minsize="1" maxsize="15" maxlength="10" array="true"> - <description> - Array of all reported DTCs on module (ecuHeader contains information if list is truncated). - Each DTC is represented by 4 bytes (3 bytes of data and 1 byte status as defined in VHR_Layout_Specification_DTCs.pdf). - </description> - </param> - - </function> - - <function name="DiagnosticMessage" functionID="DiagnosticMessageID" messagetype="request" since="3.0"> - <description>Non periodic vehicle diagnostic request</description> - - <param name="targetID" type="Integer" minvalue="0" maxvalue="65535" mandatory="true"> - <description>Name of target ECU.</description> - </param> - - <param name="messageLength" type="Integer" minvalue="0" maxvalue="65535" mandatory="true"> - <description>Length of message (in bytes).</description> - </param> - - <param name="messageData" type="Integer" minvalue="0" maxvalue="255" minsize="1" maxsize="65535" array="true" mandatory="true"> - <description> - Array of bytes comprising CAN message. - </description> - </param> - </function> - - <function name="DiagnosticMessage" functionID="DiagnosticMessageID" messagetype="response" since="3.0"> - - <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="DISALLOWED"/> - <element name="USER_DISALLOWED"/> - <element name="TRUNCATED_DATA"/> - </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="messageDataResult" type="Integer" minvalue="0" maxvalue="255" minsize="1" maxsize="65535" array="true" mandatory="false"> - <description> - Array of bytes comprising CAN message result. - </description> - </param> - - </function> - - <function name="ScrollableMessage" functionID="ScrollableMessageID" messagetype="request" since="2.0"> - <description>Creates a full screen overlay containing a large block of formatted text that can be scrolled with up to 8 SoftButtons defined</description> - <param name="scrollableMessageBody" type="String" maxlength="500" mandatory="true"> - <description>Body of text that can include newlines and tabs.</description> - </param> - <param name="timeout" type="Integer" minvalue="1000" maxvalue="65535" defvalue="30000" mandatory="false"> - <description>App defined timeout. Indicates how long of a timeout from the last action (i.e. scrolling message resets timeout).</description> - </param> - <param name="softButtons" type="SoftButton" minsize="0" maxsize="8" array="true" mandatory="false"> - <description> - App defined SoftButtons. - If omitted on supported displays, only the system defined "Close" SoftButton will be displayed. - </description> - </param> - <param name="cancelID" type="Integer" mandatory="false" since="6.0"> - <description> - An ID for this specific ScrollableMessage to allow cancellation through the `CancelInteraction` RPC. - </description> - </param> - </function> - - <function name="ScrollableMessage" functionID="ScrollableMessageID" messagetype="response" since="2.0"> - <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="CHAR_LIMIT_EXCEEDED"/> - <element name="TOO_MANY_PENDING_REQUESTS"/> - <element name="APPLICATION_NOT_REGISTERED"/> - <element name="GENERIC_ERROR"/> - <element name="DISALLOWED"/> - <element name="UNSUPPORTED_RESOURCE"/> - <element name="REJECTED"/> - <element name="ABORTED"/> - </param> - - <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> - <description>Provides additional human readable info regarding the result.</description> - </param> - - </function> - - <function name="Slider" functionID="SliderID" messagetype="request" since="2.0"> - <description>Creates a full screen or pop-up overlay (depending on platform) with a single user controlled slider.</description> - <param name="numTicks" type="Integer" minvalue="2" maxvalue="26" mandatory="true"> - <description>Number of selectable items on a horizontal axis</description> - </param> - <param name="position" type="Integer" minvalue="1" maxvalue="26" mandatory="true"> - <description>Initial position of slider control (cannot exceed numTicks)</description> - </param> - <param name="sliderHeader" type="String" maxlength="500" mandatory="true"> - <description>Text header to display</description> - </param> - <param name="sliderFooter" type="String" maxlength="500" minsize="1" maxsize="26" array="true" mandatory="false"> - <description> - Text footer to display (meant to display min/max threshold descriptors). - For a static text footer, only one footer string shall be provided in the array. - For a dynamic text footer, the number of footer text string in the array must match the numTicks value. - For a dynamic text footer, text array string should correlate with potential slider position index. - If omitted on supported displays, no footer text shall be displayed. - </description> - </param> - <param name="timeout" type="Integer" minvalue="1000" maxvalue="65535" defvalue="10000" mandatory="false"> - <description> - App defined timeout. Indicates how long of a timeout from the last action (i.e. sliding control resets timeout). - If omitted, the value is set to 10000. - </description> - </param> - <param name="cancelID" type="Integer" mandatory="false" since="6.0"> - <description> - An ID for this specific Slider to allow cancellation through the `CancelInteraction` RPC. - </description> - </param> - </function> - - <function name="Slider" functionID="SliderID" messagetype="response" since="2.0"> - <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="SAVED"/> - <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="DISALLOWED"/> - <element name="UNSUPPORTED_RESOURCE"/> - <element name="REJECTED"/> - <element name="ABORTED"/> - <element name="TIMED_OUT"/> - </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="sliderPosition" type="Integer" minvalue="1" maxvalue="26" mandatory="false"> - <description> - Current slider value returned when saved or canceled (aborted) - This value is only returned for resultCodes "SAVED" or "ABORTED" - </description> - </param> - </function> - - <function name="ShowConstantTBT" functionID="ShowConstantTBTID" messagetype="request" since="2.0"> - <param name="navigationText1" type="String" minlength="0" maxlength="500" mandatory="false" since="2.0"> - </param> - <param name="navigationText2" type="String" minlength="0" maxlength="500" mandatory="false" since="2.0"> - </param> - <param name="eta" type="String" minlength="0" maxlength="500" mandatory="false" since="2.0"> - </param> - <param name="timeToDestination" type="String" minlength="0" maxlength="500" mandatory="false" since="3.0"> - </param> - <param name="totalDistance" type="String" minlength="0" maxlength="500" mandatory="false" since="2.0"> - </param> - <param name="turnIcon" type="Image" mandatory="false" since="2.0"> - </param> - <param name="nextTurnIcon" type="Image" mandatory="false" since="3.0"> - </param> - <param name="distanceToManeuver" type="Float" minvalue="0" maxvalue="1000000000" mandatory="false" since="2.0"> - <description> - Fraction of distance till next maneuver (starting from when AlertManeuver is triggered). - Used to calculate progress bar. - </description> - </param> - <param name="distanceToManeuverScale" type="Float" minvalue="0" maxvalue="1000000000" mandatory="false" since="2.0"> - <description> - Distance till next maneuver (starting from) from previous maneuver. - Used to calculate progress bar. - </description> - </param> - <param name="maneuverComplete" type="Boolean" mandatory="false" since="2.0"> - <description> - If and when a maneuver has completed while an AlertManeuver is active, the app must send this value set to TRUE in order to clear the AlertManeuver overlay. - If omitted the value will be assumed as FALSE. - </description> - </param> - <param name="softButtons" type="SoftButton" minsize="0" maxsize="3" array="true" mandatory="false" since="2.0"> - <description> - Three dynamic SoftButtons available (first SoftButton is fixed to "Turns"). - If omitted on supported displays, the currently displayed SoftButton values will not change. - </description> - </param> - </function> - - <function name="ShowConstantTBT" functionID="ShowConstantTBTID" messagetype="response" since="2.0"> - <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="DISALLOWED"/> - <element name="UNSUPPORTED_REQUEST"/> - <element name="UNSUPPORTED_RESOURCE"/> - </param> - <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> - <description>Provides additional human readable info regarding the result.</description> - </param> - </function> - - <function name="AlertManeuver" functionID="AlertManeuverID" messagetype="request" since="2.0"> - <param name="ttsChunks" type="TTSChunk" minsize="1" maxsize="100" array="true" mandatory="false"> - <description>An array of text chunks of type TTSChunk. See TTSChunk</description> - </param> - <param name="softButtons" type="SoftButton" minsize="0" maxsize="3" array="true" mandatory="false"> - <description>If omitted on supported displays, only the system defined "Close" SoftButton shall be displayed.</description> - </param> - </function> - - <function name="AlertManeuver" functionID="AlertManeuverID" messagetype="response" since="2.0"> - <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="IGNORED"/> - <element name="DISALLOWED"/> - <element name="UNSUPPORTED_REQUEST"/> - <element name="UNSUPPORTED_RESOURCE"/> - <element name="ABORTED"/> - <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> - </function> - - <function name="UpdateTurnList" functionID="UpdateTurnListID" messagetype="request" since="2.0"> - <param name="turnList" type="Turn" minsize="1" maxsize="100" array="true" mandatory="false"> - </param> - <param name="softButtons" type="SoftButton" minsize="0" maxsize="1" array="true" mandatory="false"> - <description>If omitted on supported displays, app-defined SoftButton will be left blank.</description> - </param> - </function> - - <function name="UpdateTurnList" functionID="UpdateTurnListID" messagetype="response" since="2.0"> - <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="DISALLOWED"/> - <element name="UNSUPPORTED_REQUEST"/> - <element name="UNSUPPORTED_RESOURCE"/> - </param> - <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> - <description>Provides additional human readable info regarding the result.</description> - </param> - </function> - - <function name="ChangeRegistration" functionID="ChangeRegistrationID" messagetype="request" since="2.0"> - <param name="language" type="Language" mandatory="true"> - <description>Requested voice engine (VR+TTS) language registration</description> - </param> - <param name="hmiDisplayLanguage" type="Language" mandatory="true"> - <description>Request display language registration</description> - </param> - <param name="appName" type="String" maxlength="100" mandatory="false" since="3.0"> - <description>Request new app name registration</description> - </param> - <param name="ttsName" type="TTSChunk" minsize="1" maxsize="100" array="true" mandatory="false" since="3.0"> - <description>Request new ttsName registration</description> - </param> - <param name="ngnMediaScreenAppName" type="String" maxlength="100" mandatory="false" since="3.0"> - <description>Request new app short name registration</description> - </param> - <param name="vrSynonyms" type="String" maxlength="40" minsize="1" maxsize="100" array="true" mandatory="false" since="3.0"> - <description>Request new VR synonyms registration</description> - </param> - - </function> - - <function name="ChangeRegistration" functionID="ChangeRegistrationID" messagetype="response" since="2.0"> - <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="DISALLOWED"/> - </param> - - <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> - <description>Provides additional human readable info regarding the result.</description> - </param> - - </function> - - <function name="GenericResponse" functionID="GenericResponseID" messagetype="response" since="1.0"> - <description> - Generic Response is sent, when the name of a received msg cannot be retrieved. Only used in case of an error. - Currently, only resultCode INVALID_DATA is used. - </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="INVALID_DATA"/> - </param> - - <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> - <description>Provides additional human readable info regarding the result.</description> - </param> - </function> - - <function name="PutFile" functionID="PutFileID" messagetype="request" since="3.0"> - <description> - Used to push a binary data onto the module from a mobile device, such as icons and album art - Not supported on first generation of SDL enabled modules. - Binary data is in binary part of hybrid msg. - </description> - - <param name="syncFileName" type="String" maxlength="255" mandatory="true"> - <description>File reference name.</description> - </param> - - <param name="fileType" type="FileType" mandatory="true"> - <description>Selected file type.</description> - </param> - - <param name="persistentFile" type="Boolean" defvalue="false" mandatory="false"> - <description> - Indicates if the file is meant to persist between sessions / ignition cycles. - If set to TRUE, then the system will aim to persist this file through session / cycles. - While files with this designation will have priority over others, they are subject to deletion by the system at any time. - In the event of automatic deletion by the system, the app will receive a rejection and have to resend the file. - If omitted, the value will be set to false. - </description> - </param> - - <param name="systemFile" type="Boolean" defvalue="false" mandatory="false" > - <description> - Indicates if the file is meant to be passed thru core to elsewhere on the system. - If set to TRUE, then the system will instead pass the data thru as it arrives to a predetermined area outside of core. - If omitted, the value will be set to false. - </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> - <param name="crc" type="Integer" minvalue="0" maxvalue="4294967295" mandatory="false" since="5.0"> - <description> Additional CRC32 checksum to protect data integrity up to 512 Mbits </description> - </param> - </function> - - <function name="PutFile" functionID="PutFileID" messagetype="response" since="3.0"> - <description>Response is sent, when the file data was copied (success case). Or when an error occurred.</description> - <description>Not supported on first generation SDL enabled vehicles. </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="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="UNSUPPORTED_REQUEST"/> - <element name="CORRUPTED_DATA"/> - </param> - - <param name="spaceAvailable" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="false" since="5.0"> - <description> - Provides the total local space available in SDL Core for the registered app. - If the transfer has systemFile enabled, then the value will be set to 0 automatically. - </description> - <history> - <param name="spaceAvailable" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="true" since="3.0" until="5.0"/> - </history> - </param> - - <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> - <description>Provides additional human readable info regarding the result.</description> - </param> - </function> - - <function name="GetFile" functionID="GetFileID" messagetype="request" since="5.1"> - <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 retrieved - </description> - </param> - </function> - - <function name="GetFile" functionID="GetFileID" messagetype="response" since="5.1"> - <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. - Not supported on first generation SDL enabled vehicles. - </description> - - <param name="syncFileName" type="String" maxlength="500" mandatory="true"> - <description>File reference name.</description> - </param> - - </function> - - <function name="DeleteFile" functionID="DeleteFileID" messagetype="response" since="3.0"> - <description> - Response is sent, when the file data was deleted (success case). Or when an error occurred. - Not supported on First generation SDL enabled vehicles. - </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="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="UNSUPPORTED_REQUEST"/> - </param> - - <param name="spaceAvailable" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="false" since="5.0"> - <description>Provides the total local space available on the module for the registered app.</description> - <history> - <param name="spaceAvailable" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="true" since="3.0" until="5.0"/> - </history> - </param> - - <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> - <description>Provides additional human readable info regarding the result.</description> - </param> - </function> - - <function name="ListFiles" functionID="ListFilesID" messagetype="request" since="3.0"> - <description> - Requests the current list of resident filenames for the registered app. - Not supported on first generation SDL enabled vehicles. - </description> - </function> - - <function name="ListFiles" functionID="ListFilesID" messagetype="response" since="3.0"> - <description> - Returns the current list of resident filenames for the registered app along with the current space available - Not supported on First generation SDL enabled vehicles. - </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="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="UNSUPPORTED_REQUEST"/> - </param> - - <param name="filenames" type="String" maxlength="500" minsize="0" maxsize="1000" array="true" mandatory="false"> - <description> - An array of all filenames resident on the module for the given registered app. - If omitted, then no files currently reside on the system. - </description> - </param> - - <param name="spaceAvailable" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="false" since="5.0"> - <description>Provides the total local space available on the module for the registered app.</description> - <history> - <param name="spaceAvailable" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="true" since="3.0" until="5.0"/> - </history> - </param> - - <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> - <description>Provides additional human readable info regarding the result.</description> - </param> - </function> - - <function name="SetAppIcon" functionID="SetAppIconID" messagetype="request" since="3.0"> - <description> - Used to set existing local file on the module as the app's icon - Not supported on first generation SDL enabled vehicles. - </description> - - <param name="syncFileName" type="String" maxlength="500" mandatory="true"> - <description>File reference name.</description> - </param> - - </function> - - <function name="SetAppIcon" functionID="SetAppIconID" messagetype="response" since="3.0"> - <description> - Response is sent, when the file data was copied (success case). Or when an error occurred. - Not supported on First generation SDL enabled vehicles. - </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="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="UNSUPPORTED_REQUEST"/> - </param> - - <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> - <description>Provides additional human readable info regarding the result.</description> - </param> - - </function> - - <function name="SetDisplayLayout" functionID="SetDisplayLayoutID" messagetype="request" deprecated="true" since="6.0"> - <history> - <function name="SetDisplayLayout" functionID="SetDisplayLayoutID" messagetype="request" since="3.0" until="6.0"/> - </history> - <description>This RPC is deprecated. Use Show RPC to change layout.</description> - <param name="displayLayout" type="String" maxlength="500" mandatory="true"> - <description> - Predefined or dynamically created screen layout. - Currently only predefined screen layouts are defined. - </description> - </param> - - <param name="dayColorScheme" type="TemplateColorScheme" mandatory="false" since="5.0"/> - - <param name="nightColorScheme" type="TemplateColorScheme" mandatory="false" since="5.0"/> - </function> - - <function name="SetDisplayLayout" functionID="SetDisplayLayoutID" messagetype="response" deprecated="true" since="6.0"> - <history> - <function name="SetDisplayLayout" functionID="SetDisplayLayoutID" messagetype="response" since="3.0" until="6.0"/> - </history> - <description>This RPC is deprecated. Use Show RPC to change layout.</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="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="UNSUPPORTED_REQUEST"/> - </param> - - <param name="displayCapabilities" type="DisplayCapabilities" mandatory="false"> - <description>See DisplayCapabilities</description> - </param> - - <param name="buttonCapabilities" type="ButtonCapabilities" minsize="1" maxsize="100" array="true" mandatory="false"> - <description>See ButtonCapabilities</description > - </param> - - <param name="softButtonCapabilities" type="SoftButtonCapabilities" minsize="1" maxsize="100" array="true" mandatory="false"> - <description>If returned, the platform supports on-screen SoftButtons; see SoftButtonCapabilities.</description> - </param> - - <param name="presetBankCapabilities" type="PresetBankCapabilities" mandatory="false"> - <description>If returned, the platform supports custom on-screen Presets; see PresetBankCapabilities.</description> - </param> - - <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> - <description>Provides additional human readable info regarding the result.</description> - </param> - - </function> - - <function name="SystemRequest" functionID="SystemRequestID" messagetype="request" since="3.0"> - <description>An asynchronous request from the device; binary data can be included in hybrid part of message for some requests (such as HTTP, Proprietary, or Authentication requests)</description> - <param name="requestType" type="RequestType" mandatory="true"> - <description> - The type of system request. - Note that Proprietary requests should forward the binary data to the known proprietary module on the system. - </description> - </param> - <param name="requestSubType" type="String" maxlength="255" mandatory="false" since="5.0"> - <description> - This parameter is filled for supporting OEM proprietary data exchanges. - </description> - </param> - <param name="fileName" type="String" maxlength="255" mandatory="false"> - <description> - Filename of HTTP data to store in predefined system staging area. - Mandatory if requestType is HTTP. - PROPRIETARY requestType should ignore this parameter. - </description> - </param> - </function> - - <function name="SystemRequest" functionID="SystemRequestID" messagetype="response" since="3.0"> - <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="INVALID_CERT"/> - <element name="EXPIRED_CERT"/> - <element name="UNSUPPORTED_REQUEST"/> - <element name="UNSUPPORTED_RESOURCE"/> - <element name="DISALLOWED"/> - <element name="ABORTED"/> - <element name="WARNINGS"/> - <element name="TIMED_OUT"/> - <element name="IGNORED"/> - </param> - - <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> - <description>Provides additional human readable info regarding the result.</description> - </param> - </function> - - <function name="SendLocation" functionID="SendLocationID" messagetype="request" since="3.0"> - <param name="longitudeDegrees" type="Float" minvalue="-180" maxvalue="180" mandatory="false"> - </param> - <param name="latitudeDegrees" type="Float" minvalue="-90" maxvalue="90" mandatory="false"> - </param> - <param name="locationName" type="String" maxlength="500" mandatory="false"> - <description> - Name / title of intended location - </description> - </param> - <param name="locationDescription" type="String" maxlength="500" mandatory="false"> - <description> - Description intended location / establishment (if applicable) - </description> - </param> - <param name="addressLines" type="String" maxlength="500" minsize="0" maxsize="4" array="true" mandatory="false"> - <description> - Location address (if applicable) - </description> - </param> - <param name="phoneNumber" type="String" maxlength="500" mandatory="false"> - <description> - Phone number of intended location / establishment (if applicable) - </description> - </param> - <param name="locationImage" type="Image" mandatory="false"> - <description> - Image / icon of intended location (if applicable and supported) - </description> - </param> - - <param name="timeStamp" type="DateTime" mandatory="false" since="4.1"> - <description> - timestamp in ISO 8601 format - </description> - </param> - - <param name="address" type="OASISAddress" mandatory="false" since="4.1"> - <description>Address to be used for setting destination</description> - </param> - <param name="deliveryMode" type="DeliveryMode" mandatory="false" since="4.1"> - <description>Defines the mode of prompt for user</description> - </param> - </function> - - <function name="SendLocation" functionID="SendLocationID" messagetype="response" since="3.0"> - <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="UNSUPPORTED_RESOURCE"/> - <element name="DISALLOWED"/> - </param> - - <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> - <description>Provides additional human readable info regarding the result.</description> - </param> - </function> - - <function name="DialNumber" functionID="DialNumberID" messagetype="request" since="3.0"> - <description>Dials a phone number and switches to phone application.</description> - - <param name="number" type="String" maxlength="40" mandatory="true"> - <description> - Phone number is a string, which can be up to 40 chars. - All characters shall be stripped from string except digits 0-9 and * # , ; + - </description> - </param> - </function> - - <function name="DialNumber" functionID="DialNumberID" messagetype="response" since="3.0"> - <param name="success" type="Boolean" platform="documentation" mandatory="true"> - <description>true, if successful</description> - <description>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"/> - </param> - - <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> - <description>Provides additional human readable info regarding the result.</description> - </param> - </function> - - <function name="ButtonPress" functionID="ButtonPressID" messagetype="request" since="4.5"> - <param name="moduleType" type="ModuleType" mandatory="true"> - <description>The module where the button should be pressed</description> - </param> - <param name="moduleId" type="String" maxlength="100" mandatory="false" since="6.0"> - <description>Id of a module, published by System Capability. </description> - </param> - <param name="buttonName" type="ButtonName" mandatory="true"> - <description>The name of supported RC climate or radio button.</description> - </param> - <param name="buttonPressMode" type="ButtonPressMode" mandatory="true"> - <description>Indicates whether this is a LONG or SHORT button press event.</description> - </param> - </function> - - <function name="ButtonPress" functionID="ButtonPressID" messagetype="response" since="4.5"> - <param name="resultCode" type="Result" platform="documentation" mandatory="true"> - <description>See Result</description> - <element name="SUCCESS"/> - <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="IGNORED"/> - <element name="DISALLOWED"/> - <element name="USER_DISALLOWED"/> - <element name="IN_USE"/> - </param> - <param name="info" type="String" maxlength="1000" mandatory="false"> - </param> - <param name="success" type="Boolean" platform="documentation" mandatory="true"> - <description> true if successful; false, if failed </description> - </param> - </function> - - <function name="GetInteriorVehicleData" functionID="GetInteriorVehicleDataID" messagetype="request" since="4.5"> - <param name="moduleType" type="ModuleType" mandatory="true"> - <description> - The type of a RC module to retrieve module data from the vehicle. - In the future, this should be the Identification of a module. - </description> - </param> - <param name="moduleId" type="String" maxlength="100" mandatory="false" since="6.0"> - <description>Id of a module, published by System Capability. </description> - </param> - <param name="subscribe" type="Boolean" mandatory="false" since="4.5.1"> - <description> - If subscribe is true, the head unit will register OnInteriorVehicleData notifications for the requested module (moduleId and moduleType). - If subscribe is false, the head unit will unregister OnInteriorVehicleData notifications for the requested module (moduleId and moduleType). - If subscribe is not included, the subscription status of the app for the requested module (moduleId and moduleType) will remain unchanged. - </description> - <history> - <param name="subscribe" type="Boolean" mandatory="false" defvalue="false" since="4.5" until="4.5.1"/> - </history> - </param> - </function> - - <function name="GetInteriorVehicleData" functionID="GetInteriorVehicleDataID" messagetype="response" since="4.5"> - <param name="moduleData" type="ModuleData" mandatory="false"> - </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="IGNORED"/> - <element name="DISALLOWED"/> - <element name="USER_DISALLOWED"/> - <element name="UNSUPPORTED_RESOURCE"/> - </param> - <param name="info" type="String" maxlength="1000" mandatory="false"> - </param> - <param name="success" type="Boolean" platform="documentation" mandatory="true"> - <description> true if successful; false, if failed </description> - </param> - <param name="isSubscribed" type="Boolean" mandatory="false" > - <description> - It is a conditional-mandatory parameter: must be returned in case "subscribe" parameter was present in the related request. - if "true" - the "moduleType" from request is successfully subscribed and the head unit will send onInteriorVehicleData notifications for the moduleType. - if "false" - the "moduleType" from request is either unsubscribed or failed to subscribe. - </description> - </param> - </function> - - <function name="GetInteriorVehicleDataConsent" functionID="GetInteriorVehicleDataConsentID" messagetype="request" since="6.0"> - <param name="moduleType" type="ModuleType" mandatory="true"> - <description>The module type that the app requests to control.</description> - </param> - <param name="moduleIds" type="String" maxlength="100" array="true" mandatory="true"> - <description>Ids of a module of same type, published by System Capability. </description> - </param> - </function> - - <function name="GetInteriorVehicleDataConsent" functionID="GetInteriorVehicleDataConsentID" messagetype="response" since="6.0"> - <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="IGNORED"/> - <element name="DISALLOWED"/> - <element name="USER_DISALLOWED"/> - <element name="UNSUPPORTED_RESOURCE"/> - </param> - <param name="info" type="String" maxlength="1000" mandatory="false"> - </param> - <param name="allowed" type="Boolean" array="true" mandatory="false"> - <description> - This array has the same size as "moduleIds" in the request and each element corresponds to one moduleId - If true, SDL grants the permission for the requested module - If false, SDL denies the permission for the requested module. - </description> - </param> - </function> - - <function name="ReleaseInteriorVehicleDataModule" functionID="ReleaseInteriorVehicleDataModuleID" messagetype="request" since="6.0"> - <param name="moduleType" type="ModuleType" mandatory="true"> - </param> - <param name="moduleId" type="String" maxlength="100" mandatory="false" since="5.1"> - <description>Id of a module, published by System Capability. </description> - </param> - </function> - - <function name="ReleaseInteriorVehicleDataModule" functionID="ReleaseInteriorVehicleDataModuleID" messagetype="response" since="6.0"> - <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="IGNORED"/> - <element name="DISALLOWED"/> - <element name="UNSUPPORTED_RESOURCE"/> - </param> - <param name="info" type="String" maxlength="1000" mandatory="false"> - </param> - </function> - - <function name="SetInteriorVehicleData" functionID="SetInteriorVehicleDataID" messagetype="request" since="4.5"> - <param name="moduleData" type="ModuleData" mandatory="true"> - <description>The module data to set for the requested RC module.</description> - </param> - </function> - - <function name="SetInteriorVehicleData" functionID="SetInteriorVehicleDataID" messagetype="response" since="4.5"> - <description>Used to set the values of one remote control module </description> - <param name="moduleData" type="ModuleData" mandatory="false"> - </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="IGNORED"/> - <element name="DISALLOWED"/> - <element name="USER_DISALLOWED"/> - <element name="READ_ONLY"/> - <element name="UNSUPPORTED_RESOURCE"/> - <element name="IN_USE"/> - </param> - <param name="info" type="String" maxlength="1000" mandatory="false"> - </param> - <param name="success" type="Boolean" platform="documentation" mandatory="true"> - <description> true if successful; false, if failed </description> - </param> - </function> - - <function name="SubscribeWayPoints" functionID="SubscribeWayPointsID" messagetype="request" since="4.1"> - <description>To subscribe in getting changes for Waypoints/destinations</description> - </function> - - <function name="SubscribeWayPoints" functionID="SubscribeWayPointsID" messagetype="response" since="4.1"> - <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="GENERIC_ERROR"/> - <element name="REJECTED"/> - <element name="UNSUPPORTED_RESOURCE"/> - <element name="IGNORED"/> - <element name="DISALLOWED"/> - </param> - <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> - <description>Provides additional human readable info regarding the result.</description> - </param> - </function> - - <function name="GetWayPoints" functionID="GetWayPointsID" messagetype="request" since="4.1"> - <description>Request for getting waypoint/destination data.</description> - <param name="wayPointType" type="WayPointType" mandatory="true"> - <description>To request for either the destination only or for all waypoints including destination</description> - </param> - </function> - - <function name="GetWayPoints" functionID="GetWayPointsID" messagetype="response" since="4.1"> - <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="TIMED_OUT"/> - <element name="GENERIC_ERROR"/> - <element name="REJECTED"/> - <element name="UNSUPPORTED_RESOURCE"/> - <element name="IGNORED"/> - <element name="IN_USE"/> - <element name="DISALLOWED"/> - </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="wayPoints" type="LocationDetails" mandatory="false" array="true" minsize="1" maxsize="10"> - <description>See LocationDetails</description> - </param> - </function> - - <function name="UnsubscribeWayPoints" functionID="UnsubscribeWayPointsID" messagetype="request" since="4.1"> - <description>Request to unsubscribe from WayPoints and Destination</description> - </function> - - <function name="UnsubscribeWayPoints" functionID="UnsubscribeWayPointsID" messagetype="response" since="4.1"> - <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="GENERIC_ERROR"/> - <element name="REJECTED"/> - <element name="UNSUPPORTED_RESOURCE"/> - <element name="IGNORED"/> - <element name="DISALLOWED"/> - </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="wayPoints" type="LocationDetails" mandatory="false" array="true" minsize="1" maxsize="10"> - <description>See LocationDetails</description> - </param> - </function> - - <function name="GetSystemCapability" functionID="GetSystemCapabilityID" messagetype="request" since="4.5"> - <description>Request for expanded information about a supported system/HMI capability</description> - <param name="systemCapabilityType" type="SystemCapabilityType" mandatory="true"> - <description>The type of system capability to get more information on</description> - </param> - <param name="subscribe" type="Boolean" mandatory="false" since="5.1"> - <description>Flag to subscribe to updates of the supplied service capability type. If true, the requester will be subscribed. If false, the requester will not be subscribed and be removed as a subscriber if it was previously subscribed.</description> - </param> - </function> - - <function name="GetSystemCapability" functionID="GetSystemCapabilityID" messagetype="response" since="4.5"> - <param name="systemCapability" type="SystemCapability" mandatory="false"> - </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="IGNORED"/> - <element name="DISALLOWED"/> - <element name="USER_DISALLOWED"/> - <element name="UNSUPPORTED_RESOURCE"> - <description>The capability does not exist on the module</description> - </element> - <element name="DATA_NOT_AVAILABLE"> - <description>The capability should exist on the module but there was an error retrieving the data.</description> - </element> - </param> - <param name="info" type="String" maxlength="1000" mandatory="false"> - <description>Provides additional human readable info regarding the result.</description> - </param> - <param name="success" type="Boolean" platform="documentation" mandatory="true"> - <description> true if successful; false, if failed </description> - </param> - </function> - - <function name="SendHapticData" functionID="SendHapticDataID" messagetype="request" since="4.5"> - <description>Send the spatial data gathered from SDLCarWindow or VirtualDisplayEncoder to the HMI. This data will be utilized by the HMI to determine how and when haptic events should occur</description> - <param name="hapticRectData" type="HapticRect" minsize="0" maxsize="1000" mandatory="false" array="true"> - <description>Array of spatial data structures that represent the locations of all user controls present on the HMI. This data should be updated if/when the application presents a new screen. When a request is sent, if successful, it will replace all spatial data previously sent through RPC. If an empty array is sent, the existing spatial data will be cleared</description> - </param> - </function> - - <function name="SendHapticData" functionID="SendHapticDataID" messagetype="response" since="4.5"> - <param name="success" type="Boolean" platform="documentation" mandatory="true"> - <description> true if successful; false if failed </description> - </param> - <param name="info" type="String" maxlength="1000" mandatory="false"> - <description>Provides additional human readable info regarding the result.</description> - </param> - <param name="resultCode" type="Result" platform="documentation" mandatory="true"> - <description>See Result</description> - <element name="SUCCESS"/> - <element name="GENERIC_ERROR"/> - </param> - </function> - - <function name="SetCloudAppProperties" functionID="SetCloudAppPropertiesID" messagetype="request" since="5.1"> - <description> - RPC used to enable/disable a cloud application and set its cloud-related policy properties - </description> - <param name="properties" type="CloudAppProperties" mandatory="true"> - <description> The new cloud application properties </description> - </param> - </function> - - <function name="SetCloudAppProperties" functionID="SetCloudAppPropertiesID" messagetype="response" since="5.1"> - <description>The response to SetCloudAppProperties</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="INVALID_DATA"/> - <element name="OUT_OF_MEMORY"/> - <element name="TOO_MANY_PENDING_REQUESTS"/> - <element name="GENERIC_ERROR"/> - <element name="DISALLOWED"/> - <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> - </function> - - <function name="GetCloudAppProperties" functionID="GetCloudAppPropertiesID" messagetype="request" since="5.1"> - <description> - RPC used to get the current properties of a cloud application - </description> - <param name="appID" type="String" maxlength="100" mandatory="true"></param> - </function> - - <function name="GetCloudAppProperties" functionID="GetCloudAppPropertiesID" messagetype="response" since="5.1"> - <description>The response to GetCloudAppProperties</description> - <param name="properties" type="CloudAppProperties" mandatory="false"> - <description> The requested cloud application properties </description> - </param> - <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="GENERIC_ERROR"/> - <element name="DISALLOWED"/> - <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> - </function> - - <function name="PublishAppService" functionID="PublishAppServiceID" messagetype="request" since="5.1"> - <description> - Registers a service offered by this app on the module. - Subsequent calls with the same service type will update the manifest for that service. - </description> - - <param name="appServiceManifest" type="AppServiceManifest" mandatory="true"> - <description> - The manifest of the service that wishes to be published. - If already published, the updated manifest for this service. - </description> - </param> - </function> - - <function name="PublishAppService" functionID="PublishAppServiceID" messagetype="response" since="5.1"> - <description>Response to the request to register a service offered by this app on the module</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"/> - </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="appServiceRecord" type="AppServiceRecord" mandatory="false"> - <description> If the request was successful, this object will be the current status of the service record for the published service. This will include the Core supplied service ID.</description> - </param> - </function> - - <function name="UnpublishAppService" functionID="UnpublishAppServiceID" messagetype="request" since="6.0"> - <description> Unpublish an existing service published by this application. </description> - - <param name="serviceID" type="String" mandatory="true"> - <description> The ID of the service to be unpublished. </description> - </param> - </function> - - <function name="UnpublishAppService" functionID="UnpublishAppServiceID" messagetype="response" since="6.0"> - <description> The response to UnpublishAppService </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="INVALID_ID"/> - <element name="OUT_OF_MEMORY"/> - <element name="TOO_MANY_PENDING_REQUESTS"/> - <element name="APPLICATION_NOT_REGISTERED"/> - <element name="GENERIC_ERROR"/> - </param> - - <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> - <description>Provides additional human readable info regarding the result.</description> - </param> - </function> - - <function name="GetAppServiceData" functionID="GetAppServiceDataID" messagetype="request" since="5.1"> - <description> This request asks the module for current data related to the specific service. It also includes an option to subscribe to that service for future updates</description> - - <param name="serviceType" type="String" mandatory="true"> - <description>The type of service that is to be offered by this app. See AppServiceType for known enum equivalent types. Parameter is a string to allow for new service types to be used by apps on older versions of SDL Core.</description> - </param> - - <param name="subscribe" type="Boolean" mandatory="false"> - <description> If true, the consumer is requesting to subscribe to all future updates from the service publisher. If false, the consumer doesn't wish to subscribe and should be unsubscribed if it was previously subscribed.</description> - </param> - </function> - - <function name="GetAppServiceData" functionID="GetAppServiceDataID" messagetype="response" since="5.1"> - <description> This response includes the data that was 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"/> - </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="serviceData" type="AppServiceData" mandatory="false"/> - </function> - - <function name="PerformAppServiceInteraction" functionID="PerformAppServiceInteractionID" messagetype="request" since="5.1"> - <param name="serviceUri" type="String" mandatory="true"> - <description>Fully qualified URI based on a predetermined scheme provided by the app service. SDL makes no guarantee that this URI is correct.</description> - </param> - - <param name="serviceID" type="String" mandatory="true"> - <description>The service ID that the app consumer wishes to send this URI.</description> - </param> - - <param name="originApp" type="String" mandatory="true"> - <description>This string is the appID of the app requesting the app service provider take the specific action.</description> - </param> - - <param name="requestServiceActive" type="Boolean" mandatory="false"> - <description>This flag signals the requesting consumer would like this service to become the active primary service of the destination's type.</description> - </param> - </function> - - <function name="PerformAppServiceInteraction" functionID="PerformAppServiceInteractionID" messagetype="response" since="5.1"> - <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. All results will be available for this response.</description> - </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="serviceSpecificResult" type="String" mandatory="false"> - <description>The service can provide specific result strings to the consumer through this param.</description> - </param> - </function> - - <function name="CancelInteraction" functionID="CancelInteractionID" messagetype="request" since="6.0"> - <description> - Close an active interaction on the HMI. - </description> - - <param name="cancelID" type="Integer" mandatory="false"> - <description> - The ID of the specific interaction you want to dismiss. If not set, the most recent of the RPC type set in functionID will be dismissed. - </description> - </param> - - <param name="functionID" type="Integer" mandatory="true"> - <description> - The ID of the type of interaction the developer wants to dismiss. Only values 10, (PerformInteractionID), 12 (AlertID), 25 (ScrollableMessageID), and 26 (SliderID) are permitted. - </description> - </param> - </function> - - <function name="CancelInteraction" functionID="CancelInteractionID" messagetype="response" since="6.0"> - <description> - If no applicable request can be dismissed, the result will be IGNORED. - </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="IGNORED"/> - <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="DISALLOWED"/> - <element name="UNSUPPORTED_RESOURCE"/> - <element name="WARNINGS"/> - <element name="ABORTED"/> - </param> - - <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> - <description>Provides additional human readable info regarding the result.</description> - </param> - </function> - - <function name="CloseApplication" functionID="CloseApplicationID" messagetype="request" since="6.0"> - <description>Request from the application to exit the foreground and enter HMI_NONE.</description> - </function> - - <function name="CloseApplication" functionID="CloseApplicationID" messagetype="response" since="6.0"> - <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="DISALLOWED"/> - <element name="APPLICATION_NOT_REGISTERED"/> - <element name="GENERIC_ERROR"/> - <element name="IGNORED"/> - </param> - - <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> - <description>Provides additional human readable info regarding the result.</description> - </param> - </function> - - <!-- Notifications --> - - <function name="OnHMIStatus" functionID="OnHMIStatusID" messagetype="notification" since="1.0"> - <param name="hmiLevel" type="HMILevel" mandatory="true"> - <description>See HMILevel</description> - </param> - - <param name="audioStreamingState" type="AudioStreamingState" mandatory="true"> - <description>See AudioStreamingState</description> - </param> - - <param name="systemContext" type="SystemContext" mandatory="true"> - <description>See SystemContext</description> - </param> - - <param name="videoStreamingState" type="VideoStreamingState" mandatory="false" defvalue="STREAMABLE" since="5.0"> - <description> - See VideoStreamingState. - If it is NOT_STREAMABLE, the app must stop streaming video to SDL Core(stop service). - </description> - </param> - <param name="windowID" type="Integer" mandatory="false" since="6.0"> - <description> - This is the unique ID assigned to the window that this RPC is intended. If this param is not included, it will be assumed that this request is specifically for the main window on the main display. See PredefinedWindows enum. - </description> - </param> - </function> - - <function name="OnAppInterfaceUnregistered" functionID="OnAppInterfaceUnregisteredID" messagetype="notification" since="1.0"> - <param name="reason" type="AppInterfaceUnregisteredReason" mandatory="true"> - <description>See AppInterfaceUnregisteredReason</description> - </param> - </function> - - <function name="OnButtonEvent" functionID="OnButtonEventID" messagetype="notification" since="1.0"> - <description>Notifies application of UP/DOWN events for buttons to which the application is subscribed.</description> - <param name="buttonName" type="ButtonName" mandatory="true"/> - <param name="buttonEventMode" type="ButtonEventMode" mandatory="true"> - <description>Indicates whether this is an UP or DOWN event.</description> - </param> - <param name="customButtonID" type="Integer" minvalue="0" maxvalue="65536" mandatory="false" since="2.0"> - <description>If ButtonName is "CUSTOM_BUTTON", this references the integer ID passed by a custom button. (e.g. softButton ID)</description> - </param> - </function> - - <function name="OnButtonPress" functionID="OnButtonPressID" messagetype="notification" since="1.0"> - <description>Notifies application of LONG/SHORT press events for buttons to which the application is subscribed.</description> - <param name="buttonName" type="ButtonName" mandatory="true"/> - <param name="buttonPressMode" type="ButtonPressMode" mandatory="true"> - <description>Indicates whether this is a LONG or SHORT button press event.</description> - </param> - <param name="customButtonID" type="Integer" minvalue="0" maxvalue="65536" mandatory="false" since="2.0"> - <description>If ButtonName is "CUSTOM_BUTTON", this references the integer ID passed by a custom button. (e.g. softButton ID)</description> - </param> - </function> - - <function name="OnVehicleData" functionID="OnVehicleDataID" messagetype="notification" since="2.0"> - <description>Callback for the periodic and non periodic vehicle data read function.</description> - <param name="gps" type="GPSData" mandatory="false"> - <description>See GPSData</description> - </param> - <param name="speed" type="Float" minvalue="0" maxvalue="700" mandatory="false"> - <description>The vehicle speed in kilometers per hour</description> - </param> - <param name="rpm" type="Integer" minvalue="0" maxvalue="20000" mandatory="false"> - <description>The number of revolutions per minute of the engine</description> - </param> - <param name="fuelLevel" type="Float" minvalue="-6" maxvalue="106" mandatory="false"> - <description>The fuel level in the tank (percentage)</description> - </param> - <param name="fuelLevel_State" type="ComponentVolumeStatus" mandatory="false"> - <description>The fuel level state</description> - </param> - <param name="instantFuelConsumption" type="Float" minvalue="0" maxvalue="25575" mandatory="false"> - <description>The instantaneous fuel consumption in microlitres</description> - </param> - <param name="fuelRange" type="FuelRange" minsize="0" maxsize="100" array="true" mandatory="false" since="5.0"> - <description>The estimate range in KM the vehicle can travel based on fuel level and consumption</description> - </param> - <param name="externalTemperature" type="Float" minvalue="-40" maxvalue="100" mandatory="false"> - <description>The external temperature in degrees celsius</description> - </param> - <param name="turnSignal" type="TurnSignal" mandatory="false" since="5.0"> - <description>See TurnSignal</description> - </param> - <param name="vin" type="String" maxlength="17" mandatory="false"> - <description>Vehicle identification number.</description> - </param> - <param name="prndl" type="PRNDL" mandatory="false"> - <description>See PRNDL</description> - </param> - <param name="tirePressure" type="TireStatus" mandatory="false"> - <description>See TireStatus</description> - </param> - <param name="odometer" type="Integer" minvalue="0" maxvalue="17000000" mandatory="false"> - <description>Odometer in km</description> - </param> - <param name="beltStatus" type="BeltStatus" mandatory="false"> - <description>The status of the seat belts</description> - </param> - <param name="bodyInformation" type="BodyInformation" mandatory="false"> - <description>The body information including power modes</description> - </param> - <param name="deviceStatus" type="DeviceStatus" mandatory="false"> - <description>The device status including signal and battery strength</description> - </param> - <param name="driverBraking" type="VehicleDataEventStatus" mandatory="false"> - <description>The status of the brake pedal</description> - </param> - <param name="wiperStatus" type="WiperStatus" mandatory="false"> - <description>The status of the wipers</description> - </param> - <param name="headLampStatus" type="HeadLampStatus" mandatory="false"> - <description>Status of the head lamps</description> - </param> - <param name="engineTorque" type="Float" minvalue="-1000" maxvalue="2000" mandatory="false"> - <description>Torque value for engine (in Nm) on non-diesel variants</description> - </param> - <param name="accPedalPosition" type="Float" minvalue="0" maxvalue="100" mandatory="false"> - <description>Accelerator pedal position (percentage depressed)</description> - </param> - <param name="steeringWheelAngle" type="Float" minvalue="-2000" maxvalue="2000" mandatory="false"> - <description>Current angle of the steering wheel (in deg)</description> - </param> - <param name="engineOilLife" type="Float" minvalue="0" maxvalue="100" mandatory="false" since="5.0"> - <description>The estimated percentage of remaining oil life of the engine.</description> - </param> - <param name="electronicParkBrakeStatus" type="ElectronicParkBrakeStatus" mandatory="false" since="5.0"> - <description>The status of the park brake as provided by Electric Park Brake (EPB) system.</description> - </param> - <param name="cloudAppVehicleID" type="String" mandatory="false" since="5.1"> - <description>Parameter used by cloud apps to identify a head unit</description> - </param> - <param name="eCallInfo" type="ECallInfo" mandatory="false"> - <description>Emergency Call notification and confirmation data</description> - </param> - <param name="airbagStatus" type="AirbagStatus" mandatory="false"> - <description>The status of the air bags</description> - </param> - <param name="emergencyEvent" type="EmergencyEvent" mandatory="false"> - <description>Information related to an emergency event (and if it occurred)</description> - </param> - <param name="clusterModeStatus" type="ClusterModeStatus" mandatory="false"> - <description>The status modes of the cluster</description> - </param> - <param name="myKey" type="MyKey" mandatory="false"> - <description>Information related to the MyKey feature</description> - </param> - - - </function> - - <function name="OnCommand" functionID="OnCommandID" messagetype="notification" since="1.0"> - <param name="cmdID" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="true"> - <description>Command ID, which is related to a specific menu entry</description> - </param> - - <param name="triggerSource" type="TriggerSource" mandatory="true"> - <description>See TriggerSource</description> - </param> - </function> - - <function name="OnTBTClientState" functionID="OnTBTClientStateID" messagetype="notification" since="1.0"> - <description>Provides applications with notifications specific to the current TBT client status on the module</description> - <param name="state" type="TBTState" mandatory="true"> - <description>Current State of TBT client</description> - </param> - </function> - - <function name="OnDriverDistraction" functionID="OnDriverDistractionID" messagetype="notification" since="1.0"> - <description>Provides driver distraction state to mobile applications</description> - <param name="state" type="DriverDistractionState" mandatory="true"> - <description>Current State of Driver Distraction</description> - </param> - <param name="lockScreenDismissalEnabled" type="Boolean" mandatory="false" since="6.0"> - <description> - If enabled, the lock screen will be able to be dismissed while connected to SDL, allowing users - the ability to interact with the app. Dismissals should include a warning to the user and ensure - that they are not the driver. - </description> - </param> - <param name="lockScreenDismissalWarning" type="String" mandatory="false" since="6.0"> - <description> - Warning message to be displayed on the lock screen when dismissal is enabled. - This warning should be used to ensure that the user is not the driver of the vehicle, - ex. `Swipe down to dismiss, acknowledging that you are not the driver.`. - This parameter must be present if "lockScreenDismissalEnabled" is set to true. - </description> - </param> - </function> - - <function name="OnPermissionsChange" functionID="OnPermissionsChangeID" messagetype="notification" since="2.0"> - <description>Provides update to app of which policy-table-enabled functions are available</description> - <param name="permissionItem" type="PermissionItem" minsize="0" maxsize="500" array="true" mandatory="true"> - <description>Change in permissions for a given set of RPCs</description> - </param> - <param name="requireEncryption" type="Boolean" mandatory="false" since="6.0"/> - </function> - - <function name="OnAudioPassThru" functionID="OnAudioPassThruID" messagetype="notification" since="2.0"> - <description>Binary data is in binary part of hybrid msg</description> - </function> - - <function name="OnLanguageChange" functionID="OnLanguageChangeID" messagetype="notification" since="2.0"> - <param name="language" type="Language" mandatory="true"> - <description>Current SDL voice engine (VR+TTS) language</description> - </param> - <param name="hmiDisplayLanguage" type="Language" mandatory="true"> - <description>Current display language</description> - </param> - </function> - - <function name="OnKeyboardInput" functionID="OnKeyboardInputID" messagetype="notification" since="3.0"> - - <description>On-screen keyboard event.</description> - <description>Can be full string or individual keypresses depending on keyboard mode.</description> - - <param name="event" type="KeyboardEvent" mandatory="true"> - <description>On-screen keyboard input data.</description> - </param> - - <param name="data" type="String" maxlength="500" mandatory="false"> - <description>On-screen keyboard input data.</description> - <description>For dynamic keypress events, this will be the current compounded string of entry text.</description> - <description>For entry submission events, this will be the full text entry (this will always return regardless of the mode).</description> - <description>For entry cancelled and entry aborted events, this data param will be omitted.</description> - </param> - - </function> - - <function name="OnTouchEvent" functionID="OnTouchEventID" messagetype="notification" since="3.0"> - <description>Notifies about touch events on the screen's prescribed area</description> - <param name="type" type="TouchType" mandatory="true"> - <description>The type of touch event.</description> - </param> - <param name="event" type="TouchEvent" mandatory="true" minsize="1" maxsize="10" array="true"> - <description>List of all individual touches involved in this event.</description> - </param> - </function> - - <function name="OnSystemRequest" functionID="OnSystemRequestID" messagetype="notification" since="3.0"> - <description> - An asynchronous request from the system for specific data from the device or the cloud or response to a request from the device or cloud - Binary data can be included in hybrid part of message for some requests (such as Authentication request responses) - </description> - <param name="requestType" type="RequestType" mandatory="true"> - <description>The type of system request.</description> - </param> - <param name="requestSubType" type="String" maxlength="255" mandatory="false" since="5.0"> - <description> - This parameter is filled for supporting OEM proprietary data exchanges. - </description> - </param> - <param name="url" type="String" maxlength="1000" mandatory="false"> - <description> - Optional URL for HTTP requests. - If blank, the binary data shall be forwarded to the app. - If not blank, the binary data shall be forwarded to the url with a provided timeout in seconds. - </description> - </param> - <param name="timeout" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="false"> - <description> - Optional timeout for HTTP requests - Required if a URL is provided - </description> - </param> - <param name="fileType" type="FileType" mandatory="false"> - <description>Optional file type (meant for HTTP file requests).</description> - </param> - <param name="offset" type="Integer" minvalue="0" maxvalue="100000000000" mandatory="false"> - <description>Optional offset in bytes for resuming partial data chunks</description> - </param> - <param name="length" type="Integer" minvalue="0" maxvalue="100000000000" mandatory="false"> - <description>Optional length in bytes for resuming partial data chunks</description> - </param> - </function> - - <function name="OnHashChange" functionID="OnHashChangeID" messagetype="notification" since="3.0"> - <description> - Notification containing an updated hashID which can be used over connection cycles (i.e. loss of connection, ignition cycles, etc.). - Sent after initial registration and subsequently after any change in the calculated hash of all persisted app data. - </description> - <param name="hashID" type="String" maxlength="100" mandatory="true"> - <description>Calculated hash ID to be referenced during RegisterAppInterface.</description> - </param> - </function> - - <function name="OnWayPointChange" functionID="OnWayPointChangeID" messagetype="notification" since="4.1"> - <description>Notification which provides the entire LocationDetails when there is a change to any waypoints or destination.</description> - <param name="wayPoints" type="LocationDetails" mandatory="true" array="true" minsize="1" maxsize="10"> - <description>See LocationDetails</description> - </param> - </function> - - <function name="OnInteriorVehicleData" functionID="OnInteriorVehicleDataID" messagetype="notification" since="4.5"> - <param name="moduleData" type="ModuleData" mandatory="true"> - </param> - </function> - - <function name="OnRCStatus" functionID="OnRCStatusID" messagetype="notification" since="5.0"> - <description>Issued by SDL to notify the application about remote control status change on SDL</description> - <param name="allowed" type="Boolean" mandatory="false"> - <description>If "true" - RC is allowed; if "false" - RC is disallowed.</description> - </param> - <param name="allocatedModules" type="ModuleData" minsize="0" maxsize="100" array="true" mandatory="true"> - <description>Contains a list (zero or more) of module types that are allocated to the application.</description> - </param> - <param name="freeModules" type="ModuleData" minsize="0" maxsize="100" array="true" mandatory="true"> - <description>Contains a list (zero or more) of module types that are free to access for the application.</description> - </param> - </function> - - <function name="OnAppServiceData" functionID="OnAppServiceDataID" messagetype="notification" since="5.1"> - <description>This notification includes the data that is updated from the specific service</description> - - <param name="serviceData" type="AppServiceData" mandatory="true"/> - </function> - - <function name="OnSystemCapabilityUpdated" functionID="OnSystemCapabilityUpdatedID" messagetype="notification" since="5.1"> - <description>A notification to inform the connected device that a specific system capability has changed.</description> - <param name="systemCapability" type="SystemCapability" mandatory="true"> - <description>The system capability that has been updated</description> - </param> - </function> - - <!-- ~~~~~~~~~~~~~~~~~~ --> - <!-- Ford Specific APIs --> - <!-- ~~~~~~~~~~~~~~~~~~ --> - - <function name="EncodedSyncPData" functionID="EncodedSyncPDataID" messagetype="request" since="1.0"> - <description> - Allows encoded data in the form of SyncP packets to be sent to the SYNC module. - Legacy / v1 Protocol implementation; use SyncPData instead. - *** DEPRECATED *** - </description> - - <param name="data" type="String" maxlength="1000000" minsize="1" maxsize="100" array="true" mandatory="true"> - <description>Contains base64 encoded string of SyncP packets.</description> - <todo>What is the maxlength?</todo> - </param> - </function> - - <function name="EncodedSyncPData" functionID="EncodedSyncPDataID" messagetype="response" since="1.0"> - <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"/> - </param> - - <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> - <description>Provides additional human readable info regarding the result.</description> - </param> - </function> - - <!-- Deprecating - covered by SystemRequest - <function name="SyncPData" functionID="SyncPDataID" messagetype="request" > - <description> - Allows binary data in the form of SyncP packets to be sent to the SYNC module. - Binary data is in binary part of hybrid msg. - </description> - </function> - - <function name="SyncPData" functionID="SyncPDataID" messagetype="response" > - <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"/> - </param> - - <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> - <description>Provides additional human readable info regarding the result.</description> - </param> - </function> - --> - - <function name="OnEncodedSyncPData" functionID="OnEncodedSyncPDataID" messagetype="notification" since="1.0"> - <description> - Callback including encoded data of any SyncP packets that SYNC needs to send back to the mobile device. - Legacy / v1 Protocol implementation; responds to EncodedSyncPData. - *** DEPRECATED *** - </description> - <param name="data" type="String" maxlength="1000000" minsize="1" maxsize="100" mandatory="true" array="true"> - <description>Contains base64 encoded string of SyncP packets.</description> - </param> - <param name="URL" type="String" maxlength="1000" mandatory="false"> - <description> - If blank, the SyncP data shall be forwarded to the app. - If not blank, the SyncP data shall be forwarded to the provided URL. - </description> - </param> - <param name="Timeout" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="false"> - <description> - If blank, the SyncP data shall be forwarded to the app. - If not blank, the SyncP data shall be forwarded with the provided timeout in seconds. - </description> - </param> - </function> - - - <!-- Deprecating - covered by OnSystemRequest - <function name="OnSyncPData" functionID="OnSyncPDataID" messagetype="notification" > - <description> - Callback including binary data of any SyncP packets that SYNC needs to send back to the mobile device. - Responds to SyncPData. - Binary data is in binary part of hybrid msg. - </description> - - <param name="URL" type="String" maxlength="1000" mandatory="false"> - <description> - If blank, the SyncP data shall be forwarded to the app. - If not blank, the SyncP data shall be forwarded to the provided URL. - </description> - </param> - <param name="Timeout" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="false"> - <description> - If blank, the SyncP data shall be forwarded to the app. - If not blank, the SyncP data shall be forwarded with the provided timeout in seconds. - </description> - </param> - - </function> - --> -</interface>
\ No newline at end of file diff --git a/android/sdl_android/src/androidTest/java/com/smartdevicelink/test/rpc/RPCConstructorsTests.java b/android/sdl_android/src/androidTest/java/com/smartdevicelink/test/rpc/RPCConstructorsTests.java deleted file mode 100644 index 64f22a673..000000000 --- a/android/sdl_android/src/androidTest/java/com/smartdevicelink/test/rpc/RPCConstructorsTests.java +++ /dev/null @@ -1,339 +0,0 @@ -package com.smartdevicelink.test.rpc; - - -import androidx.test.ext.junit.runners.AndroidJUnit4; - -import org.junit.Before; -import org.junit.Test; -import org.junit.runner.RunWith; -import org.xmlpull.v1.XmlPullParser; -import org.xmlpull.v1.XmlPullParserException; -import org.xmlpull.v1.XmlPullParserFactory; - -import java.io.IOException; -import java.io.InputStream; -import java.lang.reflect.Constructor; -import java.lang.reflect.InvocationTargetException; -import java.lang.reflect.Method; -import java.lang.reflect.Type; -import java.util.ArrayList; -import java.util.Arrays; -import java.util.HashMap; -import java.util.List; -import java.util.Map; -import static androidx.test.platform.app.InstrumentationRegistry.getInstrumentation; -import static junit.framework.TestCase.assertTrue; - -/** - * This is a unit test class for the SmartDeviceLink library project - * It makes sure that for each RPC, all mandatory parameters are set in a constructor - */ - -@RunWith(AndroidJUnit4.class) -public class RPCConstructorsTests { - - private final String XML_FILE_NAME = "xml/MOBILE_API.xml"; - private final String RPC_PACKAGE_PREFIX = "com.smartdevicelink.proxy.rpc."; - private Map<String, List<Parameter>> rpcMandatoryParamsMapFromXml; - - private class Parameter { - private String name; - private String type; - private boolean isArray; - - public Parameter(String name, String type, boolean isArray) { - this.name = name; - this.type = type; - this.isArray = isArray; - } - } - - @Before - public void setUp(){ - // Map that has keys correspond to the RPC names and values correspond to the - // mandatory params for that RPC. All info are loaded from the RPC spec xml file - rpcMandatoryParamsMapFromXml = getRPCMandatoryParamsMap(XML_FILE_NAME); - - } - - // This method parses the RPC spec xml file and returns a map that has - // keys correspond to the RPC names and values correspond to the mandatory params for that RPC - private Map<String, List<Parameter>> getRPCMandatoryParamsMap(String fileName) { - Map<String, List<Parameter>> rpcMandatoryParamsMap = new HashMap<>(); - try { - InputStream stream = getInstrumentation().getTargetContext().getAssets().open(fileName); - XmlPullParserFactory xmlFactoryObject = XmlPullParserFactory.newInstance(); - XmlPullParser myParser = xmlFactoryObject.newPullParser(); - myParser.setInput(stream, null); - int event = myParser.getEventType(); - String rpcName = null; - boolean ignoreRPC = false; - while (event != XmlPullParser.END_DOCUMENT) { - String name = myParser.getName(); - switch (event){ - case XmlPullParser.START_TAG: - // Store the RPC name in the map - if(name.equals("function") || name.equals("struct")){ - rpcName = myParser.getAttributeValue(null,"name"); - ignoreRPC = false; - if (name.equals("function") && myParser.getAttributeValue(null, "messagetype").equals("response") && !rpcName.contains("Response")){ - rpcName += "Response"; - } - - // -------------- Exceptional cases because of mismatch between the RPC spec and the Android code -------------- - if(rpcName.equals("SyncMsgVersion")){ - rpcName = "SdlMsgVersion"; - } else if(rpcName.equals("ShowConstantTBTResponse")){ - rpcName = "ShowConstantTbtResponse"; - } else if(rpcName.equals("OASISAddress")) { - rpcName = "OasisAddress"; - } else if(rpcName.equals("ShowConstantTBT")) { - rpcName = "ShowConstantTbt"; - } else if (rpcName.equals("EncodedSyncPData") || rpcName.equals("OnEncodedSyncPData") || rpcName.equals("EncodedSyncPDataResponse")){ - ignoreRPC = true; - } - // ------------------------------------------------------------------------------------------------------------- - - if (!ignoreRPC) { - rpcMandatoryParamsMap.put(rpcName, new ArrayList<Parameter>()); - } - } - // Store the mandatory params for the current RPC in the map - if(name.equals("param") && myParser.getAttributeValue(null, "until") == null && !ignoreRPC){ - boolean mandatory = Boolean.valueOf(myParser.getAttributeValue(null,"mandatory")); - if (mandatory) { - String paramName = myParser.getAttributeValue(null, "name"); - String paramType = myParser.getAttributeValue(null, "type"); - boolean paramIsArray = Boolean.valueOf(myParser.getAttributeValue(null, "array")); - - // -------------- Exceptional cases because of mismatch between the RPC spec and the Android code -------------- - if (paramType.equals("SyncMsgVersion")){ - paramType = "SdlMsgVersion"; - } else if (rpcName.equals("GPSData") && paramType.equals("Float")){ - paramType = "Double"; - } else if (rpcName.equals("TouchEvent") && paramType.equals("Integer") && paramIsArray){ - paramType = "Long"; - } - - if (paramName.equals("syncFileName")){ - paramName = "sdlFileName"; - } else if (paramName.equals("syncMsgVersion")){ - paramName = "sdlMsgVersion"; - } else if (paramName.equals("hmiPermissions")){ - paramName = "hMIPermissions"; - } else if (paramName.equals("resolution")){ - paramName = "imageResolution"; - } else if (paramName.equals("pressureTelltale")){ - paramName = "pressureTellTale"; - } - // ------------------------------------------------------------------------------------------------------------- - - Parameter param = new Parameter(paramName, paramType, paramIsArray); - rpcMandatoryParamsMap.get(rpcName).add(param); - } - } - break; - } - event = myParser.next(); - } - stream.close(); - } catch (IOException | XmlPullParserException e) { - e.printStackTrace(); - } - return rpcMandatoryParamsMap; - } - - // This method makes sure that for every RPC, there is a constructor that has all the mandatory params - // It also checks if there are RPC in the XML file that don't exist in the code - @Test - public void testMandatoryParamsMatch() { - // List of RPC names that don't have a constructor that has all mandatory params - List<String> rpcsWithInvalidConstructor = new ArrayList<>(); - - // List of the RPC names that couldn't be found in code - // potentially because of a mismatch between name in the RPC spec xml file and name in code - List<String> rpcsFromXmlNotFoundInCode = new ArrayList<>(); - - // Loop through all RPCs that were loaded from RPC spec XML file - // and make sure that every RPC has a constructor that has all mandatory params - for (String rpcName : rpcMandatoryParamsMapFromXml.keySet()) { - Class aClass; - try { - aClass = Class.forName(RPC_PACKAGE_PREFIX + rpcName); - } catch (ClassNotFoundException e) { - e.printStackTrace(); - rpcsFromXmlNotFoundInCode.add(rpcName); - continue; - } - List<String> mandatoryParamsListFromXML = new ArrayList<>(); - for (Parameter param : rpcMandatoryParamsMapFromXml.get(rpcName)) { - String type = param.type; - // If the param is a list of objects, the type should be like "List<Object>" - if (param.isArray){ - type = String.format("List<%s>", type); - } - mandatoryParamsListFromXML.add(type); - } - List<String> mandatoryParamsListFromCode = new ArrayList<>(); - boolean rpcHasValidConstructor = false; - for (Constructor constructor : aClass.getConstructors()){ - mandatoryParamsListFromCode.clear(); - for (Type paramType : constructor.getGenericParameterTypes()){ - String paramFullType = paramType.toString(); - String paramSimpleType; - - // If the param is a list of objects, the type should be like "List<Object>" - if (paramFullType.matches("java.util.List<.+>")) { - paramSimpleType = String.format("List<%s>", paramFullType.substring(paramFullType.lastIndexOf('.') + 1, paramFullType.length() - 1)); - } - // If the param is a simple object for example "java.lang.String", the type should be the last part "String" - else if (!paramFullType.contains(">")){ - paramSimpleType = paramFullType.substring(paramFullType.lastIndexOf('.') + 1, paramFullType.length()); - } - else { - paramSimpleType = paramFullType; - } - mandatoryParamsListFromCode.add(paramSimpleType); - } - if (mandatoryParamsListFromCode.containsAll(mandatoryParamsListFromXML) && mandatoryParamsListFromXML.containsAll(mandatoryParamsListFromCode)){ - rpcHasValidConstructor = true; - break; - } - } - if (!rpcHasValidConstructor){ - rpcsWithInvalidConstructor.add(rpcName); - } - } - assertTrue("The following RPCs were not found in the code: " + rpcsFromXmlNotFoundInCode, rpcsFromXmlNotFoundInCode.isEmpty()); - assertTrue("The following RPCs don't have a constructor that has all the mandatory params: " + rpcsWithInvalidConstructor, rpcsWithInvalidConstructor.isEmpty()); - } - - // This method makes sure that for every RPC, the constructor that has the mandatory params is setting the values correctly - @Test - public void testMandatoryParamsValues() { - // List of RPC names that have a constructor which is not settings the values for the mandatory params correctly - List<String> rpcsWithInvalidConstructor = new ArrayList<>(); - - // List of types that exist in java.lang.* - List<String> javaLangBuiltInTypes = Arrays.asList("String", "Integer", "Float", "Double", "Boolean"); - - // Loop through all RPCs that were loaded from RPC spec XML file - // and make sure that the constructor that has the mandatory params is setting the values correctly - for (String rpcName : rpcMandatoryParamsMapFromXml.keySet()) { - Class aClass; - try { - aClass = Class.forName(RPC_PACKAGE_PREFIX + rpcName); - } catch (ClassNotFoundException e) { - e.printStackTrace(); - continue; - } - - List<Parameter> parameters = rpcMandatoryParamsMapFromXml.get(rpcName); - List<Class<?>> mandatoryParamsTypes = new ArrayList<>(); - List<Object> mandatoryParamsValues = new ArrayList<>(); - - // Loop through all mandatory params for the current RPC - // and try to find the full Java type for each param - // also assign a value for each param from com.smartdevicelink.test.Test class - for (Parameter param : parameters) { - String typeString = null; - Class<?> type = null; - String valueString = null; - Object value = null; - - // Find the full Java type for the current param - try { - if (param.isArray) { - type = List.class; - } else { - if (javaLangBuiltInTypes.contains(param.type)){ - typeString = "java.lang." + param.type; - } else { - typeString = RPC_PACKAGE_PREFIX + param.type; - } - type = Class.forName(typeString); - } - - } catch (ClassNotFoundException e) { - // If the class was not found in the com.smartdevicelink.proxy.rpc package - // try to see if it can be found in com.smartdevicelink.proxy.rpc.enums package - typeString = RPC_PACKAGE_PREFIX + "enums." + param.type; - try { - type = Class.forName(typeString); - } catch (ClassNotFoundException e1) { - e1.printStackTrace(); - assertTrue("Type: " + typeString + " cannot be found for RPC: " + rpcName , false); - } - } - - - // Assign a value for the current param from com.smartdevicelink.test.Test based of the param type - try { - // --------------------------------------------- Exceptional cases --------------------------------------------- - // This case is exceptional because the setter changes the input if it is not all digits - if (rpcName.equals("DialNumber") && param.type.equals("String")){ - value = "5558675309"; - } - // ------------------------------------------------------------------------------------------------------------- - - if (value == null) { - valueString = "GENERAL_" + param.type.toUpperCase(); - if (param.isArray){ - valueString += "_LIST"; - } - value = Class.forName("com.smartdevicelink.test.TestValues").getDeclaredField(valueString).get(null); - } - - } catch (ClassNotFoundException | NoSuchFieldException | IllegalAccessException e) { - e.printStackTrace(); - assertTrue("Value: " + valueString + " cannot be found for RPC: " + rpcName + ". Make sure that you declared that value in com.smartdevicelink.test.Test" , false); - } - - mandatoryParamsTypes.add(type); - mandatoryParamsValues.add(value); - } - - - // Create an instance of the RPC object using the constructor that has all the mandatory params - Object instance = null; - try { - Constructor constructor = aClass.getConstructor(mandatoryParamsTypes.toArray(new Class<?>[mandatoryParamsTypes.size()])); - instance = constructor.newInstance(mandatoryParamsValues.toArray(new Object[mandatoryParamsValues.size()])); - } catch (NoSuchMethodException | IllegalAccessException | InstantiationException | InvocationTargetException e) { - e.printStackTrace(); - assertTrue("Constructor for RPC " + rpcName + " cannot be invoked. Make sure that the constructor parameters order and types are identical to the RPC specs", false); - } - - - // Loop through all getter methods for the instance and make sure that they are returning the expected values - if (instance != null) { - for (int i = 0; i < parameters.size(); i++) { - // Find the getter method name by taking the param name, capitalize the first letter, then add thw word "get" to the beginning - // for example if the param name is "buttonName" the method name will be "getButtonName" - String getterMethodName = "get" + parameters.get(i).name.substring(0, 1).toUpperCase() + parameters.get(i).name.substring(1); - - // --------------------------------------------- Exceptional cases --------------------------------------------- - if (rpcName.equals("CancelInteraction") && getterMethodName.equals("getFunctionID")){ - getterMethodName = "getInteractionFunctionID"; - } - // ------------------------------------------------------------------------------------------------------------- - - try { - Method getterMethod = aClass.getMethod(getterMethodName); - Object val = getterMethod.invoke(instance); - if (val == null || !val.equals(mandatoryParamsValues.get(i))) { - rpcsWithInvalidConstructor.add(rpcName); - break; - } - } catch (NoSuchMethodException | IllegalAccessException | InvocationTargetException e) { - e.printStackTrace(); - assertTrue("Method: " + getterMethodName + " cannot be found for RPC: " + rpcName + ". Make sure that the method exists and that the parameters order and types are identical to the RPC specs", false); - - } - } - } - } - - assertTrue("The following RPCs have a constructor that is not setting the mandatory params correctly: " + rpcsWithInvalidConstructor, rpcsWithInvalidConstructor.isEmpty()); - } -} diff --git a/android/sdl_android/src/androidTest/java/com/smartdevicelink/test/rpc/RPCGenericTests.java b/android/sdl_android/src/androidTest/java/com/smartdevicelink/test/rpc/RPCGenericTests.java new file mode 100644 index 000000000..88dfeb1c6 --- /dev/null +++ b/android/sdl_android/src/androidTest/java/com/smartdevicelink/test/rpc/RPCGenericTests.java @@ -0,0 +1,662 @@ +package com.smartdevicelink.test.rpc; + + +import androidx.test.ext.junit.runners.AndroidJUnit4; + +import com.smartdevicelink.proxy.rpc.enums.SystemCapabilityType; + +import org.junit.Before; +import org.junit.Test; +import org.junit.runner.RunWith; +import org.xmlpull.v1.XmlPullParser; +import org.xmlpull.v1.XmlPullParserException; +import org.xmlpull.v1.XmlPullParserFactory; + +import java.io.IOException; +import java.io.InputStream; +import java.lang.reflect.Constructor; +import java.lang.reflect.InvocationTargetException; +import java.lang.reflect.Method; +import java.lang.reflect.Type; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +import static androidx.test.platform.app.InstrumentationRegistry.getInstrumentation; +import static junit.framework.TestCase.assertNotNull; +import static junit.framework.TestCase.assertTrue; +import static junit.framework.TestCase.fail; + +@RunWith(AndroidJUnit4.class) +public class RPCGenericTests { + + private final String XML_FILE_NAME = "MOBILE_API.xml"; + private final String RPC_PACKAGE_PREFIX = "com.smartdevicelink.proxy.rpc."; + private final String TEST_VALUES_CLASS = "com.smartdevicelink.test.TestValues"; + private Map<String, List<Parameter>> rpcMandatoryParamsMapFromXml; + private Map<String, List<Parameter>> rpcAllParamsMapFromXml; + + private class Parameter { + private String rpcName; + private String name; + private String type; + private Class<?> javaType; + private boolean isArray; + private boolean isMandatory; + private String setterName; + private String getterName1; + private String getterName2; + private Object value; + private boolean skip; + + + public Parameter setRPCName(String rpcName) { + this.rpcName = rpcName; + return this; + } + + public Parameter setName(String name) { + this.name = name; + return this; + } + + public Parameter setType(String type) { + this.type = type; + return this; + } + + public Parameter setJavaType(Class<?> javaType) { + this.javaType = javaType; + return this; + } + + public Parameter setArray(boolean array) { + isArray = array; + return this; + } + + public Parameter setMandatory(boolean mandatory) { + isMandatory = mandatory; + return this; + } + + public Parameter setSetterName(String setterName) { + this.setterName = setterName; + return this; + } + + public Parameter setGetterName1(String getterName1) { + this.getterName1 = getterName1; + return this; + } + + public Parameter setGetterName2(String getterName2) { + this.getterName2 = getterName2; + return this; + } + + public void setValue(Object value) { + this.value = value; + } + + public Parameter setSkip(boolean skip) { + this.skip = skip; + return this; + } + } + + @Before + public void setUp(){ + // Map that has keys correspond to the RPC names and values correspond to the params for that RPC. + rpcMandatoryParamsMapFromXml = getRPCParamsMap(XML_FILE_NAME, true); + rpcAllParamsMapFromXml = getRPCParamsMap(XML_FILE_NAME, false); + } + + // This method parses the RPC spec xml file and returns a map that has + // keys correspond to the RPC names and values correspond to the params for that RPC + private Map<String, List<Parameter>> getRPCParamsMap(String fileName, boolean includeMandatoryOnly) { + Map<String, List<Parameter>> rpcParamsMap = new HashMap<>(); + try { + InputStream stream = getInstrumentation().getTargetContext().getAssets().open(fileName); + XmlPullParserFactory xmlFactoryObject = XmlPullParserFactory.newInstance(); + XmlPullParser myParser = xmlFactoryObject.newPullParser(); + myParser.setInput(stream, null); + int event = myParser.getEventType(); + String rpcName = null; + boolean ignoreRPC = false; + String setterMethodName; + String getterMethodName1; + String getterMethodName2; + Class<?> javaParamType; + boolean skipParam; + while (event != XmlPullParser.END_DOCUMENT) { + String name = myParser.getName(); + switch (event){ + case XmlPullParser.START_TAG: + // Store the RPC name in the map + if(name.equals("function") || name.equals("struct")){ + rpcName = myParser.getAttributeValue(null,"name"); + ignoreRPC = false; + if (name.equals("function") && myParser.getAttributeValue(null, "messagetype").equals("response") && !rpcName.contains("Response")){ + rpcName += "Response"; + } + + // -------------- Exceptional cases because of mismatch between the RPC spec and the Android code -------------- + if(rpcName.equals("SyncMsgVersion")){ + rpcName = "SdlMsgVersion"; + } else if(rpcName.equals("ShowConstantTBTResponse")){ + rpcName = "ShowConstantTbtResponse"; + } else if(rpcName.equals("OASISAddress")) { + rpcName = "OasisAddress"; + } else if(rpcName.equals("ShowConstantTBT")) { + rpcName = "ShowConstantTbt"; + } else if (rpcName.equals("EncodedSyncPData") || rpcName.equals("OnEncodedSyncPData") || rpcName.equals("EncodedSyncPDataResponse")){ + ignoreRPC = true; + } + // ------------------------------------------------------------------------------------------------------------- + + if (!ignoreRPC) { + rpcParamsMap.put(rpcName, new ArrayList<Parameter>()); + } + } + // Store the params for the current RPC in the map + if(name.equals("param") && myParser.getAttributeValue(null, "until") == null && !ignoreRPC){ + setterMethodName = null; + getterMethodName1 = null; + getterMethodName2 = null; + javaParamType = null; + skipParam = false; + boolean isMandatory = Boolean.valueOf(myParser.getAttributeValue(null,"mandatory")); + if (isMandatory || !includeMandatoryOnly) { + String paramName = myParser.getAttributeValue(null, "name"); + String paramType = myParser.getAttributeValue(null, "type"); + boolean isArray = Boolean.valueOf(myParser.getAttributeValue(null, "array")); + + // -------------- Exceptional cases because of mismatch between the RPC spec and the Android code -------------- + if (paramName.equals("syncFileName")){ + paramName = "sdlFileName"; + } else if (paramName.equals("syncMsgVersion")){ + paramName = "sdlMsgVersion"; + } else if (paramName.equals("hmiPermissions")){ + paramName = "hMIPermissions"; + } else if (paramName.equals("resolution")){ + paramName = "imageResolution"; + } else if (paramName.equals("pressureTelltale")){ + paramName = "pressureTellTale"; + } + + setterMethodName = "set" + paramName.substring(0, 1).toUpperCase() + paramName.substring(1); + + if (paramType.equals("SyncMsgVersion")){ + paramType = "SdlMsgVersion"; + } else if (rpcName.equals("GPSData") && paramType.equals("Float")){ + paramType = "Double"; + } else if (rpcName.equals("TouchEvent") && paramType.equals("Integer") && isArray){ + paramType = "Long"; + } else if (paramType.equals("OASISAddress")) { + paramType = "OasisAddress"; + } else if (rpcName.equals("VideoStreamingCapability") && paramType.equals("Float")) { + paramType = "Double"; + } else if (rpcName.equals("UnsubscribeVehicleData") && setterMethodName.equals("setCloudAppVehicleID")) { + paramType = "boolean"; + } else if (rpcName.equals("CancelInteraction") && setterMethodName.equals("setFunctionID")) { + setterMethodName = "setInteractionFunctionID"; + } else if (rpcName.equals("NavigationCapability") && setterMethodName.equals("setGetWayPointsEnabled")) { + setterMethodName = "setWayPointsEnabled"; + } else if (rpcName.equals("UnsubscribeWayPointsResponse") && setterMethodName.equals("setGetWayPointsEnabled")) { + setterMethodName = "setWayPointsEnabled"; + } else if (rpcName.equals("HMICapabilities") && setterMethodName.equals("setNavigation")) { + setterMethodName = "setNavigationAvilable"; + } else if (rpcName.equals("HMICapabilities") && setterMethodName.equals("setPhoneCall")) { + setterMethodName = "setPhoneCallAvilable"; + } else if (rpcName.equals("HMICapabilities") && setterMethodName.equals("setDisplays")) { + setterMethodName = "setDisplaysCapabilityAvailable"; + } else if (rpcName.equals("HMICapabilities")) { + setterMethodName += "Available"; + } else if (rpcName.equals("VideoStreamingCapability") && setterMethodName.equals("setHapticSpatialDataSupported")) { + setterMethodName = "setIsHapticSpatialDataSupported"; + } else if (rpcName.equals("OnDriverDistraction") && setterMethodName.equals("setLockScreenDismissalEnabled")) { + setterMethodName = "setLockscreenDismissibility"; + paramType = "boolean"; + } else if (rpcName.equals("OnDriverDistraction") && setterMethodName.equals("setLockScreenDismissalWarning")) { + setterMethodName = "setLockscreenWarningMessage"; + } else if (rpcName.equals("PublishAppServiceResponse") && setterMethodName.equals("setAppServiceRecord")) { + setterMethodName = "setServiceRecord"; + } else if (setterMethodName.equals("setFuelLevel_State")) { + setterMethodName = "setFuelLevelState"; + } else if (rpcName.equals("LightCapabilities") && setterMethodName.equals("setRgbColorSpaceAvailable")) { + setterMethodName = "setRGBColorSpaceAvailable"; + } else if (rpcName.equals("CloudAppProperties") && setterMethodName.equals("setEnabled")) { + paramType = "boolean"; + } else if (rpcName.equals("DateTime") && setterMethodName.equals("setMillisecond")) { + setterMethodName = "setMilliSecond"; + } else if (rpcName.equals("DateTime") && setterMethodName.equals("setTz_hour")) { + setterMethodName = "setTzHour"; + } else if (rpcName.equals("DateTime") && setterMethodName.equals("setTz_minute")) { + setterMethodName = "setTzMinute"; + } else if (rpcName.equals("PutFile") && setterMethodName.equals("setCrc")) { + setterMethodName = "setCRC"; + paramType = "Long"; + } else if (rpcName.equals("AppServiceManifest") && setterMethodName.equals("setHandledRPCs")) { + setterMethodName = "setHandledRpcs"; + } else if (rpcName.equals("LocationDetails") && setterMethodName.equals("setHandledRPCs")) { + setterMethodName = "setHandledRpcs"; + } else if (rpcName.equals("SendLocation") && setterMethodName.equals("setLongitudeDegrees")) { + paramType = "Double"; + } else if (rpcName.equals("SendLocation") && setterMethodName.equals("setLatitudeDegrees")) { + paramType = "Double"; + } else if (rpcName.equals("Grid") && setterMethodName.equals("setColspan")) { + setterMethodName = "setColSpan"; + } else if (rpcName.equals("Grid") && setterMethodName.equals("setRowspan")) { + setterMethodName = "setRowSpan"; + } else if (rpcName.equals("Grid") && setterMethodName.equals("setLevelspan")) { + setterMethodName = "setLevelSpan"; + } else if (rpcName.equals("HeadLampStatus") && setterMethodName.equals("setAmbientLightSensorStatus")) { + setterMethodName = "setAmbientLightStatus"; + } else if (rpcName.equals("GetVehicleData") && setterMethodName.equals("setCloudAppVehicleID")) { + paramType = "boolean"; + } else if (rpcName.equals("GetVehicleDataResponse") && Arrays.asList("setInstantFuelConsumption", "setFuelLevel", "setSpeed", "setExternalTemperature", "setEngineTorque", "setAccPedalPosition", "setSteeringWheelAngle").contains(setterMethodName)) { + paramType = "Double"; + } else if (rpcName.equals("RdsData") && setterMethodName.equals("setPS")) { + setterMethodName = "setProgramService"; + } else if (rpcName.equals("RdsData") && setterMethodName.equals("setCT")) { + setterMethodName = "setClockText"; + } else if (rpcName.equals("RdsData") && setterMethodName.equals("setRT")) { + setterMethodName = "setRadioText"; + } else if (rpcName.equals("RdsData") && setterMethodName.equals("setPI")) { + setterMethodName = "setProgramIdentification"; + } else if (rpcName.equals("RdsData") && setterMethodName.equals("setPTY")) { + setterMethodName = "setProgramType"; + } else if (rpcName.equals("RdsData") && setterMethodName.equals("setTP")) { + setterMethodName = "setTrafficProgram"; + } else if (rpcName.equals("RdsData") && setterMethodName.equals("setTA")) { + setterMethodName = "setTrafficAnnouncement"; + } else if (rpcName.equals("RdsData") && setterMethodName.equals("setREG")) { + setterMethodName = "setRegion"; + } else if (rpcName.equals("RadioControlCapabilities") && setterMethodName.equals("setSiriusxmRadioAvailable")) { + setterMethodName = "setSiriusXMRadioAvailable"; + } else if (rpcName.equals("GetCloudAppPropertiesResponse") && setterMethodName.equals("setProperties")) { + setterMethodName = "setCloudAppProperties"; + } else if (rpcName.equals("GetFileResponse") && setterMethodName.equals("setCrc")) { + setterMethodName = "setCRC"; + } else if (rpcName.equals("RegisterAppInterfaceResponse") && setterMethodName.equals("setPcmStreamCapabilities")) { + setterMethodName = "setPcmStreamingCapabilities"; + } else if (rpcName.equals("SubscribeVehicleData") && setterMethodName.equals("setElectronicParkBrakeStatus")) { + paramType = "boolean"; + } else if (rpcName.equals("SubscribeVehicleData") && setterMethodName.equals("setCloudAppVehicleID")) { + paramType = "boolean"; + } else if (rpcName.equals("ModuleInfo") && setterMethodName.equals("setLocation")) { + setterMethodName = "setModuleLocation"; + } else if (rpcName.equals("ModuleInfo") && setterMethodName.equals("setServiceArea")) { + setterMethodName = "setModuleServiceArea"; + } else if (rpcName.equals("ModuleInfo") && setterMethodName.equals("setAllowMultipleAccess")) { + setterMethodName = "setMultipleAccessAllowance"; + } else if (rpcName.equals("OnVehicleData") && setterMethodName.equals("setSpeed")) { + paramType = "Double"; + } else if (rpcName.equals("OnVehicleData") && setterMethodName.equals("setFuelLevel")) { + paramType = "Double"; + } else if (rpcName.equals("OnVehicleData") && setterMethodName.equals("setInstantFuelConsumption")) { + paramType = "Double"; + } else if (rpcName.equals("OnVehicleData") && setterMethodName.equals("setExternalTemperature")) { + paramType = "Double"; + } else if (rpcName.equals("OnVehicleData") && setterMethodName.equals("setEngineTorque")) { + paramType = "Double"; + } else if (rpcName.equals("OnVehicleData") && setterMethodName.equals("setAccPedalPosition")) { + paramType = "Double"; + } else if (rpcName.equals("OnVehicleData") && setterMethodName.equals("setSteeringWheelAngle")) { + paramType = "Double"; + } else if (rpcName.equals("GetInteriorVehicleDataConsentResponse") && setterMethodName.equals("setAllowed")) { + setterMethodName = "setAllowances"; + } else if (rpcName.equals("SeatLocationCapability") && setterMethodName.equals("setColumns")) { + setterMethodName = "setCols"; + } else if (rpcName.equals("ShowConstantTbt") && setterMethodName.equals("setDistanceToManeuver")) { + paramType = "Double"; + } else if (rpcName.equals("ShowConstantTbt") && setterMethodName.equals("setDistanceToManeuverScale")) { + paramType = "Double"; + } else if (rpcName.equals("SingleTireStatus") && setterMethodName.equals("setTpms")) { + setterMethodName = "setTPMS"; + } else if (rpcName.equals("VehicleDataResult") && setterMethodName.equals("setOemCustomDataType")) { + setterMethodName = "setOEMCustomVehicleDataType"; + } else if (rpcName.equals("SystemCapability") && !setterMethodName.equals("setSystemCapabilityType")) { + setterMethodName = "setCapabilityForType"; + paramType = "SystemCapabilityType"; + } else if (rpcName.equals("UnsubscribeWayPointsResponse") && paramName.equals("wayPoints")) { + skipParam = true; + } else if (rpcName.equals("UnsubscribeVehicleDataResponse") && paramName.equals("clusterModes")) { + skipParam = true; + } else if (rpcName.equals("ClimateControlCapabilities") && paramName.equals("currentTemperatureAvailable")) { + skipParam = true; + } else if (rpcName.equals("SubscribeVehicleDataResponse") && paramName.equals("clusterModes")) { + skipParam = true; + } + + // ------------------------------------------------------------------------------------------------------------- + + javaParamType = findJavaTypeForParam(paramType, isArray); + getterMethodName1 = "get" + setterMethodName.substring(3); + if (paramType.equalsIgnoreCase("boolean")) { + getterMethodName2 = "is" + setterMethodName.substring(3); + } + + Parameter param = new Parameter() + .setRPCName(rpcName) + .setName(paramName) + .setType(paramType) + .setJavaType(javaParamType) + .setArray(isArray) + .setMandatory(isMandatory) + .setSkip(skipParam) + .setSetterName(setterMethodName) + .setGetterName1(getterMethodName1) + .setGetterName2(getterMethodName2) + ; + + rpcParamsMap.get(rpcName).add(param); + } + } + break; + } + event = myParser.next(); + } + stream.close(); + } catch (IOException | XmlPullParserException e) { + fail("Cannot parse mobile APIs XML file: " + e.getMessage()); + } + return rpcParamsMap; + } + + // This method makes sure that for every RPC, there is a constructor that has all the mandatory params + // It also checks if there are RPC in the XML file that don't exist in the code + @Test + public void testMandatoryParamsMatch() { + // List of RPC names that don't have a constructor that has all mandatory params + List<String> rpcsWithInvalidConstructor = new ArrayList<>(); + + // List of the RPC names that couldn't be found in code + // potentially because of a mismatch between name in the RPC spec xml file and name in code + List<String> rpcsFromXmlNotFoundInCode = new ArrayList<>(); + + // Loop through all RPCs that were loaded from RPC spec XML file + // and make sure that every RPC has a constructor that has all mandatory params + for (String rpcName : rpcMandatoryParamsMapFromXml.keySet()) { + Class aClass; + try { + aClass = Class.forName(RPC_PACKAGE_PREFIX + rpcName); + } catch (ClassNotFoundException e) { + e.printStackTrace(); + rpcsFromXmlNotFoundInCode.add(rpcName); + continue; + } + List<String> mandatoryParamsListFromXML = new ArrayList<>(); + for (Parameter param : rpcMandatoryParamsMapFromXml.get(rpcName)) { + String type = param.type; + // If the param is a list of objects, the type should be like "List<Object>" + if (param.isArray){ + type = String.format("List<%s>", type); + } + mandatoryParamsListFromXML.add(type); + } + List<String> mandatoryParamsListFromCode = new ArrayList<>(); + boolean rpcHasValidConstructor = false; + for (Constructor constructor : aClass.getConstructors()){ + mandatoryParamsListFromCode.clear(); + for (Type paramType : constructor.getGenericParameterTypes()){ + String paramFullType = paramType.toString(); + String paramSimpleType; + + // If the param is a list of objects, the type should be like "List<Object>" + if (paramFullType.matches("java.util.List<.+>")) { + paramSimpleType = String.format("List<%s>", paramFullType.substring(paramFullType.lastIndexOf('.') + 1, paramFullType.length() - 1)); + } + // If the param is a simple object for example "java.lang.String", the type should be the last part "String" + else if (!paramFullType.contains(">")){ + paramSimpleType = paramFullType.substring(paramFullType.lastIndexOf('.') + 1, paramFullType.length()); + } + else { + paramSimpleType = paramFullType; + } + mandatoryParamsListFromCode.add(paramSimpleType); + } + if (mandatoryParamsListFromCode.containsAll(mandatoryParamsListFromXML) && mandatoryParamsListFromXML.containsAll(mandatoryParamsListFromCode)){ + rpcHasValidConstructor = true; + break; + } + } + if (!rpcHasValidConstructor){ + rpcsWithInvalidConstructor.add(rpcName); + } + } + assertTrue("The following RPCs were not found in the code: " + rpcsFromXmlNotFoundInCode, rpcsFromXmlNotFoundInCode.isEmpty()); + assertTrue("The following RPCs don't have a constructor that has all the mandatory params: " + rpcsWithInvalidConstructor, rpcsWithInvalidConstructor.isEmpty()); + } + + // This method returns the correct java reflection method in a specific class + private Method getMethod(Class aClass, Parameter parameter, String methodName, boolean isGetter) throws NoSuchMethodException { + Method method = null; + if (methodName == null) { + throw new NoSuchMethodException(); + } + if (isGetter) { + if (parameter.rpcName.equals("SystemCapability") && !methodName.contains("SystemCapabilityType")) { + method = aClass.getMethod(methodName, SystemCapabilityType.class); + } else { + method = aClass.getMethod(methodName); + } + } else { + if (parameter.rpcName.equals("SystemCapability") && !methodName.contains("SystemCapabilityType")) { + method = aClass.getMethod(methodName, SystemCapabilityType.class, Object.class); + } else { + method = aClass.getMethod(methodName, parameter.javaType); + } + } + return method; + } + + // This method returns the full Java type for a param + private Class<?> findJavaTypeForParam(String type, boolean isArray) { + String typeString = null; + Class<?> javaType = null; + + // List of types that exist in java.lang.* + List<String> javaLangBuiltInTypes = Arrays.asList("String", "Integer", "Long", "Float", "Double", "Boolean"); + + // List of primitive types in java + List<String> javaLangPrimitiveTypes = Arrays.asList("int", "long", "float", "double", "boolean"); + + // Find the full Java type for the current param + try { + if (isArray) { + javaType = List.class; + } else if (javaLangPrimitiveTypes.contains(type)) { + if (type.equals("int")) { + javaType = int.class; + } else if (type.equals("long")) { + javaType = long.class; + } else if (type.equals("float")) { + javaType = float.class; + } else if (type.equals("double")) { + javaType = double.class; + } else if (type.equals("boolean")) { + javaType = boolean.class; + } + } else { + if (javaLangBuiltInTypes.contains(type)) { + typeString = "java.lang." + type; + } else { + typeString = RPC_PACKAGE_PREFIX + type; + } + javaType = Class.forName(typeString); + } + + } catch (ClassNotFoundException e) { + // If the class was not found in the rpc package + // try to see if it can be found in enums package + typeString = RPC_PACKAGE_PREFIX + "enums." + type; + try { + javaType = Class.forName(typeString); + } catch (ClassNotFoundException e1) { + e1.printStackTrace(); + } + } + assertNotNull("Java type cannot be found for: " + type, javaType); + return javaType; + } + + // This method makes sure that for every RPC, the constructor that has the mandatory params is setting the values correctly + @Test + public void testMandatoryParamsValues() { + // List of RPC names that have a constructor which is not settings the values for the mandatory params correctly + List<String> rpcsWithInvalidConstructor = new ArrayList<>(); + + // Loop through all RPCs that were loaded from RPC spec XML file + // and make sure that the constructor that has the mandatory params is setting the values correctly + for (String rpcName : rpcMandatoryParamsMapFromXml.keySet()) { + Class aClass; + try { + aClass = Class.forName(RPC_PACKAGE_PREFIX + rpcName); + } catch (ClassNotFoundException e) { + fail(e.getMessage()); + continue; + } + + List<Parameter> parameters = rpcMandatoryParamsMapFromXml.get(rpcName); + List<Class<?>> mandatoryParamsTypes = new ArrayList<>(); + List<Object> mandatoryParamsValues = new ArrayList<>(); + + // Loop through all mandatory params for the current RPC + // and try to find the full Java type for each param + // also assign a value for each param from TestValues class + for (Parameter param : parameters) { + String valueString = null; + Object value = null; + + // Assign a value for the current param from TestValues based of the param type + try { + // --------------------------------------------- Exceptional cases --------------------------------------------- + // This case is exceptional because the setter changes the input if it is not all digits + if (rpcName.equals("DialNumber") && param.type.equals("String")){ + value = "5558675309"; + } + // ------------------------------------------------------------------------------------------------------------- + + if (value == null) { + valueString = "GENERAL_" + param.type.toUpperCase(); + if (param.isArray){ + valueString += "_LIST"; + } + value = Class.forName(TEST_VALUES_CLASS).getDeclaredField(valueString).get(null); + } + + } catch (ClassNotFoundException | NoSuchFieldException | IllegalAccessException e) { + e.printStackTrace(); + fail("Value: " + valueString + " cannot be found for RPC: " + rpcName + ". Make sure that you declared that value in " + TEST_VALUES_CLASS); + } + + mandatoryParamsTypes.add(param.javaType); + mandatoryParamsValues.add(value); + } + + + // Create an instance of the RPC object using the constructor that has all the mandatory params + Object instance = null; + try { + Constructor constructor = aClass.getConstructor(mandatoryParamsTypes.toArray(new Class<?>[mandatoryParamsTypes.size()])); + instance = constructor.newInstance(mandatoryParamsValues.toArray(new Object[mandatoryParamsValues.size()])); + } catch (NoSuchMethodException | IllegalAccessException | InstantiationException | InvocationTargetException e) { + e.printStackTrace(); + fail("Constructor for RPC " + rpcName + " cannot be invoked. Make sure that the constructor parameters order and types are identical to the RPC specs"); + } + + + // Loop through all getter methods for the instance and make sure that they are returning the expected values + if (instance != null) { + for (int i = 0; i < parameters.size(); i++) { + try { + Method getterMethod = getMethod(aClass, parameters.get(i), parameters.get(i).getterName1, true); + Object val = getterMethod.invoke(instance); + if (val == null || !val.equals(mandatoryParamsValues.get(i))) { + rpcsWithInvalidConstructor.add(rpcName); + break; + } + } catch (NoSuchMethodException | IllegalAccessException | InvocationTargetException e) { + e.printStackTrace(); + fail("Method: " + parameters.get(i).getterName1 + " cannot be found for RPC: " + rpcName + ". Make sure that the method exists and that the parameters order and types are identical to the RPC specs"); + } + } + } + } + + assertTrue("The following RPCs have a constructor that is not setting the mandatory params correctly: " + rpcsWithInvalidConstructor, rpcsWithInvalidConstructor.isEmpty()); + } + + /** + * This method makes sure that for every param in every RPC: + * - A setter exists and its name matches the RPC spec + * - The setter return type matches the RPC type (to make RPCs chainable) + * - A getter exists and its name matches the RPC spec + */ + @Test + public void testParamsSettersAndGetters() { + List<String> errors = new ArrayList<>(); + + // Loop through all RPCs that were loaded from RPC spec XML file + for (String rpcName : rpcAllParamsMapFromXml.keySet()) { + Class aClass; + try { + aClass = Class.forName(RPC_PACKAGE_PREFIX + rpcName); + } catch (ClassNotFoundException e) { + e.printStackTrace(); + errors.add("Class not found for rpc: "+ rpcName + ". \n"); + continue; + } + + // Loop through all params for the current RPC and make sure everyone has a a setter and a getter + List<Parameter> parameters = rpcAllParamsMapFromXml.get(rpcName); + for (int i = 0; i < parameters.size(); i++) { + Parameter parameter = parameters.get(i); + if (parameter.skip) { + continue; + } + + // Confirm that the setter is correct + try { + Method setterMethod = getMethod(aClass, parameter, parameter.setterName, false); + List<String> expectedReturnTypes = Arrays.asList(aClass.getName(), aClass.getSuperclass().getName()); + String actualReturnType = setterMethod.getReturnType().getName(); + if (!expectedReturnTypes.contains(actualReturnType)) { + String errMsg = rpcName + "." + parameter.setterName + "() is expected to return one of these types: " + expectedReturnTypes + " but it returns: " + actualReturnType + ". \n"; + errors.add(errMsg); + } + } catch (NoSuchMethodException e) { + String errMsg = rpcName + "." + parameter.setterName + "(" + parameter.type + ")" + " cannot be found. Make sure that the method exists. \n"; + errors.add(errMsg); + } + + // Confirm that the getter is correct + Method getterMethod = null; + try { + // --------------------------------------------- Exceptional cases --------------------------------------------- + if (parameter.getterName1.contains("Avilable")) { + continue; + } else if (parameter.getterName1.equals("getSeats")) { + parameter.getterName1 = "getSeatLocations"; + } + // ------------------------------------------------------------------------------------------------------------- + getterMethod = getMethod(aClass, parameter, parameter.getterName1, true); + } catch (NoSuchMethodException e) { + try { + getterMethod = getMethod(aClass, parameter, parameter.getterName2, true); + } catch (NoSuchMethodException ex) { + ex.printStackTrace(); + String errMsg = String.format(rpcName + "." + parameter.getterName1 + "()" + "%s" + " cannot be found. Make sure that the method exists. \n", parameter.type.equalsIgnoreCase("boolean")? "/" + parameter.getterName2 + "()" : ""); + errors.add(errMsg); + } + } + } + } + + assertTrue("There are " + errors.size() + " errors: \n" + errors, errors.isEmpty()); + } +} diff --git a/base/src/main/java/com/smartdevicelink/proxy/RPCMessage.java b/base/src/main/java/com/smartdevicelink/proxy/RPCMessage.java index ac0d11506..427379842 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/RPCMessage.java +++ b/base/src/main/java/com/smartdevicelink/proxy/RPCMessage.java @@ -100,8 +100,9 @@ public class RPCMessage extends RPCStruct { return (String)function.get(KEY_FUNCTION_NAME);
}
- protected void setFunctionName(String functionName) {
+ protected RPCMessage setFunctionName(String functionName) {
function.put(KEY_FUNCTION_NAME, functionName);
+ return this;
}
public String getMessageType() {
@@ -115,12 +116,13 @@ public class RPCMessage extends RPCStruct { // Generalized Getters and Setters
- public void setParameters(String key, Object value) {
+ public RPCMessage setParameters(String key, Object value) {
if (value != null) {
parameters.put(key, value);
} else {
parameters.remove(key);
}
+ return this;
}
public Object getParameters(String key) {
diff --git a/base/src/main/java/com/smartdevicelink/proxy/RPCRequest.java b/base/src/main/java/com/smartdevicelink/proxy/RPCRequest.java index 22ce1c2a5..7dc9de1d3 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/RPCRequest.java +++ b/base/src/main/java/com/smartdevicelink/proxy/RPCRequest.java @@ -1,34 +1,34 @@ -/* - * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this - * list of conditions and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following - * disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its - * contributors may be used to endorse or promote products derived from this - * software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ +/*
+ * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
package com.smartdevicelink.proxy;
import com.smartdevicelink.proxy.rpc.listeners.OnRPCResponseListener;
@@ -64,15 +64,17 @@ public class RPCRequest extends RPCMessage { return (Integer)function.get(RPCMessage.KEY_CORRELATION_ID);
}
- public void setCorrelationID(Integer correlationID) {
+ public RPCRequest setCorrelationID(Integer correlationID) {
if (correlationID != null) {
function.put(RPCMessage.KEY_CORRELATION_ID, correlationID );
} else {
function.remove(RPCMessage.KEY_CORRELATION_ID);
}
+ return this;
}
- public void setOnRPCResponseListener(OnRPCResponseListener listener){
+ public RPCRequest setOnRPCResponseListener(OnRPCResponseListener listener){
onResponseListener = listener;
+ return this;
}
public OnRPCResponseListener getOnRPCResponseListener(){
diff --git a/base/src/main/java/com/smartdevicelink/proxy/RPCResponse.java b/base/src/main/java/com/smartdevicelink/proxy/RPCResponse.java index 771ccfe7c..b0a3549dc 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/RPCResponse.java +++ b/base/src/main/java/com/smartdevicelink/proxy/RPCResponse.java @@ -1,34 +1,34 @@ -/* - * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this - * list of conditions and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following - * disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its - * contributors may be used to endorse or promote products derived from this - * software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ +/*
+ * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
package com.smartdevicelink.proxy;
import androidx.annotation.NonNull;
@@ -126,12 +126,13 @@ public class RPCResponse extends RPCMessage { * @param correlationID
* the ID of the response
*/
- public void setCorrelationID(Integer correlationID) {
+ public RPCResponse setCorrelationID(Integer correlationID) {
if (correlationID != null) {
function.put(RPCMessage.KEY_CORRELATION_ID, correlationID );
} else {
function.remove(RPCMessage.KEY_CORRELATION_ID);
}
+ return this;
}
/**
* <p>
@@ -151,10 +152,11 @@ public class RPCResponse extends RPCMessage { * @param success
* whether the request is successfully processed
*/
- public void setSuccess( @NonNull Boolean success ) {
+ public RPCResponse setSuccess( @NonNull Boolean success ) {
if (success != null) {
parameters.put(RPCResponse.KEY_SUCCESS, success );
}
+ return this;
}
/**
* <p>
@@ -180,10 +182,11 @@ public class RPCResponse extends RPCMessage { * @param resultCode
* whether the request is successfully processed
*/
- public void setResultCode( @NonNull Result resultCode ) {
+ public RPCResponse setResultCode( @NonNull Result resultCode ) {
if (resultCode != null) {
parameters.put(RPCResponse.KEY_RESULT_CODE, resultCode );
}
+ return this;
}
/**
* <p>
@@ -203,9 +206,10 @@ public class RPCResponse extends RPCMessage { * @param info
* a string of text representing additional information returned from SDL
*/
- public void setInfo( String info ) {
+ public RPCResponse setInfo( String info ) {
if (info != null) {
parameters.put(RPCResponse.KEY_INFO, info );
}
+ return this;
}
}
diff --git a/base/src/main/java/com/smartdevicelink/proxy/RPCStruct.java b/base/src/main/java/com/smartdevicelink/proxy/RPCStruct.java index cebe43a60..e54694526 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/RPCStruct.java +++ b/base/src/main/java/com/smartdevicelink/proxy/RPCStruct.java @@ -172,7 +172,7 @@ public class RPCStruct { return this._bulkData;
}
- public void setBulkData(byte[] bulkData) {
+ public RPCStruct setBulkData(byte[] bulkData) {
if (bulkData != null) {
this._bulkData = new byte[bulkData.length];
System.arraycopy(bulkData, 0, _bulkData, 0, bulkData.length);
@@ -180,10 +180,12 @@ public class RPCStruct { else{
this._bulkData = null;
}
+ return this;
}
- public void setPayloadProtected(Boolean bVal) {
+ public RPCStruct setPayloadProtected(Boolean bVal) {
protectedPayload = bVal;
+ return this;
}
public Boolean isPayloadProtected() {
@@ -217,12 +219,13 @@ public class RPCStruct { // Generalized Getters and Setters
- public void setValue(String key, Object value){
+ public RPCStruct setValue(String key, Object value){
if (value != null) {
store.put(key, value);
} else {
store.remove(key);
}
+ return this;
}
public Object getValue(String key) {
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/AddCommand.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/AddCommand.java index c46fb4a7a..57d0719a5 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/AddCommand.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/AddCommand.java @@ -1,34 +1,34 @@ -/* - * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this - * list of conditions and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following - * disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its - * contributors may be used to endorse or promote products derived from this - * software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ +/*
+ * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
package com.smartdevicelink.proxy.rpc;
import androidx.annotation.NonNull;
@@ -165,15 +165,16 @@ public class AddCommand extends RPCRequest { * <p>Sets an Unique Command ID that identifies the command. Is returned in an
* <i>{@linkplain OnCommand}</i> notification to identify the command
* selected by the user</p>
- *
- *
+ *
+ *
* @param cmdID
* an integer object representing a Command ID
* <p>
* <b>Notes:</b> Min Value: 0; Max Value: 2000000000</p>
*/
- public void setCmdID(@NonNull Integer cmdID) {
- setParameters(KEY_CMD_ID, cmdID);
+ public AddCommand setCmdID(@NonNull Integer cmdID) {
+ setParameters(KEY_CMD_ID, cmdID);
+ return this;
}
/**
* <p>
@@ -195,12 +196,13 @@ public class AddCommand extends RPCRequest { * Command Menu<p>
* If null, commands will not be accessible through the HMI application menu
* </p>
- *
+ *
* @param menuParams
* a menuParams object
- */
- public void setMenuParams(MenuParams menuParams) {
+ */
+ public AddCommand setMenuParams( MenuParams menuParams) {
setParameters(KEY_MENU_PARAMS, menuParams);
+ return this;
}
/**
* <p>
@@ -222,7 +224,7 @@ public class AddCommand extends RPCRequest { * <p>If null, commands will not be accessible by voice commands (when the user
* hits push-to-talk)
* </p>
- *
+ *
* @param vrCommands
* List<String> indicating one or more VR phrases
* <p>
@@ -230,8 +232,9 @@ public class AddCommand extends RPCRequest { * provided, array must contain at least one non-empty (not null,
* not zero-length, not whitespace only) element</p>
*/
- public void setVrCommands( List<String> vrCommands ) {
- setParameters(KEY_VR_COMMANDS, vrCommands);
+ public AddCommand setVrCommands( List<String> vrCommands) {
+ setParameters(KEY_VR_COMMANDS, vrCommands);
+ return this;
}
/**
@@ -256,7 +259,8 @@ public class AddCommand extends RPCRequest { * default if applicable) icon will be displayed</p>
* @since SmartDeviceLink 2.0
*/
- public void setCmdIcon(Image cmdIcon) {
+ public AddCommand setCmdIcon( Image cmdIcon) {
setParameters(KEY_CMD_ICON, cmdIcon);
+ return this;
}
}
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/AddSubMenu.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/AddSubMenu.java index 3751134e0..e2453a727 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/AddSubMenu.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/AddSubMenu.java @@ -166,15 +166,16 @@ public class AddSubMenu extends RPCRequest { * <p>Sets a Menu ID that identifies a sub menu.</p><p> This value is used in
* {@linkplain AddCommand} to which SubMenu is the parent of the command
* being added</p>
- *
- *
+ *
+ *
* @param menuID
* an integer object representing a Menu ID
- *
+ *
* <p><b>Notes:</b> Min Value: 0; Max Value: 2000000000</p>
- */
- public void setMenuID( @NonNull Integer menuID ) {
- setParameters(KEY_MENU_ID, menuID);
+ */
+ public AddSubMenu setMenuID(@NonNull Integer menuID) {
+ setParameters(KEY_MENU_ID, menuID);
+ return this;
}
/**
* <p>Returns an <i>Integer</i> object representing the position of menu</p>
@@ -187,7 +188,7 @@ public class AddSubMenu extends RPCRequest { }
/**
* Sets a position of menu
- *
+ *
* @param position
* <p>An Integer object representing the position within the items
* of the top level Command Menu. 0 will insert at the front, 1
@@ -204,9 +205,10 @@ public class AddSubMenu extends RPCRequest { * <li>If this parameter is omitted, the entry will be added at
* the end of the list</li>
* </ul>
- */
- public void setPosition( Integer position ) {
- setParameters(KEY_POSITION, position);
+ */
+ public AddSubMenu setPosition( Integer position) {
+ setParameters(KEY_POSITION, position);
+ return this;
}
/**
* Returns String which is displayed representing this submenu item
@@ -218,12 +220,13 @@ public class AddSubMenu extends RPCRequest { }
/**
* Sets a menuName which is displayed representing this submenu item
- *
+ *
* @param menuName
* String which will be displayed representing this submenu item
- */
- public void setMenuName( @NonNull String menuName ) {
- setParameters(KEY_MENU_NAME, menuName);
+ */
+ public AddSubMenu setMenuName(@NonNull String menuName) {
+ setParameters(KEY_MENU_NAME, menuName);
+ return this;
}
/**
* Returns Image to be be shown along with the submenu item
@@ -239,17 +242,19 @@ public class AddSubMenu extends RPCRequest { * @param menuIcon
* Image to be be shown along with the submenu item
*/
- public void setMenuIcon(Image menuIcon) {
- setParameters(KEY_MENU_ICON, menuIcon);
- }
+ public AddSubMenu setMenuIcon( Image menuIcon) {
+ setParameters(KEY_MENU_ICON, menuIcon);
+ return this;
+ }
/**
* Sets the layout of the submenu screen.
* @param menuLayout - the menuLayout
*/
- public void setMenuLayout(MenuLayout menuLayout) {
- setParameters(KEY_MENU_LAYOUT, menuLayout);
- }
+ public AddSubMenu setMenuLayout( MenuLayout menuLayout) {
+ setParameters(KEY_MENU_LAYOUT, menuLayout);
+ return this;
+ }
/**
* Gets the layout of the submenu screen.
@@ -267,9 +272,10 @@ public class AddSubMenu extends RPCRequest { * provided to the top level of the in application menu.
* @since SmartDeviceLink 7.0.0
*/
- public void setParentID(Integer parentID) {
- setParameters(KEY_PARENT_ID, parentID);
- }
+ public AddSubMenu setParentID( Integer parentID) {
+ setParameters(KEY_PARENT_ID, parentID);
+ return this;
+ }
/**
* Gets the parentID.
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/AirbagStatus.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/AirbagStatus.java index 49fdf959e..55498160a 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/AirbagStatus.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/AirbagStatus.java @@ -1,34 +1,34 @@ -/* - * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this - * list of conditions and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following - * disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its - * contributors may be used to endorse or promote products derived from this - * software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ +/*
+ * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
package com.smartdevicelink.proxy.rpc;
import androidx.annotation.NonNull;
@@ -149,50 +149,58 @@ public class AirbagStatus extends RPCStruct { setPassengerKneeAirbagDeployed(passengerKneeAirbagDeployed);
}
- public void setDriverAirbagDeployed(@NonNull VehicleDataEventStatus driverAirbagDeployed) {
+ public AirbagStatus setDriverAirbagDeployed(@NonNull VehicleDataEventStatus driverAirbagDeployed) {
setValue(KEY_DRIVER_AIRBAG_DEPLOYED, driverAirbagDeployed);
+ return this;
}
public VehicleDataEventStatus getDriverAirbagDeployed() {
return (VehicleDataEventStatus) getObject(VehicleDataEventStatus.class, KEY_DRIVER_AIRBAG_DEPLOYED);
}
- public void setDriverSideAirbagDeployed(@NonNull VehicleDataEventStatus driverSideAirbagDeployed) {
+ public AirbagStatus setDriverSideAirbagDeployed(@NonNull VehicleDataEventStatus driverSideAirbagDeployed) {
setValue(KEY_DRIVER_SIDE_AIRBAG_DEPLOYED, driverSideAirbagDeployed);
+ return this;
}
public VehicleDataEventStatus getDriverSideAirbagDeployed() {
return (VehicleDataEventStatus) getObject(VehicleDataEventStatus.class, KEY_DRIVER_SIDE_AIRBAG_DEPLOYED);
}
- public void setDriverCurtainAirbagDeployed(@NonNull VehicleDataEventStatus driverCurtainAirbagDeployed) {
+ public AirbagStatus setDriverCurtainAirbagDeployed(@NonNull VehicleDataEventStatus driverCurtainAirbagDeployed) {
setValue(KEY_DRIVER_CURTAIN_AIRBAG_DEPLOYED, driverCurtainAirbagDeployed);
+ return this;
}
public VehicleDataEventStatus getDriverCurtainAirbagDeployed() {
return (VehicleDataEventStatus) getObject(VehicleDataEventStatus.class, KEY_DRIVER_CURTAIN_AIRBAG_DEPLOYED);
}
- public void setPassengerAirbagDeployed(@NonNull VehicleDataEventStatus passengerAirbagDeployed) {
+ public AirbagStatus setPassengerAirbagDeployed(@NonNull VehicleDataEventStatus passengerAirbagDeployed) {
setValue(KEY_PASSENGER_AIRBAG_DEPLOYED, passengerAirbagDeployed);
+ return this;
}
public VehicleDataEventStatus getPassengerAirbagDeployed() {
return (VehicleDataEventStatus) getObject(VehicleDataEventStatus.class, KEY_PASSENGER_AIRBAG_DEPLOYED);
}
- public void setPassengerCurtainAirbagDeployed(@NonNull VehicleDataEventStatus passengerCurtainAirbagDeployed) {
+ public AirbagStatus setPassengerCurtainAirbagDeployed(@NonNull VehicleDataEventStatus passengerCurtainAirbagDeployed) {
setValue(KEY_PASSENGER_CURTAIN_AIRBAG_DEPLOYED, passengerCurtainAirbagDeployed);
+ return this;
}
public VehicleDataEventStatus getPassengerCurtainAirbagDeployed() {
return (VehicleDataEventStatus) getObject(VehicleDataEventStatus.class, KEY_PASSENGER_CURTAIN_AIRBAG_DEPLOYED);
}
- public void setDriverKneeAirbagDeployed(@NonNull VehicleDataEventStatus driverKneeAirbagDeployed) {
+ public AirbagStatus setDriverKneeAirbagDeployed(@NonNull VehicleDataEventStatus driverKneeAirbagDeployed) {
setValue(KEY_DRIVER_KNEE_AIRBAG_DEPLOYED, driverKneeAirbagDeployed);
+ return this;
}
public VehicleDataEventStatus getDriverKneeAirbagDeployed() {
return (VehicleDataEventStatus) getObject(VehicleDataEventStatus.class, KEY_DRIVER_KNEE_AIRBAG_DEPLOYED);
}
- public void setPassengerSideAirbagDeployed(@NonNull VehicleDataEventStatus passengerSideAirbagDeployed) {
+ public AirbagStatus setPassengerSideAirbagDeployed(@NonNull VehicleDataEventStatus passengerSideAirbagDeployed) {
setValue(KEY_PASSENGER_SIDE_AIRBAG_DEPLOYED, passengerSideAirbagDeployed);
+ return this;
}
public VehicleDataEventStatus getPassengerSideAirbagDeployed() {
return (VehicleDataEventStatus) getObject(VehicleDataEventStatus.class, KEY_PASSENGER_SIDE_AIRBAG_DEPLOYED);
}
- public void setPassengerKneeAirbagDeployed(@NonNull VehicleDataEventStatus passengerKneeAirbagDeployed) {
+ public AirbagStatus setPassengerKneeAirbagDeployed(@NonNull VehicleDataEventStatus passengerKneeAirbagDeployed) {
setValue(KEY_PASSENGER_KNEE_AIRBAG_DEPLOYED, passengerKneeAirbagDeployed);
+ return this;
}
public VehicleDataEventStatus getPassengerKneeAirbagDeployed() {
return (VehicleDataEventStatus) getObject(VehicleDataEventStatus.class, KEY_PASSENGER_KNEE_AIRBAG_DEPLOYED);
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/Alert.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/Alert.java index a67484131..dbb16c073 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/Alert.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/Alert.java @@ -204,10 +204,10 @@ public class Alert extends RPCRequest { /**
* Sets the String to be displayed in the first field of the display during
* the Alert
- *
+ *
* @param alertText1
* String Value
- *
+ *
* <p><b>Notes: </b></p>
* <ul>
* <li>Length is limited to what is indicated in <i>
@@ -215,9 +215,10 @@ public class Alert extends RPCRequest { * <li>If omitted, top display line will be cleared</li>
* <li>Text is always centered</li>
* </ul>
- */
- public void setAlertText1(String alertText1) {
- setParameters(KEY_ALERT_TEXT_1, alertText1);
+ */
+ public Alert setAlertText1( String alertText1) {
+ setParameters(KEY_ALERT_TEXT_1, alertText1);
+ return this;
}
/**
* Gets the text which is displayed in the second field of the display
@@ -232,10 +233,10 @@ public class Alert extends RPCRequest { /**
* Sets the String to be displayed in the second field of the display during
* the Alert
- *
+ *
* @param alertText2
* String Value
- *
+ *
* <p><b>Notes: </b></p>
* <ul>
* <li>Only permitted if HMI supports a second display line</li>
@@ -244,9 +245,10 @@ public class Alert extends RPCRequest { * <li>If omitted, second display line will be cleared</li>
* <li>Text is always centered</li>
* </ul>
- */
- public void setAlertText2(String alertText2) {
- setParameters(KEY_ALERT_TEXT_2, alertText2);
+ */
+ public Alert setAlertText2( String alertText2) {
+ setParameters(KEY_ALERT_TEXT_2, alertText2);
+ return this;
}
/**
@@ -265,10 +267,10 @@ public class Alert extends RPCRequest { /**
* Sets the String to be displayed in the third field of the display during
* the Alert
- *
+ *
* @param alertText3
* String Value
- *
+ *
* <p> <b>Notes: </b></p>
* <ul>
* <li>Only permitted if HMI supports a third display line</li>
@@ -277,11 +279,12 @@ public class Alert extends RPCRequest { * <li>If omitted, third display line will be cleared</li>
* <li>Text is always centered</li>
* </ul>
- *
+ *
* @since SmartDeviceLink 2.0
*/
- public void setAlertText3(String alertText3) {
- setParameters(KEY_ALERT_TEXT_3, alertText3);
+ public Alert setAlertText3( String alertText3) {
+ setParameters(KEY_ALERT_TEXT_3, alertText3);
+ return this;
}
/**
* Gets TTSChunk[], the Array of type TTSChunk which, taken together,
@@ -297,13 +300,14 @@ public class Alert extends RPCRequest { /**
* Sets array of type TTSChunk which, taken together, specify what is to be
* spoken to the user
- *
+ *
* @param ttsChunks
- *
+ *
* <p> <b>Notes: </b>Array must have a least one element</p>
- */
- public void setTtsChunks(List<TTSChunk> ttsChunks) {
- setParameters(KEY_TTS_CHUNKS, ttsChunks);
+ */
+ public Alert setTtsChunks( List<TTSChunk> ttsChunks) {
+ setParameters(KEY_TTS_CHUNKS, ttsChunks);
+ return this;
}
/**
* Gets the duration of the displayed portion of the alert, in milliseconds
@@ -319,8 +323,8 @@ public class Alert extends RPCRequest { * After this amount of time has passed, the display fields alertText1 and
* alertText2 will revert to what was displayed in those fields before the
* alert began</p>
- *
- *
+ *
+ *
* @param duration
* the Integer values representing the duration time, in
* milliseconds
@@ -330,9 +334,10 @@ public class Alert extends RPCRequest { * <li>Min Value: 3000; Max Value: 10000</li>
* <li>If omitted, the default is 5000 milliseconds</li>
* </ul>
- */
- public void setDuration(Integer duration) {
- setParameters(KEY_DURATION, duration);
+ */
+ public Alert setDuration( Integer duration) {
+ setParameters(KEY_DURATION, duration);
+ return this;
}
/**
* Gets a Boolean value representing the alert tone
@@ -346,15 +351,16 @@ public class Alert extends RPCRequest { /**
* Sets whether the alert tone should be played before the TTS (if any) is
* spoken
- *
+ *
* @param playTone
* a Boolean value which specifies whether the alert tone should
* be played before the TTS (if any) is spoken
- *
+ *
* <p> <b>Notes: </b>If omitted, default is true</p>
- */
- public void setPlayTone(Boolean playTone) {
- setParameters(KEY_PLAY_TONE, playTone);
+ */
+ public Alert setPlayTone( Boolean playTone) {
+ setParameters(KEY_PLAY_TONE, playTone);
+ return this;
}
/**
@@ -371,7 +377,7 @@ public class Alert extends RPCRequest { /**
* Sets the SoftButtons
- *
+ *
* @param softButtons
* a List<SoftButton> value
* <p>
@@ -384,8 +390,9 @@ public class Alert extends RPCRequest { * </ul>
* @since SmartDeviceLink 2.0
*/
- public void setSoftButtons(List<SoftButton> softButtons) {
- setParameters(KEY_SOFT_BUTTONS, softButtons);
+ public Alert setSoftButtons( List<SoftButton> softButtons) {
+ setParameters(KEY_SOFT_BUTTONS, softButtons);
+ return this;
}
/**
@@ -406,8 +413,9 @@ public class Alert extends RPCRequest { *
* @since SmartDeviceLink 3.0
*/
- public void setProgressIndicator(Boolean progressIndicator) {
+ public Alert setProgressIndicator( Boolean progressIndicator) {
setParameters(KEY_PROGRESS_INDICATOR, progressIndicator);
+ return this;
}
/**
@@ -428,9 +436,10 @@ public class Alert extends RPCRequest { *
* @since SmartDeviceLink 6.0
*/
- public void setCancelID(Integer cancelID) {
- setParameters(KEY_CANCEL_ID, cancelID);
- };
+ public Alert setCancelID( Integer cancelID) {
+ setParameters(KEY_CANCEL_ID, cancelID);
+ return this;
+ };
/**
* <p>Sets the Image
@@ -441,9 +450,10 @@ public class Alert extends RPCRequest { * <b>Notes: </b>If omitted on supported displays, no (or the
* default if applicable) icon will be displayed</p>
*/
- public void setAlertIcon(Image alertIcon) {
- setParameters(KEY_ALERT_ICON, alertIcon);
- }
+ public Alert setAlertIcon( Image alertIcon) {
+ setParameters(KEY_ALERT_ICON, alertIcon);
+ return this;
+ }
/**
* <p>Gets the image to be shown along with the alert </p>
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/AlertManeuver.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/AlertManeuver.java index 37b6c2da3..9e5fb32b7 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/AlertManeuver.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/AlertManeuver.java @@ -86,7 +86,7 @@ public class AlertManeuver extends RPCRequest{ /** * Sets the SoftButtons - * + * * @param softButtons * a List<SoftButton> value * <p> @@ -99,8 +99,9 @@ public class AlertManeuver extends RPCRequest{ * @since SmartDeviceLink 2.0 */ - public void setSoftButtons(List<SoftButton> softButtons){ + public AlertManeuver setSoftButtons( List<SoftButton> softButtons) { setParameters(KEY_SOFT_BUTTONS, softButtons); + return this; } /** @@ -115,13 +116,14 @@ public class AlertManeuver extends RPCRequest{ /** * Sets array of type TTSChunk which, taken together, specify what is to be spoken to the user - * + * * @param ttsChunks * <p> * <b>Notes: </b></p>Array must have a least one element */ - public void setTtsChunks(List<TTSChunk> ttsChunks){ + public AlertManeuver setTtsChunks( List<TTSChunk> ttsChunks) { setParameters(KEY_TTS_CHUNKS, ttsChunks); + return this; } } diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/AlertResponse.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/AlertResponse.java index a2fae73be..3ad14972b 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/AlertResponse.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/AlertResponse.java @@ -1,34 +1,34 @@ -/* - * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this - * list of conditions and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following - * disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its - * contributors may be used to endorse or promote products derived from this - * software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ +/*
+ * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
package com.smartdevicelink.proxy.rpc;
import androidx.annotation.NonNull;
@@ -78,7 +78,8 @@ public class AlertResponse extends RPCResponse { public Integer getTryAgainTime() {
return getInteger(KEY_TRY_AGAIN_TIME);
}
- public void setTryAgainTime(Integer tryAgainTime) {
+ public AlertResponse setTryAgainTime( Integer tryAgainTime) {
setParameters(KEY_TRY_AGAIN_TIME, tryAgainTime);
+ return this;
}
}
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/AppInfo.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/AppInfo.java index a71d7b6e2..b07e918d1 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/AppInfo.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/AppInfo.java @@ -73,9 +73,10 @@ public class AppInfo extends RPCStruct { /** Sets the name displayed for the mobile application on the mobile device (can differ from the app name set in the initial RAI request). * @param appDisplayName - name displayed for the mobile application on the mobile device. */ - public void setAppDisplayName(@NonNull String appDisplayName) { - setValue(KEY_APP_DISPLAY_NAME, appDisplayName); - } + public AppInfo setAppDisplayName(@NonNull String appDisplayName) { + setValue(KEY_APP_DISPLAY_NAME, appDisplayName); + return this; + } /** Gets the name displayed for the mobile application on the mobile device (can differ from the app name set in the initial RAI request). * @return appDisplayName - name displayed for the mobile application on the mobile device. @@ -87,9 +88,10 @@ public class AppInfo extends RPCStruct { /** Sets package name of the Android application. This supports App Launch strategies for each platform. * @param appBundleID - package name of the application */ - public void setAppBundleID(@NonNull String appBundleID) { - setValue(KEY_APP_BUNDLE_ID, appBundleID); - } + public AppInfo setAppBundleID(@NonNull String appBundleID) { + setValue(KEY_APP_BUNDLE_ID, appBundleID); + return this; + } /** Gets package name of the Android application. This supports App Launch strategies for each platform. * @return appBundleID - package name of the application. @@ -101,9 +103,10 @@ public class AppInfo extends RPCStruct { /** Sets build version number of this particular mobile app. * @param appVersion - build version number of this particular mobile app. */ - public void setAppVersion(@NonNull String appVersion) { - setValue(KEY_APP_VERSION, appVersion); - } + public AppInfo setAppVersion(@NonNull String appVersion) { + setValue(KEY_APP_VERSION, appVersion); + return this; + } /** Gets build version number of this particular mobile app. * @return appVersion - build version number of this particular mobile app. @@ -115,9 +118,10 @@ public class AppInfo extends RPCStruct { /** Sets file reference to the icon utilized by this app (simplifies the process of setting an app icon during app registration). * @param appIcon - file reference to the icon utilized by this app */ - public void setAppIcon(String appIcon) { - setValue(KEY_APP_ICON, appIcon); - } + public AppInfo setAppIcon( String appIcon) { + setValue(KEY_APP_ICON, appIcon); + return this; + } /** Gets build version number of this particular mobile app. * @return appIcon - build version number of this particular mobile app. diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/AppServiceCapability.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/AppServiceCapability.java index 780ac13ed..3f46cbb7a 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/AppServiceCapability.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/AppServiceCapability.java @@ -69,9 +69,10 @@ public class AppServiceCapability extends RPCStruct { * Only included in OnSystemCapabilityUpdated. Update reason for this service record. * @param updateReason - */ - public void setUpdateReason(ServiceUpdateReason updateReason){ - setValue(KEY_UPDATE_REASON, updateReason); - } + public AppServiceCapability setUpdateReason( ServiceUpdateReason updateReason) { + setValue(KEY_UPDATE_REASON, updateReason); + return this; + } /** * Only included in OnSystemCapabilityUpdated. Update reason for this service record. @@ -85,9 +86,10 @@ public class AppServiceCapability extends RPCStruct { * Only included in OnSystemCapabilityUpdated. Update reason for this service record. * @param updatedAppServiceRecord - */ - public void setUpdatedAppServiceRecord(AppServiceRecord updatedAppServiceRecord){ - setValue(KEY_UPDATED_APP_SERVICE_RECORD, updatedAppServiceRecord); - } + public AppServiceCapability setUpdatedAppServiceRecord( AppServiceRecord updatedAppServiceRecord) { + setValue(KEY_UPDATED_APP_SERVICE_RECORD, updatedAppServiceRecord); + return this; + } /** * Only included in OnSystemCapabilityUpdated. Update reason for this service record. diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/AppServiceData.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/AppServiceData.java index 1a441a7fa..529815cfc 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/AppServiceData.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/AppServiceData.java @@ -68,9 +68,10 @@ public class AppServiceData extends RPCStruct { /** * @param serviceType - */ - public void setServiceType(@NonNull String serviceType) { - setValue(KEY_SERVICE_TYPE, serviceType); - } + public AppServiceData setServiceType(@NonNull String serviceType) { + setValue(KEY_SERVICE_TYPE, serviceType); + return this; + } /** * @return serviceType - @@ -82,9 +83,10 @@ public class AppServiceData extends RPCStruct { /** * @param serviceId - */ - public void setServiceID(@NonNull String serviceId) { - setValue(KEY_SERVICE_ID, serviceId); - } + public AppServiceData setServiceID(@NonNull String serviceId) { + setValue(KEY_SERVICE_ID, serviceId); + return this; + } /** * @return serviceId - @@ -96,9 +98,10 @@ public class AppServiceData extends RPCStruct { /** * @param mediaServiceData - */ - public void setMediaServiceData(MediaServiceData mediaServiceData) { - setValue(KEY_MEDIA_SERVICE_DATA, mediaServiceData); - } + public AppServiceData setMediaServiceData( MediaServiceData mediaServiceData) { + setValue(KEY_MEDIA_SERVICE_DATA, mediaServiceData); + return this; + } /** * @return mediaServiceData - @@ -110,9 +113,10 @@ public class AppServiceData extends RPCStruct { /** * @param weatherServiceData - */ - public void setWeatherServiceData(WeatherServiceData weatherServiceData) { - setValue(KEY_WEATHER_SERVICE_DATA, weatherServiceData); - } + public AppServiceData setWeatherServiceData( WeatherServiceData weatherServiceData) { + setValue(KEY_WEATHER_SERVICE_DATA, weatherServiceData); + return this; + } /** * @return weatherServiceData - @@ -124,9 +128,10 @@ public class AppServiceData extends RPCStruct { /** * @param navigationServiceData - */ - public void setNavigationServiceData(NavigationServiceData navigationServiceData) { - setValue(KEY_NAVIGATION_SERVICE_DATA, navigationServiceData); - } + public AppServiceData setNavigationServiceData( NavigationServiceData navigationServiceData) { + setValue(KEY_NAVIGATION_SERVICE_DATA, navigationServiceData); + return this; + } /** * @return navigationServiceData - diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/AppServiceManifest.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/AppServiceManifest.java index 9f2e4e2f6..9de0201b9 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/AppServiceManifest.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/AppServiceManifest.java @@ -88,9 +88,10 @@ public class AppServiceManifest extends RPCStruct { * Unique name of this service * @param serviceName - the service name */ - public void setServiceName(String serviceName){ - setValue(KEY_SERVICE_NAME, serviceName); - } + public AppServiceManifest setServiceName( String serviceName) { + setValue(KEY_SERVICE_NAME, serviceName); + return this; + } /** * Unique name of this service @@ -102,12 +103,13 @@ public class AppServiceManifest extends RPCStruct { /** * The type of service that is to be offered by this app - * @param serviceType - the serviceType use {@link com.smartdevicelink.proxy.rpc.enums.AppServiceType} - * @see com.smartdevicelink.proxy.rpc.enums.AppServiceType + * @param serviceType - the serviceType use {@link AppServiceType} + * @see AppServiceType */ - public void setServiceType(@NonNull String serviceType){ - setValue(KEY_SERVICE_TYPE, serviceType); - } + public AppServiceManifest setServiceType(@NonNull String serviceType) { + setValue(KEY_SERVICE_TYPE, serviceType); + return this; + } /** * The type of service that is to be offered by this app @@ -122,9 +124,10 @@ public class AppServiceManifest extends RPCStruct { * The icon to be associated with this service Most likely the same as the appIcon. * @param serviceIcon - The Service Icon Image */ - public void setServiceIcon(Image serviceIcon){ - setValue(KEY_SERVICE_ICON, serviceIcon); - } + public AppServiceManifest setServiceIcon( Image serviceIcon) { + setValue(KEY_SERVICE_ICON, serviceIcon); + return this; + } /** * The icon to be associated with this service Most likely the same as the appIcon. @@ -139,9 +142,10 @@ public class AppServiceManifest extends RPCStruct { * only the IVI system will be able consume the service. If not provided, it is assumed to be false. * @param allowAppConsumers - boolean */ - public void setAllowAppConsumers(Boolean allowAppConsumers){ - setValue(KEY_ALLOW_APP_CONSUMERS, allowAppConsumers); - } + public AppServiceManifest setAllowAppConsumers( Boolean allowAppConsumers) { + setValue(KEY_ALLOW_APP_CONSUMERS, allowAppConsumers); + return this; + } /** * If true, app service consumers beyond the IVI system will be able to access this service. If false, @@ -157,9 +161,10 @@ public class AppServiceManifest extends RPCStruct { * If not included, it is assumed the max version of the module is acceptable. * @param rpcSpecVersion - The rpcSpecVersion */ - public void setRpcSpecVersion(SdlMsgVersion rpcSpecVersion){ - setValue(KEY_RPC_SPEC_VERSION, rpcSpecVersion); - } + public AppServiceManifest setRpcSpecVersion( SdlMsgVersion rpcSpecVersion) { + setValue(KEY_RPC_SPEC_VERSION, rpcSpecVersion); + return this; + } /** * This is the max RPC Spec version the app service understands. This is important during the RPC pass through functionality. @@ -174,20 +179,21 @@ public class AppServiceManifest extends RPCStruct { * This field contains the Function IDs for the RPCs that this service intends to handle correctly. * This means the service will provide meaningful responses. * @param handledRPCs - The List of Handled RPCs using their ID value from the FunctionID enum - * @see com.smartdevicelink.protocol.enums.FunctionID - * @see #setHandledRpcsUsingFunctionIDs(List) + * @see FunctionID + * @see #setHandledRpcsUsingFunctionIDs( List ) */ - public void setHandledRpcs(List<Integer> handledRPCs){ - setValue(KEY_HANDLED_RPCS, handledRPCs); - } + public AppServiceManifest setHandledRpcs( List<Integer> handledRPCs) { + setValue(KEY_HANDLED_RPCS, handledRPCs); + return this; + } /** * This field contains the Function IDs for the RPCs that this service intends to handle correctly. * This means the service will provide meaningful responses. * @param handledRPCs - The List of Handled RPCs using the FunctionID enum - * @see #setHandledRpcs(List) + * @see #setHandledRpcs( List ) */ - public void setHandledRpcsUsingFunctionIDs(List<FunctionID> handledRPCs){ - if(handledRPCs != null){ + public AppServiceManifest setHandledRpcsUsingFunctionIDs( List<FunctionID> handledRPCs) { + if(handledRPCs != null){ List<Integer> rpcIds = new ArrayList<>(); for(FunctionID functionID : handledRPCs){ rpcIds.add(functionID.getId()); @@ -196,7 +202,8 @@ public class AppServiceManifest extends RPCStruct { }else{ setValue(KEY_HANDLED_RPCS, null); } - } + return this; + } /** * This field contains the FunctionID integer ID values for the RPCs that this service intends to handle correctly. @@ -213,9 +220,10 @@ public class AppServiceManifest extends RPCStruct { * The MediaServiceManifest * @param mediaServiceManifest - The mediaServiceManifest */ - public void setMediaServiceManifest(MediaServiceManifest mediaServiceManifest){ - setValue(KEY_MEDIA_SERVICE_MANIFEST, mediaServiceManifest); - } + public AppServiceManifest setMediaServiceManifest( MediaServiceManifest mediaServiceManifest) { + setValue(KEY_MEDIA_SERVICE_MANIFEST, mediaServiceManifest); + return this; + } /** * The MediaServiceManifest @@ -229,9 +237,10 @@ public class AppServiceManifest extends RPCStruct { * The WeatherServiceManifest * @param weatherServiceManifest - The weatherServiceManifest */ - public void setWeatherServiceManifest(WeatherServiceManifest weatherServiceManifest){ - setValue(KEY_WEATHER_SERVICE_MANIFEST, weatherServiceManifest); - } + public AppServiceManifest setWeatherServiceManifest( WeatherServiceManifest weatherServiceManifest) { + setValue(KEY_WEATHER_SERVICE_MANIFEST, weatherServiceManifest); + return this; + } /** * The WeatherServiceManifest @@ -245,9 +254,10 @@ public class AppServiceManifest extends RPCStruct { * The NavigationServiceManifest * @param navigationServiceManifest - The navigationServiceManifest */ - public void setNavigationServiceManifest(NavigationServiceManifest navigationServiceManifest){ - setValue(KEY_NAVIGATION_SERVICE_MANIFEST, navigationServiceManifest); - } + public AppServiceManifest setNavigationServiceManifest( NavigationServiceManifest navigationServiceManifest) { + setValue(KEY_NAVIGATION_SERVICE_MANIFEST, navigationServiceManifest); + return this; + } /** * The NavigationServiceManifest diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/AppServiceRecord.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/AppServiceRecord.java index 198be4e26..d59cb8fe0 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/AppServiceRecord.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/AppServiceRecord.java @@ -70,9 +70,10 @@ public class AppServiceRecord extends RPCStruct { * ID of this service * @param serviceID - the service ID */ - public void setServiceID(@NonNull String serviceID){ - setValue(KEY_SERVICE_ID, serviceID); - } + public AppServiceRecord setServiceID(@NonNull String serviceID) { + setValue(KEY_SERVICE_ID, serviceID); + return this; + } /** * ID of this service @@ -86,9 +87,10 @@ public class AppServiceRecord extends RPCStruct { * the App Service Manifest * @param serviceManifest - the App Service Manifest */ - public void setServiceManifest(@NonNull AppServiceManifest serviceManifest){ - setValue(KEY_SERVICE_MANIFEST, serviceManifest); - } + public AppServiceRecord setServiceManifest(@NonNull AppServiceManifest serviceManifest) { + setValue(KEY_SERVICE_MANIFEST, serviceManifest); + return this; + } /** * the App Service Manifest @@ -103,9 +105,10 @@ public class AppServiceRecord extends RPCStruct { * unpublished, and should be considered unavailable. * @param servicePublished - boolean */ - public void setServicePublished(@NonNull Boolean servicePublished){ - setValue(KEY_SERVICE_PUBLISHED, servicePublished); - } + public AppServiceRecord setServicePublished(@NonNull Boolean servicePublished) { + setValue(KEY_SERVICE_PUBLISHED, servicePublished); + return this; + } /** * If true, the service is published and available. If false, the service has likely just been @@ -122,9 +125,10 @@ public class AppServiceRecord extends RPCStruct { * service of the supplied type. See servicePublished for its availability. * @param serviceActive - boolean */ - public void setServiceActive(@NonNull Boolean serviceActive){ - setValue(KEY_SERVICE_ACTIVE, serviceActive); - } + public AppServiceRecord setServiceActive(@NonNull Boolean serviceActive) { + setValue(KEY_SERVICE_ACTIVE, serviceActive); + return this; + } /** * If true, the service is the active primary service of the supplied service type. It will receive diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/AppServicesCapabilities.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/AppServicesCapabilities.java index 63d3dd6a5..30cac40fa 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/AppServicesCapabilities.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/AppServicesCapabilities.java @@ -72,9 +72,10 @@ public class AppServicesCapabilities extends RPCStruct { * capability the affected services will include an update reason in that item * @param appServices - */ - public void setAppServices(List<AppServiceCapability> appServices){ - setValue(KEY_APP_SERVICES, appServices); - } + public AppServicesCapabilities setAppServices( List<AppServiceCapability> appServices) { + setValue(KEY_APP_SERVICES, appServices); + return this; + } /** * An array of currently available services. If this is an update to the diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/AudioControlCapabilities.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/AudioControlCapabilities.java index 7ee26175e..ecb6daef8 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/AudioControlCapabilities.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/AudioControlCapabilities.java @@ -76,9 +76,10 @@ public class AudioControlCapabilities extends RPCStruct { * * @param moduleName The short friendly name of the light control module. It should not be used to identify a module by mobile application. */ - public void setModuleName(@NonNull String moduleName) { - setValue(KEY_MODULE_NAME, moduleName); - } + public AudioControlCapabilities setModuleName(@NonNull String moduleName) { + setValue(KEY_MODULE_NAME, moduleName); + return this; + } /** * Gets the moduleName portion of the AudioControlCapabilities class @@ -94,9 +95,10 @@ public class AudioControlCapabilities extends RPCStruct { * * @param keepContextAvailable Availability of the keepContext parameter. */ - public void setKeepContextAvailable(Boolean keepContextAvailable) { - setValue(KEY_KEEP_CONTEXT_AVAILABLE, keepContextAvailable); - } + public AudioControlCapabilities setKeepContextAvailable( Boolean keepContextAvailable) { + setValue(KEY_KEEP_CONTEXT_AVAILABLE, keepContextAvailable); + return this; + } /** * Gets the keepContextAvailable portion of the AudioControlCapabilities class @@ -112,9 +114,10 @@ public class AudioControlCapabilities extends RPCStruct { * * @param sourceAvailable Availability of the control of audio source. */ - public void setSourceAvailable(Boolean sourceAvailable) { - setValue(KEY_SOURCE_AVAILABLE, sourceAvailable); - } + public AudioControlCapabilities setSourceAvailable( Boolean sourceAvailable) { + setValue(KEY_SOURCE_AVAILABLE, sourceAvailable); + return this; + } /** * Gets the sourceAvailable portion of the AudioControlCapabilities class @@ -130,9 +133,10 @@ public class AudioControlCapabilities extends RPCStruct { * * @param volumeAvailable Availability of the control of audio volume. */ - public void setVolumeAvailable(Boolean volumeAvailable) { - setValue(KEY_VOLUME_AVAILABLE, volumeAvailable); - } + public AudioControlCapabilities setVolumeAvailable( Boolean volumeAvailable) { + setValue(KEY_VOLUME_AVAILABLE, volumeAvailable); + return this; + } /** * Gets the volumeAvailable portion of the AudioControlCapabilities class @@ -148,9 +152,10 @@ public class AudioControlCapabilities extends RPCStruct { * * @param equalizerAvailable Availability of the control of Equalizer Settings. */ - public void setEqualizerAvailable(Boolean equalizerAvailable) { - setValue(KEY_EQUALIZER_AVAILABLE, equalizerAvailable); - } + public AudioControlCapabilities setEqualizerAvailable( Boolean equalizerAvailable) { + setValue(KEY_EQUALIZER_AVAILABLE, equalizerAvailable); + return this; + } /** * Gets the equalizerAvailable portion of the AudioControlCapabilities class @@ -166,9 +171,10 @@ public class AudioControlCapabilities extends RPCStruct { * * @param equalizerMaxChannelId Must be included if equalizerAvailable=true, and assume all IDs starting from 1 to this value are valid. */ - public void setEqualizerMaxChannelId(Integer equalizerMaxChannelId) { - setValue(KEY_EQUALIZER_MAX_CHANNEL_ID, equalizerMaxChannelId); - } + public AudioControlCapabilities setEqualizerMaxChannelId( Integer equalizerMaxChannelId) { + setValue(KEY_EQUALIZER_MAX_CHANNEL_ID, equalizerMaxChannelId); + return this; + } /** * Gets the equalizerMaxChannelId portion of the AudioControlCapabilities class @@ -183,9 +189,10 @@ public class AudioControlCapabilities extends RPCStruct { * Sets ModuleInfo for this capability * @param info the ModuleInfo to be set */ - public void setModuleInfo(ModuleInfo info) { - setValue(KEY_MODULE_INFO, info); - } + public AudioControlCapabilities setModuleInfo( ModuleInfo info) { + setValue(KEY_MODULE_INFO, info); + return this; + } /** * Gets a ModuleInfo of this capability diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/AudioControlData.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/AudioControlData.java index ff95186d5..2de646ff6 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/AudioControlData.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/AudioControlData.java @@ -65,9 +65,10 @@ public class AudioControlData extends RPCStruct { * In a setter request, it is the target audio source that the system shall switch to. * If the value is MOBILE_APP, the system shall switch to the mobile media app that issues the setter RPC. */ - public void setSource(PrimaryAudioSource source) { - setValue(KEY_SOURCE, source); - } + public AudioControlData setSource( PrimaryAudioSource source) { + setValue(KEY_SOURCE, source); + return this; + } /** * Gets the source portion of the AudioControlData class @@ -89,9 +90,10 @@ public class AudioControlData extends RPCStruct { * system UI associated with the audio source to foreground. * If it is true, the system only changes the audio source, but keeps the current application in foreground. */ - public void setKeepContext(Boolean keepContext) { - setValue(KEY_KEEP_CONTEXT, keepContext); - } + public AudioControlData setKeepContext( Boolean keepContext) { + setValue(KEY_KEEP_CONTEXT, keepContext); + return this; + } /** * Gets the keepContext portion of the AudioControlData class @@ -111,9 +113,10 @@ public class AudioControlData extends RPCStruct { * * @param volume Reflects the volume of audio, from 0%-100%. */ - public void setVolume(Integer volume) { - setValue(KEY_VOLUME, volume); - } + public AudioControlData setVolume( Integer volume) { + setValue(KEY_VOLUME, volume); + return this; + } /** * Gets the volume portion of the AudioControlData class @@ -139,8 +142,9 @@ public class AudioControlData extends RPCStruct { * * @param equalizerSettings Defines the list of supported channels (band) and their current/desired settings on HMI. */ - public void setEqualizerSettings(List<EqualizerSettings> equalizerSettings) { - setValue(KEY_EQUALIZER_SETTINGS, equalizerSettings); - } + public AudioControlData setEqualizerSettings( List<EqualizerSettings> equalizerSettings) { + setValue(KEY_EQUALIZER_SETTINGS, equalizerSettings); + return this; + } } diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/AudioPassThruCapabilities.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/AudioPassThruCapabilities.java index 38f2f80bb..769813bad 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/AudioPassThruCapabilities.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/AudioPassThruCapabilities.java @@ -1,34 +1,34 @@ -/* - * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this - * list of conditions and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following - * disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its - * contributors may be used to endorse or promote products derived from this - * software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ +/*
+ * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
package com.smartdevicelink.proxy.rpc;
import androidx.annotation.NonNull;
@@ -110,8 +110,9 @@ public class AudioPassThruCapabilities extends RPCStruct { * set the sampling rate for AudioPassThru
* @param samplingRate the sampling rate for AudioPassThru
*/
- public void setSamplingRate(@NonNull SamplingRate samplingRate) {
- setValue(KEY_SAMPLING_RATE, samplingRate);
+ public AudioPassThruCapabilities setSamplingRate(@NonNull SamplingRate samplingRate) {
+ setValue(KEY_SAMPLING_RATE, samplingRate);
+ return this;
}
/**
@@ -126,8 +127,9 @@ public class AudioPassThruCapabilities extends RPCStruct { * set the sample depth in bit for AudioPassThru
* @param bitsPerSample the sample depth in bit for AudioPassThru
*/
- public void setBitsPerSample(@NonNull BitsPerSample bitsPerSample) {
- setValue(KEY_BITS_PER_SAMPLE, bitsPerSample);
+ public AudioPassThruCapabilities setBitsPerSample(@NonNull BitsPerSample bitsPerSample) {
+ setValue(KEY_BITS_PER_SAMPLE, bitsPerSample);
+ return this;
}
/**
@@ -142,8 +144,9 @@ public class AudioPassThruCapabilities extends RPCStruct { * set the audiotype for AudioPassThru
* @param audioType the audiotype for AudioPassThru
*/
- public void setAudioType(@NonNull AudioType audioType) {
- setValue(KEY_AUDIO_TYPE, audioType);
+ public AudioPassThruCapabilities setAudioType(@NonNull AudioType audioType) {
+ setValue(KEY_AUDIO_TYPE, audioType);
+ return this;
}
/**
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/BeltStatus.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/BeltStatus.java index ff01b72e4..faa10d607 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/BeltStatus.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/BeltStatus.java @@ -200,92 +200,107 @@ public class BeltStatus extends RPCStruct { setMiddleRow1BuckleBelted(middleRow1BuckleBelted);
}
- public void setDriverBeltDeployed(@NonNull VehicleDataEventStatus driverBeltDeployed) {
+ public BeltStatus setDriverBeltDeployed(@NonNull VehicleDataEventStatus driverBeltDeployed) {
setValue(KEY_DRIVER_BELT_DEPLOYED, driverBeltDeployed);
+ return this;
}
public VehicleDataEventStatus getDriverBeltDeployed() {
return (VehicleDataEventStatus) getObject(VehicleDataEventStatus.class, KEY_DRIVER_BELT_DEPLOYED);
}
- public void setPassengerBeltDeployed(@NonNull VehicleDataEventStatus passengerBeltDeployed) {
+ public BeltStatus setPassengerBeltDeployed(@NonNull VehicleDataEventStatus passengerBeltDeployed) {
setValue(KEY_PASSENGER_BELT_DEPLOYED, passengerBeltDeployed);
+ return this;
}
public VehicleDataEventStatus getPassengerBeltDeployed() {
return (VehicleDataEventStatus) getObject(VehicleDataEventStatus.class, KEY_PASSENGER_BELT_DEPLOYED);
}
- public void setPassengerBuckleBelted(@NonNull VehicleDataEventStatus passengerBuckleBelted) {
+ public BeltStatus setPassengerBuckleBelted(@NonNull VehicleDataEventStatus passengerBuckleBelted) {
setValue(KEY_PASSENGER_BUCKLE_BELTED, passengerBuckleBelted);
+ return this;
}
public VehicleDataEventStatus getPassengerBuckleBelted() {
return (VehicleDataEventStatus) getObject(VehicleDataEventStatus.class, KEY_PASSENGER_BUCKLE_BELTED);
}
- public void setDriverBuckleBelted(VehicleDataEventStatus driverBuckleBelted) {
+ public BeltStatus setDriverBuckleBelted( VehicleDataEventStatus driverBuckleBelted) {
setValue(KEY_DRIVER_BUCKLE_BELTED, driverBuckleBelted);
+ return this;
}
public VehicleDataEventStatus getDriverBuckleBelted() {
return (VehicleDataEventStatus) getObject(VehicleDataEventStatus.class, KEY_DRIVER_BUCKLE_BELTED);
}
- public void setLeftRow2BuckleBelted(VehicleDataEventStatus leftRow2BuckleBelted) {
+ public BeltStatus setLeftRow2BuckleBelted( VehicleDataEventStatus leftRow2BuckleBelted) {
setValue(KEY_LEFT_ROW_2_BUCKLE_BELTED, leftRow2BuckleBelted);
+ return this;
}
public VehicleDataEventStatus getLeftRow2BuckleBelted() {
return (VehicleDataEventStatus) getObject(VehicleDataEventStatus.class, KEY_LEFT_ROW_2_BUCKLE_BELTED);
}
- public void setPassengerChildDetected(@NonNull VehicleDataEventStatus passengerChildDetected) {
+ public BeltStatus setPassengerChildDetected(@NonNull VehicleDataEventStatus passengerChildDetected) {
setValue(KEY_PASSENGER_CHILD_DETECTED, passengerChildDetected);
+ return this;
}
public VehicleDataEventStatus getPassengerChildDetected() {
return (VehicleDataEventStatus) getObject(VehicleDataEventStatus.class, KEY_PASSENGER_CHILD_DETECTED);
}
- public void setRightRow2BuckleBelted(@NonNull VehicleDataEventStatus rightRow2BuckleBelted) {
+ public BeltStatus setRightRow2BuckleBelted(@NonNull VehicleDataEventStatus rightRow2BuckleBelted) {
setValue(KEY_RIGHT_ROW_2_BUCKLE_BELTED, rightRow2BuckleBelted);
+ return this;
}
public VehicleDataEventStatus getRightRow2BuckleBelted() {
return (VehicleDataEventStatus) getObject(VehicleDataEventStatus.class, KEY_RIGHT_ROW_2_BUCKLE_BELTED);
}
- public void setMiddleRow2BuckleBelted(@NonNull VehicleDataEventStatus middleRow2BuckleBelted) {
+ public BeltStatus setMiddleRow2BuckleBelted(@NonNull VehicleDataEventStatus middleRow2BuckleBelted) {
setValue(KEY_MIDDLE_ROW_2_BUCKLE_BELTED, middleRow2BuckleBelted);
+ return this;
}
public VehicleDataEventStatus getMiddleRow2BuckleBelted() {
return (VehicleDataEventStatus) getObject(VehicleDataEventStatus.class, KEY_MIDDLE_ROW_2_BUCKLE_BELTED);
}
- public void setMiddleRow3BuckleBelted(@NonNull VehicleDataEventStatus middleRow3BuckleBelted) {
+ public BeltStatus setMiddleRow3BuckleBelted(@NonNull VehicleDataEventStatus middleRow3BuckleBelted) {
setValue(KEY_MIDDLE_ROW_3_BUCKLE_BELTED, middleRow3BuckleBelted);
+ return this;
}
public VehicleDataEventStatus getMiddleRow3BuckleBelted() {
return (VehicleDataEventStatus) getObject(VehicleDataEventStatus.class, KEY_MIDDLE_ROW_3_BUCKLE_BELTED);
}
- public void setLeftRow3BuckleBelted(@NonNull VehicleDataEventStatus leftRow3BuckleBelted) {
+ public BeltStatus setLeftRow3BuckleBelted(@NonNull VehicleDataEventStatus leftRow3BuckleBelted) {
setValue(KEY_LEFT_ROW_3_BUCKLE_BELTED, leftRow3BuckleBelted);
+ return this;
}
public VehicleDataEventStatus getLeftRow3BuckleBelted() {
return (VehicleDataEventStatus) getObject(VehicleDataEventStatus.class, KEY_LEFT_ROW_3_BUCKLE_BELTED);
}
- public void setRightRow3BuckleBelted(@NonNull VehicleDataEventStatus rightRow3BuckleBelted) {
+ public BeltStatus setRightRow3BuckleBelted(@NonNull VehicleDataEventStatus rightRow3BuckleBelted) {
setValue(KEY_RIGHT_ROW_3_BUCKLE_BELTED, rightRow3BuckleBelted);
+ return this;
}
public VehicleDataEventStatus getRightRow3BuckleBelted() {
return (VehicleDataEventStatus) getObject(VehicleDataEventStatus.class, KEY_RIGHT_ROW_3_BUCKLE_BELTED);
}
- public void setLeftRearInflatableBelted(@NonNull VehicleDataEventStatus rearInflatableBelted) {
+ public BeltStatus setLeftRearInflatableBelted(@NonNull VehicleDataEventStatus rearInflatableBelted) {
setValue(KEY_LEFT_REAR_INFLATABLE_BELTED, rearInflatableBelted);
+ return this;
}
public VehicleDataEventStatus getLeftRearInflatableBelted() {
return (VehicleDataEventStatus) getObject(VehicleDataEventStatus.class, KEY_LEFT_REAR_INFLATABLE_BELTED);
}
- public void setRightRearInflatableBelted(@NonNull VehicleDataEventStatus rightRearInflatableBelted) {
+ public BeltStatus setRightRearInflatableBelted(@NonNull VehicleDataEventStatus rightRearInflatableBelted) {
setValue(KEY_RIGHT_REAR_INFLATABLE_BELTED, rightRearInflatableBelted);
+ return this;
}
public VehicleDataEventStatus getRightRearInflatableBelted() {
return (VehicleDataEventStatus) getObject(VehicleDataEventStatus.class, KEY_RIGHT_REAR_INFLATABLE_BELTED);
}
- public void setMiddleRow1BeltDeployed(@NonNull VehicleDataEventStatus middleRow1BeltDeployed) {
+ public BeltStatus setMiddleRow1BeltDeployed(@NonNull VehicleDataEventStatus middleRow1BeltDeployed) {
setValue(KEY_MIDDLE_ROW_1_BELT_DEPLOYED, middleRow1BeltDeployed);
+ return this;
}
public VehicleDataEventStatus getMiddleRow1BeltDeployed() {
return (VehicleDataEventStatus) getObject(VehicleDataEventStatus.class, KEY_MIDDLE_ROW_1_BELT_DEPLOYED);
}
- public void setMiddleRow1BuckleBelted(@NonNull VehicleDataEventStatus middleRow1BuckleBelted) {
+ public BeltStatus setMiddleRow1BuckleBelted(@NonNull VehicleDataEventStatus middleRow1BuckleBelted) {
setValue(KEY_MIDDLE_ROW_1_BUCKLE_BELTED, middleRow1BuckleBelted);
+ return this;
}
public VehicleDataEventStatus getMiddleRow1BuckleBelted() {
return (VehicleDataEventStatus) getObject(VehicleDataEventStatus.class, KEY_MIDDLE_ROW_1_BUCKLE_BELTED);
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/BodyInformation.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/BodyInformation.java index a502e1df6..61379d9dc 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/BodyInformation.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/BodyInformation.java @@ -1,34 +1,34 @@ -/* - * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this - * list of conditions and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following - * disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its - * contributors may be used to endorse or promote products derived from this - * software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ +/*
+ * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
package com.smartdevicelink.proxy.rpc;
import androidx.annotation.NonNull;
@@ -142,50 +142,57 @@ public class BodyInformation extends RPCStruct { setIgnitionStableStatus(ignitionStableStatus);
setIgnitionStatus(ignitionStatus);
}
- public void setParkBrakeActive(@NonNull Boolean parkBrakeActive) {
+ public BodyInformation setParkBrakeActive(@NonNull Boolean parkBrakeActive) {
setValue(KEY_PARK_BRAKE_ACTIVE, parkBrakeActive);
+ return this;
}
public Boolean getParkBrakeActive() {
return getBoolean(KEY_PARK_BRAKE_ACTIVE);
}
- public void setIgnitionStableStatus(@NonNull IgnitionStableStatus ignitionStableStatus) {
+ public BodyInformation setIgnitionStableStatus(@NonNull IgnitionStableStatus ignitionStableStatus) {
setValue(KEY_IGNITION_STABLE_STATUS, ignitionStableStatus);
+ return this;
}
public IgnitionStableStatus getIgnitionStableStatus() {
return (IgnitionStableStatus) getObject(IgnitionStableStatus.class, KEY_IGNITION_STABLE_STATUS);
}
- public void setIgnitionStatus(@NonNull IgnitionStatus ignitionStatus) {
+ public BodyInformation setIgnitionStatus(@NonNull IgnitionStatus ignitionStatus) {
setValue(KEY_IGNITION_STATUS, ignitionStatus);
+ return this;
}
public IgnitionStatus getIgnitionStatus() {
return (IgnitionStatus) getObject(IgnitionStatus.class, KEY_IGNITION_STATUS);
}
- public void setDriverDoorAjar(Boolean driverDoorAjar) {
+ public BodyInformation setDriverDoorAjar( Boolean driverDoorAjar) {
setValue(KEY_DRIVER_DOOR_AJAR, driverDoorAjar);
- }
+ return this;
+ }
public Boolean getDriverDoorAjar() {
return getBoolean(KEY_DRIVER_DOOR_AJAR);
}
- public void setPassengerDoorAjar(Boolean passengerDoorAjar) {
+ public BodyInformation setPassengerDoorAjar( Boolean passengerDoorAjar) {
setValue(KEY_PASSENGER_DOOR_AJAR, passengerDoorAjar);
- }
+ return this;
+ }
public Boolean getPassengerDoorAjar() {
return getBoolean(KEY_PASSENGER_DOOR_AJAR);
}
- public void setRearLeftDoorAjar(Boolean rearLeftDoorAjar) {
+ public BodyInformation setRearLeftDoorAjar( Boolean rearLeftDoorAjar) {
setValue(KEY_REAR_LEFT_DOOR_AJAR, rearLeftDoorAjar);
- }
+ return this;
+ }
public Boolean getRearLeftDoorAjar() {
return getBoolean(KEY_REAR_LEFT_DOOR_AJAR);
}
- public void setRearRightDoorAjar(Boolean rearRightDoorAjar) {
+ public BodyInformation setRearRightDoorAjar( Boolean rearRightDoorAjar) {
setValue(KEY_REAR_RIGHT_DOOR_AJAR, rearRightDoorAjar);
- }
+ return this;
+ }
public Boolean getRearRightDoorAjar() {
return getBoolean(KEY_REAR_RIGHT_DOOR_AJAR);
}
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/ButtonCapabilities.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/ButtonCapabilities.java index 1a8cb4df9..d2d5246be 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/ButtonCapabilities.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/ButtonCapabilities.java @@ -133,9 +133,10 @@ public class ButtonCapabilities extends RPCStruct { /**
* Set the name of theSDL HMI button.
* @param name the name of button
- */
- public void setName( @NonNull ButtonName name ) {
+ */
+ public ButtonCapabilities setName(@NonNull ButtonName name) {
setValue(KEY_NAME, name);
+ return this;
}
/**
* Whether the button supports a SHORT press. See <i>{@linkplain com.smartdevicelink.proxy.rpc.enums.ButtonPressMode}</i> for more information.
@@ -147,9 +148,10 @@ public class ButtonCapabilities extends RPCStruct { /**
* Set the button supports a SHORT press. See <i>{@linkplain com.smartdevicelink.proxy.rpc.enums.ButtonPressMode}</i> for more information.
* @param shortPressAvailable True if support otherwise False.
- */
- public void setShortPressAvailable( @NonNull Boolean shortPressAvailable ) {
+ */
+ public ButtonCapabilities setShortPressAvailable(@NonNull Boolean shortPressAvailable) {
setValue(KEY_SHORT_PRESS_AVAILABLE, shortPressAvailable);
+ return this;
}
/**
* Whether the button supports a LONG press. See <i>{@linkplain com.smartdevicelink.proxy.rpc.enums.ButtonPressMode}</i> for more information.
@@ -161,9 +163,10 @@ public class ButtonCapabilities extends RPCStruct { /**
* Set the button supports a LONG press. See <i>{@linkplain com.smartdevicelink.proxy.rpc.enums.ButtonPressMode}</i> for more information.
* @param longPressAvailable True if support otherwise False.
- */
- public void setLongPressAvailable( @NonNull Boolean longPressAvailable ) {
+ */
+ public ButtonCapabilities setLongPressAvailable(@NonNull Boolean longPressAvailable) {
setValue(KEY_LONG_PRESS_AVAILABLE, longPressAvailable);
+ return this;
}
/**
* Whether the button supports "button down" and "button up". When the button is depressed, the <i>{@linkplain OnButtonEvent}</i> notification will be invoked with a value of BUTTONDOWN.
@@ -175,17 +178,19 @@ public class ButtonCapabilities extends RPCStruct { /**
* Set the button supports "button down" and "button up". When the button is depressed, the <i>{@linkplain OnButtonEvent}</i> notification will be invoked with a value of BUTTONDOWN.
* @param upDownAvailable True if support otherwise False.
- */
- public void setUpDownAvailable( @NonNull Boolean upDownAvailable ) {
+ */
+ public ButtonCapabilities setUpDownAvailable(@NonNull Boolean upDownAvailable) {
setValue(KEY_UP_DOWN_AVAILABLE, upDownAvailable);
+ return this;
}
/**
* Sets ModuleInfo for this capability
* @param info the ModuleInfo to be set
*/
- public void setModuleInfo(ModuleInfo info) {
+ public ButtonCapabilities setModuleInfo( ModuleInfo info) {
setValue(KEY_MODULE_INFO, info);
+ return this;
}
/**
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/ButtonPress.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/ButtonPress.java index 645ae336d..ecdac7b95 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/ButtonPress.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/ButtonPress.java @@ -96,8 +96,9 @@ public class ButtonPress extends RPCRequest { * @param moduleType * Represents module where the button should be pressed */ - public void setModuleType(@NonNull ModuleType moduleType) { + public ButtonPress setModuleType(@NonNull ModuleType moduleType) { setParameters(KEY_MODULE_TYPE, moduleType); + return this; } /** @@ -115,8 +116,9 @@ public class ButtonPress extends RPCRequest { * @param buttonName * Represents name of supported RC climate or radio button */ - public void setButtonName(@NonNull ButtonName buttonName) { + public ButtonPress setButtonName(@NonNull ButtonName buttonName) { setParameters(KEY_BUTTON_NAME, buttonName); + return this; } /** @@ -134,16 +136,18 @@ public class ButtonPress extends RPCRequest { * @param buttonPressMode * Indicates whether this is a LONG or SHORT button press event. */ - public void setButtonPressMode(@NonNull ButtonPressMode buttonPressMode) { + public ButtonPress setButtonPressMode(@NonNull ButtonPressMode buttonPressMode) { setParameters(KEY_BUTTON_PRESS_MODE, buttonPressMode); + return this; } /** * Sets the module id for this object * @param id the id to be set */ - public void setModuleId(String id) { + public ButtonPress setModuleId( String id) { setParameters(KEY_MODULE_ID, id); + return this; } /** diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/CancelInteraction.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/CancelInteraction.java index 9016458a6..16de2d9f7 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/CancelInteraction.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/CancelInteraction.java @@ -104,8 +104,9 @@ public class CancelInteraction extends RPCRequest { * Only values 10 (PerformInteractionID), 12 (AlertID), 25 (ScrollableMessageID), 26 (SliderID), and 64 (SubtleAlertID) are permitted. * @param functionID - the functionID */ - public void setInteractionFunctionID(@NonNull Integer functionID) { + public CancelInteraction setInteractionFunctionID(@NonNull Integer functionID) { setParameters(KEY_FUNCTION_ID, functionID); + return this; } /** @@ -120,7 +121,8 @@ public class CancelInteraction extends RPCRequest { * The ID of the specific interaction to dismiss. If not set, the most recent of the RPC type set in functionID will be dismissed. * @param cancelID - the cancelID */ - public void setCancelID(Integer cancelID) { + public CancelInteraction setCancelID( Integer cancelID) { setParameters(KEY_CANCEL_ID, cancelID); + return this; } }
\ No newline at end of file diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/ChangeRegistration.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/ChangeRegistration.java index 2087ea886..41dbe6f78 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/ChangeRegistration.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/ChangeRegistration.java @@ -1,34 +1,34 @@ -/* - * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this - * list of conditions and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following - * disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its - * contributors may be used to endorse or promote products derived from this - * software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ +/*
+ * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
package com.smartdevicelink.proxy.rpc;
import androidx.annotation.NonNull;
@@ -170,12 +170,13 @@ public class ChangeRegistration extends RPCRequest { /**
* Sets language
- *
+ *
* @param language
* a language value
*/
- public void setLanguage(@NonNull Language language) {
+ public ChangeRegistration setLanguage(@NonNull Language language) {
setParameters(KEY_LANGUAGE, language);
+ return this;
}
/**
@@ -189,12 +190,13 @@ public class ChangeRegistration extends RPCRequest { /**
* Sets HMI display language
- *
+ *
* @param hmiDisplayLanguage
* a Language value
*/
- public void setHmiDisplayLanguage(@NonNull Language hmiDisplayLanguage) {
+ public ChangeRegistration setHmiDisplayLanguage(@NonNull Language hmiDisplayLanguage) {
setParameters(KEY_HMI_DISPLAY_LANGUAGE, hmiDisplayLanguage);
+ return this;
}
/**
@@ -208,11 +210,12 @@ public class ChangeRegistration extends RPCRequest { /**
* Sets app name
- *
+ *
* @param appName App name to set
*/
- public void setAppName(String appName){
+ public ChangeRegistration setAppName( String appName) {
setParameters(KEY_APP_NAME, appName);
+ return this;
}
/**
@@ -226,11 +229,12 @@ public class ChangeRegistration extends RPCRequest { /**
* Sets NGN media screen app name
- *
+ *
* @param ngnAppName The NGN app name
*/
- public void setNgnMediaScreenAppName(String ngnAppName){
+ public ChangeRegistration setNgnMediaScreenAppName( String ngnAppName) {
setParameters(KEY_NGN_MEDIA_SCREEN_NAME, ngnAppName);
+ return this;
}
/**
@@ -244,11 +248,12 @@ public class ChangeRegistration extends RPCRequest { /**
* Sets the TTS name
- *
+ *
* @param ttsName The TTS name to set
*/
- public void setTtsName(List<TTSChunk> ttsName){
+ public ChangeRegistration setTtsName( List<TTSChunk> ttsName) {
setParameters(KEY_TTS_NAME, ttsName);
+ return this;
}
/**
@@ -277,7 +282,7 @@ public class ChangeRegistration extends RPCRequest { /**
* Sets a vrSynonyms representing the an array of 1-100 elements, each
* element containing a voice-recognition synonym
- *
+ *
* @param vrSynonyms
* a List<String> value representing the an array of 1-100
* elements
@@ -290,8 +295,9 @@ public class ChangeRegistration extends RPCRequest { * the name or any synonym of any currently-registered
* application</li>
* </ul>
- */
- public void setVrSynonyms(List<String> vrSynonyms) {
+ */
+ public ChangeRegistration setVrSynonyms( List<String> vrSynonyms) {
setParameters(KEY_VR_SYNONYMS, vrSynonyms);
+ return this;
}
}
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/Choice.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/Choice.java index 72fb49a91..aca5f86d5 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/Choice.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/Choice.java @@ -171,9 +171,10 @@ public class Choice extends RPCStruct { /**
* Set the application-scoped identifier that uniquely identifies this choice.
* @param choiceID Min: 0 Max: 65535
- */
- public void setChoiceID(@NonNull Integer choiceID) {
+ */
+ public Choice setChoiceID(@NonNull Integer choiceID) {
setValue(KEY_CHOICE_ID, choiceID);
+ return this;
}
/**
* Text which appears in menu, representing this choice.
@@ -189,9 +190,10 @@ public class Choice extends RPCStruct { * Min: 1;
* Max: 100
* @param menuName the menu name
- */
- public void setMenuName(@NonNull String menuName) {
+ */
+ public Choice setMenuName(@NonNull String menuName) {
setValue(KEY_MENU_NAME, menuName);
+ return this;
}
/**
* Get an array of strings to be used as VR synonyms for this choice. If this array is provided, it must have at least one non-empty element
@@ -206,16 +208,18 @@ public class Choice extends RPCStruct { * Set an array of strings to be used as VR synonyms for this choice. If this array is provided, it must have at least one non-empty element
* @param vrCommands the List of vrCommands
* @since SmartDeviceLink 2.0
- */
- public void setVrCommands(List<String> vrCommands) {
+ */
+ public Choice setVrCommands( List<String> vrCommands) {
setValue(KEY_VR_COMMANDS, vrCommands);
+ return this;
}
/**
* Set the image
* @param image the image of the choice
- */
- public void setImage(Image image) {
+ */
+ public Choice setImage( Image image) {
setValue(KEY_IMAGE, image);
+ return this;
}
/**
* Get the image
@@ -230,20 +234,23 @@ public class Choice extends RPCStruct { return getString(KEY_SECONDARY_TEXT);
}
- public void setSecondaryText(String secondaryText) {
+ public Choice setSecondaryText( String secondaryText) {
setValue(KEY_SECONDARY_TEXT, secondaryText);
+ return this;
}
public String getTertiaryText() {
return getString(KEY_TERTIARY_TEXT);
}
- public void setTertiaryText(String tertiaryText) {
+ public Choice setTertiaryText( String tertiaryText) {
setValue(KEY_TERTIARY_TEXT, tertiaryText);
+ return this;
}
- public void setSecondaryImage(Image image) {
+ public Choice setSecondaryImage( Image image) {
setValue(KEY_SECONDARY_IMAGE, image);
+ return this;
}
@SuppressWarnings("unchecked")
@@ -255,7 +262,8 @@ public class Choice extends RPCStruct { * This prevents the @{link Choice#format} method from adding VR commands if set to true
* @param ignoreAddingVRItems - whether or not to let the format method add vr commands
*/
- public void setIgnoreAddingVRItems(boolean ignoreAddingVRItems){
+ public Choice setIgnoreAddingVRItems( boolean ignoreAddingVRItems) {
this.ignoreAddingVRItems = ignoreAddingVRItems;
+ return this;
}
}
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/ClimateControlCapabilities.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/ClimateControlCapabilities.java index 856087fda..1c3140d6f 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/ClimateControlCapabilities.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/ClimateControlCapabilities.java @@ -86,8 +86,9 @@ public class ClimateControlCapabilities extends RPCStruct{ * * @param moduleName The short friendly name of the climate control module. It should not be used to identify a module by mobile application. */ - public void setModuleName(@NonNull String moduleName) { + public ClimateControlCapabilities setModuleName(@NonNull String moduleName) { setValue(KEY_MODULE_NAME, moduleName); + return this; } /** @@ -106,8 +107,9 @@ public class ClimateControlCapabilities extends RPCStruct{ * Availability of the control of fan speed. * True: Available, False: Not Available, Not present: Not Available. */ - public void setFanSpeedAvailable(Boolean fanSpeedAvailable) { + public ClimateControlCapabilities setFanSpeedAvailable( Boolean fanSpeedAvailable) { setValue(KEY_FAN_SPEED_AVAILABLE, fanSpeedAvailable); + return this; } /** @@ -127,8 +129,9 @@ public class ClimateControlCapabilities extends RPCStruct{ * Availability of the control of desired temperature. * True: Available, False: Not Available, Not present: Not Available. */ - public void setDesiredTemperatureAvailable(Boolean desiredTemperatureAvailable) { + public ClimateControlCapabilities setDesiredTemperatureAvailable( Boolean desiredTemperatureAvailable) { setValue(KEY_DESIRED_TEMPERATURE_AVAILABLE, desiredTemperatureAvailable); + return this; } /** @@ -148,8 +151,9 @@ public class ClimateControlCapabilities extends RPCStruct{ * Availability of the control of turn on/off AC. * True: Available, False: Not Available, Not present: Not Available. */ - public void setAcEnableAvailable(Boolean acEnableAvailable) { + public ClimateControlCapabilities setAcEnableAvailable( Boolean acEnableAvailable) { setValue(KEY_AC_ENABLE_AVAILABLE, acEnableAvailable); + return this; } /** @@ -169,8 +173,9 @@ public class ClimateControlCapabilities extends RPCStruct{ * Availability of the control of enable/disable air conditioning is ON on the maximum level. * True: Available, False: Not Available, Not present: Not Available. */ - public void setAcMaxEnableAvailable(Boolean acMaxEnableAvailable) { + public ClimateControlCapabilities setAcMaxEnableAvailable( Boolean acMaxEnableAvailable) { setValue(KEY_AC_MAX_ENABLE_AVAILABLE, acMaxEnableAvailable); + return this; } /** @@ -190,8 +195,9 @@ public class ClimateControlCapabilities extends RPCStruct{ * Availability of the control of enable/disable circulate Air mode. * True: Available, False: Not Available, Not present: Not Available. */ - public void setCirculateAirEnableAvailable(Boolean circulateAirEnableAvailable) { + public ClimateControlCapabilities setCirculateAirEnableAvailable( Boolean circulateAirEnableAvailable) { setValue(KEY_CIRCULATE_AIR_ENABLE_AVAILABLE, circulateAirEnableAvailable); + return this; } /** @@ -211,8 +217,9 @@ public class ClimateControlCapabilities extends RPCStruct{ * Availability of the control of enable/disable auto mode. * True: Available, False: Not Available, Not present: Not Available. */ - public void setAutoModeEnableAvailable(Boolean autoModeEnableAvailable) { + public ClimateControlCapabilities setAutoModeEnableAvailable( Boolean autoModeEnableAvailable) { setValue(KEY_AUTO_MODE_ENABLE_AVAILABLE, autoModeEnableAvailable); + return this; } /** @@ -232,8 +239,9 @@ public class ClimateControlCapabilities extends RPCStruct{ * Availability of the control of enable/disable dual mode. * True: Available, False: Not Available, Not present: Not Available. */ - public void setDualModeEnableAvailable(Boolean dualModeEnableAvailable) { + public ClimateControlCapabilities setDualModeEnableAvailable( Boolean dualModeEnableAvailable) { setValue(KEY_DUAL_MODE_ENABLE_AVAILABLE, dualModeEnableAvailable); + return this; } /** @@ -253,8 +261,9 @@ public class ClimateControlCapabilities extends RPCStruct{ * Availability of the control of defrost zones. * True: Available, False: Not Available, Not present: Not Available. */ - public void setDefrostZoneAvailable(Boolean defrostZoneAvailable) { + public ClimateControlCapabilities setDefrostZoneAvailable( Boolean defrostZoneAvailable) { setValue(KEY_DEFROST_ZONE_AVAILABLE, defrostZoneAvailable); + return this; } /** @@ -282,8 +291,9 @@ public class ClimateControlCapabilities extends RPCStruct{ * @param defrostZone * A set of all defrost zones that are controllable. */ - public void setDefrostZone(List<DefrostZone> defrostZone) { + public ClimateControlCapabilities setDefrostZone( List<DefrostZone> defrostZone) { setValue(KEY_DEFROST_ZONE, defrostZone); + return this; } /** @@ -293,8 +303,9 @@ public class ClimateControlCapabilities extends RPCStruct{ * Availability of the control of air ventilation mode. * True: Available, False: Not Available, Not present: Not Available. */ - public void setVentilationModeAvailable(Boolean ventilationModeAvailable) { + public ClimateControlCapabilities setVentilationModeAvailable( Boolean ventilationModeAvailable) { setValue(KEY_VENTILATION_MODE_AVAILABLE, ventilationModeAvailable); + return this; } /** @@ -322,8 +333,9 @@ public class ClimateControlCapabilities extends RPCStruct{ * @param ventilationMode * A set of all ventilation modes that are controllable. */ - public void setVentilationMode(List<VentilationMode> ventilationMode) { + public ClimateControlCapabilities setVentilationMode( List<VentilationMode> ventilationMode) { setValue(KEY_VENTILATION_MODE, ventilationMode); + return this; } /** @@ -332,8 +344,9 @@ public class ClimateControlCapabilities extends RPCStruct{ * @param heatedSteeringWheelAvailable Availability of the control (enable/disable) of heated Steering Wheel. * True: Available, False: Not Available, Not present: Not Available. */ - public void setHeatedSteeringWheelAvailable(Boolean heatedSteeringWheelAvailable) { + public ClimateControlCapabilities setHeatedSteeringWheelAvailable( Boolean heatedSteeringWheelAvailable) { setValue(KEY_HEATED_STEERING_WHEEL_AVAILABLE, heatedSteeringWheelAvailable); + return this; } /** @@ -352,8 +365,9 @@ public class ClimateControlCapabilities extends RPCStruct{ * @param heatedWindshieldAvailable Availability of the control (enable/disable) of heated Windshield. * True: Available, False: Not Available, Not present: Not Available. */ - public void setHeatedWindshieldAvailable(Boolean heatedWindshieldAvailable) { + public ClimateControlCapabilities setHeatedWindshieldAvailable( Boolean heatedWindshieldAvailable) { setValue(KEY_HEATED_WIND_SHIELD_AVAILABLE, heatedWindshieldAvailable); + return this; } /** @@ -372,8 +386,9 @@ public class ClimateControlCapabilities extends RPCStruct{ * @param heatedRearWindowAvailable Availability of the control (enable/disable) of heated Rear Window. * True: Available, False: Not Available, Not present: Not Available. */ - public void setHeatedRearWindowAvailable(Boolean heatedRearWindowAvailable) { + public ClimateControlCapabilities setHeatedRearWindowAvailable( Boolean heatedRearWindowAvailable) { setValue(KEY_HEATED_REAR_WINDOW_AVAILABLE, heatedRearWindowAvailable); + return this; } /** @@ -392,8 +407,9 @@ public class ClimateControlCapabilities extends RPCStruct{ * @param heatedMirrorsAvailable Availability of the control (enable/disable) of heated Mirrors. * True: Available, False: Not Available, Not present: Not Available. */ - public void setHeatedMirrorsAvailable(Boolean heatedMirrorsAvailable) { + public ClimateControlCapabilities setHeatedMirrorsAvailable( Boolean heatedMirrorsAvailable) { setValue(KEY_HEATED_MIRRORS_AVAILABLE, heatedMirrorsAvailable); + return this; } /** @@ -410,8 +426,9 @@ public class ClimateControlCapabilities extends RPCStruct{ * Sets ModuleInfo for this capability * @param info the ModuleInfo to be set */ - public void setModuleInfo(ModuleInfo info) { + public ClimateControlCapabilities setModuleInfo( ModuleInfo info) { setValue(KEY_MODULE_INFO, info); + return this; } /** @@ -427,8 +444,9 @@ public class ClimateControlCapabilities extends RPCStruct{ * @param climateEnableAvailable Availability of the control of enable/disable climate control. * True: Available, False: Not Available, Not present: Not Available. */ - public void setClimateEnableAvailable(Boolean climateEnableAvailable) { + public ClimateControlCapabilities setClimateEnableAvailable( Boolean climateEnableAvailable) { setValue(KEY_CLIMATE_ENABLE_AVAILABLE, climateEnableAvailable); + return this; } /** diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/ClimateControlData.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/ClimateControlData.java index 365a74044..de243bc8d 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/ClimateControlData.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/ClimateControlData.java @@ -61,80 +61,90 @@ public class ClimateControlData extends RPCStruct{ super(hash); } - public void setFanSpeed(Integer fanSpeed) { + public ClimateControlData setFanSpeed( Integer fanSpeed) { setValue(KEY_FAN_SPEED, fanSpeed); + return this; } public Integer getFanSpeed() { return getInteger(KEY_FAN_SPEED); } - public void setCurrentTemperature(Temperature currentTemperature) { + public ClimateControlData setCurrentTemperature( Temperature currentTemperature) { setValue(KEY_CURRENT_TEMPERATURE, currentTemperature); + return this; } public Temperature getCurrentTemperature() { return (Temperature) getObject(Temperature.class, KEY_CURRENT_TEMPERATURE); } - public void setDesiredTemperature(Temperature desiredTemperature) { + public ClimateControlData setDesiredTemperature( Temperature desiredTemperature) { setValue(KEY_DESIRED_TEMPERATURE, desiredTemperature); + return this; } public Temperature getDesiredTemperature() { return (Temperature) getObject(Temperature.class, KEY_DESIRED_TEMPERATURE); } - public void setAcEnable(Boolean acEnable) { + public ClimateControlData setAcEnable( Boolean acEnable) { setValue(KEY_AC_ENABLE, acEnable); + return this; } public Boolean getAcEnable() { return getBoolean(KEY_AC_ENABLE); } - public void setCirculateAirEnable(Boolean circulateAirEnable) { + public ClimateControlData setCirculateAirEnable( Boolean circulateAirEnable) { setValue(KEY_CIRCULATE_AIR_ENABLE, circulateAirEnable); + return this; } public Boolean getCirculateAirEnable() { return getBoolean(KEY_CIRCULATE_AIR_ENABLE); } - public void setAutoModeEnable(Boolean autoModeEnable) { + public ClimateControlData setAutoModeEnable( Boolean autoModeEnable) { setValue(KEY_AUTO_MODE_ENABLE, autoModeEnable); + return this; } public Boolean getAutoModeEnable() { return getBoolean(KEY_AUTO_MODE_ENABLE); } - public void setDefrostZone(DefrostZone defrostZone) { + public ClimateControlData setDefrostZone( DefrostZone defrostZone) { setValue(KEY_DEFROST_ZONE, defrostZone); + return this; } public DefrostZone getDefrostZone() { return (DefrostZone) getObject(DefrostZone.class, KEY_DEFROST_ZONE); } - public void setDualModeEnable(Boolean dualModeEnable) { + public ClimateControlData setDualModeEnable( Boolean dualModeEnable) { setValue(KEY_DUAL_MODE_ENABLE, dualModeEnable); + return this; } public Boolean getDualModeEnable() { return getBoolean(KEY_DUAL_MODE_ENABLE); } - public void setAcMaxEnable(Boolean acMaxEnable) { + public ClimateControlData setAcMaxEnable( Boolean acMaxEnable) { setValue(KEY_AC_MAX_ENABLE, acMaxEnable); + return this; } public Boolean getAcMaxEnable() { return getBoolean(KEY_AC_MAX_ENABLE); } - public void setVentilationMode(VentilationMode ventilationMode) { + public ClimateControlData setVentilationMode( VentilationMode ventilationMode) { setValue(KEY_VENTILATION_MODE, ventilationMode); + return this; } public VentilationMode getVentilationMode() { @@ -146,8 +156,9 @@ public class ClimateControlData extends RPCStruct{ * * @param heatedSteeringWheelEnable Value false means disabled/turn off, value true means enabled/turn on. */ - public void setHeatedSteeringWheelEnable(Boolean heatedSteeringWheelEnable) { + public ClimateControlData setHeatedSteeringWheelEnable( Boolean heatedSteeringWheelEnable) { setValue(KEY_HEATED_STEERING_WHEEL_ENABLE, heatedSteeringWheelEnable); + return this; } /** @@ -164,8 +175,9 @@ public class ClimateControlData extends RPCStruct{ * * @param heatedWindshieldEnable Value false means disabled, value true means enabled. */ - public void setHeatedWindshieldEnable(Boolean heatedWindshieldEnable) { + public ClimateControlData setHeatedWindshieldEnable( Boolean heatedWindshieldEnable) { setValue(KEY_HEATED_WIND_SHIELD_ENABLE, heatedWindshieldEnable); + return this; } /** @@ -182,8 +194,9 @@ public class ClimateControlData extends RPCStruct{ * * @param heatedRearWindowEnable Value false means disabled, value true means enabled. */ - public void setHeatedRearWindowEnable(Boolean heatedRearWindowEnable) { + public ClimateControlData setHeatedRearWindowEnable( Boolean heatedRearWindowEnable) { setValue(KEY_HEATED_REAR_WINDOW_ENABLE, heatedRearWindowEnable); + return this; } /** @@ -200,8 +213,9 @@ public class ClimateControlData extends RPCStruct{ * * @param heatedMirrorsEnable Value false means disabled, value true means enabled. */ - public void setHeatedMirrorsEnable(Boolean heatedMirrorsEnable) { + public ClimateControlData setHeatedMirrorsEnable( Boolean heatedMirrorsEnable) { setValue(KEY_HEATED_MIRRORS_ENABLE, heatedMirrorsEnable); + return this; } /** @@ -218,8 +232,9 @@ public class ClimateControlData extends RPCStruct{ * * @param climateEnable Value false means disabled, value true means enabled. */ - public void setClimateEnable(Boolean climateEnable) { + public ClimateControlData setClimateEnable( Boolean climateEnable) { setValue(KEY_CLIMATE_ENABLE, climateEnable); + return this; } /** diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/CloudAppProperties.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/CloudAppProperties.java index 1c81ce95b..59035fc27 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/CloudAppProperties.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/CloudAppProperties.java @@ -63,8 +63,9 @@ public class CloudAppProperties extends RPCStruct { setValue(KEY_APP_ID, appID); } - public void setNicknames(List<String> nicknames){ + public CloudAppProperties setNicknames( List<String> nicknames) { setValue(KEY_NICKNAMES, nicknames); + return this; } @SuppressWarnings("unchecked") @@ -72,8 +73,9 @@ public class CloudAppProperties extends RPCStruct { return (List<String>) getObject(String.class, KEY_NICKNAMES); } - public void setAppID(@NonNull String appID){ + public CloudAppProperties setAppID(@NonNull String appID) { setValue(KEY_APP_ID, appID); + return this; } public String getAppID(){ @@ -84,8 +86,9 @@ public class CloudAppProperties extends RPCStruct { * If true, this cloud app entry will designate it should appear in the HMI * @param enabled if the app should be */ - public void setEnabled(boolean enabled){ + public CloudAppProperties setEnabled( boolean enabled) { setValue(KEY_ENABLED, enabled); + return this; } /** @@ -95,24 +98,27 @@ public class CloudAppProperties extends RPCStruct { return getBoolean(KEY_ENABLED); } - public void setAuthToken(String token){ + public CloudAppProperties setAuthToken( String token) { setValue(KEY_AUTH_TOKEN, token); + return this; } public String getAuthToken(){ return getString(KEY_AUTH_TOKEN); } - public void setCloudTransportType(String transportType){ + public CloudAppProperties setCloudTransportType( String transportType) { setValue(KEY_CLOUD_TRANSPORT_TYPE, transportType); + return this; } public String getCloudTransportType(){ return getString(KEY_CLOUD_TRANSPORT_TYPE); } - public void setHybridAppPreference(HybridAppPreference hybridAppPreference){ + public CloudAppProperties setHybridAppPreference( HybridAppPreference hybridAppPreference) { setValue(KEY_HYBRID_APP_PREFERENCE, hybridAppPreference); + return this; } public HybridAppPreference getHybridAppPreference(){ @@ -122,8 +128,9 @@ public class CloudAppProperties extends RPCStruct { /** * @param token - max length ="65535" */ - public void setEndpoint(String token){ + public CloudAppProperties setEndpoint( String token) { setValue(KEY_ENDPOINT, token); + return this; } /** diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/ClusterModeStatus.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/ClusterModeStatus.java index 98aa2a060..94b3aed05 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/ClusterModeStatus.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/ClusterModeStatus.java @@ -1,34 +1,34 @@ -/* - * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this - * list of conditions and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following - * disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its - * contributors may be used to endorse or promote products derived from this - * software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ +/*
+ * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
package com.smartdevicelink.proxy.rpc;
import androidx.annotation.NonNull;
@@ -109,27 +109,31 @@ public class ClusterModeStatus extends RPCStruct { setPowerModeStatus(powerModeStatus);
}
- public void setPowerModeActive(@NonNull Boolean powerModeActive) {
- setValue(KEY_POWER_MODE_ACTIVE, powerModeActive);
- }
+ public ClusterModeStatus setPowerModeActive(@NonNull Boolean powerModeActive) {
+ setValue(KEY_POWER_MODE_ACTIVE, powerModeActive);
+ return this;
+ }
public Boolean getPowerModeActive() {
return getBoolean(KEY_POWER_MODE_ACTIVE);
}
- public void setPowerModeQualificationStatus(@NonNull PowerModeQualificationStatus powerModeQualificationStatus) {
- setValue(KEY_POWER_MODE_QUALIFICATION_STATUS, powerModeQualificationStatus);
- }
+ public ClusterModeStatus setPowerModeQualificationStatus(@NonNull PowerModeQualificationStatus powerModeQualificationStatus) {
+ setValue(KEY_POWER_MODE_QUALIFICATION_STATUS, powerModeQualificationStatus);
+ return this;
+ }
public PowerModeQualificationStatus getPowerModeQualificationStatus() {
return (PowerModeQualificationStatus) getObject(PowerModeQualificationStatus.class, KEY_POWER_MODE_QUALIFICATION_STATUS);
}
- public void setCarModeStatus(@NonNull CarModeStatus carModeStatus) {
- setValue(KEY_CAR_MODE_STATUS, carModeStatus);
- }
+ public ClusterModeStatus setCarModeStatus(@NonNull CarModeStatus carModeStatus) {
+ setValue(KEY_CAR_MODE_STATUS, carModeStatus);
+ return this;
+ }
public CarModeStatus getCarModeStatus() {
return (CarModeStatus) getObject(CarModeStatus.class, KEY_CAR_MODE_STATUS);
}
- public void setPowerModeStatus(@NonNull PowerModeStatus powerModeStatus) {
- setValue(KEY_POWER_MODE_STATUS, powerModeStatus);
- }
+ public ClusterModeStatus setPowerModeStatus(@NonNull PowerModeStatus powerModeStatus) {
+ setValue(KEY_POWER_MODE_STATUS, powerModeStatus);
+ return this;
+ }
public PowerModeStatus getPowerModeStatus() {
return (PowerModeStatus) getObject(PowerModeStatus.class, KEY_POWER_MODE_STATUS);
}
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/Coordinate.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/Coordinate.java index 970692dab..bc41103d5 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/Coordinate.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/Coordinate.java @@ -60,8 +60,9 @@ public class Coordinate extends RPCStruct{ return SdlDataTypeConverter.objectToFloat(value); } - public void setLatitudeDegrees(@NonNull Float latitudeDegrees) { + public Coordinate setLatitudeDegrees(@NonNull Float latitudeDegrees) { setValue(KEY_LATITUDE_DEGREES, latitudeDegrees); + return this; } public Float getLongitudeDegrees() { @@ -69,7 +70,8 @@ public class Coordinate extends RPCStruct{ return SdlDataTypeConverter.objectToFloat(value); } - public void setLongitudeDegrees(@NonNull Float longitudeDegrees) { + public Coordinate setLongitudeDegrees(@NonNull Float longitudeDegrees) { setValue(KEY_LONGITUDE_DEGREES, longitudeDegrees); + return this; } } diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/CreateInteractionChoiceSet.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/CreateInteractionChoiceSet.java index be638065b..32e09dde3 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/CreateInteractionChoiceSet.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/CreateInteractionChoiceSet.java @@ -1,34 +1,34 @@ -/* - * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this - * list of conditions and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following - * disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its - * contributors may be used to endorse or promote products derived from this - * software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ +/*
+ * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
package com.smartdevicelink.proxy.rpc;
import androidx.annotation.NonNull;
@@ -148,14 +148,15 @@ public class CreateInteractionChoiceSet extends RPCRequest { }
/**
* Sets a unique ID that identifies the Choice Set
- *
+ *
* @param interactionChoiceSetID
* an Integer value representing the Choice Set ID
- *
+ *
* <b>Notes: </b>Min Value: 0; Max Value: 2000000000
- */
- public void setInteractionChoiceSetID( @NonNull Integer interactionChoiceSetID ) {
- setParameters(KEY_INTERACTION_CHOICE_SET_ID, interactionChoiceSetID);
+ */
+ public CreateInteractionChoiceSet setInteractionChoiceSetID(@NonNull Integer interactionChoiceSetID) {
+ setParameters(KEY_INTERACTION_CHOICE_SET_ID, interactionChoiceSetID);
+ return this;
}
/**
* Gets Choice Set Array of one or more elements
@@ -169,14 +170,15 @@ public class CreateInteractionChoiceSet extends RPCRequest { }
/**
* Sets a Choice Set that is an Array of one or more elements
- *
+ *
* @param choiceSet
* a List<Choice> representing the array of one or more
* elements
- *
+ *
* <b>Notes: </b>Min Value: 1; Max Value: 100
- */
- public void setChoiceSet( @NonNull List<Choice> choiceSet ) {
- setParameters(KEY_CHOICE_SET, choiceSet);
+ */
+ public CreateInteractionChoiceSet setChoiceSet(@NonNull List<Choice> choiceSet) {
+ setParameters(KEY_CHOICE_SET, choiceSet);
+ return this;
}
}
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/CreateWindow.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/CreateWindow.java index 6184bb059..976d00f9e 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/CreateWindow.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/CreateWindow.java @@ -60,8 +60,9 @@ public class CreateWindow extends RPCRequest { *
* @param windowID A unique ID to identify the window. The value of '0' will always be the default main window on the main display and should not be used in this context as it will already be created for the app. See PredefinedWindows enum. Creating a window with an ID that is already in use will be rejected with `INVALID_ID`.
*/
- public void setWindowID(@NonNull Integer windowID) {
+ public CreateWindow setWindowID(@NonNull Integer windowID) {
setParameters(KEY_WINDOW_ID, windowID);
+ return this;
}
/**
@@ -83,8 +84,9 @@ public class CreateWindow extends RPCRequest { * Multiple apps can share the same window name except for the default main window.
* {@code windowName.length() <= 100}
*/
- public void setWindowName(@NonNull String windowName) {
+ public CreateWindow setWindowName(@NonNull String windowName) {
setParameters(KEY_WINDOW_NAME, windowName);
+ return this;
}
/**
@@ -101,8 +103,9 @@ public class CreateWindow extends RPCRequest { *
* @param type The type of the window to be created. Main window or widget.
*/
- public void setType(@NonNull WindowType type) {
+ public CreateWindow setType(@NonNull WindowType type) {
setParameters(KEY_TYPE, type);
+ return this;
}
/**
@@ -127,8 +130,9 @@ public class CreateWindow extends RPCRequest { * @param associatedServiceType Allows an app to create a widget related to a specific service type.
* As an example if a `MEDIA` app becomes active, this app becomes audible and is allowed to play audio.
*/
- public void setAssociatedServiceType(String associatedServiceType) {
+ public CreateWindow setAssociatedServiceType( String associatedServiceType) {
setParameters(KEY_ASSOCIATED_SERVICE_TYPE, associatedServiceType);
+ return this;
}
/**
@@ -148,8 +152,9 @@ public class CreateWindow extends RPCRequest { *
* @param duplicateUpdatesFromWindowID Specify whether the content sent to an existing window should be duplicated to the created window.
*/
- public void setDuplicateUpdatesFromWindowID(Integer duplicateUpdatesFromWindowID) {
+ public CreateWindow setDuplicateUpdatesFromWindowID( Integer duplicateUpdatesFromWindowID) {
setParameters(KEY_DUPLICATE_UPDATES_FROM_WINDOW_ID, duplicateUpdatesFromWindowID);
+ return this;
}
/**
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/DIDResult.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/DIDResult.java index 8cd8e9c18..73d45282d 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/DIDResult.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/DIDResult.java @@ -1,34 +1,34 @@ -/* - * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this - * list of conditions and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following - * disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its - * contributors may be used to endorse or promote products derived from this - * software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ +/*
+ * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
package com.smartdevicelink.proxy.rpc;
import androidx.annotation.NonNull;
@@ -96,20 +96,23 @@ public class DIDResult extends RPCStruct { setResultCode(resultCode);
setDidLocation(didLocation);
}
- public void setResultCode(@NonNull VehicleDataResultCode resultCode) {
- setValue(KEY_RESULT_CODE, resultCode);
+ public DIDResult setResultCode(@NonNull VehicleDataResultCode resultCode) {
+ setValue(KEY_RESULT_CODE, resultCode);
+ return this;
}
public VehicleDataResultCode getResultCode() {
return (VehicleDataResultCode) getObject(VehicleDataResultCode.class, KEY_RESULT_CODE);
}
- public void setDidLocation(@NonNull Integer didLocation) {
- setValue(KEY_DID_LOCATION, didLocation);
+ public DIDResult setDidLocation(@NonNull Integer didLocation) {
+ setValue(KEY_DID_LOCATION, didLocation);
+ return this;
}
public Integer getDidLocation() {
return getInteger(KEY_DID_LOCATION);
}
- public void setData(String data) {
- setValue(KEY_DATA, data);
+ public DIDResult setData( String data) {
+ setValue(KEY_DATA, data);
+ return this;
}
public String getData() {
return getString(KEY_DATA);
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/DTC.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/DTC.java index 697514a08..9b7623129 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/DTC.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/DTC.java @@ -1,34 +1,34 @@ -/* - * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this - * list of conditions and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following - * disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its - * contributors may be used to endorse or promote products derived from this - * software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ +/*
+ * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
package com.smartdevicelink.proxy.rpc;
import com.smartdevicelink.proxy.RPCStruct;
@@ -78,8 +78,9 @@ public class DTC extends RPCStruct { * set identifier
* @param identifier the hexadecimal id of the DTC
*/
- public void setIdentifier(String identifier) {
- setValue(KEY_IDENTIFIER, identifier);
+ public DTC setIdentifier( String identifier) {
+ setValue(KEY_IDENTIFIER, identifier);
+ return this;
}
/**
@@ -94,8 +95,9 @@ public class DTC extends RPCStruct { * set Hexadecimal byte string
* @param statusByte Hexadecimal byte string
*/
- public void setStatusByte(String statusByte) {
- setValue(KEY_STATUS_BYTE, statusByte);
+ public DTC setStatusByte( String statusByte) {
+ setValue(KEY_STATUS_BYTE, statusByte);
+ return this;
}
/**
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/DateTime.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/DateTime.java index 2335743d0..ab3f61140 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/DateTime.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/DateTime.java @@ -66,13 +66,14 @@ public class DateTime extends RPCStruct{ /** * Sets the Milliseconds portion of the DateTime class - * + * * @param milliSecond * The milliseconds associated with this DateTime class - * - */ - public void setMilliSecond(Integer milliSecond) { + * + */ + public DateTime setMilliSecond( Integer milliSecond) { setValue(KEY_MILLISECOND, milliSecond); + return this; } @@ -88,13 +89,14 @@ public class DateTime extends RPCStruct{ /** * Sets the Seconds portion of the DateTime class - * + * * @param second * The Seconds associated with this DateTime class - * + * */ - public void setSecond(Integer second) { + public DateTime setSecond( Integer second) { setValue(KEY_SECOND, second); + return this; } @@ -110,13 +112,14 @@ public class DateTime extends RPCStruct{ /** * Sets the Minutes portion of the DateTime class - * + * * @param minute * The Minutes associated with this DateTime class - * - */ - public void setMinute(Integer minute) { + * + */ + public DateTime setMinute( Integer minute) { setValue(KEY_MINUTE, minute); + return this; } /** @@ -130,14 +133,15 @@ public class DateTime extends RPCStruct{ } /** - * Sets the Hours portion of the DateTime class. - * + * Sets the Hours portion of the DateTime class. + * * @param hour * The Hours associated with this DateTime class. This structure is used to store hours in a 24 hour format. - * - */ - public void setHour(Integer hour) { + * + */ + public DateTime setHour( Integer hour) { setValue(KEY_HOUR, hour); + return this; } /** @@ -152,13 +156,14 @@ public class DateTime extends RPCStruct{ /** * Sets the Day portion of the DateTime class - * + * * @param day * The Day of the month associated with this DateTime class - * - */ - public void setDay(Integer day) { + * + */ + public DateTime setDay( Integer day) { setValue(KEY_DAY, day); + return this; } /** @@ -173,13 +178,14 @@ public class DateTime extends RPCStruct{ /** * Sets the Month portion of the DateTime class - * + * * @param month * The Month of the year associate with this DateTime class - * - */ - public void setMonth(Integer month) { + * + */ + public DateTime setMonth( Integer month) { setValue(KEY_MONTH, month); + return this; } /** @@ -194,13 +200,14 @@ public class DateTime extends RPCStruct{ /** * Sets the Year portion of the DateTime class - * + * * @param year * The Year in YYYY format associated with this DateTime class - * - */ - public void setYear(Integer year) { + * + */ + public DateTime setYear( Integer year) { setValue(KEY_YEAR, year); + return this; } /** @@ -215,13 +222,14 @@ public class DateTime extends RPCStruct{ /** * Sets the Time Zone Hours portion of the DateTime class - * + * * @param tzHour * The time zone offset in Hours with regard to UTC time associated with this DateTime class - * - */ - public void setTzHour(Integer tzHour) { + * + */ + public DateTime setTzHour( Integer tzHour) { setValue(KEY_TZ_HOUR, tzHour); + return this; } /** @@ -236,11 +244,12 @@ public class DateTime extends RPCStruct{ /** * Sets the Time Zone Minutes portion of the DateTime class - * + * * @param tzMinute * The time zone offset in Minutes with regard to UTC associated with this DateTime class - */ - public void setTzMinute(Integer tzMinute) { + */ + public DateTime setTzMinute( Integer tzMinute) { setValue(KEY_TZ_MINUTE, tzMinute); + return this; } } diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/DeleteCommand.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/DeleteCommand.java index e102e9427..35b96387f 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/DeleteCommand.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/DeleteCommand.java @@ -1,34 +1,34 @@ -/* - * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this - * list of conditions and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following - * disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its - * contributors may be used to endorse or promote products derived from this - * software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ +/*
+ * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
package com.smartdevicelink.proxy.rpc;
import androidx.annotation.NonNull;
@@ -125,13 +125,14 @@ public class DeleteCommand extends RPCRequest { }
/**
* Sets the Command ID that identifies the Command to be deleted from Command Menu
- *
+ *
* @param cmdID
* an Integer value representing Command ID
- *
+ *
* <p><b>Notes: </b>Min Value: 0; Max Value: 2000000000</p>
- */
- public void setCmdID( @NonNull Integer cmdID ) {
- setParameters(KEY_CMD_ID, cmdID);
+ */
+ public DeleteCommand setCmdID(@NonNull Integer cmdID) {
+ setParameters(KEY_CMD_ID, cmdID);
+ return this;
}
}
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/DeleteFile.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/DeleteFile.java index 177171027..b855f1bbf 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/DeleteFile.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/DeleteFile.java @@ -1,34 +1,34 @@ -/* - * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this - * list of conditions and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following - * disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its - * contributors may be used to endorse or promote products derived from this - * software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ +/*
+ * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
package com.smartdevicelink.proxy.rpc;
import androidx.annotation.NonNull;
@@ -105,12 +105,13 @@ public class DeleteFile extends RPCRequest { /**
* Sets a file reference name
- *
+ *
* @param sdlFileName
* a String value representing a file reference name
*/
- public void setSdlFileName(@NonNull String sdlFileName) {
- setParameters(KEY_SDL_FILE_NAME, sdlFileName);
+ public DeleteFile setSdlFileName(@NonNull String sdlFileName) {
+ setParameters(KEY_SDL_FILE_NAME, sdlFileName);
+ return this;
}
/**
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/DeleteFileResponse.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/DeleteFileResponse.java index e1076935b..bea9a1b65 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/DeleteFileResponse.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/DeleteFileResponse.java @@ -90,8 +90,9 @@ public class DeleteFileResponse extends RPCResponse { super.format(rpcVersion, formatParams);
}
- public void setSpaceAvailable(Integer spaceAvailable) {
+ public DeleteFileResponse setSpaceAvailable( Integer spaceAvailable) {
setParameters(KEY_SPACE_AVAILABLE, spaceAvailable);
+ return this;
}
public Integer getSpaceAvailable() {
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/DeleteInteractionChoiceSet.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/DeleteInteractionChoiceSet.java index e3d0d5c86..3bfc56e72 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/DeleteInteractionChoiceSet.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/DeleteInteractionChoiceSet.java @@ -1,34 +1,34 @@ -/* - * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this - * list of conditions and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following - * disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its - * contributors may be used to endorse or promote products derived from this - * software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ +/*
+ * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
package com.smartdevicelink.proxy.rpc;
import androidx.annotation.NonNull;
@@ -131,8 +131,9 @@ public class DeleteInteractionChoiceSet extends RPCRequest { * Sets a unique ID that identifies the Choice Set
* @param interactionChoiceSetID a unique ID that identifies the Choice Set
* <p><b>Notes: </b>Min Value: 0; Max Value: 2000000000 </p>
- */
- public void setInteractionChoiceSetID( @NonNull Integer interactionChoiceSetID ) {
- setParameters(KEY_INTERACTION_CHOICE_SET_ID, interactionChoiceSetID);
+ */
+ public DeleteInteractionChoiceSet setInteractionChoiceSetID(@NonNull Integer interactionChoiceSetID) {
+ setParameters(KEY_INTERACTION_CHOICE_SET_ID, interactionChoiceSetID);
+ return this;
}
}
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/DeleteSubMenu.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/DeleteSubMenu.java index e526013c8..22306a668 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/DeleteSubMenu.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/DeleteSubMenu.java @@ -1,34 +1,34 @@ -/* - * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this - * list of conditions and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following - * disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its - * contributors may be used to endorse or promote products derived from this - * software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ +/*
+ * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
package com.smartdevicelink.proxy.rpc;
import androidx.annotation.NonNull;
@@ -118,12 +118,13 @@ public class DeleteSubMenu extends RPCRequest { return getInteger( KEY_MENU_ID );
}
/**
- * Sets the MenuID that identifies the SubMenu to be delete
+ * Sets the MenuID that identifies the SubMenu to be delete
* @param menuID an Integer value representing menuID that identifies the SubMenu to be delete
- *
+ *
* <p><b>Notes: </b>Min Value: 0; Max Value: 2000000000</p>
- */
- public void setMenuID( @NonNull Integer menuID ) {
+ */
+ public DeleteSubMenu setMenuID(@NonNull Integer menuID) {
setParameters(KEY_MENU_ID, menuID);
+ return this;
}
}
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/DeleteWindow.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/DeleteWindow.java index 4e78b95a7..06c00736a 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/DeleteWindow.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/DeleteWindow.java @@ -50,8 +50,9 @@ public class DeleteWindow extends RPCRequest { *
* @param windowID A unique ID to identify the window. The value of '0' will always be the default main window on the main display and should not be used in this context as it will already be created for the app. See PredefinedWindows enum. Creating a window with an ID that is already in use will be rejected with `INVALID_ID`.
*/
- public void setWindowID(@NonNull Integer windowID) {
+ public DeleteWindow setWindowID(@NonNull Integer windowID) {
setParameters(KEY_WINDOW_ID, windowID);
+ return this;
}
/**
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/DeviceInfo.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/DeviceInfo.java index c19068eb0..7c98b1e84 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/DeviceInfo.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/DeviceInfo.java @@ -119,41 +119,46 @@ public class DeviceInfo extends RPCStruct{ super(hash);
}
- public void setHardware(String hardware) {
+ public DeviceInfo setHardware( String hardware) {
setValue(KEY_HARDWARE, hardware);
- }
+ return this;
+ }
public String getHardware() {
return getString(KEY_HARDWARE);
}
- public void setFirmwareRev(String firmwareRev) {
- setValue(KEY_FIRMWARE_REV, firmwareRev);
- }
+ public DeviceInfo setFirmwareRev( String firmwareRev) {
+ setValue(KEY_FIRMWARE_REV, firmwareRev);
+ return this;
+ }
public String getFirmwareRev() {
return getString(KEY_FIRMWARE_REV);
}
- public void setOs(String os) {
- setValue(KEY_OS, os);
- }
+ public DeviceInfo setOs( String os) {
+ setValue(KEY_OS, os);
+ return this;
+ }
public String getOs() {
return getString(KEY_OS);
}
- public void setOsVersion(String osVersion) {
- setValue(KEY_OS_VERSION, osVersion);
-}
+ public DeviceInfo setOsVersion( String osVersion) {
+ setValue(KEY_OS_VERSION, osVersion);
+ return this;
+ }
public String getOsVersion() {
return getString(KEY_OS_VERSION);
}
-public void setCarrier(String carrier) {
- setValue(KEY_CARRIER, carrier);
-}
+public DeviceInfo setCarrier( String carrier) {
+ setValue(KEY_CARRIER, carrier);
+ return this;
+ }
public String getCarrier() {
return getString(KEY_CARRIER);
@@ -163,8 +168,9 @@ public Integer getMaxNumberRFCOMMPorts() { return getInteger( KEY_MAX_NUMBER_RFCOMM_PORTS );
}
-public void setMaxNumberRFCOMMPorts( Integer maxNumberRFCOMMPorts ) {
- setValue(KEY_MAX_NUMBER_RFCOMM_PORTS, maxNumberRFCOMMPorts);
-}
+public DeviceInfo setMaxNumberRFCOMMPorts( Integer maxNumberRFCOMMPorts) {
+ setValue(KEY_MAX_NUMBER_RFCOMM_PORTS, maxNumberRFCOMMPorts);
+ return this;
+ }
}
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/DeviceStatus.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/DeviceStatus.java index 8748014f2..78ff3a91b 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/DeviceStatus.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/DeviceStatus.java @@ -1,34 +1,34 @@ -/* - * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this - * list of conditions and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following - * disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its - * contributors may be used to endorse or promote products derived from this - * software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ +/*
+ * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
package com.smartdevicelink.proxy.rpc;
import androidx.annotation.NonNull;
@@ -194,8 +194,9 @@ public class DeviceStatus extends RPCStruct { * set the voice recognition on or off
* @param voiceRecOn
*/
- public void setVoiceRecOn(@NonNull Boolean voiceRecOn) {
+ public DeviceStatus setVoiceRecOn(@NonNull Boolean voiceRecOn) {
setValue(KEY_VOICE_REC_ON, voiceRecOn);
+ return this;
}
/**
@@ -210,8 +211,9 @@ public class DeviceStatus extends RPCStruct { * set the bluetooth connection established
* @param btIconOn the bluetooth connection established
*/
- public void setBtIconOn(@NonNull Boolean btIconOn) {
+ public DeviceStatus setBtIconOn(@NonNull Boolean btIconOn) {
setValue(KEY_BT_ICON_ON, btIconOn);
+ return this;
}
/**
@@ -226,8 +228,9 @@ public class DeviceStatus extends RPCStruct { * set a call is being active
* @param callActive a call is being active
*/
- public void setCallActive(@NonNull Boolean callActive) {
+ public DeviceStatus setCallActive(@NonNull Boolean callActive) {
setValue(KEY_CALL_ACTIVE, callActive);
+ return this;
}
/**
@@ -242,8 +245,9 @@ public class DeviceStatus extends RPCStruct { * set the phone is in roaming mode
* @param phoneRoaming the phone is in roaming mode
*/
- public void setPhoneRoaming(@NonNull Boolean phoneRoaming) {
+ public DeviceStatus setPhoneRoaming(@NonNull Boolean phoneRoaming) {
setValue(KEY_PHONE_ROAMING, phoneRoaming);
+ return this;
}
/**
@@ -253,8 +257,9 @@ public class DeviceStatus extends RPCStruct { public Boolean getPhoneRoaming() {
return getBoolean(KEY_PHONE_ROAMING);
}
- public void setTextMsgAvailable(@NonNull Boolean textMsgAvailable) {
+ public DeviceStatus setTextMsgAvailable(@NonNull Boolean textMsgAvailable) {
setValue(KEY_TEXT_MSG_AVAILABLE, textMsgAvailable);
+ return this;
}
/**
@@ -269,8 +274,9 @@ public class DeviceStatus extends RPCStruct { * set battery level status
* @param battLevelStatus battery level status
*/
- public void setBattLevelStatus(@NonNull DeviceLevelStatus battLevelStatus) {
+ public DeviceStatus setBattLevelStatus(@NonNull DeviceLevelStatus battLevelStatus) {
setValue(KEY_BATT_LEVEL_STATUS, battLevelStatus);
+ return this;
}
/**
@@ -285,8 +291,9 @@ public class DeviceStatus extends RPCStruct { * set the status of the stereo audio output channel
* @param stereoAudioOutputMuted the status of the stereo audio output channel
*/
- public void setStereoAudioOutputMuted(@NonNull Boolean stereoAudioOutputMuted) {
+ public DeviceStatus setStereoAudioOutputMuted(@NonNull Boolean stereoAudioOutputMuted) {
setValue(KEY_STEREO_AUDIO_OUTPUT_MUTED, stereoAudioOutputMuted);
+ return this;
}
/**
@@ -301,8 +308,9 @@ public class DeviceStatus extends RPCStruct { * set the status of the mono audio output channel
* @param monoAudioOutputMuted the status of the mono audio output channel
*/
- public void setMonoAudioOutputMuted(@NonNull Boolean monoAudioOutputMuted) {
+ public DeviceStatus setMonoAudioOutputMuted(@NonNull Boolean monoAudioOutputMuted) {
setValue(KEY_MONO_AUDIO_OUTPUT_MUTED, monoAudioOutputMuted);
+ return this;
}
/**
@@ -317,8 +325,9 @@ public class DeviceStatus extends RPCStruct { * set signal level status
* @param signalLevelStatus signal level status
*/
- public void setSignalLevelStatus(@NonNull DeviceLevelStatus signalLevelStatus) {
+ public DeviceStatus setSignalLevelStatus(@NonNull DeviceLevelStatus signalLevelStatus) {
setValue(KEY_SIGNAL_LEVEL_STATUS, signalLevelStatus);
+ return this;
}
/**
@@ -333,8 +342,9 @@ public class DeviceStatus extends RPCStruct { * set the current primary audio source of SDL (if selected).
* @param primaryAudioSource the current primary audio source of SDL (if selected).
*/
- public void setPrimaryAudioSource(@NonNull PrimaryAudioSource primaryAudioSource) {
+ public DeviceStatus setPrimaryAudioSource(@NonNull PrimaryAudioSource primaryAudioSource) {
setValue(KEY_PRIMARY_AUDIO_SOURCE, primaryAudioSource);
+ return this;
}
/**
@@ -344,8 +354,9 @@ public class DeviceStatus extends RPCStruct { public PrimaryAudioSource getPrimaryAudioSource() {
return (PrimaryAudioSource) getObject(PrimaryAudioSource.class, KEY_PRIMARY_AUDIO_SOURCE);
}
- public void setECallEventActive(@NonNull Boolean eCallEventActive) {
+ public DeviceStatus setECallEventActive(@NonNull Boolean eCallEventActive) {
setValue(KEY_E_CALL_EVENT_ACTIVE, eCallEventActive);
+ return this;
}
public Boolean getECallEventActive() {
return getBoolean(KEY_E_CALL_EVENT_ACTIVE);
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/DiagnosticMessage.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/DiagnosticMessage.java index effba93a9..ddfcccf7c 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/DiagnosticMessage.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/DiagnosticMessage.java @@ -1,34 +1,34 @@ -/* - * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this - * list of conditions and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following - * disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its - * contributors may be used to endorse or promote products derived from this - * software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ +/*
+ * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
package com.smartdevicelink.proxy.rpc;
import androidx.annotation.NonNull;
@@ -123,8 +123,9 @@ public class DiagnosticMessage extends RPCRequest { *
* @param targetID the target for this Diagnostic Message
*/
- public void setTargetID(@NonNull Integer targetID) {
- setParameters(KEY_TARGET_ID, targetID);
+ public DiagnosticMessage setTargetID(@NonNull Integer targetID) {
+ setParameters(KEY_TARGET_ID, targetID);
+ return this;
}
/**
@@ -138,8 +139,9 @@ public class DiagnosticMessage extends RPCRequest { return getInteger(KEY_TARGET_ID);
}
- public void setMessageLength(@NonNull Integer messageLength) {
- setParameters(KEY_MESSAGE_LENGTH, messageLength);
+ public DiagnosticMessage setMessageLength(@NonNull Integer messageLength) {
+ setParameters(KEY_MESSAGE_LENGTH, messageLength);
+ return this;
}
public Integer getMessageLength() {
return getInteger(KEY_MESSAGE_LENGTH);
@@ -150,7 +152,8 @@ public class DiagnosticMessage extends RPCRequest { return (List<Integer>) getObject(Integer.class, KEY_MESSAGE_DATA);
}
- public void setMessageData(@NonNull List<Integer> messageData) {
- setParameters(KEY_MESSAGE_DATA, messageData);
- }
+ public DiagnosticMessage setMessageData(@NonNull List<Integer> messageData) {
+ setParameters(KEY_MESSAGE_DATA, messageData);
+ return this;
+ }
}
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/DiagnosticMessageResponse.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/DiagnosticMessageResponse.java index c1a1cf5cb..38aee38b0 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/DiagnosticMessageResponse.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/DiagnosticMessageResponse.java @@ -74,8 +74,9 @@ public class DiagnosticMessageResponse extends RPCResponse { return (List<Integer>) getObject(Integer.class, KEY_MESSAGE_DATA_RESULT);
}
- public void setMessageDataResult(List<Integer> messageDataResult) {
+ public DiagnosticMessageResponse setMessageDataResult( List<Integer> messageDataResult) {
setParameters(KEY_MESSAGE_DATA_RESULT, messageDataResult);
+ return this;
}
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/DialNumber.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/DialNumber.java index 989617456..472bca08d 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/DialNumber.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/DialNumber.java @@ -68,11 +68,12 @@ public class DialNumber extends RPCRequest { * <b>Notes: </b>Maxlength=40</p> * All characters shall be stripped from string except digits 0-9 and * # , ; + */ - public void setNumber(@NonNull String number) { + public DialNumber setNumber(@NonNull String number) { if (number != null) { number = number.replaceAll("[^0-9*#,;+]", ""); //This will sanitize the input } setParameters(KEY_NUMBER, number); + return this; } /** diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/DisplayCapabilities.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/DisplayCapabilities.java index 43b4b408e..15d9c5f39 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/DisplayCapabilities.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/DisplayCapabilities.java @@ -167,8 +167,9 @@ public class DisplayCapabilities extends RPCStruct { * @param displayType the display type
*/
@Deprecated
- public void setDisplayType( @NonNull DisplayType displayType ) {
+ public DisplayCapabilities setDisplayType(@NonNull DisplayType displayType) {
setValue(KEY_DISPLAY_TYPE, displayType);
+ return this;
}
/** Get the name of the display
* @return the name of the display
@@ -180,8 +181,9 @@ public class DisplayCapabilities extends RPCStruct { * Set the name of the display
* @param displayName the name of the display
*/
- public void setDisplayName( String displayName ) {
+ public DisplayCapabilities setDisplayName( String displayName) {
setValue(KEY_DISPLAY_NAME, displayName);
+ return this;
}
/**
*Get an array of TextField structures, each of which describes a field in the HMI which the application can write to using operations such as <i>{@linkplain Show}</i>, <i>{@linkplain SetMediaClockTimer}</i>, etc.
@@ -193,12 +195,13 @@ public class DisplayCapabilities extends RPCStruct { return (List<TextField>) getObject(TextField.class, KEY_TEXT_FIELDS);
}
/**
- * Set an array of TextField structures, each of which describes a field in the HMI which the application can write to using operations such as <i>{@linkplain Show}</i>, <i>{@linkplain SetMediaClockTimer}</i>, etc.
+ * Set an array of TextField structures, each of which describes a field in the HMI which the application can write to using operations such as <i>{@linkplain Show}</i>, <i>{@linkplain SetMediaClockTimer}</i>, etc.
* This array of TextField structures identify all the text fields to which the application can write on the current display (identified by DisplayType ).
* @param textFields the List of textFields
- */
- public void setTextFields( @NonNull List<TextField> textFields ) {
+ */
+ public DisplayCapabilities setTextFields(@NonNull List<TextField> textFields) {
setValue(KEY_TEXT_FIELDS, textFields);
+ return this;
}
@@ -208,16 +211,18 @@ public class DisplayCapabilities extends RPCStruct { return (List<ImageField>) getObject(ImageField.class, KEY_IMAGE_FIELDS);
}
- public void setImageFields( List<ImageField> imageFields ) {
+ public DisplayCapabilities setImageFields( List<ImageField> imageFields) {
setValue(KEY_IMAGE_FIELDS, imageFields);
- }
+ return this;
+ }
public Integer getNumCustomPresetsAvailable() {
return getInteger(KEY_NUM_CUSTOM_PRESETS_AVAILABLE);
}
- public void setNumCustomPresetsAvailable(Integer numCustomPresetsAvailable) {
+ public DisplayCapabilities setNumCustomPresetsAvailable( Integer numCustomPresetsAvailable) {
setValue(KEY_NUM_CUSTOM_PRESETS_AVAILABLE, numCustomPresetsAvailable);
+ return this;
}
/**
@@ -231,9 +236,10 @@ public class DisplayCapabilities extends RPCStruct { /**
* Set an array of MediaClockFormat elements, defining the valid string formats used in specifying the contents of the media clock field
* @param mediaClockFormats the List of MediaClockFormat
- */
- public void setMediaClockFormats( @NonNull List<MediaClockFormat> mediaClockFormats ) {
+ */
+ public DisplayCapabilities setMediaClockFormats(@NonNull List<MediaClockFormat> mediaClockFormats) {
setValue(KEY_MEDIA_CLOCK_FORMATS, mediaClockFormats);
+ return this;
}
/**
@@ -241,8 +247,9 @@ public class DisplayCapabilities extends RPCStruct { * @param graphicSupported true if the display supports graphics, false if it does not
* @since SmartDeviceLink 2.0
*/
- public void setGraphicSupported(@NonNull Boolean graphicSupported) {
- setValue(KEY_GRAPHIC_SUPPORTED, graphicSupported);
+ public DisplayCapabilities setGraphicSupported(@NonNull Boolean graphicSupported) {
+ setValue(KEY_GRAPHIC_SUPPORTED, graphicSupported);
+ return this;
}
/**
@@ -259,12 +266,14 @@ public class DisplayCapabilities extends RPCStruct { return (List<String>) getObject(String.class, KEY_TEMPLATES_AVAILABLE);
}
- public void setTemplatesAvailable(List<String> templatesAvailable) {
+ public DisplayCapabilities setTemplatesAvailable( List<String> templatesAvailable) {
setValue(KEY_TEMPLATES_AVAILABLE, templatesAvailable);
+ return this;
}
- public void setScreenParams(ScreenParams screenParams) {
+ public DisplayCapabilities setScreenParams( ScreenParams screenParams) {
setValue(KEY_SCREEN_PARAMS, screenParams);
+ return this;
}
@SuppressWarnings("unchecked")
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/DisplayCapability.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/DisplayCapability.java index 992083689..a071d915f 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/DisplayCapability.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/DisplayCapability.java @@ -36,8 +36,9 @@ public class DisplayCapability extends RPCStruct { * * @param displayName the name of the display */ - public void setDisplayName(String displayName) { + public DisplayCapability setDisplayName( String displayName) { setValue(KEY_DISPLAY_NAME, displayName); + return this; } /** @@ -46,8 +47,9 @@ public class DisplayCapability extends RPCStruct { * * @param windowTypeSupported It informs the application how many windows the app is allowed to create per type. */ - public void setWindowTypeSupported(List<WindowTypeCapabilities> windowTypeSupported) { + public DisplayCapability setWindowTypeSupported( List<WindowTypeCapabilities> windowTypeSupported) { setValue(KEY_WINDOW_TYPE_SUPPORTED, windowTypeSupported); + return this; } /** @@ -72,8 +74,9 @@ public class DisplayCapability extends RPCStruct { * 1. App creates a new window. After the window is created, a system capability notification will be sent related only to the created window. * 2. App sets a new template to the window. The new template changes window capabilties. The notification will reflect those changes to the single window. */ - public void setWindowCapabilities(List<WindowCapability> windowCapabilities) { + public DisplayCapability setWindowCapabilities( List<WindowCapability> windowCapabilities) { setValue(KEY_WINDOW_CAPABILITIES, windowCapabilities); + return this; } /** diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/DriverDistractionCapability.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/DriverDistractionCapability.java index c09a77f46..67d9bb434 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/DriverDistractionCapability.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/DriverDistractionCapability.java @@ -87,8 +87,9 @@ public class DriverDistractionCapability extends RPCStruct { * * @param menuLength The number of items allowed in a Choice Set or Command menu while the driver is distracted */ - public void setMenuLength(Integer menuLength) { + public DriverDistractionCapability setMenuLength( Integer menuLength) { setValue(KEY_MENU_LENGTH, menuLength); + return this; } /** @@ -106,8 +107,9 @@ public class DriverDistractionCapability extends RPCStruct { * @param subMenuDepth The depth of submenus allowed when the driver is distracted. e.g. 3 == top level menu -> * submenu -> submenu; 1 == top level menu only */ - public void setSubMenuDepth(Integer subMenuDepth) { + public DriverDistractionCapability setSubMenuDepth( Integer subMenuDepth) { setValue(KEY_SUB_MENU_DEPTH, subMenuDepth); + return this; } /** diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/DynamicUpdateCapabilities.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/DynamicUpdateCapabilities.java index f8b16ce29..d70523356 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/DynamicUpdateCapabilities.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/DynamicUpdateCapabilities.java @@ -93,8 +93,9 @@ public class DynamicUpdateCapabilities extends RPCStruct { * you upload the data with PutFile at a later point when the HMI needs it. The HMI will then * display the image in the appropriate field. If not sent, assume false. */ - public void setSupportedDynamicImageFieldNames(List<ImageFieldName> supportedDynamicImageFieldNames) { + public DynamicUpdateCapabilities setSupportedDynamicImageFieldNames( List<ImageFieldName> supportedDynamicImageFieldNames) { setValue(KEY_SUPPORTED_DYNAMIC_IMAGE_FIELD_NAMES, supportedDynamicImageFieldNames); + return this; } /** @@ -119,8 +120,9 @@ public class DynamicUpdateCapabilities extends RPCStruct { * AddSubMenu until OnUpdateSubMenu is received with the menuID. At that point, you should * send all AddCommands with a parentID that match the menuID. If not set, assume false. */ - public void setSupportsDynamicSubMenus(Boolean supportsDynamicSubMenus) { + public DynamicUpdateCapabilities setSupportsDynamicSubMenus( Boolean supportsDynamicSubMenus) { setValue(KEY_SUPPORTS_DYNAMIC_SUB_MENUS, supportsDynamicSubMenus); + return this; } /** diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/ECallInfo.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/ECallInfo.java index 03c69af0a..c1bd8d476 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/ECallInfo.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/ECallInfo.java @@ -1,34 +1,34 @@ -/* - * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this - * list of conditions and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following - * disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its - * contributors may be used to endorse or promote products derived from this - * software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ +/*
+ * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
package com.smartdevicelink.proxy.rpc;
import androidx.annotation.NonNull;
@@ -107,20 +107,23 @@ public class ECallInfo extends RPCStruct { setECallConfirmationStatus(eCallConfirmationStatus);
}
- public void setECallNotificationStatus(@NonNull VehicleDataNotificationStatus eCallNotificationStatus) {
+ public ECallInfo setECallNotificationStatus(@NonNull VehicleDataNotificationStatus eCallNotificationStatus) {
setValue(KEY_E_CALL_NOTIFICATION_STATUS, eCallNotificationStatus);
+ return this;
}
public VehicleDataNotificationStatus getECallNotificationStatus() {
return (VehicleDataNotificationStatus) getObject(VehicleDataNotificationStatus.class, KEY_E_CALL_NOTIFICATION_STATUS);
}
- public void setAuxECallNotificationStatus(@NonNull VehicleDataNotificationStatus auxECallNotificationStatus) {
+ public ECallInfo setAuxECallNotificationStatus(@NonNull VehicleDataNotificationStatus auxECallNotificationStatus) {
setValue(KEY_AUX_E_CALL_NOTIFICATION_STATUS, auxECallNotificationStatus);
+ return this;
}
public VehicleDataNotificationStatus getAuxECallNotificationStatus() {
return (VehicleDataNotificationStatus) getObject(VehicleDataNotificationStatus.class, KEY_AUX_E_CALL_NOTIFICATION_STATUS);
}
- public void setECallConfirmationStatus(@NonNull ECallConfirmationStatus eCallConfirmationStatus) {
+ public ECallInfo setECallConfirmationStatus(@NonNull ECallConfirmationStatus eCallConfirmationStatus) {
setValue(KEY_E_CALL_CONFIRMATION_STATUS, eCallConfirmationStatus);
+ return this;
}
public ECallConfirmationStatus getECallConfirmationStatus() {
return (ECallConfirmationStatus) getObject(ECallConfirmationStatus.class, KEY_E_CALL_CONFIRMATION_STATUS);
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/EmergencyEvent.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/EmergencyEvent.java index 6c22dc83d..923ad39fd 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/EmergencyEvent.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/EmergencyEvent.java @@ -1,34 +1,34 @@ -/* - * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this - * list of conditions and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following - * disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its - * contributors may be used to endorse or promote products derived from this - * software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ +/*
+ * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
package com.smartdevicelink.proxy.rpc;
import androidx.annotation.NonNull;
@@ -132,32 +132,37 @@ public class EmergencyEvent extends RPCStruct { setMultipleEvents(multipleEvents);
}
- public void setEmergencyEventType(@NonNull EmergencyEventType emergencyEventType) {
+ public EmergencyEvent setEmergencyEventType(@NonNull EmergencyEventType emergencyEventType) {
setValue(KEY_EMERGENCY_EVENT_TYPE, emergencyEventType);
+ return this;
}
public EmergencyEventType getEmergencyEventType() {
return (EmergencyEventType) getObject(EmergencyEventType.class, KEY_EMERGENCY_EVENT_TYPE);
}
- public void setFuelCutoffStatus(@NonNull FuelCutoffStatus fuelCutoffStatus) {
+ public EmergencyEvent setFuelCutoffStatus(@NonNull FuelCutoffStatus fuelCutoffStatus) {
setValue(KEY_FUEL_CUTOFF_STATUS, fuelCutoffStatus);
+ return this;
}
public FuelCutoffStatus getFuelCutoffStatus() {
return (FuelCutoffStatus) getObject(FuelCutoffStatus.class, KEY_FUEL_CUTOFF_STATUS);
}
- public void setRolloverEvent(@NonNull VehicleDataEventStatus rolloverEvent) {
+ public EmergencyEvent setRolloverEvent(@NonNull VehicleDataEventStatus rolloverEvent) {
setValue(KEY_ROLLOVER_EVENT, rolloverEvent);
+ return this;
}
public VehicleDataEventStatus getRolloverEvent() {
return (VehicleDataEventStatus) getObject(VehicleDataEventStatus.class, KEY_ROLLOVER_EVENT);
}
- public void setMaximumChangeVelocity(@NonNull Integer maximumChangeVelocity) {
+ public EmergencyEvent setMaximumChangeVelocity(@NonNull Integer maximumChangeVelocity) {
setValue(KEY_MAXIMUM_CHANGE_VELOCITY, maximumChangeVelocity);
+ return this;
}
public Integer getMaximumChangeVelocity() {
return getInteger(KEY_MAXIMUM_CHANGE_VELOCITY);
}
- public void setMultipleEvents(@NonNull VehicleDataEventStatus multipleEvents) {
+ public EmergencyEvent setMultipleEvents(@NonNull VehicleDataEventStatus multipleEvents) {
setValue(KEY_MULTIPLE_EVENTS, multipleEvents);
+ return this;
}
public VehicleDataEventStatus getMultipleEvents() {
return (VehicleDataEventStatus) getObject(VehicleDataEventStatus.class, KEY_MULTIPLE_EVENTS);
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/EqualizerSettings.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/EqualizerSettings.java index 81c7f100c..509545143 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/EqualizerSettings.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/EqualizerSettings.java @@ -77,9 +77,10 @@ public class EqualizerSettings extends RPCStruct { * * @param channelId ID that represents the channel these settings should be applied */ - public void setChannelId(@NonNull Integer channelId) { - setValue(KEY_CHANNEL_ID, channelId); - } + public EqualizerSettings setChannelId(@NonNull Integer channelId) { + setValue(KEY_CHANNEL_ID, channelId); + return this; + } /** * Gets the channelId portion of the EqualizerSettings class @@ -95,9 +96,10 @@ public class EqualizerSettings extends RPCStruct { * * @param channelName Read-only channel / frequency name (e.i. "Treble, Midrange, Bass" or "125 Hz"). */ - public void setChannelName(String channelName) { - setValue(KEY_CHANNEL_NAME, channelName); - } + public EqualizerSettings setChannelName( String channelName) { + setValue(KEY_CHANNEL_NAME, channelName); + return this; + } /** * Gets the channelName portion of the EqualizerSettings class @@ -113,9 +115,10 @@ public class EqualizerSettings extends RPCStruct { * * @param channelSetting Reflects the setting, from 0%-100%. */ - public void setChannelSetting(@NonNull Integer channelSetting) { - setValue(KEY_CHANNEL_SETTING, channelSetting); - } + public EqualizerSettings setChannelSetting(@NonNull Integer channelSetting) { + setValue(KEY_CHANNEL_SETTING, channelSetting); + return this; + } /** * Gets the channelSetting portion of the EqualizerSettings class diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/FuelRange.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/FuelRange.java index 334f6eb4e..549ce6862 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/FuelRange.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/FuelRange.java @@ -132,10 +132,11 @@ public class FuelRange extends RPCStruct { * * @param fuelType the type of fuel related to this FuelRange object. * - * @see com.smartdevicelink.proxy.rpc.enums.FuelType + * @see FuelType */ - public void setType(FuelType fuelType) { + public FuelRange setType( FuelType fuelType) { setValue(KEY_TYPE, fuelType); + return this; } /** @@ -163,8 +164,9 @@ public class FuelRange extends RPCStruct { * @param range * The estimate range in KM the vehicle can travel based on fuel level and consumption. */ - public void setRange(Float range) { + public FuelRange setRange( Float range) { setValue(KEY_RANGE, range); + return this; } /** @@ -174,8 +176,9 @@ public class FuelRange extends RPCStruct { * {"num_min_value": -6.0, "num_max_value": 1000000.0} * @since SmartDeviceLink 7.0.0 */ - public void setLevel(Float level) { + public FuelRange setLevel( Float level) { setValue(KEY_LEVEL, level); + return this; } /** @@ -196,8 +199,9 @@ public class FuelRange extends RPCStruct { * @param levelState The fuel level state * @since SmartDeviceLink 7.0.0 */ - public void setLevelState(ComponentVolumeStatus levelState) { + public FuelRange setLevelState( ComponentVolumeStatus levelState) { setValue(KEY_LEVEL_STATE, levelState); + return this; } /** @@ -217,8 +221,9 @@ public class FuelRange extends RPCStruct { * {"num_min_value": 0.0, "num_max_value": 1000000.0} * @since SmartDeviceLink 7.0.0 */ - public void setCapacity(Float capacity) { + public FuelRange setCapacity( Float capacity) { setValue(KEY_CAPACITY, capacity); + return this; } /** @@ -240,8 +245,9 @@ public class FuelRange extends RPCStruct { * batteries. * @since SmartDeviceLink 7.0.0 */ - public void setCapacityUnit(CapacityUnit capacityUnit) { + public FuelRange setCapacityUnit( CapacityUnit capacityUnit) { setValue(KEY_CAPACITY_UNIT, capacityUnit); + return this; } /** diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/GPSData.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/GPSData.java index f36cd6127..98d85a739 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/GPSData.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/GPSData.java @@ -222,8 +222,9 @@ public class GPSData extends RPCStruct { * set longitude degrees
* @param longitudeDegrees degrees of the longitudinal position
*/
- public void setLongitudeDegrees(@NonNull Double longitudeDegrees) {
- setValue(KEY_LONGITUDE_DEGREES, longitudeDegrees);
+ public GPSData setLongitudeDegrees(@NonNull Double longitudeDegrees) {
+ setValue(KEY_LONGITUDE_DEGREES, longitudeDegrees);
+ return this;
}
/**
@@ -239,8 +240,9 @@ public class GPSData extends RPCStruct { * set latitude degrees
* @param latitudeDegrees degrees of the latitudinal position
*/
- public void setLatitudeDegrees(@NonNull Double latitudeDegrees) {
- setValue(KEY_LATITUDE_DEGREES, latitudeDegrees);
+ public GPSData setLatitudeDegrees(@NonNull Double latitudeDegrees) {
+ setValue(KEY_LATITUDE_DEGREES, latitudeDegrees);
+ return this;
}
/**
@@ -256,8 +258,9 @@ public class GPSData extends RPCStruct { * set utc year
* @param utcYear utc year
*/
- public void setUtcYear(Integer utcYear) {
- setValue(KEY_UTC_YEAR, utcYear);
+ public GPSData setUtcYear( Integer utcYear) {
+ setValue(KEY_UTC_YEAR, utcYear);
+ return this;
}
/**
@@ -272,8 +275,9 @@ public class GPSData extends RPCStruct { * set utc month
* @param utcMonth utc month
*/
- public void setUtcMonth(Integer utcMonth) {
- setValue(KEY_UTC_MONTH, utcMonth);
+ public GPSData setUtcMonth( Integer utcMonth) {
+ setValue(KEY_UTC_MONTH, utcMonth);
+ return this;
}
/**
@@ -288,8 +292,9 @@ public class GPSData extends RPCStruct { * set utc day
* @param utcDay utc day
*/
- public void setUtcDay(Integer utcDay) {
- setValue(KEY_UTC_DAY, utcDay);
+ public GPSData setUtcDay( Integer utcDay) {
+ setValue(KEY_UTC_DAY, utcDay);
+ return this;
}
/**
@@ -304,8 +309,9 @@ public class GPSData extends RPCStruct { * set utc hours
* @param utcHours utc hours
*/
- public void setUtcHours(Integer utcHours) {
- setValue(KEY_UTC_HOURS, utcHours);
+ public GPSData setUtcHours( Integer utcHours) {
+ setValue(KEY_UTC_HOURS, utcHours);
+ return this;
}
/**
@@ -320,8 +326,9 @@ public class GPSData extends RPCStruct { * set utc minutes
* @param utcMinutes utc minutes
*/
- public void setUtcMinutes(Integer utcMinutes) {
- setValue(KEY_UTC_MINUTES, utcMinutes);
+ public GPSData setUtcMinutes( Integer utcMinutes) {
+ setValue(KEY_UTC_MINUTES, utcMinutes);
+ return this;
}
/**
@@ -336,8 +343,9 @@ public class GPSData extends RPCStruct { * set utc seconds
* @param utcSeconds utc seconds
*/
- public void setUtcSeconds(Integer utcSeconds) {
- setValue(KEY_UTC_SECONDS, utcSeconds);
+ public GPSData setUtcSeconds( Integer utcSeconds) {
+ setValue(KEY_UTC_SECONDS, utcSeconds);
+ return this;
}
/**
@@ -347,8 +355,9 @@ public class GPSData extends RPCStruct { public Integer getUtcSeconds() {
return getInteger(KEY_UTC_SECONDS);
}
- public void setCompassDirection(CompassDirection compassDirection) {
- setValue(KEY_COMPASS_DIRECTION, compassDirection);
+ public GPSData setCompassDirection( CompassDirection compassDirection) {
+ setValue(KEY_COMPASS_DIRECTION, compassDirection);
+ return this;
}
public CompassDirection getCompassDirection() {
return (CompassDirection) getObject(CompassDirection.class, KEY_COMPASS_DIRECTION);
@@ -358,8 +367,9 @@ public class GPSData extends RPCStruct { * set the positional dilution of precision
* @param pdop the positional dilution of precision
*/
- public void setPdop(Double pdop) {
- setValue(KEY_PDOP, pdop);
+ public GPSData setPdop( Double pdop) {
+ setValue(KEY_PDOP, pdop);
+ return this;
}
/**
@@ -374,8 +384,9 @@ public class GPSData extends RPCStruct { * set the horizontal dilution of precision
* @param hdop the horizontal dilution of precision
*/
- public void setHdop(Double hdop) {
- setValue(KEY_HDOP, hdop);
+ public GPSData setHdop( Double hdop) {
+ setValue(KEY_HDOP, hdop);
+ return this;
}
/**
@@ -391,8 +402,9 @@ public class GPSData extends RPCStruct { * set the vertical dilution of precision
* @param vdop the vertical dilution of precision
*/
- public void setVdop(Double vdop) {
- setValue(KEY_VDOP, vdop);
+ public GPSData setVdop( Double vdop) {
+ setValue(KEY_VDOP, vdop);
+ return this;
}
/**
@@ -405,11 +417,12 @@ public class GPSData extends RPCStruct { }
/**
- * set what coordinates based on
+ * set what coordinates based on
* @param actual True, if coordinates are based on satellites.False, if based on dead reckoning
*/
- public void setActual(Boolean actual) {
- setValue(KEY_ACTUAL, actual);
+ public GPSData setActual( Boolean actual) {
+ setValue(KEY_ACTUAL, actual);
+ return this;
}
/**
@@ -424,8 +437,9 @@ public class GPSData extends RPCStruct { * set the number of satellites in view
* @param satellites the number of satellites in view
*/
- public void setSatellites(Integer satellites) {
- setValue(KEY_SATELLITES, satellites);
+ public GPSData setSatellites( Integer satellites) {
+ setValue(KEY_SATELLITES, satellites);
+ return this;
}
/**
@@ -435,8 +449,9 @@ public class GPSData extends RPCStruct { public Integer getSatellites() {
return getInteger(KEY_SATELLITES);
}
- public void setDimension(Dimension dimension) {
- setValue(KEY_DIMENSION, dimension);
+ public GPSData setDimension( Dimension dimension) {
+ setValue(KEY_DIMENSION, dimension);
+ return this;
}
public Dimension getDimension() {
return (Dimension) getObject(Dimension.class, KEY_DIMENSION);
@@ -446,8 +461,9 @@ public class GPSData extends RPCStruct { * set altitude in meters
* @param altitude altitude in meters
*/
- public void setAltitude(Double altitude) {
- setValue(KEY_ALTITUDE, altitude);
+ public GPSData setAltitude( Double altitude) {
+ setValue(KEY_ALTITUDE, altitude);
+ return this;
}
/**
@@ -461,10 +477,11 @@ public class GPSData extends RPCStruct { /**
* set the heading.North is 0, East is 90, etc.
- * @param heading the heading.
+ * @param heading the heading.
*/
- public void setHeading(Double heading) {
- setValue(KEY_HEADING, heading);
+ public GPSData setHeading( Double heading) {
+ setValue(KEY_HEADING, heading);
+ return this;
}
/**
@@ -479,8 +496,9 @@ public class GPSData extends RPCStruct { * set speed in KPH
* @param speed the speed
*/
- public void setSpeed(Double speed) {
- setValue(KEY_SPEED, speed);
+ public GPSData setSpeed( Double speed) {
+ setValue(KEY_SPEED, speed);
+ return this;
}
/**
@@ -491,22 +509,23 @@ public class GPSData extends RPCStruct { Object object = getValue(KEY_SPEED);
return SdlDataTypeConverter.objectToDouble(object);
}
- - /** - * Sets the shifted param for GPSData. - * @param shifted True, if GPS lat/long, time, and altitude have been purposefully shifted (requires a proprietary algorithm to unshift). - * False, if the GPS data is raw and un-shifted. - * If not provided, then value is assumed False. - */ - public void setShifted(Boolean shifted) { - setValue(KEY_SHIFTED, shifted); - } - - /** - * Gets the shifted param for GPSData. - * @return Boolean - True, if GPS lat/long, time, and altitude have been purposefully shifted (requires a proprietary algorithm to unshift). - */ - public Boolean getShifted() { - return getBoolean(KEY_SHIFTED); - } -} +
+ /**
+ * Sets the shifted param for GPSData.
+ * @param shifted True, if GPS lat/long, time, and altitude have been purposefully shifted (requires a proprietary algorithm to unshift).
+ * False, if the GPS data is raw and un-shifted.
+ * If not provided, then value is assumed False.
+ */
+ public GPSData setShifted( Boolean shifted) {
+ setValue(KEY_SHIFTED, shifted);
+ return this;
+ }
+
+ /**
+ * Gets the shifted param for GPSData.
+ * @return Boolean - True, if GPS lat/long, time, and altitude have been purposefully shifted (requires a proprietary algorithm to unshift).
+ */
+ public Boolean getShifted() {
+ return getBoolean(KEY_SHIFTED);
+ }
+}
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/GearStatus.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/GearStatus.java index 131e7f831..dbae57a2a 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/GearStatus.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/GearStatus.java @@ -97,8 +97,9 @@ public class GearStatus extends RPCStruct { * * @param userSelectedGear Gear position selected by the user i.e. Park, Drive, Reverse */ - public void setUserSelectedGear(PRNDL selectedGear){ + public GearStatus setUserSelectedGear( PRNDL selectedGear) { setValue(KEY_USER_SELECTED_GEAR, selectedGear); + return this; } /** @@ -116,8 +117,9 @@ public class GearStatus extends RPCStruct { * * @param actualGear Actual Gear in use by the transmission */ - public void setActualGear(PRNDL actualGear){ + public GearStatus setActualGear( PRNDL actualGear) { setValue(KEY_ACTUAL_GEAR, actualGear); + return this; } /** @@ -135,8 +137,9 @@ public class GearStatus extends RPCStruct { * * @param transmissionType Tells the transmission type */ - public void setTransmissionType(TransmissionType transmissionType){ + public GearStatus setTransmissionType( TransmissionType transmissionType) { setValue(KEY_TRANSMISSION_TYPE, transmissionType); + return this; } /** diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/GetAppServiceData.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/GetAppServiceData.java index 9946de27a..77a423af9 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/GetAppServiceData.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/GetAppServiceData.java @@ -78,9 +78,10 @@ public class GetAppServiceData extends RPCRequest { /** * @param appServiceType - the appServiceType */ - public void setServiceType(@NonNull String appServiceType){ - setParameters(KEY_SERVICE_TYPE, appServiceType); - } + public GetAppServiceData setServiceType(@NonNull String appServiceType) { + setParameters(KEY_SERVICE_TYPE, appServiceType); + return this; + } /** * @return appServiceType @@ -95,9 +96,10 @@ public class GetAppServiceData extends RPCRequest { * if it was previously subscribed. * @param subscribe - */ - public void setSubscribe(Boolean subscribe){ - setParameters(KEY_SUBSCRIBE, subscribe); - } + public GetAppServiceData setSubscribe( Boolean subscribe) { + setParameters(KEY_SUBSCRIBE, subscribe); + return this; + } /** * If true, the consumer is requesting to subscribe to all future updates from the service diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/GetAppServiceDataResponse.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/GetAppServiceDataResponse.java index 253626e9b..0739e9e58 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/GetAppServiceDataResponse.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/GetAppServiceDataResponse.java @@ -67,9 +67,10 @@ public class GetAppServiceDataResponse extends RPCResponse { /** * @param serviceData - */ - public void setServiceData(AppServiceData serviceData){ - setParameters(KEY_SERVICE_DATA, serviceData); - } + public GetAppServiceDataResponse setServiceData( AppServiceData serviceData) { + setParameters(KEY_SERVICE_DATA, serviceData); + return this; + } /** * @return serviceData diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/GetCloudAppProperties.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/GetCloudAppProperties.java index 3348d4cb1..11913954b 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/GetCloudAppProperties.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/GetCloudAppProperties.java @@ -55,8 +55,9 @@ public class GetCloudAppProperties extends RPCRequest { setParameters(KEY_APP_ID, appID); } - public void setAppID(String appId){ + public GetCloudAppProperties setAppID( String appId) { setParameters(KEY_APP_ID, appId); + return this; } public String getAppID(){ diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/GetCloudAppPropertiesResponse.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/GetCloudAppPropertiesResponse.java index 2c4eddeda..04e576353 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/GetCloudAppPropertiesResponse.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/GetCloudAppPropertiesResponse.java @@ -62,8 +62,9 @@ public class GetCloudAppPropertiesResponse extends RPCResponse { setResultCode(resultCode); } - public void setCloudAppProperties(CloudAppProperties cloudAppProperties){ + public GetCloudAppPropertiesResponse setCloudAppProperties( CloudAppProperties cloudAppProperties) { setParameters(KEY_PROPERTIES, cloudAppProperties); + return this; } public CloudAppProperties getCloudAppProperties(){ diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/GetDTCs.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/GetDTCs.java index 939e1cdb6..63b0d716b 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/GetDTCs.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/GetDTCs.java @@ -1,34 +1,34 @@ -/* - * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this - * list of conditions and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following - * disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its - * contributors may be used to endorse or promote products derived from this - * software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ +/*
+ * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
package com.smartdevicelink.proxy.rpc;
import androidx.annotation.NonNull;
@@ -120,15 +120,16 @@ public class GetDTCs extends RPCRequest { /**
* Sets a name of the module to receive the DTC form
- *
+ *
* @param ecuName
* an Integer value representing a name of the module to receive
* the DTC form
* <p>
* <b>Notes:</p> </b>Minvalue:0; Maxvalue:65535
*/
- public void setEcuName(@NonNull Integer ecuName) {
- setParameters(KEY_ECU_NAME, ecuName);
+ public GetDTCs setEcuName(@NonNull Integer ecuName) {
+ setParameters(KEY_ECU_NAME, ecuName);
+ return this;
}
/**
@@ -140,8 +141,9 @@ public class GetDTCs extends RPCRequest { public Integer getEcuName() {
return getInteger(KEY_ECU_NAME);
}
- public void setDtcMask(Integer dtcMask) {
- setParameters(KEY_DTC_MASK, dtcMask);
+ public GetDTCs setDtcMask( Integer dtcMask) {
+ setParameters(KEY_DTC_MASK, dtcMask);
+ return this;
}
public Integer getDtcMask() {
return getInteger(KEY_DTC_MASK);
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/GetDTCsResponse.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/GetDTCsResponse.java index e7c54c02b..87ae47ab8 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/GetDTCsResponse.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/GetDTCsResponse.java @@ -74,16 +74,18 @@ public class GetDTCsResponse extends RPCResponse{ return (List<String>) getObject(String.class, KEY_DTC);
}
- public void setDtc(List<String> dtc){
+ public GetDTCsResponse setDtc( List<String> dtc) {
setParameters(KEY_DTC, dtc);
+ return this;
}
public Integer getEcuHeader(){
return getInteger(KEY_ECU_HEADER);
}
- public void setEcuHeader(Integer ecuHeader){
+ public GetDTCsResponse setEcuHeader( Integer ecuHeader) {
setParameters(KEY_ECU_HEADER, ecuHeader);
+ return this;
}
}
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/GetFile.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/GetFile.java index d1453ded1..ea8d41c04 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/GetFile.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/GetFile.java @@ -72,9 +72,10 @@ public class GetFile extends RPCRequest { * maxlength="255" * @param fileName - */ - public void setFileName(@NonNull String fileName){ - setParameters(KEY_FILE_NAME, fileName); - } + public GetFile setFileName(@NonNull String fileName) { + setParameters(KEY_FILE_NAME, fileName); + return this; + } /** * File name that should be retrieved. @@ -89,9 +90,10 @@ public class GetFile extends RPCRequest { * ID of the service that should have uploaded the requested file * @param appServiceId - */ - public void setAppServiceId(String appServiceId){ - setParameters(KEY_APP_SERVICE_ID, appServiceId); - } + public GetFile setAppServiceId( String appServiceId) { + setParameters(KEY_APP_SERVICE_ID, appServiceId); + return this; + } /** * ID of the service that should have uploaded the requested file @@ -105,9 +107,10 @@ public class GetFile extends RPCRequest { * Selected file type. * @param fileType - */ - public void setFileType(FileType fileType){ - setParameters(KEY_FILE_TYPE, fileType); - } + public GetFile setFileType( FileType fileType) { + setParameters(KEY_FILE_TYPE, fileType); + return this; + } /** * Selected file type. @@ -122,9 +125,10 @@ public class GetFile extends RPCRequest { * minvalue="0" maxvalue="2000000000" * @param offset - */ - public void setOffset(Integer offset){ - setParameters(KEY_OFFSET, offset); - } + public GetFile setOffset( Integer offset) { + setParameters(KEY_OFFSET, offset); + return this; + } /** * Optional offset in bytes for resuming partial data chunks @@ -141,9 +145,10 @@ public class GetFile extends RPCRequest { * minvalue="0" maxvalue="2000000000" * @param length - */ - public void setLength(Integer length){ - setParameters(KEY_LENGTH, length); - } + public GetFile setLength( Integer length) { + setParameters(KEY_LENGTH, length); + return this; + } /** * Optional length in bytes for resuming partial data chunks if offset is set to 0, then length diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/GetFileResponse.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/GetFileResponse.java index 711de294c..17b5473c4 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/GetFileResponse.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/GetFileResponse.java @@ -73,9 +73,10 @@ public class GetFileResponse extends RPCResponse { * File type that is being sent in response * @param fileType - */ - public void setFileType(FileType fileType){ - setParameters(KEY_FILE_TYPE, fileType); - } + public GetFileResponse setFileType( FileType fileType) { + setParameters(KEY_FILE_TYPE, fileType); + return this; + } /** * File type that is being sent in response @@ -90,9 +91,10 @@ public class GetFileResponse extends RPCResponse { * minvalue="0" maxvalue="2000000000" * @param offset - */ - public void setOffset(Integer offset){ - setParameters(KEY_OFFSET, offset); - } + public GetFileResponse setOffset( Integer offset) { + setParameters(KEY_OFFSET, offset); + return this; + } /** * Optional offset in bytes for resuming partial data chunks @@ -109,9 +111,10 @@ public class GetFileResponse extends RPCResponse { * minvalue="0" maxvalue="2000000000" * @param length - */ - public void setLength(Integer length){ - setParameters(KEY_LENGTH, length); - } + public GetFileResponse setLength( Integer length) { + setParameters(KEY_LENGTH, length); + return this; + } /** * Optional length in bytes for resuming partial data chunks if offset is set to 0, then length @@ -128,9 +131,10 @@ public class GetFileResponse extends RPCResponse { * minvalue="0" maxvalue="4294967295" * @param crc - */ - public void setCRC(Integer crc){ - setParameters(KEY_CRC, crc); - } + public GetFileResponse setCRC( Integer crc) { + setParameters(KEY_CRC, crc); + return this; + } /** * Additional CRC32 checksum to protect data integrity up to 512 Mbits diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/GetInteriorVehicleData.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/GetInteriorVehicleData.java index a6a323646..3b2a5098b 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/GetInteriorVehicleData.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/GetInteriorVehicleData.java @@ -95,8 +95,9 @@ public class GetInteriorVehicleData extends RPCRequest { * The type of a RC module to retrieve module data from the vehicle. * In the future, this should be the Identification of a module. */ - public void setModuleType(@NonNull ModuleType moduleType) { + public GetInteriorVehicleData setModuleType(@NonNull ModuleType moduleType) { setParameters(KEY_MODULE_TYPE, moduleType); + return this; } /** @@ -106,8 +107,9 @@ public class GetInteriorVehicleData extends RPCRequest { * If subscribe is true, the head unit will register onInteriorVehicleData notifications for the requested moduelType. * If subscribe is false, the head unit will unregister onInteriorVehicleData notifications for the requested moduelType. */ - public void setSubscribe(Boolean subscribe) { + public GetInteriorVehicleData setSubscribe( Boolean subscribe) { setParameters(KEY_SUBSCRIBE, subscribe); + return this; } /** @@ -124,8 +126,9 @@ public class GetInteriorVehicleData extends RPCRequest { * Sets the Module ID for this class * @param id the id to be set */ - public void setModuleId(String id) { + public GetInteriorVehicleData setModuleId( String id) { setParameters(KEY_MODULE_ID, id); + return this; } /** diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/GetInteriorVehicleDataConsent.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/GetInteriorVehicleDataConsent.java index b4d3e02f3..46a40b5dd 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/GetInteriorVehicleDataConsent.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/GetInteriorVehicleDataConsent.java @@ -35,8 +35,9 @@ public class GetInteriorVehicleDataConsent extends RPCRequest { * Sets the Module Type for this class * @param type the Module Type to be set */ - public void setModuleType(@NonNull ModuleType type) { + public GetInteriorVehicleDataConsent setModuleType(@NonNull ModuleType type) { setParameters(KEY_MODULE_TYPE, type); + return this; } /** @@ -51,8 +52,9 @@ public class GetInteriorVehicleDataConsent extends RPCRequest { * Sets the Module Ids for this class * @param ids the ids to be set */ - public void setModuleIds(@NonNull List<String> ids) { + public GetInteriorVehicleDataConsent setModuleIds(@NonNull List<String> ids) { setParameters(KEY_MODULE_ID, ids); + return this; } /** diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/GetInteriorVehicleDataConsentResponse.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/GetInteriorVehicleDataConsentResponse.java index 5c2b5c7e9..91df49d4a 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/GetInteriorVehicleDataConsentResponse.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/GetInteriorVehicleDataConsentResponse.java @@ -31,8 +31,9 @@ public class GetInteriorVehicleDataConsentResponse extends RPCResponse { * Sets the list of allowances for this class * @param allowances the allowances to be set */ - public void setAllowances(@NonNull List<Boolean> allowances) { + public GetInteriorVehicleDataConsentResponse setAllowances(@NonNull List<Boolean> allowances) { setParameters(KEY_ALLOWED, allowances); + return this; } /** diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/GetInteriorVehicleDataResponse.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/GetInteriorVehicleDataResponse.java index ccf1e7913..7fb081f30 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/GetInteriorVehicleDataResponse.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/GetInteriorVehicleDataResponse.java @@ -87,9 +87,10 @@ public class GetInteriorVehicleDataResponse extends RPCResponse { * * @param moduleData specific data for the module that was requested */ - public void setModuleData(ModuleData moduleData) { - setParameters(KEY_MODULE_DATA, moduleData); - } + public GetInteriorVehicleDataResponse setModuleData( ModuleData moduleData) { + setParameters(KEY_MODULE_DATA, moduleData); + return this; + } /** * Sets isSubscribed parameter @@ -99,9 +100,10 @@ public class GetInteriorVehicleDataResponse extends RPCResponse { * If "true" - the "moduleType" from request is successfully subscribed and the head unit will send onInteriorVehicleData notifications for the moduleType. * If "false" - the "moduleType" from request is either unsubscribed or failed to subscribe. * */ - public void setIsSubscribed(Boolean isSubscribed) { - setParameters(KEY_IS_SUBSCRIBED, isSubscribed); - } + public GetInteriorVehicleDataResponse setIsSubscribed( Boolean isSubscribed) { + setParameters(KEY_IS_SUBSCRIBED, isSubscribed); + return this; + } /** * Gets isSubscribed parameter diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/GetSystemCapability.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/GetSystemCapability.java index 8cb70d7aa..173360d64 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/GetSystemCapability.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/GetSystemCapability.java @@ -84,8 +84,9 @@ public class GetSystemCapability extends RPCRequest { * Used to set the SystemCapabilityType being requested * @param value SystemCapabilityType being requested */ - public void setSystemCapabilityType(@NonNull SystemCapabilityType value){ + public GetSystemCapability setSystemCapabilityType(@NonNull SystemCapabilityType value) { setParameters(KEY_SYSTEM_CAPABILITY_TYPE, value); + return this; } /** @@ -104,7 +105,8 @@ public class GetSystemCapability extends RPCRequest { * subscriber if it was previously subscribed. * @param subscribe to changes in the SystemCapabilityType */ - public void setSubscribe(Boolean subscribe){ + public GetSystemCapability setSubscribe( Boolean subscribe) { setParameters(KEY_SUBSCRIBE, subscribe); + return this; } } diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/GetSystemCapabilityResponse.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/GetSystemCapabilityResponse.java index 29803499e..f48e095e7 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/GetSystemCapabilityResponse.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/GetSystemCapabilityResponse.java @@ -87,7 +87,8 @@ public class GetSystemCapabilityResponse extends RPCResponse { * Set a SystemCapability object in the response * @param value SystemCapability object */ - public void setSystemCapability(SystemCapability value){ + public GetSystemCapabilityResponse setSystemCapability( SystemCapability value) { setParameters(KEY_SYSTEM_CAPABILITY, value); + return this; } } diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/GetVehicleData.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/GetVehicleData.java index d1400d8f3..e5480b584 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/GetVehicleData.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/GetVehicleData.java @@ -357,20 +357,23 @@ public class GetVehicleData extends RPCRequest { public GetVehicleData(Hashtable<String, Object> hash) {
super(hash);
}
- public void setGps(Boolean gps) {
+ public GetVehicleData setGps( Boolean gps) {
setParameters(KEY_GPS, gps);
+ return this;
}
public Boolean getGps() {
return getBoolean(KEY_GPS);
}
- public void setSpeed(Boolean speed) {
+ public GetVehicleData setSpeed( Boolean speed) {
setParameters(KEY_SPEED, speed);
+ return this;
}
public Boolean getSpeed() {
return getBoolean(KEY_SPEED);
}
- public void setRpm(Boolean rpm) {
+ public GetVehicleData setRpm( Boolean rpm) {
setParameters(KEY_RPM, rpm);
+ return this;
}
public Boolean getRpm() {
return getBoolean(KEY_RPM);
@@ -383,8 +386,9 @@ public class GetVehicleData extends RPCRequest { * 7.0, please see fuelRange.
*/
@Deprecated
- public void setFuelLevel(Boolean fuelLevel) {
+ public GetVehicleData setFuelLevel( Boolean fuelLevel) {
setParameters(KEY_FUEL_LEVEL, fuelLevel);
+ return this;
}
/**
@@ -399,38 +403,43 @@ public class GetVehicleData extends RPCRequest { }
@Deprecated
- public void setFuelLevelState(Boolean fuelLevelState) {
+ public GetVehicleData setFuelLevelState( Boolean fuelLevelState) {
setParameters(KEY_FUEL_LEVEL_STATE, fuelLevelState);
+ return this;
}
@Deprecated
public Boolean getFuelLevelState() {
return getBoolean(KEY_FUEL_LEVEL_STATE);
}
- public void setInstantFuelConsumption(Boolean instantFuelConsumption) {
+ public GetVehicleData setInstantFuelConsumption( Boolean instantFuelConsumption) {
setParameters(KEY_INSTANT_FUEL_CONSUMPTION, instantFuelConsumption);
+ return this;
}
public Boolean getInstantFuelConsumption() {
return getBoolean(KEY_INSTANT_FUEL_CONSUMPTION);
}
- public void setFuelRange(Boolean fuelRange) {
+ public GetVehicleData setFuelRange( Boolean fuelRange) {
setParameters(KEY_FUEL_RANGE, fuelRange);
+ return this;
}
public Boolean getFuelRange() {
return getBoolean(KEY_FUEL_RANGE);
}
- public void setExternalTemperature(Boolean externalTemperature) {
+ public GetVehicleData setExternalTemperature( Boolean externalTemperature) {
setParameters(KEY_EXTERNAL_TEMPERATURE, externalTemperature);
+ return this;
}
public Boolean getExternalTemperature() {
return getBoolean(KEY_EXTERNAL_TEMPERATURE);
}
- public void setVin(Boolean vin) {
+ public GetVehicleData setVin( Boolean vin) {
setParameters(KEY_VIN, vin);
+ return this;
}
public Boolean getVin() {
return getBoolean(KEY_VIN);
@@ -443,8 +452,9 @@ public class GetVehicleData extends RPCRequest { * @deprecated in SmartDeviceLink 7.0.0
*/
@Deprecated
- public void setPrndl(Boolean prndl) {
+ public GetVehicleData setPrndl( Boolean prndl) {
setParameters(KEY_PRNDL, prndl);
+ return this;
}
/**
@@ -457,107 +467,124 @@ public class GetVehicleData extends RPCRequest { public Boolean getPrndl() {
return getBoolean(KEY_PRNDL);
}
- public void setTirePressure(Boolean tirePressure) {
+ public GetVehicleData setTirePressure( Boolean tirePressure) {
setParameters(KEY_TIRE_PRESSURE, tirePressure);
+ return this;
}
public Boolean getTirePressure() {
return getBoolean(KEY_TIRE_PRESSURE);
}
- public void setOdometer(Boolean odometer) {
+ public GetVehicleData setOdometer( Boolean odometer) {
setParameters(KEY_ODOMETER, odometer);
+ return this;
}
public Boolean getOdometer() {
return getBoolean(KEY_ODOMETER);
}
- public void setBeltStatus(Boolean beltStatus) {
+ public GetVehicleData setBeltStatus( Boolean beltStatus) {
setParameters(KEY_BELT_STATUS, beltStatus);
+ return this;
}
public Boolean getBeltStatus() {
return getBoolean(KEY_BELT_STATUS);
}
- public void setBodyInformation(Boolean bodyInformation) {
+ public GetVehicleData setBodyInformation( Boolean bodyInformation) {
setParameters(KEY_BODY_INFORMATION, bodyInformation);
+ return this;
}
public Boolean getBodyInformation() {
return getBoolean(KEY_BODY_INFORMATION);
}
- public void setDeviceStatus(Boolean deviceStatus) {
+ public GetVehicleData setDeviceStatus( Boolean deviceStatus) {
setParameters(KEY_DEVICE_STATUS, deviceStatus);
+ return this;
}
public Boolean getDeviceStatus() {
return getBoolean(KEY_DEVICE_STATUS);
}
- public void setDriverBraking(Boolean driverBraking) {
+ public GetVehicleData setDriverBraking( Boolean driverBraking) {
setParameters(KEY_DRIVER_BRAKING, driverBraking);
+ return this;
}
public Boolean getDriverBraking() {
return getBoolean(KEY_DRIVER_BRAKING);
}
- public void setWiperStatus(Boolean wiperStatus) {
+ public GetVehicleData setWiperStatus( Boolean wiperStatus) {
setParameters(KEY_WIPER_STATUS, wiperStatus);
+ return this;
}
public Boolean getWiperStatus() {
return getBoolean(KEY_WIPER_STATUS);
}
- public void setHeadLampStatus(Boolean headLampStatus) {
+ public GetVehicleData setHeadLampStatus( Boolean headLampStatus) {
setParameters(KEY_HEAD_LAMP_STATUS, headLampStatus);
+ return this;
}
public Boolean getHeadLampStatus() {
return getBoolean(KEY_HEAD_LAMP_STATUS);
}
- public void setEngineTorque(Boolean engineTorque) {
+ public GetVehicleData setEngineTorque( Boolean engineTorque) {
setParameters(KEY_ENGINE_TORQUE, engineTorque);
+ return this;
}
public Boolean getEngineTorque() {
return getBoolean(KEY_ENGINE_TORQUE);
}
- public void setEngineOilLife(Boolean engineOilLife) {
+ public GetVehicleData setEngineOilLife( Boolean engineOilLife) {
setParameters(KEY_ENGINE_OIL_LIFE, engineOilLife);
+ return this;
}
public Boolean getEngineOilLife() {
return getBoolean(KEY_ENGINE_OIL_LIFE);
}
- public void setAccPedalPosition(Boolean accPedalPosition) {
+ public GetVehicleData setAccPedalPosition( Boolean accPedalPosition) {
setParameters(KEY_ACC_PEDAL_POSITION, accPedalPosition);
+ return this;
}
public Boolean getAccPedalPosition() {
return getBoolean(KEY_ACC_PEDAL_POSITION);
}
- public void setSteeringWheelAngle(Boolean steeringWheelAngle) {
+ public GetVehicleData setSteeringWheelAngle( Boolean steeringWheelAngle) {
setParameters(KEY_STEERING_WHEEL_ANGLE, steeringWheelAngle);
+ return this;
}
public Boolean getSteeringWheelAngle() {
return getBoolean(KEY_STEERING_WHEEL_ANGLE);
}
- public void setECallInfo(Boolean eCallInfo) {
+ public GetVehicleData setECallInfo( Boolean eCallInfo) {
setParameters(KEY_E_CALL_INFO, eCallInfo);
+ return this;
}
public Boolean getECallInfo() {
return getBoolean(KEY_E_CALL_INFO);
}
- public void setAirbagStatus(Boolean airbagStatus) {
+ public GetVehicleData setAirbagStatus( Boolean airbagStatus) {
setParameters(KEY_AIRBAG_STATUS, airbagStatus);
+ return this;
}
public Boolean getAirbagStatus() {
return getBoolean(KEY_AIRBAG_STATUS);
}
- public void setEmergencyEvent(Boolean emergencyEvent) {
+ public GetVehicleData setEmergencyEvent( Boolean emergencyEvent) {
setParameters(KEY_EMERGENCY_EVENT, emergencyEvent);
+ return this;
}
public Boolean getEmergencyEvent() {
return getBoolean(KEY_EMERGENCY_EVENT);
}
- public void setClusterModeStatus(Boolean clusterModeStatus) {
+ public GetVehicleData setClusterModeStatus( Boolean clusterModeStatus) {
setParameters(KEY_CLUSTER_MODE_STATUS, clusterModeStatus);
+ return this;
}
public Boolean getClusterModeStatus() {
return getBoolean(KEY_CLUSTER_MODE_STATUS);
}
- public void setMyKey(Boolean myKey) {
+ public GetVehicleData setMyKey( Boolean myKey) {
setParameters(KEY_MY_KEY, myKey);
+ return this;
}
public Boolean getMyKey() {
return getBoolean(KEY_MY_KEY);
@@ -567,7 +594,10 @@ public class GetVehicleData extends RPCRequest { * Sets a boolean value. If true, subscribes turnSignal data
* @param turnSignal a boolean value
*/
- public void setTurnSignal(Boolean turnSignal) { setParameters(KEY_TURN_SIGNAL, turnSignal); }
+ public GetVehicleData setTurnSignal( Boolean turnSignal) {
+ setParameters(KEY_TURN_SIGNAL, turnSignal);
+ return this;
+ }
/**
* Gets a boolean value. If true, means the turnSignal data has been subscribed.
@@ -579,8 +609,9 @@ public class GetVehicleData extends RPCRequest { * Sets a boolean value. If true, subscribes electronicParkBrakeStatus data
* @param electronicParkBrakeStatus a boolean value
*/
- public void setElectronicParkBrakeStatus(Boolean electronicParkBrakeStatus){
+ public GetVehicleData setElectronicParkBrakeStatus( Boolean electronicParkBrakeStatus) {
setParameters(KEY_ELECTRONIC_PARK_BRAKE_STATUS, electronicParkBrakeStatus);
+ return this;
}
/**
@@ -595,8 +626,9 @@ public class GetVehicleData extends RPCRequest { * Sets a boolean value. If true, gets the cloudAppVehicleID data
* @param cloudAppVehicleID a boolean value
*/
- public void setCloudAppVehicleID(boolean cloudAppVehicleID){
+ public GetVehicleData setCloudAppVehicleID( boolean cloudAppVehicleID) {
setParameters(KEY_CLOUD_APP_VEHICLE_ID, cloudAppVehicleID);
+ return this;
}
/**
@@ -612,8 +644,9 @@ public class GetVehicleData extends RPCRequest { * @param vehicleDataName a String value
* @param vehicleDataState a boolean value
*/
- public void setOEMCustomVehicleData(String vehicleDataName, Boolean vehicleDataState){
+ public GetVehicleData setOEMCustomVehicleData( String vehicleDataName, Boolean vehicleDataState) {
setParameters(vehicleDataName, vehicleDataState);
+ return this;
}
/**
@@ -630,8 +663,9 @@ public class GetVehicleData extends RPCRequest { * @param windowStatus See WindowStatus
* @since SmartDeviceLink 7.0.0
*/
- public void setWindowStatus(Boolean windowStatus) {
+ public GetVehicleData setWindowStatus( Boolean windowStatus) {
setParameters(KEY_WINDOW_STATUS, windowStatus);
+ return this;
}
/**
@@ -650,8 +684,9 @@ public class GetVehicleData extends RPCRequest { * @param handsOffSteering To indicate whether driver hands are off the steering wheel
* @since SmartDeviceLink 7.0.0
*/
- public void setHandsOffSteering(Boolean handsOffSteering) {
+ public GetVehicleData setHandsOffSteering( Boolean handsOffSteering) {
setParameters(KEY_HANDS_OFF_STEERING, handsOffSteering);
+ return this;
}
/**
@@ -670,8 +705,9 @@ public class GetVehicleData extends RPCRequest { * @param gearStatus See GearStatus
* @since SmartDeviceLink 7.0.0
*/
- public void setGearStatus(Boolean gearStatus) {
+ public GetVehicleData setGearStatus( Boolean gearStatus) {
setParameters(KEY_GEAR_STATUS, gearStatus);
+ return this;
}
/**
@@ -690,8 +726,9 @@ public class GetVehicleData extends RPCRequest { * @param stabilityControlsStatus See StabilityControlsStatus
* @since SmartDeviceLink 7.0.0
*/
- public void setStabilityControlsStatus(Boolean stabilityControlsStatus) {
+ public GetVehicleData setStabilityControlsStatus( Boolean stabilityControlsStatus) {
setParameters(KEY_STABILITY_CONTROLS_STATUS, stabilityControlsStatus);
+ return this;
}
/**
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/GetVehicleDataResponse.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/GetVehicleDataResponse.java index 2e7df80a9..fd1636edb 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/GetVehicleDataResponse.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/GetVehicleDataResponse.java @@ -117,22 +117,25 @@ public class GetVehicleDataResponse extends RPCResponse { setSuccess(success);
setResultCode(resultCode);
}
- public void setGps(GPSData gps) {
+ public GetVehicleDataResponse setGps( GPSData gps) {
setParameters(KEY_GPS, gps);
+ return this;
}
@SuppressWarnings("unchecked")
public GPSData getGps() {
return (GPSData) getObject(GPSData.class, KEY_GPS);
}
- public void setSpeed(Double speed) {
+ public GetVehicleDataResponse setSpeed( Double speed) {
setParameters(KEY_SPEED, speed);
+ return this;
}
public Double getSpeed() {
Object object = getParameters(KEY_SPEED);
return SdlDataTypeConverter.objectToDouble(object);
}
- public void setRpm(Integer rpm) {
+ public GetVehicleDataResponse setRpm( Integer rpm) {
setParameters(KEY_RPM, rpm);
+ return this;
}
public Integer getRpm() {
return getInteger(KEY_RPM);
@@ -143,8 +146,9 @@ public class GetVehicleDataResponse extends RPCResponse { * @param fuelLevelState a ComponentVolumeStatus related to FuelLevel State
*/
@Deprecated
- public void setFuelLevelState(ComponentVolumeStatus fuelLevelState) {
+ public GetVehicleDataResponse setFuelLevelState( ComponentVolumeStatus fuelLevelState) {
setParameters(KEY_FUEL_LEVEL_STATE, fuelLevelState);
+ return this;
}
/**
* Gets Fuel Level State
@@ -164,8 +168,9 @@ public class GetVehicleDataResponse extends RPCResponse { * @since SmartDeviceLink 7.0.0
*/
@Deprecated
- public void setFuelLevel(Double fuelLevel) {
+ public GetVehicleDataResponse setFuelLevel( Double fuelLevel) {
setParameters(KEY_FUEL_LEVEL, fuelLevel);
+ return this;
}
/**
@@ -180,22 +185,25 @@ public class GetVehicleDataResponse extends RPCResponse { Object object = getParameters(KEY_FUEL_LEVEL);
return SdlDataTypeConverter.objectToDouble(object);
}
- public void setInstantFuelConsumption(Double instantFuelConsumption) {
+ public GetVehicleDataResponse setInstantFuelConsumption( Double instantFuelConsumption) {
setParameters(KEY_INSTANT_FUEL_CONSUMPTION, instantFuelConsumption);
+ return this;
}
public Double getInstantFuelConsumption() {
Object object = getParameters(KEY_INSTANT_FUEL_CONSUMPTION);
return SdlDataTypeConverter.objectToDouble(object);
}
- public void setExternalTemperature(Double externalTemperature) {
+ public GetVehicleDataResponse setExternalTemperature( Double externalTemperature) {
setParameters(KEY_EXTERNAL_TEMPERATURE, externalTemperature);
+ return this;
}
public Double getExternalTemperature() {
Object object = getParameters(KEY_EXTERNAL_TEMPERATURE);
return SdlDataTypeConverter.objectToDouble(object);
}
- public void setVin(String vin) {
+ public GetVehicleDataResponse setVin( String vin) {
setParameters(KEY_VIN, vin);
+ return this;
}
public String getVin() {
return getString(KEY_VIN);
@@ -208,8 +216,9 @@ public class GetVehicleDataResponse extends RPCResponse { * @deprecated in SmartDeviceLink 7.0.0
*/
@Deprecated
- public void setPrndl(PRNDL prndl) {
+ public GetVehicleDataResponse setPrndl( PRNDL prndl) {
setParameters(KEY_PRNDL, prndl);
+ return this;
}
/**
@@ -222,123 +231,140 @@ public class GetVehicleDataResponse extends RPCResponse { public PRNDL getPrndl() {
return (PRNDL) getObject(PRNDL.class, KEY_PRNDL);
}
- public void setTirePressure(TireStatus tirePressure) {
+ public GetVehicleDataResponse setTirePressure( TireStatus tirePressure) {
setParameters(KEY_TIRE_PRESSURE, tirePressure);
+ return this;
}
@SuppressWarnings("unchecked")
public TireStatus getTirePressure() {
return (TireStatus) getObject(TireStatus.class, KEY_TIRE_PRESSURE);
}
- public void setOdometer(Integer odometer) {
+ public GetVehicleDataResponse setOdometer( Integer odometer) {
setParameters(KEY_ODOMETER, odometer);
+ return this;
}
public Integer getOdometer() {
return getInteger(KEY_ODOMETER);
}
- public void setBeltStatus(BeltStatus beltStatus) {
+ public GetVehicleDataResponse setBeltStatus( BeltStatus beltStatus) {
setParameters(KEY_BELT_STATUS, beltStatus);
+ return this;
}
@SuppressWarnings("unchecked")
public BeltStatus getBeltStatus() {
return (BeltStatus) getObject(BeltStatus.class, KEY_BELT_STATUS);
}
- public void setBodyInformation(BodyInformation bodyInformation) {
+ public GetVehicleDataResponse setBodyInformation( BodyInformation bodyInformation) {
setParameters(KEY_BODY_INFORMATION, bodyInformation);
+ return this;
}
@SuppressWarnings("unchecked")
public BodyInformation getBodyInformation() {
return (BodyInformation) getObject(BodyInformation.class, KEY_BODY_INFORMATION);
}
- public void setDeviceStatus(DeviceStatus deviceStatus) {
+ public GetVehicleDataResponse setDeviceStatus( DeviceStatus deviceStatus) {
setParameters(KEY_DEVICE_STATUS, deviceStatus);
+ return this;
}
@SuppressWarnings("unchecked")
public DeviceStatus getDeviceStatus() {
return (DeviceStatus) getObject(DeviceStatus.class, KEY_DEVICE_STATUS);
}
- public void setDriverBraking(VehicleDataEventStatus driverBraking) {
+ public GetVehicleDataResponse setDriverBraking( VehicleDataEventStatus driverBraking) {
setParameters(KEY_DRIVER_BRAKING, driverBraking);
+ return this;
}
public VehicleDataEventStatus getDriverBraking() {
return (VehicleDataEventStatus) getObject(VehicleDataEventStatus.class, KEY_DRIVER_BRAKING);
}
- public void setWiperStatus(WiperStatus wiperStatus) {
+ public GetVehicleDataResponse setWiperStatus( WiperStatus wiperStatus) {
setParameters(KEY_WIPER_STATUS, wiperStatus);
+ return this;
}
public WiperStatus getWiperStatus() {
return (WiperStatus) getObject(WiperStatus.class, KEY_WIPER_STATUS);
}
- public void setHeadLampStatus(HeadLampStatus headLampStatus) {
+ public GetVehicleDataResponse setHeadLampStatus( HeadLampStatus headLampStatus) {
setParameters(KEY_HEAD_LAMP_STATUS, headLampStatus);
+ return this;
}
@SuppressWarnings("unchecked")
public HeadLampStatus getHeadLampStatus() {
return (HeadLampStatus) getObject(HeadLampStatus.class, KEY_HEAD_LAMP_STATUS);
}
- public void setEngineTorque(Double engineTorque) {
+ public GetVehicleDataResponse setEngineTorque( Double engineTorque) {
setParameters(KEY_ENGINE_TORQUE, engineTorque);
+ return this;
}
public Double getEngineTorque() {
Object object = getParameters(KEY_ENGINE_TORQUE);
return SdlDataTypeConverter.objectToDouble(object);
}
- public void setEngineOilLife(Float engineOilLife) {
+ public GetVehicleDataResponse setEngineOilLife( Float engineOilLife) {
setParameters(KEY_ENGINE_OIL_LIFE, engineOilLife);
+ return this;
}
public Float getEngineOilLife() {
Object object = getParameters(KEY_ENGINE_OIL_LIFE);
return SdlDataTypeConverter.objectToFloat(object);
}
- public void setAccPedalPosition(Double accPedalPosition) {
+ public GetVehicleDataResponse setAccPedalPosition( Double accPedalPosition) {
setParameters(KEY_ACC_PEDAL_POSITION, accPedalPosition);
+ return this;
}
public Double getAccPedalPosition() {
Object object = getParameters(KEY_ACC_PEDAL_POSITION);
return SdlDataTypeConverter.objectToDouble(object);
}
- public void setSteeringWheelAngle(Double steeringWheelAngle) {
+ public GetVehicleDataResponse setSteeringWheelAngle( Double steeringWheelAngle) {
setParameters(KEY_STEERING_WHEEL_ANGLE, steeringWheelAngle);
+ return this;
}
public Double getSteeringWheelAngle() {
Object object = getParameters(KEY_STEERING_WHEEL_ANGLE);
return SdlDataTypeConverter.objectToDouble(object);
}
- public void setECallInfo(ECallInfo eCallInfo) {
+ public GetVehicleDataResponse setECallInfo( ECallInfo eCallInfo) {
setParameters(KEY_E_CALL_INFO, eCallInfo);
+ return this;
}
@SuppressWarnings("unchecked")
public ECallInfo getECallInfo() {
return (ECallInfo) getObject(ECallInfo.class, KEY_E_CALL_INFO);
}
- public void setAirbagStatus(AirbagStatus airbagStatus) {
+ public GetVehicleDataResponse setAirbagStatus( AirbagStatus airbagStatus) {
setParameters(KEY_AIRBAG_STATUS, airbagStatus);
+ return this;
}
@SuppressWarnings("unchecked")
public AirbagStatus getAirbagStatus() {
return (AirbagStatus) getObject(AirbagStatus.class, KEY_AIRBAG_STATUS);
}
- public void setEmergencyEvent(EmergencyEvent emergencyEvent) {
+ public GetVehicleDataResponse setEmergencyEvent( EmergencyEvent emergencyEvent) {
setParameters(KEY_EMERGENCY_EVENT, emergencyEvent);
+ return this;
}
@SuppressWarnings("unchecked")
public EmergencyEvent getEmergencyEvent() {
return (EmergencyEvent) getObject(EmergencyEvent.class, KEY_EMERGENCY_EVENT);
}
- public void setClusterModeStatus(ClusterModeStatus clusterModeStatus) {
+ public GetVehicleDataResponse setClusterModeStatus( ClusterModeStatus clusterModeStatus) {
setParameters(KEY_CLUSTER_MODE_STATUS, clusterModeStatus);
+ return this;
}
@SuppressWarnings("unchecked")
public ClusterModeStatus getClusterModeStatus() {
return (ClusterModeStatus) getObject(ClusterModeStatus.class, KEY_CLUSTER_MODE_STATUS);
}
- public void setMyKey(MyKey myKey) {
+ public GetVehicleDataResponse setMyKey( MyKey myKey) {
setParameters(KEY_MY_KEY, myKey);
+ return this;
}
@SuppressWarnings("unchecked")
public MyKey getMyKey() {
@@ -349,11 +375,12 @@ public class GetVehicleDataResponse extends RPCResponse { * Sets Fuel Range List. Fuel Range - The estimate range in KM the vehicle can travel based on fuel level and consumption.
* @param fuelRange the range in KM left as well as fuel type
*
- * @see com.smartdevicelink.proxy.rpc.FuelRange
+ * @see FuelRange
* @see com.smartdevicelink.proxy.rpc.enums.FuelType
*/
- public void setFuelRange(List<FuelRange> fuelRange) {
+ public GetVehicleDataResponse setFuelRange( List<FuelRange> fuelRange) {
setParameters(KEY_FUEL_RANGE, fuelRange);
+ return this;
}
/**
@@ -370,10 +397,11 @@ public class GetVehicleDataResponse extends RPCResponse { * Sets turnSignal
* @param turnSignal status of the turn signals
*
- * @see com.smartdevicelink.proxy.rpc.enums.TurnSignal
+ * @see TurnSignal
*/
- public void setTurnSignal(TurnSignal turnSignal) {
+ public GetVehicleDataResponse setTurnSignal( TurnSignal turnSignal) {
setParameters(KEY_TURN_SIGNAL, turnSignal);
+ return this;
}
/**
@@ -391,10 +419,11 @@ public class GetVehicleDataResponse extends RPCResponse { * Sets electronicParkBrakeStatus
* @param electronicParkBrakeStatus status of the electronic park brake of the connected vehicle
*
- * @see com.smartdevicelink.proxy.rpc.enums.ElectronicParkBrakeStatus
+ * @see ElectronicParkBrakeStatus
*/
- public void setElectronicParkBrakeStatus(ElectronicParkBrakeStatus electronicParkBrakeStatus){
+ public GetVehicleDataResponse setElectronicParkBrakeStatus( ElectronicParkBrakeStatus electronicParkBrakeStatus) {
setParameters(KEY_ELECTRONIC_PARK_BRAKE_STATUS, electronicParkBrakeStatus);
+ return this;
}
/**
@@ -411,8 +440,9 @@ public class GetVehicleDataResponse extends RPCResponse { * Sets a string value for the cloud app vehicle ID
* @param cloudAppVehicleID a string value
*/
- public void setCloudAppVehicleID(String cloudAppVehicleID){
+ public GetVehicleDataResponse setCloudAppVehicleID( String cloudAppVehicleID) {
setParameters(KEY_CLOUD_APP_VEHICLE_ID, cloudAppVehicleID);
+ return this;
}
/**
@@ -429,8 +459,9 @@ public class GetVehicleDataResponse extends RPCResponse { * @param vehicleDataName a String value
* @param vehicleDataState a VehicleDataResult value
*/
- public void setOEMCustomVehicleData(String vehicleDataName, Object vehicleDataState){
+ public GetVehicleDataResponse setOEMCustomVehicleData( String vehicleDataName, Object vehicleDataState) {
setParameters(vehicleDataName, vehicleDataState);
+ return this;
}
/**
@@ -447,8 +478,9 @@ public class GetVehicleDataResponse extends RPCResponse { * @param windowStatus See WindowStatus
* @since SmartDeviceLink 7.0.0
*/
- public void setWindowStatus(List<WindowStatus> windowStatus) {
+ public GetVehicleDataResponse setWindowStatus( List<WindowStatus> windowStatus) {
setParameters(KEY_WINDOW_STATUS, windowStatus);
+ return this;
}
/**
@@ -468,8 +500,9 @@ public class GetVehicleDataResponse extends RPCResponse { * @param handsOffSteering To indicate whether driver hands are off the steering wheel
* @since SmartDeviceLink 7.0.0
*/
- public void setHandsOffSteering(Boolean handsOffSteering) {
+ public GetVehicleDataResponse setHandsOffSteering( Boolean handsOffSteering) {
setParameters(KEY_HANDS_OFF_STEERING, handsOffSteering);
+ return this;
}
/**
@@ -488,8 +521,9 @@ public class GetVehicleDataResponse extends RPCResponse { * @param gearStatus See GearStatus
* @since SmartDeviceLink 7.0.0
*/
- public void setGearStatus(GearStatus gearStatus) {
+ public GetVehicleDataResponse setGearStatus( GearStatus gearStatus) {
setParameters(KEY_GEAR_STATUS, gearStatus);
+ return this;
}
/**
@@ -518,7 +552,8 @@ public class GetVehicleDataResponse extends RPCResponse { * @param stabilityControlsStatus See StabilityControlsStatus
* @since SmartDeviceLink 7.0.0
*/
- public void setStabilityControlsStatus(StabilityControlsStatus stabilityControlsStatus) {
+ public GetVehicleDataResponse setStabilityControlsStatus( StabilityControlsStatus stabilityControlsStatus) {
setParameters(KEY_STABILITY_CONTROLS_STATUS, stabilityControlsStatus);
+ return this;
}
}
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/GetWayPoints.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/GetWayPoints.java index 2146e3933..6ad9518e9 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/GetWayPoints.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/GetWayPoints.java @@ -59,7 +59,8 @@ public class GetWayPoints extends RPCRequest { return (WayPointType) getObject(WayPointType.class, KEY_WAY_POINT_TYPE); } - public void setWayPointType(@NonNull WayPointType wayPointType) { + public GetWayPoints setWayPointType(@NonNull WayPointType wayPointType) { setParameters(KEY_WAY_POINT_TYPE, wayPointType); + return this; } } diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/GetWayPointsResponse.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/GetWayPointsResponse.java index 7a4924dea..cb7b99be3 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/GetWayPointsResponse.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/GetWayPointsResponse.java @@ -59,8 +59,9 @@ public class GetWayPointsResponse extends RPCResponse { setSuccess(success); setResultCode(resultCode); } - public void setWayPoints(List<LocationDetails> wayPoints) { - setParameters(KEY_WAY_POINTS, wayPoints); + public GetWayPointsResponse setWayPoints( List<LocationDetails> wayPoints) { + setParameters(KEY_WAY_POINTS, wayPoints); + return this; } @SuppressWarnings("unchecked") public List<LocationDetails> getWayPoints() { diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/Grid.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/Grid.java index e0c93369d..861c1a433 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/Grid.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/Grid.java @@ -39,8 +39,9 @@ public class Grid extends RPCStruct { * Sets the column of this Grid * @param col the column to be set */ - public void setCol(@NonNull Integer col) { + public Grid setCol(@NonNull Integer col) { setValue(KEY_COL, col); + return this; } /** @@ -55,8 +56,9 @@ public class Grid extends RPCStruct { * Sets the row's value of this Grid * @param row the row to be set */ - public void setRow(@NonNull Integer row) { + public Grid setRow(@NonNull Integer row) { setValue(KEY_ROW, row); + return this; } /** @@ -71,8 +73,9 @@ public class Grid extends RPCStruct { * Sets the level value of this Grid * @param level the level to be set */ - public void setLevel(Integer level) { + public Grid setLevel( Integer level) { setValue(KEY_LEVEL, level); + return this; } /** @@ -87,8 +90,9 @@ public class Grid extends RPCStruct { * Sets the column span of this Grid * @param span the span to be set */ - public void setColSpan(Integer span) { + public Grid setColSpan( Integer span) { setValue(KEY_COL_SPAN, span); + return this; } /** @@ -103,8 +107,9 @@ public class Grid extends RPCStruct { * Sets the row span of this Grid * @param span the span to be set */ - public void setRowSpan(Integer span) { + public Grid setRowSpan( Integer span) { setValue(KEY_ROW_SPAN, span); + return this; } /** @@ -119,8 +124,9 @@ public class Grid extends RPCStruct { * Sets the level span of this Grid * @param span the span to be set */ - public void setLevelSpan(Integer span) { + public Grid setLevelSpan( Integer span) { setValue(KEY_LEVEL_SPAN, span); + return this; } /** diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/HMICapabilities.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/HMICapabilities.java index f1b3c4821..0762b42ed 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/HMICapabilities.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/HMICapabilities.java @@ -59,9 +59,10 @@ public class HMICapabilities extends RPCStruct{ return (Boolean)available; } - public void setNavigationAvilable(Boolean available){ - setValue(KEY_NAVIGATION, available); - } + public HMICapabilities setNavigationAvilable( Boolean available) { + setValue(KEY_NAVIGATION, available); + return this; + } public boolean isPhoneCallAvailable(){ Object available = getValue(KEY_PHONE_CALL); @@ -71,9 +72,10 @@ public class HMICapabilities extends RPCStruct{ return (Boolean)available; } - public void setPhoneCallAvilable(Boolean available){ - setValue(KEY_PHONE_CALL, available); - } + public HMICapabilities setPhoneCallAvilable( Boolean available) { + setValue(KEY_PHONE_CALL, available); + return this; + } public boolean isVideoStreamingAvailable(){ Object available = getValue(KEY_VIDEO_STREAMING); @@ -83,9 +85,10 @@ public class HMICapabilities extends RPCStruct{ return (Boolean)available; } - public void setVideoStreamingAvailable(Boolean available){ - setValue(KEY_VIDEO_STREAMING, available); - } + public HMICapabilities setVideoStreamingAvailable( Boolean available) { + setValue(KEY_VIDEO_STREAMING, available); + return this; + } public boolean isRemoteControlAvailable(){ Object available = getValue(KEY_REMOTE_CONTROL); @@ -95,9 +98,10 @@ public class HMICapabilities extends RPCStruct{ return (Boolean)available; } - public void setRemoteControlAvailable(Boolean available){ - setValue(KEY_REMOTE_CONTROL, available); - } + public HMICapabilities setRemoteControlAvailable( Boolean available) { + setValue(KEY_REMOTE_CONTROL, available); + return this; + } public boolean isAppServicesAvailable(){ Object available = getValue(KEY_APP_SERVICES); @@ -107,9 +111,10 @@ public class HMICapabilities extends RPCStruct{ return (Boolean)available; } - public void setAppServicesAvailable(Boolean available){ - setValue(KEY_APP_SERVICES, available); - } + public HMICapabilities setAppServicesAvailable( Boolean available) { + setValue(KEY_APP_SERVICES, available); + return this; + } public boolean isDisplaysCapabilityAvailable(){ Object available = getValue(KEY_DISPLAYS); @@ -119,9 +124,10 @@ public class HMICapabilities extends RPCStruct{ return (Boolean)available; } - public void setDisplaysCapabilityAvailable(Boolean available){ - setValue(KEY_DISPLAYS, available); - } + public HMICapabilities setDisplaysCapabilityAvailable( Boolean available) { + setValue(KEY_DISPLAYS, available); + return this; + } public boolean isSeatLocationAvailable(){ Object available = getValue(KEY_SEAT_LOCATION); @@ -131,9 +137,10 @@ public class HMICapabilities extends RPCStruct{ return (Boolean)available; } - public void setSeatLocationAvailable(Boolean available){ - setValue(KEY_SEAT_LOCATION, available); - } + public HMICapabilities setSeatLocationAvailable( Boolean available) { + setValue(KEY_SEAT_LOCATION, available); + return this; + } /** * Sets the driverDistraction. @@ -141,8 +148,9 @@ public class HMICapabilities extends RPCStruct{ * @param driverDistraction Availability of driver distraction capability. True: Available, False: Not Available * @since SmartDeviceLink 7.0.0 */ - public void setDriverDistraction(Boolean driverDistraction) { + public HMICapabilities setDriverDistraction( Boolean driverDistraction) { setValue(KEY_DRIVER_DISTRACTION, driverDistraction); + return this; } /** diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/HMIPermissions.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/HMIPermissions.java index 68a84d451..5d5237b12 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/HMIPermissions.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/HMIPermissions.java @@ -1,34 +1,34 @@ -/* - * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this - * list of conditions and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following - * disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its - * contributors may be used to endorse or promote products derived from this - * software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ +/*
+ * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
package com.smartdevicelink.proxy.rpc;
import androidx.annotation.NonNull;
@@ -112,8 +112,9 @@ public class HMIPermissions extends RPCStruct { * set HMI level that is permitted for this given RPC.
* @param allowed HMI level that is permitted for this given RPC
*/
- public void setAllowed(@NonNull List<HMILevel> allowed) {
- setValue(KEY_ALLOWED, allowed);
+ public HMIPermissions setAllowed(@NonNull List<HMILevel> allowed) {
+ setValue(KEY_ALLOWED, allowed);
+ return this;
}
/**
@@ -129,7 +130,8 @@ public class HMIPermissions extends RPCStruct { * set a set of all HMI levels that are prohibited for this given RPC
* @param userDisallowed HMI level that is prohibited for this given RPC
*/
- public void setUserDisallowed(@NonNull List<HMILevel> userDisallowed) {
- setValue(KEY_USER_DISALLOWED, userDisallowed);
+ public HMIPermissions setUserDisallowed(@NonNull List<HMILevel> userDisallowed) {
+ setValue(KEY_USER_DISALLOWED, userDisallowed);
+ return this;
}
}
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/HMISettingsControlCapabilities.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/HMISettingsControlCapabilities.java index d62b646ba..36ef9c12c 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/HMISettingsControlCapabilities.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/HMISettingsControlCapabilities.java @@ -70,9 +70,10 @@ public class HMISettingsControlCapabilities extends RPCStruct { * * @param moduleName The short friendly name of the hmi setting module. It should not be used to identify a module by mobile application. */ - public void setModuleName(@NonNull String moduleName) { - setValue(KEY_MODULE_NAME, moduleName); - } + public HMISettingsControlCapabilities setModuleName(@NonNull String moduleName) { + setValue(KEY_MODULE_NAME, moduleName); + return this; + } /** * Gets the moduleName portion of the HMISettingsControlCapabilities class @@ -88,9 +89,10 @@ public class HMISettingsControlCapabilities extends RPCStruct { * * @param distanceUnitAvailable Availability of the control of distance unit. */ - public void setDistanceUnitAvailable(Boolean distanceUnitAvailable) { - setValue(KEY_DISTANCE_UNIT_AVAILABLE, distanceUnitAvailable); - } + public HMISettingsControlCapabilities setDistanceUnitAvailable( Boolean distanceUnitAvailable) { + setValue(KEY_DISTANCE_UNIT_AVAILABLE, distanceUnitAvailable); + return this; + } /** * Gets the distanceUnitAvailable portion of the HMISettingsControlCapabilities class @@ -106,9 +108,10 @@ public class HMISettingsControlCapabilities extends RPCStruct { * * @param temperatureUnitAvailable Availability of the control of temperature unit. */ - public void setTemperatureUnitAvailable(Boolean temperatureUnitAvailable) { - setValue(KEY_TEMPERATURE_UNIT_AVAILABLE, temperatureUnitAvailable); - } + public HMISettingsControlCapabilities setTemperatureUnitAvailable( Boolean temperatureUnitAvailable) { + setValue(KEY_TEMPERATURE_UNIT_AVAILABLE, temperatureUnitAvailable); + return this; + } /** * Gets the temperatureUnitAvailable portion of the HMISettingsControlCapabilities class @@ -124,9 +127,10 @@ public class HMISettingsControlCapabilities extends RPCStruct { * * @param displayModeUnitAvailable Availability of the control of HMI display mode. */ - public void setDisplayModeUnitAvailable(Boolean displayModeUnitAvailable) { - setValue(KEY_DISPLAY_MODE_UNIT_AVAILABLE, displayModeUnitAvailable); - } + public HMISettingsControlCapabilities setDisplayModeUnitAvailable( Boolean displayModeUnitAvailable) { + setValue(KEY_DISPLAY_MODE_UNIT_AVAILABLE, displayModeUnitAvailable); + return this; + } /** * Gets the displayModeUnitAvailable portion of the HMISettingsControlCapabilities class @@ -141,9 +145,10 @@ public class HMISettingsControlCapabilities extends RPCStruct { * Sets ModuleInfo for this capability * @param info the ModuleInfo to be set */ - public void setModuleInfo(ModuleInfo info) { - setValue(KEY_MODULE_INFO, info); - } + public HMISettingsControlCapabilities setModuleInfo( ModuleInfo info) { + setValue(KEY_MODULE_INFO, info); + return this; + } /** * Gets a ModuleInfo of this capability diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/HMISettingsControlData.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/HMISettingsControlData.java index 6030e712a..05dda0de2 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/HMISettingsControlData.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/HMISettingsControlData.java @@ -59,11 +59,12 @@ public class HMISettingsControlData extends RPCStruct { * * @param displayMode the display mode (DAY, NIGHT, AUTO) of screen on the respective module * - * @see com.smartdevicelink.proxy.rpc.enums.DisplayMode + * @see DisplayMode */ - public void setDisplayMode(DisplayMode displayMode) { - setValue(KEY_DISPLAY_MODE, displayMode); - } + public HMISettingsControlData setDisplayMode( DisplayMode displayMode) { + setValue(KEY_DISPLAY_MODE, displayMode); + return this; + } /** * Gets the displayMode portion of the HMISettingsControlData class @@ -81,11 +82,12 @@ public class HMISettingsControlData extends RPCStruct { * * @param temperatureUnit enum value of temperature unit associated with the display of the current module * - * @see com.smartdevicelink.proxy.rpc.enums.TemperatureUnit + * @see TemperatureUnit */ - public void setTemperatureUnit(TemperatureUnit temperatureUnit) { - setValue(KEY_TEMPERATURE_UNIT, temperatureUnit); - } + public HMISettingsControlData setTemperatureUnit( TemperatureUnit temperatureUnit) { + setValue(KEY_TEMPERATURE_UNIT, temperatureUnit); + return this; + } /** * Gets the temperatureUnit portion of the HMISettingsControlData class @@ -103,11 +105,12 @@ public class HMISettingsControlData extends RPCStruct { * * @param distanceUnit enum value of distance unit associated with the display of the current module * - * @see com.smartdevicelink.proxy.rpc.enums.DistanceUnit + * @see DistanceUnit */ - public void setDistanceUnit(DistanceUnit distanceUnit) { - setValue(KEY_DISTANCE_UNIT, distanceUnit); - } + public HMISettingsControlData setDistanceUnit( DistanceUnit distanceUnit) { + setValue(KEY_DISTANCE_UNIT, distanceUnit); + return this; + } /** * Gets the distanceUnit portion of the HMISettingsControlData class diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/HapticRect.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/HapticRect.java index c4458e547..a50c2d37b 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/HapticRect.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/HapticRect.java @@ -62,9 +62,10 @@ public class HapticRect extends RPCStruct { /** * Set a user control spatial identifier that references the supplied spatial data */ - public void setId(@NonNull Integer id) { - setValue(KEY_ID, id); - } + public HapticRect setId(@NonNull Integer id) { + setValue(KEY_ID, id); + return this; + } /** * @return a user control spatial identifier that references the supplied spatial data @@ -76,9 +77,10 @@ public class HapticRect extends RPCStruct { /** * Set the position of the haptic rectangle to be highlighted. The center of this rectangle will be "touched" when a press occurs. */ - public void setRect(@NonNull Rectangle rect) { - setValue(KEY_RECT, rect); - } + public HapticRect setRect(@NonNull Rectangle rect) { + setValue(KEY_RECT, rect); + return this; + } /** * @return the position of the haptic rectangle to be highlighted. The center of this rectangle will be "touched" when a press occurs. diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/HeadLampStatus.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/HeadLampStatus.java index abd0f10e0..693219fe0 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/HeadLampStatus.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/HeadLampStatus.java @@ -1,34 +1,34 @@ -/* - * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this - * list of conditions and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following - * disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its - * contributors may be used to endorse or promote products derived from this - * software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ +/*
+ * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
package com.smartdevicelink.proxy.rpc;
import androidx.annotation.NonNull;
@@ -98,20 +98,23 @@ public class HeadLampStatus extends RPCStruct { setLowBeamsOn(lowBeamsOn);
setHighBeamsOn(highBeamsOn);
}
- public void setAmbientLightStatus(AmbientLightStatus ambientLightSensorStatus) {
+ public HeadLampStatus setAmbientLightStatus( AmbientLightStatus ambientLightSensorStatus) {
setValue(KEY_AMBIENT_LIGHT_SENSOR_STATUS, ambientLightSensorStatus);
+ return this;
}
public AmbientLightStatus getAmbientLightStatus() {
return (AmbientLightStatus) getObject(AmbientLightStatus.class, KEY_AMBIENT_LIGHT_SENSOR_STATUS);
}
- public void setHighBeamsOn(@NonNull Boolean highBeamsOn) {
+ public HeadLampStatus setHighBeamsOn(@NonNull Boolean highBeamsOn) {
setValue(KEY_HIGH_BEAMS_ON, highBeamsOn);
+ return this;
}
public Boolean getHighBeamsOn() {
return getBoolean(KEY_HIGH_BEAMS_ON);
}
- public void setLowBeamsOn(@NonNull Boolean lowBeamsOn) {
+ public HeadLampStatus setLowBeamsOn(@NonNull Boolean lowBeamsOn) {
setValue(KEY_LOW_BEAMS_ON, lowBeamsOn);
+ return this;
}
public Boolean getLowBeamsOn() {
return getBoolean(KEY_LOW_BEAMS_ON);
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/Headers.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/Headers.java index 845f4649f..6226dc991 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/Headers.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/Headers.java @@ -1,34 +1,34 @@ -/* - * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this - * list of conditions and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following - * disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its - * contributors may be used to endorse or promote products derived from this - * software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ +/*
+ * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
package com.smartdevicelink.proxy.rpc;
import com.smartdevicelink.proxy.RPCStruct;
@@ -67,48 +67,54 @@ public class Headers extends RPCStruct { super(hash);
}
- public void setContentType(String contenttype) {
+ public Headers setContentType( String contenttype) {
setValue(KEY_CONTENT_TYPE, contenttype);
+ return this;
}
public String getContentType() {
return getString(KEY_CONTENT_TYPE);
}
- public void setConnectTimeout(Integer connectiontimeout) {
+ public Headers setConnectTimeout( Integer connectiontimeout) {
setValue(KEY_CONNECT_TIMEOUT, connectiontimeout);
+ return this;
}
public Integer getConnectTimeout() {
return getInteger(KEY_CONNECT_TIMEOUT);
}
- public void setDoOutput(Boolean dooutput) {
+ public Headers setDoOutput( Boolean dooutput) {
setValue(KEY_DO_OUTPUT, dooutput);
+ return this;
}
public Boolean getDoOutput() {
return getBoolean(KEY_DO_OUTPUT);
}
- public void setDoInput(Boolean doinput) {
+ public Headers setDoInput( Boolean doinput) {
setValue(KEY_DO_INPUT, doinput);
+ return this;
}
public Boolean getDoInput() {
return getBoolean(KEY_DO_INPUT);
}
- public void setUseCaches(Boolean usescaches) {
+ public Headers setUseCaches( Boolean usescaches) {
setValue(KEY_USE_CACHES, usescaches);
+ return this;
}
public Boolean getUseCaches() {
return getBoolean(KEY_USE_CACHES);
}
- public void setRequestMethod(String requestmethod) {
+ public Headers setRequestMethod( String requestmethod) {
setValue(KEY_REQUEST_METHOD, requestmethod);
+ return this;
}
public String getRequestMethod() {
@@ -116,32 +122,36 @@ public class Headers extends RPCStruct { }
- public void setReadTimeout(Integer readtimeout) {
+ public Headers setReadTimeout( Integer readtimeout) {
setValue(KEY_READ_TIMEOUT, readtimeout);
+ return this;
}
public Integer getReadTimeout() {
return getInteger(KEY_READ_TIMEOUT);
}
- public void setInstanceFollowRedirects(Boolean instancefollowredirects) {
+ public Headers setInstanceFollowRedirects( Boolean instancefollowredirects) {
setValue(KEY_INSTANCE_FOLLOW_REDIRECTS, instancefollowredirects);
+ return this;
}
public Boolean getInstanceFollowRedirects() {
return getBoolean(KEY_INSTANCE_FOLLOW_REDIRECTS);
}
- public void setCharset(String charset) {
+ public Headers setCharset( String charset) {
setValue(KEY_CHARSET, charset);
+ return this;
}
public String getCharset() {
return getString(KEY_CHARSET);
}
- public void setContentLength(Integer contentlength) {
+ public Headers setContentLength( Integer contentlength) {
setValue(KEY_CONTENT_LENGTH, contentlength);
+ return this;
}
public Integer getContentLength() {
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/Image.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/Image.java index ba9f25f5c..1d5b57e26 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/Image.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/Image.java @@ -1,34 +1,34 @@ -/* - * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this - * list of conditions and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following - * disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its - * contributors may be used to endorse or promote products derived from this - * software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ +/*
+ * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
package com.smartdevicelink.proxy.rpc;
import androidx.annotation.NonNull;
@@ -101,8 +101,9 @@ public class Image extends RPCStruct { * Set either the static hex icon value or the binary image file name identifier (sent by PutFile)
* @param value either the static hex icon value or the binary image file name identifier (sent by PutFile)
*/
- public void setValue(@NonNull String value) {
+ public Image setValue(@NonNull String value) {
setValue(KEY_VALUE, value);
+ return this;
}
/**
@@ -117,8 +118,9 @@ public class Image extends RPCStruct { * Set the image type (static or dynamic image)
* @param imageType whether it is a static or dynamic image
*/
- public void setImageType(@NonNull ImageType imageType) {
+ public Image setImageType(@NonNull ImageType imageType) {
setValue(KEY_IMAGE_TYPE, imageType);
+ return this;
}
/**
@@ -133,8 +135,9 @@ public class Image extends RPCStruct { * Set whether this Image is a template image whose coloring should be decided by the HMI
* @param isTemplate boolean that tells whether this Image is a template image
*/
- public void setIsTemplate(Boolean isTemplate){
+ public Image setIsTemplate( Boolean isTemplate) {
setValue(KEY_IS_TEMPLATE, isTemplate);
+ return this;
}
/**
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/ImageField.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/ImageField.java index de052a6f7..0e4748072 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/ImageField.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/ImageField.java @@ -1,34 +1,34 @@ -/* - * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this - * list of conditions and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following - * disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its - * contributors may be used to endorse or promote products derived from this - * software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ +/*
+ * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
package com.smartdevicelink.proxy.rpc;
import androidx.annotation.NonNull;
@@ -108,21 +108,24 @@ public class ImageField extends RPCStruct { public ImageFieldName getName() {
return (ImageFieldName) getObject(ImageFieldName.class, KEY_NAME);
}
- public void setName(@NonNull ImageFieldName name ) {
+ public ImageField setName(@NonNull ImageFieldName name) {
setValue(KEY_NAME, name);
- }
+ return this;
+ }
@SuppressWarnings("unchecked")
public List<FileType> getImageTypeSupported() {
return (List<FileType>) getObject(FileType.class, KEY_IMAGE_TYPE_SUPPORTED);
}
- public void setImageTypeSupported(@NonNull List<FileType> imageTypeSupported ) {
+ public ImageField setImageTypeSupported(@NonNull List<FileType> imageTypeSupported) {
setValue(KEY_IMAGE_TYPE_SUPPORTED, imageTypeSupported);
+ return this;
}
@SuppressWarnings("unchecked")
public ImageResolution getImageResolution() {
return (ImageResolution) getObject(ImageResolution.class, KEY_IMAGE_RESOLUTION);
}
- public void setImageResolution( ImageResolution imageResolution ) {
+ public ImageField setImageResolution( ImageResolution imageResolution) {
setValue(KEY_IMAGE_RESOLUTION, imageResolution);
- }
+ return this;
+ }
}
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/ImageResolution.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/ImageResolution.java index 66841c773..151075bab 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/ImageResolution.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/ImageResolution.java @@ -1,34 +1,34 @@ -/* - * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this - * list of conditions and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following - * disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its - * contributors may be used to endorse or promote products derived from this - * software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ +/*
+ * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
package com.smartdevicelink.proxy.rpc;
import androidx.annotation.NonNull;
@@ -101,11 +101,12 @@ public class ImageResolution extends RPCStruct { * the Android H264 decoder, as a workaround the odd value is
* converted to a pair value.
*/
- public void setResolutionWidth(@NonNull Integer resolutionWidth) {
- if(resolutionWidth != null && resolutionWidth % 2 != 0) { - resolutionWidth++; - } + public ImageResolution setResolutionWidth(@NonNull Integer resolutionWidth) {
+ if(resolutionWidth != null && resolutionWidth % 2 != 0) {
+ resolutionWidth++;
+ }
setValue(KEY_RESOLUTION_WIDTH, resolutionWidth);
+ return this;
}
public Integer getResolutionWidth() {
@@ -117,11 +118,12 @@ public class ImageResolution extends RPCStruct { * the Android H264 decoder, as a workaround the odd value is
* converted to a pair value.
*/
- public void setResolutionHeight(@NonNull Integer resolutionHeight) {
- if(resolutionHeight != null && resolutionHeight % 2 != 0) { - resolutionHeight++; - } + public ImageResolution setResolutionHeight(@NonNull Integer resolutionHeight) {
+ if(resolutionHeight != null && resolutionHeight % 2 != 0) {
+ resolutionHeight++;
+ }
setValue(KEY_RESOLUTION_HEIGHT, resolutionHeight);
+ return this;
}
public Integer getResolutionHeight() {
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/KeyboardProperties.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/KeyboardProperties.java index cd721fec8..3687cd05e 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/KeyboardProperties.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/KeyboardProperties.java @@ -131,16 +131,18 @@ public class KeyboardProperties extends RPCStruct { return (Language) getObject(Language.class, KEY_LANGUAGE);
}
- public void setLanguage(Language language) {
+ public KeyboardProperties setLanguage( Language language) {
setValue(KEY_LANGUAGE, language);
+ return this;
}
public KeyboardLayout getKeyboardLayout() {
return (KeyboardLayout) getObject(KeyboardLayout.class, KEY_KEYBOARD_LAYOUT);
}
- public void setKeyboardLayout(KeyboardLayout keyboardLayout) {
+ public KeyboardProperties setKeyboardLayout( KeyboardLayout keyboardLayout) {
setValue(KEY_KEYBOARD_LAYOUT, keyboardLayout);
+ return this;
}
public KeypressMode getKeypressMode() {
@@ -151,12 +153,13 @@ public class KeyboardProperties extends RPCStruct { return kp;
}
- public void setKeypressMode(KeypressMode keypressMode) {
+ public KeyboardProperties setKeypressMode( KeypressMode keypressMode) {
if (keypressMode != null) {
setValue(KEY_KEYPRESS_MODE, keypressMode);
} else {
setValue(KEY_KEYPRESS_MODE, KEYPRESS_MODE_DEFAULT);
}
+ return this;
}
@SuppressWarnings("unchecked")
@@ -164,8 +167,9 @@ public class KeyboardProperties extends RPCStruct { return (List<String>) getObject(String.class, KEY_LIMITED_CHARACTER_LIST);
}
- public void setLimitedCharacterList(List<String> limitedCharacterList) {
+ public KeyboardProperties setLimitedCharacterList( List<String> limitedCharacterList) {
setValue(KEY_LIMITED_CHARACTER_LIST, limitedCharacterList);
+ return this;
}
/**
@@ -180,11 +184,11 @@ public class KeyboardProperties extends RPCStruct { /**
* Sets the text that allows an app to prepopulate the text field with a suggested entry as the user types
* @param autoCompleteText String representing the suggestions text
- * @deprecated use {@link #setAutoCompleteList(List<String>)} instead
+ * @deprecated use {@link #setAutoCompleteList( List <String>)} instead
*/
- @Deprecated // Note: removing autoCompleteText setter will leave no way to provide auto complete suggestions on old head units that don't support autoCompleteList
- public void setAutoCompleteText(String autoCompleteText) {
+ @Deprecated public KeyboardProperties setAutoCompleteText( String autoCompleteText) {
setValue(KEY_AUTO_COMPLETE_TEXT, autoCompleteText);
+ return this;
}
/**
@@ -201,7 +205,8 @@ public class KeyboardProperties extends RPCStruct { * completed entries as the user types. Set to an empty array to remove the auto-complete list from the screen
* @param autoCompleteList List<String> representing the suggestions list
*/
- public void setAutoCompleteList(List<String> autoCompleteList) {
+ public KeyboardProperties setAutoCompleteList( List<String> autoCompleteList) {
setValue(KEY_AUTO_COMPLETE_LIST, autoCompleteList);
+ return this;
}
}
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/LightCapabilities.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/LightCapabilities.java index 6ecfca5c6..365e71543 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/LightCapabilities.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/LightCapabilities.java @@ -75,11 +75,12 @@ public class LightCapabilities extends RPCStruct { * * @param name enum value of type LightName that describes the specific light * - * @see com.smartdevicelink.proxy.rpc.enums.LightName + * @see LightName */ - public void setName(@NonNull LightName name) { - setValue(KEY_NAME, name); - } + public LightCapabilities setName(@NonNull LightName name) { + setValue(KEY_NAME, name); + return this; + } /** * Gets the name portion of the LightCapabilities class @@ -97,9 +98,10 @@ public class LightCapabilities extends RPCStruct { * * @param densityAvailable Indicates if the light's density can be set remotely (similar to a dimmer). */ - public void setDensityAvailable(Boolean densityAvailable) { - setValue(KEY_DENSITY_AVAILABLE, densityAvailable); - } + public LightCapabilities setDensityAvailable( Boolean densityAvailable) { + setValue(KEY_DENSITY_AVAILABLE, densityAvailable); + return this; + } /** * Gets the densityAvailable portion of the LightCapabilities class @@ -115,9 +117,10 @@ public class LightCapabilities extends RPCStruct { * * @param RGBColorSpaceAvailable Indicates if the light's color can be set remotely by using the RGB color space. */ - public void setRGBColorSpaceAvailable(Boolean RGBColorSpaceAvailable) { - setValue(KEY_RGB_COLOR_SPACE_AVAILABLE, RGBColorSpaceAvailable); - } + public LightCapabilities setRGBColorSpaceAvailable( Boolean RGBColorSpaceAvailable) { + setValue(KEY_RGB_COLOR_SPACE_AVAILABLE, RGBColorSpaceAvailable); + return this; + } /** * Gets the RGBColorSpaceAvailable portion of the LightCapabilities class @@ -133,9 +136,10 @@ public class LightCapabilities extends RPCStruct { * * @param statusAvailable Indicates if the status (ON/OFF) can be set remotely. App shall not use read-only values (RAMP_UP/RAMP_DOWN/UNKNOWN/INVALID) in a setInteriorVehicleData request. */ - public void setStatusAvailable(Boolean statusAvailable) { - setValue(KEY_STATUS_AVAILABLE, statusAvailable); - } + public LightCapabilities setStatusAvailable( Boolean statusAvailable) { + setValue(KEY_STATUS_AVAILABLE, statusAvailable); + return this; + } /** * Gets the statusAvailable portion of the LightCapabilities class diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/LightControlCapabilities.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/LightControlCapabilities.java index 3cc66e67e..979b0a0cf 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/LightControlCapabilities.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/LightControlCapabilities.java @@ -76,9 +76,10 @@ public class LightControlCapabilities extends RPCStruct { * * @param moduleName The short friendly name of the light control module. It should not be used to identify a module by mobile application. */ - public void setModuleName(@NonNull String moduleName) { - setValue(KEY_MODULE_NAME, moduleName); - } + public LightControlCapabilities setModuleName(@NonNull String moduleName) { + setValue(KEY_MODULE_NAME, moduleName); + return this; + } /** * Gets the moduleName portion of the LightControlCapabilities class @@ -104,17 +105,19 @@ public class LightControlCapabilities extends RPCStruct { * * @param supportedLights An array of available LightCapabilities that are controllable. */ - public void setSupportedLights(@NonNull List<LightCapabilities> supportedLights) { - setValue(KEY_SUPPORTED_LIGHTS, supportedLights); - } + public LightControlCapabilities setSupportedLights(@NonNull List<LightCapabilities> supportedLights) { + setValue(KEY_SUPPORTED_LIGHTS, supportedLights); + return this; + } /** * Sets ModuleInfo for this capability * @param info the ModuleInfo to be set */ - public void setModuleInfo(ModuleInfo info) { - setValue(KEY_MODULE_INFO, info); - } + public LightControlCapabilities setModuleInfo( ModuleInfo info) { + setValue(KEY_MODULE_INFO, info); + return this; + } /** * Gets a ModuleInfo of this capability diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/LightControlData.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/LightControlData.java index 05bcb5fec..e40fd8c68 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/LightControlData.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/LightControlData.java @@ -83,7 +83,8 @@ public class LightControlData extends RPCStruct { * * @param lightState An array of LightNames and their current or desired status. Status of the LightNames that are not listed in the array shall remain unchanged. */ - public void setLightState(@NonNull List<LightState> lightState) { - setValue(KEY_LIGHT_STATE, lightState); - } + public LightControlData setLightState(@NonNull List<LightState> lightState) { + setValue(KEY_LIGHT_STATE, lightState); + return this; + } } diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/LightState.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/LightState.java index 0676b50da..749d43039 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/LightState.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/LightState.java @@ -79,9 +79,10 @@ public class LightState extends RPCStruct { * * @param id The name of a light or a group of lights. */ - public void setId(@NonNull LightName id) { - setValue(KEY_ID, id); - } + public LightState setId(@NonNull LightName id) { + setValue(KEY_ID, id); + return this; + } /** * Gets the id portion of the LightState class @@ -97,11 +98,12 @@ public class LightState extends RPCStruct { * * @param status enum value of type LightStatus that describes the specific lights state * - * @see com.smartdevicelink.proxy.rpc.enums.LightStatus + * @see LightStatus */ - public void setStatus(@NonNull LightStatus status) { - setValue(KEY_STATUS, status); - } + public LightState setStatus(@NonNull LightStatus status) { + setValue(KEY_STATUS, status); + return this; + } /** * Gets the status portion of the LightState class @@ -129,9 +131,10 @@ public class LightState extends RPCStruct { * * @param density a float representation of the density of the specific light state */ - public void setDensity(Float density) { - setValue(KEY_DENSITY, density); - } + public LightState setDensity( Float density) { + setValue(KEY_DENSITY, density); + return this; + } /** * Gets the color portion of the LightState class @@ -150,9 +153,10 @@ public class LightState extends RPCStruct { * * @param color an RGBColor representation of the color of this specific light state * - * @see com.smartdevicelink.proxy.rpc.RGBColor + * @see RGBColor */ - public void setColor(RGBColor color) { - setValue(KEY_COLOR, color); - } + public LightState setColor( RGBColor color) { + setValue(KEY_COLOR, color); + return this; + } } diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/ListFilesResponse.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/ListFilesResponse.java index e69e0a900..b60d79522 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/ListFilesResponse.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/ListFilesResponse.java @@ -91,8 +91,9 @@ public class ListFilesResponse extends RPCResponse { super.format(rpcVersion, formatParams);
}
- public void setFilenames(List<String> filenames) {
+ public ListFilesResponse setFilenames( List<String> filenames) {
setParameters(KEY_FILENAMES, filenames);
+ return this;
}
@SuppressWarnings("unchecked")
@@ -100,8 +101,9 @@ public class ListFilesResponse extends RPCResponse { return (List<String>) getObject(String.class, KEY_FILENAMES);
}
- public void setSpaceAvailable(Integer spaceAvailable) {
+ public ListFilesResponse setSpaceAvailable( Integer spaceAvailable) {
setParameters(KEY_SPACE_AVAILABLE, spaceAvailable);
+ return this;
}
public Integer getSpaceAvailable() {
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/LocationDetails.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/LocationDetails.java index f548336f2..574d16912 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/LocationDetails.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/LocationDetails.java @@ -56,16 +56,18 @@ public class LocationDetails extends RPCStruct{ public Coordinate getCoordinate() { return (Coordinate) getObject(Coordinate.class, KEY_COORDINATE); } - public void setCoordinate(Coordinate coordinate) { + public LocationDetails setCoordinate( Coordinate coordinate) { setValue(KEY_COORDINATE, coordinate); + return this; } public String getLocationName() { return getString(KEY_LOCATION_NAME); } - public void setLocationName(String locationName) { + public LocationDetails setLocationName( String locationName) { setValue(KEY_LOCATION_NAME, locationName); + return this; } @SuppressWarnings("unchecked") @@ -73,24 +75,27 @@ public class LocationDetails extends RPCStruct{ return (List<String>) getObject(String.class, KEY_ADDRESS_LINES); } - public void setAddressLines(List<String> addressLines) { + public LocationDetails setAddressLines( List<String> addressLines) { setValue(KEY_ADDRESS_LINES, addressLines); + return this; } public String getLocationDescription() { return getString(KEY_LOCATION_DESCRIPTION); } - public void setLocationDescription(String locationDescription) { + public LocationDetails setLocationDescription( String locationDescription) { setValue(KEY_LOCATION_DESCRIPTION, locationDescription); + return this; } public String getPhoneNumber() { return getString(KEY_PHONE_NUMBER); } - public void setPhoneNumber(String phoneNumber) { + public LocationDetails setPhoneNumber( String phoneNumber) { setValue(KEY_PHONE_NUMBER, phoneNumber); + return this; } @SuppressWarnings("unchecked") @@ -98,15 +103,17 @@ public class LocationDetails extends RPCStruct{ return (Image) getObject(Image.class, KEY_LOCATION_IMAGE); } - public void setLocationImage(Image locationImage) { + public LocationDetails setLocationImage( Image locationImage) { setValue(KEY_LOCATION_IMAGE, locationImage); + return this; } @SuppressWarnings("unchecked") public OasisAddress getSearchAddress() { return (OasisAddress) getObject(OasisAddress.class, KEY_SEARCH_ADDRESS); } - public void setSearchAddress(OasisAddress searchAddress) { + public LocationDetails setSearchAddress( OasisAddress searchAddress) { setValue(KEY_SEARCH_ADDRESS, searchAddress); + return this; } } diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/MassageCushionFirmness.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/MassageCushionFirmness.java index 6a4694a22..5d6219e14 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/MassageCushionFirmness.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/MassageCushionFirmness.java @@ -77,9 +77,10 @@ public class MassageCushionFirmness extends RPCStruct { * * @param cushion type of MassageCushion for multi-contour massage seat */ - public void setCushion(@NonNull MassageCushion cushion) { - setValue(KEY_CUSHION, cushion); - } + public MassageCushionFirmness setCushion(@NonNull MassageCushion cushion) { + setValue(KEY_CUSHION, cushion); + return this; + } /** * Gets the type of MassageCushion for multi-contour massage seat @@ -95,9 +96,10 @@ public class MassageCushionFirmness extends RPCStruct { * * @param firmness firmness of the supplied MassageCushion (Min: 0 Max: 100) */ - public void setFirmness(@NonNull Integer firmness) { - setValue(KEY_FIRMNESS, firmness); - } + public MassageCushionFirmness setFirmness(@NonNull Integer firmness) { + setValue(KEY_FIRMNESS, firmness); + return this; + } /** * Gets the firmness associated with the supplied MassageCushion diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/MassageModeData.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/MassageModeData.java index 1802c18c3..fee40d30d 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/MassageModeData.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/MassageModeData.java @@ -78,9 +78,10 @@ public class MassageModeData extends RPCStruct { * * @param massageZone the zone of a multi-contour massage seat */ - public void setMassageZone(@NonNull MassageZone massageZone) { - setValue(KEY_MASSAGE_ZONE, massageZone); - } + public MassageModeData setMassageZone(@NonNull MassageZone massageZone) { + setValue(KEY_MASSAGE_ZONE, massageZone); + return this; + } /** * Gets the massageZone that will be associated with the supplied massage mode @@ -105,7 +106,8 @@ public class MassageModeData extends RPCStruct { * * @param massageMode mode of massage to be used (OFF, LOW, HIGH) */ - public void setMassageMode(@NonNull MassageMode massageMode) { - setValue(KEY_MASSAGE_MODE, massageMode); - } + public MassageModeData setMassageMode(@NonNull MassageMode massageMode) { + setValue(KEY_MASSAGE_MODE, massageMode); + return this; + } } diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/MediaServiceData.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/MediaServiceData.java index 16065f669..a4722adb9 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/MediaServiceData.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/MediaServiceData.java @@ -68,9 +68,10 @@ public class MediaServiceData extends RPCStruct { /** * @param mediaType - The type of the currently playing or paused track. */ - public void setMediaType(MediaType mediaType) { - setValue(KEY_MEDIA_TYPE, mediaType); - } + public MediaServiceData setMediaType( MediaType mediaType) { + setValue(KEY_MEDIA_TYPE, mediaType); + return this; + } /** * @return mediaType - The type of the currently playing or paused track. @@ -85,9 +86,10 @@ public class MediaServiceData extends RPCStruct { * Audiobook: The name of the current chapter * @param mediaTitle - */ - public void setMediaTitle(String mediaTitle) { - setValue(KEY_MEDIA_TITLE, mediaTitle); - } + public MediaServiceData setMediaTitle( String mediaTitle) { + setValue(KEY_MEDIA_TITLE, mediaTitle); + return this; + } /** * Music: The name of the current track @@ -105,9 +107,10 @@ public class MediaServiceData extends RPCStruct { * Audiobook: The book author's name * @param mediaArtist - */ - public void setMediaArtist(String mediaArtist) { - setValue(KEY_MEDIA_ARTIST, mediaArtist); - } + public MediaServiceData setMediaArtist( String mediaArtist) { + setValue(KEY_MEDIA_ARTIST, mediaArtist); + return this; + } /** * Music: The name of the current album artist @@ -125,9 +128,10 @@ public class MediaServiceData extends RPCStruct { * Audiobook: The name of the current book * @param mediaAlbum - */ - public void setMediaAlbum(String mediaAlbum) { - setValue(KEY_MEDIA_ALBUM, mediaAlbum); - } + public MediaServiceData setMediaAlbum( String mediaAlbum) { + setValue(KEY_MEDIA_ALBUM, mediaAlbum); + return this; + } /** * Music: The name of the current album @@ -146,9 +150,10 @@ public class MediaServiceData extends RPCStruct { * Audiobook: The book or chapter artwork of the current audiobook * @param mediaImage */ - public void setMediaImage(Image mediaImage){ - setValue(KEY_MEDIA_IMAGE, mediaImage); - } + public MediaServiceData setMediaImage( Image mediaImage) { + setValue(KEY_MEDIA_IMAGE, mediaImage); + return this; + } /** * Returns the media image associated with the currently playing media @@ -166,9 +171,10 @@ public class MediaServiceData extends RPCStruct { * Audiobook: Likely not applicable, possibly a collection or "playlist" of books * @param playlistName - */ - public void setPlaylistName(String playlistName) { - setValue(KEY_PLAYLIST_NAME, playlistName); - } + public MediaServiceData setPlaylistName( String playlistName) { + setValue(KEY_PLAYLIST_NAME, playlistName); + return this; + } /** * Music: The name of the playlist or radio station, if the user is playing from a playlist, otherwise, Null @@ -183,9 +189,10 @@ public class MediaServiceData extends RPCStruct { /** * @param isExplicit - Whether or not the content currently playing (e.g. the track, episode, or book) contains explicit content */ - public void setIsExplicit(Boolean isExplicit) { - setValue(KEY_IS_EXPLICIT, isExplicit); - } + public MediaServiceData setIsExplicit( Boolean isExplicit) { + setValue(KEY_IS_EXPLICIT, isExplicit); + return this; + } /** * @return isExplicit - Whether or not the content currently playing (e.g. the track, episode, or book) contains explicit content @@ -200,9 +207,10 @@ public class MediaServiceData extends RPCStruct { * Audiobook: The current progress of the current segment (e.g. the chapter) in seconds * @param trackPlaybackProgress - */ - public void setTrackPlaybackProgress(Integer trackPlaybackProgress) { - setValue(KEY_TRACK_PLAYBACK_PROGRESS, trackPlaybackProgress); - } + public MediaServiceData setTrackPlaybackProgress( Integer trackPlaybackProgress) { + setValue(KEY_TRACK_PLAYBACK_PROGRESS, trackPlaybackProgress); + return this; + } /** * Music: The current progress of the track in seconds @@ -220,9 +228,10 @@ public class MediaServiceData extends RPCStruct { * Audiobook: The total duration of the current segment (e.g. the chapter) in seconds * @param trackPlaybackDuration - */ - public void setTrackPlaybackDuration(Integer trackPlaybackDuration) { - setValue(KEY_TRACK_PLAYBACK_DURATION, trackPlaybackDuration); - } + public MediaServiceData setTrackPlaybackDuration( Integer trackPlaybackDuration) { + setValue(KEY_TRACK_PLAYBACK_DURATION, trackPlaybackDuration); + return this; + } /** * Music: The total duration of the track in seconds @@ -240,9 +249,10 @@ public class MediaServiceData extends RPCStruct { * Audiobook: The current progress of the playback queue (e.g. the book) in seconds * @param queuePlaybackProgress - */ - public void setQueuePlaybackProgress(Integer queuePlaybackProgress) { - setValue(KEY_QUEUE_PLAYBACK_PROGRESS, queuePlaybackProgress); - } + public MediaServiceData setQueuePlaybackProgress( Integer queuePlaybackProgress) { + setValue(KEY_QUEUE_PLAYBACK_PROGRESS, queuePlaybackProgress); + return this; + } /** * Music: The current progress of the playback queue in seconds @@ -260,9 +270,10 @@ public class MediaServiceData extends RPCStruct { * Audiobook: The total duration of the playback queue (e.g. the book) in seconds * @param queuePlaybackDuration - */ - public void setQueuePlaybackDuration(Integer queuePlaybackDuration) { - setValue(KEY_QUEUE_PLAYBACK_DURATION, queuePlaybackDuration); - } + public MediaServiceData setQueuePlaybackDuration( Integer queuePlaybackDuration) { + setValue(KEY_QUEUE_PLAYBACK_DURATION, queuePlaybackDuration); + return this; + } /** * Music: The total duration of the playback queue in seconds @@ -280,9 +291,10 @@ public class MediaServiceData extends RPCStruct { * Audiobook: The current number (1 based) of the episode in the playback queue (e.g. the chapter number in the book) * @param queueCurrentTrackNumber - */ - public void setQueueCurrentTrackNumber(Integer queueCurrentTrackNumber) { - setValue(KEY_QUEUE_CURRENT_TRACK_NUMBER, queueCurrentTrackNumber); - } + public MediaServiceData setQueueCurrentTrackNumber( Integer queueCurrentTrackNumber) { + setValue(KEY_QUEUE_CURRENT_TRACK_NUMBER, queueCurrentTrackNumber); + return this; + } /** * Music: The current number (1 based) of the track in the playback queue @@ -300,9 +312,10 @@ public class MediaServiceData extends RPCStruct { * Audiobook: The total number of sections in the playback queue (e.g. the number of chapters in the book) * @param queueTotalTrackCount - */ - public void setQueueTotalTrackCount(Integer queueTotalTrackCount) { - setValue(KEY_QUEUE_TOTAL_TRACK_COUNT, queueTotalTrackCount); - } + public MediaServiceData setQueueTotalTrackCount( Integer queueTotalTrackCount) { + setValue(KEY_QUEUE_TOTAL_TRACK_COUNT, queueTotalTrackCount); + return this; + } /** * Music: The total number of tracks in the playback queue diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/MenuParams.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/MenuParams.java index 3ed8db072..408c36f71 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/MenuParams.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/MenuParams.java @@ -1,34 +1,34 @@ -/* - * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this - * list of conditions and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following - * disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its - * contributors may be used to endorse or promote products derived from this - * software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ +/*
+ * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
package com.smartdevicelink.proxy.rpc;
import androidx.annotation.NonNull;
@@ -123,9 +123,10 @@ public class MenuParams extends RPCStruct { * Set the unique ID of an existing submenu to which a command will be added.
* If this element is not provided, the command will be added to the top level of the Command Menu.
* @param parentID Min: 0; Max: 2000000000
- */
- public void setParentID( Integer parentID ) {
+ */
+ public MenuParams setParentID( Integer parentID) {
setValue(KEY_PARENT_ID, parentID);
+ return this;
}
/**
* Get the position within the items of the parent Command Menu. 0 will insert at the front, 1 will insert after the first existing element, etc.
@@ -142,7 +143,7 @@ public class MenuParams extends RPCStruct { return getInteger( KEY_POSITION );
}
/**
- * Set the position within the items of the parent Command Menu. 0 will insert at the front, 1 will insert after the first existing element, etc.
+ * Set the position within the items of the parent Command Menu. 0 will insert at the front, 1 will insert after the first existing element, etc.
* Position of any submenu will always be located before the return and exit options.
* <ul>
* <li>Min Value: 0</li>
@@ -151,9 +152,10 @@ public class MenuParams extends RPCStruct { * <li>If this element is omitted, the entry will be added at the end of the parent menu.</li>
* </ul>
* @param position Mix: 0 Max: 1000
- */
- public void setPosition( Integer position ) {
+ */
+ public MenuParams setPosition( Integer position) {
setValue(KEY_POSITION, position);
+ return this;
}
/**
* Get the text which appears in menu, representing this command.
@@ -175,8 +177,9 @@ public class MenuParams extends RPCStruct { * </ul>
* @param menuName the menu name
*/
-
- public void setMenuName( @NonNull String menuName ) {
+
+ public MenuParams setMenuName(@NonNull String menuName) {
setValue(KEY_MENU_NAME, menuName);
+ return this;
}
}
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/MetadataTags.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/MetadataTags.java index 49afcd86b..6894109fa 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/MetadataTags.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/MetadataTags.java @@ -59,16 +59,18 @@ public class MetadataTags extends RPCStruct { /** * Set the metadata types of data contained in the "mainField1" text field */ - public void setMainField1( List<MetadataType> metadataTypes ) { - setValue(KEY_MAIN_FIELD_1_TYPE, metadataTypes); - } + public MetadataTags setMainField1( List<MetadataType> metadataTypes) { + setValue(KEY_MAIN_FIELD_1_TYPE, metadataTypes); + return this; + } /** * Set the metadata type of data contained in the "mainField1" text field */ - public void setMainField1(MetadataType metadataType) { - setValue(KEY_MAIN_FIELD_1_TYPE, Collections.singletonList(metadataType)); - } + public MetadataTags setMainField1( MetadataType metadataType) { + setValue(KEY_MAIN_FIELD_1_TYPE, Collections.singletonList(metadataType)); + return this; + } /** * @return The type of data contained in the "mainField1" text field @@ -81,16 +83,18 @@ public class MetadataTags extends RPCStruct { /** * Set the metadata types of data contained in the "mainField2" text field */ - public void setMainField2( List<MetadataType> metadataTypes ) { - setValue(KEY_MAIN_FIELD_2_TYPE, metadataTypes); - } + public MetadataTags setMainField2( List<MetadataType> metadataTypes) { + setValue(KEY_MAIN_FIELD_2_TYPE, metadataTypes); + return this; + } /** * Set the metadata type of data contained in the "mainField2" text field */ - public void setMainField2(MetadataType metadataType) { - setValue(KEY_MAIN_FIELD_2_TYPE, Collections.singletonList(metadataType)); - } + public MetadataTags setMainField2( MetadataType metadataType) { + setValue(KEY_MAIN_FIELD_2_TYPE, Collections.singletonList(metadataType)); + return this; + } /** * @return The type of data contained in the "mainField2" text field @@ -103,16 +107,18 @@ public class MetadataTags extends RPCStruct { /** * Set the metadata types of data contained in the "mainField3" text field */ - public void setMainField3( List<MetadataType> metadataTypes ) { - setValue(KEY_MAIN_FIELD_3_TYPE, metadataTypes); - } + public MetadataTags setMainField3( List<MetadataType> metadataTypes) { + setValue(KEY_MAIN_FIELD_3_TYPE, metadataTypes); + return this; + } /** * Set the metadata type of data contained in the "mainField3" text field */ - public void setMainField3(MetadataType metadataType) { - setValue(KEY_MAIN_FIELD_3_TYPE, Collections.singletonList(metadataType)); - } + public MetadataTags setMainField3( MetadataType metadataType) { + setValue(KEY_MAIN_FIELD_3_TYPE, Collections.singletonList(metadataType)); + return this; + } /** * @return The type of data contained in the "mainField3" text field @@ -125,16 +131,18 @@ public class MetadataTags extends RPCStruct { /** * Set the metadata types of data contained in the "mainField4" text field */ - public void setMainField4( List<MetadataType> metadataTypes ) { - setValue(KEY_MAIN_FIELD_4_TYPE, metadataTypes); - } + public MetadataTags setMainField4( List<MetadataType> metadataTypes) { + setValue(KEY_MAIN_FIELD_4_TYPE, metadataTypes); + return this; + } /** * Set the metadata type of data contained in the "mainField4" text field */ - public void setMainField4(MetadataType metadataType) { - setValue(KEY_MAIN_FIELD_4_TYPE, Collections.singletonList(metadataType)); - } + public MetadataTags setMainField4( MetadataType metadataType) { + setValue(KEY_MAIN_FIELD_4_TYPE, Collections.singletonList(metadataType)); + return this; + } /** * @return The type of data contained in the "mainField4" text field diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/ModuleData.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/ModuleData.java index 1c1333102..b20124551 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/ModuleData.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/ModuleData.java @@ -66,9 +66,10 @@ public class ModuleData extends RPCStruct { * @param moduleType The moduleType indicates which type of data should be changed and identifies which data object exists in this struct. * For example, if the moduleType is CLIMATE then a "climateControlData" should exist */ - public void setModuleType(@NonNull ModuleType moduleType) { - setValue(KEY_MODULE_TYPE, moduleType); - } + public ModuleData setModuleType(@NonNull ModuleType moduleType) { + setValue(KEY_MODULE_TYPE, moduleType); + return this; + } /** * Gets the moduleType portion of the ModuleData class @@ -85,9 +86,10 @@ public class ModuleData extends RPCStruct { * * @param radioControlData */ - public void setRadioControlData(RadioControlData radioControlData) { - setValue(KEY_RADIO_CONTROL_DATA, radioControlData); - } + public ModuleData setRadioControlData( RadioControlData radioControlData) { + setValue(KEY_RADIO_CONTROL_DATA, radioControlData); + return this; + } /** * Gets the radioControlData portion of the ModuleData class @@ -103,9 +105,10 @@ public class ModuleData extends RPCStruct { * * @param climateControlData */ - public void setClimateControlData(ClimateControlData climateControlData) { - setValue(KEY_CLIMATE_CONTROL_DATA, climateControlData); - } + public ModuleData setClimateControlData( ClimateControlData climateControlData) { + setValue(KEY_CLIMATE_CONTROL_DATA, climateControlData); + return this; + } /** * Gets the climateControlData portion of the ModuleData class @@ -121,9 +124,10 @@ public class ModuleData extends RPCStruct { * * @param seatControlData */ - public void setSeatControlData(SeatControlData seatControlData) { - setValue(KEY_SEAT_CONTROL_DATA, seatControlData); - } + public ModuleData setSeatControlData( SeatControlData seatControlData) { + setValue(KEY_SEAT_CONTROL_DATA, seatControlData); + return this; + } /** * Gets the seatControlData portion of the ModuleData class @@ -139,9 +143,10 @@ public class ModuleData extends RPCStruct { * * @param audioControlData */ - public void setAudioControlData(AudioControlData audioControlData) { - setValue(KEY_AUDIO_CONTROL_DATA, audioControlData); - } + public ModuleData setAudioControlData( AudioControlData audioControlData) { + setValue(KEY_AUDIO_CONTROL_DATA, audioControlData); + return this; + } /** * Gets the audioControlData portion of the ModuleData class @@ -157,9 +162,10 @@ public class ModuleData extends RPCStruct { * * @param lightControlData */ - public void setLightControlData(LightControlData lightControlData) { - setValue(KEY_LIGHT_CONTROL_DATA, lightControlData); - } + public ModuleData setLightControlData( LightControlData lightControlData) { + setValue(KEY_LIGHT_CONTROL_DATA, lightControlData); + return this; + } /** * Gets the lightControlData portion of the ModuleData class @@ -175,9 +181,10 @@ public class ModuleData extends RPCStruct { * * @param hmiSettingsControlData */ - public void setHmiSettingsControlData(HMISettingsControlData hmiSettingsControlData) { - setValue(KEY_HMI_SETTINGS_CONTROL_DATA, hmiSettingsControlData); - } + public ModuleData setHmiSettingsControlData( HMISettingsControlData hmiSettingsControlData) { + setValue(KEY_HMI_SETTINGS_CONTROL_DATA, hmiSettingsControlData); + return this; + } /** * Gets the hmiSettingsControlData portion of the ModuleData class @@ -192,9 +199,10 @@ public class ModuleData extends RPCStruct { * Sets the Module ID of the ModuleData class * @param id the id to be set */ - public void setModuleId(String id) { - setValue(KEY_MODULE_ID, id); - } + public ModuleData setModuleId( String id) { + setValue(KEY_MODULE_ID, id); + return this; + } /** * Gets the Module ID of the ModuleData class diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/ModuleInfo.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/ModuleInfo.java index 701fe6c09..65debe0cf 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/ModuleInfo.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/ModuleInfo.java @@ -34,8 +34,9 @@ public class ModuleInfo extends RPCStruct { * Sets the Module ID for this Module * @param id the id to be set */ - public void setModuleId(@NonNull String id) { + public ModuleInfo setModuleId(@NonNull String id) { setValue(KEY_MODULE_ID, id); + return this; } /** @@ -50,8 +51,9 @@ public class ModuleInfo extends RPCStruct { * Sets the location of this Module * @param location the location to be set */ - public void setModuleLocation(Grid location) { + public ModuleInfo setModuleLocation( Grid location) { setValue(KEY_MODULE_LOCATION, location); + return this; } /** @@ -66,8 +68,9 @@ public class ModuleInfo extends RPCStruct { * Sets the service area of this Module * @param serviceArea the service area of this Module */ - public void setModuleServiceArea(Grid serviceArea) { + public ModuleInfo setModuleServiceArea( Grid serviceArea) { setValue(KEY_MODULE_SERVICE_AREA, serviceArea); + return this; } /** @@ -82,8 +85,9 @@ public class ModuleInfo extends RPCStruct { * Sets the multiple access allowance for this Module * @param isMultipleAccess the access to be set */ - public void setMultipleAccessAllowance(Boolean isMultipleAccess) { + public ModuleInfo setMultipleAccessAllowance( Boolean isMultipleAccess) { setValue(KEY_MULTIPLE_ACCESS_ALLOWED, isMultipleAccess); + return this; } /** diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/MyKey.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/MyKey.java index c72b8a203..e73565677 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/MyKey.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/MyKey.java @@ -1,34 +1,34 @@ -/* - * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this - * list of conditions and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following - * disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its - * contributors may be used to endorse or promote products derived from this - * software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ +/*
+ * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
package com.smartdevicelink.proxy.rpc;
import androidx.annotation.NonNull;
@@ -84,8 +84,9 @@ public class MyKey extends RPCStruct { this();
setE911Override(e911Override);
}
- public void setE911Override(@NonNull VehicleDataStatus e911Override) {
+ public MyKey setE911Override(@NonNull VehicleDataStatus e911Override) {
setValue(KEY_E_911_OVERRIDE, e911Override);
+ return this;
}
public VehicleDataStatus getE911Override() {
return (VehicleDataStatus) getObject(VehicleDataStatus.class, KEY_E_911_OVERRIDE);
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/NavigationCapability.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/NavigationCapability.java index 486a3c2ea..c3d19c3b1 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/NavigationCapability.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/NavigationCapability.java @@ -52,15 +52,17 @@ public class NavigationCapability extends RPCStruct{ return getBoolean(KEY_LOCATION_ENABLED); } - public void setSendLocationEnabled(Boolean sendLocationEnabled){ - setValue(KEY_LOCATION_ENABLED, sendLocationEnabled); - } + public NavigationCapability setSendLocationEnabled( Boolean sendLocationEnabled) { + setValue(KEY_LOCATION_ENABLED, sendLocationEnabled); + return this; + } public Boolean getWayPointsEnabled(){ return getBoolean(KEY_GETWAYPOINTS_ENABLED); } - public void setWayPointsEnabled(Boolean getWayPointsEnabled){ - setValue(KEY_GETWAYPOINTS_ENABLED, getWayPointsEnabled); - } + public NavigationCapability setWayPointsEnabled( Boolean getWayPointsEnabled) { + setValue(KEY_GETWAYPOINTS_ENABLED, getWayPointsEnabled); + return this; + } } diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/NavigationInstruction.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/NavigationInstruction.java index bd7bbc0eb..e4c3136ab 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/NavigationInstruction.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/NavigationInstruction.java @@ -70,9 +70,10 @@ public class NavigationInstruction extends RPCStruct { /** * @param locationDetails - */ - public void setLocationDetails(@NonNull LocationDetails locationDetails){ - setValue(KEY_LOCATION_DETAILS, locationDetails); - } + public NavigationInstruction setLocationDetails(@NonNull LocationDetails locationDetails) { + setValue(KEY_LOCATION_DETAILS, locationDetails); + return this; + } /** * @return locationDetails @@ -84,9 +85,10 @@ public class NavigationInstruction extends RPCStruct { /** * @param action - */ - public void setAction(@NonNull NavigationAction action){ - setValue(KEY_ACTION, action); - } + public NavigationInstruction setAction(@NonNull NavigationAction action) { + setValue(KEY_ACTION, action); + return this; + } /** * @return action @@ -98,9 +100,10 @@ public class NavigationInstruction extends RPCStruct { /** * @param eta - */ - public void setEta(DateTime eta){ - setValue(KEY_ETA, eta); - } + public NavigationInstruction setEta( DateTime eta) { + setValue(KEY_ETA, eta); + return this; + } /** * @return eta @@ -115,9 +118,10 @@ public class NavigationInstruction extends RPCStruct { * a U-Turn, etc. * @param bearing - minValue="0" maxValue="359" */ - public void setBearing(Integer bearing){ - setValue(KEY_BEARING, bearing); - } + public NavigationInstruction setBearing( Integer bearing) { + setValue(KEY_BEARING, bearing); + return this; + } /** * The angle at which this instruction takes place. For example, 0 would mean straight, <=45 @@ -132,9 +136,10 @@ public class NavigationInstruction extends RPCStruct { /** * @param junctionType - */ - public void setJunctionType(NavigationJunction junctionType){ - setValue(KEY_JUNCTION_TYPE, junctionType); - } + public NavigationInstruction setJunctionType( NavigationJunction junctionType) { + setValue(KEY_JUNCTION_TYPE, junctionType); + return this; + } /** * @return junctionType @@ -148,9 +153,10 @@ public class NavigationInstruction extends RPCStruct { * will determine which direction the turn should take place. * @param drivingSide - Direction enum value that represents the driving side */ - public void setDrivingSide(Direction drivingSide){ - setValue(KEY_DRIVING_SIDE, drivingSide); - } + public NavigationInstruction setDrivingSide( Direction drivingSide) { + setValue(KEY_DRIVING_SIDE, drivingSide); + return this; + } /** * Used to infer which side of the road this instruction takes place. For a U-Turn (action=TURN, bearing=180) this @@ -167,9 +173,10 @@ public class NavigationInstruction extends RPCStruct { * NavigationServiceData for that. * @param details - */ - public void setDetails(String details){ - setValue(KEY_DETAILS, details); - } + public NavigationInstruction setDetails( String details) { + setValue(KEY_DETAILS, details); + return this; + } /** * This is a string representation of this instruction, used to display instructions to the @@ -185,9 +192,10 @@ public class NavigationInstruction extends RPCStruct { * An image representation of this instruction. * @param image - */ - public void setImage(Image image){ - setValue(KEY_IMAGE, image); - } + public NavigationInstruction setImage( Image image) { + setValue(KEY_IMAGE, image); + return this; + } /** * An image representation of this instruction. diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/NavigationServiceData.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/NavigationServiceData.java index ae566c6e8..dd4b9237f 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/NavigationServiceData.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/NavigationServiceData.java @@ -73,9 +73,10 @@ public class NavigationServiceData extends RPCStruct { * given in the data can accurately be adjusted if necessary. * @param timeStamp - */ - public void setTimeStamp(@NonNull DateTime timeStamp){ - setValue(KEY_TIMESTAMP, timeStamp); - } + public NavigationServiceData setTimeStamp(@NonNull DateTime timeStamp) { + setValue(KEY_TIMESTAMP, timeStamp); + return this; + } /** * This is the timeStamp of when the data was generated. This is to ensure any time or distance @@ -89,9 +90,10 @@ public class NavigationServiceData extends RPCStruct { /** * @param origin - */ - public void setOrigin(LocationDetails origin){ - setValue(KEY_ORIGIN, origin); - } + public NavigationServiceData setOrigin( LocationDetails origin) { + setValue(KEY_ORIGIN, origin); + return this; + } /** * @return origin @@ -103,9 +105,10 @@ public class NavigationServiceData extends RPCStruct { /** * @param destination - */ - public void setDestination(LocationDetails destination){ - setValue(KEY_DESTINATION, destination); - } + public NavigationServiceData setDestination( LocationDetails destination) { + setValue(KEY_DESTINATION, destination); + return this; + } /** * @return destination @@ -117,9 +120,10 @@ public class NavigationServiceData extends RPCStruct { /** * @param destinationETA - */ - public void setDestinationETA(DateTime destinationETA){ - setValue(KEY_DESTINATION_ETA, destinationETA); - } + public NavigationServiceData setDestinationETA( DateTime destinationETA) { + setValue(KEY_DESTINATION_ETA, destinationETA); + return this; + } /** * @return destinationETA @@ -133,9 +137,10 @@ public class NavigationServiceData extends RPCStruct { * always contain the next instruction. * @param instructions - */ - public void setInstructions(List<NavigationInstruction> instructions){ - setValue(KEY_INSTRUCTIONS, instructions); - } + public NavigationServiceData setInstructions( List<NavigationInstruction> instructions) { + setValue(KEY_INSTRUCTIONS, instructions); + return this; + } /** * This array should be ordered with all remaining instructions. The start of this array should @@ -150,9 +155,10 @@ public class NavigationServiceData extends RPCStruct { /** * @param nextInstructionETA - */ - public void setNextInstructionETA(DateTime nextInstructionETA){ - setValue(KEY_NEXT_INSTRUCTION_ETA, nextInstructionETA); - } + public NavigationServiceData setNextInstructionETA( DateTime nextInstructionETA) { + setValue(KEY_NEXT_INSTRUCTION_ETA, nextInstructionETA); + return this; + } /** * @return nextInstructionETA @@ -167,9 +173,10 @@ public class NavigationServiceData extends RPCStruct { * the next instruction. * @param nextInstructionDistance - */ - public void setNextInstructionDistance(Float nextInstructionDistance){ - setValue(KEY_NEXT_INSTRUCTION_DISTANCE, nextInstructionDistance); - } + public NavigationServiceData setNextInstructionDistance( Float nextInstructionDistance) { + setValue(KEY_NEXT_INSTRUCTION_DISTANCE, nextInstructionDistance); + return this; + } /** * The distance to this instruction from current location. This should only be updated every @@ -185,9 +192,10 @@ public class NavigationServiceData extends RPCStruct { * Distance till next maneuver (starting from) from previous maneuver. * @param nextInstructionDistanceScale - */ - public void setNextInstructionDistanceScale(Float nextInstructionDistanceScale){ - setValue(KEY_NEXT_INSTRUCTION_DISTANCE_SCALE, nextInstructionDistanceScale); - } + public NavigationServiceData setNextInstructionDistanceScale( Float nextInstructionDistanceScale) { + setValue(KEY_NEXT_INSTRUCTION_DISTANCE_SCALE, nextInstructionDistanceScale); + return this; + } /** * Distance till next maneuver (starting from) from previous maneuver. @@ -203,9 +211,10 @@ public class NavigationServiceData extends RPCStruct { * instruction, post instruction, alerts that affect the current navigation session, etc. * @param prompt - */ - public void setPrompt(String prompt){ - setValue(KEY_PROMPT, prompt); - } + public NavigationServiceData setPrompt( String prompt) { + setValue(KEY_PROMPT, prompt); + return this; + } /** * This is a prompt message that should be conveyed to the user through either display or voice diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/NavigationServiceManifest.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/NavigationServiceManifest.java index 78b392865..e355c7a1c 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/NavigationServiceManifest.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/NavigationServiceManifest.java @@ -53,9 +53,10 @@ public class NavigationServiceManifest extends RPCStruct { * Informs the subscriber if this service can actually accept way points. * @param acceptsWayPoints - */ - public void setAcceptsWayPoints(Boolean acceptsWayPoints){ - setValue(KEY_ACCEPTS_WAY_POINTS, acceptsWayPoints); - } + public NavigationServiceManifest setAcceptsWayPoints( Boolean acceptsWayPoints) { + setValue(KEY_ACCEPTS_WAY_POINTS, acceptsWayPoints); + return this; + } /** * Informs the subscriber if this service can actually accept way points. diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/OasisAddress.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/OasisAddress.java index 7b4d09478..775f50d2c 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/OasisAddress.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/OasisAddress.java @@ -71,13 +71,14 @@ public class OasisAddress extends RPCStruct{ /** * Sets the localized Name of the country associated with the OasisAddress class. - * + * * @param countryName * The localized Name of the country associated with the OasisAddress class. - * + * */ - public void setCountryName(String countryName) { + public OasisAddress setCountryName( String countryName) { setValue(KEY_COUNTRY_NAME, countryName); + return this; } /** @@ -92,13 +93,14 @@ public class OasisAddress extends RPCStruct{ /** * Sets the country code in ISO 3166-2 format associated with the OasisAddress class. - * + * * @param countryCode * The country code in ISO 3166-2 format associated with the OasisAddress class. - * - */ - public void setCountryCode(String countryCode) { + * + */ + public OasisAddress setCountryCode( String countryCode) { setValue(KEY_COUNTRY_CODE, countryCode); + return this; } /** @@ -113,13 +115,14 @@ public class OasisAddress extends RPCStruct{ /** * Sets the Postal Code associated with the OasisAddress class. - * + * * @param postalCode * The Postal Code associated with the OasisAddress class. - * - */ - public void setPostalCode(String postalCode) { + * + */ + public OasisAddress setPostalCode( String postalCode) { setValue(KEY_POSTAL_CODE, postalCode); + return this; } /** @@ -134,13 +137,14 @@ public class OasisAddress extends RPCStruct{ /** * Sets the Administrative Area associated with the OasisAddress class. A portion of the country - Administrative Area can include details of the top-level area division in the country, such as state, district, province, island, region, etc. - * + * * @param administrativeArea * The Administrative Area associated with the OasisAddress class. - * - */ - public void setAdministrativeArea(String administrativeArea) { + * + */ + public OasisAddress setAdministrativeArea( String administrativeArea) { setValue(KEY_ADMINISTRATIVE_AREA, administrativeArea); + return this; } /** @@ -155,13 +159,14 @@ public class OasisAddress extends RPCStruct{ /** * Sets the SubAdministrative Area associated with the OasisAddress class. A portion of the administrativeArea - The next level down division of the area. E.g. state / county, province / reservation. - * + * * @param subAdministrativeArea * The SubAdministrative Area associated with the OasisAddress class. - * - */ - public void setSubAdministrativeArea(String subAdministrativeArea) { + * + */ + public OasisAddress setSubAdministrativeArea( String subAdministrativeArea) { setValue(KEY_SUB_ADMINISTRATIVE_AREA, subAdministrativeArea); + return this; } /** @@ -176,13 +181,14 @@ public class OasisAddress extends RPCStruct{ /** * Sets the Locality associated with the OasisAddress class. - A hypernym for city/village. - * + * * @param locality * The Locality associated with the OasisAddress class. - * + * */ - public void setLocality(String locality) { + public OasisAddress setLocality( String locality) { setValue(KEY_LOCALITY, locality); + return this; } /** @@ -197,13 +203,14 @@ public class OasisAddress extends RPCStruct{ /** * Sets the Sub-Locality associated with the OasisAddress class. A hypernym for district. - * + * * @param subLocality * The Sub-Locality associated with the OasisAddress class. - * - */ - public void setSubLocality(String subLocality) { + * + */ + public OasisAddress setSubLocality( String subLocality) { setValue(KEY_SUB_LOCALITY, subLocality); + return this; } /** @@ -218,13 +225,14 @@ public class OasisAddress extends RPCStruct{ /** * Sets the Thoroughfare associated with the OasisAddress class. A hypernym for street, road etc. - * + * * @param thoroughFare * The Thoroughfare associated with the OasisAddress class. - * - */ - public void setThoroughfare(String thoroughFare) { + * + */ + public OasisAddress setThoroughfare( String thoroughFare) { setValue(KEY_THOROUGH_FARE, thoroughFare); + return this; } /** @@ -238,12 +246,13 @@ public class OasisAddress extends RPCStruct{ /** * Sets the Sub-Thoroughfare associated with the OasisAddress class. - A Portion of thoroughfare (e.g. house number). - * + * * @param subThoroughfare * The Sub-Thoroughfare associated with the OasisAddress class. - * - */ - public void setSubThoroughfare(String subThoroughfare) { + * + */ + public OasisAddress setSubThoroughfare( String subThoroughfare) { setValue(KEY_SUB_THOROUGH_FARE, subThoroughfare); + return this; } } diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnAppInterfaceUnregistered.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnAppInterfaceUnregistered.java index 30fe4e755..33a896c2f 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnAppInterfaceUnregistered.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnAppInterfaceUnregistered.java @@ -1,34 +1,34 @@ -/* - * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this - * list of conditions and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following - * disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its - * contributors may be used to endorse or promote products derived from this - * software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ +/*
+ * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
package com.smartdevicelink.proxy.rpc;
import androidx.annotation.NonNull;
@@ -105,8 +105,9 @@ public class OnAppInterfaceUnregistered extends RPCNotification { /**
* <p>Set the reason application's interface was terminated</p>
* @param reason The reason application's interface registration was terminated
- */
- public void setReason( @NonNull AppInterfaceUnregisteredReason reason ) {
+ */
+ public OnAppInterfaceUnregistered setReason(@NonNull AppInterfaceUnregisteredReason reason) {
setParameters(KEY_REASON, reason);
+ return this;
}
}
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnAppServiceData.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnAppServiceData.java index e959b78f4..61b696809 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnAppServiceData.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnAppServiceData.java @@ -65,9 +65,10 @@ public class OnAppServiceData extends RPCNotification { /** * @param serviceData - */ - public void setServiceData(@NonNull AppServiceData serviceData){ - setParameters(KEY_SERVICE_DATA, serviceData); - } + public OnAppServiceData setServiceData(@NonNull AppServiceData serviceData) { + setParameters(KEY_SERVICE_DATA, serviceData); + return this; + } /** * @return serviceData diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnAudioPassThru.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnAudioPassThru.java index ab1ea3770..e5b9a5993 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnAudioPassThru.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnAudioPassThru.java @@ -1,34 +1,34 @@ -/* - * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this - * list of conditions and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following - * disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its - * contributors may be used to endorse or promote products derived from this - * software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ +/*
+ * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
package com.smartdevicelink.proxy.rpc;
import com.smartdevicelink.protocol.enums.FunctionID;
@@ -84,8 +84,9 @@ public class OnAudioPassThru extends RPCNotification { public OnAudioPassThru(Hashtable<String, Object> hash) {
super(hash);
}
- public void setAPTData(byte[] aptData) {
+ public OnAudioPassThru setAPTData( byte[] aptData) {
setBulkData(aptData);
+ return this;
}
public byte[] getAPTData() {
return getBulkData();
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnButtonEvent.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnButtonEvent.java index d4e1b01b7..ca408c580 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnButtonEvent.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnButtonEvent.java @@ -1,34 +1,34 @@ -/* - * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this - * list of conditions and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following - * disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its - * contributors may be used to endorse or promote products derived from this - * software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ +/*
+ * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
package com.smartdevicelink.proxy.rpc;
import androidx.annotation.NonNull;
@@ -160,11 +160,12 @@ public class OnButtonEvent extends RPCNotification { }
/**
- * <p>Set the button's name</p>
+ * <p>Set the button's name</p>
* @param buttonName name of the button
- */
- public void setButtonName(@NonNull ButtonName buttonName) {
+ */
+ public OnButtonEvent setButtonName(@NonNull ButtonName buttonName) {
setParameters(KEY_BUTTON_NAME, buttonName);
+ return this;
}
/**
@@ -179,13 +180,15 @@ public class OnButtonEvent extends RPCNotification { * <p> Set the event mode of the button,pressed or released</p>
* @param buttonEventMode indicates the button is pressed or released
* @see ButtonEventMode
- */
- public void setButtonEventMode(@NonNull ButtonEventMode buttonEventMode) {
+ */
+ public OnButtonEvent setButtonEventMode(@NonNull ButtonEventMode buttonEventMode) {
setParameters(KEY_BUTTON_EVENT_MODE, buttonEventMode);
+ return this;
}
- public void setCustomButtonID(Integer customButtonID) {
+ public OnButtonEvent setCustomButtonID( Integer customButtonID) {
setParameters(KEY_CUSTOM_BUTTON_ID, customButtonID);
+ return this;
}
public Integer getCustomButtonID() {
return getInteger(KEY_CUSTOM_BUTTON_ID);
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnButtonPress.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnButtonPress.java index 8c0003db8..e214e8b96 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnButtonPress.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnButtonPress.java @@ -160,11 +160,12 @@ public class OnButtonPress extends RPCNotification { return (ButtonName) getObject(ButtonName.class, KEY_BUTTON_NAME);
}
/**
- * <p>Set the button's name</p>
+ * <p>Set the button's name</p>
* @param buttonName name of the button
- */
- public void setButtonName( @NonNull ButtonName buttonName ) {
+ */
+ public OnButtonPress setButtonName(@NonNull ButtonName buttonName) {
setParameters(KEY_BUTTON_NAME, buttonName);
+ return this;
}
/**<p>Returns <i>{@linkplain ButtonPressMode}</i></p>
* @return ButtonPressMode whether this is a long or short button press event
@@ -175,9 +176,10 @@ public class OnButtonPress extends RPCNotification { /**
* <p>Set the button press mode of the event</p>
* @param buttonPressMode indicates whether this is a short or long press
- */
- public void setButtonPressMode( @NonNull ButtonPressMode buttonPressMode ) {
+ */
+ public OnButtonPress setButtonPressMode(@NonNull ButtonPressMode buttonPressMode) {
setParameters(KEY_BUTTON_PRESS_MODE, buttonPressMode);
+ return this;
}
/**
@@ -185,8 +187,9 @@ public class OnButtonPress extends RPCNotification { * If ButtonName is "CUSTOM_BUTTON", this references the integer ID passed by a custom button. (e.g. softButton ID)
* @param customButtonID CustomButtonID of the button
*/
- public void setCustomButtonID(Integer customButtonID) {
+ public OnButtonPress setCustomButtonID( Integer customButtonID) {
setParameters(KEY_CUSTOM_BUTTON_ID, customButtonID);
+ return this;
}
/**
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnCommand.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnCommand.java index 1f474bd30..12695323d 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnCommand.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnCommand.java @@ -1,34 +1,34 @@ -/* - * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this - * list of conditions and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following - * disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its - * contributors may be used to endorse or promote products derived from this - * software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ +/*
+ * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
package com.smartdevicelink.proxy.rpc;
import androidx.annotation.NonNull;
@@ -118,11 +118,12 @@ public class OnCommand extends RPCNotification { return getInteger( KEY_CMD_ID );
}
/**
- * <p>Sets a Command ID</p>
+ * <p>Sets a Command ID</p>
* @param cmdID an integer object representing a Command ID
- */
- public void setCmdID( @NonNull Integer cmdID ) {
+ */
+ public OnCommand setCmdID(@NonNull Integer cmdID) {
setParameters(KEY_CMD_ID, cmdID);
+ return this;
}
/**
* <p>Returns a <I>TriggerSource</I> object which will be shown in the HMI</p>
@@ -133,10 +134,11 @@ public class OnCommand extends RPCNotification { }
/**
* <p>Sets TriggerSource</p>
- * <p>Indicates whether command was selected via VR or via a menu selection (using the OK button).</p>
+ * <p>Indicates whether command was selected via VR or via a menu selection (using the OK button).</p>
* @param triggerSource a TriggerSource object
- */
- public void setTriggerSource( @NonNull TriggerSource triggerSource ) {
+ */
+ public OnCommand setTriggerSource(@NonNull TriggerSource triggerSource) {
setParameters(KEY_TRIGGER_SOURCE, triggerSource);
+ return this;
}
}
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnDriverDistraction.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnDriverDistraction.java index dc0b1b5e7..d9c16e50d 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnDriverDistraction.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnDriverDistraction.java @@ -106,17 +106,19 @@ public class OnDriverDistraction extends RPCNotification { /**
* <p>Called to set the driver distraction state(i.e. whether driver distraction rules are in effect, or not)</p>
* @param state the current driver distraction state
- */
- public void setState( @NonNull DriverDistractionState state ) {
+ */
+ public OnDriverDistraction setState(@NonNull DriverDistractionState state) {
setParameters(KEY_STATE, state);
+ return this;
}
/**
* <p>Called to set dismissible state of Lockscreen</p>
* @param isDismissible the Lockscreen's dismissibility
*/
- public void setLockscreenDismissibility(boolean isDismissible) {
+ public OnDriverDistraction setLockscreenDismissibility( boolean isDismissible) {
setParameters(KEY_LOCKSCREEN_DISMISSIBLE, isDismissible);
+ return this;
}
/**
@@ -131,8 +133,9 @@ public class OnDriverDistraction extends RPCNotification { * Called to set a warning message for the lockscreen
* @param msg the message to be set
*/
- public void setLockscreenWarningMessage(String msg) {
+ public OnDriverDistraction setLockscreenWarningMessage( String msg) {
setParameters(KEY_LOCKSCREEN_DISMISSIBLE_MSG, msg);
+ return this;
}
/**
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnHMIStatus.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnHMIStatus.java index ba2a5300b..52f3c4b84 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnHMIStatus.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnHMIStatus.java @@ -158,9 +158,10 @@ public class OnHMIStatus extends RPCNotification { /**
* <p>Set the HMILevel of OnHMIStatus</p>
* @param hmiLevel the HMILevel to set
- */
- public void setHmiLevel( @NonNull HMILevel hmiLevel ) {
+ */
+ public OnHMIStatus setHmiLevel(@NonNull HMILevel hmiLevel) {
setParameters(KEY_HMI_LEVEL, hmiLevel);
+ return this;
}
/**
* <p>Get current state of audio streaming for the application</p>
@@ -172,9 +173,10 @@ public class OnHMIStatus extends RPCNotification { /**
* <p>Set the audio streaming state</p>
* @param audioStreamingState the state of audio streaming of the application
- */
- public void setAudioStreamingState(@NonNull AudioStreamingState audioStreamingState ) {
+ */
+ public OnHMIStatus setAudioStreamingState(@NonNull AudioStreamingState audioStreamingState) {
setParameters(KEY_AUDIO_STREAMING_STATE, audioStreamingState);
+ return this;
}
/**
* <p>Get current state of video streaming for the application</p>
@@ -187,8 +189,9 @@ public class OnHMIStatus extends RPCNotification { * <p>Set the video streaming state</p>
* @param videoStreamingState the state of video streaming of the application
*/
- public void setVideoStreamingState( VideoStreamingState videoStreamingState ) {
+ public OnHMIStatus setVideoStreamingState( VideoStreamingState videoStreamingState) {
setParameters(KEY_VIDEO_STREAMING_STATE, videoStreamingState);
+ return this;
}
/**
* <p>Get the System Context</p>
@@ -199,11 +202,12 @@ public class OnHMIStatus extends RPCNotification { }
/**
* <p>Set the System Context of OnHMIStatus</p>
- * @param systemContext Indicates that a user-initiated interaction is in-progress
+ * @param systemContext Indicates that a user-initiated interaction is in-progress
* (VRSESSION or MENU), or not (MAIN)
- */
- public void setSystemContext( @NonNull SystemContext systemContext ) {
+ */
+ public OnHMIStatus setSystemContext(@NonNull SystemContext systemContext) {
setParameters(KEY_SYSTEM_CONTEXT, systemContext);
+ return this;
}
/**
* <p>Query whether it's the first run</p>
@@ -215,9 +219,10 @@ public class OnHMIStatus extends RPCNotification { /**
* <p>Set the firstRun value</p>
* @param firstRun True if it is the first run, False or not
- */
- public void setFirstRun(Boolean firstRun) {
- this.firstRun = firstRun;
+ */
+ public OnHMIStatus setFirstRun( Boolean firstRun) {
+ this.firstRun = firstRun;
+ return this;
}
/**
* <p>Set the windowID value</p>
@@ -226,8 +231,9 @@ public class OnHMIStatus extends RPCNotification { * See PredefinedWindows enum.
* @since 6.0
*/
- public void setWindowID(Integer windowID) {
+ public OnHMIStatus setWindowID( Integer windowID) {
setParameters(KEY_WINDOW_ID, windowID);
+ return this;
}
/**
* <p>Get the windowID value</p>
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnHashChange.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnHashChange.java index 0abe4c1a8..baea12ec3 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnHashChange.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnHashChange.java @@ -1,34 +1,34 @@ -/* - * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this - * list of conditions and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following - * disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its - * contributors may be used to endorse or promote products derived from this - * software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ +/*
+ * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
package com.smartdevicelink.proxy.rpc;
import androidx.annotation.NonNull;
@@ -99,8 +99,9 @@ public class OnHashChange extends RPCNotification { return getString(KEY_HASH_ID);
}
- public void setHashID(@NonNull String hashID) {
+ public OnHashChange setHashID(@NonNull String hashID) {
setParameters(KEY_HASH_ID, hashID);
- }
+ return this;
+ }
}
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnInteriorVehicleData.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnInteriorVehicleData.java index 37c9d107c..a532421d9 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnInteriorVehicleData.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnInteriorVehicleData.java @@ -83,7 +83,8 @@ public class OnInteriorVehicleData extends RPCNotification { * * @param moduleData */ - public void setModuleData(@NonNull ModuleData moduleData) { + public OnInteriorVehicleData setModuleData(@NonNull ModuleData moduleData) { setParameters(KEY_MODULE_DATA, moduleData); + return this; } } diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnKeyboardInput.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnKeyboardInput.java index d888c685b..3b2f71269 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnKeyboardInput.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnKeyboardInput.java @@ -107,12 +107,14 @@ public class OnKeyboardInput extends RPCNotification { return (KeyboardEvent) getObject(KeyboardEvent.class, KEY_EVENT);
}
- public void setEvent(@NonNull KeyboardEvent event) {
+ public OnKeyboardInput setEvent(@NonNull KeyboardEvent event) {
setParameters(KEY_EVENT, event);
+ return this;
}
- public void setData(String data) {
+ public OnKeyboardInput setData( String data) {
setParameters(KEY_DATA, data);
+ return this;
}
public String getData() {
Object obj = getParameters(KEY_DATA);
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnLanguageChange.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnLanguageChange.java index bf72f5f19..cc58efaf6 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnLanguageChange.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnLanguageChange.java @@ -1,34 +1,34 @@ -/* - * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this - * list of conditions and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following - * disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its - * contributors may be used to endorse or promote products derived from this - * software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ +/*
+ * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
package com.smartdevicelink.proxy.rpc;
import androidx.annotation.NonNull;
@@ -116,11 +116,12 @@ public class OnLanguageChange extends RPCNotification { setHmiDisplayLanguage(hmiDisplayLanguage);
}
/**
- * <p>Sets language that current SDL voice engine(VR+TTS) use</p>
+ * <p>Sets language that current SDL voice engine(VR+TTS) use</p>
* @param language language that current SDL voice engine(VR+TTS) use
- */
- public void setLanguage(@NonNull Language language) {
+ */
+ public OnLanguageChange setLanguage(@NonNull Language language) {
setParameters(KEY_LANGUAGE, language);
+ return this;
}
/**
* <p>Returns language that current SDL voice engine(VR+TTS) use</p>
@@ -130,11 +131,12 @@ public class OnLanguageChange extends RPCNotification { return (Language) getObject(Language.class, KEY_LANGUAGE);
}
/**
- * <p>Sets language that current display use</p>
+ * <p>Sets language that current display use</p>
* @param hmiDisplayLanguage language that current SDL voice engine(VR+TTS) use
- */
- public void setHmiDisplayLanguage(@NonNull Language hmiDisplayLanguage) {
+ */
+ public OnLanguageChange setHmiDisplayLanguage(@NonNull Language hmiDisplayLanguage) {
setParameters(KEY_HMI_DISPLAY_LANGUAGE, hmiDisplayLanguage);
+ return this;
}
/**
* <p>Returns language that current display use</p>
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnPermissionsChange.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnPermissionsChange.java index 41e003981..ebc95f699 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnPermissionsChange.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnPermissionsChange.java @@ -113,12 +113,13 @@ public class OnPermissionsChange extends RPCNotification { return (List<PermissionItem>) getObject(PermissionItem.class, KEY_PERMISSION_ITEM);
}
/**
- * <p>Sets PermissionItems describing change in permissions for a given set of RPCs</p>
+ * <p>Sets PermissionItems describing change in permissions for a given set of RPCs</p>
* @param permissionItem an List of PermissionItem describing change in permissions for a given set of RPCs
- */
- public void setPermissionItem(@NonNull List<PermissionItem> permissionItem) {
- setParameters(KEY_PERMISSION_ITEM, permissionItem);
- }
+ */
+ public OnPermissionsChange setPermissionItem(@NonNull List<PermissionItem> permissionItem) {
+ setParameters(KEY_PERMISSION_ITEM, permissionItem);
+ return this;
+ }
/**
* Returns the encryption requirement for this permission change
@@ -132,7 +133,8 @@ public class OnPermissionsChange extends RPCNotification { * Sets the encryption requirement for this permission change
* @param isRequired the boolean requirement to be set
*/
- public void setRequireEncryption(Boolean isRequired) {
- setParameters(KEY_REQUIRE_ENCRYPTION, isRequired);
- }
+ public OnPermissionsChange setRequireEncryption( Boolean isRequired) {
+ setParameters(KEY_REQUIRE_ENCRYPTION, isRequired);
+ return this;
+ }
}
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnRCStatus.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnRCStatus.java index ffd7f03cc..e2f7831c9 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnRCStatus.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnRCStatus.java @@ -77,24 +77,27 @@ public class OnRCStatus extends RPCNotification { return (List<ModuleData>) getObject(ModuleData.class, KEY_ALLOCATED_MODULES); } - public void setAllocatedModules(@NonNull List<ModuleData> allocatedModules) { - setParameters(KEY_ALLOCATED_MODULES, allocatedModules); - } + public OnRCStatus setAllocatedModules(@NonNull List<ModuleData> allocatedModules) { + setParameters(KEY_ALLOCATED_MODULES, allocatedModules); + return this; + } @SuppressWarnings("unchecked") public List<ModuleData> getFreeModules() { return (List<ModuleData>) getObject(ModuleData.class, KEY_FREE_MODULES); } - public void setFreeModules(@NonNull List<ModuleData> freeModules) { - setParameters(KEY_FREE_MODULES, freeModules); - } + public OnRCStatus setFreeModules(@NonNull List<ModuleData> freeModules) { + setParameters(KEY_FREE_MODULES, freeModules); + return this; + } public Boolean getAllowed() { return getBoolean(KEY_ALLOWED); } - public void setAllowed(Boolean allowed) { - setParameters(KEY_ALLOWED, allowed); - } + public OnRCStatus setAllowed( Boolean allowed) { + setParameters(KEY_ALLOWED, allowed); + return this; + } } diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnSystemCapabilityUpdated.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnSystemCapabilityUpdated.java index d01bf757d..98e9088c6 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnSystemCapabilityUpdated.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnSystemCapabilityUpdated.java @@ -65,9 +65,10 @@ public class OnSystemCapabilityUpdated extends RPCNotification { /** * @param systemCapability - The system capability that has been updated */ - public void setSystemCapability(@NonNull SystemCapability systemCapability){ - setParameters(KEY_SYSTEM_CAPABILITY, systemCapability); - } + public OnSystemCapabilityUpdated setSystemCapability(@NonNull SystemCapability systemCapability) { + setParameters(KEY_SYSTEM_CAPABILITY, systemCapability); + return this; + } /** * @return systemCapability - The system capability that has been updated diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnSystemRequest.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnSystemRequest.java index 5de6c922b..ff7f1b959 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnSystemRequest.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnSystemRequest.java @@ -231,9 +231,10 @@ public class OnSystemRequest extends RPCNotification { }
@Override
- public void setBulkData(byte[] bulkData){
+ public OnSystemRequest setBulkData(byte[] bulkData){
super.setBulkData(bulkData);
handleBulkData(bulkData);
+ return this;
}
@@ -246,12 +247,14 @@ public class OnSystemRequest extends RPCNotification { return this.body;
}
- public void setBody(String body) {
+ public OnSystemRequest setBody( String body) {
this.body = body;
+ return this;
}
- public void setHeaders(Headers header) {
+ public OnSystemRequest setHeaders( Headers header) {
this.headers = header;
+ return this;
}
public Headers getHeader() {
@@ -262,16 +265,18 @@ public class OnSystemRequest extends RPCNotification { return (RequestType) getObject(RequestType.class, KEY_REQUEST_TYPE);
}
- public void setRequestType(@NonNull RequestType requestType) {
+ public OnSystemRequest setRequestType(@NonNull RequestType requestType) {
setParameters(KEY_REQUEST_TYPE, requestType);
+ return this;
}
public String getRequestSubType() {
return getString(KEY_REQUEST_SUB_TYPE);
}
- public void setRequestSubType(String requestSubType) {
+ public OnSystemRequest setRequestSubType( String requestSubType) {
setParameters(KEY_REQUEST_SUB_TYPE, requestSubType);
+ return this;
}
public String getUrl() {
@@ -290,28 +295,31 @@ public class OnSystemRequest extends RPCNotification { return null;
}
- public void setUrl(String url) {
+ public OnSystemRequest setUrl( String url) {
setParameters(KEY_URL, url);
+ return this;
}
public FileType getFileType() {
return (FileType) getObject(FileType.class, KEY_FILE_TYPE);
}
- public void setFileType(FileType fileType) {
+ public OnSystemRequest setFileType( FileType fileType) {
setParameters(KEY_FILE_TYPE, fileType);
+ return this;
}
/**
* @deprecated as of SmartDeviceLink 4.0
* @param offset of the data attached
*/
- public void setOffset(Integer offset) {
- if(offset == null){
+ public OnSystemRequest setOffset( Integer offset) {
+ if(offset == null){
setOffset((Long)null);
}else{
setOffset(offset.longValue());
}
+ return this;
}
public Long getOffset() {
@@ -329,8 +337,9 @@ public class OnSystemRequest extends RPCNotification { return null;
}
- public void setOffset(Long offset) {
+ public OnSystemRequest setOffset( Long offset) {
setParameters(KEY_OFFSET, offset);
+ return this;
}
public Integer getTimeout() {
@@ -347,9 +356,10 @@ public class OnSystemRequest extends RPCNotification { return null;
}
- public void setTimeout(Integer timeout) {
+ public OnSystemRequest setTimeout( Integer timeout) {
setParameters(KEY_TIMEOUT, timeout);
- }
+ return this;
+ }
public Long getLength() {
final Object o = getParameters(KEY_LENGTH);
@@ -369,15 +379,17 @@ public class OnSystemRequest extends RPCNotification { * @deprecated as of SmartDeviceLink 4.0
* @param length of the data attached
*/
- public void setLength(Integer length) {
- if(length == null){
+ public OnSystemRequest setLength( Integer length) {
+ if(length == null){
setLength((Long)null);
}else{
setLength(length.longValue());
}
+ return this;
}
- public void setLength(Long length) {
+ public OnSystemRequest setLength( Long length) {
setParameters(KEY_LENGTH, length);
+ return this;
}
}
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnTBTClientState.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnTBTClientState.java index c11eb1066..977e2afe9 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnTBTClientState.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnTBTClientState.java @@ -1,34 +1,34 @@ -/* - * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this - * list of conditions and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following - * disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its - * contributors may be used to endorse or promote products derived from this - * software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ +/*
+ * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
package com.smartdevicelink.proxy.rpc;
import androidx.annotation.NonNull;
@@ -104,8 +104,9 @@ public class OnTBTClientState extends RPCNotification { /**
* <p>Called to set the current state of TBT client</p>
* @param state current state of TBT client
- */
- public void setState( TBTState state ) {
+ */
+ public OnTBTClientState setState( TBTState state) {
setParameters(KEY_STATE, state);
+ return this;
}
} // end-class
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnTouchEvent.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnTouchEvent.java index b898cc398..bdc83bfab 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnTouchEvent.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnTouchEvent.java @@ -1,34 +1,34 @@ -/* - * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this - * list of conditions and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following - * disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its - * contributors may be used to endorse or promote products derived from this - * software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ +/*
+ * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
package com.smartdevicelink.proxy.rpc;
import androidx.annotation.NonNull;
@@ -109,16 +109,18 @@ public class OnTouchEvent extends RPCNotification { setEvent(event);
}
- public void setType(@NonNull TouchType type) {
- setParameters(KEY_TYPE, type);
+ public OnTouchEvent setType(@NonNull TouchType type) {
+ setParameters(KEY_TYPE, type);
+ return this;
}
public TouchType getType() {
return (TouchType) getObject(TouchType.class, KEY_TYPE);
}
- public void setEvent(@NonNull List<TouchEvent> event) {
- setParameters(KEY_EVENT, event);
+ public OnTouchEvent setEvent(@NonNull List<TouchEvent> event) {
+ setParameters(KEY_EVENT, event);
+ return this;
}
@SuppressWarnings("unchecked")
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnUpdateFile.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnUpdateFile.java index 2f1c63cf8..9a7b32c5c 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnUpdateFile.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnUpdateFile.java @@ -96,8 +96,9 @@ public class OnUpdateFile extends RPCNotification { * * @param fileName File reference name. */ - public void setFileName(@NonNull String fileName) { + public OnUpdateFile setFileName(@NonNull String fileName) { setParameters(KEY_FILE_NAME, fileName); + return this; } /** diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnUpdateSubMenu.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnUpdateSubMenu.java index e6fb05829..e430aa71d 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnUpdateSubMenu.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnUpdateSubMenu.java @@ -105,8 +105,9 @@ public class OnUpdateSubMenu extends RPCNotification { * * @param menuID This menuID must match a menuID in the current menu structure */ - public void setMenuID(@NonNull Integer menuID) { + public OnUpdateSubMenu setMenuID(@NonNull Integer menuID) { setParameters(KEY_MENU_ID, menuID); + return this; } /** @@ -125,8 +126,9 @@ public class OnUpdateSubMenu extends RPCNotification { * the menuID. These AddCommands will then be attached to the submenu and displayed if the * submenu is selected. */ - public void setUpdateSubCells(Boolean updateSubCells) { + public OnUpdateSubMenu setUpdateSubCells( Boolean updateSubCells) { setParameters(KEY_UPDATE_SUB_CELLS, updateSubCells); + return this; } /** diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnVehicleData.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnVehicleData.java index a5cbb162c..c134eba57 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnVehicleData.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnVehicleData.java @@ -386,22 +386,25 @@ public class OnVehicleData extends RPCNotification { public OnVehicleData(Hashtable<String, Object> hash) {
super(hash);
}
- public void setGps(GPSData gps) {
+ public OnVehicleData setGps( GPSData gps) {
setParameters(KEY_GPS, gps);
+ return this;
}
@SuppressWarnings("unchecked")
public GPSData getGps() {
return (GPSData) getObject(GPSData.class, KEY_GPS);
}
- public void setSpeed(Double speed) {
+ public OnVehicleData setSpeed( Double speed) {
setParameters(KEY_SPEED, speed);
+ return this;
}
public Double getSpeed() {
Object object = getParameters(KEY_SPEED);
return SdlDataTypeConverter.objectToDouble(object);
}
- public void setRpm(Integer rpm) {
+ public OnVehicleData setRpm( Integer rpm) {
setParameters(KEY_RPM, rpm);
+ return this;
}
public Integer getRpm() {
return getInteger(KEY_RPM);
@@ -414,8 +417,9 @@ public class OnVehicleData extends RPCNotification { * 7.0, please see fuelRange.
*/
@Deprecated
- public void setFuelLevel(Double fuelLevel) {
+ public OnVehicleData setFuelLevel( Double fuelLevel) {
setParameters(KEY_FUEL_LEVEL, fuelLevel);
+ return this;
}
/**
@@ -430,29 +434,33 @@ public class OnVehicleData extends RPCNotification { return SdlDataTypeConverter.objectToDouble(object);
}
@Deprecated
- public void setFuelLevelState(ComponentVolumeStatus fuelLevelState) {
+ public OnVehicleData setFuelLevelState( ComponentVolumeStatus fuelLevelState) {
setParameters(KEY_FUEL_LEVEL_STATE, fuelLevelState);
+ return this;
}
@Deprecated
public ComponentVolumeStatus getFuelLevelState() {
return (ComponentVolumeStatus) getObject(ComponentVolumeStatus.class, KEY_FUEL_LEVEL_STATE);
}
- public void setInstantFuelConsumption(Double instantFuelConsumption) {
+ public OnVehicleData setInstantFuelConsumption( Double instantFuelConsumption) {
setParameters(KEY_INSTANT_FUEL_CONSUMPTION, instantFuelConsumption);
+ return this;
}
public Double getInstantFuelConsumption() {
Object object = getParameters(KEY_INSTANT_FUEL_CONSUMPTION);
return SdlDataTypeConverter.objectToDouble(object);
}
- public void setExternalTemperature(Double externalTemperature) {
+ public OnVehicleData setExternalTemperature( Double externalTemperature) {
setParameters(KEY_EXTERNAL_TEMPERATURE, externalTemperature);
+ return this;
}
public Double getExternalTemperature() {
Object object = getParameters(KEY_EXTERNAL_TEMPERATURE);
return SdlDataTypeConverter.objectToDouble(object);
}
- public void setVin(String vin) {
+ public OnVehicleData setVin( String vin) {
setParameters(KEY_VIN, vin);
+ return this;
}
public String getVin() {
return getString(KEY_VIN);
@@ -465,8 +473,9 @@ public class OnVehicleData extends RPCNotification { * @deprecated in SmartDeviceLink 7.0.0
*/
@Deprecated
- public void setPrndl(PRNDL prndl) {
+ public OnVehicleData setPrndl( PRNDL prndl) {
setParameters(KEY_PRNDL, prndl);
+ return this;
}
/**
@@ -485,117 +494,134 @@ public class OnVehicleData extends RPCNotification { *
* @param tirePressure See TireStatus
*/
- public void setTirePressure(TireStatus tirePressure) {
+ public OnVehicleData setTirePressure( TireStatus tirePressure) {
setParameters(KEY_TIRE_PRESSURE, tirePressure);
+ return this;
}
@SuppressWarnings("unchecked")
public TireStatus getTirePressure() {
return (TireStatus) getObject(TireStatus.class, KEY_TIRE_PRESSURE);
}
- public void setOdometer(Integer odometer) {
+ public OnVehicleData setOdometer( Integer odometer) {
setParameters(KEY_ODOMETER, odometer);
+ return this;
}
public Integer getOdometer() {
return getInteger(KEY_ODOMETER);
}
- public void setBeltStatus(BeltStatus beltStatus) {
+ public OnVehicleData setBeltStatus( BeltStatus beltStatus) {
setParameters(KEY_BELT_STATUS, beltStatus);
+ return this;
}
@SuppressWarnings("unchecked")
public BeltStatus getBeltStatus() {
return (BeltStatus) getObject(BeltStatus.class, KEY_BELT_STATUS);
}
- public void setBodyInformation(BodyInformation bodyInformation) {
+ public OnVehicleData setBodyInformation( BodyInformation bodyInformation) {
setParameters(KEY_BODY_INFORMATION, bodyInformation);
+ return this;
}
@SuppressWarnings("unchecked")
public BodyInformation getBodyInformation() {
return (BodyInformation) getObject(BodyInformation.class, KEY_BODY_INFORMATION);
}
- public void setDeviceStatus(DeviceStatus deviceStatus) {
+ public OnVehicleData setDeviceStatus( DeviceStatus deviceStatus) {
setParameters(KEY_DEVICE_STATUS, deviceStatus);
+ return this;
}
@SuppressWarnings("unchecked")
public DeviceStatus getDeviceStatus() {
return (DeviceStatus) getObject(DeviceStatus.class, KEY_DEVICE_STATUS);
}
- public void setDriverBraking(VehicleDataEventStatus driverBraking) {
+ public OnVehicleData setDriverBraking( VehicleDataEventStatus driverBraking) {
setParameters(KEY_DRIVER_BRAKING, driverBraking);
+ return this;
}
public VehicleDataEventStatus getDriverBraking() {
return (VehicleDataEventStatus) getObject(VehicleDataEventStatus.class, KEY_DRIVER_BRAKING);
}
- public void setWiperStatus(WiperStatus wiperStatus) {
+ public OnVehicleData setWiperStatus( WiperStatus wiperStatus) {
setParameters(KEY_WIPER_STATUS, wiperStatus);
+ return this;
}
public WiperStatus getWiperStatus() {
return (WiperStatus) getObject(WiperStatus.class, KEY_WIPER_STATUS);
}
- public void setHeadLampStatus(HeadLampStatus headLampStatus) {
+ public OnVehicleData setHeadLampStatus( HeadLampStatus headLampStatus) {
setParameters(KEY_HEAD_LAMP_STATUS, headLampStatus);
+ return this;
}
@SuppressWarnings("unchecked")
public HeadLampStatus getHeadLampStatus() {
return (HeadLampStatus) getObject(HeadLampStatus.class, KEY_HEAD_LAMP_STATUS);
}
- public void setEngineTorque(Double engineTorque) {
+ public OnVehicleData setEngineTorque( Double engineTorque) {
setParameters(KEY_ENGINE_TORQUE, engineTorque);
+ return this;
}
public Double getEngineTorque() {
Object object = getParameters(KEY_ENGINE_TORQUE);
return SdlDataTypeConverter.objectToDouble(object);
}
- public void setEngineOilLife(Float engineOilLife) {
+ public OnVehicleData setEngineOilLife( Float engineOilLife) {
setParameters(KEY_ENGINE_OIL_LIFE, engineOilLife);
+ return this;
}
public Float getEngineOilLife() {
Object object = getParameters(KEY_ENGINE_OIL_LIFE);
return SdlDataTypeConverter.objectToFloat(object);
}
- public void setAccPedalPosition(Double accPedalPosition) {
+ public OnVehicleData setAccPedalPosition( Double accPedalPosition) {
setParameters(KEY_ACC_PEDAL_POSITION, accPedalPosition);
+ return this;
}
public Double getAccPedalPosition() {
Object object = getParameters(KEY_ACC_PEDAL_POSITION);
return SdlDataTypeConverter.objectToDouble(object);
}
- public void setSteeringWheelAngle(Double steeringWheelAngle) {
+ public OnVehicleData setSteeringWheelAngle( Double steeringWheelAngle) {
setParameters(KEY_STEERING_WHEEL_ANGLE, steeringWheelAngle);
+ return this;
}
public Double getSteeringWheelAngle() {
Object object = getParameters(KEY_STEERING_WHEEL_ANGLE);
return SdlDataTypeConverter.objectToDouble(object);
}
- public void setECallInfo(ECallInfo eCallInfo) {
+ public OnVehicleData setECallInfo( ECallInfo eCallInfo) {
setParameters(KEY_E_CALL_INFO, eCallInfo);
+ return this;
}
@SuppressWarnings("unchecked")
public ECallInfo getECallInfo() {
return (ECallInfo) getObject(ECallInfo.class, KEY_E_CALL_INFO);
}
- public void setAirbagStatus(AirbagStatus airbagStatus) {
+ public OnVehicleData setAirbagStatus( AirbagStatus airbagStatus) {
setParameters(KEY_AIRBAG_STATUS, airbagStatus);
+ return this;
}
@SuppressWarnings("unchecked")
public AirbagStatus getAirbagStatus() {
return (AirbagStatus) getObject(AirbagStatus.class, KEY_AIRBAG_STATUS);
}
- public void setEmergencyEvent(EmergencyEvent emergencyEvent) {
+ public OnVehicleData setEmergencyEvent( EmergencyEvent emergencyEvent) {
setParameters(KEY_EMERGENCY_EVENT, emergencyEvent);
+ return this;
}
@SuppressWarnings("unchecked")
public EmergencyEvent getEmergencyEvent() {
return (EmergencyEvent) getObject(EmergencyEvent.class, KEY_EMERGENCY_EVENT);
}
- public void setClusterModeStatus(ClusterModeStatus clusterModeStatus) {
+ public OnVehicleData setClusterModeStatus( ClusterModeStatus clusterModeStatus) {
setParameters(KEY_CLUSTER_MODE_STATUS, clusterModeStatus);
+ return this;
}
@SuppressWarnings("unchecked")
public ClusterModeStatus getClusterModeStatus() {
return (ClusterModeStatus) getObject(ClusterModeStatus.class, KEY_CLUSTER_MODE_STATUS);
}
- public void setMyKey(MyKey myKey) {
+ public OnVehicleData setMyKey( MyKey myKey) {
setParameters(KEY_MY_KEY, myKey);
+ return this;
}
@SuppressWarnings("unchecked")
public MyKey getMyKey() {
@@ -610,8 +636,9 @@ public class OnVehicleData extends RPCNotification { * {"array_min_size": 0, "array_max_size": 100}
* @since SmartDeviceLink 5.0.0
*/
- public void setFuelRange(List<FuelRange> fuelRange) {
+ public OnVehicleData setFuelRange( List<FuelRange> fuelRange) {
setParameters(KEY_FUEL_RANGE, fuelRange);
+ return this;
}
/**
@@ -632,8 +659,9 @@ public class OnVehicleData extends RPCNotification { * Sets turnSignal
* @param turnSignal
*/
- public void setTurnSignal(TurnSignal turnSignal) {
+ public OnVehicleData setTurnSignal( TurnSignal turnSignal) {
setParameters(KEY_TURN_SIGNAL, turnSignal);
+ return this;
}
/**
@@ -649,8 +677,9 @@ public class OnVehicleData extends RPCNotification { * Sets electronicParkBrakeStatus
* @param electronicParkBrakeStatus
*/
- public void setElectronicParkBrakeStatus(ElectronicParkBrakeStatus electronicParkBrakeStatus){
+ public OnVehicleData setElectronicParkBrakeStatus( ElectronicParkBrakeStatus electronicParkBrakeStatus) {
setParameters(KEY_ELECTRONIC_PARK_BRAKE_STATUS, electronicParkBrakeStatus);
+ return this;
}
/**
@@ -665,8 +694,9 @@ public class OnVehicleData extends RPCNotification { * Sets a string value for the cloud app vehicle ID
* @param cloudAppVehicleID a string value
*/
- public void setCloudAppVehicleID(String cloudAppVehicleID){
+ public OnVehicleData setCloudAppVehicleID( String cloudAppVehicleID) {
setParameters(KEY_CLOUD_APP_VEHICLE_ID, cloudAppVehicleID);
+ return this;
}
/**
@@ -682,8 +712,9 @@ public class OnVehicleData extends RPCNotification { * @param vehicleDataName a String value
* @param vehicleDataState a VehicleDataResult value
*/
- public void setOEMCustomVehicleData(String vehicleDataName, Object vehicleDataState){
+ public OnVehicleData setOEMCustomVehicleData( String vehicleDataName, Object vehicleDataState) {
setParameters(vehicleDataName, vehicleDataState);
+ return this;
}
/**
@@ -700,8 +731,9 @@ public class OnVehicleData extends RPCNotification { * @param windowStatus See WindowStatus
* @since SmartDeviceLink 7.0.0
*/
- public void setWindowStatus(List<WindowStatus> windowStatus) {
+ public OnVehicleData setWindowStatus( List<WindowStatus> windowStatus) {
setParameters(KEY_WINDOW_STATUS, windowStatus);
+ return this;
}
/**
@@ -731,8 +763,9 @@ public class OnVehicleData extends RPCNotification { * @param stabilityControlsStatus See StabilityControlsStatus
* @since SmartDeviceLink 7.0.0
*/
- public void setStabilityControlsStatus(StabilityControlsStatus stabilityControlsStatus) {
+ public OnVehicleData setStabilityControlsStatus( StabilityControlsStatus stabilityControlsStatus) {
setParameters(KEY_STABILITY_CONTROLS_STATUS, stabilityControlsStatus);
+ return this;
}
/**
@@ -741,8 +774,9 @@ public class OnVehicleData extends RPCNotification { * @param handsOffSteering To indicate whether driver hands are off the steering wheel
* @since SmartDeviceLink 7.0.0
*/
- public void setHandsOffSteering(Boolean handsOffSteering) {
+ public OnVehicleData setHandsOffSteering( Boolean handsOffSteering) {
setParameters(KEY_HANDS_OFF_STEERING, handsOffSteering);
+ return this;
}
/**
@@ -760,8 +794,9 @@ public class OnVehicleData extends RPCNotification { * @param gearStatus See GearStatus
* @since SmartDeviceLink 7.0.0
*/
- public void setGearStatus(GearStatus gearStatus) {
+ public OnVehicleData setGearStatus( GearStatus gearStatus) {
setParameters(KEY_GEAR_STATUS, gearStatus);
+ return this;
}
/**
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnWayPointChange.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnWayPointChange.java index f204b6998..27809115b 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnWayPointChange.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnWayPointChange.java @@ -60,7 +60,8 @@ public class OnWayPointChange extends RPCNotification { return (List<LocationDetails>) getObject(LocationDetails.class, KEY_WAY_POINTS); } - public void setWayPoints(@NonNull List<LocationDetails> wayPoints) { - setParameters(KEY_WAY_POINTS, wayPoints); - } + public OnWayPointChange setWayPoints(@NonNull List<LocationDetails> wayPoints) { + setParameters(KEY_WAY_POINTS, wayPoints); + return this; + } } diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/ParameterPermissions.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/ParameterPermissions.java index 4de4ad82c..e102f56c0 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/ParameterPermissions.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/ParameterPermissions.java @@ -1,34 +1,34 @@ -/* - * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this - * list of conditions and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following - * disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its - * contributors may be used to endorse or promote products derived from this - * software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ +/*
+ * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
package com.smartdevicelink.proxy.rpc;
import androidx.annotation.NonNull;
@@ -116,8 +116,9 @@ public class ParameterPermissions extends RPCStruct { * set a set of all parameters that are permitted for this given RPC.
* @param allowed parameter that is permitted for this given RPC
*/
- public void setAllowed(@NonNull List<String> allowed) {
+ public ParameterPermissions setAllowed(@NonNull List<String> allowed) {
setValue(KEY_ALLOWED, allowed);
+ return this;
}
/**
@@ -133,7 +134,8 @@ public class ParameterPermissions extends RPCStruct { * set a set of all parameters that are prohibited for this given RPC.
* @param userDisallowed paramter that is prohibited for this given RPC
*/
- public void setUserDisallowed(@NonNull List<String> userDisallowed) {
+ public ParameterPermissions setUserDisallowed(@NonNull List<String> userDisallowed) {
setValue(KEY_USER_DISALLOWED, userDisallowed);
+ return this;
}
}
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/PerformAppServiceInteraction.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/PerformAppServiceInteraction.java index a71f1b25a..af70ab1c0 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/PerformAppServiceInteraction.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/PerformAppServiceInteraction.java @@ -67,9 +67,10 @@ public class PerformAppServiceInteraction extends RPCRequest { * URI is correct. * @param serviceUri - */ - public void setServiceUri(@NonNull String serviceUri){ - setParameters(KEY_SERVICE_URI, serviceUri); - } + public PerformAppServiceInteraction setServiceUri(@NonNull String serviceUri) { + setParameters(KEY_SERVICE_URI, serviceUri); + return this; + } /** * Fully qualified URI based on a predetermined scheme provided by the app service. SDL makes no guarantee that this @@ -84,9 +85,10 @@ public class PerformAppServiceInteraction extends RPCRequest { * The service ID that the app consumer wishes to send this URI. * @param appServiceId - */ - public void setServiceID(@NonNull String appServiceId){ - setParameters(KEY_SERVICE_ID, appServiceId); - } + public PerformAppServiceInteraction setServiceID(@NonNull String appServiceId) { + setParameters(KEY_SERVICE_ID, appServiceId); + return this; + } /** * The service ID that the app consumer wishes to send this URI. @@ -100,9 +102,10 @@ public class PerformAppServiceInteraction extends RPCRequest { * This string is the appID of the app requesting the app service provider take the specific action. * @param originApp - */ - public void setOriginApp(@NonNull String originApp){ - setParameters(KEY_ORIGIN_APP, originApp); - } + public PerformAppServiceInteraction setOriginApp(@NonNull String originApp) { + setParameters(KEY_ORIGIN_APP, originApp); + return this; + } /** * This string is the appID of the app requesting the app service provider take the specific action. @@ -117,9 +120,10 @@ public class PerformAppServiceInteraction extends RPCRequest { * service of the destination's type. * @param requestServiceActive - */ - public void setRequestServiceActive(Boolean requestServiceActive){ - setParameters(KEY_REQUEST_SERVICE_ACTIVE, requestServiceActive); - } + public PerformAppServiceInteraction setRequestServiceActive( Boolean requestServiceActive) { + setParameters(KEY_REQUEST_SERVICE_ACTIVE, requestServiceActive); + return this; + } /** * This string is the appID of the app requesting the app service provider take the specific action. diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/PerformAppServiceInteractionResponse.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/PerformAppServiceInteractionResponse.java index cc6d5c5f4..481c91e17 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/PerformAppServiceInteractionResponse.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/PerformAppServiceInteractionResponse.java @@ -70,9 +70,10 @@ public class PerformAppServiceInteractionResponse extends RPCResponse { * The service can provide specific result strings to the consumer through this param. * @param serviceSpecificResult - */ - public void setServiceSpecificResult(String serviceSpecificResult){ - setParameters(KEY_SERVICE_SPECIFIC_RESULT, serviceSpecificResult); - } + public PerformAppServiceInteractionResponse setServiceSpecificResult( String serviceSpecificResult) { + setParameters(KEY_SERVICE_SPECIFIC_RESULT, serviceSpecificResult); + return this; + } /** * The service can provide specific result strings to the consumer through this param. diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/PerformAudioPassThru.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/PerformAudioPassThru.java index f9a4a29cb..0e125f8a7 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/PerformAudioPassThru.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/PerformAudioPassThru.java @@ -1,34 +1,34 @@ -/* - * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this - * list of conditions and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following - * disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its - * contributors may be used to endorse or promote products derived from this - * software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ +/*
+ * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
package com.smartdevicelink.proxy.rpc;
import androidx.annotation.NonNull;
@@ -170,7 +170,7 @@ public class PerformAudioPassThru extends RPCRequest { /**
* Sets initial prompt which will be spoken before opening the audio pass
* thru session by SDL
- *
+ *
* @param initialPrompt
* a List<TTSChunk> value represents the initial prompt which
* will be spoken before opening the audio pass thru session by
@@ -185,8 +185,9 @@ public class PerformAudioPassThru extends RPCRequest { * <li>Array Maxsize: 100</li>
* </ul>
*/
- public void setInitialPrompt(List<TTSChunk> initialPrompt) {
- setParameters(KEY_INITIAL_PROMPT, initialPrompt);
+ public PerformAudioPassThru setInitialPrompt( List<TTSChunk> initialPrompt) {
+ setParameters(KEY_INITIAL_PROMPT, initialPrompt);
+ return this;
}
/**
@@ -204,15 +205,16 @@ public class PerformAudioPassThru extends RPCRequest { /**
* Sets a line of text displayed during audio capture
- *
+ *
* @param audioPassThruDisplayText1
* <p>a String value representing the line of text displayed during
* audio capture</p>
* <p></p>
* <b>Notes: </b>Maxlength=500
*/
- public void setAudioPassThruDisplayText1(String audioPassThruDisplayText1) {
- setParameters(KEY_AUDIO_PASS_THRU_DISPLAY_TEXT_1, audioPassThruDisplayText1);
+ public PerformAudioPassThru setAudioPassThruDisplayText1( String audioPassThruDisplayText1) {
+ setParameters(KEY_AUDIO_PASS_THRU_DISPLAY_TEXT_1, audioPassThruDisplayText1);
+ return this;
}
/**
@@ -227,15 +229,16 @@ public class PerformAudioPassThru extends RPCRequest { /**
* Sets a line of text displayed during audio capture
- *
+ *
* @param audioPassThruDisplayText2
* <p>a String value representing the line of text displayed during
* audio capture</p>
* <p></p>
* <b>Notes: </b>Maxlength=500
*/
- public void setAudioPassThruDisplayText2(String audioPassThruDisplayText2) {
- setParameters(KEY_AUDIO_PASS_THRU_DISPLAY_TEXT_2, audioPassThruDisplayText2);
+ public PerformAudioPassThru setAudioPassThruDisplayText2( String audioPassThruDisplayText2) {
+ setParameters(KEY_AUDIO_PASS_THRU_DISPLAY_TEXT_2, audioPassThruDisplayText2);
+ return this;
}
/**
@@ -250,12 +253,13 @@ public class PerformAudioPassThru extends RPCRequest { /**
* Sets a samplingRate
- *
+ *
* @param samplingRate
* a SamplingRate value representing a 8 or 16 or 22 or 24 khz
*/
- public void setSamplingRate(@NonNull SamplingRate samplingRate) {
- setParameters(KEY_SAMPLING_RATE, samplingRate);
+ public PerformAudioPassThru setSamplingRate(@NonNull SamplingRate samplingRate) {
+ setParameters(KEY_SAMPLING_RATE, samplingRate);
+ return this;
}
/**
@@ -269,15 +273,16 @@ public class PerformAudioPassThru extends RPCRequest { /**
* Sets the maximum duration of audio recording in milliseconds
- *
+ *
* @param maxDuration
* an Integer value representing the maximum duration of audio
* recording in millisecond
* <p></p>
* <b>Notes: </b>Minvalue:1; Maxvalue:1000000
*/
- public void setMaxDuration(@NonNull Integer maxDuration) {
- setParameters(KEY_MAX_DURATION, maxDuration);
+ public PerformAudioPassThru setMaxDuration(@NonNull Integer maxDuration) {
+ setParameters(KEY_MAX_DURATION, maxDuration);
+ return this;
}
/**
@@ -292,12 +297,13 @@ public class PerformAudioPassThru extends RPCRequest { /**
* Sets the quality the audio is recorded - 8 bit or 16 bit
- *
+ *
* @param audioQuality
* a BitsPerSample value representing 8 bit or 16 bit
*/
- public void setBitsPerSample(@NonNull BitsPerSample audioQuality) {
- setParameters(KEY_BITS_PER_SAMPLE, audioQuality);
+ public PerformAudioPassThru setBitsPerSample(@NonNull BitsPerSample audioQuality) {
+ setParameters(KEY_BITS_PER_SAMPLE, audioQuality);
+ return this;
}
/**
@@ -311,12 +317,13 @@ public class PerformAudioPassThru extends RPCRequest { /**
* Sets an audioType
- *
+ *
* @param audioType
* an audioType
*/
- public void setAudioType(@NonNull AudioType audioType) {
- setParameters(KEY_AUDIO_TYPE, audioType);
+ public PerformAudioPassThru setAudioType(@NonNull AudioType audioType) {
+ setParameters(KEY_AUDIO_TYPE, audioType);
+ return this;
}
/**
@@ -345,13 +352,14 @@ public class PerformAudioPassThru extends RPCRequest { * muted during the APT session
* If not, the audio source will play without interruption. If omitted, the
* value is set to true</p>
- *
- *
+ *
+ *
* @param muteAudio
* a Boolean value representing if the current audio source
* should be muted during the APT session
*/
- public void setMuteAudio(Boolean muteAudio) {
- setParameters(KEY_MUTE_AUDIO, muteAudio);
- }
+ public PerformAudioPassThru setMuteAudio( Boolean muteAudio) {
+ setParameters(KEY_MUTE_AUDIO, muteAudio);
+ return this;
+ }
}
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/PerformInteraction.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/PerformInteraction.java index 129825f6c..99efbb2ef 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/PerformInteraction.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/PerformInteraction.java @@ -207,12 +207,13 @@ public class PerformInteraction extends RPCRequest { * be overlaid by the "Listening" prompt during the interaction. Text is
* displayed on first line of multiline display, and is centered. If text
* does not fit on line, it will be truncated
- *
+ *
* @param initialText
* a String value that Displayed when the interaction begins
- */
- public void setInitialText(@NonNull String initialText) {
- setParameters(KEY_INITIAL_TEXT, initialText);
+ */
+ public PerformInteraction setInitialText(@NonNull String initialText) {
+ setParameters(KEY_INITIAL_TEXT, initialText);
+ return this;
}
/**
* Gets an An array of one or more TTSChunks that, taken together, specify
@@ -228,13 +229,14 @@ public class PerformInteraction extends RPCRequest { /**
* Sets An array of one or more TTSChunks that, taken together, specify what
* is to be spoken to the user at the start of an interaction
- *
+ *
* @param initialPrompt
* a List<TTSChunk> value, specify what is to be spoken to the
* user at the start of an interaction
- */
- public void setInitialPrompt(List<TTSChunk> initialPrompt) {
- setParameters(KEY_INITIAL_PROMPT, initialPrompt);
+ */
+ public PerformInteraction setInitialPrompt( List<TTSChunk> initialPrompt) {
+ setParameters(KEY_INITIAL_PROMPT, initialPrompt);
+ return this;
}
/**
* Gets the Indicates mode that indicate how user selects interaction
@@ -251,13 +253,14 @@ public class PerformInteraction extends RPCRequest { * Sets the Indicates mode that indicate how user selects interaction
* choice. User can choose either by voice (VR_ONLY), by visual selection
* from the menu (MANUAL_ONLY), or by either mode (BOTH)
- *
+ *
* @param interactionMode
* indicate how user selects interaction choice (VR_ONLY,
* MANUAL_ONLY or BOTH)
- */
- public void setInteractionMode(@NonNull InteractionMode interactionMode) {
- setParameters(KEY_INTERACTION_MODE, interactionMode);
+ */
+ public PerformInteraction setInteractionMode(@NonNull InteractionMode interactionMode) {
+ setParameters(KEY_INTERACTION_MODE, interactionMode);
+ return this;
}
/**
* Gets a List<Integer> value representing an Array of one or more Choice
@@ -274,16 +277,17 @@ public class PerformInteraction extends RPCRequest { /**
* Sets a List<Integer> representing an Array of one or more Choice Set
* IDs. User can select any choice from any of the specified Choice Sets
- *
+ *
* @param interactionChoiceSetIDList
* -a List<Integer> representing an Array of one or more Choice
* Set IDs. User can select any choice from any of the specified
* Choice Sets
* <p></p>
* <b>Notes: </b>Min Value: 0; Max Vlaue: 2000000000
- */
- public void setInteractionChoiceSetIDList(@NonNull List<Integer> interactionChoiceSetIDList) {
- setParameters(KEY_INTERACTION_CHOICE_SET_ID_LIST, interactionChoiceSetIDList);
+ */
+ public PerformInteraction setInteractionChoiceSetIDList(@NonNull List<Integer> interactionChoiceSetIDList) {
+ setParameters(KEY_INTERACTION_CHOICE_SET_ID_LIST, interactionChoiceSetIDList);
+ return this;
}
/**
* Gets a List<TTSChunk> which taken together, specify the help phrase to
@@ -307,14 +311,15 @@ public class PerformInteraction extends RPCRequest { * <P></p>
* <b>Notes: </b>The helpPrompt specified in
* {@linkplain SetGlobalProperties} is not used by PerformInteraction
- *
+ *
* @param helpPrompt
* a List<TTSChunk> which taken together, specify the help
* phrase to be spoken when the user says "help" during the VR
* session
- */
- public void setHelpPrompt(List<TTSChunk> helpPrompt) {
- setParameters(KEY_HELP_PROMPT, helpPrompt);
+ */
+ public PerformInteraction setHelpPrompt( List<TTSChunk> helpPrompt) {
+ setParameters(KEY_HELP_PROMPT, helpPrompt);
+ return this;
}
/**
* Gets An array of TTSChunks which, taken together, specify the phrase to
@@ -333,13 +338,14 @@ public class PerformInteraction extends RPCRequest { * <p></p>
* <b>Notes: </b>The timeoutPrompt specified in
* {@linkplain SetGlobalProperties} is not used by PerformInteraction
- *
+ *
* @param timeoutPrompt
* a List<TTSChunk> specify the phrase to be spoken when the
* listen times out during the VR session
- */
- public void setTimeoutPrompt(List<TTSChunk> timeoutPrompt) {
- setParameters(KEY_TIMEOUT_PROMPT, timeoutPrompt);
+ */
+ public PerformInteraction setTimeoutPrompt( List<TTSChunk> timeoutPrompt) {
+ setParameters(KEY_TIMEOUT_PROMPT, timeoutPrompt);
+ return this;
}
/**
* Gets a Integer value representing the amount of time, in milliseconds,
@@ -360,16 +366,17 @@ public class PerformInteraction extends RPCRequest { * take place after SDL speaks the timeout prompt. If that times out as
* well, the interaction will end completely. If omitted, the default is
* 10000ms
- *
+ *
* @param timeout
* an Integer value representing the amount of time, in
* milliseconds, SDL will wait for the user to make a choice (VR
* or Menu)
* <p></p>
* <b>Notes: </b>Min Value: 5000; Max Value: 100000
- */
- public void setTimeout(Integer timeout) {
- setParameters(KEY_TIMEOUT, timeout);
+ */
+ public PerformInteraction setTimeout( Integer timeout) {
+ setParameters(KEY_TIMEOUT, timeout);
+ return this;
}
/**
@@ -396,8 +403,9 @@ public class PerformInteraction extends RPCRequest { * <b>Notes: </b>Min=1; Max=100
* @since SmartDeviceLink 2.0
*/
- public void setVrHelp(List<VrHelpItem> vrHelp) {
- setParameters(KEY_VR_HELP, vrHelp);
+ public PerformInteraction setVrHelp( List<VrHelpItem> vrHelp) {
+ setParameters(KEY_VR_HELP, vrHelp);
+ return this;
}
/**
@@ -418,8 +426,9 @@ public class PerformInteraction extends RPCRequest { *
* @since SmartDeviceLink 3.0
*/
- public void setInteractionLayout(LayoutMode interactionLayout ) {
- setParameters(KEY_INTERACTION_LAYOUT, interactionLayout);
+ public PerformInteraction setInteractionLayout( LayoutMode interactionLayout) {
+ setParameters(KEY_INTERACTION_LAYOUT, interactionLayout);
+ return this;
}
/**
@@ -440,7 +449,8 @@ public class PerformInteraction extends RPCRequest { *
* @since SmartDeviceLink 6.0
*/
- public void setCancelID(Integer cancelID) {
- setParameters(KEY_CANCEL_ID, cancelID);
- }
+ public PerformInteraction setCancelID( Integer cancelID) {
+ setParameters(KEY_CANCEL_ID, cancelID);
+ return this;
+ }
}
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/PerformInteractionResponse.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/PerformInteractionResponse.java index 20fec4c85..9bd0e37a9 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/PerformInteractionResponse.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/PerformInteractionResponse.java @@ -1,34 +1,34 @@ -/* - * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this - * list of conditions and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following - * disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its - * contributors may be used to endorse or promote products derived from this - * software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ +/*
+ * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
package com.smartdevicelink.proxy.rpc;
import androidx.annotation.NonNull;
@@ -88,9 +88,10 @@ public class PerformInteractionResponse extends RPCResponse { /**
* Sets the application-scoped identifier that uniquely identifies this choice.
* @param choiceID Min: 0 Max: 65535
- */
- public void setChoiceID( Integer choiceID ) {
+ */
+ public PerformInteractionResponse setChoiceID( Integer choiceID) {
setParameters(KEY_CHOICE_ID, choiceID);
+ return this;
}
/**
* <p>Returns a <I>TriggerSource</I> object which will be shown in the HMI</p>
@@ -101,15 +102,17 @@ public class PerformInteractionResponse extends RPCResponse { }
/**
* <p>Sets TriggerSource
- * Indicates whether command was selected via VR or via a menu selection (using the OK button).</p>
+ * Indicates whether command was selected via VR or via a menu selection (using the OK button).</p>
* @param triggerSource a TriggerSource object
- */
- public void setTriggerSource( TriggerSource triggerSource ) {
+ */
+ public PerformInteractionResponse setTriggerSource( TriggerSource triggerSource) {
setParameters(KEY_TRIGGER_SOURCE, triggerSource);
+ return this;
}
- public void setManualTextEntry(String manualTextEntry) {
+ public PerformInteractionResponse setManualTextEntry( String manualTextEntry) {
setParameters(KEY_MANUAL_TEXT_ENTRY, manualTextEntry);
+ return this;
}
public String getManualTextEntry() {
return getString(KEY_MANUAL_TEXT_ENTRY);
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/PermissionItem.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/PermissionItem.java index ce0ec00a7..237fe84cc 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/PermissionItem.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/PermissionItem.java @@ -109,22 +109,25 @@ public class PermissionItem extends RPCStruct { public String getRpcName() {
return getString(KEY_RPC_NAME);
}
- public void setRpcName(@NonNull String rpcName) {
+ public PermissionItem setRpcName(@NonNull String rpcName) {
setValue(KEY_RPC_NAME, rpcName);
+ return this;
}
@SuppressWarnings("unchecked")
public HMIPermissions getHMIPermissions() {
return (HMIPermissions) getObject(HMIPermissions.class, KEY_HMI_PERMISSIONS);
}
- public void setHMIPermissions(@NonNull HMIPermissions hmiPermissions) {
+ public PermissionItem setHMIPermissions(@NonNull HMIPermissions hmiPermissions) {
setValue(KEY_HMI_PERMISSIONS, hmiPermissions);
+ return this;
}
@SuppressWarnings("unchecked")
public ParameterPermissions getParameterPermissions() {
return (ParameterPermissions) getObject(ParameterPermissions.class, KEY_PARAMETER_PERMISSIONS);
}
- public void setParameterPermissions(@NonNull ParameterPermissions parameterPermissions) {
+ public PermissionItem setParameterPermissions(@NonNull ParameterPermissions parameterPermissions) {
setValue(KEY_PARAMETER_PERMISSIONS, parameterPermissions);
+ return this;
}
/**
@@ -139,7 +142,8 @@ public class PermissionItem extends RPCStruct { * Sets the encryption requirement for this item
* @param isRequired the boolean requirement to be set
*/
- public void setRequireEncryption(Boolean isRequired) {
+ public PermissionItem setRequireEncryption( Boolean isRequired) {
setValue(KEY_REQUIRE_ENCRYPTION, isRequired);
+ return this;
}
}
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/PhoneCapability.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/PhoneCapability.java index 348f23f25..bffabdf09 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/PhoneCapability.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/PhoneCapability.java @@ -52,7 +52,8 @@ public class PhoneCapability extends RPCStruct { return getBoolean(KEY_DIALNUMBER_ENABLED); } - public void setDialNumberEnabled(Boolean dialNumberEnabled){ - setValue(KEY_DIALNUMBER_ENABLED, dialNumberEnabled); - } + public PhoneCapability setDialNumberEnabled( Boolean dialNumberEnabled) { + setValue(KEY_DIALNUMBER_ENABLED, dialNumberEnabled); + return this; + } } diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/PresetBankCapabilities.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/PresetBankCapabilities.java index 4b218e143..cb59d5f6c 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/PresetBankCapabilities.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/PresetBankCapabilities.java @@ -1,34 +1,34 @@ -/* - * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this - * list of conditions and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following - * disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its - * contributors may be used to endorse or promote products derived from this - * software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ +/*
+ * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
package com.smartdevicelink.proxy.rpc;
import androidx.annotation.NonNull;
@@ -86,8 +86,9 @@ public class PresetBankCapabilities extends RPCStruct { * set if Onscreen custom presets are available.
* @param onScreenPresetsAvailable if Onscreen custom presets are available.
*/
- public void setOnScreenPresetsAvailable(@NonNull Boolean onScreenPresetsAvailable) {
- setValue(KEY_ON_SCREEN_PRESETS_AVAILABLE, onScreenPresetsAvailable);
+ public PresetBankCapabilities setOnScreenPresetsAvailable(@NonNull Boolean onScreenPresetsAvailable) {
+ setValue(KEY_ON_SCREEN_PRESETS_AVAILABLE, onScreenPresetsAvailable);
+ return this;
}
/**
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/PublishAppService.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/PublishAppService.java index 9c121bc22..bc3e48e33 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/PublishAppService.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/PublishAppService.java @@ -79,9 +79,10 @@ public class PublishAppService extends RPCRequest { * If already published, the updated manifest for this service. * @param serviceManifest - the App Service Manifest */ - public void setAppServiceManifest(@NonNull AppServiceManifest serviceManifest){ - setParameters(KEY_APP_SERVICE_MANIFEST, serviceManifest); - } + public PublishAppService setAppServiceManifest(@NonNull AppServiceManifest serviceManifest) { + setParameters(KEY_APP_SERVICE_MANIFEST, serviceManifest); + return this; + } /** * The manifest of the service that wishes to be published. diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/PublishAppServiceResponse.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/PublishAppServiceResponse.java index 6fcddfd47..d52a310dd 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/PublishAppServiceResponse.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/PublishAppServiceResponse.java @@ -70,9 +70,10 @@ public class PublishAppServiceResponse extends RPCResponse { * for the published service. This will include the Core supplied service ID. * @param appServiceRecord - the App Service Record */ - public void setServiceRecord(AppServiceRecord appServiceRecord){ - setParameters(KEY_APP_SERVICE_RECORD, appServiceRecord); - } + public PublishAppServiceResponse setServiceRecord( AppServiceRecord appServiceRecord) { + setParameters(KEY_APP_SERVICE_RECORD, appServiceRecord); + return this; + } /** * If the request was successful, this object will be the current status of the service record diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/PutFile.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/PutFile.java index 2d01d9a47..da4adfb1d 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/PutFile.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/PutFile.java @@ -189,14 +189,15 @@ public class PutFile extends RPCRequest { /**
* Sets a file reference name
- *
+ *
* @param sdlFileName
* a String value representing a file reference name
* <p></p>
* <b>Notes: </b>Maxlength=500, however the max file name length may vary based on remote filesystem limitations
*/
- public void setSdlFileName(@NonNull String sdlFileName) {
+ public PutFile setSdlFileName(@NonNull String sdlFileName) {
setParameters(KEY_SDL_FILE_NAME, sdlFileName);
+ return this;
}
/**
@@ -210,12 +211,13 @@ public class PutFile extends RPCRequest { /**
* Sets file type
- *
+ *
* @param fileType
* a FileType value representing a selected file type
*/
- public void setFileType(@NonNull FileType fileType) {
+ public PutFile setFileType(@NonNull FileType fileType) {
setParameters(KEY_FILE_TYPE, fileType);
+ return this;
}
/**
@@ -236,12 +238,13 @@ public class PutFile extends RPCRequest { * system, the app will receive a rejection and have to resend the file. If
* omitted, the value will be set to false
* <p></p>
- *
+ *
* @param persistentFile
* a Boolean value
*/
- public void setPersistentFile(Boolean persistentFile) {
+ public PutFile setPersistentFile( Boolean persistentFile) {
setParameters(KEY_PERSISTENT_FILE, persistentFile);
+ return this;
}
/**
@@ -254,8 +257,9 @@ public class PutFile extends RPCRequest { public Boolean getPersistentFile() {
return getBoolean(KEY_PERSISTENT_FILE);
}
- public void setFileData(byte[] fileData) {
+ public PutFile setFileData( byte[] fileData) {
setBulkData(fileData);
+ return this;
}
public byte[] getFileData() {
return getBulkData();
@@ -265,19 +269,21 @@ public class PutFile extends RPCRequest { * @deprecated as of SmartDeviceLink 4.0
* @param offset Optional offset in bytes for resuming partial data chunks
*/
- public void setOffset(Integer offset) {
- if(offset == null){
+ public PutFile setOffset( Integer offset) {
+ if(offset == null){
setOffset((Long)null);
}else{
setOffset(offset.longValue());
}
+ return this;
}
/**
* @param offset Optional offset in bytes for resuming partial data chunks
*/
- public void setOffset(Long offset) {
+ public PutFile setOffset( Long offset) {
setParameters(KEY_OFFSET, offset);
+ return this;
}
public Long getOffset() {
@@ -300,20 +306,22 @@ public class PutFile extends RPCRequest { * @param length 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
*/
- public void setLength(Integer length) {
- if(length == null){
+ public PutFile setLength( Integer length) {
+ if(length == null){
setLength((Long)null);
}else{
setLength(length.longValue());
}
+ return this;
}
/**
* @param length 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
*/
- public void setLength(Long length) {
+ public PutFile setLength( Long length) {
setParameters(KEY_LENGTH, length);
+ return this;
}
public Long getLength() {
@@ -330,8 +338,9 @@ public class PutFile extends RPCRequest { return null;
}
- public void setSystemFile(Boolean systemFile) {
+ public PutFile setSystemFile( Boolean systemFile) {
setParameters(KEY_SYSTEM_FILE, systemFile);
+ return this;
}
public Boolean getSystemFile() {
@@ -348,15 +357,16 @@ public class PutFile extends RPCRequest { * CRC32 for it.
* @param fileData - the file as a byte array
*/
- public void setCRC(byte[] fileData) {
- if (fileData != null) {
+ public PutFile setCRC( byte[] fileData) {
+ if (fileData != null) {
CRC32 crc = new CRC32();
crc.update(fileData);
parameters.put(KEY_CRC, crc.getValue());
} else {
parameters.remove(KEY_CRC);
}
- }
+ return this;
+ }
/**
* This assumes you have created your own CRC32 and are setting it with the file
@@ -364,13 +374,14 @@ public class PutFile extends RPCRequest { * included in java.util</STRONG>
* @param crc - the CRC32 of the file being set
*/
- public void setCRC(Long crc) {
- if (crc != null) {
+ public PutFile setCRC( Long crc) {
+ if (crc != null) {
parameters.put(KEY_CRC, crc);
} else {
parameters.remove(KEY_CRC);
}
- }
+ return this;
+ }
/**
* This returns the CRC, if it has been set, for the file object
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/PutFileResponse.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/PutFileResponse.java index e1bf71a43..1bc5a6887 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/PutFileResponse.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/PutFileResponse.java @@ -97,8 +97,9 @@ public class PutFileResponse extends RPCResponse { super.format(rpcVersion, formatParams);
}
- public void setSpaceAvailable(Integer spaceAvailable) {
+ public PutFileResponse setSpaceAvailable( Integer spaceAvailable) {
setParameters(KEY_SPACE_AVAILABLE, spaceAvailable);
+ return this;
}
public Integer getSpaceAvailable() {
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/RGBColor.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/RGBColor.java index 0cac1951d..0a22821ac 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/RGBColor.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/RGBColor.java @@ -121,10 +121,11 @@ public class RGBColor extends RPCStruct{ * Sets the red value of the color object * @param color red value - min: 0; max: 255 */ - public void setRed(Integer color) { + public RGBColor setRed( Integer color) { if (color != null && color >= MIN_VALUE && color <= MAX_VALUE) { setValue(KEY_RED, color); } + return this; } /** @@ -139,10 +140,11 @@ public class RGBColor extends RPCStruct{ * Sets the green value of the color object * @param color green value - min: 0; max: 255 */ - public void setGreen(Integer color) { + public RGBColor setGreen( Integer color) { if (color != null && color >= MIN_VALUE && color <= MAX_VALUE) { setValue(KEY_GREEN, color); } + return this; } /** @@ -157,10 +159,11 @@ public class RGBColor extends RPCStruct{ * Sets the blue value of the color object * @param color blue value - min: 0; max: 255 */ - public void setBlue(Integer color) { + public RGBColor setBlue( Integer color) { if (color != null && color >= MIN_VALUE && color <= MAX_VALUE) { setValue(KEY_BLUE, color); } + return this; } /** diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/RadioControlCapabilities.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/RadioControlCapabilities.java index 8ab552526..0b6297b68 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/RadioControlCapabilities.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/RadioControlCapabilities.java @@ -81,8 +81,9 @@ public class RadioControlCapabilities extends RPCStruct{ * The short friendly name of the climate control module. * It should not be used to identify a module by mobile application. */ - public void setModuleName(@NonNull String moduleName) { + public RadioControlCapabilities setModuleName(@NonNull String moduleName) { setValue(KEY_MODULE_NAME, moduleName); + return this; } /** @@ -101,8 +102,9 @@ public class RadioControlCapabilities extends RPCStruct{ * Availability of the control of enable/disable radio. * True: Available, False: Not Available, Not present: Not Available. */ - public void setRadioEnableAvailable(Boolean radioEnableAvailable) { + public RadioControlCapabilities setRadioEnableAvailable( Boolean radioEnableAvailable) { setValue(KEY_RADIO_ENABLE_AVAILABLE, radioEnableAvailable); + return this; } /** @@ -122,8 +124,9 @@ public class RadioControlCapabilities extends RPCStruct{ * Availability of the control of radio band. * True: Available, False: Not Available, Not present: Not Available. */ - public void setRadioBandAvailable(Boolean radioBandAvailable) { + public RadioControlCapabilities setRadioBandAvailable( Boolean radioBandAvailable) { setValue(KEY_RADIO_BAND_AVAILABLE, radioBandAvailable); + return this; } /** @@ -143,8 +146,9 @@ public class RadioControlCapabilities extends RPCStruct{ * Availability of the control of radio frequency. * True: Available, False: Not Available, Not present: Not Available. */ - public void setRadioFrequencyAvailable(Boolean radioFrequencyAvailable) { + public RadioControlCapabilities setRadioFrequencyAvailable( Boolean radioFrequencyAvailable) { setValue(KEY_RADIO_FREQUENCY_AVAILABLE, radioFrequencyAvailable); + return this; } /** @@ -164,8 +168,9 @@ public class RadioControlCapabilities extends RPCStruct{ * Availability of the control of HD radio channel. * True: Available, False: Not Available, Not present: Not Available. */ - public void setHdChannelAvailable(Boolean hdChannelAvailable) { + public RadioControlCapabilities setHdChannelAvailable( Boolean hdChannelAvailable) { setValue(KEY_HD_CHANNEL_AVAILABLE, hdChannelAvailable); + return this; } /** @@ -185,8 +190,9 @@ public class RadioControlCapabilities extends RPCStruct{ * Availability of the getting Radio Data System (RDS) data. * True: Available, False: Not Available, Not present: Not Available. */ - public void setRdsDataAvailable(Boolean rdsDataAvailable) { + public RadioControlCapabilities setRdsDataAvailable( Boolean rdsDataAvailable) { setValue(KEY_RDS_DATA_AVAILABLE, rdsDataAvailable); + return this; } /** @@ -207,8 +213,9 @@ public class RadioControlCapabilities extends RPCStruct{ * True: Available, False: Not Available, Not present: Not Available. */ @Deprecated - public void setAvailableHDsAvailable(Boolean availableHDsAvailable) { + public RadioControlCapabilities setAvailableHDsAvailable( Boolean availableHDsAvailable) { setValue(KEY_AVAILABLE_HDS_AVAILABLE, availableHDsAvailable); + return this; } /** @@ -229,8 +236,9 @@ public class RadioControlCapabilities extends RPCStruct{ * Availability of the list of available HD sub-channel indexes. * True: Available, False: Not Available, Not present: Not Available. */ - public void setAvailableHdChannelsAvailable(Boolean availableHdChannelsAvailable) { + public RadioControlCapabilities setAvailableHdChannelsAvailable( Boolean availableHdChannelsAvailable) { setValue(KEY_AVAILABLE_HD_CHANNELS_AVAILABLE, availableHdChannelsAvailable); + return this; } /** @@ -250,8 +258,9 @@ public class RadioControlCapabilities extends RPCStruct{ * Availability of the getting the Radio state. * True: Available, False: Not Available, Not present: Not Available. */ - public void setStateAvailable(Boolean stateAvailable) { + public RadioControlCapabilities setStateAvailable( Boolean stateAvailable) { setValue(KEY_STATE_AVAILABLE, stateAvailable); + return this; } /** @@ -271,8 +280,9 @@ public class RadioControlCapabilities extends RPCStruct{ * Availability of the getting the signal strength. * True: Available, False: Not Available, Not present: Not Available. */ - public void setSignalStrengthAvailable(Boolean signalStrengthAvailable) { + public RadioControlCapabilities setSignalStrengthAvailable( Boolean signalStrengthAvailable) { setValue(KEY_SIGNAL_STRENGTH_AVAILABLE, signalStrengthAvailable); + return this; } /** @@ -292,8 +302,9 @@ public class RadioControlCapabilities extends RPCStruct{ * Availability of the getting the signal Change Threshold. * True: Available, False: Not Available, Not present: Not Available. */ - public void setSignalChangeThresholdAvailable(Boolean signalChangeThresholdAvailable) { + public RadioControlCapabilities setSignalChangeThresholdAvailable( Boolean signalChangeThresholdAvailable) { setValue(KEY_SIGNAL_CHANGE_THRESHOLD_AVAILABLE, signalChangeThresholdAvailable); + return this; } /** @@ -312,8 +323,9 @@ public class RadioControlCapabilities extends RPCStruct{ * @param hdRadioEnableAvailable Availability of the control of enable/disable HD radio. * True: Available, False: Not Available, Not present: Not Available. */ - public void setHdRadioEnableAvailable(Boolean hdRadioEnableAvailable) { + public RadioControlCapabilities setHdRadioEnableAvailable( Boolean hdRadioEnableAvailable) { setValue(KEY_HD_RADIO_ENABLE_AVAILABLE, hdRadioEnableAvailable); + return this; } /** @@ -332,8 +344,9 @@ public class RadioControlCapabilities extends RPCStruct{ * @param siriusxmRadioAvailable Availability of sirius XM radio. * True: Available, False: Not Available, Not present: Not Available. */ - public void setSiriusXMRadioAvailable(Boolean siriusxmRadioAvailable) { + public RadioControlCapabilities setSiriusXMRadioAvailable( Boolean siriusxmRadioAvailable) { setValue(KEY_SIRIUS_XM_RADIO_AVAILABLE, siriusxmRadioAvailable); + return this; } /** @@ -352,8 +365,9 @@ public class RadioControlCapabilities extends RPCStruct{ * @param sisDataAvailable Availability of the getting HD radio Station Information Service (SIS) data. * True: Available, False: Not Available, Not present: Not Available. */ - public void setSisDataAvailable(Boolean sisDataAvailable) { + public RadioControlCapabilities setSisDataAvailable( Boolean sisDataAvailable) { setValue(KEY_SIS_DATA_AVAILABLE, sisDataAvailable); + return this; } /** @@ -370,8 +384,9 @@ public class RadioControlCapabilities extends RPCStruct{ * Sets ModuleInfo for this capability * @param info the ModuleInfo to be set */ - public void setModuleInfo(ModuleInfo info) { + public RadioControlCapabilities setModuleInfo( ModuleInfo info) { setValue(KEY_MODULE_INFO, info); + return this; } /** diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/RadioControlData.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/RadioControlData.java index 86cd9c962..433d7ad28 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/RadioControlData.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/RadioControlData.java @@ -70,8 +70,9 @@ public class RadioControlData extends RPCStruct{ * @param frequencyInteger * The integer part of the frequency i.e. for 101.7 this value should be 101 */ - public void setFrequencyInteger(Integer frequencyInteger) { + public RadioControlData setFrequencyInteger( Integer frequencyInteger) { setValue(KEY_FREQUENCY_INTEGER, frequencyInteger); + return this; } /** @@ -89,8 +90,9 @@ public class RadioControlData extends RPCStruct{ * @param frequencyFraction * The fractional part of the frequency i.e. for 101.7 is 7. */ - public void setFrequencyFraction(Integer frequencyFraction) { + public RadioControlData setFrequencyFraction( Integer frequencyFraction) { setValue(KEY_FREQUENCY_FRACTION, frequencyFraction); + return this; } /** @@ -108,8 +110,9 @@ public class RadioControlData extends RPCStruct{ * @param band * The radio band (AM|FM|XM) of the radio tuner. */ - public void setBand(RadioBand band) { + public RadioControlData setBand( RadioBand band) { setValue(KEY_BAND, band); + return this; } /** @@ -127,8 +130,9 @@ public class RadioControlData extends RPCStruct{ * @param rdsData * Read only parameter. See RdsData data type for details. */ - public void setRdsData(RdsData rdsData) { + public RadioControlData setRdsData( RdsData rdsData) { setValue(KEY_RDS_DATA, rdsData); + return this; } /** @@ -147,8 +151,9 @@ public class RadioControlData extends RPCStruct{ * Number of HD sub-channels if available. */ @Deprecated - public void setAvailableHDs(Integer availableHDs) { + public RadioControlData setAvailableHDs( Integer availableHDs) { setValue(KEY_AVAILABLE_HDS, availableHDs); + return this; } /** @@ -167,8 +172,9 @@ public class RadioControlData extends RPCStruct{ * @param hdChannel * Current HD sub-channel if available. */ - public void setHdChannel(Integer hdChannel) { + public RadioControlData setHdChannel( Integer hdChannel) { setValue(KEY_HD_CHANNEL, hdChannel); + return this; } /** @@ -186,8 +192,9 @@ public class RadioControlData extends RPCStruct{ * @param signalStrength * Read only parameter. Indicates the strength of receiving radio signal in current frequency. */ - public void setSignalStrength(Integer signalStrength) { + public RadioControlData setSignalStrength( Integer signalStrength) { setValue(KEY_SIGNAL_STRENGTH, signalStrength); + return this; } /** @@ -205,8 +212,9 @@ public class RadioControlData extends RPCStruct{ * @param signalChangeThreshold * If the signal strength falls below the set value for this parameter, the radio will tune to an alternative frequency. */ - public void setSignalChangeThreshold(Integer signalChangeThreshold) { + public RadioControlData setSignalChangeThreshold( Integer signalChangeThreshold) { setValue(KEY_SIGNAL_CHANGE_THRESHOLD, signalChangeThreshold); + return this; } /** @@ -226,8 +234,9 @@ public class RadioControlData extends RPCStruct{ * @param radioEnable * True if the radio is on, false is the radio is off. */ - public void setRadioEnable(Boolean radioEnable) { + public RadioControlData setRadioEnable( Boolean radioEnable) { setValue(KEY_RADIO_ENABLE, radioEnable); + return this; } /** @@ -246,8 +255,9 @@ public class RadioControlData extends RPCStruct{ * @param state * Read only parameter. See RadioState data type for details. */ - public void setState(RadioState state) { + public RadioControlData setState( RadioState state) { setValue(KEY_STATE, state); + return this; } /** @@ -264,8 +274,9 @@ public class RadioControlData extends RPCStruct{ * * @param hdRadioEnable True if the hd radio is on, false if the radio is off. */ - public void setHdRadioEnable(Boolean hdRadioEnable) { + public RadioControlData setHdRadioEnable( Boolean hdRadioEnable) { setValue(KEY_HD_RADIO_ENABLE, hdRadioEnable); + return this; } /** @@ -282,8 +293,9 @@ public class RadioControlData extends RPCStruct{ * * @param sisData Read-only Station Information Service (SIS) data provides basic information about the station such as call sign, as well as information not displayable to the consumer such as the station identification number. */ - public void setSisData(SisData sisData) { + public RadioControlData setSisData( SisData sisData) { setValue(KEY_SIS_DATA, sisData); + return this; } /** @@ -300,8 +312,9 @@ public class RadioControlData extends RPCStruct{ * * @param availableHdChannels List of available hd sub-channel indexes, empty list means no Hd channel is available, read-only. */ - public void setAvailableHdChannels(List<Integer> availableHdChannels){ + public RadioControlData setAvailableHdChannels( List<Integer> availableHdChannels) { setValue(KEY_AVAILABLE_HD_CHANNELS, availableHdChannels); + return this; } /** diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/RdsData.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/RdsData.java index 29326e550..223adebd7 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/RdsData.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/RdsData.java @@ -62,8 +62,9 @@ public class RdsData extends RPCStruct{ * @param programService * Program Service Name. */ - public void setProgramService(String programService) { + public RdsData setProgramService( String programService) { setValue(KEY_PS, programService); + return this; } /** @@ -81,8 +82,9 @@ public class RdsData extends RPCStruct{ * @param radioText * Radio Text. */ - public void setRadioText(String radioText) { + public RdsData setRadioText( String radioText) { setValue(KEY_RT, radioText); + return this; } /** @@ -100,8 +102,9 @@ public class RdsData extends RPCStruct{ * @param clockText * The clock text in UTC format as YYYY-MM-DDThh:mm:ss.sTZD. */ - public void setClockText(String clockText) { + public RdsData setClockText( String clockText) { setValue(KEY_CT, clockText); + return this; } /** @@ -119,8 +122,9 @@ public class RdsData extends RPCStruct{ * @param programIdentification * Program Identification - the call sign for the radio station. */ - public void setProgramIdentification(String programIdentification) { + public RdsData setProgramIdentification( String programIdentification) { setValue(KEY_PI, programIdentification); + return this; } /** @@ -138,8 +142,9 @@ public class RdsData extends RPCStruct{ * @param region * Region. */ - public void setRegion(String region) { + public RdsData setRegion( String region) { setValue(KEY_REG, region); + return this; } /** @@ -157,8 +162,9 @@ public class RdsData extends RPCStruct{ * @param trafficProgram * Traffic Program Identification - Identifies a station that offers traffic. */ - public void setTrafficProgram(Boolean trafficProgram) { + public RdsData setTrafficProgram( Boolean trafficProgram) { setValue(KEY_TP, trafficProgram); + return this; } /** @@ -176,8 +182,9 @@ public class RdsData extends RPCStruct{ * @param trafficAnnouncement * Traffic Announcement Identification - Indicates an ongoing traffic announcement. */ - public void setTrafficAnnouncement(Boolean trafficAnnouncement) { + public RdsData setTrafficAnnouncement( Boolean trafficAnnouncement) { setValue(KEY_TA, trafficAnnouncement); + return this; } /** @@ -195,8 +202,9 @@ public class RdsData extends RPCStruct{ * @param programType * The program type - The region should be used to differentiate between EU and North America program types. */ - public void setProgramType(Integer programType) { + public RdsData setProgramType( Integer programType) { setValue(KEY_PTY, programType); + return this; } /** diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/ReadDID.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/ReadDID.java index 553922e0f..b72524eeb 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/ReadDID.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/ReadDID.java @@ -1,34 +1,34 @@ -/* - * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this - * list of conditions and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following - * disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its - * contributors may be used to endorse or promote products derived from this - * software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ +/*
+ * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
package com.smartdevicelink.proxy.rpc;
import androidx.annotation.NonNull;
@@ -139,14 +139,15 @@ public class ReadDID extends RPCRequest { /**
* Sets an ID of the vehicle module
- *
+ *
* @param ecuName
* an Integer value representing the ID of the vehicle module
* <p></p>
* <b>Notes: </b>Minvalue:0; Maxvalue:65535
*/
- public void setEcuName(@NonNull Integer ecuName) {
- setParameters(KEY_ECU_NAME, ecuName);
+ public ReadDID setEcuName(@NonNull Integer ecuName) {
+ setParameters(KEY_ECU_NAME, ecuName);
+ return this;
}
/**
@@ -161,7 +162,7 @@ public class ReadDID extends RPCRequest { /**
* Sets raw data from vehicle data DID location(s)
- *
+ *
* @param didLocation
* a List<Integer> value representing raw data from vehicle
* data DID location(s)
@@ -172,8 +173,9 @@ public class ReadDID extends RPCRequest { * <li>ArrayMin:0; ArrayMax:1000</li>
* </ul>
*/
- public void setDidLocation(@NonNull List<Integer> didLocation) {
- setParameters(KEY_DID_LOCATION, didLocation);
+ public ReadDID setDidLocation(@NonNull List<Integer> didLocation) {
+ setParameters(KEY_DID_LOCATION, didLocation);
+ return this;
}
/**
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/ReadDIDResponse.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/ReadDIDResponse.java index 41694c446..61158da36 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/ReadDIDResponse.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/ReadDIDResponse.java @@ -1,34 +1,34 @@ -/* - * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this - * list of conditions and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following - * disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its - * contributors may be used to endorse or promote products derived from this - * software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ +/*
+ * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
package com.smartdevicelink.proxy.rpc;
import androidx.annotation.NonNull;
@@ -64,8 +64,9 @@ public class ReadDIDResponse extends RPCResponse { setSuccess(success);
setResultCode(resultCode);
}
- public void setDidResult(List<DIDResult> didResult) {
- setParameters(KEY_DID_RESULT, didResult);
+ public ReadDIDResponse setDidResult( List<DIDResult> didResult) {
+ setParameters(KEY_DID_RESULT, didResult);
+ return this;
}
@SuppressWarnings("unchecked")
public List<DIDResult> getDidResult() {
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/Rectangle.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/Rectangle.java index fc7f16c26..69f6c26ef 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/Rectangle.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/Rectangle.java @@ -64,9 +64,10 @@ public class Rectangle extends RPCStruct { /** * Set the X-coordinate pixel in of the user control that starts in the upper left corner */ - public void setX(@NonNull Float x) { - setValue(KEY_X, x); - } + public Rectangle setX(@NonNull Float x) { + setValue(KEY_X, x); + return this; + } /** * @return the X-coordinate pixel of the user control that starts in the upper left corner @@ -78,9 +79,10 @@ public class Rectangle extends RPCStruct { /** * Set the Y-coordinate pixel of the user control that starts in the upper left corner */ - public void setY(@NonNull Float y) { - setValue(KEY_Y, y); - } + public Rectangle setY(@NonNull Float y) { + setValue(KEY_Y, y); + return this; + } /** * @return the Y-coordinate pixel of the user control that starts in the upper left corner @@ -92,9 +94,10 @@ public class Rectangle extends RPCStruct { /** * Set the width in pixels of the user control's bounding rectangle in pixels */ - public void setWidth(@NonNull Float width) { - setValue(KEY_WIDTH, width); - } + public Rectangle setWidth(@NonNull Float width) { + setValue(KEY_WIDTH, width); + return this; + } /** * @return the width in pixels of the user control's bounding rectangle in pixels @@ -106,9 +109,10 @@ public class Rectangle extends RPCStruct { /** * The height in pixels of the user control's bounding rectangle */ - public void setHeight(@NonNull Float height) { - setValue(KEY_HEIGHT, height); - } + public Rectangle setHeight(@NonNull Float height) { + setValue(KEY_HEIGHT, height); + return this; + } /** * @return the width in pixels of the user control's bounding rectangle in pixels diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/RegisterAppInterface.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/RegisterAppInterface.java index ee741f7c1..ae4c0e874 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/RegisterAppInterface.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/RegisterAppInterface.java @@ -1,34 +1,34 @@ -/* - * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this - * list of conditions and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following - * disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its - * contributors may be used to endorse or promote products derived from this - * software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ +/*
+ * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
package com.smartdevicelink.proxy.rpc;
import androidx.annotation.NonNull;
@@ -358,7 +358,7 @@ public class RegisterAppInterface extends RPCRequest { }
/**
* Sets the version of the SDL® SmartDeviceLink interface
- *
+ *
* @param sdlMsgVersion
* a SdlMsgVersion object representing version of the SDL®
* SmartDeviceLink interface
@@ -375,9 +375,10 @@ public class RegisterAppInterface extends RPCRequest { * number sent from the app to SDL® (in RegisterAppInterface
* request) is ignored by SDL®
*
- */
- public void setSdlMsgVersion(@NonNull SdlMsgVersion sdlMsgVersion) {
+ */
+ public RegisterAppInterface setSdlMsgVersion(@NonNull SdlMsgVersion sdlMsgVersion) {
setParameters(KEY_SDL_MSG_VERSION, sdlMsgVersion);
+ return this;
}
@SuppressWarnings("unchecked")
@@ -385,9 +386,10 @@ public class RegisterAppInterface extends RPCRequest { return (DeviceInfo) getObject(DeviceInfo.class, KEY_DEVICE_INFO);
}
- public void setDeviceInfo(DeviceInfo deviceInfo) {
- setParameters(KEY_DEVICE_INFO, deviceInfo);
- }
+ public RegisterAppInterface setDeviceInfo( DeviceInfo deviceInfo) {
+ setParameters(KEY_DEVICE_INFO, deviceInfo);
+ return this;
+ }
/**
* Gets Mobile Application's Name
*
@@ -400,7 +402,7 @@ public class RegisterAppInterface extends RPCRequest { * Sets Mobile Application's Name, This name is displayed in the SDL®
* Mobile Applications menu. It also serves as the unique identifier of the
* application for SmartDeviceLink
- *
+ *
* @param appName
* a String value representing the Mobile Application's Name
* <p></p>
@@ -411,9 +413,10 @@ public class RegisterAppInterface extends RPCRequest { * the name or any synonym of any currently-registered
* application</li>
* </ul>
- */
- public void setAppName(@NonNull String appName) {
- setParameters(KEY_APP_NAME, appName);
+ */
+ public RegisterAppInterface setAppName(@NonNull String appName) {
+ setParameters(KEY_APP_NAME, appName);
+ return this;
}
/**
@@ -428,7 +431,7 @@ public class RegisterAppInterface extends RPCRequest { }
/**
- *
+ *
* @param ttsName
* a List<TTSChunk> value represeting the TTS Name
* <p></p>
@@ -445,8 +448,9 @@ public class RegisterAppInterface extends RPCRequest { * </ul>
* @since SmartDeviceLink 2.0
*/
- public void setTtsName(List<TTSChunk> ttsName) {
- setParameters(KEY_TTS_NAME, ttsName);
+ public RegisterAppInterface setTtsName( List<TTSChunk> ttsName) {
+ setParameters(KEY_TTS_NAME, ttsName);
+ return this;
}
/**
* Gets a String representing an abbreviated version of the mobile
@@ -463,7 +467,7 @@ public class RegisterAppInterface extends RPCRequest { * Sets a String representing an abbreviated version of the mobile
* applincation's name (if necessary) that will be displayed on the NGN
* media screen
- *
+ *
* @param ngnMediaScreenAppName
* a String value representing an abbreviated version of the
* mobile applincation's name
@@ -474,9 +478,10 @@ public class RegisterAppInterface extends RPCRequest { * <li>If not provided, value will be derived from appName
* truncated to 5 characters</li>
* </ul>
- */
- public void setNgnMediaScreenAppName(String ngnMediaScreenAppName) {
- setParameters(KEY_NGN_MEDIA_SCREEN_APP_NAME, ngnMediaScreenAppName);
+ */
+ public RegisterAppInterface setNgnMediaScreenAppName( String ngnMediaScreenAppName) {
+ setParameters(KEY_NGN_MEDIA_SCREEN_APP_NAME, ngnMediaScreenAppName);
+ return this;
}
/**
* Gets the List<String> representing the an array of 1-100 elements, each
@@ -493,7 +498,7 @@ public class RegisterAppInterface extends RPCRequest { /**
* Sets a vrSynonyms representing the an array of 1-100 elements, each
* element containing a voice-recognition synonym
- *
+ *
* @param vrSynonyms
* a List<String> value representing the an array of 1-100
* elements
@@ -506,9 +511,10 @@ public class RegisterAppInterface extends RPCRequest { * the name or any synonym of any currently-registered
* application</li>
* </ul>
- */
- public void setVrSynonyms(List<String> vrSynonyms) {
- setParameters(KEY_VR_SYNONYMS, vrSynonyms);
+ */
+ public RegisterAppInterface setVrSynonyms( List<String> vrSynonyms) {
+ setParameters(KEY_VR_SYNONYMS, vrSynonyms);
+ return this;
}
/**
* Gets a Boolean representing MediaApplication
@@ -522,12 +528,13 @@ public class RegisterAppInterface extends RPCRequest { /**
* Sets a Boolean to indicate a mobile application that is a media
* application or not
- *
+ *
* @param isMediaApplication
* a Boolean value
- */
- public void setIsMediaApplication(@NonNull Boolean isMediaApplication) {
- setParameters(KEY_IS_MEDIA_APPLICATION, isMediaApplication);
+ */
+ public RegisterAppInterface setIsMediaApplication(@NonNull Boolean isMediaApplication) {
+ setParameters(KEY_IS_MEDIA_APPLICATION, isMediaApplication);
+ return this;
}
/**
* Gets a Language enumeration indicating what language the application
@@ -541,14 +548,15 @@ public class RegisterAppInterface extends RPCRequest { /**
* Sets an enumeration indicating what language the application intends to
* use for user interaction (Display, TTS and VR)
- *
+ *
* @param languageDesired
* a Language Enumeration
- *
- *
- */
- public void setLanguageDesired(@NonNull Language languageDesired) {
- setParameters(KEY_LANGUAGE_DESIRED, languageDesired);
+ *
+ *
+ */
+ public RegisterAppInterface setLanguageDesired(@NonNull Language languageDesired) {
+ setParameters(KEY_LANGUAGE_DESIRED, languageDesired);
+ return this;
}
/**
@@ -567,12 +575,13 @@ public class RegisterAppInterface extends RPCRequest { /**
* Sets an enumeration indicating what language the application intends to
* use for user interaction ( Display)
- *
+ *
* @param hmiDisplayLanguageDesired the requested language to be used on the HMI/Display
* @since SmartDeviceLink 2.0
*/
- public void setHmiDisplayLanguageDesired(@NonNull Language hmiDisplayLanguageDesired) {
- setParameters(KEY_HMI_DISPLAY_LANGUAGE_DESIRED, hmiDisplayLanguageDesired);
+ public RegisterAppInterface setHmiDisplayLanguageDesired(@NonNull Language hmiDisplayLanguageDesired) {
+ setParameters(KEY_HMI_DISPLAY_LANGUAGE_DESIRED, hmiDisplayLanguageDesired);
+ return this;
}
/**
@@ -594,7 +603,7 @@ public class RegisterAppInterface extends RPCRequest { * Sets a a list of all applicable app types stating which classifications
* to be given to the app. e.g. for platforms , like GEN2, this will
* determine which "corner(s)" the app can populate
- *
+ *
* @param appHMIType
* a List<AppHMIType>
* <p></p>
@@ -605,16 +614,18 @@ public class RegisterAppInterface extends RPCRequest { * </ul>
* @since SmartDeviceLink 2.0
*/
- public void setAppHMIType(List<AppHMIType> appHMIType) {
- setParameters(KEY_APP_HMI_TYPE, appHMIType);
+ public RegisterAppInterface setAppHMIType( List<AppHMIType> appHMIType) {
+ setParameters(KEY_APP_HMI_TYPE, appHMIType);
+ return this;
}
public String getHashID() {
return getString(KEY_HASH_ID);
}
- public void setHashID(String hashID) {
- setParameters(KEY_HASH_ID, hashID);
+ public RegisterAppInterface setHashID( String hashID) {
+ setParameters(KEY_HASH_ID, hashID);
+ return this;
}
/**
@@ -629,9 +640,10 @@ public class RegisterAppInterface extends RPCRequest { * Sets detailed information about the registered application
* @param appInfo - detailed information about the registered application
*/
- public void setAppInfo(AppInfo appInfo) {
- setParameters(KEY_APP_INFO, appInfo);
- }
+ public RegisterAppInterface setAppInfo( AppInfo appInfo) {
+ setParameters(KEY_APP_INFO, appInfo);
+ return this;
+ }
/**
* Gets the unique ID, which an app will be given when approved
@@ -654,13 +666,14 @@ public class RegisterAppInterface extends RPCRequest { * <b>Notes: </b>Maxlength = 100
* @since SmartDeviceLink 2.0
*/
- public void setAppID(@NonNull String appID) {
- if (appID != null) {
+ public RegisterAppInterface setAppID(@NonNull String appID) {
+ if (appID != null) {
setParameters(KEY_APP_ID, appID.toLowerCase());
} else {
setParameters(KEY_APP_ID, appID);
}
- }
+ return this;
+ }
/**
* Gets the unique ID, which an app will be given when approved
@@ -683,8 +696,8 @@ public class RegisterAppInterface extends RPCRequest { * <b>Notes: </b>Maxlength = 100
* @since SmartDeviceLink 5.0
*/
- public void setFullAppID(String fullAppID) {
- if (fullAppID != null) {
+ public RegisterAppInterface setFullAppID( String fullAppID) {
+ if (fullAppID != null) {
fullAppID = fullAppID.toLowerCase();
setParameters(KEY_FULL_APP_ID, fullAppID);
String appID;
@@ -697,7 +710,8 @@ public class RegisterAppInterface extends RPCRequest { } else {
setParameters(KEY_FULL_APP_ID, null);
}
- }
+ return this;
+ }
@Override
public void format(Version rpcVersion, boolean formatParams) {
@@ -727,9 +741,10 @@ public class RegisterAppInterface extends RPCRequest { * used for day color scheme
* @since SmartDeviceLink 5.0
*/
- public void setDayColorScheme(TemplateColorScheme templateColorScheme){
- setParameters(KEY_DAY_COLOR_SCHEME, templateColorScheme);
- }
+ public RegisterAppInterface setDayColorScheme( TemplateColorScheme templateColorScheme) {
+ setParameters(KEY_DAY_COLOR_SCHEME, templateColorScheme);
+ return this;
+ }
/**
* Gets the color scheme that is currently used for night
@@ -749,7 +764,8 @@ public class RegisterAppInterface extends RPCRequest { * used for night color scheme
* @since SmartDeviceLink 5.0
*/
- public void setNightColorScheme(TemplateColorScheme templateColorScheme){
- setParameters(KEY_NIGHT_COLOR_SCHEME, templateColorScheme);
- }
+ public RegisterAppInterface setNightColorScheme( TemplateColorScheme templateColorScheme) {
+ setParameters(KEY_NIGHT_COLOR_SCHEME, templateColorScheme);
+ return this;
+ }
}
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/RegisterAppInterfaceResponse.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/RegisterAppInterfaceResponse.java index 449056871..967737c85 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/RegisterAppInterfaceResponse.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/RegisterAppInterfaceResponse.java @@ -143,7 +143,7 @@ public class RegisterAppInterfaceResponse extends RPCResponse { /**
* Sets the version of the SDL® SmartDeviceLink interface
- *
+ *
* @param sdlMsgVersion
* a SdlMsgVersion object representing version of the SDL®
* SmartDeviceLink interface
@@ -160,8 +160,9 @@ public class RegisterAppInterfaceResponse extends RPCResponse { * number sent from the app to SDL® (in RegisterAppInterface
* request) is ignored by SDL®
*/
- public void setSdlMsgVersion(SdlMsgVersion sdlMsgVersion) {
- setParameters(KEY_SDL_MSG_VERSION, sdlMsgVersion);
+ public RegisterAppInterfaceResponse setSdlMsgVersion( SdlMsgVersion sdlMsgVersion) {
+ setParameters(KEY_SDL_MSG_VERSION, sdlMsgVersion);
+ return this;
}
/**
@@ -177,14 +178,15 @@ public class RegisterAppInterfaceResponse extends RPCResponse { /**
* Sets an enumeration indicating what language the application intends to
* use for user interaction (Display, TTS and VR)
- *
+ *
* @param language
* a Language Enumeration
- *
- *
+ *
+ *
*/
- public void setLanguage(Language language) {
- setParameters(KEY_LANGUAGE, language);
+ public RegisterAppInterfaceResponse setLanguage( Language language) {
+ setParameters(KEY_LANGUAGE, language);
+ return this;
}
/**
@@ -203,12 +205,13 @@ public class RegisterAppInterfaceResponse extends RPCResponse { /**
* Sets an enumeration indicating what language the application intends to
* use for user interaction ( Display)
- *
+ *
* @param hmiDisplayLanguage
* @since SmartDeviceLink 2.0
*/
- public void setHmiDisplayLanguage(Language hmiDisplayLanguage) {
- setParameters(KEY_HMI_DISPLAY_LANGUAGE, hmiDisplayLanguage);
+ public RegisterAppInterfaceResponse setHmiDisplayLanguage( Language hmiDisplayLanguage) {
+ setParameters(KEY_HMI_DISPLAY_LANGUAGE, hmiDisplayLanguage);
+ return this;
}
/**
@@ -226,8 +229,9 @@ public class RegisterAppInterfaceResponse extends RPCResponse { * @param displayCapabilities
*/
@Deprecated
- public void setDisplayCapabilities(DisplayCapabilities displayCapabilities) {
- setParameters(KEY_DISPLAY_CAPABILITIES, displayCapabilities);
+ public RegisterAppInterfaceResponse setDisplayCapabilities( DisplayCapabilities displayCapabilities) {
+ setParameters(KEY_DISPLAY_CAPABILITIES, displayCapabilities);
+ return this;
}
/**
@@ -245,8 +249,9 @@ public class RegisterAppInterfaceResponse extends RPCResponse { * @param buttonCapabilities
*/
@Deprecated
- public void setButtonCapabilities(List<ButtonCapabilities> buttonCapabilities) {
- setParameters(KEY_BUTTON_CAPABILITIES, buttonCapabilities);
+ public RegisterAppInterfaceResponse setButtonCapabilities( List<ButtonCapabilities> buttonCapabilities) {
+ setParameters(KEY_BUTTON_CAPABILITIES, buttonCapabilities);
+ return this;
}
/**
* Gets getSoftButtonCapabilities set when application interface is registered.
@@ -263,8 +268,9 @@ public class RegisterAppInterfaceResponse extends RPCResponse { * @param softButtonCapabilities
*/
@Deprecated
- public void setSoftButtonCapabilities(List<SoftButtonCapabilities> softButtonCapabilities) {
- setParameters(KEY_SOFT_BUTTON_CAPABILITIES, softButtonCapabilities);
+ public RegisterAppInterfaceResponse setSoftButtonCapabilities( List<SoftButtonCapabilities> softButtonCapabilities) {
+ setParameters(KEY_SOFT_BUTTON_CAPABILITIES, softButtonCapabilities);
+ return this;
}
/**
@@ -282,8 +288,9 @@ public class RegisterAppInterfaceResponse extends RPCResponse { * @param presetBankCapabilities
*/
@Deprecated
- public void setPresetBankCapabilities(PresetBankCapabilities presetBankCapabilities) {
- setParameters(KEY_PRESET_BANK_CAPABILITIES, presetBankCapabilities);
+ public RegisterAppInterfaceResponse setPresetBankCapabilities( PresetBankCapabilities presetBankCapabilities) {
+ setParameters(KEY_PRESET_BANK_CAPABILITIES, presetBankCapabilities);
+ return this;
}
/**
@@ -299,8 +306,9 @@ public class RegisterAppInterfaceResponse extends RPCResponse { * Sets hmiZoneCapabilities
* @param hmiZoneCapabilities
*/
- public void setHmiZoneCapabilities(List<HmiZoneCapabilities> hmiZoneCapabilities) {
- setParameters(KEY_HMI_ZONE_CAPABILITIES, hmiZoneCapabilities);
+ public RegisterAppInterfaceResponse setHmiZoneCapabilities( List<HmiZoneCapabilities> hmiZoneCapabilities) {
+ setParameters(KEY_HMI_ZONE_CAPABILITIES, hmiZoneCapabilities);
+ return this;
}
/**
@@ -325,8 +333,9 @@ public class RegisterAppInterfaceResponse extends RPCResponse { * Sets speechCapabilities
* @param speechCapabilities
*/
- public void setSpeechCapabilities(List<SpeechCapabilities> speechCapabilities) {
- setParameters(KEY_SPEECH_CAPABILITIES, speechCapabilities);
+ public RegisterAppInterfaceResponse setSpeechCapabilities( List<SpeechCapabilities> speechCapabilities) {
+ setParameters(KEY_SPEECH_CAPABILITIES, speechCapabilities);
+ return this;
}
@@ -335,8 +344,9 @@ public class RegisterAppInterfaceResponse extends RPCResponse { return (List<PrerecordedSpeech>) getObject(PrerecordedSpeech.class, KEY_PRERECORDED_SPEECH);
}
- public void setPrerecordedSpeech(List<PrerecordedSpeech> prerecordedSpeech) {
- setParameters(KEY_PRERECORDED_SPEECH, prerecordedSpeech);
+ public RegisterAppInterfaceResponse setPrerecordedSpeech( List<PrerecordedSpeech> prerecordedSpeech) {
+ setParameters(KEY_PRERECORDED_SPEECH, prerecordedSpeech);
+ return this;
}
@@ -353,8 +363,9 @@ public class RegisterAppInterfaceResponse extends RPCResponse { * Sets VrCapabilities
* @param vrCapabilities
*/
- public void setVrCapabilities(List<VrCapabilities> vrCapabilities) {
- setParameters(KEY_VR_CAPABILITIES, vrCapabilities);
+ public RegisterAppInterfaceResponse setVrCapabilities( List<VrCapabilities> vrCapabilities) {
+ setParameters(KEY_VR_CAPABILITIES, vrCapabilities);
+ return this;
}
/**
@@ -370,8 +381,9 @@ public class RegisterAppInterfaceResponse extends RPCResponse { * Sets vehicleType
* @param vehicleType
*/
- public void setVehicleType(VehicleType vehicleType) {
- setParameters(KEY_VEHICLE_TYPE, vehicleType);
+ public RegisterAppInterfaceResponse setVehicleType( VehicleType vehicleType) {
+ setParameters(KEY_VEHICLE_TYPE, vehicleType);
+ return this;
}
/**
@@ -387,8 +399,9 @@ public class RegisterAppInterfaceResponse extends RPCResponse { * Sets AudioPassThruCapabilities
* @param audioPassThruCapabilities
*/
- public void setAudioPassThruCapabilities(List<AudioPassThruCapabilities> audioPassThruCapabilities) {
- setParameters(KEY_AUDIO_PASS_THRU_CAPABILITIES, audioPassThruCapabilities);
+ public RegisterAppInterfaceResponse setAudioPassThruCapabilities( List<AudioPassThruCapabilities> audioPassThruCapabilities) {
+ setParameters(KEY_AUDIO_PASS_THRU_CAPABILITIES, audioPassThruCapabilities);
+ return this;
}
/**
@@ -404,12 +417,14 @@ public class RegisterAppInterfaceResponse extends RPCResponse { * Sets pcmStreamingCapabilities
* @param pcmStreamingCapabilities
*/
- public void setPcmStreamingCapabilities(AudioPassThruCapabilities pcmStreamingCapabilities) {
- setParameters(KEY_PCM_STREAM_CAPABILITIES, pcmStreamingCapabilities);
- }
+ public RegisterAppInterfaceResponse setPcmStreamingCapabilities( AudioPassThruCapabilities pcmStreamingCapabilities) {
+ setParameters(KEY_PCM_STREAM_CAPABILITIES, pcmStreamingCapabilities);
+ return this;
+ }
- public void setSupportedDiagModes(List<Integer> supportedDiagModes) {
- setParameters(KEY_SUPPORTED_DIAG_MODES, supportedDiagModes);
+ public RegisterAppInterfaceResponse setSupportedDiagModes( List<Integer> supportedDiagModes) {
+ setParameters(KEY_SUPPORTED_DIAG_MODES, supportedDiagModes);
+ return this;
}
@SuppressWarnings("unchecked")
@@ -417,8 +432,9 @@ public class RegisterAppInterfaceResponse extends RPCResponse { return (List<Integer>) getObject(Integer.class, KEY_SUPPORTED_DIAG_MODES);
}
- public void setHmiCapabilities(HMICapabilities hmiCapabilities) {
- setParameters(KEY_HMI_CAPABILITIES, hmiCapabilities);
+ public RegisterAppInterfaceResponse setHmiCapabilities( HMICapabilities hmiCapabilities) {
+ setParameters(KEY_HMI_CAPABILITIES, hmiCapabilities);
+ return this;
}
@SuppressWarnings("unchecked")
@@ -426,16 +442,18 @@ public class RegisterAppInterfaceResponse extends RPCResponse { return (HMICapabilities) getObject(HMICapabilities.class, KEY_HMI_CAPABILITIES);
}
- public void setSdlVersion(String sdlVersion) {
- setParameters(KEY_SDL_VERSION, sdlVersion);
+ public RegisterAppInterfaceResponse setSdlVersion( String sdlVersion) {
+ setParameters(KEY_SDL_VERSION, sdlVersion);
+ return this;
}
public String getSdlVersion() {
return getString(KEY_SDL_VERSION);
}
- public void setSystemSoftwareVersion(String systemSoftwareVersion) {
- setParameters(KEY_SYSTEM_SOFTWARE_VERSION, systemSoftwareVersion);
+ public RegisterAppInterfaceResponse setSystemSoftwareVersion( String systemSoftwareVersion) {
+ setParameters(KEY_SYSTEM_SOFTWARE_VERSION, systemSoftwareVersion);
+ return this;
}
public String getSystemSoftwareVersion() {
@@ -446,11 +464,12 @@ public class RegisterAppInterfaceResponse extends RPCResponse { * Sets Icon Resumed Boolean
* @param iconResumed - if param not included, set to false
*/
- public void setIconResumed(Boolean iconResumed){
+ public RegisterAppInterfaceResponse setIconResumed(Boolean iconResumed){
if(iconResumed == null){
iconResumed = false;
}
setParameters(KEY_ICON_RESUMED, iconResumed);
+ return this;
}
/**
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/ReleaseInteriorVehicleDataModule.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/ReleaseInteriorVehicleDataModule.java index 807e239da..0c52a9e0a 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/ReleaseInteriorVehicleDataModule.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/ReleaseInteriorVehicleDataModule.java @@ -32,8 +32,9 @@ public class ReleaseInteriorVehicleDataModule extends RPCRequest { * Sets the Module Type for this class * @param type the Module Type to be set */ - public void setModuleType(@NonNull ModuleType type) { + public ReleaseInteriorVehicleDataModule setModuleType(@NonNull ModuleType type) { setParameters(KEY_MODULE_TYPE, type); + return this; } /** @@ -48,8 +49,9 @@ public class ReleaseInteriorVehicleDataModule extends RPCRequest { * Sets the Module Ids for this class * @param id the ids to be set */ - public void setModuleId(String id) { + public ReleaseInteriorVehicleDataModule setModuleId( String id) { setParameters(KEY_MODULE_ID, id); + return this; } /** diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/RemoteControlCapabilities.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/RemoteControlCapabilities.java index 5703f1cc2..31fd12534 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/RemoteControlCapabilities.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/RemoteControlCapabilities.java @@ -58,9 +58,10 @@ public class RemoteControlCapabilities extends RPCStruct { * @param climateControlCapabilities If included, the platform supports RC climate controls. * For this baseline version, maxsize=1. i.e. only one climate control module is supported. */ - public void setClimateControlCapabilities(List<ClimateControlCapabilities> climateControlCapabilities) { - setValue(KEY_CLIMATE_CONTROL_CAPABILITIES, climateControlCapabilities); - } + public RemoteControlCapabilities setClimateControlCapabilities( List<ClimateControlCapabilities> climateControlCapabilities) { + setValue(KEY_CLIMATE_CONTROL_CAPABILITIES, climateControlCapabilities); + return this; + } /** * Gets the climateControlCapabilities portion of the RemoteControlCapabilities class @@ -79,9 +80,10 @@ public class RemoteControlCapabilities extends RPCStruct { * @param radioControlCapabilities If included, the platform supports RC climate controls. * For this baseline version, maxsize=1. i.e. only one radio control module is supported. */ - public void setRadioControlCapabilities(List<RadioControlCapabilities> radioControlCapabilities) { - setValue(KEY_RADIO_CONTROL_CAPABILITIES, radioControlCapabilities); - } + public RemoteControlCapabilities setRadioControlCapabilities( List<RadioControlCapabilities> radioControlCapabilities) { + setValue(KEY_RADIO_CONTROL_CAPABILITIES, radioControlCapabilities); + return this; + } /** * Gets the radioControlCapabilities portion of the RemoteControlCapabilities class @@ -99,9 +101,10 @@ public class RemoteControlCapabilities extends RPCStruct { * * @param buttonCapabilities If included, the platform supports RC button controls with the included button names. */ - public void setButtonCapabilities(List<ButtonCapabilities> buttonCapabilities) { - setValue(KEY_BUTTON_CAPABILITIES, buttonCapabilities); - } + public RemoteControlCapabilities setButtonCapabilities( List<ButtonCapabilities> buttonCapabilities) { + setValue(KEY_BUTTON_CAPABILITIES, buttonCapabilities); + return this; + } /** * Gets the buttonCapabilities portion of the RemoteControlCapabilities class @@ -118,9 +121,10 @@ public class RemoteControlCapabilities extends RPCStruct { * * @param seatControlCapabilities If included, the platform supports seat controls. */ - public void setSeatControlCapabilities(List<SeatControlCapabilities> seatControlCapabilities) { - setValue(KEY_SEAT_CONTROL_CAPABILITIES, seatControlCapabilities); - } + public RemoteControlCapabilities setSeatControlCapabilities( List<SeatControlCapabilities> seatControlCapabilities) { + setValue(KEY_SEAT_CONTROL_CAPABILITIES, seatControlCapabilities); + return this; + } /** * Gets the seatControlCapabilities portion of the RemoteControlCapabilities class @@ -137,9 +141,10 @@ public class RemoteControlCapabilities extends RPCStruct { * * @param audioControlCapabilities If included, the platform supports audio controls. */ - public void setAudioControlCapabilities(List<AudioControlCapabilities> audioControlCapabilities) { - setValue(KEY_AUDIO_CONTROL_CAPABILITIES, audioControlCapabilities); - } + public RemoteControlCapabilities setAudioControlCapabilities( List<AudioControlCapabilities> audioControlCapabilities) { + setValue(KEY_AUDIO_CONTROL_CAPABILITIES, audioControlCapabilities); + return this; + } /** * Gets the audioControlCapabilities portion of the RemoteControlCapabilities class @@ -156,9 +161,10 @@ public class RemoteControlCapabilities extends RPCStruct { * * @param hmiSettingsControlCapabilities If included, the platform supports hmi setting controls. */ - public void setHmiSettingsControlCapabilities(HMISettingsControlCapabilities hmiSettingsControlCapabilities) { - setValue(KEY_HMI_SETTINGS_CONTROL_CAPABILITIES, hmiSettingsControlCapabilities); - } + public RemoteControlCapabilities setHmiSettingsControlCapabilities( HMISettingsControlCapabilities hmiSettingsControlCapabilities) { + setValue(KEY_HMI_SETTINGS_CONTROL_CAPABILITIES, hmiSettingsControlCapabilities); + return this; + } /** * Gets the hmiSettingsControlCapabilities portion of the RemoteControlCapabilities class @@ -174,9 +180,10 @@ public class RemoteControlCapabilities extends RPCStruct { * * @param lightControlCapabilities If included, the platform supports light controls. */ - public void setLightControlCapabilities(LightControlCapabilities lightControlCapabilities) { - setValue(KEY_LIGHT_CONTROL_CAPABILITIES, lightControlCapabilities); - } + public RemoteControlCapabilities setLightControlCapabilities( LightControlCapabilities lightControlCapabilities) { + setValue(KEY_LIGHT_CONTROL_CAPABILITIES, lightControlCapabilities); + return this; + } /** * Gets the lightControlCapabilities portion of the RemoteControlCapabilities class diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/ResetGlobalProperties.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/ResetGlobalProperties.java index a88ca2950..1bd508186 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/ResetGlobalProperties.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/ResetGlobalProperties.java @@ -1,34 +1,34 @@ -/* - * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this - * list of conditions and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following - * disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its - * contributors may be used to endorse or promote products derived from this - * software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ +/*
+ * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
package com.smartdevicelink.proxy.rpc;
import androidx.annotation.NonNull;
@@ -132,15 +132,16 @@ public class ResetGlobalProperties extends RPCRequest { /**
* Sets an array of one or more GlobalProperty enumeration elements
* indicating which global properties to reset to their default value
- *
+ *
* @param properties
* a List<GlobalProperty> An array of one or more
* GlobalProperty enumeration elements indicating which global
* properties to reset to their default value
* <p></p>
* <b>Notes: </b>Array must have at least one element
- */
- public void setProperties(@NonNull List<GlobalProperty> properties ) {
- setParameters(KEY_PROPERTIES, properties);
+ */
+ public ResetGlobalProperties setProperties(@NonNull List<GlobalProperty> properties) {
+ setParameters(KEY_PROPERTIES, properties);
+ return this;
}
}
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/ScreenParams.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/ScreenParams.java index a5b9e1525..fd644cb40 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/ScreenParams.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/ScreenParams.java @@ -1,34 +1,34 @@ -/* - * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this - * list of conditions and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following - * disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its - * contributors may be used to endorse or promote products derived from this - * software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ +/*
+ * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
package com.smartdevicelink.proxy.rpc;
import androidx.annotation.NonNull;
@@ -105,14 +105,16 @@ public class ScreenParams extends RPCStruct { public ImageResolution getImageResolution() {
return (ImageResolution) getObject(ImageResolution.class, KEY_RESOLUTION);
}
- public void setImageResolution( @NonNull ImageResolution resolution ) {
+ public ScreenParams setImageResolution(@NonNull ImageResolution resolution) {
setValue(KEY_RESOLUTION, resolution);
+ return this;
}
@SuppressWarnings("unchecked")
public TouchEventCapabilities getTouchEventAvailable() {
return (TouchEventCapabilities) getObject(TouchEventCapabilities.class, KEY_TOUCH_EVENT_AVAILABLE);
}
- public void setTouchEventAvailable( TouchEventCapabilities touchEventAvailable ) {
- setValue(KEY_TOUCH_EVENT_AVAILABLE, touchEventAvailable);
- }
+ public ScreenParams setTouchEventAvailable( TouchEventCapabilities touchEventAvailable) {
+ setValue(KEY_TOUCH_EVENT_AVAILABLE, touchEventAvailable);
+ return this;
+ }
}
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/ScrollableMessage.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/ScrollableMessage.java index 1ad0d0846..cb331914a 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/ScrollableMessage.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/ScrollableMessage.java @@ -144,15 +144,16 @@ public class ScrollableMessage extends RPCRequest { /**
* Sets a Body of text that can include newlines and tabs
- *
+ *
* @param scrollableMessageBody
* a String value representing the Body of text that can include
* newlines and tabs
* <p></p>
* <b>Notes: </b>Maxlength=500
*/
- public void setScrollableMessageBody(@NonNull String scrollableMessageBody) {
- setParameters(KEY_SCROLLABLE_MESSAGE_BODY, scrollableMessageBody);
+ public ScrollableMessage setScrollableMessageBody(@NonNull String scrollableMessageBody) {
+ setParameters(KEY_SCROLLABLE_MESSAGE_BODY, scrollableMessageBody);
+ return this;
}
/**
@@ -167,14 +168,15 @@ public class ScrollableMessage extends RPCRequest { /**
* Sets an App defined timeout. Indicates how long of a timeout from the
* last action
- *
+ *
* @param timeout
* an Integer value representing an App defined timeout
* <p></p>
* <b>Notes</b>:Minval=0; Maxval=65535;Default=30000
*/
- public void setTimeout(Integer timeout) {
- setParameters(KEY_TIMEOUT, timeout);
+ public ScrollableMessage setTimeout( Integer timeout) {
+ setParameters(KEY_TIMEOUT, timeout);
+ return this;
}
/**
@@ -189,15 +191,16 @@ public class ScrollableMessage extends RPCRequest { /**
* Sets App defined SoftButtons.If omitted on supported displays, only the
* system defined "Close" SoftButton will be displayed
- *
+ *
* @param softButtons
* a List<SoftButton> value representing App defined
* SoftButtons
* <p></p>
* <b>Notes: </b>Minsize=0, Maxsize=8
*/
- public void setSoftButtons(List<SoftButton> softButtons) {
- setParameters(KEY_SOFT_BUTTONS, softButtons);
+ public ScrollableMessage setSoftButtons( List<SoftButton> softButtons) {
+ setParameters(KEY_SOFT_BUTTONS, softButtons);
+ return this;
}
/**
@@ -227,7 +230,8 @@ public class ScrollableMessage extends RPCRequest { *
* @since SmartDeviceLink 6.0
*/
- public void setCancelID(Integer cancelID) {
- setParameters(KEY_CANCEL_ID, cancelID);
- }
+ public ScrollableMessage setCancelID( Integer cancelID) {
+ setParameters(KEY_CANCEL_ID, cancelID);
+ return this;
+ }
}
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/SdlMsgVersion.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/SdlMsgVersion.java index 8a2135753..0e8f9453f 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/SdlMsgVersion.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/SdlMsgVersion.java @@ -138,10 +138,11 @@ public class SdlMsgVersion extends RPCStruct { * <li>minvalue="1"</li>
* <li>maxvalue="10"</li>
* </ul>
- * @param majorVersion minvalue="1" and maxvalue="10"
- */
- public void setMajorVersion( @NonNull Integer majorVersion ) {
+ * @param majorVersion minvalue="1" and maxvalue="10"
+ */
+ public SdlMsgVersion setMajorVersion(@NonNull Integer majorVersion) {
setValue(KEY_MAJOR_VERSION, majorVersion);
+ return this;
}
/**
* Get minor version
@@ -162,8 +163,9 @@ public class SdlMsgVersion extends RPCStruct { * </ul>
* @param minorVersion min: 0; max: 1000
*/
- public void setMinorVersion( @NonNull Integer minorVersion ) {
+ public SdlMsgVersion setMinorVersion(@NonNull Integer minorVersion) {
setValue(KEY_MINOR_VERSION, minorVersion);
+ return this;
}
/**
@@ -185,8 +187,9 @@ public class SdlMsgVersion extends RPCStruct { * </ul>
* @param patchVersion min: 0; max: 1000
*/
- public void setPatchVersion( Integer patchVersion ) {
+ public SdlMsgVersion setPatchVersion( Integer patchVersion) {
setValue(KEY_PATCH_VERSION, patchVersion);
+ return this;
}
}
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/SeatControlCapabilities.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/SeatControlCapabilities.java index 106edf2cb..82d3cf72c 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/SeatControlCapabilities.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/SeatControlCapabilities.java @@ -95,18 +95,20 @@ public class SeatControlCapabilities extends RPCStruct { * * @param moduleName - The short friendly name of the light control module. It should not be used to identify a module by mobile application. */ - public void setModuleName(@NonNull String moduleName) { - setValue(KEY_MODULE_NAME, moduleName); - } + public SeatControlCapabilities setModuleName(@NonNull String moduleName) { + setValue(KEY_MODULE_NAME, moduleName); + return this; + } /** * Sets the heatingEnabledAvailable portion of the SeatControlCapabilities class * * @param heatingEnabledAvailable */ - public void setHeatingEnabledAvailable(Boolean heatingEnabledAvailable) { - setValue(KEY_HEATING_ENABLED_AVAILABLE, heatingEnabledAvailable); - } + public SeatControlCapabilities setHeatingEnabledAvailable( Boolean heatingEnabledAvailable) { + setValue(KEY_HEATING_ENABLED_AVAILABLE, heatingEnabledAvailable); + return this; + } /** * Gets the heatingEnabledAvailable portion of the SeatControlCapabilities class @@ -122,9 +124,10 @@ public class SeatControlCapabilities extends RPCStruct { * * @param coolingEnabledAvailable */ - public void setCoolingEnabledAvailable(Boolean coolingEnabledAvailable) { - setValue(KEY_COOLING_ENABLED_AVAILABLE, coolingEnabledAvailable); - } + public SeatControlCapabilities setCoolingEnabledAvailable( Boolean coolingEnabledAvailable) { + setValue(KEY_COOLING_ENABLED_AVAILABLE, coolingEnabledAvailable); + return this; + } /** * Gets the coolingEnabledAvailable portion of the SeatControlCapabilities class @@ -140,9 +143,10 @@ public class SeatControlCapabilities extends RPCStruct { * * @param heatingLevelAvailable */ - public void setHeatingLevelAvailable(Boolean heatingLevelAvailable) { - setValue(KEY_HEATING_LEVEL_AVAILABLE, heatingLevelAvailable); - } + public SeatControlCapabilities setHeatingLevelAvailable( Boolean heatingLevelAvailable) { + setValue(KEY_HEATING_LEVEL_AVAILABLE, heatingLevelAvailable); + return this; + } /** * Gets the heatingLevelAvailable portion of the SeatControlCapabilities class @@ -158,9 +162,10 @@ public class SeatControlCapabilities extends RPCStruct { * * @param coolingLevelAvailable */ - public void setCoolingLevelAvailable(Boolean coolingLevelAvailable) { - setValue(KEY_COOLING_LEVEL_AVAILABLE, coolingLevelAvailable); - } + public SeatControlCapabilities setCoolingLevelAvailable( Boolean coolingLevelAvailable) { + setValue(KEY_COOLING_LEVEL_AVAILABLE, coolingLevelAvailable); + return this; + } /** * Gets the coolingLevelAvailable portion of the SeatControlCapabilities class @@ -176,9 +181,10 @@ public class SeatControlCapabilities extends RPCStruct { * * @param horizontalPositionAvailable */ - public void setHorizontalPositionAvailable(Boolean horizontalPositionAvailable) { - setValue(KEY_HORIZONTAL_POSITION_AVAILABLE, horizontalPositionAvailable); - } + public SeatControlCapabilities setHorizontalPositionAvailable( Boolean horizontalPositionAvailable) { + setValue(KEY_HORIZONTAL_POSITION_AVAILABLE, horizontalPositionAvailable); + return this; + } /** * Gets the horizontalPositionAvailable portion of the SeatControlCapabilities class @@ -194,9 +200,10 @@ public class SeatControlCapabilities extends RPCStruct { * * @param verticalPositionAvailable */ - public void setVerticalPositionAvailable(Boolean verticalPositionAvailable) { - setValue(KEY_VERTICAL_POSITION_AVAILABLE, verticalPositionAvailable); - } + public SeatControlCapabilities setVerticalPositionAvailable( Boolean verticalPositionAvailable) { + setValue(KEY_VERTICAL_POSITION_AVAILABLE, verticalPositionAvailable); + return this; + } /** * Gets the verticalPositionAvailable portion of the SeatControlCapabilities class @@ -212,9 +219,10 @@ public class SeatControlCapabilities extends RPCStruct { * * @param frontVerticalPositionAvailable */ - public void setFrontVerticalPositionAvailable(Boolean frontVerticalPositionAvailable) { - setValue(KEY_FRONT_VERTICAL_POSITION_AVAILABLE, frontVerticalPositionAvailable); - } + public SeatControlCapabilities setFrontVerticalPositionAvailable( Boolean frontVerticalPositionAvailable) { + setValue(KEY_FRONT_VERTICAL_POSITION_AVAILABLE, frontVerticalPositionAvailable); + return this; + } /** * Gets the frontVerticalPositionAvailable portion of the SeatControlCapabilities class @@ -230,9 +238,10 @@ public class SeatControlCapabilities extends RPCStruct { * * @param backVerticalPositionAvailable */ - public void setBackVerticalPositionAvailable(Boolean backVerticalPositionAvailable) { - setValue(KEY_BACK_VERTICAL_POSITION_AVAILABLE, backVerticalPositionAvailable); - } + public SeatControlCapabilities setBackVerticalPositionAvailable( Boolean backVerticalPositionAvailable) { + setValue(KEY_BACK_VERTICAL_POSITION_AVAILABLE, backVerticalPositionAvailable); + return this; + } /** * Gets the backVerticalPositionAvailable portion of the SeatControlCapabilities class @@ -248,9 +257,10 @@ public class SeatControlCapabilities extends RPCStruct { * * @param backTiltAngleAvailable */ - public void setBackTiltAngleAvailable(Boolean backTiltAngleAvailable) { - setValue(KEY_BACK_TILT_ANGLE_AVAILABLE, backTiltAngleAvailable); - } + public SeatControlCapabilities setBackTiltAngleAvailable( Boolean backTiltAngleAvailable) { + setValue(KEY_BACK_TILT_ANGLE_AVAILABLE, backTiltAngleAvailable); + return this; + } /** * Gets the backTiltAngleAvailable portion of the SeatControlCapabilities class @@ -266,9 +276,10 @@ public class SeatControlCapabilities extends RPCStruct { * * @param headSupportHorizontalPositionAvailable */ - public void setHeadSupportHorizontalPositionAvailable(Boolean headSupportHorizontalPositionAvailable) { - setValue(KEY_HEAD_SUPPORT_HORIZONTAL_POSITION_AVAILABLE, headSupportHorizontalPositionAvailable); - } + public SeatControlCapabilities setHeadSupportHorizontalPositionAvailable( Boolean headSupportHorizontalPositionAvailable) { + setValue(KEY_HEAD_SUPPORT_HORIZONTAL_POSITION_AVAILABLE, headSupportHorizontalPositionAvailable); + return this; + } /** * Gets the headSupportHorizontalPositionAvailable portion of the SeatControlCapabilities class @@ -284,9 +295,10 @@ public class SeatControlCapabilities extends RPCStruct { * * @param headSupportVerticalPositionAvailable */ - public void setHeadSupportVerticalPositionAvailable(Boolean headSupportVerticalPositionAvailable) { - setValue(KEY_HEAD_SUPPORT_VERTICAL_POSITION_AVAILABLE, headSupportVerticalPositionAvailable); - } + public SeatControlCapabilities setHeadSupportVerticalPositionAvailable( Boolean headSupportVerticalPositionAvailable) { + setValue(KEY_HEAD_SUPPORT_VERTICAL_POSITION_AVAILABLE, headSupportVerticalPositionAvailable); + return this; + } /** * Gets the headSupportVerticalPositionAvailable portion of the SeatControlCapabilities class @@ -302,9 +314,10 @@ public class SeatControlCapabilities extends RPCStruct { * * @param massageEnabledAvailable */ - public void setMassageEnabledAvailable(Boolean massageEnabledAvailable) { - setValue(KEY_MASSAGE_ENABLED_AVAILABLE, massageEnabledAvailable); - } + public SeatControlCapabilities setMassageEnabledAvailable( Boolean massageEnabledAvailable) { + setValue(KEY_MASSAGE_ENABLED_AVAILABLE, massageEnabledAvailable); + return this; + } /** * Gets the massageEnabledAvailable portion of the SeatControlCapabilities class @@ -320,9 +333,10 @@ public class SeatControlCapabilities extends RPCStruct { * * @param massageModeAvailable */ - public void setMassageModeAvailable(Boolean massageModeAvailable) { - setValue(KEY_MASSAGE_MODE_AVAILABLE, massageModeAvailable); - } + public SeatControlCapabilities setMassageModeAvailable( Boolean massageModeAvailable) { + setValue(KEY_MASSAGE_MODE_AVAILABLE, massageModeAvailable); + return this; + } /** * Gets the massageModeAvailable portion of the SeatControlCapabilities class @@ -338,9 +352,10 @@ public class SeatControlCapabilities extends RPCStruct { * * @param massageCushionFirmnessAvailable */ - public void setMassageCushionFirmnessAvailable(Boolean massageCushionFirmnessAvailable) { - setValue(KEY_MASSAGE_CUSHION_FIRMNESS_AVAILABLE, massageCushionFirmnessAvailable); - } + public SeatControlCapabilities setMassageCushionFirmnessAvailable( Boolean massageCushionFirmnessAvailable) { + setValue(KEY_MASSAGE_CUSHION_FIRMNESS_AVAILABLE, massageCushionFirmnessAvailable); + return this; + } /** * Gets the massageCushionFirmnessAvailable portion of the SeatControlCapabilities class @@ -356,9 +371,10 @@ public class SeatControlCapabilities extends RPCStruct { * * @param memoryAvailable */ - public void setMemoryAvailable(Boolean memoryAvailable) { - setValue(KEY_MEMORY_AVAILABLE, memoryAvailable); - } + public SeatControlCapabilities setMemoryAvailable( Boolean memoryAvailable) { + setValue(KEY_MEMORY_AVAILABLE, memoryAvailable); + return this; + } /** * Gets the memoryAvailable portion of the SeatControlCapabilities class @@ -373,9 +389,10 @@ public class SeatControlCapabilities extends RPCStruct { * Sets ModuleInfo for this capability * @param info the ModuleInfo to be set */ - public void setModuleInfo(ModuleInfo info) { - setValue(KEY_MODULE_INFO, info); - } + public SeatControlCapabilities setModuleInfo( ModuleInfo info) { + setValue(KEY_MODULE_INFO, info); + return this; + } /** * Gets a ModuleInfo of this capability diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/SeatControlData.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/SeatControlData.java index fbaf55fad..8f63ff39e 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/SeatControlData.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/SeatControlData.java @@ -90,9 +90,10 @@ public class SeatControlData extends RPCStruct { * * @param id */ - public void setId(@NonNull SupportedSeat id) { - setValue(KEY_ID, id); - } + public SeatControlData setId(@NonNull SupportedSeat id) { + setValue(KEY_ID, id); + return this; + } /** * Gets the id portion of the SeatControlData class @@ -108,9 +109,10 @@ public class SeatControlData extends RPCStruct { * * @param heatingEnabled */ - public void setHeatingEnabled(Boolean heatingEnabled) { - setValue(KEY_HEATING_ENABLED, heatingEnabled); - } + public SeatControlData setHeatingEnabled( Boolean heatingEnabled) { + setValue(KEY_HEATING_ENABLED, heatingEnabled); + return this; + } /** * Gets the heatingEnabled portion of the SeatControlData class @@ -126,9 +128,10 @@ public class SeatControlData extends RPCStruct { * * @param coolingEnabled */ - public void setCoolingEnabled(Boolean coolingEnabled) { - setValue(KEY_COOLING_ENABLED, coolingEnabled); - } + public SeatControlData setCoolingEnabled( Boolean coolingEnabled) { + setValue(KEY_COOLING_ENABLED, coolingEnabled); + return this; + } /** * Gets the coolingEnabled portion of the SeatControlData class @@ -144,9 +147,10 @@ public class SeatControlData extends RPCStruct { * * @param heatingLevel */ - public void setHeatingLevel(Integer heatingLevel) { - setValue(KEY_HEATING_LEVEL, heatingLevel); - } + public SeatControlData setHeatingLevel( Integer heatingLevel) { + setValue(KEY_HEATING_LEVEL, heatingLevel); + return this; + } /** * Gets the heatingLevel portion of the SeatControlData class @@ -162,9 +166,10 @@ public class SeatControlData extends RPCStruct { * * @param coolingLevel */ - public void setCoolingLevel(Integer coolingLevel) { - setValue(KEY_COOLING_LEVEL, coolingLevel); - } + public SeatControlData setCoolingLevel( Integer coolingLevel) { + setValue(KEY_COOLING_LEVEL, coolingLevel); + return this; + } /** * Gets the coolingLevel portion of the SeatControlData class @@ -180,9 +185,10 @@ public class SeatControlData extends RPCStruct { * * @param horizontalPosition */ - public void setHorizontalPosition(Integer horizontalPosition) { - setValue(KEY_HORIZONTAL_POSITION, horizontalPosition); - } + public SeatControlData setHorizontalPosition( Integer horizontalPosition) { + setValue(KEY_HORIZONTAL_POSITION, horizontalPosition); + return this; + } /** * Gets the horizontalPosition portion of the SeatControlData class @@ -198,9 +204,10 @@ public class SeatControlData extends RPCStruct { * * @param verticalPosition */ - public void setVerticalPosition(Integer verticalPosition) { - setValue(KEY_VERTICAL_POSITION, verticalPosition); - } + public SeatControlData setVerticalPosition( Integer verticalPosition) { + setValue(KEY_VERTICAL_POSITION, verticalPosition); + return this; + } /** * Gets the verticalPosition portion of the SeatControlData class @@ -216,9 +223,10 @@ public class SeatControlData extends RPCStruct { * * @param frontVerticalPosition */ - public void setFrontVerticalPosition(Integer frontVerticalPosition) { - setValue(KEY_FRONT_VERTICAL_POSITION, frontVerticalPosition); - } + public SeatControlData setFrontVerticalPosition( Integer frontVerticalPosition) { + setValue(KEY_FRONT_VERTICAL_POSITION, frontVerticalPosition); + return this; + } /** * Gets the frontVerticalPosition portion of the SeatControlData class @@ -234,9 +242,10 @@ public class SeatControlData extends RPCStruct { * * @param backVerticalPosition */ - public void setBackVerticalPosition(Integer backVerticalPosition) { - setValue(KEY_BACK_VERTICAL_POSITION, backVerticalPosition); - } + public SeatControlData setBackVerticalPosition( Integer backVerticalPosition) { + setValue(KEY_BACK_VERTICAL_POSITION, backVerticalPosition); + return this; + } /** * Gets the backVerticalPosition portion of the SeatControlData class @@ -252,9 +261,10 @@ public class SeatControlData extends RPCStruct { * * @param backTiltAngle */ - public void setBackTiltAngle(Integer backTiltAngle) { - setValue(KEY_BACK_TILT_ANGLE, backTiltAngle); - } + public SeatControlData setBackTiltAngle( Integer backTiltAngle) { + setValue(KEY_BACK_TILT_ANGLE, backTiltAngle); + return this; + } /** * Gets the backTiltAngle portion of the SeatControlData class @@ -270,9 +280,10 @@ public class SeatControlData extends RPCStruct { * * @param headSupportHorizontalPosition */ - public void setHeadSupportHorizontalPosition(Integer headSupportHorizontalPosition) { - setValue(KEY_HEAD_SUPPORT_HORIZONTAL_POSITION, headSupportHorizontalPosition); - } + public SeatControlData setHeadSupportHorizontalPosition( Integer headSupportHorizontalPosition) { + setValue(KEY_HEAD_SUPPORT_HORIZONTAL_POSITION, headSupportHorizontalPosition); + return this; + } /** * Gets the headSupportHorizontalPosition portion of the SeatControlData class @@ -288,9 +299,10 @@ public class SeatControlData extends RPCStruct { * * @param headSupportVerticalPosition */ - public void setHeadSupportVerticalPosition(Integer headSupportVerticalPosition) { - setValue(KEY_HEAD_SUPPORT_VERTICAL_POSITION, headSupportVerticalPosition); - } + public SeatControlData setHeadSupportVerticalPosition( Integer headSupportVerticalPosition) { + setValue(KEY_HEAD_SUPPORT_VERTICAL_POSITION, headSupportVerticalPosition); + return this; + } /** * Gets the headSupportVerticalPosition portion of the SeatControlData class @@ -306,9 +318,10 @@ public class SeatControlData extends RPCStruct { * * @param massageEnabled */ - public void setMassageEnabled(Boolean massageEnabled) { - setValue(KEY_MASSAGE_ENABLED, massageEnabled); - } + public SeatControlData setMassageEnabled( Boolean massageEnabled) { + setValue(KEY_MASSAGE_ENABLED, massageEnabled); + return this; + } /** * Gets the massageEnabled portion of the SeatControlData class @@ -334,9 +347,10 @@ public class SeatControlData extends RPCStruct { * * @param massageMode */ - public void setMassageMode(List<MassageModeData> massageMode) { - setValue(KEY_MASSAGE_MODE, massageMode); - } + public SeatControlData setMassageMode( List<MassageModeData> massageMode) { + setValue(KEY_MASSAGE_MODE, massageMode); + return this; + } /** * Gets the List<MassageCushionFirmness> portion of the SeatControlData class @@ -353,18 +367,20 @@ public class SeatControlData extends RPCStruct { * * @param massageCushionFirmness */ - public void setMassageCushionFirmness(List<MassageCushionFirmness> massageCushionFirmness) { - setValue(KEY_MASSAGE_CUSHION_FIRMNESS, massageCushionFirmness); - } + public SeatControlData setMassageCushionFirmness( List<MassageCushionFirmness> massageCushionFirmness) { + setValue(KEY_MASSAGE_CUSHION_FIRMNESS, massageCushionFirmness); + return this; + } /** * Sets the memory portion of the SeatControlData class * * @param memory */ - public void setMemory(SeatMemoryAction memory) { - setValue(KEY_MEMORY, memory); - } + public SeatControlData setMemory( SeatMemoryAction memory) { + setValue(KEY_MEMORY, memory); + return this; + } /** * Gets the memory portion of the SeatControlData class diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/SeatLocation.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/SeatLocation.java index a4b33d1bd..a0b1338e7 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/SeatLocation.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/SeatLocation.java @@ -17,8 +17,9 @@ public class SeatLocation extends RPCStruct { * Sets grid data for this seat location * @param grid the grid to be set */ - public void setGrid(Grid grid) { + public SeatLocation setGrid( Grid grid) { setValue(KEY_GRID, grid); + return this; } /** diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/SeatLocationCapability.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/SeatLocationCapability.java index 3fc34bada..160e6c33e 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/SeatLocationCapability.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/SeatLocationCapability.java @@ -22,8 +22,9 @@ public class SeatLocationCapability extends RPCStruct { * Sets the seat rows for this capability * @param rows rows to be set */ - public void setRows(Integer rows) { + public SeatLocationCapability setRows( Integer rows) { setValue(KEY_ROWS, rows); + return this; } /** @@ -38,8 +39,9 @@ public class SeatLocationCapability extends RPCStruct { * Sets the seat columns for this capability * @param cols the seat columns to be set */ - public void setCols(Integer cols) { + public SeatLocationCapability setCols( Integer cols) { setValue(KEY_COLS, cols); + return this; } /** @@ -54,8 +56,9 @@ public class SeatLocationCapability extends RPCStruct { * Sets the levels for this capability * @param levels the levels to be set */ - public void setLevels(Integer levels) { + public SeatLocationCapability setLevels( Integer levels) { setValue(KEY_LEVELS, levels); + return this; } /** @@ -70,8 +73,9 @@ public class SeatLocationCapability extends RPCStruct { * Sets the seat locations for this capability * @param locations the locations to be set */ - public void setSeats(List<SeatLocation> locations) { + public SeatLocationCapability setSeats( List<SeatLocation> locations) { setValue(KEY_SEATS, locations); + return this; } /** diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/SeatMemoryAction.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/SeatMemoryAction.java index af27805db..1dc2411ba 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/SeatMemoryAction.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/SeatMemoryAction.java @@ -75,9 +75,10 @@ public class SeatMemoryAction extends RPCStruct { * * @param id */ - public void setId(@NonNull Integer id) { - setValue(KEY_ID, id); - } + public SeatMemoryAction setId(@NonNull Integer id) { + setValue(KEY_ID, id); + return this; + } /** * Gets the id portion of the SeatMemoryAction class @@ -93,9 +94,10 @@ public class SeatMemoryAction extends RPCStruct { * * @param label */ - public void setLabel(String label) { - setValue(KEY_LABEL, label); - } + public SeatMemoryAction setLabel( String label) { + setValue(KEY_LABEL, label); + return this; + } /** * Gets the label portion of the SeatMemoryAction class @@ -111,9 +113,10 @@ public class SeatMemoryAction extends RPCStruct { * * @param action */ - public void setAction(@NonNull SeatMemoryActionType action) { - setValue(KEY_ACTION, action); - } + public SeatMemoryAction setAction(@NonNull SeatMemoryActionType action) { + setValue(KEY_ACTION, action); + return this; + } /** * Gets the action portion of the SeatMemoryAction class diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/SendHapticData.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/SendHapticData.java index 6cee332f1..34295d9c5 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/SendHapticData.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/SendHapticData.java @@ -71,9 +71,10 @@ public class SendHapticData extends RPCRequest { * When a request is sent, if successful, it will replace all spatial data previously sent through RPC. * If an empty array is sent, the existing spatial data will be cleared */ - public void setHapticRectData(List<HapticRect> hapticRectData) { - setParameters(KEY_HAPTIC_RECT_DATA, hapticRectData); - } + public SendHapticData setHapticRectData( List<HapticRect> hapticRectData) { + setParameters(KEY_HAPTIC_RECT_DATA, hapticRectData); + return this; + } /** * Get the haptic data diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/SendLocation.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/SendLocation.java index 87fa67bb6..1ed6cfb10 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/SendLocation.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/SendLocation.java @@ -97,8 +97,9 @@ public class SendLocation extends RPCRequest{ * Setter for longitude of the location to send. * @param longitudeDegrees degrees of the longitudinal position */ - public void setLongitudeDegrees(Double longitudeDegrees){ + public SendLocation setLongitudeDegrees( Double longitudeDegrees) { setParameters(KEY_LON_DEGREES, longitudeDegrees); + return this; } /** @@ -120,8 +121,9 @@ public class SendLocation extends RPCRequest{ * Setter for latitude of the location to send. * @param latitudeDegrees degrees of the latitudinal position */ - public void setLatitudeDegrees(Double latitudeDegrees){ + public SendLocation setLatitudeDegrees( Double latitudeDegrees) { setParameters(KEY_LAT_DEGREES, latitudeDegrees); + return this; } /** @@ -136,8 +138,9 @@ public class SendLocation extends RPCRequest{ * Setter for name of the location to send. * @param locationName The name of the location */ - public void setLocationName(String locationName){ + public SendLocation setLocationName( String locationName) { setParameters(KEY_LOCATION_NAME, locationName); + return this; } /** @@ -152,8 +155,9 @@ public class SendLocation extends RPCRequest{ * Setter for description of the location to send. * @param locationDescription The description of the location */ - public void setLocationDescription(String locationDescription){ + public SendLocation setLocationDescription( String locationDescription) { setParameters(KEY_LOCATION_DESCRIPTION, locationDescription); + return this; } /** @@ -168,8 +172,9 @@ public class SendLocation extends RPCRequest{ * Setter for phone number of the location to send. * @param phoneNumber The phone number of the location */ - public void setPhoneNumber(String phoneNumber){ + public SendLocation setPhoneNumber( String phoneNumber) { setParameters(KEY_PHONE_NUMBER, phoneNumber); + return this; } /** @@ -185,8 +190,9 @@ public class SendLocation extends RPCRequest{ * Setter for address lines of the location to send. * @param addressLines The address lines of the location */ - public void setAddressLines(List<String> addressLines){ + public SendLocation setAddressLines( List<String> addressLines) { setParameters(KEY_ADDRESS_LINES, addressLines); + return this; } /** @@ -202,33 +208,37 @@ public class SendLocation extends RPCRequest{ * Setter for image of the location to send. * @param locationImage The image of the location to send */ - public void setLocationImage(Image locationImage){ + public SendLocation setLocationImage( Image locationImage) { setParameters(KEY_LOCATION_IMAGE, locationImage); + return this; } public DeliveryMode getDeliveryMode() { return (DeliveryMode) getObject(DeliveryMode.class, KEY_DELIVERY_MODE); } - public void setDeliveryMode(DeliveryMode deliveryMode) { + public SendLocation setDeliveryMode( DeliveryMode deliveryMode) { setParameters(KEY_DELIVERY_MODE, deliveryMode); - } + return this; + } @SuppressWarnings("unchecked") public DateTime getTimeStamp() { return (DateTime) getObject(DateTime.class, KEY_TIME_STAMP); } - public void setTimeStamp(DateTime timeStamp) { + public SendLocation setTimeStamp( DateTime timeStamp) { setParameters(KEY_TIME_STAMP, timeStamp); - } + return this; + } @SuppressWarnings("unchecked") public OasisAddress getAddress() { return (OasisAddress) getObject(OasisAddress.class, KEY_ADDRESS); } - public void setAddress(OasisAddress address) { + public SendLocation setAddress( OasisAddress address) { setParameters(KEY_ADDRESS, address); - } + return this; + } } diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/SetAppIcon.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/SetAppIcon.java index 6443be188..084332432 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/SetAppIcon.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/SetAppIcon.java @@ -1,34 +1,34 @@ -/* - * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this - * list of conditions and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following - * disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its - * contributors may be used to endorse or promote products derived from this - * software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ +/*
+ * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
package com.smartdevicelink.proxy.rpc;
import androidx.annotation.NonNull;
@@ -109,14 +109,15 @@ public class SetAppIcon extends RPCRequest { /**
* Sets a file reference name
- *
+ *
* @param sdlFileName
* a String value representing a file reference name
* <p></p>
* <b>Notes: </b>Maxlength=500, however the max file name length may vary based on remote filesystem limitations
*/
- public void setSdlFileName(@NonNull String sdlFileName) {
- setParameters(KEY_SDL_FILE_NAME, sdlFileName);
+ public SetAppIcon setSdlFileName(@NonNull String sdlFileName) {
+ setParameters(KEY_SDL_FILE_NAME, sdlFileName);
+ return this;
}
/**
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/SetCloudAppProperties.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/SetCloudAppProperties.java index a457304e3..48bc1196d 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/SetCloudAppProperties.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/SetCloudAppProperties.java @@ -55,8 +55,9 @@ public class SetCloudAppProperties extends RPCRequest { setParameters(KEY_PROPERTIES, cloudAppProperties); } - public void setProperties(@NonNull CloudAppProperties cloudAppProperties){ + public SetCloudAppProperties setProperties(@NonNull CloudAppProperties cloudAppProperties) { setParameters(KEY_PROPERTIES, cloudAppProperties); + return this; } public CloudAppProperties getProperties(){ diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/SetDisplayLayout.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/SetDisplayLayout.java index 937c8e8da..1b07d047a 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/SetDisplayLayout.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/SetDisplayLayout.java @@ -131,12 +131,13 @@ public class SetDisplayLayout extends RPCRequest { * Currently only predefined screen layouts are defined. Predefined layouts
* include: "ONSCREEN_PRESETS" Custom screen containing app-defined onscreen
* presets. Currently defined for GEN2
- *
+ *
* @param displayLayout
* a String value representing a display layout
*/
- public void setDisplayLayout(@NonNull String displayLayout) {
- setParameters(KEY_DISPLAY_LAYOUT, displayLayout);
+ public SetDisplayLayout setDisplayLayout(@NonNull String displayLayout) {
+ setParameters(KEY_DISPLAY_LAYOUT, displayLayout);
+ return this;
}
/**
@@ -164,9 +165,10 @@ public class SetDisplayLayout extends RPCRequest { * used for day color scheme
* @since SmartDeviceLink 5.0
*/
- public void setDayColorScheme(TemplateColorScheme templateColorScheme){
- setParameters(KEY_DAY_COLOR_SCHEME, templateColorScheme);
- }
+ public SetDisplayLayout setDayColorScheme( TemplateColorScheme templateColorScheme) {
+ setParameters(KEY_DAY_COLOR_SCHEME, templateColorScheme);
+ return this;
+ }
/**
* Gets the color scheme that is currently used for night
@@ -186,7 +188,8 @@ public class SetDisplayLayout extends RPCRequest { * used for night color scheme
* @since SmartDeviceLink 5.0
*/
- public void setNightColorScheme(TemplateColorScheme templateColorScheme){
- setParameters(KEY_NIGHT_COLOR_SCHEME, templateColorScheme);
- }
+ public SetDisplayLayout setNightColorScheme( TemplateColorScheme templateColorScheme) {
+ setParameters(KEY_NIGHT_COLOR_SCHEME, templateColorScheme);
+ return this;
+ }
}
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/SetDisplayLayoutResponse.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/SetDisplayLayoutResponse.java index 011dcf6ac..eb4e641d9 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/SetDisplayLayoutResponse.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/SetDisplayLayoutResponse.java @@ -87,8 +87,9 @@ public class SetDisplayLayoutResponse extends RPCResponse { return (DisplayCapabilities) getObject(DisplayCapabilities.class, KEY_DISPLAY_CAPABILITIES);
}
- public void setDisplayCapabilities(DisplayCapabilities displayCapabilities) {
+ public SetDisplayLayoutResponse setDisplayCapabilities( DisplayCapabilities displayCapabilities) {
setParameters(KEY_DISPLAY_CAPABILITIES, displayCapabilities);
+ return this;
}
@SuppressWarnings("unchecked")
@@ -96,8 +97,9 @@ public class SetDisplayLayoutResponse extends RPCResponse { return (List<ButtonCapabilities>) getObject(ButtonCapabilities.class, KEY_BUTTON_CAPABILITIES);
}
- public void setButtonCapabilities(List<ButtonCapabilities> buttonCapabilities) {
+ public SetDisplayLayoutResponse setButtonCapabilities( List<ButtonCapabilities> buttonCapabilities) {
setParameters(KEY_BUTTON_CAPABILITIES, buttonCapabilities);
+ return this;
}
@SuppressWarnings("unchecked")
@@ -105,8 +107,9 @@ public class SetDisplayLayoutResponse extends RPCResponse { return (List<SoftButtonCapabilities>) getObject(SoftButtonCapabilities.class, KEY_SOFT_BUTTON_CAPABILITIES);
}
- public void setSoftButtonCapabilities(List<SoftButtonCapabilities> softButtonCapabilities) {
+ public SetDisplayLayoutResponse setSoftButtonCapabilities( List<SoftButtonCapabilities> softButtonCapabilities) {
setParameters(KEY_SOFT_BUTTON_CAPABILITIES, softButtonCapabilities);
+ return this;
}
@SuppressWarnings("unchecked")
@@ -114,8 +117,9 @@ public class SetDisplayLayoutResponse extends RPCResponse { return (PresetBankCapabilities) getObject(PresetBankCapabilities.class, KEY_PRESET_BANK_CAPABILITIES);
}
- public void setPresetBankCapabilities(PresetBankCapabilities presetBankCapabilities) {
+ public SetDisplayLayoutResponse setPresetBankCapabilities( PresetBankCapabilities presetBankCapabilities) {
setParameters(KEY_PRESET_BANK_CAPABILITIES, presetBankCapabilities);
+ return this;
}
}
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/SetGlobalProperties.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/SetGlobalProperties.java index 82e7738ee..28050a867 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/SetGlobalProperties.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/SetGlobalProperties.java @@ -188,7 +188,7 @@ public class SetGlobalProperties extends RPCRequest { * Sets a List<TTSChunk> for Help Prompt that Array of one or more
* TTSChunk elements specifying the help prompt used in an interaction
* started by PTT
- *
+ *
* @param helpPrompt
* a List<TTSChunk> of one or more TTSChunk elements
* <p></p>
@@ -197,9 +197,10 @@ public class SetGlobalProperties extends RPCRequest { * <li>Array must have at least one element</li>
* <li>Only optional it timeoutPrompt has been specified</li>
* </ul>
- */
- public void setHelpPrompt(List<TTSChunk> helpPrompt) {
- setParameters(KEY_HELP_PROMPT, helpPrompt);
+ */
+ public SetGlobalProperties setHelpPrompt( List<TTSChunk> helpPrompt) {
+ setParameters(KEY_HELP_PROMPT, helpPrompt);
+ return this;
}
/**
* Gets a List<TTSChunk> for Timeout Prompt representing Array of one or
@@ -217,10 +218,11 @@ public class SetGlobalProperties extends RPCRequest { * Sets a List<TTSChunk> for Timeout Prompt representing Array of one or
* more TTSChunk elements specifying the help prompt used in an interaction
* started by PTT
- *
- */
- public void setTimeoutPrompt(List<TTSChunk> timeoutPrompt) {
- setParameters(KEY_TIMEOUT_PROMPT, timeoutPrompt);
+ *
+ */
+ public SetGlobalProperties setTimeoutPrompt( List<TTSChunk> timeoutPrompt) {
+ setParameters(KEY_TIMEOUT_PROMPT, timeoutPrompt);
+ return this;
}
/**
@@ -236,7 +238,7 @@ public class SetGlobalProperties extends RPCRequest { /**
* Sets a voice recognition Help Title
- *
+ *
* @param vrHelpTitle
* a String value representing a voice recognition Help Title
* <p></p>
@@ -250,8 +252,9 @@ public class SetGlobalProperties extends RPCRequest { * </ul>
* @since SmartDeviceLink 2.0
*/
- public void setVrHelpTitle(String vrHelpTitle) {
- setParameters(KEY_VR_HELP_TITLE, vrHelpTitle);
+ public SetGlobalProperties setVrHelpTitle( String vrHelpTitle) {
+ setParameters(KEY_VR_HELP_TITLE, vrHelpTitle);
+ return this;
}
/**
@@ -270,7 +273,7 @@ public class SetGlobalProperties extends RPCRequest { /**
* Sets the items listed in the VR help screen used in an interaction
* started by PTT
- *
+ *
* @param vrHelp
* a List value representing items listed in the VR help screen
* used in an interaction started by PTT
@@ -288,20 +291,23 @@ public class SetGlobalProperties extends RPCRequest { * </ul>
* @since SmartDeviceLink 2.0
*/
- public void setVrHelp(List<VrHelpItem> vrHelp) {
- setParameters(KEY_VR_HELP, vrHelp);
+ public SetGlobalProperties setVrHelp( List<VrHelpItem> vrHelp) {
+ setParameters(KEY_VR_HELP, vrHelp);
+ return this;
}
public String getMenuTitle() {
return getString(KEY_MENU_TITLE);
}
- public void setMenuTitle(String menuTitle) {
- setParameters(KEY_MENU_TITLE, menuTitle);
+ public SetGlobalProperties setMenuTitle( String menuTitle) {
+ setParameters(KEY_MENU_TITLE, menuTitle);
+ return this;
}
- public void setMenuIcon(Image menuIcon) {
- setParameters(KEY_MENU_ICON, menuIcon);
+ public SetGlobalProperties setMenuIcon( Image menuIcon) {
+ setParameters(KEY_MENU_ICON, menuIcon);
+ return this;
}
@SuppressWarnings("unchecked")
@@ -309,17 +315,19 @@ public class SetGlobalProperties extends RPCRequest { return (Image) getObject(Image.class, KEY_MENU_ICON);
}
- public void setKeyboardProperties(KeyboardProperties keyboardProperties) {
- setParameters(KEY_KEYBOARD_PROPERTIES, keyboardProperties);
+ public SetGlobalProperties setKeyboardProperties( KeyboardProperties keyboardProperties) {
+ setParameters(KEY_KEYBOARD_PROPERTIES, keyboardProperties);
+ return this;
}
/**
* Sets the user seat location
* @param location the location to be set
*/
- public void setUserLocation(SeatLocation location) {
- setParameters(KEY_USER_LOCATION, location);
- }
+ public SetGlobalProperties setUserLocation( SeatLocation location) {
+ setParameters(KEY_USER_LOCATION, location);
+ return this;
+ }
/**
* Gets the user seat location
@@ -339,9 +347,10 @@ public class SetGlobalProperties extends RPCRequest { * the head unit will change the display to the new layout type.
* @param menuLayout - the menuLayout
*/
- public void setMenuLayout(MenuLayout menuLayout) {
- setParameters(KEY_MENU_LAYOUT, menuLayout);
- }
+ public SetGlobalProperties setMenuLayout( MenuLayout menuLayout) {
+ setParameters(KEY_MENU_LAYOUT, menuLayout);
+ return this;
+ }
/**
* Sets the layout of the main menu screen. If this is sent while a menu is already on-screen,
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/SetInteriorVehicleData.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/SetInteriorVehicleData.java index 130d1e277..60e792023 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/SetInteriorVehicleData.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/SetInteriorVehicleData.java @@ -78,8 +78,9 @@ public class SetInteriorVehicleData extends RPCRequest { * * @param moduleData */ - public void setModuleData(@NonNull ModuleData moduleData) { + public SetInteriorVehicleData setModuleData(@NonNull ModuleData moduleData) { setParameters(KEY_MODULE_DATA, moduleData); + return this; } /** diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/SetInteriorVehicleDataResponse.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/SetInteriorVehicleDataResponse.java index 81390e64a..01ceed4ea 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/SetInteriorVehicleDataResponse.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/SetInteriorVehicleDataResponse.java @@ -86,7 +86,8 @@ public class SetInteriorVehicleDataResponse extends RPCResponse { * * @param moduleData */ - public void setModuleData(ModuleData moduleData) { - setParameters(KEY_MODULE_DATA, moduleData); - } + public SetInteriorVehicleDataResponse setModuleData( ModuleData moduleData) { + setParameters(KEY_MODULE_DATA, moduleData); + return this; + } } diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/SetMediaClockTimer.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/SetMediaClockTimer.java index 67353132f..05a97cc62 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/SetMediaClockTimer.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/SetMediaClockTimer.java @@ -1,34 +1,34 @@ -/* - * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this - * list of conditions and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following - * disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its - * contributors may be used to endorse or promote products derived from this - * software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ +/*
+ * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
package com.smartdevicelink.proxy.rpc;
import androidx.annotation.NonNull;
@@ -268,7 +268,7 @@ public class SetMediaClockTimer extends RPCRequest { }
/**
* Sets a Start Time with specifying hour, minute, second values
- *
+ *
* @param startTime
* a startTime object with specifying hour, minute, second values
* <p></p>
@@ -278,9 +278,10 @@ public class SetMediaClockTimer extends RPCRequest { * must be provided</li>
* <li>Will be ignored for PAUSE/RESUME and CLEAR</li>
* </ul>
- */
- public void setStartTime( StartTime startTime ) {
- setParameters(KEY_START_TIME, startTime);
+ */
+ public SetMediaClockTimer setStartTime( StartTime startTime) {
+ setParameters(KEY_START_TIME, startTime);
+ return this;
}
@SuppressWarnings("unchecked")
@@ -288,8 +289,9 @@ public class SetMediaClockTimer extends RPCRequest { return (StartTime) getObject(StartTime.class, KEY_END_TIME);
}
- public void setEndTime( StartTime endTime ) {
- setParameters(KEY_END_TIME, endTime);
+ public SetMediaClockTimer setEndTime( StartTime endTime) {
+ setParameters(KEY_END_TIME, endTime);
+ return this;
}
/**
@@ -302,7 +304,7 @@ public class SetMediaClockTimer extends RPCRequest { }
/**
* Sets the media clock/timer update mode (COUNTUP/COUNTDOWN/PAUSE/RESUME)
- *
+ *
* @param updateMode
* a Enumeration value (COUNTUP/COUNTDOWN/PAUSE/RESUME)
* <p></p>
@@ -313,9 +315,10 @@ public class SetMediaClockTimer extends RPCRequest { * <li>When updateMode is RESUME, the timer resumes counting from
* the timer's value when it was paused</li>
* </ul>
- */
- public void setUpdateMode( @NonNull UpdateMode updateMode ) {
- setParameters(KEY_UPDATE_MODE, updateMode);
+ */
+ public SetMediaClockTimer setUpdateMode(@NonNull UpdateMode updateMode) {
+ setParameters(KEY_UPDATE_MODE, updateMode);
+ return this;
}
/**
@@ -330,7 +333,8 @@ public class SetMediaClockTimer extends RPCRequest { /**
* Sets the playback status of a media app
*/
- public void setAudioStreamingIndicator(AudioStreamingIndicator audioStreamingIndicator ) {
- setParameters(KEY_AUDIO_STREAMING_INDICATOR, audioStreamingIndicator);
- }
+ public SetMediaClockTimer setAudioStreamingIndicator( AudioStreamingIndicator audioStreamingIndicator) {
+ setParameters(KEY_AUDIO_STREAMING_INDICATOR, audioStreamingIndicator);
+ return this;
+ }
}
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/Show.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/Show.java index e663c9f2b..dceae1a3b 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/Show.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/Show.java @@ -238,7 +238,7 @@ public class Show extends RPCRequest { /**
* Sets the text displayed in a single-line display, or in the upper display
* line in a two-line display
- *
+ *
* @param mainField1
* the String value representing the text displayed in a
* single-line display, or in the upper display line in a
@@ -251,9 +251,10 @@ public class Show extends RPCRequest { * <li>If this parameter is an empty string, the field will be
* cleared</li>
* </ul>
- */
- public void setMainField1(String mainField1) {
- setParameters(KEY_MAIN_FIELD_1, mainField1);
+ */
+ public Show setMainField1( String mainField1) {
+ setParameters(KEY_MAIN_FIELD_1, mainField1);
+ return this;
}
/**
* Gets the text displayed on the second display line of a two-line display
@@ -266,7 +267,7 @@ public class Show extends RPCRequest { }
/**
* Sets the text displayed on the second display line of a two-line display
- *
+ *
* @param mainField2
* the String value representing the text displayed on the second
* display line of a two-line display
@@ -281,9 +282,10 @@ public class Show extends RPCRequest { * parameter is ignored</li>
* <li>Maxlength = 500</li>
* </ul>
- */
- public void setMainField2(String mainField2) {
- setParameters(KEY_MAIN_FIELD_2, mainField2);
+ */
+ public Show setMainField2( String mainField2) {
+ setParameters(KEY_MAIN_FIELD_2, mainField2);
+ return this;
}
/**
@@ -299,7 +301,7 @@ public class Show extends RPCRequest { /**
* Sets the text displayed on the first display line of the second page
- *
+ *
* @param mainField3
* the String value representing the text displayed on the first
* display line of the second page
@@ -316,8 +318,9 @@ public class Show extends RPCRequest { * </ul>
* @since SmartDeviceLink 2.0
*/
- public void setMainField3(String mainField3) {
- setParameters(KEY_MAIN_FIELD_3, mainField3);
+ public Show setMainField3( String mainField3) {
+ setParameters(KEY_MAIN_FIELD_3, mainField3);
+ return this;
}
/**
@@ -333,7 +336,7 @@ public class Show extends RPCRequest { /**
* Sets the text displayed on the second display line of the second page
- *
+ *
* @param mainField4
* the String value representing the text displayed on the second
* display line of the second page
@@ -350,8 +353,9 @@ public class Show extends RPCRequest { * </ul>
* @since SmartDeviceLink 2.0
*/
- public void setMainField4(String mainField4) {
- setParameters(KEY_MAIN_FIELD_4, mainField4);
+ public Show setMainField4( String mainField4) {
+ setParameters(KEY_MAIN_FIELD_4, mainField4);
+ return this;
}
/**
* Gets the alignment that Specifies how mainField1 and mainField2 text
@@ -365,7 +369,7 @@ public class Show extends RPCRequest { /**
* Sets the alignment that Specifies how mainField1 and mainField2 text
* should be aligned on display
- *
+ *
* @param alignment
* an Enumeration value
* <p></p>
@@ -377,9 +381,10 @@ public class Show extends RPCRequest { * mainField2 will be centered</li>
* <li>Has no effect with navigation display</li>
* </ul>
- */
- public void setAlignment(TextAlignment alignment) {
- setParameters(KEY_ALIGNMENT, alignment);
+ */
+ public Show setAlignment( TextAlignment alignment) {
+ setParameters(KEY_ALIGNMENT, alignment);
+ return this;
}
/**
* Gets text in the Status Bar
@@ -391,7 +396,7 @@ public class Show extends RPCRequest { }
/**
* Sets text in the Status Bar
- *
+ *
* @param statusBar
* a String representing the text you want to add in the Status
* Bar
@@ -406,9 +411,10 @@ public class Show extends RPCRequest { * <li>If provided and the display has no status bar, this
* parameter is ignored</li>
* </ul>
- */
- public void setStatusBar(String statusBar) {
- setParameters(KEY_STATUS_BAR, statusBar);
+ */
+ public Show setStatusBar( String statusBar) {
+ setParameters(KEY_STATUS_BAR, statusBar);
+ return this;
}
/**
* Gets the String value of the MediaClock
@@ -422,7 +428,7 @@ public class Show extends RPCRequest { /**
* Sets the value for the MediaClock field using a format described in the
* MediaClockFormat enumeration
- *
+ *
* @param mediaClock
* a String value for the MdaiaClock
* <p></p>
@@ -436,8 +442,9 @@ public class Show extends RPCRequest { * </ul>
*/
@Deprecated
- public void setMediaClock(String mediaClock) {
- setParameters(KEY_MEDIA_CLOCK, mediaClock);
+ public Show setMediaClock( String mediaClock) {
+ setParameters(KEY_MEDIA_CLOCK, mediaClock);
+ return this;
}
/**
* Gets the text in the track field
@@ -449,7 +456,7 @@ public class Show extends RPCRequest { }
/**
* Sets the text in the track field
- *
+ *
* @param mediaTrack
* a String value displayed in the track field
* <p></p>
@@ -459,14 +466,15 @@ public class Show extends RPCRequest { * <li>If an empty string is provided, the field will be cleared</li>
* <li>This field is only valid for media applications on navigation displays</li>
* </ul>
- */
- public void setMediaTrack(String mediaTrack) {
- setParameters(KEY_MEDIA_TRACK, mediaTrack);
+ */
+ public Show setMediaTrack( String mediaTrack) {
+ setParameters(KEY_MEDIA_TRACK, mediaTrack);
+ return this;
}
/**
* Sets an image to be shown on supported displays
- *
+ *
* @param graphic
* the value representing the image shown on supported displays
* <p></p>
@@ -474,8 +482,9 @@ public class Show extends RPCRequest { * graphic shall not change
* @since SmartDeviceLink 2.0
*/
- public void setGraphic(Image graphic) {
- setParameters(KEY_GRAPHIC, graphic);
+ public Show setGraphic( Image graphic) {
+ setParameters(KEY_GRAPHIC, graphic);
+ return this;
}
/**
@@ -491,8 +500,9 @@ public class Show extends RPCRequest { }
- public void setSecondaryGraphic(Image secondaryGraphic) {
- setParameters(KEY_SECONDARY_GRAPHIC, secondaryGraphic);
+ public Show setSecondaryGraphic( Image secondaryGraphic) {
+ setParameters(KEY_SECONDARY_GRAPHIC, secondaryGraphic);
+ return this;
}
@@ -516,7 +526,7 @@ public class Show extends RPCRequest { /**
* Sets the the Soft buttons defined by the App
- *
+ *
* @param softButtons
* a List value represemting the Soft buttons defined by the
* App
@@ -528,11 +538,12 @@ public class Show extends RPCRequest { * <li>Array Minsize: 0</li>
* <li>Array Maxsize: 8</li>
* </ul>
- *
+ *
* @since SmartDeviceLink 2.0
*/
- public void setSoftButtons(List<SoftButton> softButtons) {
- setParameters(KEY_SOFT_BUTTONS, softButtons);
+ public Show setSoftButtons( List<SoftButton> softButtons) {
+ setParameters(KEY_SOFT_BUTTONS, softButtons);
+ return this;
}
/**
@@ -549,7 +560,7 @@ public class Show extends RPCRequest { /**
* Sets the Custom Presets defined by the App
- *
+ *
* @param customPresets
* a List value representing the Custom Presets defined by the
* App
@@ -561,8 +572,9 @@ public class Show extends RPCRequest { * </ul>
* @since SmartDeviceLink 2.0
*/
- public void setCustomPresets(List<String> customPresets) {
- setParameters(KEY_CUSTOM_PRESETS, customPresets);
+ public Show setCustomPresets( List<String> customPresets) {
+ setParameters(KEY_CUSTOM_PRESETS, customPresets);
+ return this;
}
/**
@@ -574,9 +586,10 @@ public class Show extends RPCRequest { * <ul>
* @since SmartDeviceLink 4.5.0
*/
- public void setMetadataTags(MetadataTags metadataTags){
- setParameters(KEY_METADATA_TAGS, metadataTags);
- }
+ public Show setMetadataTags( MetadataTags metadataTags) {
+ setParameters(KEY_METADATA_TAGS, metadataTags);
+ return this;
+ }
/**
* Gets text field metadata defined by the App
@@ -599,9 +612,10 @@ public class Show extends RPCRequest { *
* @since 6.0
*/
- public void setWindowID(Integer windowID) {
- setParameters(KEY_WINDOW_ID, windowID);
- }
+ public Show setWindowID( Integer windowID) {
+ setParameters(KEY_WINDOW_ID, windowID);
+ return this;
+ }
/**
* Gets the windowID.
@@ -628,9 +642,10 @@ public class Show extends RPCRequest { * Sets the templateConfiguration. It's used to set an alternate template layout to a window.
* @param templateConfiguration
*/
- public void setTemplateConfiguration(TemplateConfiguration templateConfiguration) {
- setParameters(KEY_TEMPLATE_CONFIGURATION, templateConfiguration);
- }
+ public Show setTemplateConfiguration( TemplateConfiguration templateConfiguration) {
+ setParameters(KEY_TEMPLATE_CONFIGURATION, templateConfiguration);
+ return this;
+ }
/**
* Sets the title of the new template that will be displayed.
@@ -643,9 +658,10 @@ public class Show extends RPCRequest { * </ul>
* @since SmartDeviceLink 6.0.0
*/
- public void setTemplateTitle(String templateTitle){
- setParameters(KEY_TEMPLATE_TITLE, templateTitle);
- }
+ public Show setTemplateTitle( String templateTitle) {
+ setParameters(KEY_TEMPLATE_TITLE, templateTitle);
+ return this;
+ }
/**
* Gets the title of the new template that will be displayed
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/ShowAppMenu.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/ShowAppMenu.java index 6c6c2e7c9..6531427d8 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/ShowAppMenu.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/ShowAppMenu.java @@ -68,9 +68,10 @@ public class ShowAppMenu extends RPCRequest { * previously added using `AddSubMenu`. * @param menuID - The SubMenu ID to open */ - public void setMenuID(Integer menuID){ - setParameters(KEY_MENU_ID, menuID); - } + public ShowAppMenu setMenuID( Integer menuID) { + setParameters(KEY_MENU_ID, menuID); + return this; + } /** * If omitted the HMI opens the apps menu. diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/ShowConstantTbt.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/ShowConstantTbt.java index 43ab3a137..a8e375b8f 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/ShowConstantTbt.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/ShowConstantTbt.java @@ -84,14 +84,15 @@ public class ShowConstantTbt extends RPCRequest{ /** * Sets a text for navigation text field 1 - * + * * @param navigationText1 * a String value representing a text for navigation text field 1 * <p></p> * <b>Notes: </b>Maxlength=500 */ - public void setNavigationText1(String navigationText1){ + public ShowConstantTbt setNavigationText1( String navigationText1) { setParameters(KEY_TEXT1, navigationText1); + return this; } /** @@ -105,14 +106,15 @@ public class ShowConstantTbt extends RPCRequest{ /** * Sets a text for navigation text field 2 - * + * * @param navigationText2 * a String value representing a text for navigation text field 2 * <p></p> * <b>Notes: </b>Maxlength=500 */ - public void setNavigationText2(String navigationText2){ + public ShowConstantTbt setNavigationText2( String navigationText2) { setParameters(KEY_TEXT2, navigationText2); + return this; } /** @@ -126,14 +128,15 @@ public class ShowConstantTbt extends RPCRequest{ /** * Sets a text field for estimated time of arrival - * + * * @param eta * a String value representing a text field for estimated time of arrival * <p></p> * <b>Notes: </b>Maxlength=500 */ - public void setEta(String eta){ + public ShowConstantTbt setEta( String eta) { setParameters(KEY_ETA, eta); + return this; } /** @@ -147,14 +150,15 @@ public class ShowConstantTbt extends RPCRequest{ /** * Sets a text field for total distance - * + * * @param totalDistance * a String value representing a text field for total distance * <p></p> * <b>Notes: </b>Maxlength=500 */ - public void setTotalDistance(String totalDistance){ + public ShowConstantTbt setTotalDistance( String totalDistance) { setParameters(KEY_TOTAL_DISTANCE, totalDistance); + return this; } /** @@ -168,12 +172,13 @@ public class ShowConstantTbt extends RPCRequest{ /** * Sets an Image for turnicon - * + * * @param turnIcon * an Image value */ - public void setTurnIcon(Image turnIcon){ + public ShowConstantTbt setTurnIcon( Image turnIcon) { setParameters(KEY_MANEUVER_IMAGE, turnIcon); + return this; } /** @@ -188,12 +193,13 @@ public class ShowConstantTbt extends RPCRequest{ /** * Sets an Image for nextTurnIcon - * + * * @param nextTurnIcon * an Image value */ - public void setNextTurnIcon(Image nextTurnIcon){ + public ShowConstantTbt setNextTurnIcon( Image nextTurnIcon) { setParameters(KEY_NEXT_MANEUVER_IMAGE, nextTurnIcon); + return this; } /** @@ -208,14 +214,15 @@ public class ShowConstantTbt extends RPCRequest{ /** * Sets a Fraction of distance till next maneuver - * + * * @param distanceToManeuver * a Double value representing a Fraction of distance till next maneuver * <p></p> * <b>Notes: </b>Minvalue=0; Maxvalue=1000000000 */ - public void setDistanceToManeuver(Double distanceToManeuver){ + public ShowConstantTbt setDistanceToManeuver( Double distanceToManeuver) { setParameters(KEY_MANEUVER_DISTANCE, distanceToManeuver); + return this; } /** @@ -229,14 +236,15 @@ public class ShowConstantTbt extends RPCRequest{ /** * Sets a Distance till next maneuver (starting from) from previous maneuver - * + * * @param distanceToManeuverScale * a Double value representing a Distance till next maneuver (starting from) from previous maneuver * <p></p> * <b>Notes: </b>Minvalue=0; Maxvalue=1000000000 */ - public void setDistanceToManeuverScale(Double distanceToManeuverScale){ + public ShowConstantTbt setDistanceToManeuverScale( Double distanceToManeuverScale) { setParameters(KEY_MANEUVER_DISTANCE_SCALE, distanceToManeuverScale); + return this; } /** @@ -252,13 +260,14 @@ public class ShowConstantTbt extends RPCRequest{ * <p>Sets a maneuver complete flag. If and when a maneuver has completed while an AlertManeuver is active, the app * must send this value set to TRUE in order to clear the AlertManeuver overlay * If omitted the value will be assumed as FALSE</p> - * - * + * + * * @param maneuverComplete * a Boolean value */ - public void setManeuverComplete(Boolean maneuverComplete){ + public ShowConstantTbt setManeuverComplete( Boolean maneuverComplete) { setParameters(KEY_MANEUVER_COMPLETE, maneuverComplete); + return this; } /** @@ -273,14 +282,15 @@ public class ShowConstantTbt extends RPCRequest{ /** * <p>Sets Three dynamic SoftButtons available (first SoftButton is fixed to "Turns"). If omitted on supported * displays, the currently displayed SoftButton values will not change</p> - * + * * <p><b>Notes: </b>Minsize=0; Maxsize=3</p> - * + * * @param softButtons * a List<SoftButton> value */ - public void setSoftButtons(List<SoftButton> softButtons){ + public ShowConstantTbt setSoftButtons( List<SoftButton> softButtons) { setParameters(KEY_SOFT_BUTTONS, softButtons); + return this; } /** @@ -294,8 +304,9 @@ public class ShowConstantTbt extends RPCRequest{ return (List<SoftButton>) getObject(SoftButton.class, KEY_SOFT_BUTTONS); } - public void setTimeToDestination(String timeToDestination){ + public ShowConstantTbt setTimeToDestination( String timeToDestination) { setParameters(KEY_TIME_TO_DESTINATION, timeToDestination); + return this; } public String getTimeToDestination(){ diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/SingleTireStatus.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/SingleTireStatus.java index 7a0edfa3c..faadb2406 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/SingleTireStatus.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/SingleTireStatus.java @@ -1,34 +1,34 @@ -/* - * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this - * list of conditions and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following - * disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its - * contributors may be used to endorse or promote products derived from this - * software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ +/*
+ * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
package com.smartdevicelink.proxy.rpc;
import androidx.annotation.NonNull;
@@ -105,8 +105,9 @@ public class SingleTireStatus extends RPCStruct { * set the volume status of a single tire
* @param status the volume status of a single tire
*/
- public void setStatus(@NonNull ComponentVolumeStatus status) {
- setValue(KEY_STATUS, status);
+ public SingleTireStatus setStatus(@NonNull ComponentVolumeStatus status) {
+ setValue(KEY_STATUS, status);
+ return this;
}
/**
@@ -121,7 +122,10 @@ public class SingleTireStatus extends RPCStruct { * Set the status of TPMS according to the particular tire.
* @param tpms The status of TPMS
*/
- public void setTPMS(@NonNull TPMS tpms) { setValue(KEY_TPMS, tpms); }
+ public SingleTireStatus setTPMS(@NonNull TPMS tpms) {
+ setValue(KEY_TPMS, tpms);
+ return this;
+ }
/**
* Get the status of TPMS according to the particular tire.
@@ -134,7 +138,10 @@ public class SingleTireStatus extends RPCStruct { /**
* @param pressure The pressure value of the particular tire in kilo pascal.
*/
- public void setPressure(@NonNull Float pressure) { setValue(KEY_PRESSURE, pressure); }
+ public SingleTireStatus setPressure(@NonNull Float pressure) {
+ setValue(KEY_PRESSURE, pressure);
+ return this;
+ }
/**
* @return the pressure value of the particular tire in kilo pascal.
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/SisData.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/SisData.java index be97e14cd..e25ac69b9 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/SisData.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/SisData.java @@ -63,9 +63,10 @@ public class SisData extends RPCStruct { * * @param stationShortName Identifies the 4-alpha-character station call sign plus an optional (-FM) extension. */ - public void setStationShortName(String stationShortName) { - setValue(KEY_STATION_SHORT_NAME, stationShortName); - } + public SisData setStationShortName( String stationShortName) { + setValue(KEY_STATION_SHORT_NAME, stationShortName); + return this; + } /** * Gets the stationShortName portion of the SisData class @@ -81,9 +82,10 @@ public class SisData extends RPCStruct { * * @param stationIDNumber Consists of Country Code and FCC Facility ID */ - public void setStationIDNumber(StationIDNumber stationIDNumber) { - setValue(KEY_STATION_ID_NUMBER, stationIDNumber); - } + public SisData setStationIDNumber( StationIDNumber stationIDNumber) { + setValue(KEY_STATION_ID_NUMBER, stationIDNumber); + return this; + } /** * Gets the stationIDNumber which is used for network Application. Consists of Country Code and FCC Facility ID @@ -100,9 +102,10 @@ public class SisData extends RPCStruct { * * @param stationLongName Identifies the station call sign or other identifying information in the long format. */ - public void setStationLongName(String stationLongName) { - setValue(KEY_STATION_LONG_NAME, stationLongName); - } + public SisData setStationLongName( String stationLongName) { + setValue(KEY_STATION_LONG_NAME, stationLongName); + return this; + } /** * Gets the stationLongName portion of the SisData class @@ -118,9 +121,10 @@ public class SisData extends RPCStruct { * * @param stationLocation Provides the 3-dimensional geographic station location. */ - public void setStationLocation(GPSData stationLocation) { - setValue(KEY_STATION_LOCATION, stationLocation); - } + public SisData setStationLocation( GPSData stationLocation) { + setValue(KEY_STATION_LOCATION, stationLocation); + return this; + } /** * Gets the stationLocation portion of the SisData class @@ -138,9 +142,10 @@ public class SisData extends RPCStruct { * @param stationMessage May be used to convey textual information of general interest to the consumer such as weather forecasts or public service announcements. * Includes a high priority delivery feature to convey emergencies that may be in the listening area. */ - public void setStationMessage(String stationMessage) { - setValue(KEY_STATION_MESSAGE, stationMessage); - } + public SisData setStationMessage( String stationMessage) { + setValue(KEY_STATION_MESSAGE, stationMessage); + return this; + } /** * Gets the stationMessage portion of the SisData class diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/Slider.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/Slider.java index 374c610fe..0b9f10491 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/Slider.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/Slider.java @@ -168,15 +168,16 @@ public class Slider extends RPCRequest { /**
* Sets a number of selectable items on a horizontal axis
- *
+ *
* @param numTicks
* an Integer value representing a number of selectable items on
* a horizontal axis
* <p></p>
* <b>Notes: </b>Minvalue=2; Maxvalue=26
*/
- public void setNumTicks(@NonNull Integer numTicks) {
- setParameters(KEY_NUM_TICKS, numTicks);
+ public Slider setNumTicks(@NonNull Integer numTicks) {
+ setParameters(KEY_NUM_TICKS, numTicks);
+ return this;
}
/**
@@ -191,15 +192,16 @@ public class Slider extends RPCRequest { /**
* Sets an Initial position of slider control
- *
+ *
* @param position
* an Integer value representing an Initial position of slider
* control
* <p></p>
* <b>Notes: </b>Minvalue=1; Maxvalue=26
*/
- public void setPosition(@NonNull Integer position) {
- setParameters(KEY_POSITION, position);
+ public Slider setPosition(@NonNull Integer position) {
+ setParameters(KEY_POSITION, position);
+ return this;
}
/**
@@ -214,14 +216,15 @@ public class Slider extends RPCRequest { /**
* Sets a text header to display
- *
+ *
* @param sliderHeader
* a String value
* <p></p>
* <b>Notes: </b>Maxlength=500
*/
- public void setSliderHeader(@NonNull String sliderHeader) {
- setParameters(KEY_SLIDER_HEADER, sliderHeader);
+ public Slider setSliderHeader(@NonNull String sliderHeader) {
+ setParameters(KEY_SLIDER_HEADER, sliderHeader);
+ return this;
}
/**
@@ -235,14 +238,15 @@ public class Slider extends RPCRequest { /**
* Sets a text footer to display
- *
+ *
* @param sliderFooter
* a List<String> value representing a text footer to display
* <p></p>
* <b>Notes: </b>Maxlength=500; Minvalue=1; Maxvalue=26
*/
- public void setSliderFooter(List<String> sliderFooter) {
- setParameters(KEY_SLIDER_FOOTER, sliderFooter);
+ public Slider setSliderFooter( List<String> sliderFooter) {
+ setParameters(KEY_SLIDER_FOOTER, sliderFooter);
+ return this;
}
/**
@@ -257,14 +261,15 @@ public class Slider extends RPCRequest { /**
* Sets an App defined timeout
- *
+ *
* @param timeout
* an Integer value representing an App defined timeout
* <p></p>
* <b>Notes: </b>Minvalue=0; Maxvalue=65535; Defvalue=10000
*/
- public void setTimeout(Integer timeout) {
- setParameters(KEY_TIMEOUT, timeout);
+ public Slider setTimeout( Integer timeout) {
+ setParameters(KEY_TIMEOUT, timeout);
+ return this;
}
/**
@@ -293,7 +298,8 @@ public class Slider extends RPCRequest { *
* @since SmartDeviceLink 6.0
*/
- public void setCancelID(Integer cancelID) {
- setParameters(KEY_CANCEL_ID, cancelID);
- }
+ public Slider setCancelID( Integer cancelID) {
+ setParameters(KEY_CANCEL_ID, cancelID);
+ return this;
+ }
}
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/SliderResponse.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/SliderResponse.java index cad93b19b..5f802bd19 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/SliderResponse.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/SliderResponse.java @@ -1,34 +1,34 @@ -/* - * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this - * list of conditions and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following - * disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its - * contributors may be used to endorse or promote products derived from this - * software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ +/*
+ * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
package com.smartdevicelink.proxy.rpc;
import androidx.annotation.NonNull;
@@ -81,8 +81,9 @@ public class SliderResponse extends RPCResponse { * Sets an Initial position of slider control
* @param sliderPosition the starting position of the slider control
*/
- public void setSliderPosition(Integer sliderPosition) {
- setParameters(KEY_SLIDER_POSITION, sliderPosition);
+ public SliderResponse setSliderPosition( Integer sliderPosition) {
+ setParameters(KEY_SLIDER_POSITION, sliderPosition);
+ return this;
}
/**
* Gets an Initial position of slider control
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/SoftButton.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/SoftButton.java index bfafea14e..ef25006da 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/SoftButton.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/SoftButton.java @@ -1,34 +1,34 @@ -/* - * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this - * list of conditions and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following - * disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its - * contributors may be used to endorse or promote products derived from this - * software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ +/*
+ * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
package com.smartdevicelink.proxy.rpc;
import androidx.annotation.NonNull;
@@ -136,39 +136,45 @@ public class SoftButton extends RPCStruct { setSoftButtonID(softButtonID);
}
- public void setType(@NonNull SoftButtonType type) {
+ public SoftButton setType(@NonNull SoftButtonType type) {
setValue(KEY_TYPE, type);
+ return this;
}
public SoftButtonType getType() {
return (SoftButtonType) getObject(SoftButtonType.class, KEY_TYPE);
}
- public void setText(String text) {
+ public SoftButton setText( String text) {
setValue(KEY_TEXT, text);
+ return this;
}
public String getText() {
return getString(KEY_TEXT);
}
- public void setImage(Image image) {
+ public SoftButton setImage( Image image) {
setValue(KEY_IMAGE, image);
+ return this;
}
@SuppressWarnings("unchecked")
public Image getImage() {
return (Image) getObject(Image.class, KEY_IMAGE);
}
- public void setIsHighlighted(Boolean isHighlighted) {
+ public SoftButton setIsHighlighted( Boolean isHighlighted) {
setValue(KEY_IS_HIGHLIGHTED, isHighlighted);
+ return this;
}
public Boolean getIsHighlighted() {
return getBoolean(KEY_IS_HIGHLIGHTED);
}
- public void setSoftButtonID(@NonNull Integer softButtonID) {
+ public SoftButton setSoftButtonID(@NonNull Integer softButtonID) {
setValue(KEY_SOFT_BUTTON_ID, softButtonID);
+ return this;
}
public Integer getSoftButtonID() {
return getInteger(KEY_SOFT_BUTTON_ID);
}
- public void setSystemAction(SystemAction systemAction) {
+ public SoftButton setSystemAction( SystemAction systemAction) {
setValue(KEY_SYSTEM_ACTION, systemAction);
+ return this;
}
public SystemAction getSystemAction() {
return (SystemAction) getObject(SystemAction.class, KEY_SYSTEM_ACTION);
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/SoftButtonCapabilities.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/SoftButtonCapabilities.java index bdd2a0b9b..baac6ecda 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/SoftButtonCapabilities.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/SoftButtonCapabilities.java @@ -131,8 +131,9 @@ public class SoftButtonCapabilities extends RPCStruct { * set the button supports a short press.
* @param shortPressAvailable whether the button supports a short press.
*/
- public void setShortPressAvailable(@NonNull Boolean shortPressAvailable) {
+ public SoftButtonCapabilities setShortPressAvailable(@NonNull Boolean shortPressAvailable) {
setValue(KEY_SHORT_PRESS_AVAILABLE, shortPressAvailable);
+ return this;
}
/**
@@ -147,8 +148,9 @@ public class SoftButtonCapabilities extends RPCStruct { * set the button supports a LONG press.
* @param longPressAvailable whether the button supports a long press
*/
- public void setLongPressAvailable(@NonNull Boolean longPressAvailable) {
+ public SoftButtonCapabilities setLongPressAvailable(@NonNull Boolean longPressAvailable) {
setValue(KEY_LONG_PRESS_AVAILABLE, longPressAvailable);
+ return this;
}
/**
@@ -160,11 +162,12 @@ public class SoftButtonCapabilities extends RPCStruct { }
/**
- * set the button supports "button down" and "button up".
- * @param upDownAvailable the button supports "button down" and "button up".
+ * set the button supports "button down" and "button up".
+ * @param upDownAvailable the button supports "button down" and "button up".
*/
- public void setUpDownAvailable(@NonNull Boolean upDownAvailable) {
+ public SoftButtonCapabilities setUpDownAvailable(@NonNull Boolean upDownAvailable) {
setValue(KEY_UP_DOWN_AVAILABLE, upDownAvailable);
+ return this;
}
/**
@@ -179,8 +182,9 @@ public class SoftButtonCapabilities extends RPCStruct { * set the button supports referencing a static or dynamic image.
* @param imageSupported whether the button supports referencing a static or dynamic image.
*/
- public void setImageSupported(@NonNull Boolean imageSupported) {
+ public SoftButtonCapabilities setImageSupported(@NonNull Boolean imageSupported) {
setValue(KEY_IMAGE_SUPPORTED, imageSupported);
+ return this;
}
/**
@@ -196,8 +200,9 @@ public class SoftButtonCapabilities extends RPCStruct { * @param textSupported whether the button supports the use of text or not.
* @since 6.0
*/
- public void setTextSupported(Boolean textSupported) {
+ public SoftButtonCapabilities setTextSupported( Boolean textSupported) {
setValue(KEY_TEXT_SUPPORTED, textSupported);
+ return this;
}
/**
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/Speak.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/Speak.java index a0c66a99f..d48e6e757 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/Speak.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/Speak.java @@ -1,34 +1,34 @@ -/* - * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this - * list of conditions and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following - * disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its - * contributors may be used to endorse or promote products derived from this - * software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ +/*
+ * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
package com.smartdevicelink.proxy.rpc;
import androidx.annotation.NonNull;
@@ -180,7 +180,7 @@ public class Speak extends RPCRequest { /**
* Sets a List<TTSChunk> representing an array of 1-100 TTSChunk structs
* which, taken together, specify the phrase to be spoken
- *
+ *
* @param ttsChunks
* a List<TTSChunk> value representing an array of 1-100 TTSChunk structs
* which specify the phrase to be spoken
@@ -192,8 +192,9 @@ public class Speak extends RPCRequest { * be rejected</li>
* <li>Each chunk can be no more than 500 characters</li>
* </ul>
- */
- public void setTtsChunks( @NonNull List<TTSChunk> ttsChunks ) {
- setParameters(KEY_TTS_CHUNKS, ttsChunks);
+ */
+ public Speak setTtsChunks(@NonNull List<TTSChunk> ttsChunks) {
+ setParameters(KEY_TTS_CHUNKS, ttsChunks);
+ return this;
}
}
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/StabilityControlsStatus.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/StabilityControlsStatus.java index 5ee5eb0b4..78eb84149 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/StabilityControlsStatus.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/StabilityControlsStatus.java @@ -101,8 +101,9 @@ public class StabilityControlsStatus extends RPCStruct { * * @param escSystem true if vehicle stability control is ON, else false */ - public void setEscSystem(VehicleDataStatus escSystem) { + public StabilityControlsStatus setEscSystem( VehicleDataStatus escSystem) { setValue(KEY_ESC_SYSTEM, escSystem); + return this; } /** @@ -110,8 +111,9 @@ public class StabilityControlsStatus extends RPCStruct { * * @param trailerSwayControl true if vehicle trailer sway control is ON, else false */ - public void setTrailerSwayControl(VehicleDataStatus trailerSwayControl) { + public StabilityControlsStatus setTrailerSwayControl( VehicleDataStatus trailerSwayControl) { setValue(KEY_TRAILER_SWAY_CONTROL, trailerSwayControl); + return this; } /** diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/StartTime.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/StartTime.java index 96060d535..fd7f640bf 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/StartTime.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/StartTime.java @@ -1,34 +1,34 @@ -/* - * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this - * list of conditions and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following - * disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its - * contributors may be used to endorse or promote products derived from this - * software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ +/*
+ * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
package com.smartdevicelink.proxy.rpc;
import androidx.annotation.NonNull;
@@ -124,9 +124,10 @@ public class StartTime extends RPCStruct { * Set the hour. Minvalue="0", maxvalue="59"
* <p><b>Note:</b></p>Some display types only support a max value of 19. If out of range, it will be rejected.
* @param hours min: 0; max: 59
- */
- public void setHours(@NonNull Integer hours ) {
+ */
+ public StartTime setHours(@NonNull Integer hours) {
setValue(KEY_HOURS, hours);
+ return this;
}
/**
* Get the minute. Minvalue="0", maxvalue="59".
@@ -138,9 +139,10 @@ public class StartTime extends RPCStruct { /**
* Set the minute. Minvalue="0", maxvalue="59".
* @param minutes min: 0; max: 59
- */
- public void setMinutes( @NonNull Integer minutes ) {
+ */
+ public StartTime setMinutes(@NonNull Integer minutes) {
setValue(KEY_MINUTES, minutes);
+ return this;
}
/**
* Get the second. Minvalue="0", maxvalue="59".
@@ -152,8 +154,9 @@ public class StartTime extends RPCStruct { /**
* Set the second. Minvalue="0", maxvalue="59".
* @param seconds min: 0 max: 59
- */
- public void setSeconds( @NonNull Integer seconds ) {
+ */
+ public StartTime setSeconds(@NonNull Integer seconds) {
setValue(KEY_SECONDS, seconds);
+ return this;
}
}
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/StationIDNumber.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/StationIDNumber.java index b75cb3752..fd0365e66 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/StationIDNumber.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/StationIDNumber.java @@ -51,9 +51,10 @@ public class StationIDNumber extends RPCStruct { * * @param countryCode Binary Representation of ITU Country Code. USA Code is 001. */ - public void setCountryCode(Integer countryCode) { - setValue(KEY_COUNTRY_CODE, countryCode); - } + public StationIDNumber setCountryCode( Integer countryCode) { + setValue(KEY_COUNTRY_CODE, countryCode); + return this; + } /** * Gets the countryCode portion of the StationIDNumber class @@ -69,9 +70,10 @@ public class StationIDNumber extends RPCStruct { * * @param fccFacilityId Binary representation of unique facility ID assigned by the FCC; FCC controlled for U.S. territory. */ - public void setFccFacilityId(Integer fccFacilityId) { - setValue(KEY_FCC_FACILITY_ID, fccFacilityId); - } + public StationIDNumber setFccFacilityId( Integer fccFacilityId) { + setValue(KEY_FCC_FACILITY_ID, fccFacilityId); + return this; + } /** * Gets the fccFacilityId portion of the StationIDNumber class diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/SubscribeButton.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/SubscribeButton.java index 3c830dd61..171c4b18e 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/SubscribeButton.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/SubscribeButton.java @@ -1,34 +1,34 @@ -/* - * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this - * list of conditions and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following - * disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its - * contributors may be used to endorse or promote products derived from this - * software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ +/*
+ * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
package com.smartdevicelink.proxy.rpc;
import androidx.annotation.NonNull;
@@ -144,9 +144,10 @@ public class SubscribeButton extends RPCRequest { }
/**
* Sets a name of the button to subscribe to
- * @param buttonName a <i>{@linkplain com.smartdevicelink.proxy.rpc.enums.ButtonName}</i> value
- */
- public void setButtonName(@NonNull ButtonName buttonName ) {
+ * @param buttonName a <i>{@linkplain ButtonName}</i> value
+ */
+ public SubscribeButton setButtonName(@NonNull ButtonName buttonName) {
setParameters(KEY_BUTTON_NAME, buttonName);
+ return this;
}
}
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/SubscribeVehicleData.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/SubscribeVehicleData.java index 20822e451..7dbbbc247 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/SubscribeVehicleData.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/SubscribeVehicleData.java @@ -391,12 +391,13 @@ public class SubscribeVehicleData extends RPCRequest { /**
* Sets a boolean value. If true, subscribes Gps data
- *
+ *
* @param gps
* a boolean value
*/
- public void setGps(Boolean gps) {
- setParameters(KEY_GPS, gps);
+ public SubscribeVehicleData setGps( Boolean gps) {
+ setParameters(KEY_GPS, gps);
+ return this;
}
/**
@@ -411,12 +412,13 @@ public class SubscribeVehicleData extends RPCRequest { /**
* Sets a boolean value. If true, subscribes speed data
- *
+ *
* @param speed
* a boolean value
*/
- public void setSpeed(Boolean speed) {
- setParameters(KEY_SPEED, speed);
+ public SubscribeVehicleData setSpeed( Boolean speed) {
+ setParameters(KEY_SPEED, speed);
+ return this;
}
/**
@@ -431,12 +433,13 @@ public class SubscribeVehicleData extends RPCRequest { /**
* Sets a boolean value. If true, subscribes rpm data
- *
+ *
* @param rpm
* a boolean value
*/
- public void setRpm(Boolean rpm) {
- setParameters(KEY_RPM, rpm);
+ public SubscribeVehicleData setRpm( Boolean rpm) {
+ setParameters(KEY_RPM, rpm);
+ return this;
}
/**
@@ -451,13 +454,14 @@ public class SubscribeVehicleData extends RPCRequest { /**
* Sets the fuelLevel.
- *
+ *
* @param fuelLevel The fuel level in the tank (percentage). This parameter is deprecated starting RPC Spec
* 7.0, please see fuelRange.
*/
@Deprecated
- public void setFuelLevel(Boolean fuelLevel) {
- setParameters(KEY_FUEL_LEVEL, fuelLevel);
+ public SubscribeVehicleData setFuelLevel( Boolean fuelLevel) {
+ setParameters(KEY_FUEL_LEVEL, fuelLevel);
+ return this;
}
/**
@@ -473,13 +477,14 @@ public class SubscribeVehicleData extends RPCRequest { /**
* Sets a boolean value. If true, subscribes fuelLevelState data
- *
+ *
* @param fuelLevelState
* a boolean value
*/
@Deprecated
- public void setFuelLevelState(Boolean fuelLevelState) {
- setParameters(KEY_FUEL_LEVEL_STATE, fuelLevelState);
+ public SubscribeVehicleData setFuelLevelState( Boolean fuelLevelState) {
+ setParameters(KEY_FUEL_LEVEL_STATE, fuelLevelState);
+ return this;
}
/**
@@ -496,12 +501,13 @@ public class SubscribeVehicleData extends RPCRequest { /**
* Sets a boolean value. If true, subscribes instantFuelConsumption data
- *
+ *
* @param instantFuelConsumption
* a boolean value
*/
- public void setInstantFuelConsumption(Boolean instantFuelConsumption) {
- setParameters(KEY_INSTANT_FUEL_CONSUMPTION, instantFuelConsumption);
+ public SubscribeVehicleData setInstantFuelConsumption( Boolean instantFuelConsumption) {
+ setParameters(KEY_INSTANT_FUEL_CONSUMPTION, instantFuelConsumption);
+ return this;
}
/**
@@ -517,12 +523,13 @@ public class SubscribeVehicleData extends RPCRequest { /**
* Sets a boolean value. If true, subscribes externalTemperature data
- *
+ *
* @param externalTemperature
* a boolean value
*/
- public void setExternalTemperature(Boolean externalTemperature) {
- setParameters(KEY_EXTERNAL_TEMPERATURE, externalTemperature);
+ public SubscribeVehicleData setExternalTemperature( Boolean externalTemperature) {
+ setParameters(KEY_EXTERNAL_TEMPERATURE, externalTemperature);
+ return this;
}
/**
@@ -542,8 +549,9 @@ public class SubscribeVehicleData extends RPCRequest { * @param gearStatus See GearStatus
* @since SmartDeviceLink 7.0.0
*/
- public void setGearStatus(Boolean gearStatus) {
+ public SubscribeVehicleData setGearStatus( Boolean gearStatus) {
setParameters(KEY_GEAR_STATUS, gearStatus);
+ return this;
}
/**
@@ -563,8 +571,9 @@ public class SubscribeVehicleData extends RPCRequest { * @deprecated in SmartDeviceLink 7.0.0
*/
@Deprecated
- public void setPrndl(Boolean prndl) {
- setParameters(KEY_PRNDL, prndl);
+ public SubscribeVehicleData setPrndl( Boolean prndl) {
+ setParameters(KEY_PRNDL, prndl);
+ return this;
}
/**
@@ -580,12 +589,13 @@ public class SubscribeVehicleData extends RPCRequest { /**
* Sets a boolean value. If true, subscribes tire pressure status data
- *
+ *
* @param tirePressure
* a boolean value
*/
- public void setTirePressure(Boolean tirePressure) {
- setParameters(KEY_TIRE_PRESSURE, tirePressure);
+ public SubscribeVehicleData setTirePressure( Boolean tirePressure) {
+ setParameters(KEY_TIRE_PRESSURE, tirePressure);
+ return this;
}
/**
@@ -601,12 +611,13 @@ public class SubscribeVehicleData extends RPCRequest { /**
* Sets a boolean value. If true, subscribes odometer data
- *
+ *
* @param odometer
* a boolean value
*/
- public void setOdometer(Boolean odometer) {
- setParameters(KEY_ODOMETER, odometer);
+ public SubscribeVehicleData setOdometer( Boolean odometer) {
+ setParameters(KEY_ODOMETER, odometer);
+ return this;
}
/**
@@ -622,12 +633,13 @@ public class SubscribeVehicleData extends RPCRequest { /**
* Sets a boolean value. If true, subscribes belt Status data
- *
+ *
* @param beltStatus
* a boolean value
*/
- public void setBeltStatus(Boolean beltStatus) {
- setParameters(KEY_BELT_STATUS, beltStatus);
+ public SubscribeVehicleData setBeltStatus( Boolean beltStatus) {
+ setParameters(KEY_BELT_STATUS, beltStatus);
+ return this;
}
/**
@@ -643,12 +655,13 @@ public class SubscribeVehicleData extends RPCRequest { /**
* Sets a boolean value. If true, subscribes body Information data
- *
+ *
* @param bodyInformation
* a boolean value
*/
- public void setBodyInformation(Boolean bodyInformation) {
- setParameters(KEY_BODY_INFORMATION, bodyInformation);
+ public SubscribeVehicleData setBodyInformation( Boolean bodyInformation) {
+ setParameters(KEY_BODY_INFORMATION, bodyInformation);
+ return this;
}
/**
@@ -664,12 +677,13 @@ public class SubscribeVehicleData extends RPCRequest { /**
* Sets a boolean value. If true, subscribes device Status data
- *
+ *
* @param deviceStatus
* a boolean value
*/
- public void setDeviceStatus(Boolean deviceStatus) {
- setParameters(KEY_DEVICE_STATUS, deviceStatus);
+ public SubscribeVehicleData setDeviceStatus( Boolean deviceStatus) {
+ setParameters(KEY_DEVICE_STATUS, deviceStatus);
+ return this;
}
/**
@@ -685,12 +699,13 @@ public class SubscribeVehicleData extends RPCRequest { /**
* Sets a boolean value. If true, subscribes driver Braking data
- *
+ *
* @param driverBraking
* a boolean value
*/
- public void setDriverBraking(Boolean driverBraking) {
- setParameters(KEY_DRIVER_BRAKING, driverBraking);
+ public SubscribeVehicleData setDriverBraking( Boolean driverBraking) {
+ setParameters(KEY_DRIVER_BRAKING, driverBraking);
+ return this;
}
/**
@@ -706,12 +721,13 @@ public class SubscribeVehicleData extends RPCRequest { /**
* Sets a boolean value. If true, subscribes wiper Status data
- *
+ *
* @param wiperStatus
* a boolean value
*/
- public void setWiperStatus(Boolean wiperStatus) {
- setParameters(KEY_WIPER_STATUS, wiperStatus);
+ public SubscribeVehicleData setWiperStatus( Boolean wiperStatus) {
+ setParameters(KEY_WIPER_STATUS, wiperStatus);
+ return this;
}
/**
@@ -727,12 +743,13 @@ public class SubscribeVehicleData extends RPCRequest { /**
* Sets a boolean value. If true, subscribes Head Lamp Status data
- *
+ *
* @param headLampStatus
* a boolean value
*/
- public void setHeadLampStatus(Boolean headLampStatus) {
- setParameters(KEY_HEAD_LAMP_STATUS, headLampStatus);
+ public SubscribeVehicleData setHeadLampStatus( Boolean headLampStatus) {
+ setParameters(KEY_HEAD_LAMP_STATUS, headLampStatus);
+ return this;
}
/**
@@ -752,9 +769,10 @@ public class SubscribeVehicleData extends RPCRequest { * @param engineTorque
* a boolean value
*/
- public void setEngineTorque(Boolean engineTorque) {
- setParameters(KEY_ENGINE_TORQUE, engineTorque);
- }
+ public SubscribeVehicleData setEngineTorque( Boolean engineTorque) {
+ setParameters(KEY_ENGINE_TORQUE, engineTorque);
+ return this;
+ }
/**
* Gets a boolean value. If true, means the Engine Oil Life data has been
@@ -773,9 +791,10 @@ public class SubscribeVehicleData extends RPCRequest { * @param engineOilLife
* a boolean value
*/
- public void setEngineOilLife(Boolean engineOilLife) {
- setParameters(KEY_ENGINE_OIL_LIFE, engineOilLife);
- }
+ public SubscribeVehicleData setEngineOilLife( Boolean engineOilLife) {
+ setParameters(KEY_ENGINE_OIL_LIFE, engineOilLife);
+ return this;
+ }
/**
* Gets a boolean value. If true, means the Engine Torque data has been
@@ -794,8 +813,9 @@ public class SubscribeVehicleData extends RPCRequest { * @param accPedalPosition
* a boolean value
*/
- public void setAccPedalPosition(Boolean accPedalPosition) {
- setParameters(KEY_ACC_PEDAL_POSITION, accPedalPosition);
+ public SubscribeVehicleData setAccPedalPosition( Boolean accPedalPosition) {
+ setParameters(KEY_ACC_PEDAL_POSITION, accPedalPosition);
+ return this;
}
/**
@@ -809,39 +829,45 @@ public class SubscribeVehicleData extends RPCRequest { return getBoolean(KEY_ACC_PEDAL_POSITION);
}
- public void setSteeringWheelAngle(Boolean steeringWheelAngle) {
- setParameters(KEY_STEERING_WHEEL_ANGLE, steeringWheelAngle);
+ public SubscribeVehicleData setSteeringWheelAngle( Boolean steeringWheelAngle) {
+ setParameters(KEY_STEERING_WHEEL_ANGLE, steeringWheelAngle);
+ return this;
}
public Boolean getSteeringWheelAngle() {
return getBoolean(KEY_STEERING_WHEEL_ANGLE);
}
- public void setECallInfo(Boolean eCallInfo) {
- setParameters(KEY_E_CALL_INFO, eCallInfo);
+ public SubscribeVehicleData setECallInfo( Boolean eCallInfo) {
+ setParameters(KEY_E_CALL_INFO, eCallInfo);
+ return this;
}
public Boolean getECallInfo() {
return getBoolean(KEY_E_CALL_INFO);
}
- public void setAirbagStatus(Boolean airbagStatus) {
- setParameters(KEY_AIRBAG_STATUS, airbagStatus);
+ public SubscribeVehicleData setAirbagStatus( Boolean airbagStatus) {
+ setParameters(KEY_AIRBAG_STATUS, airbagStatus);
+ return this;
}
public Boolean getAirbagStatus() {
return getBoolean(KEY_AIRBAG_STATUS);
}
- public void setEmergencyEvent(Boolean emergencyEvent) {
- setParameters(KEY_EMERGENCY_EVENT, emergencyEvent);
+ public SubscribeVehicleData setEmergencyEvent( Boolean emergencyEvent) {
+ setParameters(KEY_EMERGENCY_EVENT, emergencyEvent);
+ return this;
}
public Boolean getEmergencyEvent() {
return getBoolean(KEY_EMERGENCY_EVENT);
}
- public void setClusterModeStatus(Boolean clusterModeStatus) {
- setParameters(KEY_CLUSTER_MODE_STATUS, clusterModeStatus);
+ public SubscribeVehicleData setClusterModeStatus( Boolean clusterModeStatus) {
+ setParameters(KEY_CLUSTER_MODE_STATUS, clusterModeStatus);
+ return this;
}
public Boolean getClusterModeStatus() {
return getBoolean(KEY_CLUSTER_MODE_STATUS);
}
- public void setMyKey(Boolean myKey) {
- setParameters(KEY_MY_KEY, myKey);
+ public SubscribeVehicleData setMyKey( Boolean myKey) {
+ setParameters(KEY_MY_KEY, myKey);
+ return this;
}
public Boolean getMyKey() {
return getBoolean(KEY_MY_KEY);
@@ -854,9 +880,10 @@ public class SubscribeVehicleData extends RPCRequest { * vehicle. See struct FuelRange for details.
* @since SmartDeviceLink 5.0.0
*/
- public void setFuelRange(Boolean fuelRange) {
- setParameters(KEY_FUEL_RANGE, fuelRange);
- }
+ public SubscribeVehicleData setFuelRange( Boolean fuelRange) {
+ setParameters(KEY_FUEL_RANGE, fuelRange);
+ return this;
+ }
/**
* Gets the fuelRange.
@@ -873,7 +900,10 @@ public class SubscribeVehicleData extends RPCRequest { * Sets a boolean value. If true, subscribes turnSignal data
* @param turnSignal a boolean value
*/
- public void setTurnSignal(Boolean turnSignal) { setParameters(KEY_TURN_SIGNAL, turnSignal); }
+ public SubscribeVehicleData setTurnSignal( Boolean turnSignal) {
+ setParameters(KEY_TURN_SIGNAL, turnSignal);
+ return this;
+ }
/**
* Gets a boolean value. If true, means the turnSignal data has been subscribed.
@@ -885,9 +915,10 @@ public class SubscribeVehicleData extends RPCRequest { * Sets a boolean value. If true, subscribes electronicParkBrakeStatus data
* @param electronicParkBrakeStatus a boolean value
*/
- public void setElectronicParkBrakeStatus(boolean electronicParkBrakeStatus){
- setParameters(KEY_ELECTRONIC_PARK_BRAKE_STATUS, electronicParkBrakeStatus);
- }
+ public SubscribeVehicleData setElectronicParkBrakeStatus( boolean electronicParkBrakeStatus) {
+ setParameters(KEY_ELECTRONIC_PARK_BRAKE_STATUS, electronicParkBrakeStatus);
+ return this;
+ }
/**
* Gets a boolean value. If true, means the electronicParkBrakeStatus data has been subscribed.
@@ -901,9 +932,10 @@ public class SubscribeVehicleData extends RPCRequest { * Sets a boolean value. If true, subscribes cloudAppVehicleID data
* @param cloudAppVehicleID a boolean value
*/
- public void setCloudAppVehicleID(boolean cloudAppVehicleID){
- setParameters(KEY_CLOUD_APP_VEHICLE_ID, cloudAppVehicleID);
- }
+ public SubscribeVehicleData setCloudAppVehicleID( boolean cloudAppVehicleID) {
+ setParameters(KEY_CLOUD_APP_VEHICLE_ID, cloudAppVehicleID);
+ return this;
+ }
/**
* Gets a boolean value. If true, means the cloudAppVehicleDataID data has been subscribed.
@@ -918,9 +950,10 @@ public class SubscribeVehicleData extends RPCRequest { * @param vehicleDataName a String value
* @param vehicleDataState a boolean value
*/
- public void setOEMCustomVehicleData(String vehicleDataName, Boolean vehicleDataState){
- setParameters(vehicleDataName, vehicleDataState);
- }
+ public SubscribeVehicleData setOEMCustomVehicleData( String vehicleDataName, Boolean vehicleDataState) {
+ setParameters(vehicleDataName, vehicleDataState);
+ return this;
+ }
/**
* Gets a boolean value for OEM Custom VehicleData.
@@ -936,8 +969,9 @@ public class SubscribeVehicleData extends RPCRequest { * @param windowStatus See WindowStatus
* @since SmartDeviceLink 7.0.0
*/
- public void setWindowStatus(Boolean windowStatus) {
+ public SubscribeVehicleData setWindowStatus( Boolean windowStatus) {
setParameters(KEY_WINDOW_STATUS, windowStatus);
+ return this;
}
/**
@@ -956,8 +990,9 @@ public class SubscribeVehicleData extends RPCRequest { * @param handsOffSteering To indicate whether driver hands are off the steering wheel
* @since SmartDeviceLink 7.0.0
*/
- public void setHandsOffSteering(Boolean handsOffSteering) {
+ public SubscribeVehicleData setHandsOffSteering( Boolean handsOffSteering) {
setParameters(KEY_HANDS_OFF_STEERING, handsOffSteering);
+ return this;
}
/**
@@ -986,7 +1021,8 @@ public class SubscribeVehicleData extends RPCRequest { * @param stabilityControlsStatus See StabilityControlsStatus
* @since SmartDeviceLink 7.0.0
*/
- public void setStabilityControlsStatus(Boolean stabilityControlsStatus) {
+ public SubscribeVehicleData setStabilityControlsStatus( Boolean stabilityControlsStatus) {
setParameters(KEY_STABILITY_CONTROLS_STATUS, stabilityControlsStatus);
+ return this;
}
}
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/SubscribeVehicleDataResponse.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/SubscribeVehicleDataResponse.java index 670687814..dfe668f66 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/SubscribeVehicleDataResponse.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/SubscribeVehicleDataResponse.java @@ -118,8 +118,9 @@ public class SubscribeVehicleDataResponse extends RPCResponse { * Sets Gps
* @param gps a VehicleDataResult related to GPS
*/
- public void setGps(VehicleDataResult gps) {
+ public SubscribeVehicleDataResponse setGps( VehicleDataResult gps) {
setParameters(KEY_GPS, gps);
+ return this;
}
/**
* Gets Gps
@@ -133,8 +134,9 @@ public class SubscribeVehicleDataResponse extends RPCResponse { * Sets Speed
* @param speed a VehicleDataResult related to speed
*/
- public void setSpeed(VehicleDataResult speed) {
+ public SubscribeVehicleDataResponse setSpeed( VehicleDataResult speed) {
setParameters(KEY_SPEED, speed);
+ return this;
}
/**
* Gets Speed
@@ -148,8 +150,9 @@ public class SubscribeVehicleDataResponse extends RPCResponse { * Sets rpm
* @param rpm a VehicleDataResult related to RPM
*/
- public void setRpm(VehicleDataResult rpm) {
+ public SubscribeVehicleDataResponse setRpm( VehicleDataResult rpm) {
setParameters(KEY_RPM, rpm);
+ return this;
}
/**
* Gets rpm
@@ -166,8 +169,9 @@ public class SubscribeVehicleDataResponse extends RPCResponse { * 7.0, please see fuelRange.
*/
@Deprecated
- public void setFuelLevel(VehicleDataResult fuelLevel) {
+ public SubscribeVehicleDataResponse setFuelLevel( VehicleDataResult fuelLevel) {
setParameters(KEY_FUEL_LEVEL, fuelLevel);
+ return this;
}
/**
* Gets the fuelLevel.
@@ -185,8 +189,9 @@ public class SubscribeVehicleDataResponse extends RPCResponse { * @param fuelLevelState a VehicleDataResult related to FuelLevel State
*/
@Deprecated
- public void setFuelLevelState(VehicleDataResult fuelLevelState) {
+ public SubscribeVehicleDataResponse setFuelLevelState( VehicleDataResult fuelLevelState) {
setParameters(KEY_FUEL_LEVEL_STATE, fuelLevelState);
+ return this;
}
/**
* Gets Fuel Level State
@@ -201,8 +206,9 @@ public class SubscribeVehicleDataResponse extends RPCResponse { * Sets Instant Fuel Consumption
* @param instantFuelConsumption a VehicleDataResult related to instant fuel consumption
*/
- public void setInstantFuelConsumption(VehicleDataResult instantFuelConsumption) {
+ public SubscribeVehicleDataResponse setInstantFuelConsumption( VehicleDataResult instantFuelConsumption) {
setParameters(KEY_INSTANT_FUEL_CONSUMPTION, instantFuelConsumption);
+ return this;
}
/**
* Gets Instant Fuel Consumption
@@ -216,8 +222,9 @@ public class SubscribeVehicleDataResponse extends RPCResponse { * Sets External Temperature
* @param externalTemperature a VehicleDataResult related to external temperature
*/
- public void setExternalTemperature(VehicleDataResult externalTemperature) {
+ public SubscribeVehicleDataResponse setExternalTemperature( VehicleDataResult externalTemperature) {
setParameters(KEY_EXTERNAL_TEMPERATURE, externalTemperature);
+ return this;
}
/**
* Gets External Temperature
@@ -234,8 +241,9 @@ public class SubscribeVehicleDataResponse extends RPCResponse { * @deprecated in SmartDeviceLink 7.0.0
*/
@Deprecated
- public void setPrndl(VehicleDataResult prndl) {
+ public SubscribeVehicleDataResponse setPrndl( VehicleDataResult prndl) {
setParameters(KEY_PRNDL, prndl);
+ return this;
}
/**
* Gets the prndl.
@@ -252,8 +260,9 @@ public class SubscribeVehicleDataResponse extends RPCResponse { * Sets Tire Pressure
* @param tirePressure a VehicleDataResult related to tire pressure
*/
- public void setTirePressure(VehicleDataResult tirePressure) {
+ public SubscribeVehicleDataResponse setTirePressure( VehicleDataResult tirePressure) {
setParameters(KEY_TIRE_PRESSURE, tirePressure);
+ return this;
}
/**
* Gets Tire Pressure
@@ -267,8 +276,9 @@ public class SubscribeVehicleDataResponse extends RPCResponse { * Sets Odometer
* @param odometer a VehicleDataResult related to the odometer
*/
- public void setOdometer(VehicleDataResult odometer) {
+ public SubscribeVehicleDataResponse setOdometer( VehicleDataResult odometer) {
setParameters(KEY_ODOMETER, odometer);
+ return this;
}
/**
* Gets Odometer
@@ -282,8 +292,9 @@ public class SubscribeVehicleDataResponse extends RPCResponse { * Sets Belt Status
* @param beltStatus a VehicleDataResult related to the seat belt status
*/
- public void setBeltStatus(VehicleDataResult beltStatus) {
+ public SubscribeVehicleDataResponse setBeltStatus( VehicleDataResult beltStatus) {
setParameters(KEY_BELT_STATUS, beltStatus);
+ return this;
}
/**
* Gets Belt Status
@@ -297,8 +308,9 @@ public class SubscribeVehicleDataResponse extends RPCResponse { * Sets Body Information
* @param bodyInformation a VehicleDataResult related to the body info
*/
- public void setBodyInformation(VehicleDataResult bodyInformation) {
+ public SubscribeVehicleDataResponse setBodyInformation( VehicleDataResult bodyInformation) {
setParameters(KEY_BODY_INFORMATION, bodyInformation);
+ return this;
}
/**
* Gets Body Information
@@ -312,8 +324,9 @@ public class SubscribeVehicleDataResponse extends RPCResponse { * Sets Device Status
* @param deviceStatus a VehicleDataResult related to the device status of the connected device
*/
- public void setDeviceStatus(VehicleDataResult deviceStatus) {
+ public SubscribeVehicleDataResponse setDeviceStatus( VehicleDataResult deviceStatus) {
setParameters(KEY_DEVICE_STATUS, deviceStatus);
+ return this;
}
/**
* Gets Device Status
@@ -327,8 +340,9 @@ public class SubscribeVehicleDataResponse extends RPCResponse { * Sets Driver Braking
* @param driverBraking a VehicleDataResult related to the driver breaking status
*/
- public void setDriverBraking(VehicleDataResult driverBraking) {
+ public SubscribeVehicleDataResponse setDriverBraking( VehicleDataResult driverBraking) {
setParameters(KEY_DRIVER_BRAKING, driverBraking);
+ return this;
}
/**
* Gets Driver Braking
@@ -342,8 +356,9 @@ public class SubscribeVehicleDataResponse extends RPCResponse { * Sets Wiper Status
* @param wiperStatus a VehicleDataResult related to the wiper status
*/
- public void setWiperStatus(VehicleDataResult wiperStatus) {
+ public SubscribeVehicleDataResponse setWiperStatus( VehicleDataResult wiperStatus) {
setParameters(KEY_WIPER_STATUS, wiperStatus);
+ return this;
}
/**
* Gets Wiper Status
@@ -357,8 +372,9 @@ public class SubscribeVehicleDataResponse extends RPCResponse { * Sets Head Lamp Status
* @param headLampStatus a VehicleDataResult related to the headlamp status
*/
- public void setHeadLampStatus(VehicleDataResult headLampStatus) {
+ public SubscribeVehicleDataResponse setHeadLampStatus( VehicleDataResult headLampStatus) {
setParameters(KEY_HEAD_LAMP_STATUS, headLampStatus);
+ return this;
}
/**
* Gets Head Lamp Status
@@ -372,8 +388,9 @@ public class SubscribeVehicleDataResponse extends RPCResponse { * Sets Engine Torque
* @param engineTorque a VehicleDataResult related to the engine's torque
*/
- public void setEngineTorque(VehicleDataResult engineTorque) {
+ public SubscribeVehicleDataResponse setEngineTorque( VehicleDataResult engineTorque) {
setParameters(KEY_ENGINE_TORQUE, engineTorque);
+ return this;
}
/**
* Gets Engine Torque
@@ -387,8 +404,9 @@ public class SubscribeVehicleDataResponse extends RPCResponse { * Sets Engine Oil Life
* @param engineOilLife a VehicleDataResult related to the engine's oil life
*/
- public void setEngineOilLife(VehicleDataResult engineOilLife) {
+ public SubscribeVehicleDataResponse setEngineOilLife( VehicleDataResult engineOilLife) {
setParameters(KEY_ENGINE_OIL_LIFE, engineOilLife);
+ return this;
}
/**
* Gets Engine Oil Life
@@ -402,8 +420,9 @@ public class SubscribeVehicleDataResponse extends RPCResponse { * Sets AccPedal Position
* @param accPedalPosition a VehicleDataResult related to the accelerator pedal's position
*/
- public void setAccPedalPosition(VehicleDataResult accPedalPosition) {
+ public SubscribeVehicleDataResponse setAccPedalPosition( VehicleDataResult accPedalPosition) {
setParameters(KEY_ACC_PEDAL_POSITION, accPedalPosition);
+ return this;
}
/**
* Gets AccPedal Position
@@ -414,8 +433,9 @@ public class SubscribeVehicleDataResponse extends RPCResponse { return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_ACC_PEDAL_POSITION);
}
- public void setSteeringWheelAngle(VehicleDataResult steeringWheelAngle) {
+ public SubscribeVehicleDataResponse setSteeringWheelAngle( VehicleDataResult steeringWheelAngle) {
setParameters(KEY_STEERING_WHEEL_ANGLE, steeringWheelAngle);
+ return this;
}
@SuppressWarnings("unchecked")
@@ -423,36 +443,41 @@ public class SubscribeVehicleDataResponse extends RPCResponse { return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_STEERING_WHEEL_ANGLE);
}
- public void setECallInfo(VehicleDataResult eCallInfo) {
+ public SubscribeVehicleDataResponse setECallInfo( VehicleDataResult eCallInfo) {
setParameters(KEY_E_CALL_INFO, eCallInfo);
+ return this;
}
@SuppressWarnings("unchecked")
public VehicleDataResult getECallInfo() {
return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_E_CALL_INFO);
}
- public void setAirbagStatus(VehicleDataResult airbagStatus) {
+ public SubscribeVehicleDataResponse setAirbagStatus( VehicleDataResult airbagStatus) {
setParameters(KEY_AIRBAG_STATUS, airbagStatus);
+ return this;
}
@SuppressWarnings("unchecked")
public VehicleDataResult getAirbagStatus() {
return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_AIRBAG_STATUS);
}
- public void setEmergencyEvent(VehicleDataResult emergencyEvent) {
+ public SubscribeVehicleDataResponse setEmergencyEvent( VehicleDataResult emergencyEvent) {
setParameters(KEY_EMERGENCY_EVENT, emergencyEvent);
+ return this;
}
@SuppressWarnings("unchecked")
public VehicleDataResult getEmergencyEvent() {
return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_EMERGENCY_EVENT);
}
- public void setClusterModeStatus(VehicleDataResult clusterModeStatus) {
+ public SubscribeVehicleDataResponse setClusterModeStatus( VehicleDataResult clusterModeStatus) {
setParameters(KEY_CLUSTER_MODE_STATUS, clusterModeStatus);
+ return this;
}
@SuppressWarnings("unchecked")
public VehicleDataResult getClusterModeStatus() {
return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_CLUSTER_MODE_STATUS);
}
- public void setMyKey(VehicleDataResult myKey) {
+ public SubscribeVehicleDataResponse setMyKey( VehicleDataResult myKey) {
setParameters(KEY_MY_KEY, myKey);
+ return this;
}
@SuppressWarnings("unchecked")
public VehicleDataResult getMyKey() {
@@ -466,8 +491,9 @@ public class SubscribeVehicleDataResponse extends RPCResponse { * vehicle. See struct FuelRange for details.
* @since SmartDeviceLink 5.0.0
*/
- public void setFuelRange(VehicleDataResult fuelRange) {
+ public SubscribeVehicleDataResponse setFuelRange( VehicleDataResult fuelRange) {
setParameters(KEY_FUEL_RANGE, fuelRange);
+ return this;
}
/**
@@ -486,8 +512,9 @@ public class SubscribeVehicleDataResponse extends RPCResponse { * Sets turnSignal
* @param turnSignal a VehicleDataResult related to the turn signal status
*/
- public void setTurnSignal(VehicleDataResult turnSignal) {
+ public SubscribeVehicleDataResponse setTurnSignal( VehicleDataResult turnSignal) {
setParameters(KEY_TURN_SIGNAL, turnSignal);
+ return this;
}
/**
@@ -503,8 +530,9 @@ public class SubscribeVehicleDataResponse extends RPCResponse { * Sets electronicParkBrakeStatus
* @param electronicParkBrakeStatus a VehicleDataResult related to the electronic park brake status
*/
- public void setElectronicParkBrakeStatus(VehicleDataResult electronicParkBrakeStatus){
+ public SubscribeVehicleDataResponse setElectronicParkBrakeStatus( VehicleDataResult electronicParkBrakeStatus) {
setParameters(KEY_ELECTRONIC_PARK_BRAKE_STATUS, electronicParkBrakeStatus);
+ return this;
}
/**
@@ -519,8 +547,9 @@ public class SubscribeVehicleDataResponse extends RPCResponse { * Sets cloudAppVehicleID
* @param cloudAppVehicleID a VehicleDataResult related to the cloud app vehicle ID
*/
- public void setCloudAppVehicleID(VehicleDataResult cloudAppVehicleID){
+ public SubscribeVehicleDataResponse setCloudAppVehicleID( VehicleDataResult cloudAppVehicleID) {
setParameters(KEY_CLOUD_APP_VEHICLE_ID, cloudAppVehicleID);
+ return this;
}
/**
@@ -536,8 +565,9 @@ public class SubscribeVehicleDataResponse extends RPCResponse { * @param vehicleDataName a String value
* @param vehicleDataState a VehicleDataResult value
*/
- public void setOEMCustomVehicleData(String vehicleDataName, VehicleDataResult vehicleDataState){
+ public SubscribeVehicleDataResponse setOEMCustomVehicleData( String vehicleDataName, VehicleDataResult vehicleDataState) {
setParameters(vehicleDataName, vehicleDataState);
+ return this;
}
/**
@@ -554,8 +584,9 @@ public class SubscribeVehicleDataResponse extends RPCResponse { * @param handsOffSteering To indicate whether driver hands are off the steering wheel
* @since SmartDeviceLink 7.0.0
*/
- public void setHandsOffSteering(VehicleDataResult handsOffSteering) {
+ public SubscribeVehicleDataResponse setHandsOffSteering( VehicleDataResult handsOffSteering) {
setParameters(KEY_HANDS_OFF_STEERING, handsOffSteering);
+ return this;
}
/**
@@ -573,8 +604,9 @@ public class SubscribeVehicleDataResponse extends RPCResponse { * @param gearStatus See GearStatus
* @since SmartDeviceLink 7.0.0
*/
- public void setGearStatus(VehicleDataResult gearStatus){
+ public SubscribeVehicleDataResponse setGearStatus( VehicleDataResult gearStatus) {
setParameters(KEY_GEAR_STATUS, gearStatus);
+ return this;
}
/**
@@ -594,8 +626,9 @@ public class SubscribeVehicleDataResponse extends RPCResponse { * @param windowStatus See WindowStatus
* @since SmartDeviceLink 7.0.0
*/
- public void setWindowStatus(VehicleDataResult windowStatus) {
+ public SubscribeVehicleDataResponse setWindowStatus( VehicleDataResult windowStatus) {
setParameters(KEY_WINDOW_STATUS, windowStatus);
+ return this;
}
/**
@@ -624,7 +657,8 @@ public class SubscribeVehicleDataResponse extends RPCResponse { * @param stabilityControlsStatus See StabilityControlsStatus
* @since SmartDeviceLink 7.0.0
*/
- public void setStabilityControlsStatus(VehicleDataResult stabilityControlsStatus) {
+ public SubscribeVehicleDataResponse setStabilityControlsStatus( VehicleDataResult stabilityControlsStatus) {
setParameters(KEY_STABILITY_CONTROLS_STATUS, stabilityControlsStatus);
+ return this;
}
}
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/SubtleAlert.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/SubtleAlert.java index 42752ff8d..a3b96e4ec 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/SubtleAlert.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/SubtleAlert.java @@ -142,8 +142,9 @@ public class SubtleAlert extends RPCRequest { * * @param alertText1 The first line of the alert text field */ - public void setAlertText1(String alertText1) { + public SubtleAlert setAlertText1( String alertText1) { setParameters(KEY_ALERT_TEXT_1, alertText1); + return this; } /** @@ -160,8 +161,9 @@ public class SubtleAlert extends RPCRequest { * * @param alertText2 The second line of the alert text field */ - public void setAlertText2(String alertText2) { + public SubtleAlert setAlertText2( String alertText2) { setParameters(KEY_ALERT_TEXT_2, alertText2); + return this; } /** @@ -179,8 +181,9 @@ public class SubtleAlert extends RPCRequest { * @param alertIcon Image to be displayed for the corresponding alert. See Image. If omitted on supported * displays, no (or the default if applicable) icon should be displayed. */ - public void setAlertIcon(Image alertIcon) { + public SubtleAlert setAlertIcon( Image alertIcon) { setParameters(KEY_ALERT_ICON, alertIcon); + return this; } /** @@ -199,8 +202,9 @@ public class SubtleAlert extends RPCRequest { * @param ttsChunks An array of text chunks of type TTSChunk. See TTSChunk. The array must have at least one * item. */ - public void setTtsChunks(List<TTSChunk> ttsChunks) { + public SubtleAlert setTtsChunks( List<TTSChunk> ttsChunks) { setParameters(KEY_TTS_CHUNKS, ttsChunks); + return this; } /** @@ -220,8 +224,9 @@ public class SubtleAlert extends RPCRequest { * @param duration Timeout in milliseconds. Typical timeouts are 3-5 seconds. If omitted, timeout is set to * 5s. */ - public void setDuration(Integer duration) { + public SubtleAlert setDuration( Integer duration) { setParameters(KEY_DURATION, duration); + return this; } /** @@ -240,8 +245,9 @@ public class SubtleAlert extends RPCRequest { * @param softButtons App defined SoftButtons. If omitted on supported displays, the displayed alert shall not * have any SoftButtons. */ - public void setSoftButtons(List<SoftButton> softButtons) { + public SubtleAlert setSoftButtons( List<SoftButton> softButtons) { setParameters(KEY_SOFT_BUTTONS, softButtons); + return this; } /** @@ -260,8 +266,9 @@ public class SubtleAlert extends RPCRequest { * * @param cancelID An ID for this specific alert to allow cancellation through the `CancelInteraction` RPC. */ - public void setCancelID(Integer cancelID) { + public SubtleAlert setCancelID( Integer cancelID) { setParameters(KEY_CANCEL_ID, cancelID); + return this; } /** diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/SubtleAlertResponse.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/SubtleAlertResponse.java index a15dbe13b..9e1e5b2c3 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/SubtleAlertResponse.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/SubtleAlertResponse.java @@ -80,8 +80,9 @@ public class SubtleAlertResponse extends RPCResponse { * 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. */ - public void setTryAgainTime(Integer tryAgainTime) { + public SubtleAlertResponse setTryAgainTime( Integer tryAgainTime) { setParameters(KEY_TRY_AGAIN_TIME, tryAgainTime); + return this; } /** diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/SystemCapability.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/SystemCapability.java index 470321627..6ae6fa914 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/SystemCapability.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/SystemCapability.java @@ -79,8 +79,9 @@ public class SystemCapability extends RPCStruct { /** * @param value Set the SystemCapabilityType that indicates which type of data should be changed and identifies which data object exists in this struct. */ - public void setSystemCapabilityType(@NonNull SystemCapabilityType value){ + public SystemCapability setSystemCapabilityType(@NonNull SystemCapabilityType value) { setValue(KEY_SYSTEM_CAPABILITY_TYPE, value); + return this; } public Object getCapabilityForType(SystemCapabilityType type) { @@ -107,9 +108,9 @@ public class SystemCapability extends RPCStruct { } } - public void setCapabilityForType(SystemCapabilityType type, Object capability) { + public SystemCapability setCapabilityForType( SystemCapabilityType type, Object capability) { if (type == null) { - return; + return this; } else if (type.equals(SystemCapabilityType.NAVIGATION)) { setValue(KEY_NAVIGATION_CAPABILITY, capability); } else if (type.equals(SystemCapabilityType.PHONE_CALL)) { @@ -127,8 +128,9 @@ public class SystemCapability extends RPCStruct { } else if (type.equals(SystemCapabilityType.DRIVER_DISTRACTION)) { setValue(KEY_DRIVER_DISTRACTION_CAPABILITY, capability); } else { - return; + return this; } + return this; } } diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/SystemRequest.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/SystemRequest.java index 5c02cfe7d..839d49953 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/SystemRequest.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/SystemRequest.java @@ -1,34 +1,34 @@ -/* - * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this - * list of conditions and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following - * disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its - * contributors may be used to endorse or promote products derived from this - * software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ +/*
+ * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
package com.smartdevicelink.proxy.rpc;
import androidx.annotation.NonNull;
@@ -118,31 +118,35 @@ public class SystemRequest extends RPCRequest { return (List<String>) getObject(String.class, KEY_DATA);
}
- public void setLegacyData( List<String> data ) {
+ public SystemRequest setLegacyData( List<String> data) {
setParameters(KEY_DATA, data);
- }
+ return this;
+ }
public String getFileName() {
return getString(KEY_FILE_NAME);
}
- public void setFileName(String fileName) {
+ public SystemRequest setFileName( String fileName) {
setParameters(KEY_FILE_NAME, fileName);
- }
+ return this;
+ }
public RequestType getRequestType() {
return (RequestType) getObject(RequestType.class, KEY_REQUEST_TYPE);
}
- public void setRequestType(@NonNull RequestType requestType) {
+ public SystemRequest setRequestType(@NonNull RequestType requestType) {
setParameters(KEY_REQUEST_TYPE, requestType);
+ return this;
}
public String getRequestSubType() {
return getString(KEY_REQUEST_SUB_TYPE);
}
- public void setRequestSubType(String requestSubType) {
+ public SystemRequest setRequestSubType( String requestSubType) {
setParameters(KEY_REQUEST_SUB_TYPE, requestSubType);
+ return this;
}
}
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/TTSChunk.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/TTSChunk.java index fbd526b30..9eed92f3f 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/TTSChunk.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/TTSChunk.java @@ -1,34 +1,34 @@ -/* - * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this - * list of conditions and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following - * disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its - * contributors may be used to endorse or promote products derived from this - * software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ +/*
+ * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
package com.smartdevicelink.proxy.rpc;
import androidx.annotation.NonNull;
@@ -105,9 +105,10 @@ public class TTSChunk extends RPCStruct { /**
* Set the text to be spoken, or a phoneme specification, or the name of a pre-recorded sound. The contents of this field are indicated by the "type" field.
* @param text to be spoken, or a phoneme specification, or the name of a pre-recorded sound.
- */
- public void setText(@NonNull String text ) {
+ */
+ public TTSChunk setText(@NonNull String text) {
setValue(KEY_TEXT, text);
+ return this;
}
/**
* Get the type of information in the "text" field (e.g. phrase to be spoken, phoneme specification, name of pre-recorded sound).
@@ -117,10 +118,11 @@ public class TTSChunk extends RPCStruct { return (SpeechCapabilities) getObject(SpeechCapabilities.class, KEY_TYPE);
}
/**
- * Set the type of information in the "text" field (e.g. phrase to be spoken, phoneme specification, name of pre-recorded sound).
+ * Set the type of information in the "text" field (e.g. phrase to be spoken, phoneme specification, name of pre-recorded sound).
* @param type the type of information in the "text" field
- */
- public void setType(@NonNull SpeechCapabilities type ) {
+ */
+ public TTSChunk setType(@NonNull SpeechCapabilities type) {
setValue(KEY_TYPE, type);
+ return this;
}
}
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/Temperature.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/Temperature.java index c2c809f13..9bd23d4a0 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/Temperature.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/Temperature.java @@ -65,8 +65,9 @@ public class Temperature extends RPCStruct{ * @param unit * Temperature Unit. */ - public void setUnit(@NonNull TemperatureUnit unit) { + public Temperature setUnit(@NonNull TemperatureUnit unit) { setValue(KEY_UNIT, unit); + return this; } /** @@ -94,7 +95,8 @@ public class Temperature extends RPCStruct{ * @param value * Temperature Value in TemperatureUnit specified unit. Range depends on OEM and is not checked by SDL. */ - public void setValue(@NonNull Float value) { + public Temperature setValue(@NonNull Float value) { setValue(KEY_VALUE, value); + return this; } } diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/TemplateColorScheme.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/TemplateColorScheme.java index aa2e2b2f6..e65f25659 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/TemplateColorScheme.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/TemplateColorScheme.java @@ -94,8 +94,9 @@ public class TemplateColorScheme extends RPCStruct { * Sets the primaryColor of the scheme * @param color an RGBColor object representing the primaryColor */ - public void setPrimaryColor(RGBColor color) { + public TemplateColorScheme setPrimaryColor( RGBColor color) { setValue(KEY_PRIMARY_COLOR, color); + return this; } /** @@ -110,8 +111,9 @@ public class TemplateColorScheme extends RPCStruct { * Sets the secondaryColor of the scheme * @param color an RGBColor object representing the secondaryColor */ - public void setSecondaryColor(RGBColor color) { + public TemplateColorScheme setSecondaryColor( RGBColor color) { setValue(KEY_SECONDARY_COLOR, color); + return this; } /** @@ -126,8 +128,9 @@ public class TemplateColorScheme extends RPCStruct { * Sets the backgroundColor of the scheme * @param color an RGBColor object representing the backgroundColor */ - public void setBackgroundColor(RGBColor color) { + public TemplateColorScheme setBackgroundColor( RGBColor color) { setValue(KEY_BACKGROUND_COLOR, color); + return this; } /** diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/TemplateConfiguration.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/TemplateConfiguration.java index c82b4c481..edaf224e5 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/TemplateConfiguration.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/TemplateConfiguration.java @@ -55,8 +55,9 @@ public class TemplateConfiguration extends RPCStruct { *
* @param template Predefined or dynamically created window template. Currently only predefined window template layouts are defined.
*/
- public void setTemplate(@NonNull String template) {
+ public TemplateConfiguration setTemplate(@NonNull String template) {
setValue(KEY_TEMPLATE, template);
+ return this;
}
/**
@@ -74,8 +75,9 @@ public class TemplateConfiguration extends RPCStruct { *
* @param dayColorScheme TemplateColorScheme for the day
*/
- public void setDayColorScheme(TemplateColorScheme dayColorScheme) {
+ public TemplateConfiguration setDayColorScheme( TemplateColorScheme dayColorScheme) {
setValue(KEY_DAY_COLOR_SCHEME, dayColorScheme);
+ return this;
}
/**
@@ -93,7 +95,8 @@ public class TemplateConfiguration extends RPCStruct { *
* @param nightColorScheme TemplateColorScheme for the night
*/
- public void setNightColorScheme(TemplateColorScheme nightColorScheme) {
+ public TemplateConfiguration setNightColorScheme( TemplateColorScheme nightColorScheme) {
setValue(KEY_NIGHT_COLOR_SCHEME, nightColorScheme);
+ return this;
}
}
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/TextField.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/TextField.java index dc9907bad..317138936 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/TextField.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/TextField.java @@ -135,11 +135,12 @@ public class TextField extends RPCStruct { return (TextFieldName) getObject(TextFieldName.class, KEY_NAME);
}
/**
- * Set the enumeration identifying the field.
+ * Set the enumeration identifying the field.
* @param name the name of TextField
- */
- public void setName(@NonNull TextFieldName name ) {
+ */
+ public TextField setName(@NonNull TextFieldName name) {
setValue(KEY_NAME, name);
+ return this;
}
/**
* Get the character set that is supported in this field.
@@ -155,9 +156,10 @@ public class TextField extends RPCStruct { * @param characterSet - The set of characters that are supported by this text field.
* All text is sent in UTF-8 format, but not all systems may support all of the characters expressed by UTF-8.
* All systems will support at least ASCII, but they may support more, either the LATIN-1 character set, or the full UTF-8 character set.
- */
- public void setCharacterSet(@NonNull CharacterSet characterSet ) {
+ */
+ public TextField setCharacterSet(@NonNull CharacterSet characterSet) {
setValue(KEY_CHARACTER_SET, characterSet);
+ return this;
}
/**
* Get the number of characters in one row of this field.
@@ -177,9 +179,10 @@ public class TextField extends RPCStruct { * <li>maxvalue="500"</li>
* </ul>
* @param width the number of characters in one row of this field
- */
- public void setWidth(@NonNull Integer width ) {
+ */
+ public TextField setWidth(@NonNull Integer width) {
setValue(KEY_WIDTH, width);
+ return this;
}
/**
*Get the number of rows for this text field.
@@ -192,7 +195,8 @@ public class TextField extends RPCStruct { public Integer getRows() {
return getInteger( KEY_ROWS );
}
- public void setRows(@NonNull Integer rows ) {
+ public TextField setRows(@NonNull Integer rows) {
setValue(KEY_ROWS, rows);
+ return this;
}
}
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/TireStatus.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/TireStatus.java index c5e2626b8..92c524b79 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/TireStatus.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/TireStatus.java @@ -141,49 +141,56 @@ public class TireStatus extends RPCStruct { setInnerRightRear(innerRightRear);
}
- public void setPressureTellTale(@NonNull WarningLightStatus pressureTellTale) {
- setValue(KEY_PRESSURE_TELL_TALE, pressureTellTale);
+ public TireStatus setPressureTellTale(@NonNull WarningLightStatus pressureTellTale) {
+ setValue(KEY_PRESSURE_TELL_TALE, pressureTellTale);
+ return this;
}
public WarningLightStatus getPressureTellTale() {
return (WarningLightStatus) getObject(WarningLightStatus.class, KEY_PRESSURE_TELL_TALE);
}
- public void setLeftFront(@NonNull SingleTireStatus leftFront) {
- setValue(KEY_LEFT_FRONT, leftFront);
+ public TireStatus setLeftFront(@NonNull SingleTireStatus leftFront) {
+ setValue(KEY_LEFT_FRONT, leftFront);
+ return this;
}
@SuppressWarnings("unchecked")
public SingleTireStatus getLeftFront() {
return (SingleTireStatus) getObject(SingleTireStatus.class, KEY_LEFT_FRONT);
}
- public void setRightFront(@NonNull SingleTireStatus rightFront) {
- setValue(KEY_RIGHT_FRONT, rightFront);
+ public TireStatus setRightFront(@NonNull SingleTireStatus rightFront) {
+ setValue(KEY_RIGHT_FRONT, rightFront);
+ return this;
}
@SuppressWarnings("unchecked")
public SingleTireStatus getRightFront() {
return (SingleTireStatus) getObject(SingleTireStatus.class, KEY_RIGHT_FRONT);
}
- public void setLeftRear(@NonNull SingleTireStatus leftRear) {
- setValue(KEY_LEFT_REAR, leftRear);
+ public TireStatus setLeftRear(@NonNull SingleTireStatus leftRear) {
+ setValue(KEY_LEFT_REAR, leftRear);
+ return this;
}
@SuppressWarnings("unchecked")
public SingleTireStatus getLeftRear() {
return (SingleTireStatus) getObject(SingleTireStatus.class, KEY_LEFT_REAR);
}
- public void setRightRear(@NonNull SingleTireStatus rightRear) {
- setValue(KEY_RIGHT_REAR, rightRear);
+ public TireStatus setRightRear(@NonNull SingleTireStatus rightRear) {
+ setValue(KEY_RIGHT_REAR, rightRear);
+ return this;
}
@SuppressWarnings("unchecked")
public SingleTireStatus getRightRear() {
return (SingleTireStatus) getObject(SingleTireStatus.class, KEY_RIGHT_REAR);
}
- public void setInnerLeftRear(@NonNull SingleTireStatus innerLeftRear) {
- setValue(KEY_INNER_LEFT_REAR, innerLeftRear);
+ public TireStatus setInnerLeftRear(@NonNull SingleTireStatus innerLeftRear) {
+ setValue(KEY_INNER_LEFT_REAR, innerLeftRear);
+ return this;
}
@SuppressWarnings("unchecked")
public SingleTireStatus getInnerLeftRear() {
return (SingleTireStatus) getObject(SingleTireStatus.class, KEY_INNER_LEFT_REAR);
}
- public void setInnerRightRear(@NonNull SingleTireStatus innerRightRear) {
- setValue(KEY_INNER_RIGHT_REAR, innerRightRear);
+ public TireStatus setInnerRightRear(@NonNull SingleTireStatus innerRightRear) {
+ setValue(KEY_INNER_RIGHT_REAR, innerRightRear);
+ return this;
}
@SuppressWarnings("unchecked")
public SingleTireStatus getInnerRightRear() {
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/TouchCoord.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/TouchCoord.java index 3e33369cf..c2f71e09e 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/TouchCoord.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/TouchCoord.java @@ -1,34 +1,34 @@ -/* - * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this - * list of conditions and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following - * disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its - * contributors may be used to endorse or promote products derived from this - * software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ +/*
+ * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
package com.smartdevicelink.proxy.rpc;
import androidx.annotation.NonNull;
@@ -101,16 +101,18 @@ public class TouchCoord extends RPCStruct { setY(y);
}
- public void setX(@NonNull Integer x) {
+ public TouchCoord setX(@NonNull Integer x) {
setValue(KEY_X, x);
+ return this;
}
public Integer getX() {
return getInteger(KEY_X);
}
- public void setY(@NonNull Integer y) {
+ public TouchCoord setY(@NonNull Integer y) {
setValue(KEY_Y, y);
+ return this;
}
public Integer getY() {
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/TouchEvent.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/TouchEvent.java index 47f29c0b1..55bb75249 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/TouchEvent.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/TouchEvent.java @@ -1,34 +1,34 @@ -/* - * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this - * list of conditions and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following - * disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its - * contributors may be used to endorse or promote products derived from this - * software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ +/*
+ * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
package com.smartdevicelink.proxy.rpc;
import androidx.annotation.NonNull;
@@ -116,8 +116,9 @@ public class TouchEvent extends RPCStruct { setTouchCoordinates(c);
}
- public void setId(@NonNull Integer id) {
+ public TouchEvent setId(@NonNull Integer id) {
setValue(KEY_ID, id);
+ return this;
}
public Integer getId() {
@@ -156,18 +157,20 @@ public class TouchEvent extends RPCStruct { return null;
}
- public void setTimestamps(@NonNull List<Long> ts){
+ public TouchEvent setTimestamps(@NonNull List<Long> ts) {
setValue(KEY_TS, ts);
+ return this;
}
/**
- * Use setTimestamps.
+ * Use setTimestamps.
* @deprecated 4.0.2
* @param ts
*/
@Deprecated
- public void setTs(List<Long> ts) {
- setTimestamps(ts);
+ public TouchEvent setTs( List<Long> ts) {
+ setTimestamps(ts);
+ return this;
}
/**
@@ -190,11 +193,13 @@ public class TouchEvent extends RPCStruct { * @return
*/
@Deprecated
- public void setC( List<TouchCoord> c ) {
- setTouchCoordinates(c);
+ public TouchEvent setC( List<TouchCoord> c) {
+ setTouchCoordinates(c);
+ return this;
}
- public void setTouchCoordinates(@NonNull List<TouchCoord> c ) {
+ public TouchEvent setTouchCoordinates(@NonNull List<TouchCoord> c) {
setValue(KEY_C, c);
- }
+ return this;
+ }
}
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/TouchEventCapabilities.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/TouchEventCapabilities.java index 423ae4fa2..cb455bf59 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/TouchEventCapabilities.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/TouchEventCapabilities.java @@ -1,34 +1,34 @@ -/* - * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this - * list of conditions and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following - * disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its - * contributors may be used to endorse or promote products derived from this - * software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ +/*
+ * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
package com.smartdevicelink.proxy.rpc;
import androidx.annotation.NonNull;
@@ -99,24 +99,27 @@ public class TouchEventCapabilities extends RPCStruct { setDoublePressAvailable(doublePressAvailable);
}
- public void setPressAvailable(@NonNull Boolean pressAvailable) {
+ public TouchEventCapabilities setPressAvailable(@NonNull Boolean pressAvailable) {
setValue(KEY_PRESS_AVAILABLE, pressAvailable);
+ return this;
}
public Boolean getPressAvailable() {
return getBoolean(KEY_PRESS_AVAILABLE);
}
- public void setMultiTouchAvailable(@NonNull Boolean multiTouchAvailable) {
+ public TouchEventCapabilities setMultiTouchAvailable(@NonNull Boolean multiTouchAvailable) {
setValue(KEY_MULTI_TOUCH_AVAILABLE, multiTouchAvailable);
+ return this;
}
public Boolean getMultiTouchAvailable() {
return getBoolean(KEY_MULTI_TOUCH_AVAILABLE);
}
- public void setDoublePressAvailable(@NonNull Boolean doublePressAvailable) {
+ public TouchEventCapabilities setDoublePressAvailable(@NonNull Boolean doublePressAvailable) {
setValue(KEY_DOUBLE_PRESS_AVAILABLE, doublePressAvailable);
+ return this;
}
public Boolean getDoublePressAvailable() {
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/Turn.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/Turn.java index 0498023ea..d282e6200 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/Turn.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/Turn.java @@ -77,12 +77,13 @@ public class Turn extends RPCStruct{ /** * set the text to describe the turn (e.g. streetname) - * + * * @param navigationText * the text to describe the turn (e.g. streetname) */ - public void setNavigationText(String navigationText){ + public Turn setNavigationText( String navigationText) { setValue(KEY_NAVIGATION_TEXT, navigationText); + return this; } /** @@ -96,12 +97,13 @@ public class Turn extends RPCStruct{ /** * set Image to be shown for a turn - * + * * @param turnIcon * the image to be shown for a turn */ - public void setTurnIcon(Image turnIcon){ + public Turn setTurnIcon( Image turnIcon) { setValue(KEY_TURN_IMAGE, turnIcon); + return this; } /** diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/UnpublishAppService.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/UnpublishAppService.java index 6e509fe1f..60a59f77b 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/UnpublishAppService.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/UnpublishAppService.java @@ -80,9 +80,10 @@ public class UnpublishAppService extends RPCRequest { * The ID of the service to be unpublished. * @param serviceID - set the service ID for the service to be unpublished */ - public void setServiceID(String serviceID){ - setParameters(KEY_SERVICE_ID, serviceID); - } + public UnpublishAppService setServiceID( String serviceID) { + setParameters(KEY_SERVICE_ID, serviceID); + return this; + } /** * The ID of the service to be unpublished. diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/UnsubscribeButton.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/UnsubscribeButton.java index 48c287ea8..87dcc9cfb 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/UnsubscribeButton.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/UnsubscribeButton.java @@ -1,34 +1,34 @@ -/* - * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this - * list of conditions and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following - * disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its - * contributors may be used to endorse or promote products derived from this - * software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ +/*
+ * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
package com.smartdevicelink.proxy.rpc;
import androidx.annotation.NonNull;
@@ -121,10 +121,11 @@ public class UnsubscribeButton extends RPCRequest { }
/**
* Sets the name of the button to unsubscribe from
- *
- * @param buttonName an enum value, see <i> {@linkplain com.smartdevicelink.proxy.rpc.enums.ButtonName}</i>
+ *
+ * @param buttonName an enum value, see <i> {@linkplain ButtonName}</i>
*/
- public void setButtonName(@NonNull ButtonName buttonName ) {
- setParameters(KEY_BUTTON_NAME, buttonName);
+ public UnsubscribeButton setButtonName(@NonNull ButtonName buttonName) {
+ setParameters(KEY_BUTTON_NAME, buttonName);
+ return this;
}
}
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/UnsubscribeVehicleData.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/UnsubscribeVehicleData.java index 663f8fbf8..8e7adb2d2 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/UnsubscribeVehicleData.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/UnsubscribeVehicleData.java @@ -378,12 +378,13 @@ public class UnsubscribeVehicleData extends RPCRequest { /**
* Sets a boolean value. If true, unsubscribes from Gps data
- *
+ *
* @param gps
* a boolean value
*/
- public void setGps(Boolean gps) {
- setParameters(KEY_GPS, gps);
+ public UnsubscribeVehicleData setGps( Boolean gps) {
+ setParameters(KEY_GPS, gps);
+ return this;
}
/**
@@ -398,12 +399,13 @@ public class UnsubscribeVehicleData extends RPCRequest { /**
* Sets a boolean value. If true, unsubscribes from speed data
- *
+ *
* @param speed
* a boolean value
*/
- public void setSpeed(Boolean speed) {
- setParameters(KEY_SPEED, speed);
+ public UnsubscribeVehicleData setSpeed( Boolean speed) {
+ setParameters(KEY_SPEED, speed);
+ return this;
}
/**
@@ -418,12 +420,13 @@ public class UnsubscribeVehicleData extends RPCRequest { /**
* Sets a boolean value. If true, unsubscribe data
- *
+ *
* @param rpm
* a boolean value
*/
- public void setRpm(Boolean rpm) {
- setParameters(KEY_RPM, rpm);
+ public UnsubscribeVehicleData setRpm( Boolean rpm) {
+ setParameters(KEY_RPM, rpm);
+ return this;
}
/**
@@ -438,13 +441,14 @@ public class UnsubscribeVehicleData extends RPCRequest { /**
* Sets the fuelLevel.
- *
+ *
* @param fuelLevel The fuel level in the tank (percentage). This parameter is deprecated starting RPC Spec
* 7.0, please see fuelRange.
*/
@Deprecated
- public void setFuelLevel(Boolean fuelLevel) {
- setParameters(KEY_FUEL_LEVEL, fuelLevel);
+ public UnsubscribeVehicleData setFuelLevel( Boolean fuelLevel) {
+ setParameters(KEY_FUEL_LEVEL, fuelLevel);
+ return this;
}
/**
@@ -466,8 +470,9 @@ public class UnsubscribeVehicleData extends RPCRequest { * @since SmartDeviceLink 5.0.0
*/
@Deprecated
- public void setFuelLevelState(Boolean fuelLevelState) {
- setParameters(KEY_FUEL_LEVEL_STATE, fuelLevelState);
+ public UnsubscribeVehicleData setFuelLevelState( Boolean fuelLevelState) {
+ setParameters(KEY_FUEL_LEVEL_STATE, fuelLevelState);
+ return this;
}
/**
@@ -484,12 +489,13 @@ public class UnsubscribeVehicleData extends RPCRequest { /**
* Sets a boolean value. If true, unsubscribes from instantFuelConsumption data
- *
+ *
* @param instantFuelConsumption
* a boolean value
*/
- public void setInstantFuelConsumption(Boolean instantFuelConsumption) {
- setParameters(KEY_INSTANT_FUEL_CONSUMPTION, instantFuelConsumption);
+ public UnsubscribeVehicleData setInstantFuelConsumption( Boolean instantFuelConsumption) {
+ setParameters(KEY_INSTANT_FUEL_CONSUMPTION, instantFuelConsumption);
+ return this;
}
/**
@@ -505,12 +511,13 @@ public class UnsubscribeVehicleData extends RPCRequest { /**
* Sets a boolean value. If true, unsubscribes from externalTemperature data
- *
+ *
* @param externalTemperature
* a boolean value
*/
- public void setExternalTemperature(Boolean externalTemperature) {
- setParameters(KEY_EXTERNAL_TEMPERATURE, externalTemperature);
+ public UnsubscribeVehicleData setExternalTemperature( Boolean externalTemperature) {
+ setParameters(KEY_EXTERNAL_TEMPERATURE, externalTemperature);
+ return this;
}
/**
@@ -531,8 +538,9 @@ public class UnsubscribeVehicleData extends RPCRequest { * @deprecated in SmartDeviceLink 7.0.0
*/
@Deprecated
- public void setPrndl(Boolean prndl) {
+ public UnsubscribeVehicleData setPrndl( Boolean prndl) {
setParameters(KEY_PRNDL, prndl);
+ return this;
}
/**
@@ -548,12 +556,13 @@ public class UnsubscribeVehicleData extends RPCRequest { /**
* Sets a boolean value. If true, unsubscribes from tire pressure status data
- *
+ *
* @param tirePressure
* a boolean value
*/
- public void setTirePressure(Boolean tirePressure) {
- setParameters(KEY_TIRE_PRESSURE, tirePressure);
+ public UnsubscribeVehicleData setTirePressure( Boolean tirePressure) {
+ setParameters(KEY_TIRE_PRESSURE, tirePressure);
+ return this;
}
/**
@@ -569,12 +578,13 @@ public class UnsubscribeVehicleData extends RPCRequest { /**
* Sets a boolean value. If true, unsubscribes from odometer data
- *
+ *
* @param odometer
* a boolean value
*/
- public void setOdometer(Boolean odometer) {
- setParameters(KEY_ODOMETER, odometer);
+ public UnsubscribeVehicleData setOdometer( Boolean odometer) {
+ setParameters(KEY_ODOMETER, odometer);
+ return this;
}
/**
@@ -590,12 +600,13 @@ public class UnsubscribeVehicleData extends RPCRequest { /**
* Sets a boolean value. If true, unsubscribes from belt Status data
- *
+ *
* @param beltStatus
* a boolean value
*/
- public void setBeltStatus(Boolean beltStatus) {
- setParameters(KEY_BELT_STATUS, beltStatus);
+ public UnsubscribeVehicleData setBeltStatus( Boolean beltStatus) {
+ setParameters(KEY_BELT_STATUS, beltStatus);
+ return this;
}
/**
@@ -611,12 +622,13 @@ public class UnsubscribeVehicleData extends RPCRequest { /**
* Sets a boolean value. If true, unsubscribes from body Information data
- *
+ *
* @param bodyInformation
* a boolean value
*/
- public void setBodyInformation(Boolean bodyInformation) {
- setParameters(KEY_BODY_INFORMATION, bodyInformation);
+ public UnsubscribeVehicleData setBodyInformation( Boolean bodyInformation) {
+ setParameters(KEY_BODY_INFORMATION, bodyInformation);
+ return this;
}
/**
@@ -632,12 +644,13 @@ public class UnsubscribeVehicleData extends RPCRequest { /**
* Sets a boolean value. If true, unsubscribes from device Status data
- *
+ *
* @param deviceStatus
* a boolean value
*/
- public void setDeviceStatus(Boolean deviceStatus) {
- setParameters(KEY_DEVICE_STATUS, deviceStatus);
+ public UnsubscribeVehicleData setDeviceStatus( Boolean deviceStatus) {
+ setParameters(KEY_DEVICE_STATUS, deviceStatus);
+ return this;
}
/**
@@ -653,12 +666,13 @@ public class UnsubscribeVehicleData extends RPCRequest { /**
* Sets a boolean value. If true, unsubscribes from driver Braking data
- *
+ *
* @param driverBraking
* a boolean value
*/
- public void setDriverBraking(Boolean driverBraking) {
- setParameters(KEY_DRIVER_BRAKING, driverBraking);
+ public UnsubscribeVehicleData setDriverBraking( Boolean driverBraking) {
+ setParameters(KEY_DRIVER_BRAKING, driverBraking);
+ return this;
}
/**
@@ -674,12 +688,13 @@ public class UnsubscribeVehicleData extends RPCRequest { /**
* Sets a boolean value. If true, unsubscribes from wiper Status data
- *
+ *
* @param wiperStatus
* a boolean value
*/
- public void setWiperStatus(Boolean wiperStatus) {
- setParameters(KEY_WIPER_STATUS, wiperStatus);
+ public UnsubscribeVehicleData setWiperStatus( Boolean wiperStatus) {
+ setParameters(KEY_WIPER_STATUS, wiperStatus);
+ return this;
}
/**
@@ -695,12 +710,13 @@ public class UnsubscribeVehicleData extends RPCRequest { /**
* Sets a boolean value. If true, unsubscribes from Head Lamp Status data
- *
+ *
* @param headLampStatus
* a boolean value
*/
- public void setHeadLampStatus(Boolean headLampStatus) {
- setParameters(KEY_HEAD_LAMP_STATUS, headLampStatus);
+ public UnsubscribeVehicleData setHeadLampStatus( Boolean headLampStatus) {
+ setParameters(KEY_HEAD_LAMP_STATUS, headLampStatus);
+ return this;
}
/**
@@ -720,9 +736,10 @@ public class UnsubscribeVehicleData extends RPCRequest { * @param engineTorque
* a boolean value
*/
- public void setEngineTorque(Boolean engineTorque) {
- setParameters(KEY_ENGINE_TORQUE, engineTorque);
- }
+ public UnsubscribeVehicleData setEngineTorque( Boolean engineTorque) {
+ setParameters(KEY_ENGINE_TORQUE, engineTorque);
+ return this;
+ }
/**
* Gets a boolean value. If true, means the Engine Torque data has been
@@ -741,9 +758,10 @@ public class UnsubscribeVehicleData extends RPCRequest { * @param engineOilLife
* a boolean value
*/
- public void setEngineOilLife(Boolean engineOilLife) {
- setParameters(KEY_ENGINE_OIL_LIFE, engineOilLife);
- }
+ public UnsubscribeVehicleData setEngineOilLife( Boolean engineOilLife) {
+ setParameters(KEY_ENGINE_OIL_LIFE, engineOilLife);
+ return this;
+ }
/**
* Gets a boolean value. If true, means the Engine Oil Life data has been
@@ -759,12 +777,13 @@ public class UnsubscribeVehicleData extends RPCRequest { /**
* Sets a boolean value. If true, unsubscribes from accPedalPosition data
- *
+ *
* @param accPedalPosition
* a boolean value
*/
- public void setAccPedalPosition(Boolean accPedalPosition) {
- setParameters(KEY_ACC_PEDAL_POSITION, accPedalPosition);
+ public UnsubscribeVehicleData setAccPedalPosition( Boolean accPedalPosition) {
+ setParameters(KEY_ACC_PEDAL_POSITION, accPedalPosition);
+ return this;
}
/**
@@ -778,40 +797,46 @@ public class UnsubscribeVehicleData extends RPCRequest { return getBoolean(KEY_ACC_PEDAL_POSITION);
}
- public void setSteeringWheelAngle(Boolean steeringWheelAngle) {
- setParameters(KEY_STEERING_WHEEL_ANGLE, steeringWheelAngle);
+ public UnsubscribeVehicleData setSteeringWheelAngle( Boolean steeringWheelAngle) {
+ setParameters(KEY_STEERING_WHEEL_ANGLE, steeringWheelAngle);
+ return this;
}
public Boolean getSteeringWheelAngle() {
return getBoolean(KEY_STEERING_WHEEL_ANGLE);
}
- public void setECallInfo(Boolean eCallInfo) {
- setParameters(KEY_E_CALL_INFO, eCallInfo);
+ public UnsubscribeVehicleData setECallInfo( Boolean eCallInfo) {
+ setParameters(KEY_E_CALL_INFO, eCallInfo);
+ return this;
}
public Boolean getECallInfo() {
return getBoolean(KEY_E_CALL_INFO);
}
- public void setAirbagStatus(Boolean airbagStatus) {
- setParameters(KEY_AIRBAG_STATUS, airbagStatus);
+ public UnsubscribeVehicleData setAirbagStatus( Boolean airbagStatus) {
+ setParameters(KEY_AIRBAG_STATUS, airbagStatus);
+ return this;
}
public Boolean getAirbagStatus() {
return getBoolean(KEY_AIRBAG_STATUS);
}
- public void setEmergencyEvent(Boolean emergencyEvent) {
- setParameters(KEY_EMERGENCY_EVENT, emergencyEvent);
+ public UnsubscribeVehicleData setEmergencyEvent( Boolean emergencyEvent) {
+ setParameters(KEY_EMERGENCY_EVENT, emergencyEvent);
+ return this;
}
public Boolean getEmergencyEvent() {
return getBoolean(KEY_EMERGENCY_EVENT);
}
- public void setClusterModeStatus(Boolean clusterModeStatus) {
- setParameters(KEY_CLUSTER_MODE_STATUS, clusterModeStatus);
+ public UnsubscribeVehicleData setClusterModeStatus( Boolean clusterModeStatus) {
+ setParameters(KEY_CLUSTER_MODE_STATUS, clusterModeStatus);
+ return this;
}
public Boolean getClusterModeStatus() {
return getBoolean(KEY_CLUSTER_MODE_STATUS);
}
- public void setMyKey(Boolean myKey) {
- setParameters(KEY_MY_KEY, myKey);
+ public UnsubscribeVehicleData setMyKey( Boolean myKey) {
+ setParameters(KEY_MY_KEY, myKey);
+ return this;
}
public Boolean getMyKey() {
return getBoolean(KEY_MY_KEY);
@@ -823,9 +848,10 @@ public class UnsubscribeVehicleData extends RPCRequest { * @param fuelRange
* a boolean value
*/
- public void setFuelRange(Boolean fuelRange) {
- setParameters(KEY_FUEL_RANGE, fuelRange);
- }
+ public UnsubscribeVehicleData setFuelRange( Boolean fuelRange) {
+ setParameters(KEY_FUEL_RANGE, fuelRange);
+ return this;
+ }
/**
* Gets a boolean value. If true, means the fuelRange data has been
@@ -842,7 +868,10 @@ public class UnsubscribeVehicleData extends RPCRequest { * Sets a boolean value. If true, unsubscribes from turnSignal data
* @param turnSignal a boolean value
*/
- public void setTurnSignal(Boolean turnSignal) { setParameters(KEY_TURN_SIGNAL, turnSignal); }
+ public UnsubscribeVehicleData setTurnSignal( Boolean turnSignal) {
+ setParameters(KEY_TURN_SIGNAL, turnSignal);
+ return this;
+ }
/**
* Gets a boolean value. If true, means the turnSignal data has been unsubscribed.
@@ -854,9 +883,10 @@ public class UnsubscribeVehicleData extends RPCRequest { * Sets a boolean value. If true, unsubscribes from electronicParkBrakeStatus data
* @param electronicParkBrakeStatus a boolean value
*/
- public void setElectronicParkBrakeStatus(Boolean electronicParkBrakeStatus) {
- setParameters(KEY_ELECTRONIC_PARK_BRAKE_STATUS, electronicParkBrakeStatus);
- }
+ public UnsubscribeVehicleData setElectronicParkBrakeStatus( Boolean electronicParkBrakeStatus) {
+ setParameters(KEY_ELECTRONIC_PARK_BRAKE_STATUS, electronicParkBrakeStatus);
+ return this;
+ }
/**
* Gets a boolean value. If true, means the electronicParkBrakeStatus data has been subscribed.
@@ -868,11 +898,12 @@ public class UnsubscribeVehicleData extends RPCRequest { /**
* Sets a boolean value. If true, unsubscribes from cloudAppVehicleID data
- * @param cloudAppVehicleID a boolean value.
+ * @param cloudAppVehicleID a boolean value.
*/
- public void setCloudAppVehicleID(boolean cloudAppVehicleID){
- setParameters(KEY_CLOUD_APP_VEHICLE_ID, cloudAppVehicleID);
- }
+ public UnsubscribeVehicleData setCloudAppVehicleID( boolean cloudAppVehicleID) {
+ setParameters(KEY_CLOUD_APP_VEHICLE_ID, cloudAppVehicleID);
+ return this;
+ }
/**
* Gets a boolean value. If true, means the cloudAppVehicleID data has been unsubscribed.
@@ -887,9 +918,10 @@ public class UnsubscribeVehicleData extends RPCRequest { * @param vehicleDataName a String value
* @param vehicleDataState a boolean value
*/
- public void setOEMCustomVehicleData(String vehicleDataName, Boolean vehicleDataState){
- setParameters(vehicleDataName, vehicleDataState);
- }
+ public UnsubscribeVehicleData setOEMCustomVehicleData( String vehicleDataName, Boolean vehicleDataState) {
+ setParameters(vehicleDataName, vehicleDataState);
+ return this;
+ }
/**
* Gets a boolean value for OEM Custom VehicleData.
@@ -905,8 +937,9 @@ public class UnsubscribeVehicleData extends RPCRequest { * @param gearStatus See GearStatus
* @since SmartDeviceLink 7.0.0
*/
- public void setGearStatus(Boolean gearStatus) {
+ public UnsubscribeVehicleData setGearStatus( Boolean gearStatus) {
setParameters(KEY_GEAR_STATUS, gearStatus);
+ return this;
}
/**
@@ -925,8 +958,9 @@ public class UnsubscribeVehicleData extends RPCRequest { * @param handsOffSteering To indicate whether driver hands are off the steering wheel
* @since SmartDeviceLink 7.0.0
*/
- public void setHandsOffSteering(Boolean handsOffSteering) {
+ public UnsubscribeVehicleData setHandsOffSteering( Boolean handsOffSteering) {
setParameters(KEY_HANDS_OFF_STEERING, handsOffSteering);
+ return this;
}
/**
@@ -945,8 +979,9 @@ public class UnsubscribeVehicleData extends RPCRequest { * @param windowStatus See WindowStatus
* @since SmartDeviceLink 7.0.0
*/
- public void setWindowStatus(Boolean windowStatus) {
+ public UnsubscribeVehicleData setWindowStatus( Boolean windowStatus) {
setParameters(KEY_WINDOW_STATUS, windowStatus);
+ return this;
}
/**
@@ -965,8 +1000,9 @@ public class UnsubscribeVehicleData extends RPCRequest { * @param stabilityControlsStatus See StabilityControlsStatus
* @since SmartDeviceLink 7.0.0
*/
- public void setStabilityControlsStatus(Boolean stabilityControlsStatus) {
+ public UnsubscribeVehicleData setStabilityControlsStatus( Boolean stabilityControlsStatus) {
setParameters(KEY_STABILITY_CONTROLS_STATUS, stabilityControlsStatus);
+ return this;
}
/**
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/UnsubscribeVehicleDataResponse.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/UnsubscribeVehicleDataResponse.java index 5abf391d1..4f3abd5b7 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/UnsubscribeVehicleDataResponse.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/UnsubscribeVehicleDataResponse.java @@ -120,8 +120,9 @@ public class UnsubscribeVehicleDataResponse extends RPCResponse { * Sets Gps
* @param gps a VehicleDataResult related to GPS
*/
- public void setGps(VehicleDataResult gps) {
+ public UnsubscribeVehicleDataResponse setGps( VehicleDataResult gps) {
setParameters(KEY_GPS, gps);
+ return this;
}
/**
* Gets Gps
@@ -135,8 +136,9 @@ public class UnsubscribeVehicleDataResponse extends RPCResponse { * Sets Speed
* @param speed a VehicleDataResult related to speed
*/
- public void setSpeed(VehicleDataResult speed) {
+ public UnsubscribeVehicleDataResponse setSpeed( VehicleDataResult speed) {
setParameters(KEY_SPEED, speed);
+ return this;
}
/**
* Gets Speed
@@ -150,8 +152,9 @@ public class UnsubscribeVehicleDataResponse extends RPCResponse { * Sets rpm
* @param rpm a VehicleDataResult related to RPM
*/
- public void setRpm(VehicleDataResult rpm) {
+ public UnsubscribeVehicleDataResponse setRpm( VehicleDataResult rpm) {
setParameters(KEY_RPM, rpm);
+ return this;
}
/**
* Gets rpm
@@ -168,8 +171,9 @@ public class UnsubscribeVehicleDataResponse extends RPCResponse { * 7.0, please see fuelRange.
*/
@Deprecated
- public void setFuelLevel(VehicleDataResult fuelLevel) {
+ public UnsubscribeVehicleDataResponse setFuelLevel( VehicleDataResult fuelLevel) {
setParameters(KEY_FUEL_LEVEL, fuelLevel);
+ return this;
}
/**
* Gets the fuelLevel.
@@ -187,8 +191,9 @@ public class UnsubscribeVehicleDataResponse extends RPCResponse { * @param fuelLevelState a VehicleDataResult related to FuelLevel State
*/
@Deprecated
- public void setFuelLevelState(VehicleDataResult fuelLevelState) {
+ public UnsubscribeVehicleDataResponse setFuelLevelState( VehicleDataResult fuelLevelState) {
setParameters(KEY_FUEL_LEVEL_STATE, fuelLevelState);
+ return this;
}
/**
* Gets Fuel Level State
@@ -203,8 +208,9 @@ public class UnsubscribeVehicleDataResponse extends RPCResponse { * Sets Instant Fuel Consumption
* @param instantFuelConsumption a VehicleDataResult related to instant fuel consumption
*/
- public void setInstantFuelConsumption(VehicleDataResult instantFuelConsumption) {
+ public UnsubscribeVehicleDataResponse setInstantFuelConsumption( VehicleDataResult instantFuelConsumption) {
setParameters(KEY_INSTANT_FUEL_CONSUMPTION, instantFuelConsumption);
+ return this;
}
/**
* Gets Instant Fuel Consumption
@@ -218,8 +224,9 @@ public class UnsubscribeVehicleDataResponse extends RPCResponse { * Sets External Temperature
* @param externalTemperature a VehicleDataResult related to external temperature
*/
- public void setExternalTemperature(VehicleDataResult externalTemperature) {
+ public UnsubscribeVehicleDataResponse setExternalTemperature( VehicleDataResult externalTemperature) {
setParameters(KEY_EXTERNAL_TEMPERATURE, externalTemperature);
+ return this;
}
/**
* Gets External Temperature
@@ -236,8 +243,9 @@ public class UnsubscribeVehicleDataResponse extends RPCResponse { * @deprecated in SmartDeviceLink 7.0.0
*/
@Deprecated
- public void setPrndl(VehicleDataResult prndl) {
+ public UnsubscribeVehicleDataResponse setPrndl( VehicleDataResult prndl) {
setParameters(KEY_PRNDL, prndl);
+ return this;
}
/**
* Gets the prndl.
@@ -254,8 +262,9 @@ public class UnsubscribeVehicleDataResponse extends RPCResponse { * Sets Tire Pressure
* @param tirePressure a VehicleDataResult related to tire pressure
*/
- public void setTirePressure(VehicleDataResult tirePressure) {
+ public UnsubscribeVehicleDataResponse setTirePressure( VehicleDataResult tirePressure) {
setParameters(KEY_TIRE_PRESSURE, tirePressure);
+ return this;
}
/**
* Gets Tire Pressure
@@ -269,8 +278,9 @@ public class UnsubscribeVehicleDataResponse extends RPCResponse { * Sets Odometer
* @param odometer a VehicleDataResult related to the odometer
*/
- public void setOdometer(VehicleDataResult odometer) {
+ public UnsubscribeVehicleDataResponse setOdometer( VehicleDataResult odometer) {
setParameters(KEY_ODOMETER, odometer);
+ return this;
}
/**
* Gets Odometer
@@ -284,8 +294,9 @@ public class UnsubscribeVehicleDataResponse extends RPCResponse { * Sets Belt Status
* @param beltStatus a VehicleDataResult related to the seat belt status
*/
- public void setBeltStatus(VehicleDataResult beltStatus) {
+ public UnsubscribeVehicleDataResponse setBeltStatus( VehicleDataResult beltStatus) {
setParameters(KEY_BELT_STATUS, beltStatus);
+ return this;
}
/**
* Gets Belt Status
@@ -299,8 +310,9 @@ public class UnsubscribeVehicleDataResponse extends RPCResponse { * Sets Body Information
* @param bodyInformation a VehicleDataResult related to the body info
*/
- public void setBodyInformation(VehicleDataResult bodyInformation) {
+ public UnsubscribeVehicleDataResponse setBodyInformation( VehicleDataResult bodyInformation) {
setParameters(KEY_BODY_INFORMATION, bodyInformation);
+ return this;
}
/**
* Gets Body Information
@@ -314,8 +326,9 @@ public class UnsubscribeVehicleDataResponse extends RPCResponse { * Sets Device Status
* @param deviceStatus a VehicleDataResult related to the device status of the connected device
*/
- public void setDeviceStatus(VehicleDataResult deviceStatus) {
+ public UnsubscribeVehicleDataResponse setDeviceStatus( VehicleDataResult deviceStatus) {
setParameters(KEY_DEVICE_STATUS, deviceStatus);
+ return this;
}
/**
* Gets Device Status
@@ -329,8 +342,9 @@ public class UnsubscribeVehicleDataResponse extends RPCResponse { * Sets Driver Braking
* @param driverBraking a VehicleDataResult related to the driver breaking status
*/
- public void setDriverBraking(VehicleDataResult driverBraking) {
+ public UnsubscribeVehicleDataResponse setDriverBraking( VehicleDataResult driverBraking) {
setParameters(KEY_DRIVER_BRAKING, driverBraking);
+ return this;
}
/**
* Gets Driver Braking
@@ -344,8 +358,9 @@ public class UnsubscribeVehicleDataResponse extends RPCResponse { * Sets Wiper Status
* @param wiperStatus a VehicleDataResult related to the wiper status
*/
- public void setWiperStatus(VehicleDataResult wiperStatus) {
+ public UnsubscribeVehicleDataResponse setWiperStatus( VehicleDataResult wiperStatus) {
setParameters(KEY_WIPER_STATUS, wiperStatus);
+ return this;
}
/**
* Gets Wiper Status
@@ -359,8 +374,9 @@ public class UnsubscribeVehicleDataResponse extends RPCResponse { * Sets Head Lamp Status
* @param headLampStatus a VehicleDataResult related to the headlamp status
*/
- public void setHeadLampStatus(VehicleDataResult headLampStatus) {
+ public UnsubscribeVehicleDataResponse setHeadLampStatus( VehicleDataResult headLampStatus) {
setParameters(KEY_HEAD_LAMP_STATUS, headLampStatus);
+ return this;
}
/**
* Gets Head Lamp Status
@@ -374,8 +390,9 @@ public class UnsubscribeVehicleDataResponse extends RPCResponse { * Sets Engine Torque
* @param engineTorque a VehicleDataResult related to the engine's torque
*/
- public void setEngineTorque(VehicleDataResult engineTorque) {
+ public UnsubscribeVehicleDataResponse setEngineTorque( VehicleDataResult engineTorque) {
setParameters(KEY_ENGINE_TORQUE, engineTorque);
+ return this;
}
/**
* Gets Engine Torque
@@ -389,8 +406,9 @@ public class UnsubscribeVehicleDataResponse extends RPCResponse { * Sets Engine Oil Life
* @param engineOilLife a VehicleDataResult related to the engine's oil life
*/
- public void setEngineOilLife(VehicleDataResult engineOilLife) {
+ public UnsubscribeVehicleDataResponse setEngineOilLife( VehicleDataResult engineOilLife) {
setParameters(KEY_ENGINE_OIL_LIFE, engineOilLife);
+ return this;
}
/**
* Gets Engine Oil Life
@@ -404,8 +422,9 @@ public class UnsubscribeVehicleDataResponse extends RPCResponse { * Sets AccPedal Position
* @param accPedalPosition a VehicleDataResult related to the accelerator pedal's position
*/
- public void setAccPedalPosition(VehicleDataResult accPedalPosition) {
+ public UnsubscribeVehicleDataResponse setAccPedalPosition( VehicleDataResult accPedalPosition) {
setParameters(KEY_ACC_PEDAL_POSITION, accPedalPosition);
+ return this;
}
/**
* Gets AccPedal Position
@@ -416,8 +435,9 @@ public class UnsubscribeVehicleDataResponse extends RPCResponse { return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_ACC_PEDAL_POSITION);
}
- public void setSteeringWheelAngle(VehicleDataResult steeringWheelAngle) {
+ public UnsubscribeVehicleDataResponse setSteeringWheelAngle( VehicleDataResult steeringWheelAngle) {
setParameters(KEY_STEERING_WHEEL_ANGLE, steeringWheelAngle);
+ return this;
}
@SuppressWarnings("unchecked")
@@ -425,36 +445,41 @@ public class UnsubscribeVehicleDataResponse extends RPCResponse { return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_STEERING_WHEEL_ANGLE);
}
- public void setECallInfo(VehicleDataResult eCallInfo) {
+ public UnsubscribeVehicleDataResponse setECallInfo( VehicleDataResult eCallInfo) {
setParameters(KEY_E_CALL_INFO, eCallInfo);
+ return this;
}
@SuppressWarnings("unchecked")
public VehicleDataResult getECallInfo() {
return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_E_CALL_INFO);
}
- public void setAirbagStatus(VehicleDataResult airbagStatus) {
+ public UnsubscribeVehicleDataResponse setAirbagStatus( VehicleDataResult airbagStatus) {
setParameters(KEY_AIRBAG_STATUS, airbagStatus);
+ return this;
}
@SuppressWarnings("unchecked")
public VehicleDataResult getAirbagStatus() {
return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_AIRBAG_STATUS);
}
- public void setEmergencyEvent(VehicleDataResult emergencyEvent) {
+ public UnsubscribeVehicleDataResponse setEmergencyEvent( VehicleDataResult emergencyEvent) {
setParameters(KEY_EMERGENCY_EVENT, emergencyEvent);
+ return this;
}
@SuppressWarnings("unchecked")
public VehicleDataResult getEmergencyEvent() {
return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_EMERGENCY_EVENT);
}
- public void setClusterModeStatus(VehicleDataResult clusterModeStatus) {
+ public UnsubscribeVehicleDataResponse setClusterModeStatus( VehicleDataResult clusterModeStatus) {
setParameters(KEY_CLUSTER_MODE_STATUS, clusterModeStatus);
+ return this;
}
@SuppressWarnings("unchecked")
public VehicleDataResult getClusterModeStatus() {
return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_CLUSTER_MODE_STATUS);
}
- public void setMyKey(VehicleDataResult myKey) {
+ public UnsubscribeVehicleDataResponse setMyKey( VehicleDataResult myKey) {
setParameters(KEY_MY_KEY, myKey);
+ return this;
}
@SuppressWarnings("unchecked")
public VehicleDataResult getMyKey() {
@@ -468,8 +493,9 @@ public class UnsubscribeVehicleDataResponse extends RPCResponse { * vehicle. See struct FuelRange for details.
* @since SmartDeviceLink 5.0.0
*/
- public void setFuelRange(VehicleDataResult fuelRange) {
+ public UnsubscribeVehicleDataResponse setFuelRange( VehicleDataResult fuelRange) {
setParameters(KEY_FUEL_RANGE, fuelRange);
+ return this;
}
/**
@@ -487,8 +513,9 @@ public class UnsubscribeVehicleDataResponse extends RPCResponse { * Sets turnSignal
* @param turnSignal a VehicleDataResult related to the turn signal status
*/
- public void setTurnSignal(VehicleDataResult turnSignal) {
+ public UnsubscribeVehicleDataResponse setTurnSignal( VehicleDataResult turnSignal) {
setParameters(KEY_TURN_SIGNAL, turnSignal);
+ return this;
}
/**
@@ -504,8 +531,9 @@ public class UnsubscribeVehicleDataResponse extends RPCResponse { * Sets electronicParkBrakeStatus
* @param electronicParkBrakeStatus a VehicleDataResult related to the electronic park brake status
*/
- public void setElectronicParkBrakeStatus(VehicleDataResult electronicParkBrakeStatus){
+ public UnsubscribeVehicleDataResponse setElectronicParkBrakeStatus( VehicleDataResult electronicParkBrakeStatus) {
setParameters(KEY_ELECTRONIC_PARK_BRAKE_STATUS, electronicParkBrakeStatus);
+ return this;
}
/**
@@ -520,8 +548,9 @@ public class UnsubscribeVehicleDataResponse extends RPCResponse { * Sets cloudAppVehicleID
* @param cloudAppVehicleID a VehicleDataResult related to the cloud app vehicle ID
*/
- public void setCloudAppVehicleID(VehicleDataResult cloudAppVehicleID){
+ public UnsubscribeVehicleDataResponse setCloudAppVehicleID( VehicleDataResult cloudAppVehicleID) {
setParameters(KEY_CLOUD_APP_VEHICLE_ID, cloudAppVehicleID);
+ return this;
}
/**
@@ -537,8 +566,9 @@ public class UnsubscribeVehicleDataResponse extends RPCResponse { * @param vehicleDataName a String value
* @param vehicleDataState a VehicleDataResult value
*/
- public void setOEMCustomVehicleData(String vehicleDataName, VehicleDataResult vehicleDataState){
+ public UnsubscribeVehicleDataResponse setOEMCustomVehicleData( String vehicleDataName, VehicleDataResult vehicleDataState) {
setParameters(vehicleDataName, vehicleDataState);
+ return this;
}
/**
@@ -555,8 +585,9 @@ public class UnsubscribeVehicleDataResponse extends RPCResponse { * @param handsOffSteering To indicate whether driver hands are off the steering wheel
* @since SmartDeviceLink 7.0.0
*/
- public void setHandsOffSteering(VehicleDataResult handsOffSteering) {
+ public UnsubscribeVehicleDataResponse setHandsOffSteering( VehicleDataResult handsOffSteering) {
setParameters(KEY_HANDS_OFF_STEERING, handsOffSteering);
+ return this;
}
/**
@@ -575,8 +606,9 @@ public class UnsubscribeVehicleDataResponse extends RPCResponse { * @param windowStatus See WindowStatus
* @since SmartDeviceLink 7.0.0
*/
- public void setWindowStatus(VehicleDataResult windowStatus) {
+ public UnsubscribeVehicleDataResponse setWindowStatus( VehicleDataResult windowStatus) {
setParameters(KEY_WINDOW_STATUS, windowStatus);
+ return this;
}
/**
@@ -595,8 +627,9 @@ public class UnsubscribeVehicleDataResponse extends RPCResponse { * @param gearStatus See GearStatus
* @since SmartDeviceLink 7.0.0
*/
- public void setGearStatus(VehicleDataResult gearStatus){
+ public UnsubscribeVehicleDataResponse setGearStatus( VehicleDataResult gearStatus) {
setParameters(KEY_GEAR_STATUS, gearStatus);
+ return this;
}
/**
@@ -626,7 +659,8 @@ public class UnsubscribeVehicleDataResponse extends RPCResponse { * @param stabilityControlsStatus See StabilityControlsStatus
* @since SmartDeviceLink 7.0.0
*/
- public void setStabilityControlsStatus(VehicleDataResult stabilityControlsStatus) {
+ public UnsubscribeVehicleDataResponse setStabilityControlsStatus( VehicleDataResult stabilityControlsStatus) {
setParameters(KEY_STABILITY_CONTROLS_STATUS, stabilityControlsStatus);
+ return this;
}
}
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/UpdateTurnList.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/UpdateTurnList.java index cafd04d88..a19a9c2ea 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/UpdateTurnList.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/UpdateTurnList.java @@ -75,14 +75,15 @@ public class UpdateTurnList extends RPCRequest{ /** * Sets a list of turns to be shown to the user - * + * * @param turnList * a List<Turn> value representing a list of turns to be shown to the user * <p> * <b>Notes: </b>Minsize=1; Maxsize=100</p> */ - public void setTurnList(List<Turn> turnList){ + public UpdateTurnList setTurnList( List<Turn> turnList) { setParameters(KEY_TURN_LIST, turnList); + return this; } /** @@ -108,7 +109,7 @@ public class UpdateTurnList extends RPCRequest{ /** * Sets the SoftButtons - * + * * @param softButtons * a List<SoftButton> value * <p> @@ -121,8 +122,9 @@ public class UpdateTurnList extends RPCRequest{ * @since SmartDeviceLink 2.0 */ - public void setSoftButtons(List<SoftButton> softButtons){ + public UpdateTurnList setSoftButtons( List<SoftButton> softButtons) { setParameters(KEY_SOFT_BUTTONS, softButtons); + return this; } } diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/VehicleDataResult.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/VehicleDataResult.java index 5e50f18e9..cf22bc11c 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/VehicleDataResult.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/VehicleDataResult.java @@ -100,25 +100,28 @@ public class VehicleDataResult extends RPCStruct { setResultCode(resultCode);
}
- public void setResultCode(@NonNull VehicleDataResultCode resultCode) {
- setValue(KEY_RESULT_CODE, resultCode);
- }
+ public VehicleDataResult setResultCode(@NonNull VehicleDataResultCode resultCode) {
+ setValue(KEY_RESULT_CODE, resultCode);
+ return this;
+ }
public VehicleDataResultCode getResultCode() {
return (VehicleDataResultCode) getObject(VehicleDataResultCode.class, KEY_RESULT_CODE);
}
- public void setDataType(@NonNull VehicleDataType dataType) {
- setValue(KEY_DATA_TYPE, dataType);
- }
+ public VehicleDataResult setDataType(@NonNull VehicleDataType dataType) {
+ setValue(KEY_DATA_TYPE, dataType);
+ return this;
+ }
public VehicleDataType getDataType() {
return (VehicleDataType) getObject(VehicleDataType.class, KEY_DATA_TYPE);
}
- public void setOEMCustomVehicleDataType(String oemCustomDataType) {
- setValue(KEY_OEM_CUSTOM_DATA_TYPE, oemCustomDataType);
- }
+ public VehicleDataResult setOEMCustomVehicleDataType( String oemCustomDataType) {
+ setValue(KEY_OEM_CUSTOM_DATA_TYPE, oemCustomDataType);
+ return this;
+ }
public String getOEMCustomVehicleDataType() {
return (String) getObject(String.class, KEY_OEM_CUSTOM_DATA_TYPE);
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/VehicleType.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/VehicleType.java index 5858ce39e..27b1ff42a 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/VehicleType.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/VehicleType.java @@ -1,34 +1,34 @@ -/* - * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this - * list of conditions and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following - * disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its - * contributors may be used to endorse or promote products derived from this - * software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ +/*
+ * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
package com.smartdevicelink.proxy.rpc;
import com.smartdevicelink.proxy.RPCStruct;
@@ -119,8 +119,9 @@ public class VehicleType extends RPCStruct { * set the make of the vehicle
*@param make the make of the vehicle
*/
- public void setMake(String make) {
+ public VehicleType setMake( String make) {
setValue(KEY_MAKE, make);
+ return this;
}
/**
@@ -135,8 +136,9 @@ public class VehicleType extends RPCStruct { * set the model of the vehicle
* @param model the model of the vehicle
*/
- public void setModel(String model) {
+ public VehicleType setModel( String model) {
setValue(KEY_MODEL, model);
+ return this;
}
/**
@@ -151,8 +153,9 @@ public class VehicleType extends RPCStruct { * set the model year of the vehicle
* @param modelYear the model year of the vehicle
*/
- public void setModelYear(String modelYear) {
+ public VehicleType setModelYear( String modelYear) {
setValue(KEY_MODEL_YEAR, modelYear);
+ return this;
}
/**
@@ -167,7 +170,8 @@ public class VehicleType extends RPCStruct { * set the trim of the vehicle
* @param trim the trim of the vehicle
*/
- public void setTrim(String trim) {
+ public VehicleType setTrim( String trim) {
setValue(KEY_TRIM, trim);
+ return this;
}
}
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/VideoStreamingCapability.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/VideoStreamingCapability.java index ca13ba74f..872992ba1 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/VideoStreamingCapability.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/VideoStreamingCapability.java @@ -53,9 +53,10 @@ public class VideoStreamingCapability extends RPCStruct { public VideoStreamingCapability(){} public VideoStreamingCapability(Hashtable<String, Object> hash){super(hash);} - public void setPreferredResolution(ImageResolution res){ - setValue(KEY_PREFERRED_RESOLUTION, res); - } + public VideoStreamingCapability setPreferredResolution( ImageResolution res) { + setValue(KEY_PREFERRED_RESOLUTION, res); + return this; + } public ImageResolution getPreferredResolution(){ return (ImageResolution) getObject(ImageResolution.class, KEY_PREFERRED_RESOLUTION); @@ -67,9 +68,10 @@ public class VideoStreamingCapability extends RPCStruct { * <b>NOTE: </b> Unit is in kbps. * @param maxBitrate in kbps */ - public void setMaxBitrate(Integer maxBitrate){ - setValue(KEY_MAX_BITRATE, maxBitrate); - } + public VideoStreamingCapability setMaxBitrate( Integer maxBitrate) { + setValue(KEY_MAX_BITRATE, maxBitrate); + return this; + } /** * Retrieves the max bitrate supported by this module. @@ -81,9 +83,10 @@ public class VideoStreamingCapability extends RPCStruct { return getInteger(KEY_MAX_BITRATE); } - public void setSupportedFormats(List<VideoStreamingFormat> formats){ - setValue(KEY_SUPPORTED_FORMATS, formats); - } + public VideoStreamingCapability setSupportedFormats( List<VideoStreamingFormat> formats) { + setValue(KEY_SUPPORTED_FORMATS, formats); + return this; + } public List<VideoStreamingFormat> getSupportedFormats(){ return (List<VideoStreamingFormat>) getObject(VideoStreamingFormat.class, KEY_SUPPORTED_FORMATS); @@ -93,9 +96,10 @@ public class VideoStreamingCapability extends RPCStruct { return getBoolean(KEY_HAPTIC_SPATIAL_DATA_SUPPORTED); } - public void setIsHapticSpatialDataSupported(Boolean hapticSpatialDataSupported) { - setValue(KEY_HAPTIC_SPATIAL_DATA_SUPPORTED, hapticSpatialDataSupported); - } + public VideoStreamingCapability setIsHapticSpatialDataSupported( Boolean hapticSpatialDataSupported) { + setValue(KEY_HAPTIC_SPATIAL_DATA_SUPPORTED, hapticSpatialDataSupported); + return this; + } /** * @return the diagonal screen size in inches. @@ -108,9 +112,10 @@ public class VideoStreamingCapability extends RPCStruct { /** * @param diagonalScreenSize the diagonal screen size in inches. */ - public void setDiagonalScreenSize(Double diagonalScreenSize) { - setValue(KEY_DIAGONAL_SCREEN_SIZE, diagonalScreenSize); - } + public VideoStreamingCapability setDiagonalScreenSize( Double diagonalScreenSize) { + setValue(KEY_DIAGONAL_SCREEN_SIZE, diagonalScreenSize); + return this; + } /** * @return the diagonal resolution in pixels divided by the diagonal screen size in inches. @@ -123,9 +128,10 @@ public class VideoStreamingCapability extends RPCStruct { /** * @param pixelPerInch the diagonal resolution in pixels divided by the diagonal screen size in inches. */ - public void setPixelPerInch(Double pixelPerInch) { - setValue(KEY_PIXEL_PER_INCH, pixelPerInch); - } + public VideoStreamingCapability setPixelPerInch( Double pixelPerInch) { + setValue(KEY_PIXEL_PER_INCH, pixelPerInch); + return this; + } /** * @return the scaling factor the app should use to change the size of the projecting view. @@ -138,7 +144,8 @@ public class VideoStreamingCapability extends RPCStruct { /** * @param scale the scaling factor the app should use to change the size of the projecting view. */ - public void setScale(Double scale) { - setValue(KEY_SCALE, scale); - } + public VideoStreamingCapability setScale( Double scale) { + setValue(KEY_SCALE, scale); + return this; + } } diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/VideoStreamingFormat.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/VideoStreamingFormat.java index 92c16cebc..0fac119f2 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/VideoStreamingFormat.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/VideoStreamingFormat.java @@ -61,17 +61,19 @@ public class VideoStreamingFormat extends RPCStruct { setCodec(codec); } - public void setProtocol(@NonNull VideoStreamingProtocol protocol){ - setValue(KEY_PROTOCOL, protocol); - } + public VideoStreamingFormat setProtocol(@NonNull VideoStreamingProtocol protocol) { + setValue(KEY_PROTOCOL, protocol); + return this; + } public VideoStreamingProtocol getProtocol(){ return (VideoStreamingProtocol) getObject(VideoStreamingProtocol.class, KEY_PROTOCOL); } - public void setCodec(@NonNull VideoStreamingCodec codec){ - setValue(KEY_CODEC, codec); - } + public VideoStreamingFormat setCodec(@NonNull VideoStreamingCodec codec) { + setValue(KEY_CODEC, codec); + return this; + } public VideoStreamingCodec getCodec(){ return (VideoStreamingCodec) getObject(VideoStreamingCodec.class, KEY_CODEC); diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/VrHelpItem.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/VrHelpItem.java index 0acb5b8dd..2ba56c4db 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/VrHelpItem.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/VrHelpItem.java @@ -1,34 +1,34 @@ -/* - * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this - * list of conditions and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following - * disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its - * contributors may be used to endorse or promote products derived from this - * software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ +/*
+ * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
package com.smartdevicelink.proxy.rpc;
import androidx.annotation.NonNull;
@@ -107,21 +107,24 @@ public class VrHelpItem extends RPCStruct { setPosition(position);
}
- public void setText(@NonNull String text) {
+ public VrHelpItem setText(@NonNull String text) {
setValue(KEY_TEXT, text);
+ return this;
}
public String getText() {
return getString(KEY_TEXT);
}
- public void setImage(Image image) {
+ public VrHelpItem setImage( Image image) {
setValue(KEY_IMAGE, image);
+ return this;
}
@SuppressWarnings("unchecked")
public Image getImage() {
return (Image) getObject(Image.class, KEY_IMAGE);
}
- public void setPosition(@NonNull Integer position) {
+ public VrHelpItem setPosition(@NonNull Integer position) {
setValue(KEY_POSITION, position);
+ return this;
}
public Integer getPosition() {
return getInteger(KEY_POSITION);
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/WeatherAlert.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/WeatherAlert.java index 2d3afdfb4..23f183da5 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/WeatherAlert.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/WeatherAlert.java @@ -66,9 +66,10 @@ public class WeatherAlert extends RPCStruct { /** * @param title - */ - public void setTitle(String title) { - setValue(KEY_TITLE, title); - } + public WeatherAlert setTitle( String title) { + setValue(KEY_TITLE, title); + return this; + } /** * @return title @@ -80,9 +81,10 @@ public class WeatherAlert extends RPCStruct { /** * @param summary - */ - public void setSummary(String summary) { - setValue(KEY_SUMMARY, summary); - } + public WeatherAlert setSummary( String summary) { + setValue(KEY_SUMMARY, summary); + return this; + } /** * @return summary @@ -94,9 +96,10 @@ public class WeatherAlert extends RPCStruct { /** * @param severity - */ - public void setSeverity(String severity) { - setValue(KEY_SEVERITY, severity); - } + public WeatherAlert setSeverity( String severity) { + setValue(KEY_SEVERITY, severity); + return this; + } /** * @return severity @@ -109,9 +112,10 @@ public class WeatherAlert extends RPCStruct { * Min Size: 1, Max Size: 99 * @param regions - */ - public void setRegions(@NonNull List<String> regions) { - setValue(KEY_REGIONS, regions); - } + public WeatherAlert setRegions(@NonNull List<String> regions) { + setValue(KEY_REGIONS, regions); + return this; + } /** * @return regions list @@ -124,9 +128,10 @@ public class WeatherAlert extends RPCStruct { /** * @param expires - */ - public void setExpires(DateTime expires) { - setValue(KEY_EXPIRES, expires); - } + public WeatherAlert setExpires( DateTime expires) { + setValue(KEY_EXPIRES, expires); + return this; + } /** * @return expires @@ -138,9 +143,10 @@ public class WeatherAlert extends RPCStruct { /** * @param timeIssued - */ - public void setTimeIssued(DateTime timeIssued) { - setValue(KEY_TIME_ISSUED, timeIssued); - } + public WeatherAlert setTimeIssued( DateTime timeIssued) { + setValue(KEY_TIME_ISSUED, timeIssued); + return this; + } /** * @return timeIssued diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/WeatherData.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/WeatherData.java index a3b897acb..c9bbf02f4 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/WeatherData.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/WeatherData.java @@ -73,9 +73,10 @@ public class WeatherData extends RPCStruct { /** * @param currentTemperature - */ - public void setCurrentTemperature(Temperature currentTemperature) { - setValue(KEY_CURRENT_TEMPERATURE, currentTemperature); - } + public WeatherData setCurrentTemperature( Temperature currentTemperature) { + setValue(KEY_CURRENT_TEMPERATURE, currentTemperature); + return this; + } /** * @return currentTemperature @@ -87,9 +88,10 @@ public class WeatherData extends RPCStruct { /** * @param temperatureHigh - */ - public void setTemperatureHigh(Temperature temperatureHigh) { - setValue(KEY_TEMPERATURE_HIGH, temperatureHigh); - } + public WeatherData setTemperatureHigh( Temperature temperatureHigh) { + setValue(KEY_TEMPERATURE_HIGH, temperatureHigh); + return this; + } /** * @return temperatureHigh @@ -101,9 +103,10 @@ public class WeatherData extends RPCStruct { /** * @param temperatureLow - */ - public void setTemperatureLow(Temperature temperatureLow) { - setValue(KEY_TEMPERATURE_LOW, temperatureLow); - } + public WeatherData setTemperatureLow( Temperature temperatureLow) { + setValue(KEY_TEMPERATURE_LOW, temperatureLow); + return this; + } /** * @return temperatureLow @@ -115,9 +118,10 @@ public class WeatherData extends RPCStruct { /** * @param apparentTemperature - */ - public void setApparentTemperature(Temperature apparentTemperature) { - setValue(KEY_APPARENT_TEMPERATURE, apparentTemperature); - } + public WeatherData setApparentTemperature( Temperature apparentTemperature) { + setValue(KEY_APPARENT_TEMPERATURE, apparentTemperature); + return this; + } /** * @return apparentTemperature @@ -129,9 +133,10 @@ public class WeatherData extends RPCStruct { /** * @param apparentTemperatureHigh - */ - public void setApparentTemperatureHigh(Temperature apparentTemperatureHigh) { - setValue(KEY_APPARENT_TEMPERATURE_HIGH, apparentTemperatureHigh); - } + public WeatherData setApparentTemperatureHigh( Temperature apparentTemperatureHigh) { + setValue(KEY_APPARENT_TEMPERATURE_HIGH, apparentTemperatureHigh); + return this; + } /** * @return apparentTemperatureHigh @@ -143,9 +148,10 @@ public class WeatherData extends RPCStruct { /** * @param apparentTemperatureLow - */ - public void setApparentTemperatureLow(Temperature apparentTemperatureLow) { - setValue(KEY_APPARENT_TEMPERATURE_LOW, apparentTemperatureLow); - } + public WeatherData setApparentTemperatureLow( Temperature apparentTemperatureLow) { + setValue(KEY_APPARENT_TEMPERATURE_LOW, apparentTemperatureLow); + return this; + } /** * @return apparentTemperatureLow @@ -157,9 +163,10 @@ public class WeatherData extends RPCStruct { /** * @param weatherSummary - */ - public void setWeatherSummary(String weatherSummary) { - setValue(KEY_WEATHER_SUMMARY, weatherSummary); - } + public WeatherData setWeatherSummary( String weatherSummary) { + setValue(KEY_WEATHER_SUMMARY, weatherSummary); + return this; + } /** * @return weatherSummary @@ -171,9 +178,10 @@ public class WeatherData extends RPCStruct { /** * @param time - */ - public void setTime(DateTime time) { - setValue(KEY_TIME, time); - } + public WeatherData setTime( DateTime time) { + setValue(KEY_TIME, time); + return this; + } /** * @return time @@ -186,9 +194,10 @@ public class WeatherData extends RPCStruct { * minValue: 0, maxValue: 1 * @param humidity - percentage humidity */ - public void setHumidity(Float humidity) { - setValue(KEY_HUMIDITY, humidity); - } + public WeatherData setHumidity( Float humidity) { + setValue(KEY_HUMIDITY, humidity); + return this; + } /** * minValue: 0, maxValue: 1 @@ -202,9 +211,10 @@ public class WeatherData extends RPCStruct { * minValue: 0, maxValue: 1 * @param cloudCover - cloud cover */ - public void setCloudCover(Float cloudCover) { - setValue(KEY_CLOUD_COVER, cloudCover); - } + public WeatherData setCloudCover( Float cloudCover) { + setValue(KEY_CLOUD_COVER, cloudCover); + return this; + } /** * minValue: 0, maxValue: 1 @@ -218,9 +228,10 @@ public class WeatherData extends RPCStruct { * minValue: 0, maxValue: 1 * @param moonPhase - percentage of the moon seen, e.g. 0 = no moon, 0.25 = quarter moon */ - public void setMoonPhase(Float moonPhase) { - setValue(KEY_MOON_PHASE, moonPhase); - } + public WeatherData setMoonPhase( Float moonPhase) { + setValue(KEY_MOON_PHASE, moonPhase); + return this; + } /** * minValue: 0, maxValue: 1 @@ -233,9 +244,10 @@ public class WeatherData extends RPCStruct { /** * @param windBearing - In degrees, true north at 0 degrees */ - public void setWindBearing(Integer windBearing) { - setValue(KEY_WIND_BEARING, windBearing); - } + public WeatherData setWindBearing( Integer windBearing) { + setValue(KEY_WIND_BEARING, windBearing); + return this; + } /** * @return windBearing - In degrees, true north at 0 degrees @@ -247,9 +259,10 @@ public class WeatherData extends RPCStruct { /** * @param windGust - km/hr */ - public void setWindGust(Float windGust) { - setValue(KEY_WIND_GUST, windGust); - } + public WeatherData setWindGust( Float windGust) { + setValue(KEY_WIND_GUST, windGust); + return this; + } /** * @return windGust - km/hr @@ -261,9 +274,10 @@ public class WeatherData extends RPCStruct { /** * @param windSpeed - km/hr */ - public void setWindSpeed(Float windSpeed) { - setValue(KEY_WIND_SPEED, windSpeed); - } + public WeatherData setWindSpeed( Float windSpeed) { + setValue(KEY_WIND_SPEED, windSpeed); + return this; + } /** * @return windSpeed - km/hr @@ -275,9 +289,10 @@ public class WeatherData extends RPCStruct { /** * @param nearestStormBearing - In degrees, true north at 0 degrees */ - public void setNearestStormBearing(Integer nearestStormBearing) { - setValue(KEY_NEAREST_STORM_BEARING, nearestStormBearing); - } + public WeatherData setNearestStormBearing( Integer nearestStormBearing) { + setValue(KEY_NEAREST_STORM_BEARING, nearestStormBearing); + return this; + } /** * @return nearestStormBearing - In degrees, true north at 0 degrees @@ -289,9 +304,10 @@ public class WeatherData extends RPCStruct { /** * @param nearestStormDistance - In km */ - public void setNearestStormDistance(Integer nearestStormDistance) { - setValue(KEY_NEAREST_STORM_DISTANCE, nearestStormDistance); - } + public WeatherData setNearestStormDistance( Integer nearestStormDistance) { + setValue(KEY_NEAREST_STORM_DISTANCE, nearestStormDistance); + return this; + } /** * @return nearestStormDistance - In km @@ -303,9 +319,10 @@ public class WeatherData extends RPCStruct { /** * @param precipAccumulation - cm */ - public void setPrecipAccumulation(Float precipAccumulation) { - setValue(KEY_PRECIP_ACCUMULATION, precipAccumulation); - } + public WeatherData setPrecipAccumulation( Float precipAccumulation) { + setValue(KEY_PRECIP_ACCUMULATION, precipAccumulation); + return this; + } /** * @return precipAccumulation - cm @@ -317,9 +334,10 @@ public class WeatherData extends RPCStruct { /** * @param precipIntensity - cm of water per hour */ - public void setPrecipIntensity(Float precipIntensity) { - setValue(KEY_PRECIP_INTENSITY, precipIntensity); - } + public WeatherData setPrecipIntensity( Float precipIntensity) { + setValue(KEY_PRECIP_INTENSITY, precipIntensity); + return this; + } /** * @return precipIntensity - cm of water per hour @@ -332,9 +350,10 @@ public class WeatherData extends RPCStruct { * minValue: 0, maxValue: 1 * @param precipProbability - percentage chance */ - public void setPrecipProbability(Float precipProbability) { - setValue(KEY_PRECIP_PROBABILITY, precipProbability); - } + public WeatherData setPrecipProbability( Float precipProbability) { + setValue(KEY_PRECIP_PROBABILITY, precipProbability); + return this; + } /** * minValue: 0, maxValue: 1 @@ -347,9 +366,10 @@ public class WeatherData extends RPCStruct { /** * @param precipType - e.g. "rain", "snow", "sleet", "hail" */ - public void setPrecipType(String precipType) { - setValue(KEY_PRECIP_TYPE, precipType); - } + public WeatherData setPrecipType( String precipType) { + setValue(KEY_PRECIP_TYPE, precipType); + return this; + } /** * @return precipType - e.g. "rain", "snow", "sleet", "hail" @@ -361,9 +381,10 @@ public class WeatherData extends RPCStruct { /** * @param weatherIcon - */ - public void setWeatherIcon(Image weatherIcon) { - setValue(KEY_WEATHER_ICON, weatherIcon); - } + public WeatherData setWeatherIcon( Image weatherIcon) { + setValue(KEY_WEATHER_ICON, weatherIcon); + return this; + } /** * @return weatherIcon @@ -375,9 +396,10 @@ public class WeatherData extends RPCStruct { /** * @param visibility - In km */ - public void setVisibility(Float visibility) { - setValue(KEY_VISIBILITY, visibility); - } + public WeatherData setVisibility( Float visibility) { + setValue(KEY_VISIBILITY, visibility); + return this; + } /** * @return visibility - In km diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/WeatherServiceData.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/WeatherServiceData.java index 9ae1d4e0d..0d7a26648 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/WeatherServiceData.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/WeatherServiceData.java @@ -68,9 +68,10 @@ public class WeatherServiceData extends RPCStruct { /** * @param location - */ - public void setLocation(@NonNull LocationDetails location) { - setValue(KEY_LOCATION, location); - } + public WeatherServiceData setLocation(@NonNull LocationDetails location) { + setValue(KEY_LOCATION, location); + return this; + } /** * @return location @@ -82,9 +83,10 @@ public class WeatherServiceData extends RPCStruct { /** * @param currentForecast - */ - public void setCurrentForecast(WeatherData currentForecast) { - setValue(KEY_CURRENT_FORECAST, currentForecast); - } + public WeatherServiceData setCurrentForecast( WeatherData currentForecast) { + setValue(KEY_CURRENT_FORECAST, currentForecast); + return this; + } /** * @return currentForecast @@ -97,9 +99,10 @@ public class WeatherServiceData extends RPCStruct { * minsize: 15, maxsize: 60 * @param minuteForecast - */ - public void setMinuteForecast(List<WeatherData> minuteForecast){ - setValue(KEY_MINUTE_FORECAST, minuteForecast); - } + public WeatherServiceData setMinuteForecast( List<WeatherData> minuteForecast) { + setValue(KEY_MINUTE_FORECAST, minuteForecast); + return this; + } /** * minsize: 15, maxsize: 60 @@ -114,9 +117,10 @@ public class WeatherServiceData extends RPCStruct { * minsize: 1, maxsize: 96 * @param hourlyForecast - */ - public void setHourlyForecast(List<WeatherData> hourlyForecast){ - setValue(KEY_HOURLY_FORECAST, hourlyForecast); - } + public WeatherServiceData setHourlyForecast( List<WeatherData> hourlyForecast) { + setValue(KEY_HOURLY_FORECAST, hourlyForecast); + return this; + } /** * minsize: 1, maxsize: 96 @@ -131,9 +135,10 @@ public class WeatherServiceData extends RPCStruct { * minsize: 1, maxsize: 30 * @param multidayForecast - */ - public void setMultidayForecast(List<WeatherData> multidayForecast){ - setValue(KEY_MULTIDAY_FORECAST, multidayForecast); - } + public WeatherServiceData setMultidayForecast( List<WeatherData> multidayForecast) { + setValue(KEY_MULTIDAY_FORECAST, multidayForecast); + return this; + } /** * minsize: 1, maxsize: 30 @@ -148,9 +153,10 @@ public class WeatherServiceData extends RPCStruct { * minsize: 1, maxsize: 10 * @param alerts - */ - public void setAlerts(List<WeatherAlert> alerts){ - setValue(KEY_ALERTS, alerts); - } + public WeatherServiceData setAlerts( List<WeatherAlert> alerts) { + setValue(KEY_ALERTS, alerts); + return this; + } /** * minsize: 1, maxsize: 10 diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/WeatherServiceManifest.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/WeatherServiceManifest.java index 2f6a9f8d3..79a4e5528 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/WeatherServiceManifest.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/WeatherServiceManifest.java @@ -56,9 +56,10 @@ public class WeatherServiceManifest extends RPCStruct { * Set whether the current forecast is supported * @param currentForecastSupported - */ - public void setCurrentForecastSupported(Boolean currentForecastSupported){ - setValue(KEY_CURRENT_FORECAST_SUPPORTED, currentForecastSupported); - } + public WeatherServiceManifest setCurrentForecastSupported( Boolean currentForecastSupported) { + setValue(KEY_CURRENT_FORECAST_SUPPORTED, currentForecastSupported); + return this; + } /** * Get whether the current forecast is supported @@ -72,9 +73,10 @@ public class WeatherServiceManifest extends RPCStruct { * Set the max multi day forecast amount * @param maxMultidayForecastAmount - */ - public void setMaxMultidayForecastAmount(Integer maxMultidayForecastAmount){ - setValue(KEY_MAX_MULTIDAY_FORECAST_AMOUNT, maxMultidayForecastAmount); - } + public WeatherServiceManifest setMaxMultidayForecastAmount( Integer maxMultidayForecastAmount) { + setValue(KEY_MAX_MULTIDAY_FORECAST_AMOUNT, maxMultidayForecastAmount); + return this; + } /** * Get the max multi day forecast amount @@ -88,9 +90,10 @@ public class WeatherServiceManifest extends RPCStruct { * Set the max hourly forecast amount * @param maxHourlyForecastAmount - */ - public void setMaxHourlyForecastAmount(Integer maxHourlyForecastAmount){ - setValue(KEY_MAX_HOURLY_FORECAST_AMOUNT, maxHourlyForecastAmount); - } + public WeatherServiceManifest setMaxHourlyForecastAmount( Integer maxHourlyForecastAmount) { + setValue(KEY_MAX_HOURLY_FORECAST_AMOUNT, maxHourlyForecastAmount); + return this; + } /** * Get the max hourly forecast amount @@ -104,9 +107,10 @@ public class WeatherServiceManifest extends RPCStruct { * Set the max minutely forecast amount * @param maxMinutelyForecastAmount - */ - public void setMaxMinutelyForecastAmount(Integer maxMinutelyForecastAmount){ - setValue(KEY_MAX_MINUTELY_FORECAST_AMOUNT, maxMinutelyForecastAmount); - } + public WeatherServiceManifest setMaxMinutelyForecastAmount( Integer maxMinutelyForecastAmount) { + setValue(KEY_MAX_MINUTELY_FORECAST_AMOUNT, maxMinutelyForecastAmount); + return this; + } /** * Get the max minutely forecast amount @@ -120,9 +124,10 @@ public class WeatherServiceManifest extends RPCStruct { * Set whether the weather is supported for the current location * @param weatherForLocationSupported - */ - public void setWeatherForLocationSupported(Boolean weatherForLocationSupported){ - setValue(KEY_WEATHER_FOR_LOCATION_SUPPORTED, weatherForLocationSupported); - } + public WeatherServiceManifest setWeatherForLocationSupported( Boolean weatherForLocationSupported) { + setValue(KEY_WEATHER_FOR_LOCATION_SUPPORTED, weatherForLocationSupported); + return this; + } /** * Get whether the weather is supported for the current location diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/WindowCapability.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/WindowCapability.java index c93cb50ca..dcf05b4c3 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/WindowCapability.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/WindowCapability.java @@ -34,8 +34,9 @@ public class WindowCapability extends RPCStruct { * * @param windowID A unique ID to identify the window. The value of '0' will always be the default main window on the main display and should not be used in this context as it will already be created for the app. See PredefinedWindows enum. Creating a window with an ID that is already in use will be rejected with `INVALID_ID`. */ - public void setWindowID(Integer windowID) { + public WindowCapability setWindowID( Integer windowID) { setValue(KEY_WINDOW_ID, windowID); + return this; } /** @@ -63,8 +64,9 @@ public class WindowCapability extends RPCStruct { * * @param textFields the List of textFields */ - public void setTextFields(List<TextField> textFields) { + public WindowCapability setTextFields( List<TextField> textFields) { setValue(KEY_TEXT_FIELDS, textFields); + return this; } /** @@ -83,8 +85,9 @@ public class WindowCapability extends RPCStruct { * * @param imageFields the List of imageFields */ - public void setImageFields(List<ImageField> imageFields) { + public WindowCapability setImageFields( List<ImageField> imageFields) { setValue(KEY_IMAGE_FIELDS, imageFields); + return this; } /** @@ -103,8 +106,9 @@ public class WindowCapability extends RPCStruct { * * @param imageTypeSupported the List of ImageType */ - public void setImageTypeSupported(List<ImageType> imageTypeSupported) { + public WindowCapability setImageTypeSupported( List<ImageType> imageTypeSupported) { setValue(KEY_IMAGE_TYPE_SUPPORTED, imageTypeSupported); + return this; } /** @@ -123,8 +127,9 @@ public class WindowCapability extends RPCStruct { * * @param templatesAvailable the List of String */ - public void setTemplatesAvailable(List<String> templatesAvailable) { + public WindowCapability setTemplatesAvailable( List<String> templatesAvailable) { setValue(KEY_TEMPLATES_AVAILABLE, templatesAvailable); + return this; } /** @@ -142,8 +147,9 @@ public class WindowCapability extends RPCStruct { * * @param numCustomPresetsAvailable */ - public void setNumCustomPresetsAvailable(Integer numCustomPresetsAvailable) { + public WindowCapability setNumCustomPresetsAvailable( Integer numCustomPresetsAvailable) { setValue(KEY_NUM_CUSTOM_PRESETS_AVAILABLE, numCustomPresetsAvailable); + return this; } /** @@ -152,8 +158,9 @@ public class WindowCapability extends RPCStruct { * * @param buttonCapabilities It refers to number of buttons and the capabilities of each on-window button. */ - public void setButtonCapabilities(List<ButtonCapabilities> buttonCapabilities) { + public WindowCapability setButtonCapabilities( List<ButtonCapabilities> buttonCapabilities) { setValue(KEY_BUTTON_CAPABILITIES, buttonCapabilities); + return this; } /** @@ -173,8 +180,9 @@ public class WindowCapability extends RPCStruct { * * @param softButtonCapabilities It refers to number of soft buttons available on-window and the capabilities for each button. */ - public void setSoftButtonCapabilities(List<SoftButtonCapabilities> softButtonCapabilities) { + public WindowCapability setSoftButtonCapabilities( List<SoftButtonCapabilities> softButtonCapabilities) { setValue(KEY_SOFT_BUTTON_CAPABILITIES, softButtonCapabilities); + return this; } /** @@ -193,8 +201,9 @@ public class WindowCapability extends RPCStruct { * is assumed to be available * @param menuLayout - An array of MenuLayouts */ - public void setMenuLayoutsAvailable(List<MenuLayout> menuLayout) { + public WindowCapability setMenuLayoutsAvailable( List<MenuLayout> menuLayout) { setValue(KEY_MENU_LAYOUTS_AVAILABLE, menuLayout); + return this; } /** @@ -214,8 +223,9 @@ public class WindowCapability extends RPCStruct { * module will send dynamic update RPCs. * @since SmartDeviceLink 7.0.0 */ - public void setDynamicUpdateCapabilities(DynamicUpdateCapabilities dynamicUpdateCapabilities) { + public WindowCapability setDynamicUpdateCapabilities( DynamicUpdateCapabilities dynamicUpdateCapabilities) { setValue(KEY_DYNAMIC_UPDATE_CAPABILITIES, dynamicUpdateCapabilities); + return this; } /** diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/WindowState.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/WindowState.java index e17d9b7d9..9011f3865 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/WindowState.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/WindowState.java @@ -104,8 +104,9 @@ public class WindowState extends RPCStruct { * @param approximatePosition The approximate percentage that the window is open - 0 being fully closed, 100 being fully * open */ - public void setApproximatePosition(@NonNull Integer approximatePosition) { + public WindowState setApproximatePosition(@NonNull Integer approximatePosition) { setValue(KEY_APPROXIMATE_POSITION, approximatePosition); + return this; } /** @@ -124,8 +125,9 @@ public class WindowState extends RPCStruct { * @param deviation The percentage deviation of the approximatePosition. e.g. If the approximatePosition is 50 * and the deviation is 10, then the window's location is somewhere between 40 and 60. */ - public void setDeviation(@NonNull Integer deviation) { + public WindowState setDeviation(@NonNull Integer deviation) { setValue(KEY_DEVIATION, deviation); + return this; } /** diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/WindowStatus.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/WindowStatus.java index 075d5f142..ebae89ea8 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/WindowStatus.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/WindowStatus.java @@ -103,8 +103,9 @@ public class WindowStatus extends RPCStruct { * * @param location */ - public void setLocation(@NonNull Grid location) { + public WindowStatus setLocation(@NonNull Grid location) { setValue(KEY_LOCATION, location); + return this; } /** @@ -121,8 +122,9 @@ public class WindowStatus extends RPCStruct { * * @param state */ - public void setState(@NonNull WindowState state) { + public WindowStatus setState(@NonNull WindowState state) { setValue(KEY_STATE, state); + return this; } /** diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/WindowTypeCapabilities.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/WindowTypeCapabilities.java index 4853a29a2..c145dc455 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/WindowTypeCapabilities.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/WindowTypeCapabilities.java @@ -47,8 +47,9 @@ public class WindowTypeCapabilities extends RPCStruct { *
* @param type Type of windows available, to create.
*/
- public void setType(@NonNull WindowType type) {
+ public WindowTypeCapabilities setType(@NonNull WindowType type) {
setValue(KEY_TYPE, type);
+ return this;
}
/**
@@ -65,8 +66,9 @@ public class WindowTypeCapabilities extends RPCStruct { *
* @param maximumNumberOfWindows Number of windows available, to create.
*/
- public void setMaximumNumberOfWindows(@NonNull Integer maximumNumberOfWindows) {
+ public WindowTypeCapabilities setMaximumNumberOfWindows(@NonNull Integer maximumNumberOfWindows) {
setValue(KEY_MAXIMUM_NUMBER_OF_WINDOWS, maximumNumberOfWindows);
+ return this;
}
/**
|