Fix SyncResutl.delayUntil javadoc

Fix: 17912666
Bug: 66950061
Test: presubmit
Change-Id: I47b3a9fd087e7d7519eb1bc4a6182929a75d873b
This commit is contained in:
Makoto Onuki
2018-03-15 11:01:09 -07:00
parent 7b97503caa
commit acfb417cdc

View File

@@ -79,7 +79,17 @@ public final class SyncResult implements Parcelable {
/**
* Used to indicate to the SyncManager that future sync requests that match the request's
* Account and authority should be delayed at least this many seconds.
* Account and authority should be delayed until a time in seconds since Java epoch.
*
* <p>For example, if you want to delay the next sync for at least 5 minutes, then:
* <pre>
* result.delayUntil = (System.currentTimeMillis() / 1000) + 5 * 60;
* </pre>
*
* <p>By default, when a sync fails, the system retries later with an exponential back-off
* with the system default initial delay time, which always wins over {@link #delayUntil} --
* i.e. if the system back-off time is larger than {@link #delayUntil}, {@link #delayUntil}
* will essentially be ignored.
*/
public long delayUntil;