IEmbeddedPhotoPickerProvider Interface

Definition

This interface provides an api that callers can use to get a session of embedded PhotoPicker (EmbeddedPhotoPickerSession).

[Android.Runtime.Register("android/widget/photopicker/EmbeddedPhotoPickerProvider", "", "Android.Widget.PhotoPicker.IEmbeddedPhotoPickerProviderInvoker", ApiSince=36)]
public interface IEmbeddedPhotoPickerProvider : Android.Runtime.IJavaObject, IDisposable, Java.Interop.IJavaPeerable
[<Android.Runtime.Register("android/widget/photopicker/EmbeddedPhotoPickerProvider", "", "Android.Widget.PhotoPicker.IEmbeddedPhotoPickerProviderInvoker", ApiSince=36)>]
type IEmbeddedPhotoPickerProvider = interface
    interface IJavaObject
    interface IDisposable
    interface IJavaPeerable
Attributes
Implements

Remarks

This interface provides an api that callers can use to get a session of embedded PhotoPicker (EmbeddedPhotoPickerSession).

Callers can get instance of this class using EmbeddedPhotoPickerProviderFactory#create(Context).

Under the hood, a service connection with photopicker is established by the implementation of this api. To help establish this connection, a caller must include in their Manifest:

{@code
<queries>
<intent>
<action android:name="com.android.photopicker.core.embedded.EmbeddedService.BIND"/>
</intent>
</queries>
            }

When a session opens successfully, they would receive an instance of EmbeddedPhotoPickerSession and android.view.SurfaceControlViewHost.SurfacePackage via the EmbeddedPhotoPickerClient#onSessionOpened api

Callers pass an instance of EmbeddedPhotoPickerClient which is used by service to notify about different events (like sessionError, uri granted/revoked etc) to them. One-to-one relationship of client to session must be maintained by a caller i.e. they shouldn't reuse same callback for more than one openSession requests.

The EmbeddedPhotoPickerSession instance can be used to notify photopicker about different events (like resize, configChange etc).

This api is supported on api versions Android U+.

Java documentation for android.widget.photopicker.EmbeddedPhotoPickerProvider.

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

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)
JniPeerMembers

Member access and invocation support.

(Inherited from IJavaPeerable)
PeerReference

Returns a JniObjectReference of the wrapped Java object instance.

(Inherited from IJavaPeerable)

Methods

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)
OpenSession(IBinder, Int32, Int32, Int32, EmbeddedPhotoPickerFeatureInfo, IExecutor, IEmbeddedPhotoPickerClient)

Open a new session for displaying content with an initial size of width x height pixels.

SetJniIdentityHashCode(Int32)

Set the value returned by JniIdentityHashCode.

(Inherited from IJavaPeerable)
SetJniManagedPeerState(JniManagedPeerStates) (Inherited from IJavaPeerable)
SetPeerReference(JniObjectReference)

Set the value returned by PeerReference.

(Inherited from IJavaPeerable)
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

JavaCast<TResult>(IJavaObject)

Performs an Android runtime-checked type conversion.

JavaCast<TResult>(IJavaObject)
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.

TryJavaCast<TResult>(IJavaPeerable, TResult)

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

Applies to