FastNative文档
Options
All
  • Public
  • Public/Protected
  • All
Menu

创息公司封装的常用本地原生APP功能

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Methods

Static aliPay

  • aliPay(orderPrefix: string, orderTitle: string, orderMoney: number, orderData: string, callBack?: (success: boolean, message: string, data: any) => void): Promise<{ data: string; message: string; success: boolean }>

  • 发起支付宝支付

    Parameters

    • orderPrefix: string

      订单前缀，例如：PY

    • orderTitle: string

      订单标题

    • orderMoney: number

      订单金额

    • orderData: string

      订单携带的额外数据

    • Optional callBack: (success: boolean, message: string, data: any) => void

      支付完成回调，

        • (success: boolean, message: string, data: any): void

        • Parameters

          • success: boolean
          • message: string
          • data: any

          Returns void

    Returns Promise<{ data: string; message: string; success: boolean }>

Static appCallBack

  • appCallBack(key: string, result: string): void

  • 手机原生方法回执时调用

    Parameters

    • key: string

      回调函数的唯一标识

    • result: string

      回调结果

    Returns void

Static chat

  • chat(code: string, type: number, callBack?: (success: boolean, message: string, data: string) => void): Promise<{ data: string; message: string; success: boolean }>

  • 发起会话聊天

    Parameters

    • code: string

      会话编号

    • type: number

      聊天类型 0 单聊 1 群聊

    • Optional callBack: (success: boolean, message: string, data: string) => void

      获取成功后的回调函数，函数结构：function(success:boolean,message:string,data:string){}

        • (success: boolean, message: string, data: string): void

        • Parameters

          • success: boolean
          • message: string
          • data: string

          Returns void

    Returns Promise<{ data: string; message: string; success: boolean }>

Static chatConfig

  • chatConfig(code: string, type: string, value: any, callBack?: (success: boolean, message: string, data: string) => void): Promise<{ data: string; message: string; success: boolean }>

  • 设置聊天配置

    Parameters

    • code: string

      会话编号

    • type: string

      枚举值：top 是否置顶 mute 是否静音 clear 清除聊天记录

    • value: any

      配置的值，top和mute配置boolean值

    • Optional callBack: (success: boolean, message: string, data: string) => void
        • (success: boolean, message: string, data: string): void

        • Parameters

          • success: boolean
          • message: string
          • data: string

          Returns void

    Returns Promise<{ data: string; message: string; success: boolean }>

Static closeKeyboard

  • closeKeyboard(callBack?: (success: boolean, message: string) => void): Promise<{ data: string; message: string; success: boolean }>

  • 关闭手机输入键盘

    Parameters

    • Optional callBack: (success: boolean, message: string) => void

      调用成功后的回调函数

        • (success: boolean, message: string): void

        • Parameters

          • success: boolean
          • message: string

          Returns void

    Returns Promise<{ data: string; message: string; success: boolean }>

Static closeWindow

  • closeWindow(callBack?: (success: boolean, message: string) => void): Promise<{ data: string; message: string; success: boolean }>

  • 关闭浏览器窗口

    Parameters

    • Optional callBack: (success: boolean, message: string) => void

      调用成功后的回调函数

        • (success: boolean, message: string): void

        • Parameters

          • success: boolean
          • message: string

          Returns void

    Returns Promise<{ data: string; message: string; success: boolean }>

Static copy

  • copy(content: string, callBack?: (success: boolean, message: string) => void): Promise<{ data: string; message: string; success: boolean }>

  • 复制内容到剪贴板中

    Parameters

    • content: string

      复制的内容

    • Optional callBack: (success: boolean, message: string) => void

      调用成功后的回调函数

        • (success: boolean, message: string): void

        • Parameters

          • success: boolean
          • message: string

          Returns void

    Returns Promise<{ data: string; message: string; success: boolean }>

