金融魔方紅包接入文檔
一 使用說明
- 版本號1.4.0荤西，更新時(shí)間2016年12月13日
- 該文檔真對studio集成妇菱，若您使用的是eclipse開發(fā)工具，請參照studio2eclipse文檔把該項(xiàng)目轉(zhuǎn)化成eclipse項(xiàng)目
- 該項(xiàng)目包含jrmfbaselib和jrmfrplib接入示例jrmfrpdemo。
- Support-v4-21 以上歧斟。
二 產(chǎn)品功能說明
????????金融魔方紅包依賴庫是一款實(shí)現(xiàn)App快速集成發(fā)單聊紅包、發(fā)群聊紅包偏形、拆紅包并查看交易記錄等功能的庫静袖。該類庫支持支付寶第三方付款，類庫中已經(jīng)引入了支付寶的jar包俊扭，您只需要在您的Manifest文檔中配置支付寶的的參數(shù)信息即可队橙，下面會有詳細(xì)介紹。
三 集成步驟
-
把jrmfbaselib 和jrmfrplib以module的形式導(dǎo)入您的項(xiàng)目中萨惑，點(diǎn)擊File->New->import module捐康，打開如下頁面：
Markdown - 選擇路徑，找到下載好的jrmfbaselib,jrmfrplib點(diǎn)擊finish庸蔼，把這兩個庫分別導(dǎo)入到您的工程中解总。
- jrmfbaselib包含了金融魔方所有產(chǎn)品共同的工具類、自定義view等內(nèi)容姐仅，故jrmfrplib必須依賴jrmfbaselib
四 使用詳解
- 發(fā)單個紅包花枫，發(fā)群聊紅包，搶單聊紅包掏膏，搶群紅包劳翰，查看交易記錄以及更新用戶信息（頭像和昵稱）功能都由JrmfRpClient提供
???????功能示例
???????<font color = "blue">發(fā)群紅包</font>
/**
* 打開發(fā)送群組紅包界面
*
* @param context
* 【必傳】上下文對象
* @param targetId
* 【必傳】目標(biāo)ID(會話ID)
* @param userid
* 【必傳】用戶ID|當(dāng)前用戶ID
* @param thirdToken
* 【必傳】第三方的簽名,需要用戶自己傳遞過來
* @param groupNum
* 【必傳】群組人數(shù)
* @param username
* 【可為NULL或""】用戶昵稱
* @param usericon
* 【可為NULL或""】用戶頭像URL
* @param requestCode
* 【必傳】在onActivityResult方法中回調(diào)
*/
public static void sendGroupEnvelopeForResult(Context context, String
targetId, String userid, String thirdToken, int groupNum,
String username, String usericon, int requestCode);
???????<font color = "blue">發(fā)單聊紅包</font>
/**
* 打開發(fā)送單聊紅包界面
*
* @param context
* 【必傳】上下文對象
* @param targetId
* 【必傳】目標(biāo)ID(單聊會話ID)
* @param userid
* 【必傳】用戶ID|當(dāng)前用戶ID
* @param thirdToken
* 【必傳】第三方簽名,需要用戶傳遞過來
* @param username
* 【可為NULL或""】用戶昵稱
* @param usericon
* 【可為NULL或""】用戶頭像URL
* @param requestCode
* 【必傳】在onActivityResult方法中回調(diào)
*/
public static void sendSingleEnvelopeForResult(Context context,
String targetId, String userid, String thirdToken, String username,
String usericon, int requestCode)
???????<font color = "blue">查看紅包詳情</font>
/**
* 打開紅包詳情
*
* @param fromActivity
* [必傳] 上下文
* @param userId
* [必傳] 用戶id
* @param thirdToken
* [必傳] 第三方簽名
* @param rpId
* [必傳] 紅包id
* @param username
* [可為空] 用戶昵稱
* @param usericon
* [可為空] 用戶頭像
*/
public static void openRpDetail(Activity fromActivity,
String userId, String thirdToken, String rpId, String username,
String usericon);
???????<font color = "blue">搶群紅包</font>
/**
* 搶群紅包
*
* @param activity
* [必傳] 上下文
* @param userid
* [必傳] 用戶id
* @param thirdToken
* [必傳] 第三方簽名,由客戶傳遞過來
* @param username
* [可為空] 用戶姓名
* @param usericon
* [可為空] 用戶頭像
* @param envelopeId
* [必傳] 紅包id
* @param callBack
* [必傳] 搶紅包回調(diào)接口
*/
public static void openGroupRp(FragmentActivity activity, String userid, String thirdToken, String username, String usericon,
String envelopeId,GrabRpCallBack callBack);
???????<font color = "blue">搶單聊紅包</font>
/**
* 打開單聊紅包
*
* @param activity
* [必傳] 上下文
* @param userid
* [必傳] 用戶id
* @param thirdToken
* [必傳] 第三方簽名,由客戶傳遞過來
* @param username
* [可為空] 用戶姓名
* @param usericon
* [可為空] 用戶頭像
* @param envelopeId
* [必傳] 紅包id
* @param callBack
* [必傳] 搶紅包回調(diào)接口
*/
public static void openSingleRp( FragmentActivity activity,
String userid, String thirdToken, String username, String usericon,
String envelopeId, GrabRpCallBack callBack);
???????<font color = "blue">交易記錄</font>
/**
* 打開查看交易記錄
*
* @param fromActivity
* [必傳] 上下文
* @param userId
* [必傳] 用戶id
* @param thirdToken
* [必傳] 第三方簽名
*/
public static void openTradeHistory(Activity fromActivity,
String userId, String thirdToken);
???????<font color = "blue">更新用戶信息</font>
/**
* 更新用戶信息接口 此接口需要開發(fā)者自己回調(diào)處理
*
* @param custUid
* 【必傳】用戶ID|當(dāng)前用戶ID
* @param thirdToken
* 【必傳】第三方簽名需要客戶傳遞過來
* @param nickName
* 【必傳】將要更新的用戶昵稱
* @param avatar
* 【必傳】將要更新的用戶頭像URL
*/
public static String updateUserInfo(String custUid,
String thirdToken, String nickName, String avatar);
???????<font color = "blue">搶紅包的回調(diào)接口 GrabRpCallBack</font>
@Override
public void grabRpResult(int rpStatus) {
//只有搶到紅包才會回調(diào)這個方法,返回0,表示搶到了最后一個紅包;
//返回1,表示搶到了一個紅包,但不是最后一個；只有這兩種返回結(jié)果壤追。
if (rpStatus == 0){
//搶到了最后一個紅包
ToastUtil.showToast(RedPacketActivity.this,"搶到了最后一個紅包");
}else if(rpStatus == 1){
//搶到了一個紅包
ToastUtil.showToast(RedPacketActivity.this,"搶到了一個紅包");
}
}
???????<font color = "blue">發(fā)紅包通過請求碼在onActivityResult中處理回調(diào)</font>
/**
* 發(fā)紅包成功的回調(diào)
* @param requestCode
* @param resultCode
* @param data
*/
@Override protected void onActivityResult(int requestCode, int
resultCode, Intent data) {
super.onActivityResult(requestCode, resultCode, data);
switch (requestCode) {
case SEND_GROUP:
if (resultCode == RESULT_OK) {
groupRpBean = JrmfRpClient.getEnvelopeInfo(data);
}
break;
case SEND_SINGLE:
// 發(fā)了單聊紅包
if (resultCode == RESULT_OK) {
singleRpbean = JrmfRpClient.getEnvelopeInfo(data);
}
break;
}
}
發(fā)紅包成功過后會返回
envelopesID 紅包id
envelopeMessage 紅包祝福語［例如：恭喜發(fā)財(cái)磕道，大吉大利］
envelopeName 紅包名字
- 渠道和紅包名字配置：渠道是我司給客戶分配的唯一識別id；紅包名字為用戶發(fā)紅包時(shí)顯示的名稱行冰，客戶根據(jù)自己的需求來命名
<font color = "red"> 注意：如果您使用了其它金融魔方的產(chǎn)品溺蕉，已經(jīng)配置了渠道id，就無需再配置了</font>
<!--金融魔方渠道,huanqiu為我們的測試渠道-->
<meta-data
android:name="JRMF_PARTNER_ID"
android:value="huanqiu"/>
<!-- 金融魔方 紅包名字 如果您使用的紅包的SDK需要配置,
如果沒有使用則不用配置 -->
<meta-data
android:name="JRMF_PARTNER_NAME"
android:value="測試紅包"/>
- 初始化項(xiàng)目
?????您需要再您自定義的Application中初始化金融魔方的類庫,示例代碼如下：
public class MyApplication extends Application {
@Override public void onCreate() {
super.onCreate();
//用戶可以調(diào)用該方法進(jìn)行測試環(huán)境悼做，正式環(huán)境切換疯特；默認(rèn)是正式環(huán)境
//設(shè)置為測試環(huán)境
JrmfClient.isDebug(true);
//初始化項(xiàng)目-必須調(diào)用
JrmfClient.init(this);
}
}
好啦，所有的功能介紹完了肛走，而且demo中還有詳細(xì)的使用方式漓雅，大家可以打開看看。
