Language

ILocationButtonSession Interface

Definition

This interface defines location button session, and allows apps to change/customize the appearance of the button.

[Android.Runtime.Register("android/app/permissionui/LocationButtonSession", "", "Android.App.PermissionUI.ILocationButtonSessionInvoker", ApiSince=37)]
public interface ILocationButtonSession : Android.Runtime.IJavaObject, IDisposable, Java.Interop.IJavaPeerable
[<Android.Runtime.Register("android/app/permissionui/LocationButtonSession", "", "Android.App.PermissionUI.ILocationButtonSessionInvoker", ApiSince=37)>]
type ILocationButtonSession = interface
    interface IJavaObject
    interface IDisposable
    interface IJavaPeerable
Attributes
Implements

Remarks

This interface defines location button session, and allows apps to change/customize the appearance of the button.

A location button's UI is rendered by a trusted system process to ensure its integrity and prevent tap jacking. An instance of this interface is returned via LocationButtonClient.onSessionOpened after a session is requested through LocationButtonProvider.openSession.

Once a session is opened, the client can get the button's UI by calling getSurfacePackage() and embedding it in its view hierarchy. The client is responsible for notifying the session of any UI changes, such as size or configuration updates.

When the session is no longer needed, the client must call close() to release all associated system resources.

Android reference for android.app.permissionui.LocationButtonSession.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Properties

Name Description
Handle

Gets the JNI value of the underlying Android object.

(Inherited from IJavaObject)
JniIdentityHashCode

Returns the value of java.lang.System.identityHashCode() for the wrapped instance.

(Inherited from IJavaPeerable)
JniManagedPeerState

State of the managed peer.

(Inherited from IJavaPeerable)
JniObjectReferenceControlBlock (Inherited from IJavaPeerable)
JniPeerMembers

Member access and invocation support.

(Inherited from IJavaPeerable)
PeerReference

Returns a JniObjectReference of the wrapped Java object instance.

(Inherited from IJavaPeerable)
SurfacePackage

Returns the SurfaceControlViewHost.SurfacePackage containing the view for the location button.

Methods

Name Description
ChangeConfiguration(Configuration)

Notifies the remote service of a configuration change.

Close()

Closes the session and releases all associated resources.

Disposed()

Called when the instance has been disposed.

(Inherited from IJavaPeerable)
DisposeUnlessReferenced()

If there are no outstanding references to this instance, then calls Dispose(); otherwise, does nothing.

(Inherited from IJavaPeerable)
Finalized()

Called when the instance has been finalized.

(Inherited from IJavaPeerable)
Resize(Int32, Int32)

Notifies the remote service that the button's container view has been resized.

SetBackgroundColor(Color)

Sets the background color of the location button.

SetCornerRadius(Single)

Sets the corner radius for the location button.

SetIconTint(Color)

Sets the tint color of the icon within the location button.

SetJniIdentityHashCode(Int32)

Set the value returned by JniIdentityHashCode.

(Inherited from IJavaPeerable)
SetJniManagedPeerState(JniManagedPeerStates) (Inherited from IJavaPeerable)
SetPadding(Int32, Int32, Int32, Int32)

Sets the padding for the location button within its container.

SetPeerReference(JniObjectReference)

Set the value returned by PeerReference.

(Inherited from IJavaPeerable)
SetPressedCornerRadius(Single)

Sets the corner radius for the location button pressed state.

SetStrokeColor(Color)

Sets the color of location button stroke/outline.

SetStrokeWidth(Int32)

Sets the width of location button stroke/outline.

SetTextColor(Color)

Sets the color of location button text.

SetTextType(Int32)

Sets the text to be displayed on the button.

UnregisterFromRuntime()

Unregister this instance so that the runtime will not return it from future Java.Interop.JniRuntime+JniValueManager.PeekValue invocations.

(Inherited from IJavaPeerable)

Extension Methods

Name Description
GetJniTypeName(IJavaPeerable)

Gets the JNI name of the type of the instance self.

JavaAs<TResult>(IJavaPeerable)

Try to coerce self to type TResult, checking that the coercion is valid on the Java side.

JavaCast<TResult>(IJavaObject)

Performs an Android runtime-checked type conversion.

JavaCast<TResult>(IJavaObject)
TryJavaCast<TResult>(IJavaPeerable, TResult)

Try to coerce self to type TResult, checking that the coercion is valid on the Java side.

Applies to