1 /*
2  * Copyright (C) 2008 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 package android.content;
18 
19 import android.accounts.Account;
20 import android.os.Bundle;
21 import android.content.ISyncContext;
22 import android.content.ISyncAdapterUnsyncableAccountCallback;
23 
24 /**
25  * Interface used to control the sync activity on a SyncAdapter
26  * @hide
27  */
28 oneway interface ISyncAdapter {
29     /**
30      * Called before {@link #startSync}. This allows the adapter to defer syncs until the
31      * adapter is ready for the account
32      *
33      * @param cb If called back with {@code false} accounts are not synced.
34      */
35     @UnsupportedAppUsage
onUnsyncableAccount(ISyncAdapterUnsyncableAccountCallback cb)36     void onUnsyncableAccount(ISyncAdapterUnsyncableAccountCallback cb);
37 
38     /**
39      * Initiate a sync for this account. SyncAdapter-specific parameters may
40      * be specified in extras, which is guaranteed to not be null.
41      *
42      * @param syncContext the ISyncContext used to indicate the progress of the sync. When
43      *   the sync is finished (successfully or not) ISyncContext.onFinished() must be called.
44      * @param authority the authority that should be synced
45      * @param account the account that should be synced
46      * @param extras SyncAdapter-specific parameters
47      */
48     @UnsupportedAppUsage
startSync(ISyncContext syncContext, String authority, in Account account, in Bundle extras)49     void startSync(ISyncContext syncContext, String authority,
50       in Account account, in Bundle extras);
51 
52     /**
53      * Cancel the most recently initiated sync. Due to race conditions, this may arrive
54      * after the ISyncContext.onFinished() for that sync was called.
55      * @param syncContext the ISyncContext that was passed to {@link #startSync}
56      */
57     @UnsupportedAppUsage
cancelSync(ISyncContext syncContext)58     void cancelSync(ISyncContext syncContext);
59 }
60