第三方应用开发 客户端API WECOM-JSSDK 基础接口 ww.register
ww.register
最后更新:2023/03/30
可联系渠道经理采购或代理智慧硬件接口已支持设备 联系渠道经理
ww.register
最后更新:2023/03/30

目录

  • ww.register(options)
  • 功能描述
  • 参数说明
  • options: Object
  • 附加说明
  • ww.register(options)

    功能描述

    注册应用信息。

    ww.register({
      corpId: 'ww7ca4776b2a70000',
      jsApiList: ['getExternalContact'],
      getConfigSignature
    })

    参数说明

    options: Object

    属性类型默认值必填说明最低版本
    corpIdstring

    当前用户所属企业 ID

    agentIdstring / number

    当前第三方应用 AgentID

    suiteIdstring

    应用套件 ID

    jsApiListstring[]

    需要使用的JS接口列表

    openTagListstring[]

    需要使用的开放标签列表,例如['wx-open-launch-app']

    getConfigSignatureFunction

    config 签名生成函数

    参数

    url: string

    用于生成签名的 URL

    返回值

    Object / Promise<Object>

    属性类型默认值必填说明最低版本
    timestampstring / number

    生成签名的时间戳

    nonceStrstring

    生成签名的随机串

    signaturestring

    签名

    onConfigSuccessFunction

    config 成功回调

    参数

    res: Object

    属性类型默认值必填说明最低版本
    checkResultObject

    jsApiList 权限检查结果

    errMsgstring

    通用错误信息

    errCodenumber

    通用错误码

    onConfigFailFunction

    config 失败回调

    参数

    res: Error / Object

    属性类型默认值必填说明最低版本
    errMsgstring

    通用错误信息

    errCodenumber

    通用错误码

    onConfigCompleteFunction

    config 完成回调

    参数

    res: Error / Object

    可能为以下类型

    属性类型默认值必填说明最低版本
    errMsgstring

    通用错误信息

    errCodenumber

    通用错误码

    属性类型默认值必填说明最低版本
    checkResultObject

    jsApiList 权限检查结果

    errMsgstring

    通用错误信息

    errCodenumber

    通用错误码

    getAgentConfigSignatureFunction

    agentConfig 签名生成函数

    参数

    url: string

    用于生成签名的 URL

    返回值

    Object / Promise<Object>

    属性类型默认值必填说明最低版本
    timestampstring / number

    生成签名的时间戳

    nonceStrstring

    生成签名的随机串

    signaturestring

    签名

    onAgentConfigSuccessFunction

    agentConfig 成功回调

    参数

    res: Object

    属性类型默认值必填说明最低版本
    checkResultObject

    jsApiList 权限检查结果

    errMsgstring

    通用错误信息

    errCodenumber

    通用错误码

    onAgentConfigFailFunction

    agentConfig 失败回调

    参数

    res: Error / Object

    属性类型默认值必填说明最低版本
    errMsgstring

    通用错误信息

    errCodenumber

    通用错误码

    onAgentConfigCompleteFunction

    agentConfig 完成回调

    参数

    res: Error / Object

    可能为以下类型

    属性类型默认值必填说明最低版本
    errMsgstring

    通用错误信息

    errCodenumber

    通用错误码

    属性类型默认值必填说明最低版本
    checkResultObject

    jsApiList 权限检查结果

    errMsgstring

    通用错误信息

    errCodenumber

    通用错误码

    getSuiteConfigSignatureFunction

    suiteConfig 签名生成函数

    参数

    url: string

    用于生成签名的 URL

    返回值

    Object / Promise<Object>

    属性类型默认值必填说明最低版本
    timestampstring / number

    生成签名的时间戳

    nonceStrstring

    生成签名的随机串

    signaturestring

    签名

    附加说明

    参数中的回调函数(如 getConfigSignatureonConfigSuccess 等)调用时机由 JSSDK 自行控制,开发者无需关心具体的调用顺序。在非微信、企业微信内置浏览器的环境下,JSSDK 不会主动调用 getConfigSignature 回调。

    上一篇
    开发指南
    下一篇
    ww.getSignature