SyncManager

public interface SyncManager

Method Summary

Modifier and Type

Method

Description

void

deregister(@NonNull Syncable syncable)

Remove a tracked syncable.

Syncable

getSyncable(@NonNull String key)

Returns a syncable that has been registered with the central manager.

List<Syncable>

getSyncables()

Returns all syncables registered with the central manaager.

boolean

register(@NonNull Syncable syncable)

Registers a Syncable with the central manager.

Method Details
- register
  
  boolean register(@NonNull Syncable syncable)
  
  Registers a Syncable with the central manager. This Syncable will be automatically run at the desired rate and schedule.
  
  Returns:
  
  True if registration was successful.
  
  Throws:
  
  IllegalArgumentException - if the Syncable had an invalid key.
- deregister
  
  void deregister(@NonNull Syncable syncable)
  
  Remove a tracked syncable. Safe to call if the syncable has not been registered, or has already been de-registered.
- getSyncable
  
  Syncable getSyncable(@NonNull String key)
  
  Returns a syncable that has been registered with the central manager.
- getSyncables
  
  List<Syncable> getSyncables()
  
  Returns all syncables registered with the central manaager.