Added in [API level 37](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Nested Classes](https://developer.android.com/reference/android/app/permissionui/LocationButtonRequest#nestedclasses) \| [Inherited Constants](https://developer.android.com/reference/android/app/permissionui/LocationButtonRequest#inhconstants) \| [Fields](https://developer.android.com/reference/android/app/permissionui/LocationButtonRequest#lfields) \| [Methods](https://developer.android.com/reference/android/app/permissionui/LocationButtonRequest#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/app/permissionui/LocationButtonRequest#inhmethods)

# LocationButtonRequest

*** ** * ** ***

` public final class LocationButtonRequest `   
` extends https://developer.android.com/reference/java/lang/Object ` ` implements https://developer.android.com/reference/android/os/Parcelable `

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.app.permissionui.LocationButtonRequest |

<br />

*** ** * ** ***

Defines the requested visual properties for a location button.

An instance of this class is passed to `https://developer.android.com/reference/android/app/permissionui/LocationButtonProvider#openSession(android.app.Activity,%20android.os.IBinder,%20int,%20android.app.permissionui.LocationButtonRequest,%20java.util.concurrent.Executor,%20android.app.permissionui.LocationButtonClient)` to configure the button's appearance, such as its text, colors, and corner radius etc. The appearance can be changed after the session has been opened.
**See also:**

- `https://developer.android.com/reference/android/app/permissionui/LocationButtonProvider#openSession(android.app.Activity,%20android.os.IBinder,%20int,%20android.app.permissionui.LocationButtonRequest,%20java.util.concurrent.Executor,%20android.app.permissionui.LocationButtonClient)`
- `https://developer.android.com/reference/android/app/permissionui/LocationButtonSession`

## Summary

| ### Nested classes ||
|---|---|
| ` class` | `https://developer.android.com/reference/android/app/permissionui/LocationButtonRequest.Builder` Builder for `https://developer.android.com/reference/android/app/permissionui/LocationButtonRequest`. |

### Inherited constants

From interface `https://developer.android.com/reference/android/os/Parcelable` `int` `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR`

Descriptor bit used with `https://developer.android.com/reference/android/os/Parcelable#describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int` `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`

Flag for use with `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`: 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)`".

| ### Fields ||
|---|---|
| ` public static final https://developer.android.com/reference/android/os/Parcelable.Creator<https://developer.android.com/reference/android/app/permissionui/LocationButtonRequest>` | `https://developer.android.com/reference/android/app/permissionui/LocationButtonRequest#CREATOR` <br /> |

| ### Public methods ||
|---|---|
| ` int` | ` https://developer.android.com/reference/android/app/permissionui/LocationButtonRequest#describeContents()() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| ` int` | ` https://developer.android.com/reference/android/app/permissionui/LocationButtonRequest#getBackgroundColor()() ` Returns the background color of the button as a `https://developer.android.com/`. |
| ` https://developer.android.com/reference/android/content/res/Configuration` | ` https://developer.android.com/reference/android/app/permissionui/LocationButtonRequest#getConfiguration()() ` Returns the configuration of the button. |
| ` float` | ` https://developer.android.com/reference/android/app/permissionui/LocationButtonRequest#getCornerRadius()() ` Returns the corner radius of the button in pixels. |
| ` int` | ` https://developer.android.com/reference/android/app/permissionui/LocationButtonRequest#getHeight()() ` Returns the height of the button. |
| ` int` | ` https://developer.android.com/reference/android/app/permissionui/LocationButtonRequest#getIconTint()() ` Returns the icon tint color as a `https://developer.android.com/`. |
| ` int` | ` https://developer.android.com/reference/android/app/permissionui/LocationButtonRequest#getPaddingBottom()() ` Returns the bottom padding of the button. |
| ` int` | ` https://developer.android.com/reference/android/app/permissionui/LocationButtonRequest#getPaddingLeft()() ` Returns the left padding of the button. |
| ` int` | ` https://developer.android.com/reference/android/app/permissionui/LocationButtonRequest#getPaddingRight()() ` Returns the right padding of the button. |
| ` int` | ` https://developer.android.com/reference/android/app/permissionui/LocationButtonRequest#getPaddingTop()() ` Returns the top padding of the button. |
| ` float` | ` https://developer.android.com/reference/android/app/permissionui/LocationButtonRequest#getPressedCornerRadius()() ` Returns the corner radius of the button when pressed. |
| ` int` | ` https://developer.android.com/reference/android/app/permissionui/LocationButtonRequest#getStrokeColor()() ` Returns the button outline/border color as a `https://developer.android.com/`. |
| ` int` | ` https://developer.android.com/reference/android/app/permissionui/LocationButtonRequest#getStrokeWidth()() ` Returns the button outline/border width. |
| ` int` | ` https://developer.android.com/reference/android/app/permissionui/LocationButtonRequest#getTextColor()() ` Returns the color of the button's text as a `https://developer.android.com/`. |
| ` int` | ` https://developer.android.com/reference/android/app/permissionui/LocationButtonRequest#getTextType()() ` Returns the text type displayed on the button. |
| ` int` | ` https://developer.android.com/reference/android/app/permissionui/LocationButtonRequest#getWidth()() ` Returns the width of the button. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/app/permissionui/LocationButtonRequest#toString()() ` Returns a string representation of the object. |
| ` void` | ` https://developer.android.com/reference/android/app/permissionui/LocationButtonRequest#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) ` Flatten this object in to a Parcel. |

### Inherited methods

