IPrintSpooler.aidl revision bb9f686b40743df2642b7d3b7778dbf7284ae665
1/* 2 * Copyright (C) 2013 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.print; 18 19import android.content.ComponentName; 20import android.graphics.drawable.Icon; 21import android.os.ParcelFileDescriptor; 22import android.print.IPrintSpoolerClient; 23import android.print.IPrintSpoolerCallbacks; 24import android.print.PrinterId; 25import android.print.PrinterInfo; 26import android.print.PrintAttributes; 27import android.print.PrintJobId; 28import android.print.PrintJobInfo; 29 30/** 31 * Interface for communication with the print spooler service. 32 * 33 * @see android.print.IPrintSpoolerCallbacks 34 * 35 * @hide 36 */ 37oneway interface IPrintSpooler { 38 void removeObsoletePrintJobs(); 39 void getPrintJobInfos(IPrintSpoolerCallbacks callback, in ComponentName componentName, 40 int state, int appId, int sequence); 41 void getPrintJobInfo(in PrintJobId printJobId, IPrintSpoolerCallbacks callback, 42 int appId, int sequence); 43 void createPrintJob(in PrintJobInfo printJob); 44 void setPrintJobState(in PrintJobId printJobId, int status, String stateReason, 45 IPrintSpoolerCallbacks callback, int sequence); 46 47 /** 48 * Set the progress of this print job 49 * 50 * @param printJobId The print job to update 51 * @param progress The new progress 52 */ 53 void setProgress(in PrintJobId printJobId, in float progress); 54 55 /** 56 * Set the status of this print job 57 * 58 * @param printJobId The print job to update 59 * @param status The new status, can be null 60 */ 61 void setStatus(in PrintJobId printJobId, in CharSequence status); 62 63 /** 64 * Handle that a custom icon for a printer was loaded. 65 * 66 * @param printerId the id of the printer the icon belongs to 67 * @param icon the icon that was loaded 68 * @param callbacks the callback to call once icon is stored in case 69 * @param sequence the sequence number of the call 70 * @see android.print.PrinterInfo.Builder#setHasCustomPrinterIcon() 71 */ 72 void onCustomPrinterIconLoaded(in PrinterId printerId, in Icon icon, 73 in IPrintSpoolerCallbacks callbacks, in int sequence); 74 75 /** 76 * Get the custom icon for a printer. If the icon is not cached, the icon is 77 * requested asynchronously. Once it is available the printer is updated. 78 * 79 * @param printerId the id of the printer the icon should be loaded for 80 * @param callbacks the callback to call once icon is retrieved 81 * @param sequence the sequence number of the call 82 * @see android.print.PrinterInfo.Builder#setHasCustomPrinterIcon() 83 */ 84 void getCustomPrinterIcon(in PrinterId printerId, 85 in IPrintSpoolerCallbacks callbacks, in int sequence); 86 87 /** 88 * Clear all state from the custom printer icon cache. 89 * 90 * @param callbacks the callback to call once cache is cleared 91 * @param sequence the sequence number of the call 92 */ 93 void clearCustomPrinterIconCache(in IPrintSpoolerCallbacks callbacks, 94 in int sequence); 95 96 void setPrintJobTag(in PrintJobId printJobId, String tag, IPrintSpoolerCallbacks callback, 97 int sequence); 98 void writePrintJobData(in ParcelFileDescriptor fd, in PrintJobId printJobId); 99 void setClient(IPrintSpoolerClient client); 100 void setPrintJobCancelling(in PrintJobId printJobId, boolean cancelling); 101 void removeApprovedPrintService(in ComponentName serviceToRemove); 102} 103