Static downloadFile

  • downloadFile(url: string, fileName: string, doneAction?: string, callBack?: (success: boolean, message: string) => void): Promise<{ data: string; message: string; success: boolean }>

  • 下载文件，会弹出下载对话框并显示下载进度

    Parameters

    • url: string

      文件的网络地址

    • fileName: string

      文件名，主要用于区别文件的类型，所以建议传参

    • Optional doneAction: string

      文件下载成功后，操作文件的方式，可选值：share（分享文件）、open（打开文件）

    • Optional callBack: (success: boolean, message: string) => void

      调用成功后的回调函数

        • (success: boolean, message: string): void

        • Parameters

          • success: boolean
          • message: string

          Returns void

    Returns Promise<{ data: string; message: string; success: boolean }>

Static error

  • error(message: string): void

  • 手机原生方法执行错误时调用

    Parameters

    • message: string

      错误信息

    Returns void

Static execute

  • execute(methodName: string, methodParams: any, callBack?: (result: { data: any; message: string; success: boolean }) => void): void

  • 执行手机客户端原生方法

    Parameters

    • methodName: string

      方法名称

    • methodParams: any

      方法参数，Array格式，按照原生方法的参数顺序设置

    • Optional callBack: (result: { data: any; message: string; success: boolean }) => void

      回调函数

        • (result: { data: any; message: string; success: boolean }): void

        • Parameters

          • result: { data: any; message: string; success: boolean }
            • data: any
            • message: string
            • success: boolean

          Returns void

    Returns void

Static executeAppCallBack

  • executeAppCallBack(key: string, result: string): void

  • 手机原生方法回执时调用

    Parameters

    • key: string

      回调函数的唯一标识

    • result: string

      回调结果

    Returns void

Static executeByPromise

  • executeByPromise(methodName: string, methodParams: any, callBack?: (result: { data?: any; message: string; success: boolean }) => void): Promise<{ data: any; message: string; success: boolean }>

  • 可同步或异步执行手机客户端原生方法

    Parameters

    • methodName: string

      方法名称

    • methodParams: any

      方法参数，Array格式，按照原生方法的参数顺序设置

    • Optional callBack: (result: { data?: any; message: string; success: boolean }) => void

      回调函数

        • (result: { data?: any; message: string; success: boolean }): void

        • Parameters

          • result: { data?: any; message: string; success: boolean }
            • Optional data?: any
            • message: string
            • success: boolean

          Returns void

    Returns Promise<{ data: any; message: string; success: boolean }>

Static getAndroidLevel

  • getAndroidLevel(callBack?: (success: boolean, message: string, data: number) => void): Promise<{ data: number; message: string; success: boolean }>

  • 获取APP的安卓SDK版本号

    Parameters

    • Optional callBack: (success: boolean, message: string, data: number) => void

      获取成功后的回调函数

        • (success: boolean, message: string, data: number): void

        • Parameters

          • success: boolean
          • message: string
          • data: number

          Returns void

    Returns Promise<{ data: number; message: string; success: boolean }>

Static getAppLevel

  • getAppLevel(callBack?: (success: boolean, message: string, data: string) => void): Promise<{ data: string; message: string; success: boolean }>

  • 获取APP的版本描述

    Parameters

    • Optional callBack: (success: boolean, message: string, data: string) => void

      获取成功后的回调函数

        • (success: boolean, message: string, data: string): void

        • Parameters

          • success: boolean
          • message: string
          • data: string

          Returns void

    Returns Promise<{ data: string; message: string; success: boolean }>

Static getCache

  • getCache(cacheKey: string, callBack?: (success: boolean, message: string, data: string) => void): Promise<{ data: string; message: string; success: boolean }>

  • 获取缓存在手机APP中的数据【async】

    Parameters

    • cacheKey: string

      缓存的Key

    • Optional callBack: (success: boolean, message: string, data: string) => void

      获取成功后的回调函数，函数结构：function(success:boolean,message:string,data:string){}

        • (success: boolean, message: string, data: string): void

        • Parameters

          • success: boolean
          • message: string
          • data: string

          Returns void

    Returns Promise<{ data: string; message: string; success: boolean }>

Static getChatConfig

  • getChatConfig(code: string, type: string, callBack?: (success: boolean, message: string, data: any) => void): Promise<{ data: any; message: string; success: boolean }>

  • 获取聊天配置

    Parameters

    • code: string

      会话编号

    • type: string

      枚举值：top 是否置顶 mute 是否静音

    • Optional callBack: (success: boolean, message: string, data: any) => void
        • (success: boolean, message: string, data: any): void

        • Parameters

          • success: boolean
          • message: string
          • data: any

          Returns void

    Returns Promise<{ data: any; message: string; success: boolean }>

