com.radiusnetworks.proximity

Interface ProximityKitSyncNotifier

public interface ProximityKitSyncNotifier

Defines important Proximity Kit cloud communication event notifications.

Apps should implement at least this notification interface so that they are aware of potential configuration and network problems which may prevent the kit from functioning properly. Here's a simplified example:

 public class MyApplication extends Application implements ProximityKitSyncNotifier {
      @Override
     public void didFailSync( @NonNull Exception e) {
         Log.e("MyApp", "Proximity Kit network sync failed", e);
         // Check if the app needs to prompt the user for network access or enabling wifi.
     }

      @Override
     public void didSync() {
         Log.d("MyApp", "Proximity Kit sync completed");
         // Good time to check any regions for modifications if they are used by the app.
     }
 }
 

Since:

0.1.0

See Also:

ProximityKitManager.getProximityKitSyncNotifier(), ProximityKitManager.setProximityKitSyncNotifier(ProximityKitSyncNotifier)

Method Summary

Modifier and Type	Method and Description
void	didFailSync(Exception cause) Called after a failed sync of the registered kit with the cloud.
void	didSync() Called after a successful sync of the registered the kit with the cloud.

Method Detail

didFailSync

void didFailSync(Exception cause)

Called after a failed sync of the registered kit with the cloud.

This indicates that there was a problem retrieving data from the Proximity Kit server. This could indicate a generic network problem, a misconfiguration of the kit URL or authentication token, or a partial data download. The underlying problem is provided with cause.

Parameters:

cause - The cause of the failed sync.

didSync

void didSync()

Called after a successful sync of the registered the kit with the cloud.

This indicates that the kit data has successfully been downloaded and loaded from the Proximity Kit server.