PrinterInfo.Builder
public
static
final
class
PrinterInfo.Builder
extends Object
java.lang.Object | |
↳ | android.print.PrinterInfo.Builder |
Builder for creating of a PrinterInfo
.
Summary
Public constructors | |
---|---|
Builder(PrinterId printerId, String name, int status)
Constructor. |
|
Builder(PrinterInfo other)
Constructor. |
Public methods | |
---|---|
PrinterInfo
|
build()
Creates a new |
PrinterInfo.Builder
|
setCapabilities(PrinterCapabilitiesInfo capabilities)
Sets the printer capabilities. |
PrinterInfo.Builder
|
setDescription(String description)
Sets the localized printer description which is shown to the user |
PrinterInfo.Builder
|
setHasCustomPrinterIcon(boolean hasCustomPrinterIcon)
Declares that the print service can load a custom per printer's icon. |
PrinterInfo.Builder
|
setIconResourceId(int iconResourceId)
Set a drawable resource as icon for this printer. |
PrinterInfo.Builder
|
setInfoIntent(PendingIntent infoIntent)
Sets the |
PrinterInfo.Builder
|
setName(String name)
Sets the localized printer name which is shown to the user |
PrinterInfo.Builder
|
setStatus(int status)
Sets the printer status. |
Inherited methods | |
---|---|
Public constructors
Builder
public Builder (PrinterId printerId, String name, int status)
Constructor.
Parameters | |
---|---|
printerId |
PrinterId : The printer id. Cannot be null. |
name |
String : The printer name. Cannot be empty.
This value cannot be null . |
status |
int : The printer status. Must be a valid status.
Value is PrinterInfo.STATUS_IDLE , PrinterInfo.STATUS_BUSY , or PrinterInfo.STATUS_UNAVAILABLE |
Throws | |
---|---|
IllegalArgumentException |
If the printer id is null, or the printer name is empty or the status is not a valid one. |
Builder
public Builder (PrinterInfo other)
Constructor.
Parameters | |
---|---|
other |
PrinterInfo : Other info from which to start building.
This value cannot be null . |
Public methods
build
public PrinterInfo build ()
Creates a new PrinterInfo
.
Returns | |
---|---|
PrinterInfo |
A new PrinterInfo .
This value cannot be null . |
setCapabilities
public PrinterInfo.Builder setCapabilities (PrinterCapabilitiesInfo capabilities)
Sets the printer capabilities.
Parameters | |
---|---|
capabilities |
PrinterCapabilitiesInfo : The capabilities.
This value cannot be null . |
Returns | |
---|---|
PrinterInfo.Builder |
This builder.
This value cannot be null . |
setDescription
public PrinterInfo.Builder setDescription (String description)
Sets the localized printer description which is shown to the user
Parameters | |
---|---|
description |
String : The description.
This value cannot be null . |
Returns | |
---|---|
PrinterInfo.Builder |
This builder.
This value cannot be null . |
setHasCustomPrinterIcon
public PrinterInfo.Builder setHasCustomPrinterIcon (boolean hasCustomPrinterIcon)
Declares that the print service can load a custom per printer's icon. If both
PrinterInfo.Builder.setIconResourceId
and a custom icon are set the resource icon
is shown while the custom icon loads but then the custom icon is used. If
PrinterInfo.Builder.setIconResourceId
is not set the printer's service's icon is
shown while loading.
The icon is requested asynchronously and only when needed via
PrinterDiscoverySession.onRequestCustomPrinterIcon(PrinterId, CancellationSignal, CustomPrinterIconCallback)
.
Parameters | |
---|---|
hasCustomPrinterIcon |
boolean : If the printer has a custom icon or not. |
Returns | |
---|---|
PrinterInfo.Builder |
This builder.
This value cannot be null . |
setIconResourceId
public PrinterInfo.Builder setIconResourceId (int iconResourceId)
Set a drawable resource as icon for this printer. If no icon is set the printer's service's icon is used for the printer.
Parameters | |
---|---|
iconResourceId |
int : The resource ID of the icon. |
Returns | |
---|---|
PrinterInfo.Builder |
This builder.
This value cannot be null . |
See also:
setInfoIntent
public PrinterInfo.Builder setInfoIntent (PendingIntent infoIntent)
Sets the PendingIntent
that launches an activity showing more information about
the printer.
Parameters | |
---|---|
infoIntent |
PendingIntent : The intent .
This value cannot be null . |
Returns | |
---|---|
PrinterInfo.Builder |
This builder.
This value cannot be null . |
setName
public PrinterInfo.Builder setName (String name)
Sets the localized printer name which is shown to the user
Parameters | |
---|---|
name |
String : The name.
This value cannot be null . |
Returns | |
---|---|
PrinterInfo.Builder |
This builder.
This value cannot be null . |
setStatus
public PrinterInfo.Builder setStatus (int status)
Sets the printer status.
Parameters | |
---|---|
status |
int : The status.
Value is PrinterInfo.STATUS_IDLE , PrinterInfo.STATUS_BUSY , or PrinterInfo.STATUS_UNAVAILABLE |
Returns | |
---|---|
PrinterInfo.Builder |
This builder.
This value cannot be null . |