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
17package android.content;
18
19import android.accounts.Account;
20import android.os.Bundle;
21import android.content.ISyncContext;
22import android.content.ISyncAdapterUnsyncableAccountCallback;
23
24/**
25 * Interface used to control the sync activity on a SyncAdapter
26 * @hide
27 */
28oneway 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    void onUnsyncableAccount(ISyncAdapterUnsyncableAccountCallback cb);
36
37    /**
38     * Initiate a sync for this account. SyncAdapter-specific parameters may
39     * be specified in extras, which is guaranteed to not be null.
40     *
41     * @param syncContext the ISyncContext used to indicate the progress of the sync. When
42     *   the sync is finished (successfully or not) ISyncContext.onFinished() must be called.
43     * @param authority the authority that should be synced
44     * @param account the account that should be synced
45     * @param extras SyncAdapter-specific parameters
46     */
47    void startSync(ISyncContext syncContext, String authority,
48      in Account account, in Bundle extras);
49
50    /**
51     * Cancel the most recently initiated sync. Due to race conditions, this may arrive
52     * after the ISyncContext.onFinished() for that sync was called.
53     * @param syncContext the ISyncContext that was passed to {@link #startSync}
54     */
55    void cancelSync(ISyncContext syncContext);
56}
57