1 /*
2  * Copyright (C) 2020 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.ims.rcs.uce.eab;
18 
19 import android.annotation.NonNull;
20 import android.net.Uri;
21 import android.telephony.ims.RcsContactUceCapability;
22 
23 import com.android.ims.rcs.uce.ControllerBase;
24 import com.android.ims.rcs.uce.UceController.UceControllerCallback;
25 
26 import java.util.List;
27 
28 /**
29  * The interface related to the Enhanced Address Book.
30  */
31 public interface EabController extends ControllerBase {
32     /**
33      * Retrieve the contacts' capabilities from the EAB database.
34      */
getCapabilities(@onNull List<Uri> uris)35     @NonNull List<EabCapabilityResult> getCapabilities(@NonNull List<Uri> uris);
36 
37     /**
38      * Get contact capabilities from cache including expired capabilities.
39      * @param uris the uri list to get contact capabilities from cache.
40      * @return The contact capabilities of the given uri list.
41      */
getCapabilitiesIncludingExpired(@onNull List<Uri> uris)42     @NonNull List<EabCapabilityResult> getCapabilitiesIncludingExpired(@NonNull List<Uri> uris);
43 
44     /**
45      * Retrieve the contact's capabilities from the availability cache.
46      */
getAvailability(@onNull Uri contactUri)47     @NonNull EabCapabilityResult getAvailability(@NonNull Uri contactUri);
48 
49     /**
50      * Retrieve the contact's capabilities from the availability cache.
51      */
getAvailabilityIncludingExpired(@onNull Uri contactUri)52     @NonNull EabCapabilityResult getAvailabilityIncludingExpired(@NonNull Uri contactUri);
53 
54     /**
55      * Save the capabilities to the EAB database.
56      */
saveCapabilities(@onNull List<RcsContactUceCapability> contactCapabilities)57     void saveCapabilities(@NonNull List<RcsContactUceCapability> contactCapabilities);
58 
59     /**
60      * Set the UceRequestCallback for sending the request to UceController.
61      */
setUceRequestCallback(@onNull UceControllerCallback c)62     void setUceRequestCallback(@NonNull UceControllerCallback c);
63 }
64