Static getFinalParams

  • getFinalParams(callBack?: (success: boolean, message: string, data: any) => void): Promise<{ data: any; message: string; success: boolean }>

  • 获取APP配置的全局参数

    Parameters

    • Optional callBack: (success: boolean, message: string, data: any) => void

      获取成功后的回调函数，函数结构：function(success:boolean,message:string,data:string){}

        • (success: boolean, message: string, data: any): void

        • Parameters

          • success: boolean
          • message: string
          • data: any

          Returns void

    Returns Promise<{ data: any; message: string; success: boolean }>

Static getLocation

  • getLocation(callBack?: (success: boolean, message: string, data: LocationInfo) => void): Promise<{ data: string; message: string; success: boolean }>

  • 获取当前手机定位

    Parameters

    • Optional callBack: (success: boolean, message: string, data: LocationInfo) => void

      调用成功后的回调函数

        • (success: boolean, message: string, data: LocationInfo): void

        • Parameters

          Returns void

    Returns Promise<{ data: string; message: string; success: boolean }>

Static getStatusHeight

  • getStatusHeight(callBack?: (success: boolean, message: string, data: number) => void): Promise<{ data: string; message: string; success: boolean }>

  • 获取手机APP状态栏的高度

    Parameters

    • Optional callBack: (success: boolean, message: string, data: number) => void

      获取成功后的回调函数，函数结构：function(success:boolean,message:string,data:int){}

        • (success: boolean, message: string, data: number): void

        • Parameters

          • success: boolean
          • message: string
          • data: number

          Returns void

    Returns Promise<{ data: string; message: string; success: boolean }>

Static hideLoadingDialog

  • hideLoadingDialog(callBack?: (success: boolean, message: string) => void): Promise<{ data: string; message: string; success: boolean }>

  • 关闭全局等待框

    Parameters

    • Optional callBack: (success: boolean, message: string) => void

      调用成功后的回调函数

        • (success: boolean, message: string): void

        • Parameters

          • success: boolean
          • message: string

          Returns void

    Returns Promise<{ data: string; message: string; success: boolean }>

Static ignoredPower

  • ignoredPower(callBack?: (success: boolean, message: string) => void): Promise<{ data: string; message: string; success: boolean }>

  • 打开系统忽略APP电源设置

    Parameters

    • Optional callBack: (success: boolean, message: string) => void

      调用成功后的回调函数

        • (success: boolean, message: string): void

        • Parameters

          • success: boolean
          • message: string

          Returns void

    Returns Promise<{ data: string; message: string; success: boolean }>

Static isAndroid

  • isAndroid(): boolean

Static isIOS

  • isIOS(): boolean

Static notifySet

  • notifySet(callBack?: (success: boolean, message: string) => void): Promise<{ data: string; message: string; success: boolean }>

  • 打开APP的系统通知设置

    Parameters

    • Optional callBack: (success: boolean, message: string) => void

      调用成功后的回调函数

        • (success: boolean, message: string): void

        • Parameters

          • success: boolean
          • message: string

          Returns void

    Returns Promise<{ data: string; message: string; success: boolean }>

Static openBrowser

  • openBrowser(url: string, closeSelf: boolean, callBack?: (success: boolean, message: string) => void): Promise<{ data: string; message: string; success: boolean }>

  • 在新的窗口浏览器中打开链接地址

    Parameters

    • url: string

      链接地址

    • closeSelf: boolean

      打开新的窗口后是否关闭当前窗口

    • Optional callBack: (success: boolean, message: string) => void

      调用成功后的回调函数

        • (success: boolean, message: string): void

        • Parameters

          • success: boolean
          • message: string

          Returns void

    Returns Promise<{ data: string; message: string; success: boolean }>

