# minchao-js-sdk

**Repository Path**: keepjob/minchao-js-sdk

## Basic Information

- **Project Name**: minchao-js-sdk
- **Description**: 民潮SDK
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2019-01-02
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# minchao-js-sdk

[![码云Gitee](https://gitee.com/keepjob/minchao-js-sdk/badge/star.svg?theme=blue)](https://gitee.com/keepjob/minchao-js-sdk.git)
[![使用IntelliJ IDEA开发维护](https://img.shields.io/badge/IntelliJ%20IDEA-提供支持-blue.svg)](https://www.jetbrains.com/?from=WxJava-weixin-java-tools)
[![Build Status](https://travis-ci.org/Wechat-Group/WxJava.svg?branch=develop)](https://travis-ci.org/Wechat-Group/WxJava)

#### 介绍
民潮SDK

#### 软件架构
软件架构说明


#### 安装教程

1. 在 民潮SDK 的 Gitee 上下载最新的 release 版本，解压出来的文件夹里的 dist 目录里可以找到最新版本的 民潮SDK 库。
2. 通过 npm 获取 minchao-js-sdk，npm install minchao-js-sdk --save，详见“在 webpack 中使用 minchao-js-sdk”
3. 通过 yarn 获取 minchao-js-sdk，yarn add minchao-js-sdk ，详见“在 webpack 中使用 minchao-js-sdk”

#### 使用说明

1. 引用
````javascript
    const MS = require('./assets/MS-x.x.x.min')
    //or
    import MS from './assets/MS-x.x.x.min'
````
2. 初始化
````javascript
    //基本初始化
    MS.initialize(APPLICATION_ID, APPLICATION_KEY, APP_ID)
    //or 微信初始化
    MS.WXInit(APPLICATION_ID, APPLICATION_KEY, APP_ID)
    //or Web项目初始化
    MS.WebInit(APPLICATION_ID, APPLICATION_KEY, APP_ID)
    //or Node项目初始化
    MS.NodeInit(APPLICATION_ID, APPLICATION_KEY, APP_ID)
    //or Hap项目初始化
    MS.HapInit(APPLICATION_ID, APPLICATOIN_KEY, APP_ID)
````
[![文档](https://mjsj-1252113145.cos.ap-guangzhou.myqcloud.com/folder.svg)](https://gitee.com/keepjob/minchao-js-sdk/wikis/pages)
# 模块
>*User用户模块*
----

- `login` 登陆

| 参数名 | 必填 | 参数说明 |
| :----: | :----: | :----: |
| code   | y   | 微信用户code |

````javascript
    MS.User.login(code).then(res => {
    
    }).catch(err => {
        
    })
````

- `update` 更新

| 参数名 | 必填 | 参数说明 |
| :----: | :----: | :----: |
| res   | y    | 微信用户登陆后的res |

````javascript
    MS.User.update(res).then(res => {
    
    }).catch(err => {
        
    })
````

- `bindPhone` 绑定手机号码

| 参数名 | 必填 | 参数说明 |
| :----: | :----: | :----: |
| phone   | y    | 手机号码 |

````javascript
    MS.User.bindPhone(res).then(res => {
    
    }).catch(err => {
        
    })
````

- `current` 当前用户

````javascript
    //获取当前用户
    var currUser = MS.User.current()
````

- `getPhoneNumber` 获取手机号码

| 参数名 | 必填 | 参数说明 |
| :----: | :----: | :----: |
| e   | y    | 微信wx.getPhoneNumber的返回值 |

````javascript
    MS.User.getPhoneNumber(e).then(res => {
    
    }).catch(err => {
    
    })
````

- `findUnPayShopBags` 获取待支付购物袋内数据

````javascript
    MS.User.findUnPayShopBags().then(res => {
    
    }).catch(err => {
    
    })
````

- `getUnPayShopBagNum` 获取待支付购物袋内数量

````javascript
    MS.User.getUnPayShopBagNum().then(res => {
    
    }).catch(err => {
    
    })
````

- `joinShopBag` 加入购物袋

| 参数名 | 必填 | 参数说明 | 参数类型 |
| :---- | :----: | :---- | :---- |
| userId   | y    | 用户ID | String |
| sellerId   | y    | 经销商ID | String |
| goodsCategoryId   | n    | 商品类型ID | String |
| goodsSubCategoryId   | n    | 商品子类型ID | String |
| goodsId   | y    | 商品ID | String |
| goodsName   | n    | 商品名称 | String |
| itemId   | y    | 商品规格ID | String |
| itemName   | n    | 商品规格名称 | String |
| price   | y    | 单价(单位 *分* ) | Number |
| shareProfit   | n    | 返利金额 | Number |
| totalNum   | y    | 数量 | Number |
| logo   | y    | Logo | String |
| ice   | y    | 冷链 | Boolean |

````javascript
    //params is Object
    MS.User.joinShopBag(params).then(res => {
    
    }).catch(err => {
    
    })
````

- `plusShopBagGoods` 追加购物袋内商品数量

| 参数名 | 必填 | 参数说明 | 参数类型 |
| :---- | :----: | :---- | :---- |
| shopBagId   | y    | 购物袋ID | String |

````javascript
    MS.User.plusShopBagGoods(shopBagId).then(res => {
    
    }).catch(err => {
    
    })
````

- `minusShopBagGoods` 减少购物袋内商品数量

| 参数名 | 必填 | 参数说明 | 参数类型 |
| :---- | :----: | :---- | :---- |
| shopBagId   | y    | 购物袋ID | String |

````javascript
    MS.User.minusShopBagGoods(shopBagId).then(res => {
    
    }).catch(err => {
    
    })
````

- `removeShopBagGoods` 删除购物袋内商品

| 参数名 | 必填 | 参数说明 | 参数类型 |
| :---- | :----: | :---- | :---- |
| shopBagId   | y    | 购物袋ID | String |

````javascript
    MS.User.removeShopBagGoods(shopBagId).then(res => {
    
    }).catch(err => {
    
    })
````

- `findSysNotice` 获取系统通知

| 参数名 | 必填 | 参数说明 | 参数类型 | 默认值 |
| :---- | :----: | :---- | :---- | :----: |
| pageNum   | n    | 当前页数 | Number | 1 |
| pageSize   | n    | 每页展示数 | Number | 10 |

````javascript
    MS.User.findSysNotice(pageNum, pageSize).then(res => {
        var list = res.list //数据列表
        var pageNum = res.pageNum //当前页数
        var total = res.total //数据总数
    }).catch(err => {
    
    })
````

- `getNoLookSysNoticeNum` 获取未读系统通知数

````javascript
    MS.User.getNoLookSysNoticeNum().then(res => {
    
    }).catch(err => {
    
    })
````

- `setSysNoticeLook` 系统消息设为已读

````javascript
    MS.User.setSysNoticeLook().then(res =>{
    
    }).catch(err => {
    
    })
````

#### 参与贡献

1. Fork 本仓库
2. 新建 Feat_xxx 分支
3. 提交代码
4. 新建 Pull Request


#### 码云特技

1. 使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md
2. 码云官方博客 [blog.gitee.com](https://blog.gitee.com)
3. 你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解码云上的优秀开源项目
4. [GVP](https://gitee.com/gvp) 全称是码云最有价值开源项目，是码云综合评定出的优秀开源项目
5. 码云官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)
6. 码云封面人物是一档用来展示码云会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)