SyncRequest.Builder

Performs validation over the request and throws the runtime exception IllegalArgumentException if this validation fails.

An expedited sync runs immediately and will preempt another non-expedited running sync. Not valid for periodic sync and will throw an IllegalArgumentException in build().

Optional developer-provided extras handed back in onPerformSync(Account, Bundle, String, ContentProviderClient, SyncResult) occurs. This bundle is copied into the SyncRequest returned by build(). Example:

   String[] syncItems = {"dog", "cat", "frog", "child"};
   SyncRequest.Builder builder =
     new SyncRequest.Builder()
       .setSyncAdapter(dummyAccount, dummyProvider)
       .syncOnce(5 * MINUTES_IN_SECS);

   for (String syncData : syncItems) {
     Bundle extras = new Bundle();
     extras.setString("data", syncData);
     builder.setExtras(extras);
     ContentResolver.sync(builder.build()); // Each sync() request is for a unique sync.
   }
 

• Integer
• Long
• Boolean
• Float
• Double
• String
• Account
• null

Convenience function for setting SYNC_EXTRAS_IGNORE_BACKOFF. Force the sync scheduling process to ignore any back-off that was the result of a failed sync, as well as to invalidate any delayUntil value that may have been set by the adapter. Successive failures will not honor this flag. Not valid for periodic sync and will throw an IllegalArgumentException in build().

Convenience function for setting SYNC_EXTRAS_IGNORE_SETTINGS. A sync can specify that system sync settings be ignored (user has turned sync off). Not valid for periodic sync and will throw an IllegalArgumentException in build().

Convenience function for setting SYNC_EXTRAS_MANUAL. A manual sync is functionally equivalent to calling setIgnoreBackoff(boolean) and setIgnoreSettings(boolean). Not valid for periodic sync and will throw an IllegalArgumentException in build().

Convenience function for setting SYNC_EXTRAS_DO_NOT_RETRY. A one-off sync operation that fails will be retried with exponential back-off unless this is set to false. Not valid for periodic sync and will throw an IllegalArgumentException in build().

Specify an authority and account for this transfer.

Request that a sync occur immediately. Example

     SyncRequest.Builder builder = (new SyncRequest.Builder()).syncOnce();
 

Build a periodic sync. Either this or syncOnce() must be called for this builder. Syncs are identified by target android.provider/Account and by the contents of the extras bundle. You cannot reuse the same builder for one-time syncs (by calling this function) after having specified a periodic sync. If you do, an IllegalArgumentException will be thrown. Example usage.

     Request a periodic sync every 5 hours with 20 minutes of flex.
     SyncRequest.Builder builder =
         (new SyncRequest.Builder()).syncPeriodic(5 * HOUR_IN_SECS, 20 * MIN_IN_SECS);

     Schedule a periodic sync every hour at any point in time during that hour.
     SyncRequest.Builder builder =
         (new SyncRequest.Builder()).syncPeriodic(1 * HOUR_IN_SECS, 1 * HOUR_IN_SECS);