blob: c3a2d0de05759be92edea1d40efc88774233585b (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
|
/*
* Copyright (C) 2016 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 com.android.printservice.recommendation;
import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
import androidx.annotation.StringRes;
import java.net.InetAddress;
import java.util.List;
/**
* Interface to be implemented by each print service plugin.
* <p/>
* A print service plugin is a minimal version of a real {@link android.printservice.PrintService
* print service}. You cannot print using the plugin. The only functionality in the plugin is to
* report the number of printers that the real service would discover.
*/
public interface PrintServicePlugin {
/**
* Call back used by the print service plugins.
*/
interface PrinterDiscoveryCallback {
/**
* Announce that something changed and the UI for this plugin should be updated.
*
* @param discoveredPrinters The printers discovered.
*/
void onChanged(@Nullable List<InetAddress> discoveredPrinters);
}
/**
* Get the name (a string reference) of the {@link android.printservice.PrintService print
* service} with the {@link #getPackageName specified package name}. This is read once, hence
* returning different data at different times is not allowed.
*
* @return The name of the print service as a string reference. The localization is handled
* outside of the plugin.
*/
@StringRes int getName();
/**
* The package name of the full print service.
*
* @return The package name
*/
@NonNull CharSequence getPackageName();
/**
* Start the discovery plugin.
*
* @param callback Callbacks used by this plugin.
*
* @throws Exception If anything went wrong when starting the plugin
*/
void start(@NonNull PrinterDiscoveryCallback callback) throws Exception;
/**
* Stop the plugin. This can only return once the plugin is completely finished and cleaned up.
*
* @throws Exception If anything went wrong while stopping plugin
*/
void stop() throws Exception;
}
|
