diff options
| author | 2016-03-15 20:00:31 -0700 | |
|---|---|---|
| committer | 2016-03-15 20:00:31 -0700 | |
| commit | cbcd99d0934ffda2f295af96e24568ec0750aedb (patch) | |
| tree | f3a2c8314a862c72afee6063d7d30eb446d26663 | |
| parent | f275f7b6cc3213b80aaf14fd278b0fb46862e73d (diff) | |
docs: Removed misleading sync adapter section.
Removed section "Run the Sync Adapter After a Network Message," as
several members of DevRel believe that the explanation and code
sample were too misleading. Also removed related TOC entry and
"dictionary entry" (within the user-friendly list of options for sync
adapters) at the end of the introductory section for this topic.
Bug: 19718330
Change-Id: I1cd2c2e5253653f670c62be95ab50ab626d26a56
| -rw-r--r-- | docs/html/training/sync-adapters/running-sync-adapter.jd | 64 |
1 files changed, 0 insertions, 64 deletions
diff --git a/docs/html/training/sync-adapters/running-sync-adapter.jd b/docs/html/training/sync-adapters/running-sync-adapter.jd index 194e94b40304..033450f159a6 100644 --- a/docs/html/training/sync-adapters/running-sync-adapter.jd +++ b/docs/html/training/sync-adapters/running-sync-adapter.jd @@ -11,7 +11,6 @@ trainingnavtop=true <ol> <li><a href="#RunByMessage">Run the Sync Adapter When Server Data Changes</a> <li><a href="#RunDataChange">Run the Sync Adapter When Content Provider Data Changes</a></li> - <li><a href="#RunByNetwork">Run the Sync Adapter After a Network Message</a></li> <li><a href="#RunPeriodic">Run the Sync Adapter Periodically</a></li> <li><a href="#RunOnDemand">Run the Sync Adapter On Demand</a></li> </ol> @@ -69,15 +68,6 @@ trainingnavtop=true content provider, detecting data changes may be more difficult. </dd> <dt> - When the system sends out a network message - </dt> - <dd> - Run a sync adapter when the Android system sends out a network message that keeps the - TCP/IP connection open; this message is a basic part of the networking framework. Using - this option is one way to run the sync adapter automatically. Consider using it in - conjunction with interval-based sync adapter runs. - </dd> - <dt> At regular intervals </dt> <dd> @@ -283,60 +273,6 @@ public class MainActivity extends FragmentActivity { ... } </pre> -<h2 id="RunByNetwork">Run the Sync Adapter After a Network Message</h2> -<p> - When a network connection is available, the Android system sends out a message - every few seconds to keep the device's TCP/IP connection open. This message also goes to - the {@link android.content.ContentResolver} of each app. By calling - {@link android.content.ContentResolver#setSyncAutomatically setSyncAutomatically()}, - you can run the sync adapter whenever the {@link android.content.ContentResolver} - receives the message. -</p> -<p> - By scheduling your sync adapter to run when the network message is sent, you ensure that your - sync adapter is always scheduled to run while the network is available. Use this option if you - don't have to force a data transfer in response to data changes, but you do want to ensure - your data is regularly updated. Similarly, you can use this option if you don't want a fixed - schedule for your sync adapter, but you do want it to run frequently. -</p> -<p> - Since the method - {@link android.content.ContentResolver#setSyncAutomatically setSyncAutomatically()} - doesn't disable {@link android.content.ContentResolver#addPeriodicSync addPeriodicSync()}, your - sync adapter may be triggered repeatedly in a short period of time. If you do want to run - your sync adapter periodically on a regular schedule, you should disable - {@link android.content.ContentResolver#setSyncAutomatically setSyncAutomatically()}. -</p> -<p> - The following code snippet shows you how to configure your - {@link android.content.ContentResolver} to run your sync adapter in response to a network - message: -</p> -<pre> -public class MainActivity extends FragmentActivity { - ... - // Constants - // Content provider authority - public static final String AUTHORITY = "com.example.android.datasync.provider"; - // Account - public static final String ACCOUNT = "default_account"; - // Global variables - // A content resolver for accessing the provider - ContentResolver mResolver; - ... - @Override - protected void onCreate(Bundle savedInstanceState) { - super.onCreate(savedInstanceState); - ... - // Get the content resolver for your app - mResolver = getContentResolver(); - // Turn on automatic syncing for the default account and authority - mResolver.setSyncAutomatically(ACCOUNT, AUTHORITY, true); - ... - } - ... -} -</pre> <h2 id="RunPeriodic">Run the Sync Adapter Periodically</h2> <p> You can run your sync adapter periodically by setting a period of time to wait between runs, |