# CommissioningRequest

public final class **CommissioningRequest** extends [Object](https://developer.android.com/reference/java/lang/Object.html)  
implements [Parcelable](https://developer.android.com/reference/android/os/Parcelable.html) Request to commission a device, either for an uncommissioned device, or a device which has
been opened for multi-administrator commissioning.

### Nested Class Summary

|---|---|---|---|
| interface | [CommissioningRequest.Builder](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/CommissioningRequest.Builder) || Builder for constructing a `https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/CommissioningRequest` instance. |

### Inherited Constant Summary

From interface android.os.Parcelable

|---|---|---|
| int | CONTENTS_FILE_DESCRIPTOR |   |
| int | PARCELABLE_STABILITY_LOCAL |   |
| int | PARCELABLE_STABILITY_VINTF |   |
| int | PARCELABLE_WRITE_RETURN_VALUE |   |

### Public Method Summary

|---|---|
| static [CommissioningRequest.Builder](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/CommissioningRequest.Builder) | [builder](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/CommissioningRequest#builder())() Returns an empty `https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/CommissioningRequest.Builder` instance. |
| boolean | [equals](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/CommissioningRequest#equals(java.lang.Object))([Object](https://developer.android.com/reference/java/lang/Object.html) other) |
| [ComponentName](https://developer.android.com/reference/android/content/ComponentName.html) | [getCommissioningService](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/CommissioningRequest#getCommissioningService())() Returns the `https://developer.android.com/reference/android/content/ComponentName.html` of an exported service which will return a `https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/CommissioningService` in its `https://developer.android.com/reference/android/app/Service.html#onBind(android.content.Intent)` implementation. |
| [DeviceInfo](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/DeviceInfo) | [getDeviceInfo](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/CommissioningRequest#getDeviceInfo())() Returns information about the target device to be commissioned, if specified. |
| [String](https://developer.android.com/reference/java/lang/String.html) | [getDeviceNameHint](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/CommissioningRequest#getDeviceNameHint())() Returns the suggested name for the device being commissioned, if specified. |
| [String](https://developer.android.com/reference/java/lang/String.html) | [getOnboardingPayload](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/CommissioningRequest#getOnboardingPayload())() Returns the onboarding payload (e.g. |
| int | [hashCode](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/CommissioningRequest#hashCode())() |
| void | [writeToParcel](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/CommissioningRequest#writeToParcel(android.os.Parcel,%20int))([Parcel](https://developer.android.com/reference/android/os/Parcel.html) dest, int flags) |

### Inherited Method Summary

From class java.lang.Object

|---|---|
| [Object](https://developer.android.com/reference/java/lang/Object.html) | clone() |
| boolean | equals([Object](https://developer.android.com/reference/java/lang/Object.html) arg0) |
| void | finalize() |
| final [Class](https://developer.android.com/reference/java/lang/Class.html)\<?\> | getClass() |
| int | hashCode() |
| final void | notify() |
| final void | notifyAll() |
| [String](https://developer.android.com/reference/java/lang/String.html) | toString() |
| final void | wait(long arg0, int arg1) |
| final void | wait(long arg0) |
| final void | wait() |

From interface android.os.Parcelable

|---|---|
| abstract int | describeContents() |
| abstract void | writeToParcel([Parcel](https://developer.android.com/reference/android/os/Parcel.html) arg0, int arg1) |

## Public Methods

#### public static [CommissioningRequest.Builder](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/CommissioningRequest.Builder) **builder** ()

Returns an empty `https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/CommissioningRequest.Builder` instance.

#### public boolean **equals** ([Object](https://developer.android.com/reference/java/lang/Object.html) other)

#### public [ComponentName](https://developer.android.com/reference/android/content/ComponentName.html)
**getCommissioningService** ()

Returns the `https://developer.android.com/reference/android/content/ComponentName.html`
of an exported service which will return a `https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/CommissioningService` in its `https://developer.android.com/reference/android/app/Service.html#onBind(android.content.Intent)` implementation.

#### public [DeviceInfo](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/DeviceInfo)
**getDeviceInfo** ()

Returns information about the target device to be commissioned, if specified.

#### public [String](https://developer.android.com/reference/java/lang/String.html) **getDeviceNameHint** ()

Returns the suggested name for the device being commissioned, if specified.

#### public [String](https://developer.android.com/reference/java/lang/String.html) **getOnboardingPayload** ()

Returns the onboarding payload (e.g. QR code text, manual pairing code) of the
target device, if specified.

#### public int **hashCode** ()

#### public void **writeToParcel** ([Parcel](https://developer.android.com/reference/android/os/Parcel.html) dest, int flags)