com.jfinal.weixin.sdk.api

## 类 CardCodeApi

- java.lang.Object
- - com.jfinal.weixin.sdk.api.CardCodeApi

-     public class CardCodeApi
      extends Object

  核销卡券接口
  作者:
    L.cm

- - ### 构造器概要

    构造器
    构造器和说明
    `CardCodeApi()`

  - ### 方法概要

    所有方法 静态方法 具体方法
    限定符和类型 | 方法和说明
    --- | ---
    `static ApiResult` | `checkCode(String cardId, List<String> codeList)` 核查code接口
    `static ApiResult` | `consume(String code)` 核销Code接口
    `static ApiResult` | `consume(String code, String cardId)` 核销Code接口
    `static ApiResult` | `consumeOnline(String code, String openid)` 线上核销Code接口
    `static ApiResult` | `decrypt(String encryptCode)` Code解码接口
    `static ApiResult` | `get(String code, String cardId, boolean checkConsume)` 查询Code接口
    `static ApiResult` | `getDepositCount(String cardId)` 查询导入code数目接口
    `static ApiResult` | `markCode(String code, String cardId, String openid, boolean isMark)` 朋友的券-Mark(占用)Code接口
    `static ApiResult` | `setDeposit(String cardId, List<String> codeList)` 导入code接口，文档有歧义 ？？
    `static ApiResult` | `update(String code, String newCode)` 更改Code接口
    `static ApiResult` | `update(String cardId, String code, String newCode)` 更改Code接口

    - ### 从类继承的方法 java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### 构造器详细资料

    - #### CardCodeApi

          public CardCodeApi()

  - ### 方法详细资料

    - #### get

          public static ApiResult get(String code,
                                      String cardId,
                                      boolean checkConsume)

      查询Code接口
      参数:
        `code` - 单张卡券的唯一标准。
        `cardId` - 卡券ID代表一类卡券。自定义code卡券必填。
        `checkConsume` - 是否校验code核销状态，填入true和false时的code异常状态返回数据不同。
      返回:
        {ApiResult}

    - #### consume

          public static ApiResult consume(String code)

      核销Code接口
      参数:
        `code` - 需核销的Code码。
      返回:
        {ApiResult}

    - #### consume

          public static ApiResult consume(String code,
                                          String cardId)

      核销Code接口
      参数:
        `code` - 需核销的Code码。
        `cardId` - card_id卡券ID。创建卡券时use_custom_code填写true时必填。非自定义Code不必填写。
      返回:
        {ApiResult}

    - #### consumeOnline

          public static ApiResult consumeOnline(String code,
                                                String openid)

      线上核销Code接口
      参数:
        `code` - 需核销的Code码。
        `openid` - 是 string(20) 当前卡券使用者的openid，通常通过网页授权登录或自定义url跳转参数获得。
      返回:
        {ApiResult}

    - #### decrypt

          public static ApiResult decrypt(String encryptCode)

      Code解码接口
      参数:
        `encryptCode` - 经过加密的Code码。
      返回:
        {ApiResult}

    - #### setDeposit

          public static ApiResult setDeposit(String cardId,
                                             List<String> codeList)

      导入code接口，文档有歧义 ？？buffer 是 文件的数据流
      参数:
        `cardId` - 需要进行导入code的卡券ID。
        `codeList` - 需要进行导入code的卡券ID。
      返回:
        {ApiResult}

    - #### getDepositCount

          public static ApiResult getDepositCount(String cardId)

      查询导入code数目接口
      参数:
        `cardId` - 需要进行导入code的卡券ID。
      返回:
        {ApiResult}

    - #### checkCode

          public static ApiResult checkCode(String cardId,
                                            List<String> codeList)

      核查code接口
      参数:
        `cardId` - 需要进行导入code的卡券ID。
        `codeList` - 已经微信卡券后台的自定义code，上限为100个。
      返回:
        {ApiResult}

    - #### update

          public static ApiResult update(String code,
                                         String newCode)

      更改Code接口
      参数:
        `code` - 需变更的Code码。
        `newCode` - 变更后的有效Code码。
      返回:
        {ApiResult}

    - #### update

          public static ApiResult update(String cardId,
                                         String code,
                                         String newCode)

      更改Code接口
      参数:
        `cardId` - 卡券ID。自定义Code码卡券为必填。
        `code` - 需变更的Code码。
        `newCode` - 变更后的有效Code码。
      返回:
        {ApiResult}

    - #### markCode

          public static ApiResult markCode(String code,
                                           String cardId,
                                           String openid,
                                           boolean isMark)

      朋友的券-Mark(占用)Code接口
      参数:
        `code` - 是 卡券的code码。
        `cardId` - 需要进行导入code的卡券ID。
        `openid` - 是 用券用户的openid。
        `isMark` - 是 是否要mark（占用）这个code，填写true或者false，表示占用或解除占用。
      返回:
        {ApiResult}

Copyright © 2017. All rights reserved.