1 /*
2  * Copyright (c) 2022 Huawei Device Co., Ltd.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 
16 #ifndef PRINT_SERVICE_INTERFACE_H
17 #define PRINT_SERVICE_INTERFACE_H
18 
19 #include <string>
20 #include <vector>
21 
22 #include "iprint_callback.h"
23 #include "iprint_extension_callback.h"
24 #include "iremote_broker.h"
25 #include "print_extension_info.h"
26 #include "print_job.h"
27 #include "printer_info.h"
28 #include "iprint_ipc_interface_code.h"
29 
30 namespace OHOS::Print {
31 class IPrintService : public IRemoteBroker {
32 public:
33     DECLARE_INTERFACE_DESCRIPTOR(u"OHOS.Print.IPrintService");
34     virtual int32_t StartService() = 0;
35     virtual int32_t StartPrint(const std::vector<std::string> &fileList,
36         const std::vector<uint32_t> &fdList, std::string &taskId) = 0;
37     virtual int32_t StopPrint(const std::string &taskId) = 0;
38     virtual int32_t ConnectPrinter(const std::string &printerId) = 0;
39     virtual int32_t DisconnectPrinter(const std::string &printerId) = 0;
40     virtual int32_t StartDiscoverPrinter(const std::vector<std::string> &extensionList) = 0;
41     virtual int32_t StopDiscoverPrinter() = 0;
42     virtual int32_t QueryAllExtension(std::vector<PrintExtensionInfo> &extensionInfos) = 0;
43     virtual int32_t StartPrintJob(PrintJob &jobInfo) = 0;
44     virtual int32_t CancelPrintJob(const std::string &jobId) = 0;
45     virtual int32_t AddPrinters(const std::vector<PrinterInfo> &printerInfos) = 0;
46     virtual int32_t RemovePrinters(const std::vector<std::string> &printerIds) = 0;
47     virtual int32_t UpdatePrinters(const std::vector<PrinterInfo> &printerInfos) = 0;
48     virtual int32_t UpdatePrinterState(const std::string &printerId, uint32_t state) = 0;
49     virtual int32_t UpdatePrintJobStateForNormalApp(
50         const std::string &jobId, uint32_t state, uint32_t subState) = 0;
51     virtual int32_t UpdatePrintJobStateOnlyForSystemApp(
52         const std::string &jobId, uint32_t state, uint32_t subState) = 0;
53     virtual int32_t UpdateExtensionInfo(const std::string &extensionId) = 0;
54     virtual int32_t RequestPreview(const PrintJob &jobinfo, std::string &previewResult) = 0;
55     virtual int32_t QueryPrinterCapability(const std::string &printerId) = 0;
56     virtual int32_t On(const std::string taskId, const std::string &type, const sptr<IPrintCallback> &listener) = 0;
57     virtual int32_t Off(const std::string taskId, const std::string &type) = 0;
58     virtual int32_t RegisterPrinterCallback(const std::string &type, const sptr<IPrintCallback> &listener) = 0;
59     virtual int32_t UnregisterPrinterCallback(const std::string &type) = 0;
60     virtual int32_t RegisterExtCallback(const std::string &extensionCID,
61         const sptr<IPrintExtensionCallback> &listener) = 0;
62     virtual int32_t UnregisterAllExtCallback(const std::string &extensionId) = 0;
63     virtual int32_t LoadExtSuccess(const std::string &extensionId) = 0;
64     virtual int32_t QueryAllPrintJob(std::vector<PrintJob> &printJobs) = 0;
65     virtual int32_t QueryPrintJobById(std::string &printJobId, PrintJob &printjob) = 0;
66     virtual int32_t AddPrinterToCups(const std::string &printerUri, const std::string &printerName,
67         const std::string &printerMake) = 0;
68     virtual int32_t QueryPrinterCapabilityByUri(const std::string &printerUri, const std::string &printerId,
69         PrinterCapability &printerCaps) = 0;
70     virtual int32_t PrintByAdapter(const std::string jobName, const PrintAttributes &printAttributes,
71         std::string &taskId) = 0;
72     virtual int32_t StartGetPrintFile(const std::string &jobId, const PrintAttributes &printAttributes,
73         const uint32_t fd) = 0;
74     virtual int32_t NotifyPrintService(const std::string &jobId, const std::string &type) = 0;
75     virtual int32_t QueryPrinterInfoByPrinterId(const std::string &printerId, PrinterInfo &info) = 0;
76     virtual int32_t QueryAddedPrinter(std::vector<std::string> &printerNameList) = 0;
77     virtual int32_t QueryPrinterProperties(const std::string &printerId, const std::vector<std::string> &keyList,
78         std::vector<std::string> &valueList) = 0;
79     virtual int32_t StartNativePrintJob(PrintJob &printJob) = 0;
80     virtual int32_t NotifyPrintServiceEvent(std::string &jobId, uint32_t event) = 0;
81     virtual int32_t GetPrinterPreference(const std::string &printerId, std::string &printerPreference) = 0;
82     virtual int32_t SetPrinterPreference(const std::string &printerId, const std::string &printerPreference) = 0;
83     virtual int32_t SetDefaultPrinter(const std::string &printerId, uint32_t type) = 0;
84     virtual int32_t DeletePrinterFromCups(const std::string &printerName) = 0;
85     virtual int32_t DiscoverUsbPrinters(std::vector<PrinterInfo> &printers) = 0;
86     virtual int32_t AddPrinterToDiscovery(const PrinterInfo &printerInfo) = 0;
87     virtual int32_t UpdatePrinterInDiscovery(const PrinterInfo &printerInfo) = 0;
88     virtual int32_t RemovePrinterFromDiscovery(const std::string &printerId) = 0;
89     virtual int32_t UpdatePrinterInSystem(const PrinterInfo &printerInfo) = 0;
90 };
91 } // namespace OHOS::Print
92 #endif // PRINT_SERVICE_INTERFACE_H