SyncRequest.Builder Class

Creates a builder for a synchronization request.

Initializes a managed wrapper around an existing Java instance.

Returns the runtime class of this Object.

The handle to the underlying Android instance.

Gets the identity hash code assigned to this Java peer by the interop runtime.

Gets the JNI metadata used to invoke members of this Java peer.

Gets the JNI object reference for this Java peer.

Gets the JNI class used as the dispatch threshold for this Java peer.

Gets the JNI type used as the dispatch threshold for this Java peer.

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

Creates and returns a copy of this object.

Releases the resources held by this Java peer.

Releases the resources held by this Java peer.

Indicates whether some other object is "equal to" this one.

Returns a hash code value for the object.

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

Wakes up a single thread that is waiting on this object's monitor.

Wakes up all threads that are waiting on this object's monitor.

Sets whether this transfer is disallowed on metered networks. Throws an IllegalArgumentException if disallow is true after SetIgnoreSettings(true) has been called.

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() .

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. } Only values of the following types may be used in the extras bundle: Integer Long Boolean Float Double String Account null If any data is present in the bundle not of this type, build() will throw a runtime exception.

Sets the Handle property.

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() .

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.

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

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 true. Not valid for periodic sync and will throw an IllegalArgumentException in build().

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

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() . Parameters scheduleAsExpeditedJob boolean : whether to schedule as an expedited job. Default false.

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 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,String) , 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); N.B.: Periodic syncs are not allowed to have any of ContentResolver.SYNC_EXTRAS_DO_NOT_RETRY , ContentResolver.SYNC_EXTRAS_IGNORE_BACKOFF , ContentResolver.SYNC_EXTRAS_IGNORE_SETTINGS , ContentResolver.SYNC_EXTRAS_INITIALIZE , ContentResolver.SYNC_EXTRAS_FORCE , ContentResolver.SYNC_EXTRAS_EXPEDITED , ContentResolver.SYNC_EXTRAS_MANUAL , ContentResolver.SYNC_EXTRAS_SCHEDULE_AS_EXPEDITED_JOB set to true. If any are supplied then an IllegalArgumentException will be thrown.

Creates a managed array from this Java array wrapper.

Returns a string representation of the object.

Unregisters this Java peer from the interop runtime.

Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>.

Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed.

Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed.

Gets the JNI name of the type of the instance self.

Try to coerce self to type TResult, checking that the coercion is valid on the Java side.

Performs an Android runtime-checked type conversion.

Try to coerce self to type TResult, checking that the coercion is valid on the Java side.