Skip to content

插件模块

数据结构

ESPluginInfo

请求权限结果

参数描述类型非空
pkg插件的包名string

接口

installPlugin

该方法安装插件。

完整方法声明:function installPlugin(plugin: ESPluginInfo): void

  • 参数:
参数描述类型非空
plugin插件信息ESPluginInfo
  • 返回值:
属性描述类型默认值
void

addListener

该方法添加安装插件监听。

完整方法声明:function addListener(plugin: ESPluginInfo, listener: ESPluginListener): void

  • 参数:
参数描述类型非空
plugin插件信息ESPluginInfo
listener插件安装监听ESPluginListener
  • 返回值:
属性描述类型默认值
void

removeListener

该方法删除安装插件监听。

完整方法声明:function removeListener(listener: ESPluginListener): void

  • 参数:
参数描述类型非空
listener插件安装监听ESPluginListener
  • 返回值:
属性描述类型默认值
void

基础用法

  • 代码示例:
    点击查看源码
    vue
    <template>
    	<div class='es-sdk-root-css'>
    		<s-title-view class='es-sdk-content-title-css' :text='this.$options.name' />
    		<div class='es-sdk-content-divider-css' />
    		<div class='es-sdk-content-column-css'>
    			<s-text-view :text="'安装状态:' + installStatus"></s-text-view>
    			<s-text-button text='安装广告插件' @onButtonClicked='onButtonClicked' />
    		</div>
    	</div>
    </template>
    
    <script lang='ts'>
    
    import {defineComponent} from '@vue/runtime-core';
    import {ESPluginInfo, ESPluginListener, useESPlugin} from '@extscreen/es3-core';
    import {ref} from 'vue';
    
    export default defineComponent({
    	name: '插件',
    	setup() {
    
    		const installStatus = ref('');
    
    		const plugin = useESPlugin();
    		const pluginInfo: ESPluginInfo = {
    			pkg: 'eskit.plugin.ad.huan',
    		};
    
    		const listener: ESPluginListener = {
    
    			onPluginInstallSuccess(pkg: string, status: number, msg: string) {
    				installStatus.value = 'onPluginInstallSuccess '
    					+ '   pkg:' + pkg
    					+ '   status:' + status
    					+ '   msg:' + msg;
    			},
    			onPluginInstallProgress(pkg: string, status: number, current: number, total: number) {
    				installStatus.value = 'onESPluginInstallProgress '
    					+ '   pkg:' + pkg
    					+ '   status:' + status
    					+ '  current:' + current
    					+ '  total:' + total;
    			},
    			onPluginInstallError(pkg: string, status: number, msg: string) {
    				installStatus.value = 'onPluginInstallError '
    					+ '   pkg:' + pkg
    					+ '   status:' + status;
    			},
    		};
    
    		function onESCreate(params) {
    			plugin.addListener(pluginInfo, listener);
    		}
    
    		function onESDestroy() {
    			plugin.removeListener(listener);
    		}
    
    		function onButtonClicked() {
    			plugin.installPlugin(pluginInfo);
    		}
    
    		return {
    			installStatus,
    			onButtonClicked,
    			onESCreate,
    			onESDestroy,
    		};
    	},
    });
    
    </script>
    <style>
    </style>