IOnReceiveContentListener Interface

Definition

[Android.Runtime.Register("android/view/OnReceiveContentListener", "", "Android.Views.IOnReceiveContentListenerInvoker", ApiSince=31)]
public interface IOnReceiveContentListener : Android.Runtime.IJavaObject, IDisposable, Java.Interop.IJavaPeerable

[<Android.Runtime.Register("android/view/OnReceiveContentListener", "", "Android.Views.IOnReceiveContentListenerInvoker", ApiSince=31)>]
type IOnReceiveContentListener = interface
    interface IJavaObject
    interface IDisposable
    interface IJavaPeerable

Attributes

RegisterAttribute

Implements

IJavaObject IJavaPeerable IDisposable

Remarks

Listener for apps to implement handling for insertion of content. Content may be both text and non-text (plain/styled text, HTML, images, videos, audio files, etc).

This listener can be attached to different types of UI components using View#setOnReceiveContentListener.

Here is a sample implementation that handles content URIs and delegates the processing for text and everything else to the platform:<br>

// (1) Define the listener
            public class MyReceiver implements OnReceiveContentListener {
                public static final String[] MIME_TYPES = new String[] {"image/*", "video/*"};

                @Override
                public ContentInfo onReceiveContent(View view, ContentInfo payload) {
                    Pair<ContentInfo, ContentInfo> split =
                            ContentInfoCompat.partition(payload, item -> item.getUri() != null);
                    ContentInfo uriContent = split.first;
                    ContentInfo remaining = split.second;
                    if (uriContent != null) {
                        ClipData clip = uriContent.getClip();
                        for (int i = 0; i < clip.getItemCount(); i++) {
                            Uri uri = clip.getItemAt(i).getUri();
                            // ... app-specific logic to handle the URI ...
                        }
                    }
                    // Return anything that we didn't handle ourselves. This preserves the default platform
                    // behavior for text and anything else for which we are not implementing custom handling.
                    return remaining;
                }
            }

            // (2) Register the listener
            public class MyActivity extends Activity {
                &#64;Override
                public void onCreate(Bundle savedInstanceState) {
                    // ...

                    EditText myInput = findViewById(R.id.my_input);
                    myInput.setOnReceiveContentListener(MyReceiver.MIME_TYPES, new MyReceiver());
                }

Java documentation for android.view.OnReceiveContentListener.

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

Methods

Extension Methods

Applies to