简介

端JSSDK的使用

为了方便开发者使用调用原生API,我们提供了light-sdk模块,具体的使用方法如下:

  1. 在源代码目录的lib目录执行:npm install -d --save light-sdk
  2. 在需要使用light-sdk的js或者vue文件中使用如下代码:import LightSDK from "light-sdk"
  3. 具体的使用指令及API文档参考这里

注:如果不是light工程的项目,引用方式为:import lightSDK from "light-sdk/dist/index.umd.js"

注意事项

light-sdk接口在最新版本lighting-plugin-type-vue@1.0.33环境下使用可支持在.js文件中调用,升级light-sdk时建议同时升级最新版本lighting-plugin-type-vue@1.0.33

native接口调用

调用方式1

LightSDK.native.method(params, cb)

调用方式2

LightSDK.native.method(params).then(cb)

native:端调用模块名称。此处无需做改变

method:方法名。可按照调用不同方法进行替换方法名

params:方法传参。可按照调用不同方法进行替换参数

cb:回调函数。需要开发者自行编写方法回调逻辑

注:第2种调用方式接口返回的是一个promise对象,2种调用方式开发者可按需使用。

返回结果

成功返回:

{
"info": {
"error_code": "0",
"error_message": "success"
} , data:{ xxxx }
}

info:调用成功标识。此字段在方法调用成功时会返回如下的成功标识:

{
"error_code": "0",
"error_message": "success"
}

data:调用数据。此字段在方法中须返回数据时才会显示,具体内容可参考每个方法返回值介绍。

config获取组件的参数配置信息接口调用

调用方式(不支持jsn)

LightSDK.config.get (cb)

 params ={
disableCache:true //若传此入参disableCache:true,将关闭缓存功能,即每次请求接口都会执行,获取最新的参数配置信息,若不传默认开启缓存功能,即每次请求只获取第一次的参数配置信息
}
LightSDK.config.get(function(data){
console.log(data) //data为返回的组件的参数配置信息
},params);

需要在项目根目录下的project.json文件中配置组件id,例:

link_id:"8112734868607666"

返回结果

成功返回:

{
"err_no":0,
"data":{
"node_prefix":"https://fs-api.lightyy.com/"
}
}

返回的数据node_prefix和https://fs-api.lightyy.com/ 分别对应平台中参数配置的配置代码和默认值