NPM 包 Cordova-plugin-um-common 使用教程

阅读时长 7 分钟读完

介绍

cordova-plugin-um-common 是友盟分享 SDK for Cordova 的核心插件,将其安装到 Cordova 项目中,开发者可以轻松地实现友盟分享功能,广泛应用于移动应用、小程序和 H5 等场景。

本文将教大家如何在 Cordova 项目中使用 cordova-plugin-um-common,如何实现友盟分享功能以及相关注意事项。

前置要求

  • 已经安装了 Cordova 环境,且已经创建了 Cordova 项目
  • 已经注册并且创建了应用并且开通了友盟分享的账号
  • 安装了 cordova-plugin-um-common 插件及其相关依赖

安装 cordova-plugin-um-common

  1. 打开终端,进入到 Cordova 项目的根目录下;

  2. 执行如下命令:

    在上述命令中,your_app_key 是自己的友盟账号所创建应用的 App Key,可以在友盟开放平台 的后台中找到。

    --save 参数是将插件信息存储到 config.xml 文件中,这样下次从 git 或其他地方拉取代码时,插件会自动安装。

  3. 安装完毕后,可以在 config.xml 文件的 <plugin> 标签下看到已经添加了 cordova-plugin-um-common,并且已经填写了UM_APP_KEY变量参数值。

  4. 安装 cordova-plugin-whitelist 插件以支持 Cordova 访问本地资源:

    安装完毕后,打开 config.xml 文件中的 <access origin="*" /> 标签,添加 <allow-navigation href="*" /> 标签,使得应用可以访问所有网络资源。

友盟分享功能实现

  1. 引入 cordova-plugin-um-common 的 API:

  2. 在需要分享的页面上,绑定分享按钮,与具体的分享方法关联起来:

  3. 实现分享方法:

    -- -------------------- ---- -------
    -------- -------------- 
      --- ----------- - - 
        ------------- 
        ------------ 
        ----------------------- 
        ---------------- 
        -------------------------------------- 
        --------------------------------- -- --------- 
      -- 
      -------------------------------------- 
        -------- 
        -------------------- 
      ------------- 
        -------- 
        -------------------- 
      --- 
    - 
    
    -------- ---------------- 
      --- ----------- - - 
        ------------- 
        ------------ 
        ----------------------- 
        ---------------- 
        -------------------------------------- 
        ---------------------------------- 
      -- 
      -------------------------------------- 
        -------------------- 
      ------------- 
        -------------------- 
      --- 
    - 
    
    -------- ---------- 
      --- ----------- - - 
        ------------- 
        ------------ 
        ----------------------- 
        ---------------- 
        -------------------------------------- 
        --------------------- 
      -- 
      -------------------------------------- 
        -------------------- 
      ------------- 
        -------------------- 
      --- 
    - 
    
    -------- ------------- 
      --- ----------- - - 
        ------------- 
        ------------ 
        ----------------------- 
        ---------------- 
        -------------------------------------- 
        ------------------------------- 
      -- 
      -------------------------------------- 
        -------------------- 
      ------------- 
        -------------------- 
      --- 
    - 
    展开代码

    在上述代码中, shareParams 对象是分享的参数,可以根据自己的需求进行自定义。

  4. 安卓平台注意事项

    • 需要确保存在 res/xml/file_paths.xml 文件,如下所示:

    • 在安卓平台上,需要在相应的平台开发者后台创建 App 并获取对应的 App Secret。获取后,需要在 build.gradle 文件中添加如下内容,确保应用在安装后可以获取到友盟的相关授权:

      -- -------------------- ---- -------
      ------- -
          ----------- -
              ------------------ -----
              ------------ -----
          -
          ------------- -
              -------------------- - -
                  ----------- ---------------
                  -------------- ------------------
                  ----------- -------
              -
          -
      -
      展开代码

结语

本文已经向大家介绍了如何在 Cordova 项目中使用 cordova-plugin-um-common 插件实现友盟分享功能,并提供了相应的示例代码和注意事项。希望能帮助到初学者快速掌握使用这一功能。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60065f86238a385564ab6cab

纠错
反馈

纠错反馈