Static openFile

  • openFile(url: string, fileName: string, callBack?: (success: boolean, message: string) => void): Promise<{ data: string; message: string; success: boolean }>

  • 打开一个文件，如果是图片类型则调用图片浏览器打开，如果是mp4类型 则打开视频播放器，否则下载成功后打开文件

    Parameters

    • url: string

      文件地址

    • fileName: string

      文件名，主要用于区别文件的类型，所以建议传参

    • Optional callBack: (success: boolean, message: string) => void

      调用成功后的回调函数

        • (success: boolean, message: string): void

        • Parameters

          • success: boolean
          • message: string

          Returns void

    Returns Promise<{ data: string; message: string; success: boolean }>

Static openKeyboard

  • openKeyboard(callBack?: (success: boolean, message: string) => void): Promise<{ data: string; message: string; success: boolean }>

  • 打开输入键盘

    Parameters

    • Optional callBack: (success: boolean, message: string) => void

      调用成功后的回调函数

        • (success: boolean, message: string): void

        • Parameters

          • success: boolean
          • message: string

          Returns void

    Returns Promise<{ data: string; message: string; success: boolean }>

Static openTaobaoA

  • openTaobaoA(url: string, callBack?: (success: boolean, message: string) => void): Promise<{ data: string; message: string; success: boolean }>

  • 打开淘宝的商品链接

    Parameters

    • url: string

      商品链接

    • Optional callBack: (success: boolean, message: string) => void

      调用成功后的回调函数

        • (success: boolean, message: string): void

        • Parameters

          • success: boolean
          • message: string

          Returns void

    Returns Promise<{ data: string; message: string; success: boolean }>

Static openTaobaoB

  • openTaobaoB(sellerId: string, callBack?: (success: boolean, message: string) => void): Promise<{ data: string; message: string; success: boolean }>

  • 打开淘宝的商家详情页链接

    Parameters

    • sellerId: string

      商家门店的ID

    • Optional callBack: (success: boolean, message: string) => void

      调用成功后的回调函数

        • (success: boolean, message: string): void

        • Parameters

          • success: boolean
          • message: string

          Returns void

    Returns Promise<{ data: string; message: string; success: boolean }>

Static openTaobaoC

  • openTaobaoC(numIid: string, callBack?: (success: boolean, message: string) => void): Promise<{ data: string; message: string; success: boolean }>

  • 打开淘宝的商品详情页面

    Parameters

    • numIid: string

      商品ID

    • Optional callBack: (success: boolean, message: string) => void

      调用成功后的回调函数

        • (success: boolean, message: string): void

        • Parameters

          • success: boolean
          • message: string

          Returns void

    Returns Promise<{ data: string; message: string; success: boolean }>

Static openUrl

  • openUrl(url: string, callBack?: (success: boolean, message: string) => void): Promise<{ data: string; message: string; success: boolean }>

  • 打开一个地址，如果地址是http开头则调用浏览器打开，否则调用第三方APP打开，例如：wx://

    Parameters

    • url: string

      地址

    • Optional callBack: (success: boolean, message: string) => void

      调用成功后的回调函数

        • (success: boolean, message: string): void

        • Parameters

          • success: boolean
          • message: string

          Returns void

    Returns Promise<{ data: string; message: string; success: boolean }>

Static postEvent

  • postEvent(eventName: string, callBack?: (success: boolean, message: string) => void): Promise<{ data: string; message: string; success: boolean }>

  • 发送网页页面事件，此将会触发页面 FastNative.CrosheInject.onEvent 函数

    Parameters

    • eventName: string

      事件名称

    • Optional callBack: (success: boolean, message: string) => void

      调用成功后的回调函数

        • (success: boolean, message: string): void

        • Parameters

          • success: boolean
          • message: string

          Returns void

    Returns Promise<{ data: string; message: string; success: boolean }>

Static postNotify

  • postNotify(notifyName: string, callBack?: (success: boolean, message: string) => void): Promise<{ data: string; message: string; success: boolean }>

  • 发送全局事件通知到APP原生代码中

    Parameters

    • notifyName: string

      事件名称

    • Optional callBack: (success: boolean, message: string) => void

      调用成功后的回调函数

        • (success: boolean, message: string): void

        • Parameters

          • success: boolean
          • message: string

          Returns void

    Returns Promise<{ data: string; message: string; success: boolean }>

