cmp.app 类

app

方法

clearCache

clearCache
(
  • options
)

定义于 doc\doc\cmp_doc_all\cmp-app-doc.js:448

清除应用缓存

参数:

名称类型标识描述
options Object 必选

配置参数

名称类型标识描述
success Function 必选

成功后的回调

error Function 必选

失败后的回调

示例:

<script>
   cmp.app.clearCache({
       success:function(result){
            //do something with result
       },
       error:function(error){
       }
   });
</script>

deleteApp

deleteApp
(
  • options
)

定义于 doc\doc\cmp_doc_all\cmp-app-doc.js:128

删除指定应用

参数:

名称类型标识描述
options Object 必选

配置参数

名称类型标识描述
appId Sting 必选

应用id

bundle_identifier String 必选

唯一id

bundle_name String 必选

应用名称

team String 必选

所属组

version String 必选

引用版本号

success Function 必选

成功回调

error Function 必选

失败回调

示例:

<script>
   cmp.app.deleteApp({
          appId: "xxxx",
          bundle_identifier: "xaxaxa",
          bundle_name: "协同",
          team: "f1",
          version: "1.0",
          success: function () {
          },
          error: function(){}
   });
</script>

downloadApp

downloadApp ()

定义于 doc\doc\cmp_doc_all\cmp-app-doc.js:51

下载应用包

示例:

<script>
   cmp.app.downloadApp({
       url: "",
          title: "",
          extData: null,
          progress: function () {
          },
          success: function () {
          },
          error: null
   });
</script>

exitApp

exitApp
(
  • options
)

定义于 doc\doc\cmp_doc_all\cmp-app-doc.js:490

杀进程退出app

参数:

名称类型标识描述
options Object 必选

配置参数

名称类型标识描述
success Function 必选

成功后的回调

error Function 必选

失败后的回调

示例:

<script>
   cmp.app.exitApp({
       success:function(result){
            //do something with result
       },
       error:function(error){
       }
   });
</script>

getAppEntryUrl

getAppEntryUrl
(
  • options
)

定义于 doc\doc\cmp_doc_all\cmp-app-doc.js:219

获取App入口

参数:

名称类型标识描述
options Object 必选

配置参数

名称类型标识描述
appId Sting 必选

应用id

version String 必选

引用版本号

success Function 必选

成功回调

error Function 必选

失败回调

示例:

<script>
   cmp.app.getAppEntryUrl({
          appId: "xxxx",
          version: "1.0",
          success: function () {
          },
          error: function(){}
   });
</script>

getAppInfo

getAppInfo
(
  • options
)

定义于 doc\doc\cmp_doc_all\cmp-app-doc.js:242

获取App信息

参数:

名称类型标识描述
options Object 必选

配置参数

名称类型标识描述
appId Sting 必选

应用id

version String 必选

引用版本号

success Function 必选

成功回调

error Function 必选

失败回调

示例:

<script>
   cmp.app.getAppInfo({
          appId: "xxxx",
          version: "1.0",
          success: function () {
          },
          error: function(){}
   });
</script>

getAppVersionList

getAppVersionList ()

定义于 doc\doc\cmp_doc_all\cmp-app-doc.js:202

获取应用下载列表版本号

示例:

<script>
   cmp.app.getAppVersionList({
          url: "",
          success: function () {
          },
          error: null
   });
</script>

getCacheLength

getCacheLength
(
  • options
)

定义于 doc\doc\cmp_doc_all\cmp-app-doc.js:469

获取缓存大小

参数:

名称类型标识描述
options Object 必选

配置参数

名称类型标识描述
success Function 必选

成功后的回调

error Function 必选

失败后的回调

示例:

<script>
   cmp.app.getCacheLength({
       success:function(result){
            //do something with result
       },
       error:function(error){
       }
   });
</script>

getDownloadAppList

getDownloadAppList ()

定义于 doc\doc\cmp_doc_all\cmp-app-doc.js:72

获取应用下载列表

示例:

<script>
   cmp.app.getDownloadAppList({
          url: "",
          success: function () {
          },
          error: null
   });
</script>

getJSAPIUrl

getJSAPIUrl
(
  • options
)

定义于 doc\doc\cmp_doc_all\cmp-app-doc.js:157

获取js api

参数:

名称类型标识描述
options Object 必选

配置参数

名称类型标识描述
appId Sting 必选

应用id

serverVersion String 必选

服务器版本号

serverIdentifier String 必选

服务器的唯一标识

ownerId String 必选

