baseTools

概述

插件使用攻略

此插件是专门对Android插件常用功能的封装，不断更新中，该功能尽量不引用其他aar、jar等包或者库，若使用会告知，以避免插件之间冲突

插件接口

locationServices

打开手机定位服务页面（用户手动打开定位服务）

locationServices(callback(ret, err))

callback(ret, err)

##ret：

类型：JSON 对象
内部字段：NA

示例代码

function locationServices(){
    var fileBrowser = api.require('baseTools');
    fileBrowser.locationServices();
}

可用性

Android系统

可提供的1.0.0及更高版本

openSetting

打开系统设置

params

setType：

类型：字符串
描述：要打开的系统位置
枚举：（blueTooth）蓝牙、（setting）系统设置、（auxiliary）辅助功能、（net）移动网络、（apn）apn、（application）应用程序管理、（roaming）移动数据、（date）日期设置、（deviceInfo）关于手机、（display）手机显示、（input）输入法、（language）语言设置、（nfc）NFC设置、（location）定位服务、（security）安全设置、（sound）声音设置、（userDictionary）用户字典、（ip）IP设定、（wifi）wifi设置、（power）电池信息

callback(ret, err)

##ret：

类型：JSON 对象
内部字段：NA

示例代码

    function openSetting(){
        var fileBrowser = api.require('baseTools');
        fileBrowser.openSetting({
           setType: 'setting'
        });
    }

可用性

Android系统

openPhoto

打开相册

params

callback(ret, err)

##ret：

类型：JSON 对象
内部字段：

