UIActivityViewController:complete 事件
complete 事件在分享面板结束时派发:用户选的动作做完了(或者失败了),或者用户没选就把面板关了。
语法
sheet.addEventListener('complete', (event) => { })事件对象
类型是 UIActivityViewControllerCompletionEvent。监听回调的参数类型是 Event,要读下面三个字段,先转一下类型,写法见示例。
| 字段 | 类型 | 含义 |
|---|---|---|
completed | boolean | true:用户选的动作做完了。false:没做,包括用户直接把面板关掉 |
activityType | string | null | 用户选的去处:系统动作的名字,或者第三方扩展自己的标识符(一个带点的字符串)。没选就关掉了是 null |
activityError | Error | null | 动作失败时的错误,message 是系统给的说明,另外带 code(数字)和 domain(字符串)。没有错误是 null |
type是'complete',target是这个面板。- 不能取消,
preventDefault()不起作用。
什么时候派发
- 面板结束时派发,一个面板只派发一次。派发时面板已经自己关掉了,App 不需要再关。
completed是true只表示那个动作执行完了,比如信息 App 的发送界面被用户点了发送。分享出去的东西到没到对方手里,App 不知道。- 用代码
dismissViewController()关掉面板时派不派发complete,未在模拟器验证。要在用代码关掉之后做的事,直接写在那一句后面,不依赖这个事件。 - 不需要知道结果就不用监听。面板不依赖监听器工作。
这个事件的派发时机和事件对象的内容,都未在模拟器验证。
示例
js
const sheet = new UIActivityViewController([new URL('https://example.com')]);
sheet.addEventListener('complete', (event) => {
const result = /** @type {UIActivityViewControllerCompletionEvent} */ (event);
if (result.activityError !== null) {
console.log('分享出错了:' + result.activityError.message);
} else if (result.completed) {
console.log('分享完成,去处是 ' + result.activityType);
}
});效果(未在模拟器验证)
- 用户完成分享时输出去处的名字,比如
分享完成,去处是 copyToPasteboard。 - 动作失败时输出错误信息。
- 用户直接关掉面板时什么都不输出。
对应的 iOS API
UIActivityViewController.completionWithItemsHandler。回调的四个参数里,activityType、completed、activityError 是事件对象的同名字段;returnedItems 还没有提供。