用户id

success Function 必选

成功回调

error Function 必选

失败回调

示例:

<script>
   cmp.app.getJSAPIUrl({
          appId: "xxxx",
          serverVersion: "xaxaxa",
          serverIdentifier: "xxx",
          ownerId: "xxxx",
          success: function () {
          },
          error: function(){}
   });
</script>

getLocalResourceUrl

getLocalResourceUrl
(
  • options
)

定义于 doc\doc\cmp_doc_all\cmp-app-doc.js:265

获取本地资源路径

参数:

名称类型标识描述
options Object 必选

配置参数

名称类型标识描述
url Sting 必选

应用url

success Function 必选

成功回调

error Function 必选

失败回调

示例:

<script>
   cmp.app.getLocalResourceUrl({
          url: "xxxx",
          success: function () {
          },
          error: function(){}
   });
</script>

getOpenDesktopAppOptions

getOpenDesktopAppOptions
(
  • options
)

定义于 doc\doc\cmp_doc_all\cmp-app-doc.js:319

获取桌面应用的信息

参数:

名称类型标识描述
options Object 必选

配置参数

名称类型标识描述
success Function 必选

成功后的回调

error Function 必选

失败后的回调

示例:

<script>
   cmp.app.getOpenDesktopAppOptions({
       success:function(result){
            //do something with result
       },
       error:function(error){
       }
   });
</script>

getPresetAppsMd5

getPresetAppsMd5 ()

定义于 doc\doc\cmp_doc_all\cmp-app-doc.js:185

获取预置应用Md5码

示例:

<script>
   cmp.app.getPresetAppsMd5({
          success: function (result) {
              result = {"cmp":"11111", "m3_apps_login":"", "m3_apps_commons":""}
          },
          error: null
   });
</script>

hideStartPage

hideStartPage
(
  • options
)

定义于 doc\doc\cmp_doc_all\cmp-app-doc.js:538

隐藏启动页

参数:

名称类型标识描述
options Object 必选

配置参数

名称类型标识描述
success Function 必选

成功后的回调

error Function 必选

失败后的回调

示例:

<script>
   cmp.app.hideStartPage({
       success:function(result){
            //do something with result
       },
       error:function(error){
       }
   });
</script>

loadApp

loadApp
(
  • options
)

定义于 doc\doc\cmp_doc_all\cmp-app-doc.js:89

加载指定应用

参数:

名称类型标识描述
options Object 必选

配置参数

名称类型标识描述
appId Sting 必选

应用id

bundle_identifier String 必选

唯一id

bundle_name String 必选

应用名称

team String 必选

所属组

version String 必选

引用版本号

appType String 必选

应用类型 default（v5、m3标准应用）

entry String 必选

用于原生app的调用、h5的url地址

downloadUrl String 必选

原生app下载地址

parameters String 必选

打开原生应用、h5url地址的参数

iOSStatusBarStyle String 必选

ios状态栏颜色0=黑色 1=白色

success Function 必选

成功回调

error Function 必选

失败回调

示例:

<script>
   cmp.app.loadApp({
          appId: "xxxx",
          bundle_identifier: "xaxaxa",
          bundle_name: "协同",
          team: "f1",
          version: "1.0",
          appType: "default",
          entry: "http://xxxxx",
          downloadUrl: "http://xxxxx",
          parameters: "{xxx:'xxxx'}",
          iOSStatusBarStyle: "1",
          success: function () {
          },
          error: function(){}
   });
</script>

openApp

openApp
(
  • url
)

定义于 doc\doc\cmp_doc_all\cmp-app-doc.js:20

打开第三方app

参数:

名称类型标识描述
url String 必选

打开的地址

示例:

<script>
   cmp.app.openApp(url);
</script>

openNativeUI

openNativeUI ()

定义于 doc\doc\cmp_doc_all\cmp-app-doc.js:33

打开原生UI

示例:

<script>
   cmp.app.openNativeUI({
       className:"",
       JID:"",
       data:"",
       success:function(){},
       error:function(){}
   });
</script>

openThirdNative

openThirdNative
(
  • options
)

定义于 doc\doc\cmp_doc_all\cmp-app-doc.js:559

打开第三方原生应用(如打开第三方视频会议app)

参数:

名称类型标识描述
options Object 必选

配置参数

名称类型标识描述
params String 必选

参数

appEnter String 必选

app认证等

iosAppEntry String 必选

ios入口信息

androidAppEntry String 必选

android入口信息