From class ` https://developer.android.com/reference/java/lang/Object ` ` https://developer.android.com/reference/java/lang/Object` ` https://developer.android.com/reference/java/lang/Object#clone()() `

Creates and returns a copy of this object.
` boolean` ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) `

Indicates whether some other object is "equal to" this one.
` void` ` https://developer.android.com/reference/java/lang/Object#finalize()() `

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
` final https://developer.android.com/reference/java/lang/Class<?>` ` https://developer.android.com/reference/java/lang/Object#getClass()() `

Returns the runtime class of this `Object`.
` int` ` https://developer.android.com/reference/java/lang/Object#hashCode()() `

Returns a hash code value for the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#notify()() `

Wakes up a single thread that is waiting on this object's monitor.
` final void` ` https://developer.android.com/reference/java/lang/Object#notifyAll()() `

Wakes up all threads that are waiting on this object's monitor.
` https://developer.android.com/reference/java/lang/String` ` https://developer.android.com/reference/java/lang/Object#toString()() `

Returns a string representation of the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(long timeoutMillis, int nanos) `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long)(long timeoutMillis) `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait()() `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*.
From interface ` https://developer.android.com/reference/android/os/Parcelable ` ` abstract int` ` https://developer.android.com/reference/android/os/Parcelable#describeContents()() `

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
` abstract void` ` https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) `

Flatten this object in to a Parcel.

## Fields

### CREATOR

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

```
public static final Creator<LocationButtonRequest> CREATOR
```

<br />

<br />

## Public methods

### describeContents

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

```
public int describeContents ()
```

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`, the return value of this method must include the `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` bit.

<br />

| Returns ||
|---|---|
| `int` | a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or - `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` |

### getBackgroundColor

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

```
public int getBackgroundColor ()
```

Returns the background color of the button as a `https://developer.android.com/`.

<br />

| Returns ||
|---|---|
| `int` | <br /> |

### getConfiguration

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

```
public Configuration getConfiguration ()
```

Returns the configuration of the button.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/content/res/Configuration` | This value cannot be `null`. <br /> |

### getCornerRadius

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

```
public float getCornerRadius ()
```

Returns the corner radius of the button in pixels.

<br />

| Returns ||
|---|---|
| `float` | <br /> |

### getHeight

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

```
public int getHeight ()
```

Returns the height of the button.

<br />

| Returns ||
|---|---|
| `int` | <br /> |

### getIconTint

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

```
public int getIconTint ()
```

Returns the icon tint color as a `https://developer.android.com/`.

<br />

| Returns ||
|---|---|
| `int` | <br /> |

### getPaddingBottom

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

```
public int getPaddingBottom ()
```

Returns the bottom padding of the button.

<br />

| Returns ||
|---|---|
| `int` | <br /> |

### getPaddingLeft

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

```
public int getPaddingLeft ()
```

Returns the left padding of the button.

<br />

| Returns ||
|---|---|
| `int` | <br /> |

### getPaddingRight

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

```
public int getPaddingRight ()
```

Returns the right padding of the button.

<br />

| Returns ||
|---|---|
| `int` | <br /> |

### getPaddingTop

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

```
public int getPaddingTop ()
```

Returns the top padding of the button.

<br />

| Returns ||
|---|---|
| `int` | <br /> |

### getPressedCornerRadius

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

```
public float getPressedCornerRadius ()
```

Returns the corner radius of the button when pressed.

<br />

| Returns ||
|---|---|
| `float` | <br /> |

### getStrokeColor

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

```
public int getStrokeColor ()
```

Returns the button outline/border color as a `https://developer.android.com/`.

<br />

| Returns ||
|---|---|
| `int` | <br /> |

### getStrokeWidth

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

```
public int getStrokeWidth ()
```

Returns the button outline/border width.

<br />

| Returns ||
|---|---|
| `int` | <br /> |

### getTextColor

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

```
public int getTextColor ()
```

Returns the color of the button's text as a `https://developer.android.com/`.

<br />

| Returns ||
|---|---|
| `int` | <br /> |

### getTextType

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

```
public int getTextType ()
```

Returns the text type displayed on the button.

<br />

| Returns ||
|---|---|
| `int` | Value is one of the following: - `https://developer.android.com/reference/android/app/permissionui/LocationButtonSession#TEXT_TYPE_NONE` - `https://developer.android.com/reference/android/app/permissionui/LocationButtonSession#TEXT_TYPE_PRECISE_LOCATION` - `https://developer.android.com/reference/android/app/permissionui/LocationButtonSession#TEXT_TYPE_USE_PRECISE_LOCATION` - `https://developer.android.com/reference/android/app/permissionui/LocationButtonSession#TEXT_TYPE_SHARE_PRECISE_LOCATION` - `https://developer.android.com/reference/android/app/permissionui/LocationButtonSession#TEXT_TYPE_NEAR_MY_PRECISE_LOCATION` - `https://developer.android.com/reference/android/app/permissionui/LocationButtonSession#TEXT_TYPE_NEAR_YOUR_PRECISE_LOCATION` |

### getWidth

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

```
public int getWidth ()
```

Returns the width of the button.

<br />

| Returns ||
|---|---|
| `int` | <br /> |

### toString

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

```
public String toString ()
```

Returns a string representation of the object.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | a string representation of the object. <br /> |

### writeToParcel

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

```
public void writeToParcel (Parcel dest, 
                int flags)
```

Flatten this object in to a Parcel.

<br />

| Parameters ||
|---|---|
| `dest` | `Parcel`: This value cannot be `null`. <br /> |
| `flags` | `int`: Additional flags about how the object should be written. May be 0 or `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of the following: - `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE` |