EggFlow (data800sdk Maven Library 1.1.2 API)

java.lang.Object
- com.systemcn.data800.sdk.EggFlow

```
public class EggFlow
extends Object
```
易哥流量接口处理类。

作者:

HuangYingNing, ZhaoXiaoHai

另请参阅:
Code}, #com.systemcn.data800.sdk.type.Code

字段概要

字段
限定符和类型	字段和说明
`static String`	`BUY_API` 购买产品的API路径。
`static String`	`FIND_ORDER_API` 查找订单的API路径。
`static String`	`FIND_PRODUCT_API` 查找产品的API路径。
`static String`	`GET_BALANCE_API` 获取账户余额的API路径。
`static String`	`GET_ORDER_API` 获取指定流量产品的API路径。
`static String`	`GET_PRODUCT_API` 获取指定流量产品的API路径。
`static String`	`HTTPS_URL` 正式服务器URL。
`static String`	`HTTPS_URL_TEST` 测试服务器URL。
`static String`	`URL` 正式服务器URL。
`static String`	`URL_TEST` 测试服务器URL。

构造器概要

构造器
构造器和说明

EggFlow(String url, String appId, String appSecret)
构造函数。

构造器
构造器和说明
`EggFlow(String url, String appId, String appSecret)` 构造函数。

方法概要

方法
限定符和类型	方法和说明
`OrderResponse`	`buy(int amount, Scope scope, String mobile, EggAdcEffectRule effect, String orderId, String callbackUrl)` 订购流量包。
`boolean`	`callbackCheckSign(String sign, String orderId, int status, String msg)` 处理结果回调签名检查方法。
`boolean`	`callbackCheckSign(String sign, String orderId, String status, String msg)` 处理结果回调签名检查方法。
`OrdersResponse`	`findOrders(String mobile, String productId, int pageNo, int pageSize)` 按条件查询多个订单。
`ProductsResponse`	`findProducts()` 查询所有可用流量包。
`ProductsResponse`	`findProducts(String mobile)` 查询可用流量包。
`BalanceResponse`	`getBalance()` 获取账户余额。
`OrderResponse`	`getOrder(String orderId)` 查找指定id的订单。
`ProductResponse`	`getProduct(String productId)` 获取指定的产品信息。
`ProductResponse`	`getProduct(String mobile, int amount)` 通过手机号和流量包大小获取指定的产品信息。

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - URL
```
public static final String URL
```
    正式服务器URL。
    
    另请参阅:
    常量字段值
  - URL_TEST
```
public static final String URL_TEST
```
    测试服务器URL。
    
    另请参阅:
    常量字段值
  - HTTPS_URL
```
public static final String HTTPS_URL
```
    正式服务器URL。
    
    另请参阅:
    常量字段值
  - HTTPS_URL_TEST
```
public static final String HTTPS_URL_TEST
```
    测试服务器URL。
    
    另请参阅:
    常量字段值
  - GET_PRODUCT_API
```
public static final String GET_PRODUCT_API
```
    获取指定流量产品的API路径。
    
    另请参阅:
    常量字段值
  - GET_BALANCE_API
```
public static final String GET_BALANCE_API
```
    获取账户余额的API路径。
    
    另请参阅:
    常量字段值
  - FIND_PRODUCT_API
```
public static final String FIND_PRODUCT_API
```
    查找产品的API路径。
    
    另请参阅:
    常量字段值
  - BUY_API
```
public static final String BUY_API
```
    购买产品的API路径。
    
    另请参阅:
    常量字段值
  - GET_ORDER_API
```
public static final String GET_ORDER_API
```
    获取指定流量产品的API路径。
    
    另请参阅:
    常量字段值
  - FIND_ORDER_API
```
public static final String FIND_ORDER_API
```
    查找订单的API路径。
    
    另请参阅:
    常量字段值
- 构造器详细资料
  - EggFlow
