SDL_Android/SmartDeviceLinkProxyAndroid/src/com/smartdevicelink/proxy/interfaces/IProxyListenerBase.java

   1 package com.smartdevicelink.proxy.interfaces;\r
   2 \r
   3 import com.smartdevicelink.proxy.rpc.AddCommandResponse;\r
   4 import com.smartdevicelink.proxy.rpc.AddSubMenuResponse;\r
   5 import com.smartdevicelink.proxy.rpc.AlertManeuverResponse;\r
   6 import com.smartdevicelink.proxy.rpc.AlertResponse;\r
   7 import com.smartdevicelink.proxy.rpc.ChangeRegistrationResponse;\r
   8 import com.smartdevicelink.proxy.rpc.CreateInteractionChoiceSetResponse;\r
   9 import com.smartdevicelink.proxy.rpc.DeleteCommandResponse;\r
  10 import com.smartdevicelink.proxy.rpc.DeleteFileResponse;\r
  11 import com.smartdevicelink.proxy.rpc.DeleteInteractionChoiceSetResponse;\r
  12 import com.smartdevicelink.proxy.rpc.DeleteSubMenuResponse;\r
  13 import com.smartdevicelink.proxy.rpc.DialNumberResponse;\r
  14 import com.smartdevicelink.proxy.rpc.EndAudioPassThruResponse;\r
  15 import com.smartdevicelink.proxy.rpc.GenericResponse;\r
  16 import com.smartdevicelink.proxy.rpc.GetDTCsResponse;\r
  17 import com.smartdevicelink.proxy.rpc.GetVehicleDataResponse;\r
  18 import com.smartdevicelink.proxy.rpc.ListFilesResponse;\r
  19 import com.smartdevicelink.proxy.rpc.OnAudioPassThru;\r
  20 import com.smartdevicelink.proxy.rpc.OnButtonEvent;\r
  21 import com.smartdevicelink.proxy.rpc.OnButtonPress;\r
  22 import com.smartdevicelink.proxy.rpc.OnCommand;\r
  23 import com.smartdevicelink.proxy.rpc.OnDriverDistraction;\r
  24 import com.smartdevicelink.proxy.rpc.OnHMIStatus;\r
  25 import com.smartdevicelink.proxy.rpc.OnLanguageChange;\r
  26 import com.smartdevicelink.proxy.rpc.OnPermissionsChange;\r
  27 import com.smartdevicelink.proxy.rpc.OnTBTClientState;\r
  28 import com.smartdevicelink.proxy.rpc.OnVehicleData;\r
  29 import com.smartdevicelink.proxy.rpc.PerformAudioPassThruResponse;\r
  30 import com.smartdevicelink.proxy.rpc.PerformInteractionResponse;\r
  31 import com.smartdevicelink.proxy.rpc.PutFileResponse;\r
  32 import com.smartdevicelink.proxy.rpc.ReadDIDResponse;\r
  33 import com.smartdevicelink.proxy.rpc.ResetGlobalPropertiesResponse;\r
  34 import com.smartdevicelink.proxy.rpc.ScrollableMessageResponse;\r
  35 import com.smartdevicelink.proxy.rpc.SetAppIconResponse;\r
  36 import com.smartdevicelink.proxy.rpc.SetDisplayLayoutResponse;\r
  37 import com.smartdevicelink.proxy.rpc.SetGlobalPropertiesResponse;\r
  38 import com.smartdevicelink.proxy.rpc.SetMediaClockTimerResponse;\r
  39 import com.smartdevicelink.proxy.rpc.ShowConstantTBTResponse;\r
  40 import com.smartdevicelink.proxy.rpc.ShowResponse;\r
  41 import com.smartdevicelink.proxy.rpc.SliderResponse;\r
  42 import com.smartdevicelink.proxy.rpc.SpeakResponse;\r
  43 import com.smartdevicelink.proxy.rpc.SubscribeButtonResponse;\r
  44 import com.smartdevicelink.proxy.rpc.SubscribeVehicleDataResponse;\r
  45 import com.smartdevicelink.proxy.rpc.UnsubscribeButtonResponse;\r
  46 import com.smartdevicelink.proxy.rpc.UnsubscribeVehicleDataResponse;\r
  47 import com.smartdevicelink.proxy.rpc.UpdateTurnListResponse;\r
  48 \r
  49 \r
  50 public interface IProxyListenerBase  {\r
  51 \r
  52         /**\r
  53          * onOnHMIStatus being called indicates that there has been an HMI Level change,\r
  54          * system context change or audio streaming state change.\r
  55          * \r
  56          * @param notification - Contains information about the HMI Level,\r
  57          * system context and audio streaming state.\r
  58          */\r
  59         public void onOnHMIStatus(OnHMIStatus notification);\r
  60 \r
  61         /**\r
  62          * onProxyClosed has different functionality for the different models.\r
  63          * In the non-ALM model this indicates that the proxy has experienced an unrecoverable error.\r
  64          * A new proxy object must be initiated to reestablish connection with SMARTDEVICELINK.\r
  65          * In the ALM model this indicates that the app is no longer registered with SMARTDEVICELINK\r
  66          * All resources on SMARTDEVICELINK (addCommands and ChoiceSets) have been deleted and will have to be\r
  67          * recreated upon the next onReadyForInitialization() call-back. \r
  68          * \r
  69          * @param info - Includes information about the reason the proxy has been closed.\r
  70          * @param e - The exception that occurred. \r
  71          */\r
  72         public void onProxyClosed(String info, Exception e);\r
  73         \r
  74         /**\r
  75          * onProxyError() being called indicates that the SMARTDEVICELINK Proxy experenced an error.\r
  76          * \r
  77          * @param info - Includes information about the Exception that occurred.\r
  78          * @param e - The exception that occurred. \r
  79          */\r
  80         public void onError(String info, Exception e);\r
  81         \r
  82         \r
  83         /**\r
  84          * onGenericResponse() being called indicates that SMARTDEVICELINK could not determine the\r
  85          * type of request it is responding to. This is usually result of an unknown RPC Request\r
  86          * being sent.\r
  87          * \r
  88          * @param response - Includes detailed information about the response.\r
  89          */\r
  90         public void onGenericResponse(GenericResponse response);\r
  91         \r
  92         /**\r
  93          * onOnCommand() being called indicates that the user selected a command on SMARTDEVICELINK.\r
  94          * \r
  95          * @param notification - Contains information about the command chosen.\r
  96          */\r
  97         public void onOnCommand(OnCommand notification);\r
  98         \r
  99         /**\r
 100          * onAddCommandResponse() being called indicates that SMARTDEVICELINK has responded to\r
 101          * a request to add a command.\r
 102          * \r
 103          * @param response - Contains information about the response sent from SMARTDEVICELINK.\r
 104          */\r
 105         public void onAddCommandResponse(AddCommandResponse response);\r
 106         \r
 107         /**\r
 108          * onAddSubMenuResponse() being called indicates that SMARTDEVICELINK has responded to\r
 109          * a request to add a command.\r
 110          * \r
 111          * @param response - Contains information about the response sent from SMARTDEVICELINK.\r
 112          */\r
 113         public void onAddSubMenuResponse(AddSubMenuResponse response);\r
 114         \r
 115         /**\r
 116          * onCreateInteractionChoiceSetResponse() being called indicates that SMARTDEVICELINK has\r
 117          * responded to a request to add an interactionChoiceSet.\r
 118          * \r
 119          * @param response - Contains information about the response sent from SMARTDEVICELINK.\r
 120          */\r
 121         public void onCreateInteractionChoiceSetResponse(CreateInteractionChoiceSetResponse response);\r
 122         \r
 123         /**\r
 124          * onAlertResponse being called indicates that SMARTDEVICELINK has\r
 125          * responded to a request to alert the user. \r
 126          * \r
 127          * @param response - Contains information about the response sent from SMARTDEVICELINK.\r
 128          */\r
 129         public void onAlertResponse(AlertResponse response);\r
 130         \r
 131         /**\r
 132          * onDeleteCommandResponse being called indicates that SMARTDEVICELINK has\r
 133          * responded to a request to delete a command. \r
 134          * \r
 135          * @param response - Contains information about the response sent from SMARTDEVICELINK.\r
 136          */\r
 137         public void onDeleteCommandResponse(DeleteCommandResponse response);\r
 138         \r
 139         /**\r
 140          * onDeleteCommandResponse being called indicates that SMARTDEVICELINK has\r
 141          * responded to a request to delete an interaction choice set. \r
 142          * \r
 143          * @param response - Contains information about the response sent from SMARTDEVICELINK.\r
 144          */\r
 145         public void onDeleteInteractionChoiceSetResponse(DeleteInteractionChoiceSetResponse response);\r
 146         \r
 147         /**\r
 148          * onDeleteCommandResponse being called indicates that SMARTDEVICELINK has\r
 149          * responded to a request to delete a submenu. \r
 150          * \r
 151          * @param response - Contains information about the response sent from SMARTDEVICELINK.\r
 152          */\r
 153         public void onDeleteSubMenuResponse(DeleteSubMenuResponse response);\r
 154         \r
 155         /**\r
 156          * onPerformInteractionResponse being called indicates that SMARTDEVICELINK has\r
 157          * responded to a request to perform an interaction. \r
 158          * \r
 159          * @param response - Contains information about the response sent from SMARTDEVICELINK.\r
 160          */\r
 161         public void onPerformInteractionResponse(PerformInteractionResponse response);\r
 162         \r
 163         /**\r
 164          * onResetGlobalPropertiesResponse being called indicates that SMARTDEVICELINK has\r
 165          * responded to a request to reset global properties. \r
 166          * \r
 167          * @param response - Contains information about the response sent from SMARTDEVICELINK.\r
 168          */\r
 169         public void onResetGlobalPropertiesResponse(ResetGlobalPropertiesResponse response);\r
 170         \r
 171         /**\r
 172          * onSetGlobalPropertiesResponse being called indicates that SMARTDEVICELINK has\r
 173          * responded to a request to set global properties. \r
 174          * \r
 175          * @param response - Contains information about the response sent from SMARTDEVICELINK.\r
 176          */\r
 177         public void onSetGlobalPropertiesResponse(SetGlobalPropertiesResponse response);\r
 178         \r
 179         /**\r
 180          * onSetMediaClockTimerResponse being called indicates that SMARTDEVICELINK has\r
 181          * responded to a request to set the media clock timer. \r
 182          * \r
 183          * @param response - Contains information about the response sent from SMARTDEVICELINK.\r
 184          */\r
 185         public void onSetMediaClockTimerResponse(SetMediaClockTimerResponse response);\r
 186         \r
 187         /**\r
 188          * onShowResponse being called indicates that SMARTDEVICELINK has\r
 189          * responded to a request to display information to the user. \r
 190          * \r
 191          * @param response - Contains information about the response sent from SMARTDEVICELINK.\r
 192          */\r
 193         public void onShowResponse(ShowResponse response);\r
 194         \r
 195         /**\r
 196          * onSpeakResponse being called indicates that SMARTDEVICELINK has\r
 197          * responded to a request to speak information to the user. \r
 198          * \r
 199          * @param response - Contains information about the response sent from SMARTDEVICELINK.\r
 200          */\r
 201         public void onSpeakResponse(SpeakResponse response);\r
 202         \r
 203         /**\r
 204          * onButtonEvent being called indicates that a button event has occurred. \r
 205          * \r
 206          * @param notification - Contains information about the notification sent from SMARTDEVICELINK.\r
 207          */\r
 208         public void onOnButtonEvent(OnButtonEvent notification);\r
 209 \r
 210         /**\r
 211          * onButtonPress being called indicates that SMARTDEVICELINK has a button has \r
 212          * been pressed by the user. \r
 213          * \r
 214          * @param notification - Contains information about the notification sent from SMARTDEVICELINK.\r
 215          */\r
 216         public void onOnButtonPress(OnButtonPress notification);\r
 217         \r
 218         /**\r
 219          * onSubscribeButtonResponse being called indicates that SMARTDEVICELINK has\r
 220          * responded to a request to subscribe to button events and button presses. \r
 221          * \r
 222          * @param response - Contains information about the response sent from SMARTDEVICELINK.\r
 223          */\r
 224         public void onSubscribeButtonResponse(SubscribeButtonResponse response);\r
 225         \r
 226         /**\r
 227          * onUnsubscribeButtonResponse being called indicates that SMARTDEVICELINK has\r
 228          * responded to a request to unsubscribe from button events and button presses. \r
 229          * \r
 230          * @param response - Contains information about the response sent from SMARTDEVICELINK.\r
 231          */\r
 232         public void onUnsubscribeButtonResponse(UnsubscribeButtonResponse response);\r
 233 \r
 234         /**\r
 235          * onOnPermissionsChange being called indicates that your app permissions have \r
 236          * changed due to a policy table change. This can mean your app has received additional\r
 237          * permissions OR lost permissions.\r
 238          * \r
 239          * @param notification - Contains information about the changed permissions.\r
 240          */
 241         public void onOnPermissionsChange(OnPermissionsChange notification);
 242         \r
 243         public void onSubscribeVehicleDataResponse(SubscribeVehicleDataResponse response);\r
 244         \r
 245         public void onUnsubscribeVehicleDataResponse(UnsubscribeVehicleDataResponse response);\r
 246         \r
 247         public void onGetVehicleDataResponse(GetVehicleDataResponse response);\r
 248         \r
 249         public void onReadDIDResponse(ReadDIDResponse response);\r
 250         \r
 251         public void onGetDTCsResponse(GetDTCsResponse response);\r
 252         \r
 253         public void onOnVehicleData(OnVehicleData notification);
 254         \r
 255         public void onPerformAudioPassThruResponse(PerformAudioPassThruResponse response);\r
 256         \r
 257         public void onEndAudioPassThruResponse(EndAudioPassThruResponse response);\r
 258         \r
 259         public void onOnAudioPassThru(OnAudioPassThru notification);
 260
 261         public void onPutFileResponse(PutFileResponse response);\r
 262
 263         public void onDeleteFileResponse(DeleteFileResponse response);\r
 264         \r
 265         public void onListFilesResponse(ListFilesResponse response);\r
 266 \r
 267         public void onSetAppIconResponse(SetAppIconResponse response);
 268         \r
 269         public void onScrollableMessageResponse(ScrollableMessageResponse response);
 270 \r
 271         public void onChangeRegistrationResponse(ChangeRegistrationResponse response);\r
 272 \r
 273         public void onSetDisplayLayoutResponse(SetDisplayLayoutResponse response);\r
 274         \r
 275         public void onOnLanguageChange(OnLanguageChange notification);\r
 276
 277         public void onSliderResponse(SliderResponse response);\r
 278 \r
 279         public void onAlertManeuverResponse(AlertManeuverResponse response);\r
 280         \r
 281         public void onShowConstantTBTResponse(ShowConstantTBTResponse response);\r
 282         \r
 283         public void onUpdateTurnListResponse(UpdateTurnListResponse response);\r
 284         \r
 285         public void onDialNumberResponse(DialNumberResponse response);\r
 286         \r
 287         public void onOnDriverDistraction(OnDriverDistraction notification);\r
 288                 \r
 289         public void onOnTBTClientState(OnTBTClientState notification);  \r
 290
 291 }\r