Skip to content

Breaking changes from 1.0.0 BETA5 to BETA6 release

Antonis Tsakiridis edited this page Jun 19, 2017 · 1 revision

Sometimes we discover a big issue in the API that needs to fixed. Since we 're still not GA, let's keep for each BETA release a list of breaking changes, so that SDK users can check in order to fix incompatibilities when they migrate to new API. These can then be part of release notes for the release.

  • RCConnection RCDevice.initialize(Context activityContext, HashMap<String, Object> parameters, RCDeviceListener deviceListener) throws RCException now throws RCException, so the caller needs to try/catch it properly

  • RCConnection RCDevice.connect(HashMap<String, Object> parameters, RCConnectionListener listener) throws RCException:

    • Now throws RCException, so the caller needs to try/catch it properly
    • Changed Map<String, Object> to HashMap<String, Object>
  • boolean RCDevice.sendMessage(String message, Map<String, String> parameters):

    • Now throws RCException, so the caller needs to try/catch it properly
    • Changed return type to String so that the caller can know the jobId. Using the jobId they will be able to correlate the sendMessage request with its response.
  • void RCDeviceListener.onMessageSent(RCDevice device, int statusCode, String statusText, String jobId) changed so that jobId is added to the argument list so that requests & responses of messages can be correlated. jobId will be the same with the one returned by sendMessage call that sent this message

  • void RCDeviceListener.onInitializationError(int errorCode, String errorText) is deprecated; instead use void RCDeviceListener.onInitialized(RCDevice device, RCDeviceListener.RCConnectivityStatus connectivityStatus, int statusCode, String statusText). If you implement that you won't have any issues in your build, but it won't be ever called.

  • void RCDeviceListener.onStopListening(RCDevice device) is deprecated; instead use void RCDeviceListener.onStopListening(RCDevice device, int statusCode, String statusText). If you implement that you won't have any issues in your build, but it won't be ever called

  • boolean receivePresenceEvents(RCDevice device) is taken out since presence is not implemented yet and we don't want to enforce too much boilerplate code.

  • void onPresenceChanged(RCDevice device, RCPresenceEvent presenceEvent) is taken out since presence is not implemented yet and we don't want to enforce too much boilerplate code.