FileDocCategorySizeDatePackage
SyncAdapter.javaAPI DocAndroid 1.5 API2487Wed May 06 22:41:54 BST 2009android.content

SyncAdapter

public abstract class SyncAdapter extends Object
hide

Fields Summary
private static final String
TAG
public static final int
LOG_SYNC_DETAILS
Kernel event log tag. Also listed in data/etc/event-log-tags.
Transport
mTransport
Constructors Summary
Methods Summary
public abstract voidcancelSync()
Cancel the most recently initiated sync. Due to race conditions, this may arrive after the ISyncContext.onFinished() for that sync was called. IPC invocations of this method and startSync() are guaranteed to be serialized.

final ISyncAdaptergetISyncAdapter()
Get the Transport object. (note this is package private).


                   
      
    
        return mTransport;
    
public abstract voidstartSync(SyncContext syncContext, java.lang.String account, android.os.Bundle extras)
Initiate a sync for this account. SyncAdapter-specific parameters may be specified in extras, which is guaranteed to not be null. IPC invocations of this method and cancelSync() are guaranteed to be serialized.

param
syncContext the ISyncContext used to indicate the progress of the sync. When the sync is finished (successfully or not) ISyncContext.onFinished() must be called.
param
account the account that should be synced
param
extras SyncAdapter-specific parameters