Skip to content

Most visited

Recently visited

navigation
Added in API level 19

PrinterDiscoverySession

public abstract class PrinterDiscoverySession
extends Object

java.lang.Object
   ↳ android.printservice.PrinterDiscoverySession


This class encapsulates the interaction between a print service and the system during printer discovery. During printer discovery you are responsible for adding discovered printers, removing previously added printers that disappeared, and updating already added printers.

During the lifetime of this session you may be asked to start and stop performing printer discovery multiple times. You will receive a call to onStartPrinterDiscovery(List) to start printer discovery and a call to onStopPrinterDiscovery() to stop printer discovery. When the system is no longer interested in printers discovered by this session you will receive a call to onDestroy() at which point the system will no longer call into the session and all the session methods will do nothing.

Discovered printers are added by invoking addPrinters(List). Added printers that disappeared are removed by invoking removePrinters(List). Added printers whose properties or capabilities changed are updated through a call to addPrinters(List). The printers added in this session can be acquired via getPrinters() where the returned printers will be an up-to-date snapshot of the printers that you reported during the session. Printers are not persisted across sessions.

The system will make a call to onValidatePrinters(List) if you need to update some printers. It is possible that you add a printer without specifying its capabilities. This enables you to avoid querying all discovered printers for their capabilities, rather querying the capabilities of a printer only if necessary. For example, the system will request that you update a printer if it gets selected by the user. When validating printers you do not need to provide the printers' capabilities but may do so.

If the system is interested in being constantly updated for the state of a printer you will receive a call to onStartPrinterStateTracking(PrinterId) after which you will have to do a best effort to keep the system updated for changes in the printer state and capabilities. You also must update the printer capabilities if you did not provide them when adding it, or the printer will be ignored. When the system is no longer interested in getting updates for a printer you will receive a call to onStopPrinterStateTracking(PrinterId).

Note: All callbacks in this class are executed on the main application thread. You also have to invoke any method of this class on the main application thread.

Summary

Public constructors

PrinterDiscoverySession()

Constructor.

Public methods

final void addPrinters(List<PrinterInfo> printers)

Adds discovered printers.

final List<PrinterInfo> getPrinters()

Gets the printers reported in this session.

final List<PrinterId> getTrackedPrinters()

Gets the printers that should be tracked.

final boolean isDestroyed()

Gets whether the session is destroyed.

final boolean isPrinterDiscoveryStarted()

Gets whether printer discovery is started.

abstract void onDestroy()

Notifies you that the session is destroyed.

void onRequestCustomPrinterIcon(PrinterId printerId, CancellationSignal cancellationSignal, CustomPrinterIconCallback callback)

Called by the system to request the custom icon for a printer.

abstract void onStartPrinterDiscovery(List<PrinterId> priorityList)

Callback asking you to start printer discovery.

abstract void onStartPrinterStateTracking(PrinterId printerId)

Callback asking you to start tracking the state of a printer.

abstract void onStopPrinterDiscovery()

Callback notifying you that you should stop printer discovery.

abstract void onStopPrinterStateTracking(PrinterId printerId)

Callback asking you to stop tracking the state of a printer.

abstract void onValidatePrinters(List<PrinterId> printerIds)

Callback asking you to validate that the given printers are valid, that is they exist.

final void removePrinters(List<PrinterId> printerIds)

Removes added printers.

Inherited methods

From class java.lang.Object

Public constructors

PrinterDiscoverySession

Added in API level 19
PrinterDiscoverySession ()

Constructor.

Public methods

addPrinters

Added in API level 19
void addPrinters (List<PrinterInfo> printers)

Adds discovered printers. Adding an already added printer updates it. Removed printers can be added again. You can call this method multiple times during the life of this session. Duplicates will be ignored.

Note: Calls to this method after the session is destroyed, that is after the onDestroy() callback, will be ignored.

Parameters
printers List: The printers to add.

See also:

getPrinters

Added in API level 19
List<PrinterInfo> getPrinters ()

Gets the printers reported in this session. For example, if you add two printers and remove one of them, the returned list will contain only the printer that was added but not removed.

Note: Calls to this method after the session is destroyed, that is after the onDestroy() callback, will be ignored.

Returns
List<PrinterInfo> The printers.

See also:

getTrackedPrinters

Added in API level 19
List<PrinterId> getTrackedPrinters ()