Static removeCache

  • removeCache(key: string, callBack?: (success: boolean, message: string) => void): Promise<{ data: string; message: string; success: boolean }>

  • 删除缓存在APP中的数据

    Parameters

    • key: string

      缓存的标识

    • Optional callBack: (success: boolean, message: string) => void

      调用成功后的回调函数

        • (success: boolean, message: string): void

        • Parameters

          • success: boolean
          • message: string

          Returns void

    Returns Promise<{ data: string; message: string; success: boolean }>

Static reportBug

  • reportBug(error: string, callBack?: (success: boolean, message: string) => void): Promise<{ data: string; message: string; success: boolean }>

  • 上报异常信息

    Parameters

    • error: string

      异常信息

    • Optional callBack: (success: boolean, message: string) => void

      调用成功后的回调函数

        • (success: boolean, message: string): void

        • Parameters

          • success: boolean
          • message: string

          Returns void

    Returns Promise<{ data: string; message: string; success: boolean }>

Static saveImage

  • saveImage(url: string, callBack?: (success: boolean, message: string) => void): Promise<{ data: string; message: string; success: boolean }>

  • 保存图片到手机相册中

    Parameters

    • url: string

      图片地址

    • Optional callBack: (success: boolean, message: string) => void

      调用成功后的回调函数

        • (success: boolean, message: string): void

        • Parameters

          • success: boolean
          • message: string

          Returns void

    Returns Promise<{ data: string; message: string; success: boolean }>

Static selectMap

  • selectMap(callBack?: (success: boolean, message: string, data: LocationInfo) => void): Promise<{ data: string; message: string; success: boolean }>

  • 打开地图选择位置

    Parameters

    • Optional callBack: (success: boolean, message: string, data: LocationInfo) => void

      调用成功后的回调函数

        • (success: boolean, message: string, data: LocationInfo): void

        • Parameters

          Returns void

    Returns Promise<{ data: string; message: string; success: boolean }>

Static setCache

  • setCache(key: string, data: string, callBack?: (success: boolean, message: string) => void): Promise<{ data: string; message: string; success: boolean }>

  • 缓存数据到APP中

    Parameters

    • key: string

      缓存的key

    • data: string

      缓存的数据

    • Optional callBack: (success: boolean, message: string) => void

      调用成功后的回调函数

        • (success: boolean, message: string): void

        • Parameters

          • success: boolean
          • message: string

          Returns void

    Returns Promise<{ data: string; message: string; success: boolean }>

Static setCrop

  • setCrop(crop: boolean, callBack?: (success: boolean, message: string) => void): Promise<{ data: string; message: string; success: boolean }>

  • 设置图片为剪切状态，一般在选择图片前调用

    Parameters

    • crop: boolean

      是否进行图片剪切

    • Optional callBack: (success: boolean, message: string) => void

      调用成功后的回调函数

        • (success: boolean, message: string): void

        • Parameters

          • success: boolean
          • message: string

          Returns void

    Returns Promise<{ data: string; message: string; success: boolean }>

Static setImages

  • setImages(images: string, callBack?: (success: boolean, message: string) => void): Promise<{ data: string; message: string; success: boolean }>

  • 设置当前浏览器的图片集，

    Parameters

    • images: string

      图片集，多个图片以 英文逗号（,）隔开，例如：http://12123/12.png,http://12123/124.png

    • Optional callBack: (success: boolean, message: string) => void

      调用成功后的回调函数

        • (success: boolean, message: string): void

        • Parameters

          • success: boolean
          • message: string

          Returns void

    Returns Promise<{ data: string; message: string; success: boolean }>

Static setWebTitle

  • setWebTitle(title: string, callBack?: (success: boolean, message: string) => void): Promise<{ data: string; message: string; success: boolean }>

  • 预设浏览器的标题

    Parameters

    • title: string

      标题

    • Optional callBack: (success: boolean, message: string) => void

      调用成功后的回调函数

        • (success: boolean, message: string): void

        • Parameters

          • success: boolean
          • message: string

          Returns void

    Returns Promise<{ data: string; message: string; success: boolean }>