{ photo_path: 图片路径 //字符串类型 }

示例代码

function openPhoto(){
    var fileBrowser = api.require('baseTools');
    fileBrowser.openPhoto({
    },function(ret) {
    if (ret) {
            alert(JSON.stringify(ret));
        }
    });
}

可用性

Android系统

可提供的1.0.0及更高版本

openFile

打开文件

params

callback(ret, err)

##ret：

类型：JSON 对象
内部字段：

{

url: 文件路径 //字符串类型 name: 文件名称 //字符串类型 date: 文件创建日期 //长整形（时间戳） size: 文件大小 //长整形（B字节） }

示例代码

function openFile(){
    var fileBrowser = api.require('baseTools');
    fileBrowser.openFile({
    },function(ret) {
    if (ret) {
            alert(JSON.stringify(ret));
        }
    });
}

可用性

Android系统

可提供的1.0.0及更高版本

openWeb

使用外部浏览器打开url

params

url：

类型：字符串
描述：需要打开的url链接

callback(ret, err)

##ret：

类型：JSON 对象
内部字段：NA

示例代码

function openWeb(){
    var fileBrowser = api.require('baseTools');
    fileBrowser.openWeb({
       url: 'https://www.baidu.com'
    });
}

可用性

Android系统

可提供的1.0.0及更高版本

videoDuration

获取本地视频文件时长

params

videoPath：

类型：字符串
描述：本地视频文件地址(要提前获取本地文件访问权限)

callback(ret, err)

##ret：

类型：JSON 对象
内部字段：

{ duration: 300 //整数类型；单位ms }

示例代码

function videoDuration(){
    var fileBrowser = api.require('baseTools');
    fileBrowser.videoDuration({
        videoPath: '/storage/emulated/0/Pictures/Screenshots/SVID_20220419_090200_1.mp4'
    },function(ret) {
        if (ret) {
            alert(JSON.stringify(ret));
        }
    });
}

可用性

Android系统

可提供的1.0.0及更高版本

openTelPhone

拨打电话

params

phoneNumber：

类型：字符串
描述：需要拨打的电话号码

callback(ret, err)

##ret：

类型：JSON 对象
内部字段：NA

示例代码

function openTelPhone(){
    var fileBrowser = api.require('baseTools');
    fileBrowser.openTelPhone({
       phoneNumber: '13111112222'
    });
}

可用性

Android系统

可提供的1.0.0及更高版本

openPkg

打开某一个应用

params

pkgName：

类型：字符串
描述：需要打开的应用包名

callback(ret, err)

##ret：

类型：JSON 对象
内部字段：NA

示例代码

function openPkg(){
    var fileBrowser = api.require('baseTools');
    fileBrowser.openPkg({
       pkgName: 'com.tencent.mm'
    });
}

可用性

Android系统

可提供的1.0.0及更高版本

openAllPkg

遍历所有应用(应用多会消耗较长时间，可以先增加一个loading)

params

callback(ret, err)

##ret：

类型：JSON 对象
内部字段：NA { customInfo: 应用信息 //字符串类型 pkgInfo: 应用信息 //字符串类型 }

示例代码

function openAllPkg(){
    var fileBrowser = api.require('baseTools');
    fileBrowser.openAllPkg({
    },function(ret) {
    if (ret) {
            alert(JSON.stringify(ret));
        }
    });
}

可用性

Android系统

可提供的1.0.0及更高版本

分享到QQ、WX、WB（无sdk分享，后续更新分享URL）

params

shareType：

类型：字符串
描述：需要分享的应用 qq:QQ wx:微信 wb:微博

shareExtra：

类型：字符串
描述：需要分享的文本

callback(ret, err)

##ret：

类型：JSON 对象
内部字段：NA

示例代码

function share(){
    var fileBrowser = api.require('baseTools');
    fileBrowser.share({
       shareType: 'qq',
       shareExtra: '这个是分享的内容',
    });
}

可用性

Android系统

可提供的1.0.0及更高版本

openQQ

打开QQ指定好友（非好友）、QQ群

params

number：

类型：字符串
描述：qq好友（非好友）、群id

isGroup：

类型：Boolean类型
描述：是否是打开群 true:number群id

callback(ret, err)

ret：

类型：JSON 对象
内部字段：NA

示例代码

function openQQ(){
    var fileBrowser = api.require('baseTools');
    fileBrowser.openQQ({
       number: '1217224361',
       isGroup: false,
    });
}

可用性

Android系统

可提供的1.0.0及更高版本

openWX

打开微信首页

params

callback(ret, err)

##ret：

类型：JSON 对象
内部字段：NA

示例代码

function openWX(){
    var fileBrowser = api.require('baseTools');
    fileBrowser.openWX({

    });
}

可用性

Android系统

可提供的1.0.0及更高版本

sensor

摇一摇

params

winName：

类型：字符串
描述：api.winName

frameName：

类型：字符串
描述：api.frameName

initScript：

类型：字符串
描述：方法名称

duration：

类型：整形
描述：摇一摇的间隔时间

callback(ret, err)

##ret：

类型：JSON 对象
内部字段：

回调initScript定义的方法

示例代码

function sensor(){
    var fileBrowser = api.require('baseTools');
    fileBrowser.sensor({
       winName: api.winName,
       frameName: api.frameName,
       initScript: 'initScriptInfo();',
       duration: 3000,
    },function(ret) {
    if (ret) {
            alert(JSON.stringify(ret));
        }
    });
}

function initScriptInfo() {
    alert("1");
}

可用性

Android系统

可提供的1.0.0及更高版本

cancelSensor

取消摇一摇功能

params

callback(ret, err)

##ret：

类型：JSON 对象
内部字段：NA

示例代码

 function cancelSensor(){
    var fileBrowser = api.require('baseTools');
    fileBrowser.cancelSensor({

    });
}

可用性

Android系统

可提供的1.0.0及更高版本

scan

扫一扫

params

openAlbum：

类型：Boolean类型
描述：是否显示打开相册

openFlashLamp：

类型：字符串
描述：是否打开闪光灯

callback(ret, err)

##ret：

类型：JSON 对象
内部字段：

scanResult：

类型：字符串
描述：扫描到的结果

示例代码

function scan(){
    var fileBrowser = api.require('baseTools');
    fileBrowser.scan({
       openAlbum: true,
       openFlashLamp: true,
    },function(ret) {
    if (ret) {
            alert(JSON.stringify(ret));
        }
    });
}

可用性

Android系统

可提供的1.0.0及更高版本

createTurntableLottery

创建转盘

params

x：

类型：整形
描述：x坐标

y：

类型：整形
描述：y坐标

w：

类型：整形
描述：宽度

h：

类型：整形
描述：高度

minTimes：

类型：整形
描述：旋转次数

textColor：

类型：字符串
描述：文字颜色

textSize：

类型：整形
描述：文字大小

imgRes：

类型：字符串
描述：中间指针图片

typeNum：

类型：整形
描述：圆形分区个数（该数量需要和下面扇区颜色（colors）、内容（des）、奖品图片（icons）个数一样）

colors：

类型：字符串
描述：扇区颜色组'#fbc6a9,#fef9f7,#fbc6a9,#ffdecc,#fbc6a9,#ffdecc,#fbc6a9'

des：

类型：字符串
描述：奖品内容描述

icons：

类型：字符串
描述：奖品图片

callback(ret, err)

##ret：

类型：JSON 对象
内部字段：后续增加回调内容

示例代码

function createTurntableLottery(){
    var fileBrowser = api.require('baseTools');
    fileBrowser.createTurntableLottery({
        x:0,
        y:0,
        w:400,
        h:400,
        minTimes:6,
        typeNum:7,
        textColor:'#FF0000',
        textSize:50,
        imgRes:'widget://image/base_node.png',
        colors:'#fbc6a9,#fef9f7,#fbc6a9,#ffdecc,#fbc6a9,#ffdecc,#fbc6a9',
        des:'特等奖,谢谢参与,五等奖,四等奖,三等奖,二等奖,一等奖',
        icons:'widget://image/base_iphone.png,widget://image/base_meizu.png,widget://image/base_iphone.png,widget://image/base_meizu.png,widget://image/base_iphone.png,widget://image/base_meizu.png,widget://image/base_iphone.png',
    },function(ret) {
    if (ret) {
            alert(JSON.stringify(ret));
        }
    });
}

可用性

Android系统

可提供的1.0.0及更高版本

startTurntableLottery

开始转盘抽奖

params

title：

类型：字符串
描述：开始前弹框提示（若填空，则不会弹框）

position：

类型：整形
描述：奖品编号（请按照创建转盘的内存设置奖品）

callback(ret, err)

##ret：

类型：JSON 对象
内部字段： des：
类型：字符串
描述：奖品内容描述

position：

类型：字符串
描述：奖品编号

示例代码

 function startTurntableLottery(){
     var fileBrowser = api.require('baseTools');
     fileBrowser.startTurntableLottery({
        title:'确定要花费100积分抽奖？',
        position:1,
     },function(ret) {
     if (ret) {
             alert(JSON.stringify(ret));
         }
     });
 }

可用性

Android系统

可提供的1.0.0及更高版本

moveTurntableLottery

移除转盘抽奖

params

callback(ret, err)

##ret：

类型：JSON 对象
内部字段：NA

示例代码

function moveTurntableLottery(){
    var fileBrowser = api.require('baseTools');
    fileBrowser.moveTurntableLottery({
    });
}

可用性

Android系统

可提供的1.0.0及更高版本

# **scratch**

刮刮乐

params

x：

类型：整形
描述：x坐标

y：

类型：整形
描述：y坐标

w：

类型：整形
描述：宽度

h：

类型：整形
描述：高度

duration：

类型：整形
描述：刮开的范围（0~100）

positiveImg：

类型：字符串
描述：底层图片

negativeImg：

类型：字符串
描述：刮层图片

callback(ret, err)

##ret：

类型：JSON 对象
内部字段： duration：
类型：整形
描述：刮开的范围

示例代码

unction scratch(){
    var fileBrowser = api.require('baseTools');
    fileBrowser.scratch({
        x:0,
        y:300,
        w:400,
        h:240,
        duration: 70,
        positiveImg:'widget://image/base_guagua.jpeg',
        negativeImg:'widget://image/base_guagua2.jpeg',
},function(ret) {
    if (ret) {
            alert(JSON.stringify(ret));
        }
    });
}

可用性

Android系统

可提供的1.0.0及更高版本

moveScratch

移除刮刮乐

params

callback(ret, err)

##ret：

类型：JSON 对象
内部字段：NA

示例代码

function moveScratch(){
    var fileBrowser = api.require('baseTools');
    fileBrowser.moveScratch({
    });
}

可用性

Android系统

可提供的1.0.0及更高版本

longPressShortcut

长按快捷方式（通过长按桌面图标可以看到现象）

params

btns：

类型：数组

描述：需要显示的快捷数据

title：
- 类型：字符串
- 描述：名称

normalImg：
- 类型：字符串
- 描述：图片

intent：
- 类型：字符串
- 描述：需要打开的设置类型，同**openSetting**中setType

class：
- 类型：字符串
- 描述：需要打开的类,此功能和intent不能同时存在一个事件中，优先此事件

callback(ret, err)

##ret：

类型：JSON 对象
内部字段：NA

示例代码

function longPressShortcut(){
        var fileBrowser = api.require('baseTools');
        fileBrowser.longPressShortcut({
               btns : [{
                    title : '蓝牙设置',
                    normalImg : 'widget://image/chatBox_face1.png',
                    class : '',
                    intent : 'blueTooth',
                }, {
                    title : 'wifi设置',
                    normalImg : 'widget://image/chatBox_key1.png',
                    class : '',
                    intent : 'wifi',
                }, {
                    title : '系统设置',
                    normalImg : 'widget://image/chatBox_add1.png',
                    class : '',
                    intent : 'setting',
                }, {
                    title : '文件选择',
                    normalImg : 'widget://image/chatBox_album2.png',
                    class : 'com.gxy.baseTools.activity.FileChooseActivity',
                    intent : 'file',
                }],
        });
}

可用性

Android系统

可提供的1.0.0及更高版本

createQuick

桌面快捷方式

params

title：

类型：字符串
描述：桌面显示名称

normalImg：

类型：字符串
描述：桌面图标

pkgName：

类型：字符串
描述：需要打开的应用包名（和class对应，优先此事件）

class：

类型：字符串
描述：需要打开的类（和pkgName对应，如使用此功能pkgName需要置空）

id：

类型：字符串
描述：可以创建多个快捷方式，用id区分

callback(ret, err)

##ret：

类型：JSON 对象
内部字段：NA

示例代码

function createQuick(){
    var fileBrowser = api.require('baseTools');
    fileBrowser.createQuick({
         normalImg : 'widget://image/jzb_logo.png',
         pkgName: 'com.tencent.mm',
         class : 'com.gxy.baseTools.activity.FileChooseActivity',
         title : '微信快捷',
         id : 'jzb2',
    });
}

可用性

Android系统

可提供的1.0.0及更高版本

initFloatWindow

系统级悬浮窗

注：此功能使用到glide 4.3.1框架

params

floatStr：

类型：字符串
描述：悬浮窗显示的文字

showClose：

类型：Boolean
描述：是否显示关闭按钮

floatImg：

类型：字符串
描述：悬浮窗显示的图片（可以是http网络图片或本地widget图片）

imgWidth：

类型：整形
描述：图片宽度

imgHeight：

类型：整形
描述：图片高度

closeWidth：

类型：整形
描述：关闭按钮宽度

closeHeight：

类型：整形
描述：关闭按钮高度

winName：

类型：字符串
描述：api.winName

frameName：

类型：字符串
描述：api.frameName

initScript：

类型：字符串
描述：方法名称

callback(ret, err)

##ret：

类型：JSON 对象
内部字段：

回调initScript定义的方法

示例代码

function initFloatWindow(){
  var fileBrowser = api.require('baseTools');
  fileBrowser.initFloatWindow({
     floatStr:  "点击打开",
     showClose:  true,
     floatImg:  'https://gimg2.baidu.com/image_search/src=http%3A%2F%2Fdata.1freewallpapers.com%2Fdownload%2Fscarlett-johansson-face-image.jpg&refer=http%3A%2F%2Fdata.1freewallpapers.com&app=2002&size=f9999,10000&q=a80&n=0&g=0n&fmt=auto?sec=1660811823&t=90643ba8b8256ab4bae5e0576eb02007',
     imgWidth:  60,
     imgHeight:  60,
     closeWidth:  35,
     closeHeight:  35,
     winName: api.winName,
     frameName: api.frameName,
       initScript: 'initScriptInfo();',
  },function(ret) {
  if (ret) {
          alert(JSON.stringify(ret));
      }
  });
}

可用性

Android系统

可提供的1.0.0及更高版本

closeFloatWindow

关闭悬浮窗

params

callback(ret, err)

##ret：

类型：JSON 对象
内部字段：NA

示例代码

function closeFloatWindow(){
    var fileBrowser = api.require('baseTools');
    fileBrowser.closeFloatWindow({
    });
}

可用性

Android系统

可提供的1.0.0及更高版本

rotatePicture

图片动画

params

x：

类型：整形
描述：x坐标

y：

类型：整形
描述：y坐标

w：

类型：整形
描述：宽度

h：

类型：整形
描述：高度

positiveImg：

类型：字符串
描述：第一张图片

negativeImg：

类型：字符串

描述：第二张图片（用于图片旋转组合图片使用以下单个type）

  duration: 2000,
  rotateType: 'rotationY',
  animationType: 0,
  pictureNum: 2,
  oneValue: '0',
  twoValue: '3600',
  threeValue: '0',
  fourValue: '0',
  automatic: true,
  repeat: true,

type：

类型：数组

描述：动画类型（可以多个组合）

 duration：
 - 类型：整数
 - 描述：动画周期
 
 rotateType：
 - 类型：字符串
 - 描述：动画类型
 - 枚举：
       
       alpha(透明度)
       rotation(rotation中心旋转，rotationX、rotationY沿各个轴旋转)
       translation(translationX、translationY)移动
       scale(scaleX、scaleY)缩放
 
 animationType：
 - 类型：整数
 - 描述：动画的播放类型
 - 枚举：
       
       0(开始和结束的速率比较慢，中间加速)
       1(开始速率比较快，后面减速)
       2(开始速率比较慢，后面加速)
       3(速率是恒定的)           
 
 pictureNum：
 - 类型：整数
 - 描述：单个动画使用，且值为2的时候触发
 -
 oneValue：
 - 类型：float
 - 描述：属性值
 
 twoValue：
 - 类型：float
 - 描述：属性值
 
 threeValue：
 - 类型：float
 - 描述：属性值
 
 fourValue：
 - 类型：float
 - 描述：属性值
 
 repeat：
 - 类型：Boolean
 - 描述：是否重复播放动画

callback(ret, err)

##ret：

类型：JSON 对象
内部字段：NA

示例代码

function rotatePicture(){
        var fileBrowser = api.require('baseTools');
        fileBrowser.rotatePicture({
            positiveImg : 'widget://image/base_one.jpeg',
            negativeImg : 'widget://image/base_two.jpeg',
            x:100,
            y:0,
            w:200,
            h:400,
            type : [
                {
                    duration: 2000,
                    rotateType: 'alpha',
                    animationType: 2,
                    pictureNum: 1,
                    oneValue: '1.0',
                    twoValue: '0.1',
                    threeValue: '1.0',
                    fourValue: '0',
                    repeat: true,
                },
                {
                    duration: 2000,
                    rotateType: 'rotation',
                    animationType: 2,
                    pictureNum: 1,
                    oneValue: '0',
                    twoValue: '3600',
                    threeValue: '0',
                    fourValue: '0',
                    repeat: true,
                },
                {
                    duration: 2000,
                    rotateType: 'translationX',
                    animationType: 2,
                    pictureNum: 1,
                    oneValue: '0',
                    twoValue: '300',
                    threeValue: '-300',
                    fourValue: '0',
                    repeat: true,
                },
                {
                    duration: 2000,
                    rotateType: 'scaleX',
                    animationType: 2,
                    pictureNum: 1,
                    oneValue: '1',
                    twoValue: '0.2',
                    threeValue: '1',
                    fourValue: '0',
                    repeat: true,
                },
                {
                    duration: 2000,
                    rotateType: 'scaleY',
                    animationType: 2,
                    pictureNum: 1,
                    oneValue: '1',
                    twoValue: '0.2',
                    threeValue: '1',
                    fourValue: '0',
                    repeat: true,
                }
                ],

        });
}

可用性

Android系统

可提供的1.0.0及更高版本

removePicture

移除旋转图片

params

callback(ret, err)

##ret：

类型：JSON 对象
内部字段：NA

示例代码

function removePicture(){
    var fileBrowser = api.require('baseTools');
    fileBrowser.removePicture({
    });
}

可用性

Android系统

可提供的1.0.0及更高版本

setCalendar

设置日历事件

(可以使用此功能将订阅的会议等当前应用功能显示在系统日历上面，并且在设置的时间弹出提醒)

params

title：

类型：字符串
描述：日历事件的标题

description：

类型：字符串
描述：日历事件的内容

userid：

类型：字符串
描述：用户id

startTime：

类型：整形
描述：日历事件的事件（时间戳）

previousMinutes：

类型：整形
描述：提醒时间（单位分钟）

location：

类型：字符串
描述：日历事件地址（部分类型手机可能不支持地图跳转）

callback(ret, err)

##ret：

类型：JSON 对象
内部字段：

isCalendar：

类型：Boolean
描述：是否订阅日历事件成功

示例代码

function setCalendar(){
        var fileBrowser = api.require('baseTools');
        fileBrowser.setCalendar({
           title:  '[烟花]#7月研发代码规范培训#[烟花]',
           description:  '培训主题：LCS编程方法（https://jizhibao.yuque.com/jizhibao/manual/hhdvvy ）\n培训讲师：刘武 \n培训对象：所有后端开发，包括.net\n培训时间：2022年7月14日18：00\n培训地址：演播厅请大家提前5分钟安排好工作进入会议室，积极参与，认真学习。利用他人经验避坑，努力提升代码质量。\n2022，说一不二！！！ ',
           userid:  'gxy',
           startTime:  1657976807106,
           duration:  3600000,
           previousMinutes:  30,
           location:  '长沙市天心区鑫远国际大厦西单元301室',
        },function(ret) {
        if (ret) {
                alert(JSON.stringify(ret));
            }
        });
}

可用性

Android系统

可提供的1.0.0及更高版本

deleteCalendar

删除日历事件

params

userid：

类型：字符串
描述：用户id

callback(ret, err)

##ret：

类型：JSON 对象
内部字段：
deleteCalendar：
类型：Boolean
描述：是否删除订阅日历事件成功

示例代码

function deleteCalendar(){
   var fileBrowser = api.require('baseTools');
   fileBrowser.deleteCalendar({
      userid:  'gxy',
   },function(ret) {
   if (ret) {
           alert(JSON.stringify(ret));
       }
   });
}

可用性

Android系统

可提供的1.0.0及更高版本

vibrate

手机震动

params

milliseconds：

类型：整数
描述：单个震动时长

pattern：

类型：字符串
描述：组合震动的每个震动时长

isRepeat：

类型：Boolean
描述：是否重复震动

isLongVibrate：

类型：Boolean
描述：是否多个震动组合

callback(ret, err)

##ret：

类型：JSON 对象
内部字段：

示例代码

function vibrate(){
    var fileBrowser = api.require('baseTools');
    fileBrowser.vibrate({
       milliseconds:  500,
       pattern:  '500,1000,500,1000',
       isRepeat:  true,
       isLongVibrate:  true,
    });
}

可用性

Android系统

可提供的1.0.0及更高版本

cancelVibrate

取消震动事件

params

callback(ret, err)

##ret：

类型：JSON 对象
内部字段：NA

示例代码

function cancelVibrate(){
    var fileBrowser = api.require('baseTools');
    fileBrowser.cancelVibrate({
    });
}

可用性

Android系统

可提供的1.0.0及更高版本

backToDesktop

增加返回按钮直接返回桌面功能

此功能需要在apiready设置，点击返回按钮不会弹出退出确认框，直接返回桌面，保持应用常驻

params

callback(ret, err)

##ret：

类型：JSON 对象
内部字段：NA

示例代码

function backToDesktop(){
  api.addEventListener({ name: 'keyback' }, function (ret, err) {
           var obj = api.require('baseTools');
           obj.backToDesktop({
  }, function(ret, err) {
              alert(JSON.stringify(ret));
     });
  });
}

可用性

Android系统

可提供的1.0.0及更高版本

setScreenBrightness

设置屏幕亮度（当前应用）

params

number：

类型：整数
描述：亮度（0~100）

callback(ret, err)

##ret：

类型：JSON 对象
内部字段：NA

示例代码

function setScreenBrightness(){
    var fileBrowser = api.require('baseTools');
    fileBrowser.setScreenBrightness({
       number:  50,
    });
}

可用性

Android系统

可提供的1.0.0及更高版本

是否仍需要帮助？请保持联络！

最后更新于 2024/04/24