Gets the printers that should be tracked. These are printers that are important to the user and for which you received a call to onStartPrinterStateTracking(PrinterId) asking you to observer their state and reporting it to the system via addPrinters(List). You will receive a call to onStopPrinterStateTracking(PrinterId) if you should stop tracking a printer.

Note: Calls to this method after the session is destroyed, that is after the onDestroy() callback, will be ignored.

Returns
List<PrinterId> The printers.

See also:

isDestroyed

Added in API level 19
boolean isDestroyed ()

Gets whether the session is destroyed.

Returns
boolean Whether the session is destroyed.

See also:

isPrinterDiscoveryStarted

Added in API level 19
boolean isPrinterDiscoveryStarted ()

Gets whether printer discovery is started.

Returns
boolean Whether printer discovery is destroyed.

See also:

onDestroy

Added in API level 19
void onDestroy ()

Notifies you that the session is destroyed. After this callback is invoked any calls to the methods of this class will be ignored, isDestroyed() will return true and you will also no longer receive callbacks.

See also:

onRequestCustomPrinterIcon

Added in API level 24
void onRequestCustomPrinterIcon (PrinterId printerId, 
                CancellationSignal cancellationSignal, 
                CustomPrinterIconCallback callback)

Called by the system to request the custom icon for a printer. Once the icon is available the print services uses onCustomPrinterIconLoaded(Icon) to send the icon to the system.

Parameters
printerId PrinterId: The printer to icon belongs to.
cancellationSignal CancellationSignal: Signal used to cancel the request.
callback CustomPrinterIconCallback: Callback for returning the icon to the system.

See also:

onStartPrinterDiscovery

Added in API level 19
void onStartPrinterDiscovery (List<PrinterId> priorityList)

Callback asking you to start printer discovery. Discovered printers should be added via calling addPrinters(List). Added printers that disappeared should be removed via calling removePrinters(List). Added printers whose properties or capabilities changed should be updated via calling addPrinters(List). You will receive a call to onStopPrinterDiscovery() when you should stop printer discovery.

During the lifetime of this session all printers that are known to your print service have to be added. The system does not retain any printers across sessions. However, if you were asked to start and then stop performing printer discovery in this session, then a subsequent discovering should not re-discover already discovered printers. You can get the printers reported during this session by calling getPrinters().

Note: You are also given a list of printers whose availability has to be checked first. For example, these printers could be the user's favorite ones, therefore they have to be verified first. You do not need to provide the capabilities of the printers, rather verify whether they exist similarly to onValidatePrinters(List).

Parameters
priorityList List: The list of printers to validate first. Never null.

See also:

onStartPrinterStateTracking

Added in API level 19
void onStartPrinterStateTracking (PrinterId printerId)

Callback asking you to start tracking the state of a printer. Tracking the state means that you should do a best effort to observe the state of this printer and notify the system if that state changes via calling addPrinters(List).

Note: A printer can be initially added without its capabilities to avoid polling printers that the user will not select. However, after this method is called you are expected to update the printer including its capabilities. Otherwise, the printer will be ignored.

A scenario when you may be requested to track a printer's state is if the user selects that printer and the system has to present print options UI based on the printer's capabilities. In this case the user should be promptly informed if, for example, the printer becomes unavailable.

Parameters
printerId PrinterId: The printer to start tracking.

See also:

onStopPrinterDiscovery

Added in API level 19
void onStopPrinterDiscovery ()

Callback notifying you that you should stop printer discovery.

See also:

onStopPrinterStateTracking

Added in API level 19
void onStopPrinterStateTracking (PrinterId printerId)

Callback asking you to stop tracking the state of a printer. The passed in printer id is the one for which you received a call to onStartPrinterStateTracking(PrinterId).

Parameters
printerId PrinterId: The printer to stop tracking.

See also:

onValidatePrinters

Added in API level 19
void onValidatePrinters (List<PrinterId> printerIds)

Callback asking you to validate that the given printers are valid, that is they exist. You are responsible for checking whether these printers exist and for the ones that do exist notify the system via calling addPrinters(List).

Note: You are not required to provide the printer capabilities when updating the printers that do exist.

Parameters
printerIds List: The printers to validate.

See also:

removePrinters

Added in API level 19
void removePrinters (List<PrinterId> printerIds)

Removes added printers. Removing an already removed or never added printer has no effect. Removed printers can be added again. You can call this method multiple times during the lifetime of this session.

Note: Calls to this method after the session is destroyed, that is after the onDestroy() callback, will be ignored.

Parameters
printerIds List: The ids of the removed printers.

See also:

This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.