1 /*
2  * Copyright (C) 2019 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 com.android.server.people;
18 
19 import android.annotation.NonNull;
20 import android.annotation.Nullable;
21 import android.annotation.UserIdInt;
22 import android.os.CancellationSignal;
23 import android.service.appprediction.IPredictionService;
24 
25 /**
26  * @hide Only for use within the system server.
27  */
28 public abstract class PeopleServiceInternal extends IPredictionService.Stub {
29 
30     /**
31      * Prunes the data for the specified user. Called by {@link
32      * com.android.server.people.data.DataMaintenanceService} when the device is idle.
33      */
pruneDataForUser(@serIdInt int userId, @NonNull CancellationSignal signal)34     public abstract void pruneDataForUser(@UserIdInt int userId,
35             @NonNull CancellationSignal signal);
36 
37     /**
38      * Returns a backup payload that contains conversation infos. The number conversation infos will
39      * be dynamic, based on the currently installed apps on the device. All of which should be
40      * combined into a single blob to be backed up.
41      */
42     @Nullable
getBackupPayload(@serIdInt int userId)43     public abstract byte[] getBackupPayload(@UserIdInt int userId);
44 
45     /**
46      * Restores conversation infos stored in payload blob. Multiple conversation infos may exist in
47      * the restore payload, child classes are required to manage the restoration based on how
48      * individual conversation infos were originally combined during backup.
49      */
restore(@serIdInt int userId, @NonNull byte[] payload)50     public abstract void restore(@UserIdInt int userId, @NonNull byte[] payload);
51 }
52