Added in API level 37

Summary: Nested Classes | Inherited Constants | Fields | Methods | Inherited Methods

LocationButtonRequest

Kotlin |Java

public final class LocationButtonRequest
extends Object implements Parcelable

java.lang.Object
↳	android.app.permissionui.LocationButtonRequest

Defines the requested visual properties for a location button.

An instance of this class is passed to LocationButtonProvider.openSession 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:

Summary

Nested classes
`class`	`LocationButtonRequest.Builder` Builder for `LocationButtonRequest`.

Inherited constants

From interface android.os.Parcelable

`int`	`CONTENTS_FILE_DESCRIPTOR` Descriptor bit used with `describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int`	`PARCELABLE_WRITE_RETURN_VALUE` Flag for use with `writeToParcel(Parcel, 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)`".

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

Public methods
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`int`	`getBackgroundColor()` Returns the background color of the button as a `ERROR(ColorInt/android.annotation.ColorInt ColorInt)`.
`Configuration`	`getConfiguration()` Returns the configuration of the button.
`float`	`getCornerRadius()` Returns the corner radius of the button in pixels.
`int`	`getHeight()` Returns the height of the button.
`int`	`getIconTint()` Returns the icon tint color as a `ERROR(ColorInt/android.annotation.ColorInt ColorInt)`.
`int`	`getPaddingBottom()` Returns the bottom padding of the button.
`int`	`getPaddingLeft()` Returns the left padding of the button.
`int`	`getPaddingRight()` Returns the right padding of the button.
`int`	`getPaddingTop()` Returns the top padding of the button.
`float`	`getPressedCornerRadius()` Returns the corner radius of the button when pressed.
`int`	`getStrokeColor()` Returns the button outline/border color as a `ERROR(ColorInt/android.annotation.ColorInt ColorInt)`.
`int`	`getStrokeWidth()` Returns the button outline/border width.
`int`	`getTextColor()` Returns the color of the button's text as a `ERROR(ColorInt/android.annotation.ColorInt ColorInt)`.
`int`	`getTextType()` Returns the text type displayed on the button.
`int`	`getWidth()` Returns the width of the button.
`String`	`toString()` Returns a string representation of the object.
`void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(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`	`wait(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`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Fields

CREATOR

Added in API level 37

public static final Creator<LocationButtonRequest> CREATOR

Public methods

describeContents

Added in API level 37

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 writeToParcel(Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
`int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `CONTENTS_FILE_DESCRIPTOR`

getBackgroundColor

Added in API level 37

public int getBackgroundColor ()

Returns the background color of the button as a ERROR(ColorInt/android.annotation.ColorInt ColorInt).

Returns
`int`

getConfiguration

Added in API level 37

public Configuration getConfiguration ()

Returns the configuration of the button.

Returns
`Configuration`	This value cannot be `null`.

getCornerRadius

Added in API level 37

public float getCornerRadius ()

Returns the corner radius of the button in pixels.

Returns
`float`

getHeight

Added in API level 37

public int getHeight ()

Returns the height of the button.

Returns
`int`

getIconTint

Added in API level 37

public int getIconTint ()

Returns the icon tint color as a ERROR(ColorInt/android.annotation.ColorInt ColorInt).

Returns
`int`

getPaddingBottom

Added in API level 37

public int getPaddingBottom ()

Returns the bottom padding of the button.

Returns
`int`

getPaddingLeft

Added in API level 37

public int getPaddingLeft ()

Returns the left padding of the button.

Returns
`int`

getPaddingRight

Added in API level 37

public int getPaddingRight ()

Returns the right padding of the button.

Returns
`int`

getPaddingTop

Added in API level 37

public int getPaddingTop ()

Returns the top padding of the button.

Returns
`int`

getPressedCornerRadius

Added in API level 37

public float getPressedCornerRadius ()

Returns the corner radius of the button when pressed.

Returns
`float`

getStrokeColor

Added in API level 37

public int getStrokeColor ()

Returns the button outline/border color as a ERROR(ColorInt/android.annotation.ColorInt ColorInt).

Returns
`int`

getStrokeWidth

Added in API level 37

public int getStrokeWidth ()

Returns the button outline/border width.

Returns
`int`

getTextColor

Added in API level 37

public int getTextColor ()

Returns the color of the button's text as a ERROR(ColorInt/android.annotation.ColorInt ColorInt).

Returns
`int`

getTextType

Added in API level 37

public int getTextType ()

Returns the text type displayed on the button.

Returns
`int`	Value is one of the following: `LocationButtonSession.TEXT_TYPE_NONE` `LocationButtonSession.TEXT_TYPE_PRECISE_LOCATION` `LocationButtonSession.TEXT_TYPE_USE_PRECISE_LOCATION` `LocationButtonSession.TEXT_TYPE_SHARE_PRECISE_LOCATION` `LocationButtonSession.TEXT_TYPE_NEAR_MY_PRECISE_LOCATION` `LocationButtonSession.TEXT_TYPE_NEAR_YOUR_PRECISE_LOCATION`

getWidth

Added in API level 37

public int getWidth ()

Returns the width of the button.

Returns
`int`

toString

Added in API level 37

public String toString ()

Returns a string representation of the object.

Returns
`String`	a string representation of the object.

writeToParcel

Added in API level 37

public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
`dest`	`Parcel`: This value cannot be `null`.
`flags`	`int`: Additional flags about how the object should be written. May be 0 or `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of the following: `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`

LocationButtonRequest

Summary

Nested classes

Inherited constants

Fields

Public methods

Inherited methods

Fields

CREATOR

Public methods

describeContents

getBackgroundColor

getConfiguration

getCornerRadius

getHeight

getIconTint

getPaddingBottom

getPaddingLeft

getPaddingRight

getPaddingTop

getPressedCornerRadius

getStrokeColor

getStrokeWidth

getTextColor

getTextType

getWidth

toString

writeToParcel