```
public EggFlow(String url,
       String appId,
       String appSecret)
```
    构造函数。
    
    参数:
    url - 接口地址。正式生产使用 EggFlow.URL，测试时使用 EggFlow.URL_TEST。注意正式生产用服务器会限制只允许合法IP地址接入，需要在后台正确配置IP地址。
    appId - 应用接入ID。接入商提供，不可修改。注意正式生产用服务器与测试服务器上的值可能不一样，需要配对使用。
    appSecret - 应用API密钥。可通过后台系统自行修改。
- 方法详细资料
  - getProduct
```
public ProductResponse getProduct(String productId)
```
    获取指定的产品信息。
    
    参数:
    productId - 产品ID。
    
    返回:
    返回服务器返回数据的实体类对象。
  - getProduct
```
public ProductResponse getProduct(String mobile,
                         int amount)
```
    通过手机号和流量包大小获取指定的产品信息。
    
    参数:
    mobile - 产品适用的手机号。
    amount - 流量产品的流量大小，单位为MB。
    
    返回:
    返回服务器返回数据的实体类对象。
  - findProducts
```
public ProductsResponse findProducts()
```
    查询所有可用流量包。
    
    返回:
    返回服务器返回数据的实体类对象。
  - findProducts
```
public ProductsResponse findProducts(String mobile)
```
    查询可用流量包。
    
    参数:
    mobile - 产品适用的手机号，不提供则查询所有可购买的流量包。
    
    返回:
    返回服务器返回数据的实体类对象。
  - buy
```
public OrderResponse buy(int amount,
                Scope scope,
                String mobile,
                EggAdcEffectRule effect,
                String orderId,
                String callbackUrl)
```
    订购流量包。
    
    参数:
    amount - 订购的流量包MB数量（必须）。
    scope - 适用范围（必需）。
    mobile - 充值的手机号（必须）。
    effect - 流量生效模式（必须）。
    orderId - 自定义订单ID（可选，不指定时输入null）。
    callbackUrl - 自定义回调地址（可选，不指定时输入null）。
    
    返回:
    返回服务器返回数据的实体类对象。
  - getOrder
```
public OrderResponse getOrder(String orderId)
```
    查找指定id的订单。
    
    参数:
    orderId - 订单Id。
    
    返回:
    返回服务器返回数据的实体类对象。
  - findOrders
```
public OrdersResponse findOrders(String mobile,
                        String productId,
                        int pageNo,
                        int pageSize)
```
    按条件查询多个订单。
    
    参数:
    mobile - 要查询的手机号码。
    productId - 要查询的产品Id。
    pageNo - 返回第几页数据。
    pageSize - 每页数据条数。
    
    返回:
    返回服务器返回数据的实体类对象。
  - getBalance
```
public BalanceResponse getBalance()
```
    获取账户余额。
    
    返回:
    返回服务器返回数据的实体类对象。
  - callbackCheckSign
```
public boolean callbackCheckSign(String sign,
                        String orderId,
                        int status,
                        String msg)
```
    处理结果回调签名检查方法。
    
    参数:
    sign - 回调时提交的签名值。
    orderId - 回调时提交的订单Id。
    status - 回调时提交的处理状态。
    msg - 回调时提交的错误信息。
    
    返回:
    签名值正确返回true，否则返回false。
  - callbackCheckSign
```
public boolean callbackCheckSign(String sign,
                        String orderId,
                        String status,
                        String msg)
```
    处理结果回调签名检查方法。
    
    参数:
    sign - 回调时提交的签名值。
    orderId - 回调时提交的订单Id。
    status - 回调时提交的处理状态。
    msg - 回调时提交的错误信息。
    
    返回:
    签名值正确返回true，否则返回false。

类 EggFlow

字段概要

构造器概要

方法概要

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

字段详细资料

URL

URL_TEST

HTTPS_URL

HTTPS_URL_TEST

GET_PRODUCT_API

GET_BALANCE_API

FIND_PRODUCT_API

BUY_API

GET_ORDER_API

FIND_ORDER_API

构造器详细资料

EggFlow

方法详细资料

getProduct

getProduct

findProducts

findProducts

buy

getOrder

findOrders

getBalance

callbackCheckSign

callbackCheckSign