Static shareUrl

  • shareUrl(url: string, title: string, content: string, imgUrl: string, type: number, callBack?: (success: boolean, message: string, data: any) => void): Promise<{ data: string; message: string; success: boolean }>

  • 发起分享

    Parameters

    • url: string

      分享网页地址

    • title: string

      分享标题

    • content: string

      分享的内容

    • imgUrl: string

      网页的缩率图地址

    • type: number

      分享类型，可选值有：1（微信朋友圈）、2（微信好友）、3（QQ好友）、4（QQ空间）

    • Optional callBack: (success: boolean, message: string, data: any) => void

      调用成功后的回调函数

        • (success: boolean, message: string, data: any): void

        • Parameters

          • success: boolean
          • message: string
          • data: any

          Returns void

    Returns Promise<{ data: string; message: string; success: boolean }>

Static showLoadingDialog

  • showLoadingDialog(message: string, callBack?: (success: boolean, message: string) => void): Promise<{ data: string; message: string; success: boolean }>

  • 弹出全局等待框

    Parameters

    • message: string

      等待的消息

    • Optional callBack: (success: boolean, message: string) => void

      调用成功后的回调函数

        • (success: boolean, message: string): void

        • Parameters

          • success: boolean
          • message: string

          Returns void

    Returns Promise<{ data: string; message: string; success: boolean }>

Static showMap

  • showMap(lng: string, lat: string, address: string, callBack?: (success: boolean, message: string) => void): Promise<{ data: string; message: string; success: boolean }>

  • 在地图上查看位置

    Parameters

    • lng: string

      经度

    • lat: string

      纬度

    • address: string

      详细位置

    • Optional callBack: (success: boolean, message: string) => void

      调用成功后的回调函数

        • (success: boolean, message: string): void

        • Parameters

          • success: boolean
          • message: string

          Returns void

    Returns Promise<{ data: string; message: string; success: boolean }>

Static startNav

  • startNav(lng: string, lat: string, callBack?: (success: boolean, message: string) => void): Promise<{ data: string; message: string; success: boolean }>

  • 开启地图导航

    Parameters

    • lng: string

      经度

    • lat: string

      纬度

    • Optional callBack: (success: boolean, message: string) => void

      调用成功后的回调函数

        • (success: boolean, message: string): void

        • Parameters

          • success: boolean
          • message: string

          Returns void

    Returns Promise<{ data: string; message: string; success: boolean }>

Static startScanner

  • startScanner(callBack?: (success: boolean, message: string, data: string) => void): Promise<{ data: string; message: string; success: boolean }>

  • 发起扫描二维码

    Parameters

    • Optional callBack: (success: boolean, message: string, data: string) => void

      调用成功后的回调函数

        • (success: boolean, message: string, data: string): void

        • Parameters

          • success: boolean
          • message: string
          • data: string

          Returns void

    Returns Promise<{ data: string; message: string; success: boolean }>

Static toast

  • toast(message: string, callBack?: (success: boolean, message: string) => void): Promise<{ data: string; message: string; success: boolean }>

  • 弹出提示消息

    Parameters

    • message: string

      消息内容

    • Optional callBack: (success: boolean, message: string) => void

      调用成功后的回调函数

        • (success: boolean, message: string): void

        • Parameters

          • success: boolean
          • message: string

          Returns void

    Returns Promise<{ data: string; message: string; success: boolean }>

Static wxPay

  • wxPay(orderPrefix: string, orderTitle: string, orderMoney: number, orderData: string, callBack?: (success: boolean, message: string, data: any) => void): Promise<{ data: string; message: string; success: boolean }>

  • 发起微信支付

    Parameters

    • orderPrefix: string

      订单前缀，例如：PY

    • orderTitle: string

      订单标题

    • orderMoney: number

      订单金额

    • orderData: string

      订单携带的额外数据

    • Optional callBack: (success: boolean, message: string, data: any) => void

      支付完成回调

        • (success: boolean, message: string, data: any): void

        • Parameters

          • success: boolean
          • message: string
          • data: any

          Returns void

    Returns Promise<{ data: string; message: string; success: boolean }>