Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit b0017b59 authored by Hui Wu's avatar Hui Wu
Browse files

CloudSearch API: data class declarations and interface definitions. 

CTS-Coverage-Bug: 210528288
Bug: 210528288
Test: RBE Built redfin-eng and tested on a physical device
Change-Id: I640be77dbf05633b7a17ada73ea261dbd0027697
parent c5900ec5

core/api/system-current.txt

+106 −0
Original line number Diff line number Diff line
@@ -157,6 +157,7 @@ package android { 
    field public static final String MANAGE_BLUETOOTH_WHEN_WIRELESS_CONSENT_REQUIRED = "android.permission.MANAGE_BLUETOOTH_WHEN_WIRELESS_CONSENT_REQUIRED";

    field public static final String MANAGE_CARRIER_OEM_UNLOCK_STATE = "android.permission.MANAGE_CARRIER_OEM_UNLOCK_STATE";

    field public static final String MANAGE_CA_CERTIFICATES = "android.permission.MANAGE_CA_CERTIFICATES";

    field public static final String MANAGE_CLOUDSEARCH = "android.permission.MANAGE_CLOUDSEARCH";

    field public static final String MANAGE_CONTENT_CAPTURE = "android.permission.MANAGE_CONTENT_CAPTURE";

    field public static final String MANAGE_CONTENT_SUGGESTIONS = "android.permission.MANAGE_CONTENT_SUGGESTIONS";

    field public static final String MANAGE_DEBUGGING = "android.permission.MANAGE_DEBUGGING";
@@ -1578,6 +1579,99 @@ package android.app.backup { 














}



























package android.app.cloudsearch {

























  public class CloudSearchManager {













    method @RequiresPermission(android.Manifest.permission.MANAGE_CLOUDSEARCH) public void search(@NonNull android.app.cloudsearch.SearchRequest, @NonNull java.util.concurrent.Executor, @NonNull android.app.cloudsearch.CloudSearchManager.CallBack);













  }

























  public static interface CloudSearchManager.CallBack {













    method public void onSearchFailed(@NonNull android.app.cloudsearch.SearchRequest, @NonNull android.app.cloudsearch.SearchResponse);













    method public void onSearchSucceeded(@NonNull android.app.cloudsearch.SearchRequest, @NonNull android.app.cloudsearch.SearchResponse);













  }

























  public final class SearchRequest implements android.os.Parcelable {













    method public int describeContents();













    method public float getMaxLatencyMillis();













    method @NonNull public String getQuery();













    method @NonNull public String getRequestId();













    method public int getResultNumber();













    method public int getResultOffset();













    method @NonNull public android.os.Bundle getSearchConstraints();













    method public void writeToParcel(@NonNull android.os.Parcel, int);













    field public static final String CONSTRAINT_IS_PRESUBMIT_SUGGESTION = "IS_PRESUBMIT_SUGGESTION";













    field public static final String CONSTRAINT_SEARCH_PROVIDER_FILTER = "SEARCH_PROVIDER_FILTER";













    field @NonNull public static final android.os.Parcelable.Creator<android.app.cloudsearch.SearchRequest> CREATOR;













  }

























  public static final class SearchRequest.Builder {













    ctor public SearchRequest.Builder(@NonNull String);













    method @NonNull public android.app.cloudsearch.SearchRequest build();













    method @NonNull public android.app.cloudsearch.SearchRequest.Builder setMaxLatencyMillis(float);













    method @NonNull public android.app.cloudsearch.SearchRequest.Builder setQuery(@NonNull String);













    method @NonNull public android.app.cloudsearch.SearchRequest.Builder setResultNumber(int);













    method @NonNull public android.app.cloudsearch.SearchRequest.Builder setResultOffset(int);













    method @NonNull public android.app.cloudsearch.SearchRequest.Builder setSearchConstraints(@Nullable android.os.Bundle);













  }

























  public final class SearchResponse implements android.os.Parcelable {













    method public int describeContents();













    method @NonNull public java.util.List<android.app.cloudsearch.SearchResult> getSearchResults();













    method @NonNull public String getSource();













    method public int getStatusCode();













    method public void writeToParcel(@NonNull android.os.Parcel, int);













    field @NonNull public static final android.os.Parcelable.Creator<android.app.cloudsearch.SearchResponse> CREATOR;













    field public static final int SEARCH_STATUS_NO_INTERNET = 2; // 0x2













    field public static final int SEARCH_STATUS_OK = 0; // 0x0













    field public static final int SEARCH_STATUS_TIME_OUT = 1; // 0x1













    field public static final int SEARCH_STATUS_UNKNOWN = -1; // 0xffffffff













  }

























  public static final class SearchResponse.Builder {













    ctor public SearchResponse.Builder(int);













    method @NonNull public android.app.cloudsearch.SearchResponse build();













    method @NonNull public android.app.cloudsearch.SearchResponse.Builder setSearchResults(@NonNull java.util.List<android.app.cloudsearch.SearchResult>);













    method @NonNull public android.app.cloudsearch.SearchResponse.Builder setStatusCode(int);













  }

























  public final class SearchResult implements android.os.Parcelable {













    method public int describeContents();













    method @NonNull public android.os.Bundle getExtraInfos();













    method public float getScore();













    method @NonNull public String getSnippet();













    method @NonNull public String getTitle();













    method public void writeToParcel(@NonNull android.os.Parcel, int);













    field @NonNull public static final android.os.Parcelable.Creator<android.app.cloudsearch.SearchResult> CREATOR;













    field public static final String EXTRAINFO_ACTION_BUTTON_IMAGE_PREREGISTERING = "ACTION_BUTTON_IMAGE";













    field public static final String EXTRAINFO_ACTION_BUTTON_TEXT_PREREGISTERING = "ACTION_BUTTON_TEXT";













    field public static final String EXTRAINFO_APP_BADGES = "APP_BADGES";













    field public static final String EXTRAINFO_APP_CONTAINS_ADS_DISCLAIMER = "APP_CONTAINS_ADS_DISCLAIMER";













    field public static final String EXTRAINFO_APP_CONTAINS_IAP_DISCLAIMER = "APP_CONTAINS_IAP_DISCLAIMER";













    field public static final String EXTRAINFO_APP_DEVELOPER_NAME = "APP_DEVELOPER_NAME";













    field public static final String EXTRAINFO_APP_DOMAIN_URL = "APP_DOMAIN_URL";













    field public static final String EXTRAINFO_APP_IARC = "APP_IARC";













    field public static final String EXTRAINFO_APP_ICON = "APP_ICON";













    field public static final String EXTRAINFO_APP_REVIEW_COUNT = "APP_REVIEW_COUNT";













    field public static final String EXTRAINFO_APP_SIZE_BYTES = "APP_SIZE_BYTES";













    field public static final String EXTRAINFO_APP_STAR_RATING = "APP_STAR_RATING";













    field public static final String EXTRAINFO_LONG_DESCRIPTION = "LONG_DESCRIPTION";













    field public static final String EXTRAINFO_SCREENSHOTS = "SCREENSHOTS";













    field public static final String EXTRAINFO_SHORT_DESCRIPTION = "SHORT_DESCRIPTION";













    field public static final String EXTRAINFO_WEB_ICON = "WEB_ICON";













    field public static final String EXTRAINFO_WEB_URL = "WEB_URL";













  }

























  public static final class SearchResult.Builder {













    ctor public SearchResult.Builder(@NonNull String, @NonNull android.os.Bundle);













    method @NonNull public android.app.cloudsearch.SearchResult build();













    method @NonNull public android.app.cloudsearch.SearchResult.Builder setExtraInfos(@NonNull android.os.Bundle);













    method @NonNull public android.app.cloudsearch.SearchResult.Builder setScore(float);













    method @NonNull public android.app.cloudsearch.SearchResult.Builder setSnippet(@NonNull String);













    method @NonNull public android.app.cloudsearch.SearchResult.Builder setTitle(@NonNull String);













  }

























}



























package android.app.compat {





























  public final class CompatChanges {










@@ -2840,6 +2934,7 @@ package android.content {













    field public static final String BATTERY_STATS_SERVICE = "batterystats";















    field @Deprecated public static final int BIND_ALLOW_BACKGROUND_ACTIVITY_STARTS = 1048576; // 0x100000















    field public static final int BIND_ALLOW_FOREGROUND_SERVICE_STARTS_FROM_BACKGROUND = 262144; // 0x40000













    field public static final String CLOUDSEARCH_SERVICE = "cloudsearch_service";















    field public static final String CONTENT_SUGGESTIONS_SERVICE = "content_suggestions";















    field public static final String CONTEXTHUB_SERVICE = "contexthub";















    field public static final String ETHERNET_SERVICE = "ethernet";










@@ -10866,6 +10961,17 @@ package android.service.carrier {



























}



























package android.service.cloudsearch {

























  public abstract class CloudSearchService extends android.app.Service {













    ctor public CloudSearchService();













    method @NonNull public final android.os.IBinder onBind(@NonNull android.content.Intent);













    method public abstract void onSearch(@NonNull android.app.cloudsearch.SearchRequest);













    method public final void returnResults(@NonNull String, @NonNull android.app.cloudsearch.SearchResponse);













  }

























}



























package android.service.contentcapture {





























  public final class ActivityEvent implements android.os.Parcelable {

























core/api/system-lint-baseline.txt



+115
−111




























Original line number
Diff line number
Diff line








@@ -293,6 +293,10 @@ SamShouldBeLast: android.webkit.WebChromeClient#onShowFileChooser(android.webkit













    













































ServiceName: android.content.Context#CLOUDSEARCH_SERVICE:













    Inconsistent service value; expected `cloudsearch`, was `cloudsearch_service` (Note: Do not change the name of already released services, which will break tools using `adb shell dumpsys`. Instead add `@SuppressLint("ServiceName"))`











































UserHandleName: android.app.search.SearchAction.Builder#setUserHandle(android.os.UserHandle):















    Method taking UserHandle should be named `doFooAsUser` or `queryFooForUser`, was `setUserHandle`















UserHandleName: android.app.search.SearchTarget.Builder#setUserHandle(android.os.UserHandle):

































core/java/android/app/SystemServiceRegistry.java



+13
−0




























Original line number
Diff line number
Diff line








@@ -28,6 +28,8 @@ import android.app.ambientcontext.AmbientContextManager;













import android.app.ambientcontext.IAmbientContextEventObserver;















import android.app.appsearch.AppSearchManagerFrameworkInitializer;















import android.app.blob.BlobStoreManagerFrameworkInitializer;













import android.app.cloudsearch.CloudSearchManager;













import android.app.cloudsearch.ICloudSearchManager;















import android.app.contentsuggestions.ContentSuggestionsManager;















import android.app.contentsuggestions.IContentSuggestionsManager;















import android.app.job.JobSchedulerFrameworkInitializer;










@@ -1248,6 +1250,17 @@ public final class SystemServiceRegistry {













                }















            });





























        registerService(Context.CLOUDSEARCH_SERVICE, CloudSearchManager.class,













            new CachedServiceFetcher<CloudSearchManager>() {













                @Override













                public CloudSearchManager createService(ContextImpl ctx)













                    throws ServiceNotFoundException {













                    IBinder b = ServiceManager.getService(Context.CLOUDSEARCH_SERVICE);













                    return b == null ? null :













                        new CloudSearchManager(ICloudSearchManager.Stub.asInterface(b));













                }













            });





























        registerService(Context.APP_PREDICTION_SERVICE, AppPredictionManager.class,















                new CachedServiceFetcher<AppPredictionManager>() {















            @Override

































core/java/android/app/cloudsearch/CloudSearchManager.java
0 → 100644



+128
−0




























Original line number
Diff line number
Diff line













/*













 * Copyright (C) 2022 The Android Open Source Project













 *













 * Licensed under the Apache License, Version 2.0 (the "License");













 * you may not use this file except in compliance with the License.













 * You may obtain a copy of the License at













 *













 *      http://www.apache.org/licenses/LICENSE-2.0













 *













 * Unless required by applicable law or agreed to in writing, software













 * distributed under the License is distributed on an "AS IS" BASIS,













 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.













 * See the License for the specific language governing permissions and













 * limitations under the License.













 */













package android.app.cloudsearch;



























import static java.util.Objects.requireNonNull;



























import android.annotation.CallbackExecutor;













import android.annotation.NonNull;













import android.annotation.RequiresPermission;













import android.annotation.SystemApi;













import android.annotation.SystemService;













import android.content.Context;













import android.os.RemoteException;



























import java.util.concurrent.Executor;













/**













 * A {@link CloudSearchManager} is the  class having all the information passed to search providers.













 *













 * @hide













 */













@SystemApi













@SystemService(Context.CLOUDSEARCH_SERVICE)













public class CloudSearchManager {













    /**













     * CallBack Interface for this API.













     */













    public interface CallBack {













        /**













         * Invoked by receiving app with the result of the search.













         *













         * @param request original request for the search.













         * @param response search result.













         */













        void onSearchSucceeded(@NonNull SearchRequest request, @NonNull SearchResponse response);



























        /**













         * Invoked when the search is not successful.













         * Each failure is recorded. The client may receive a failure from one provider and













         * subsequently receive successful searches from other providers













         *













         * @param request original request for the search.













         * @param response search result.













         */













        void onSearchFailed(@NonNull SearchRequest request, @NonNull SearchResponse response);













    }



























    private final ICloudSearchManager mService;



























    /** @hide **/













    public CloudSearchManager(@NonNull ICloudSearchManager service) {













        mService = service;













    }



























    /**













     * Execute an {@link android.app.cloudsearch.SearchRequest} from the given parameters













     * to the designated cloud lookup services.  After the lookup is done, the given













     * callback will be invoked by the system with the result or lack thereof.













     *













     * @param request request to be searched.













     * @param callbackExecutor where the callback is invoked.













     * @param callback invoked when the result is available.













     *













     * @hide













     */













    @SystemApi













    @RequiresPermission(android.Manifest.permission.MANAGE_CLOUDSEARCH)













    public void search(@NonNull SearchRequest request,













            @NonNull @CallbackExecutor Executor callbackExecutor,













            @NonNull CallBack callback) {













        try {













            mService.search(













                    requireNonNull(request),













                    new CallBackWrapper(













                        requireNonNull(request),













                        requireNonNull(callback),













                        requireNonNull(callbackExecutor)));













        } catch (RemoteException e) {













            throw e.rethrowFromSystemServer();













        }













    }



























    private final class CallBackWrapper extends













            ICloudSearchManagerCallback.Stub {













        @NonNull













        private final SearchRequest mSearchRequest;



























        @NonNull













        private final CallBack mCallback;



























        @NonNull













        private final Executor mCallbackExecutor;



























        CallBackWrapper(













                SearchRequest searchRequest,













                CallBack callback,













                Executor callbackExecutor) {













            mSearchRequest = searchRequest;













            mCallback = callback;













            mCallbackExecutor = callbackExecutor;













        }









































        @Override













        public void onSearchSucceeded(SearchResponse searchResponse) {













            mCallbackExecutor.execute(













                    () -> mCallback.onSearchSucceeded(mSearchRequest, searchResponse));













        }



























        @Override













        public void onSearchFailed(SearchResponse searchResponse) {













            mCallbackExecutor.execute(













                    () -> mCallback.onSearchFailed(mSearchRequest, searchResponse));













        }













    }













}
























core/java/android/app/cloudsearch/ICloudSearchManager.aidl
0 → 100644



+33
−0




























Original line number
Diff line number
Diff line













/**













 * Copyright (c) 2022, The Android Open Source Project













 *













 * Licensed under the Apache License, Version 2.0 (the "License");













 * you may not use this file except in compliance with the License.













 * You may obtain a copy of the License at













 *













 *     http://www.apache.org/licenses/LICENSE-2.0













 *













 * Unless required by applicable law or agreed to in writing, software













 * distributed under the License is distributed on an "AS IS" BASIS,













 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.













 * See the License for the specific language governing permissions and













 * limitations under the License.













 */



























package android.app.cloudsearch;



























import android.app.cloudsearch.SearchRequest;













import android.app.cloudsearch.SearchResponse;













import android.app.cloudsearch.ICloudSearchManagerCallback;



























/**













 * Used by {@link CloudSearchManager} to tell system server to do search.













 *













 * @hide













 */













oneway interface ICloudSearchManager {













  void search(in SearchRequest request, in ICloudSearchManagerCallback callBack);



























  void returnResults(in IBinder token, in String requestId,













                     in SearchResponse response);













}