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 android.service.contentcapture; 18 19 import android.annotation.NonNull; 20 import android.annotation.SystemApi; 21 import android.annotation.TestApi; 22 import android.os.ParcelFileDescriptor; 23 import android.view.contentcapture.ContentCaptureManager.DataShareError; 24 25 /** 26 * Adapter class to be used for the Content Capture Service app to propagate the status of the 27 * session 28 * 29 * @hide 30 **/ 31 @SystemApi 32 @TestApi 33 public interface DataShareReadAdapter { 34 35 /** 36 * Signals the start of the data sharing session. 37 * 38 * @param fd file descriptor to use for reading data, that's being shared 39 **/ onStart(@onNull ParcelFileDescriptor fd)40 void onStart(@NonNull ParcelFileDescriptor fd); 41 42 /** 43 * Signals that the session failed to start or terminated unsuccessfully. 44 * 45 * <p>Important: together with the error, file sharing stream might be closed, and therefore 46 * reading from {@code fd} from {@link #onStart} will result in the end of stream. The order of 47 * these 2 events is not defined, and it's important that the service treats end of stream 48 * correctly in this situation. 49 **/ onError(@ataShareError int errorCode)50 void onError(@DataShareError int errorCode); 51 } 52