interface.uts

import { ComponentPublicInstance } from 'vue';

export type CreateWebviewContext = (webviewId : string.WebviewIdString, component ?: ComponentPublicInstance | null) => WebviewContext | null;

export interface WebviewContext {
	/**
	 * @description 后退到 web-view 组件网页加载历史的上一页，如果不存在上一页则没有任何效果。
	 * @uniPlatform {
	 *  "app": {
	 *    "android": {
	 *      "osVer": "5.0",
	 *      "uniVer": "x",
	 *      "unixVer": "3.9.0"
	 *    }
	 *  }
	 * }
	 * @uniVueVersion 2,3
	 */
	back() : void

	/**
	 * @description 前进到 web-view 组件网页加载历史的下一页，如果不存在下一页则没有任何效果。
	 * @uniPlatform {
	 *  "app": {
	 *    "android": {
	 *      "osVer": "5.0",
	 *      "uniVer": "x",
	 *      "unixVer": "3.9.0"
	 *    }
	 *  }
	 * }
	 * @uniVueVersion 2,3
	 */
	forward() : void

	/**
	 * @description 重新加载 web-view 组件当前页面。
	 * @uniPlatform {
	 *  "app": {
	 *    "android": {
	 *      "osVer": "5.0",
	 *      "uniVer": "x",
	 *      "unixVer": "3.9.0"
	 *    }
	 *  }
	 * }
	 * @uniVueVersion 2,3
	 */
	reload() : void

	/**
	 * @description 停止加载 web-view 组件当前网页，该方法不能阻止已经加载的 html 文档，但是能够阻止未完成的图片及延迟加载的资源。
	 * @uniPlatform {
	 *  "app": {
	 *    "android": {
	 *      "osVer": "5.0",
	 *      "uniVer": "x",
	 *      "unixVer": "3.9.0"
	 *    }
	 *  }
	 * }
	 * @uniVueVersion 2,3
	 */
	stop() : void

	/**
	 * @description 在网页中执行指定的js脚本，在 uvue 页面中可通过此方法向 web-view 组件加载的页面发送数据
	 * @uniPlatform {
	 *  "app": {
	 *    "android": {
	 *      "osVer": "5.0",
	 *      "uniVer": "x",
	 *      "unixVer": "3.9.0"
	 *    }
	 *  }
	 * }
	 * @uniVueVersion 2,3
	 */
	evalJS(js : string) : void
}

export interface Uni {
	/**
	 * @description 创建 web-view 组件的上下文对象，用于操作 web-view 的行为。
	 * @uniPlatform {
	 *  "app": {
	 *    "android": {
	 *      "osVer": "5.0",
	 *      "uniVer": "x",
	 *      "unixVer": "3.9.0"
	 *    }
	 *  },
     *  "web": {
     *    "uniVer": "x",
     *    "unixVer": "x"
     *  }
	 * }
	 * @uniVueVersion 2,3
	 * @return {WebviewContext} web-view组件上下文对象
	 */
	createWebviewContext : CreateWebviewContext
}