androidDownloadUrl String 必选
iosDownloadUrl String 必选
success Function 必选

成功后的回调

error Function 必选

失败后的回调

示例:

<script>
   cmp.app.openThirdNative({
       params:null,
       appEnter:"",
       iosAppEntry:"",
       androidAppEntry:"",
       androidDownloadUrl:"",
       iosDownloadUrl:"",
       success:function(result){
            //do something with result
       },
       error:function(error){
       }
   });
</script>

privilegeWrite

privilegeWrite
(
  • options
)

定义于 doc\doc\cmp_doc_all\cmp-app-doc.js:592

权限插件

参数:

名称类型标识描述
options Object 必选

配置参数

名称类型标识描述
values String 必选

参数

success Function 必选

成功后的回调

error Function 必选

失败后的回调

示例:

<script>
   cmp.app.privilegeWrite({
       values:{ hasColNew:true/false,xxx:true/false },
       success:function(result){
            //do something with result
       },
       error:function(error){
       }
   });
</script>

sendAjaxByActiveState

sendAjaxByActiveState
(
  • options
)

定义于 doc\doc\cmp_doc_all\cmp-app-doc.js:384

特殊情况的请求，当active的状态改变后才触发该缓存下的请求（ios不进行这个适配）

参数:

名称类型标识描述
options Object 必选

配置参数

名称类型标识描述
hide Object 必选

active hide状态的请求

名称类型标识描述
header Object 必选
请求header
url Object 必选
请求url
data Object 必选
请求参数
wakeup Object 必选

active唤醒状态的请求

名称类型标识描述
header Object 必选
请求header
url Object 必选
请求url
data Object 必选
请求参数
success Function 必选

成功后的回调

error Function 必选

失败后的回调

示例:

<script>
   cmp.app.sendAjaxByActiveState({
       params:{
          hide:{
             header:{},
             url:"xxxx",
             data:{}
          },
          wakeup:{
             header:{},
             url:"xxxx",
             data:{}
          }
       },
       success:function(result){
            //do something with result
       },
       error:function(error){
       }
   });
</script>

sendAjaxByActiveState

sendAjaxByActiveState
(
  • options
)

定义于 doc\doc\cmp_doc_all\cmp-app-doc.js:362

ios状态栏颜色0=黑色 1=白色

参数:

名称类型标识描述
options Object 必选

配置参数

名称类型标识描述
success Function 必选

成功后的回调

error Function 必选

失败后的回调

示例:

<script>
   cmp.app.setStatusBarStyleforiOS({
       statusBarStyle:0,
       success:function(result){
            //do something with result
       },
       error:function(error){
       }
   });
</script>

setApplicationIconBadgeNumber

setApplicationIconBadgeNumber
(
  • options
)

定义于 doc\doc\cmp_doc_all\cmp-app-doc.js:425

ios 设置桌面icon 数字

参数:

名称类型标识描述
options Object 必选

配置参数

名称类型标识描述
badgeNumber数字角标 Number 必选
success Function 必选

成功后的回调

error Function 必选

失败后的回调

示例:

<script>
   cmp.app.setApplicationIconBadgeNumber({
       badgeNumber:15,
       success:function(result){
            //do something with result
       },
       error:function(error){
       }
   });
</script>

setPermission

setPermission
(
  • options
)

定义于 doc\doc\cmp_doc_all\cmp-app-doc.js:511

提示设置应用权限

参数:

名称类型标识描述
options Object 必选

配置参数

名称类型标识描述
permissionTips String 必选

提示语

cancelText String 必选

取消按钮提示文字

toSetText String 必选

设置按钮提示文字

success Function 必选

成功后的回调

error Function 必选

失败后的回调

示例:

<script>
   cmp.app.setPermission({
       permissionTips:"没有权限，请开启相关权限",
       cancelText:"取消",
       toSetText:"去设置",
       success:function(result){
            //do something with result
       },
       error:function(error){
       }
   });
</script>

setStatusBarStyleforiOS

setStatusBarStyleforiOS
(
  • options
)

定义于 doc\doc\cmp_doc_all\cmp-app-doc.js:340

ios状态栏颜色0=黑色 1=白色

参数:

名称类型标识描述
options Object 必选

配置参数

名称类型标识描述
success Function 必选

成功后的回调

error Function 必选

失败后的回调

示例:

<script>
   cmp.app.setStatusBarStyleforiOS({
       statusBarStyle:0,
       success:function(result){
            //do something with result
       },
       error:function(error){
       }
   });
</script>
Top