IPrintSpooler.aidl revision d74d1e549168ba521e8009961b76e8718be37aa1 
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     * Set the status of this print job
65     *
66     * @param printJobId The print job to update
67     * @param status The new status as a string resource
68     * @param appPackageName App package name the resource belongs to
69     */
70    void setStatusRes(in PrintJobId printJobId, int status, in CharSequence appPackageName);
71
72    /**
73     * Handle that a custom icon for a printer was loaded.
74     *
75     * @param printerId the id of the printer the icon belongs to
76     * @param icon the icon that was loaded
77     * @param callbacks the callback to call once icon is stored in case
78     * @param sequence the sequence number of the call
79     * @see android.print.PrinterInfo.Builder#setHasCustomPrinterIcon()
80     */
81    void onCustomPrinterIconLoaded(in PrinterId printerId, in Icon icon,
82            in IPrintSpoolerCallbacks callbacks, in int sequence);
83
84    /**
85     * Get the custom icon for a printer. If the icon is not cached, the icon is
86     * requested asynchronously. Once it is available the printer is updated.
87     *
88     * @param printerId the id of the printer the icon should be loaded for
89     * @param callbacks the callback to call once icon is retrieved
90     * @param sequence the sequence number of the call
91     * @see android.print.PrinterInfo.Builder#setHasCustomPrinterIcon()
92     */
93    void getCustomPrinterIcon(in PrinterId printerId,
94            in IPrintSpoolerCallbacks callbacks, in int sequence);
95
96    /**
97     * Clear all state from the custom printer icon cache.
98     *
99     * @param callbacks the callback to call once cache is cleared
100     * @param sequence the sequence number of the call
101     */
102    void clearCustomPrinterIconCache(in IPrintSpoolerCallbacks callbacks,
103            in int sequence);
104
105    void setPrintJobTag(in PrintJobId printJobId, String tag, IPrintSpoolerCallbacks callback,
106            int sequence);
107    void writePrintJobData(in ParcelFileDescriptor fd, in PrintJobId printJobId);
108    void setClient(IPrintSpoolerClient client);
109    void setPrintJobCancelling(in PrintJobId printJobId, boolean cancelling);
110
111    /**
112     * Remove all approved print services that are not in the given set.
113     *
114     * @param servicesToKeep The names of the services to keep
115     */
116    void pruneApprovedPrintServices(in List<ComponentName> servicesToKeep);
117}
118