接收富媒体内容

<ph type="x-smartling-placeholder">

</ph> <ph type="x-smartling-placeholder">

图 1.统一的 API 提供了一个集中的位置来处理 而不管具体的界面机制如何， 和按住菜单或使用拖放操作。

用户喜欢图片、视频和其他富有表现力的内容， 在应用中转移此类内容并非易事。为了让应用能够更轻松地 Android 12（API 级别 31）引入了一个统一 API， 让您的应用接受来自任何来源（剪贴板、键盘或拖动）的内容。

您可以连接一个接口，如 OnReceiveContentListener、 ，并在通过任何 机制。此回调会成为您的代码处理接收所有内容（从纯文本和样式文本到标记、图片、视频、音频文件等）的唯一位置。

为了向后兼容以前的 Android 版本，此 API 也 （最低版本为 Core 1.7 和 Appcompat 1.4 建议您在实现此功能时使用此名称。

概览

对于其他现有的 API，每种界面机制（如触摸和按住菜单 或拖动）具有各自对应的 API。这意味着您必须单独与每个 API 集成，并为每种插入内容的机制添加类似的代码：

图 2. 以前，应用会为每个界面实现不同的 API 插入内容的机制。

OnReceiveContentListener API 会通过创建一个要实现的单一 API 来整合这些不同的代码路径，这样您就可以专注于应用特定的逻辑，而让平台处理其余的工作：

图 3. 统一的 API 可让您实现单个 支持所有界面机制的 API。

这种方法还意味着 无需对代码进行其他更改即可启用支持 。如果您的应用需要针对 但您仍然可以使用现有的 API，这些 API 继续有效 。

实现

注意 ：请参阅 拖放示例，了解关于 DropHelper，它会实现 OnReceiveContentListener。有关详情，请参阅 启用拖放功能。

该 API 是一个监听器接口，包含一种方法，即 OnReceiveContentListener。为了支持较低版本的 Android 平台，我们建议您使用 AndroidX Core 库中的匹配 OnReceiveContentListener 接口。

要使用该 API，请实现监听器，具体方法是指定 应用可以处理：

Kotlin

object MyReceiver : OnReceiveContentListener {
    val MIME_TYPES = arrayOf("image/*", "video/*")
    
    // ...
    
    override fun onReceiveContent(view: View, payload: ContentInfoCompat): ContentInfoCompat? {
        TODO("Not yet implemented")
    }
}

Java

public class MyReceiver implements OnReceiveContentListener {
     public static final String[] MIME_TYPES = new String[] {"image/*", "video/*"};
     // ...
}

指定您的应用支持的所有内容 MIME 类型后，实现该监听器的其余部分：

Kotlin

class MyReceiver : OnReceiveContentListener {
    override fun onReceiveContent(view: View, contentInfo: ContentInfoCompat): ContentInfoCompat {
        val split = contentInfo.partition { item: ClipData.Item -> item.uri != null }
        val uriContent = split.first
        val remaining = split.second
        if (uriContent != null) {
            // App-specific logic to handle the URI(s) in uriContent.
        }
        // Return anything that your app didn't handle. This preserves the
        // default platform behavior for text and anything else that you aren't
        // implementing custom handling for.
        return remaining
    }

    companion object {
        val MIME_TYPES = arrayOf("image/*", "video/*")
    }
}

Java

 public class MyReceiver implements OnReceiveContentListener {
     public static final String[] MIME_TYPES = new String[] {"image/*", "video/*"};

     @Override
     public ContentInfoCompat onReceiveContent(View view, ContentInfoCompat contentInfo) {
         Pair<ContentInfoCompat, ContentInfoCompat> split = contentInfo.partition(
                 item -> item.getUri() != null);
         ContentInfo uriContent = split.first;
         ContentInfo remaining = split.second;
         if (uriContent != null) {
             // App-specific logic to handle the URI(s) in uriContent.
         }
         // Return anything that your app didn't handle. This preserves the
         // default platform behavior for text and anything else that you aren't
         // implementing custom handling for.
         return remaining;
     }
 }

如果您的应用已经支持使用 intent 进行共享，您可以重复使用 特定于应用的逻辑，用于处理内容 URI。将任何剩余数据返回以委派给平台进行处理。

实现监听器后，在应用的相应界面元素上设置该监听器：

Kotlin

class MyActivity : Activity() {
    public override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        // ...
        val myInput = findViewById(R.id.my_input)
        ViewCompat.setOnReceiveContentListener(myInput, MyReceiver.MIME_TYPES, MyReceiver())
    }
}

Java

public class MyActivity extends Activity {
     @Override
     public void onCreate(Bundle savedInstanceState) {
         // ...

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

URI 权限

读取权限由平台自动授予和释放 内容 URI 传递给 OnReceiveContentListener 的载荷。

通常，您的应用会在服务或 activity 中处理内容 URI。对于 长时间运行的处理，使用 WorkManager。当您实现 此方法可将权限扩展到目标服务或 Activity，方法是传递 使用 Intent.setClipData 以及设置该标志 FLAG_GRANT_READ_URI_PERMISSION。

或者，您也可以在当前上下文中使用后台线程来处理内容。在这种情况下，您必须保留对 payload 对象，以帮助确保权限 被平台提早撤消。

自定义 View

如果您的应用使用自定义 View 子类，请务必确保 未绕过 OnReceiveContentListener。

如果 View 类会替换 onCreateInputConnection 方法，请使用 Jetpack API InputConnectionCompat.createWrapper 配置 InputConnection。

如果您的 View 类替换了 onTextContextMenuItem 方法时，委托给 super 方法，当菜单项是 R.id.paste 或 R.id.pasteAsPlainText。

与键盘图片 API 相比

您可以将 OnReceiveContentListener API 视为现有键盘图片 API 的下一个版本。此统一 API 支持键盘图片 API 的功能，以及一些其他功能。设备和功能兼容性因您使用 Jetpack 库还是 Android SDK 中的原生 API 而异。

表 1. 支持的功能和 API 级别 Jetpack。

操作或功能	受键盘图片 API 支持	受统一 API 支持
通过键盘插入	是（API 级别 13 及更高）	是（API 级别 13 及更高）
通过触摸粘贴操作插入 &按住菜单	否	是
使用拖放功能插入	否	是（API 级别 24 及更高）

表 2. 原生广告支持的功能和 API 级别 API。

操作或功能	受键盘图片 API 支持	受统一 API 支持
通过键盘插入	是（API 级别 25 及更高）	是（Android 12 及更高版本）
通过触摸粘贴操作插入 &按住菜单	否
通过拖放操作插入	否