SyncRequest.Builder

Builder

public Builder ()

build

public SyncRequest build ()

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

setDisallowMetered

public SyncRequest.Builder setDisallowMetered (boolean disallow)

Will throw an IllegalArgumentException if called and setIgnoreSettings(boolean) has already been called.

setExpedited

public SyncRequest.Builder setExpedited (boolean expedited)

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

setExtras

public SyncRequest.Builder setExtras (Bundle bundle)

Developer-provided extras handed back when sync actually 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();

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

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

setIgnoreBackoff

public SyncRequest.Builder setIgnoreBackoff (boolean ignoreBackoff)

Convenience function for setting ContentResolver.SYNC_EXTRAS_IGNORE_BACKOFF. Ignoring back-off will force the sync scheduling process to ignore any back-off that was the result of a failed sync, as well as to invalidate any SyncResult.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().

setIgnoreSettings

public SyncRequest.Builder setIgnoreSettings (boolean ignoreSettings)

Convenience function for setting ContentResolver.SYNC_EXTRAS_IGNORE_SETTINGS. Not valid for periodic sync and will throw an IllegalArgumentException in build().

Throws IllegalArgumentException if called and setDisallowMetered(boolean) has been set.

setManual

public SyncRequest.Builder setManual (boolean isManual)

Convenience function for setting ContentResolver.SYNC_EXTRAS_MANUAL. Not valid for periodic sync and will throw an IllegalArgumentException in build().

setNoRetry

public SyncRequest.Builder setNoRetry (boolean noRetry)

Convenience function for setting ContentResolver.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().

setRequiresCharging

public SyncRequest.Builder setRequiresCharging (boolean requiresCharging)

Specify whether the sync requires the phone to be plugged in.

setScheduleAsExpeditedJob

public SyncRequest.Builder setScheduleAsExpeditedJob (boolean scheduleAsExpeditedJob)

Convenience function for setting ContentResolver.SYNC_EXTRAS_SCHEDULE_AS_EXPEDITED_JOB.

Not to be confused with ContentResolver.SYNC_EXTRAS_EXPEDITED.

Not valid for periodic syncs, expedited syncs, and syncs that require charging - an IllegalArgumentException will be thrown in build().

setSyncAdapter

public SyncRequest.Builder setSyncAdapter (Account account, 
                String authority)

Specify an authority and account for this transfer.

syncOnce

public SyncRequest.Builder syncOnce ()

Request that a sync occur immediately. Example

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

syncPeriodic

public SyncRequest.Builder syncPeriodic (long pollFrequency, 
                long beforeSeconds)

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

The bundle for a periodic sync can be queried by applications with the correct permissions using ContentResolver.getPeriodicSyncs(Account account, String provider), so no sensitive data should be transferred here. 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);