# PrinterInfo

Added in[API level 19](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)

# PrinterInfo

*** ** * ** ***

Kotlin\|[Java](https://developer.android.com/reference/android/print/PrinterInfo "View this page in Java")  

```
class PrinterInfo : Parcelable
```

|---|--------------------------------------------------------------------------------------------------------|
| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)                         ||
| ↳ | [android.print.PrinterInfo](https://developer.android.com/reference/kotlin/android/print/PrinterInfo#) |

This class represents the description of a printer. Instances of this class are created by print services to report to the system the printers they manage. The information of this class has two major components, printer properties such as name, id, status, description and printer capabilities which describe the various print modes a printer supports such as media sizes, margins, etc.

Once[built](https://developer.android.com/reference/kotlin/android/print/PrinterInfo.Builder#build())the objects are immutable.

## Summary

|                                                                                                  Nested classes                                                                                                   ||
|---|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|   | [Builder](https://developer.android.com/reference/kotlin/android/print/PrinterInfo.Builder) Builder for creating of a[PrinterInfo](https://developer.android.com/reference/kotlin/android/print/PrinterInfo#). |

|                                                                                                                          Constants                                                                                                                           ||
|----------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| static[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [STATUS_BUSY](https://developer.android.com/reference/kotlin/android/print/PrinterInfo#STATUS_BUSY:kotlin.Int) Printer status: the printer is busy printing.               |
| static[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [STATUS_IDLE](https://developer.android.com/reference/kotlin/android/print/PrinterInfo#STATUS_IDLE:kotlin.Int) Printer status: the printer is idle and ready to print.     |
| static[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [STATUS_UNAVAILABLE](https://developer.android.com/reference/kotlin/android/print/PrinterInfo#STATUS_UNAVAILABLE:kotlin.Int) Printer status: the printer is not available. |

| Inherited constants ||
|---|---|
| From class[Parcelable](https://developer.android.com/reference/kotlin/android/os/Parcelable.html#) |----------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [CONTENTS_FILE_DESCRIPTOR](https://developer.android.com/reference/kotlin/android/os/Parcelable.html#CONTENTS_FILE_DESCRIPTOR:kotlin.Int) <br /> Descriptor bit used with[describeContents()](https://developer.android.com/reference/kotlin/android/os/Parcelable.html#describeContents()): indicates that the Parcelable object's flattened representation includes a file descriptor. <br />                                                                                                                                                                                                        | | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [PARCELABLE_WRITE_RETURN_VALUE](https://developer.android.com/reference/kotlin/android/os/Parcelable.html#PARCELABLE_WRITE_RETURN_VALUE:kotlin.Int) <br /> Flag for use with[writeToParcel](https://developer.android.com/reference/kotlin/android/os/Parcelable.html#writeToParcel(android.os.Parcel,%20kotlin.Int)): the object being written is a return value, that is the result of a function such as "`Parcelable someFunction()`", "`void someFunction(out Parcelable)`", or "`void someFunction(inout Parcelable)`". Some implementations may want to release resources at this point. <br /> | ||

|                                                                                                                                                                                                                      Public methods                                                                                                                                                                                                                      ||
|------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)                                       | [describeContents](https://developer.android.com/reference/kotlin/android/print/PrinterInfo#describeContents())`()` <br />                                                                                                                                                                                                             |
| [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)                               | [equals](https://developer.android.com/reference/kotlin/android/print/PrinterInfo#equals(kotlin.Any))`(`other:` `[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)?`)` Indicates whether some other object is "equal to" this one.                                                                            |
| [PrinterCapabilitiesInfo](https://developer.android.com/reference/kotlin/android/print/PrinterCapabilitiesInfo)? | [getCapabilities](https://developer.android.com/reference/kotlin/android/print/PrinterInfo#getCapabilities())`()` Gets the printer capabilities.                                                                                                                                                                                       |
| [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?                                | [getDescription](https://developer.android.com/reference/kotlin/android/print/PrinterInfo#getDescription())`()` Gets the printer description.                                                                                                                                                                                          |
| [PrinterId](https://developer.android.com/reference/kotlin/android/print/PrinterId)                              | [getId](https://developer.android.com/reference/kotlin/android/print/PrinterInfo#getId())`()` Get the globally unique printer id.                                                                                                                                                                                                      |
| [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)                                 | [getName](https://developer.android.com/reference/kotlin/android/print/PrinterInfo#getName())`()` Get the printer name.                                                                                                                                                                                                                |
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)                                       | [getStatus](https://developer.android.com/reference/kotlin/android/print/PrinterInfo#getStatus())`()` Gets the printer status.                                                                                                                                                                                                         |
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)                                       | [hashCode](https://developer.android.com/reference/kotlin/android/print/PrinterInfo#hashCode())`()` <br />                                                                                                                                                                                                                             |
| [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)                                 | [toString](https://developer.android.com/reference/kotlin/android/print/PrinterInfo#toString())`()` <br />                                                                                                                                                                                                                             |
| [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)                                     | [writeToParcel](https://developer.android.com/reference/kotlin/android/print/PrinterInfo#writeToParcel(android.os.Parcel,%20kotlin.Int))`(`parcel:` `[Parcel](https://developer.android.com/reference/kotlin/android/os/Parcel.html#)`, `flags:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` <br /> |

|                                                                                                                                                                  Properties                                                                                                                                                                   ||
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------|
| static[Parcelable.Creator](https://developer.android.com/reference/kotlin/android/os/Parcelable.Creator.html#)\<[PrinterInfo](https://developer.android.com/reference/kotlin/android/print/PrinterInfo#)!\> | [CREATOR](https://developer.android.com/reference/kotlin/android/print/PrinterInfo#CREATOR:android.os.Parcelable.Creator) <br /> |

## Constants

### STATUS_BUSY

Added in[API level 19](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
static val STATUS_BUSY: Int
```

Printer status: the printer is busy printing.  

    Value: 2

### STATUS_IDLE

Added in[API level 19](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
static val STATUS_IDLE: Int
```

Printer status: the printer is idle and ready to print.  

    Value: 1

### STATUS_UNAVAILABLE

Added in[API level 19](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
static val STATUS_UNAVAILABLE: Int
```

Printer status: the printer is not available.  

    Value: 3

## Public methods

### describeContents

Added in[API level 19](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
fun describeContents(): Int
```

|                                                                                                                                                                               Return                                                                                                                                                                               ||
|----------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either`0`or[android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR](https://developer.android.com/reference/kotlin/android/os/Parcelable.html#CONTENTS_FILE_DESCRIPTOR:kotlin.Int) |

### equals

Added in[API level 19](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
fun equals(other: Any?): Boolean
```

Indicates whether some other object is "equal to" this one.

The`equals`method implements an equivalence relation on non-null object references:

- It is*reflexive* : for any non-null reference value`x`,`x.equals(x)`should return`true`.
- It is*symmetric* : for any non-null reference values`x`and`y`,`x.equals(y)`should return`true`if and only if`y.equals(x)`returns`true`.
- It is*transitive* : for any non-null reference values`x`,`y`, and`z`, if`x.equals(y)`returns`true`and`y.equals(z)`returns`true`, then`x.equals(z)`should return`true`.
- It is*consistent* : for any non-null reference values`x`and`y`, multiple invocations of`x.equals(y)`consistently return`true`or consistently return`false`, provided no information used in`equals`comparisons on the objects is modified.
- For any non-null reference value`x`,`x.equals(null)`should return`false`.

An equivalence relation partitions the elements it operates on into*equivalence classes*; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

|           Parameters            ||
|-------|--------------------------|
| `obj` | This value may be`null`. |

|                                                                           Return                                                                           ||
|------------------------------------------------------------------------------------|------------------------------------------------------------------------|
| [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | `true`if this object is the same as the obj argument;`false`otherwise. |

### getCapabilities

Added in[API level 19](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
fun getCapabilities(): PrinterCapabilitiesInfo?
```

Gets the printer capabilities.

|                                                                            Return                                                                            ||
|------------------------------------------------------------------------------------------------------------------|--------------------------------------------|
| [PrinterCapabilitiesInfo](https://developer.android.com/reference/kotlin/android/print/PrinterCapabilitiesInfo)? | The capabilities. This value may be`null`. |

### getDescription

Added in[API level 19](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
fun getDescription(): String?
```

Gets the printer description.

|                                                            Return                                                            ||
|-----------------------------------------------------------------------------------|-------------------------------------------|
| [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? | The description. This value may be`null`. |

### getId

Added in[API level 19](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
fun getId(): PrinterId
```

Get the globally unique printer id.

|                                                              Return                                                              ||
|-------------------------------------------------------------------------------------|---------------------------------------------|
| [PrinterId](https://developer.android.com/reference/kotlin/android/print/PrinterId) | The printer id. This value cannot be`null`. |

### getName

Added in[API level 19](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
fun getName(): String
```

Get the printer name.

|                                                             Return                                                              ||
|----------------------------------------------------------------------------------|-----------------------------------------------|
| [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | The printer name. This value cannot be`null`. |

### getStatus

Added in[API level 19](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
fun getStatus(): Int
```

Gets the printer status.

|                                                                                                                                                                                                                                                                   Return                                                                                                                                                                                                                                                                    ||
|----------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | The status. Value is[android.print.PrinterInfo#STATUS_IDLE](https://developer.android.com/reference/kotlin/android/print/PrinterInfo#STATUS_IDLE:kotlin.Int),[android.print.PrinterInfo#STATUS_BUSY](https://developer.android.com/reference/kotlin/android/print/PrinterInfo#STATUS_BUSY:kotlin.Int), or[android.print.PrinterInfo#STATUS_UNAVAILABLE](https://developer.android.com/reference/kotlin/android/print/PrinterInfo#STATUS_UNAVAILABLE:kotlin.Int) |

**See Also**

- [#STATUS_BUSY](https://developer.android.com/reference/kotlin/android/print/PrinterInfo#STATUS_BUSY:kotlin.Int)
- [#STATUS_IDLE](https://developer.android.com/reference/kotlin/android/print/PrinterInfo#STATUS_IDLE:kotlin.Int)
- [#STATUS_UNAVAILABLE](https://developer.android.com/reference/kotlin/android/print/PrinterInfo#STATUS_UNAVAILABLE:kotlin.Int)  

### hashCode

Added in[API level 19](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
fun hashCode(): Int
```

|                                                     Return                                                     ||
|----------------------------------------------------------------------------|------------------------------------|
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | a hash code value for this object. |

### toString

Added in[API level 19](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
fun toString(): String
```

|                                                          Return                                                          ||
|----------------------------------------------------------------------------------|----------------------------------------|
| [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | a string representation of the object. |

### writeToParcel

Added in[API level 19](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
fun writeToParcel(
    parcel: Parcel, 
    flags: Int
): Unit
```

|                                                                                                                                                                                                                                                                                     Parameters                                                                                                                                                                                                                                                                                     ||
|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `dest`  | The Parcel in which the object should be written. This value cannot be`null`.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| `flags` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html):Additional flags about how the object should be written. May be 0 or[PARCELABLE_WRITE_RETURN_VALUE](https://developer.android.com/reference/kotlin/android/os/Parcelable.html#PARCELABLE_WRITE_RETURN_VALUE:kotlin.Int). Value is either`0`or a combination of[android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE](https://developer.android.com/reference/kotlin/android/os/Parcelable.html#PARCELABLE_WRITE_RETURN_VALUE:kotlin.Int), and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES |

## Properties

### CREATOR

Added in[API level 19](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
static val CREATOR: Parcelable.Creator<PrinterInfo!>
```