mirror of
https://gitee.com/binary/weixin-java-tools.git
synced 2026-03-10 00:13:40 +08:00
🎨 批量添加部分javadoc
This commit is contained in:
Binary Wang
@@ -15,8 +15,7 @@ import java.util.List;
|
||||
* 官方文档：
|
||||
* https://developer.work.weixin.qq.com/document/path/91552
|
||||
*
|
||||
* @author <a href="https://github.com/0katekate0">Wang_Wong</a>
|
||||
* created on 2022-01-17
|
||||
* @author <a href="https://github.com/0katekate0">Wang_Wong</a> created on 2022-01-17
|
||||
*/
|
||||
@Slf4j
|
||||
public class Finance {
|
||||
@@ -26,130 +25,182 @@ public class Finance {
|
||||
private static final String SO_FILE = "so";
|
||||
private static final String DLL_FILE = "dll";
|
||||
|
||||
public native static long NewSdk();
|
||||
/**
|
||||
* New sdk long.
|
||||
*
|
||||
* @return the long
|
||||
*/
|
||||
public native static long NewSdk();
|
||||
|
||||
/**
|
||||
* 初始化函数
|
||||
* Return值=0表示该API调用成功
|
||||
*
|
||||
* @param [in] sdk NewSdk返回的sdk指针
|
||||
* @param [in] corpid 调用企业的企业id，例如：wwd08c8exxxx5ab44d，可以在企业微信管理端--我的企业--企业信息查看
|
||||
* @param [in] secret 聊天内容存档的Secret，可以在企业微信管理端--管理工具--聊天内容存档查看
|
||||
* @return 返回是否初始化成功
|
||||
* 0 - 成功
|
||||
* !=0 - 失败
|
||||
*/
|
||||
public native static int Init(long sdk, String corpid, String secret);
|
||||
/**
|
||||
* 初始化函数
|
||||
* Return值=0表示该API调用成功
|
||||
*
|
||||
* @param sdk the sdk
|
||||
* @param corpid the corpid
|
||||
* @param secret the secret
|
||||
* @return 返回是否初始化成功 0 - 成功 !=0 - 失败
|
||||
*/
|
||||
public native static int Init(long sdk, String corpid, String secret);
|
||||
|
||||
/**
|
||||
* 拉取聊天记录函数
|
||||
* Return值=0表示该API调用成功
|
||||
*
|
||||
* @param [in] sdk NewSdk返回的sdk指针
|
||||
* @param [in] seq 从指定的seq开始拉取消息，注意的是返回的消息从seq+1开始返回，seq为之前接口返回的最大seq值。首次使用请使用seq:0
|
||||
* @param [in] limit 一次拉取的消息条数，最大值1000条，超过1000条会返回错误
|
||||
* @param [in] proxy 使用代理的请求，需要传入代理的链接。如：socks5://10.0.0.1:8081 或者 http://10.0.0.1:8081
|
||||
* @param [in] passwd 代理账号密码，需要传入代理的账号密码。如 user_name:passwd_123
|
||||
* @param [out] chatDatas 返回本次拉取消息的数据，slice结构体.内容包括errcode/errmsg，以及每条消息内容。
|
||||
* @return 返回是否调用成功
|
||||
* 0 - 成功
|
||||
* !=0 - 失败
|
||||
*/
|
||||
public native static int GetChatData(long sdk, long seq, long limit, String proxy, String passwd, long timeout, long chatData);
|
||||
/**
|
||||
* 拉取聊天记录函数
|
||||
* Return值=0表示该API调用成功
|
||||
*
|
||||
* @param sdk the sdk
|
||||
* @param seq the seq
|
||||
* @param limit the limit
|
||||
* @param proxy the proxy
|
||||
* @param passwd the passwd
|
||||
* @param timeout the timeout
|
||||
* @param chatData the chat data
|
||||
* @return 返回是否调用成功 0 - 成功 !=0 - 失败
|
||||
*/
|
||||
public native static int GetChatData(long sdk, long seq, long limit, String proxy, String passwd, long timeout, long chatData);
|
||||
|
||||
/**
|
||||
* 拉取媒体消息函数
|
||||
* Return值=0表示该API调用成功
|
||||
*
|
||||
* @param [in] sdk NewSdk返回的sdk指针
|
||||
* @param [in] sdkFileid 从GetChatData返回的聊天消息中，媒体消息包括的sdkfileid
|
||||
* @param [in] proxy 使用代理的请求，需要传入代理的链接。如：socks5://10.0.0.1:8081 或者 http://10.0.0.1:8081
|
||||
* @param [in] passwd 代理账号密码，需要传入代理的账号密码。如 user_name:passwd_123
|
||||
* @param [in] indexbuf 媒体消息分片拉取，需要填入每次拉取的索引信息。首次不需要填写，默认拉取512k，后续每次调用只需要将上次调用返回的outindexbuf填入即可。
|
||||
* @param [out] media_data 返回本次拉取的媒体数据.MediaData结构体.内容包括data(数据内容)/outindexbuf(下次索引)/is_finish(拉取完成标记)
|
||||
* @return 返回是否调用成功
|
||||
* 0 - 成功
|
||||
* !=0 - 失败
|
||||
*/
|
||||
public native static int GetMediaData(long sdk, String indexbuf, String sdkField, String proxy, String passwd, long timeout, long mediaData);
|
||||
/**
|
||||
* 拉取媒体消息函数
|
||||
* Return值=0表示该API调用成功
|
||||
*
|
||||
* @param sdk the sdk
|
||||
* @param indexbuf the indexbuf
|
||||
* @param sdkField the sdk field
|
||||
* @param proxy the proxy
|
||||
* @param passwd the passwd
|
||||
* @param timeout the timeout
|
||||
* @param mediaData the media data
|
||||
* @return 返回是否调用成功 0 - 成功 !=0 - 失败
|
||||
*/
|
||||
public native static int GetMediaData(long sdk, String indexbuf, String sdkField, String proxy, String passwd, long timeout, long mediaData);
|
||||
|
||||
/**
|
||||
* @param [in] encrypt_key, getchatdata返回的encrypt_key
|
||||
* @param [in] encrypt_msg, getchatdata返回的content
|
||||
* @param [out] msg, 解密的消息明文
|
||||
* @return 返回是否调用成功
|
||||
* 0 - 成功
|
||||
* !=0 - 失败
|
||||
* @brief 解析密文
|
||||
*/
|
||||
public native static int DecryptData(long sdk, String encrypt_key, String encrypt_msg, long msg);
|
||||
/**
|
||||
* Decrypt data int.
|
||||
*
|
||||
* @param sdk the sdk
|
||||
* @param encrypt_key the encrypt key
|
||||
* @param encrypt_msg the encrypt msg
|
||||
* @param msg the msg
|
||||
* @return 返回是否调用成功 0 - 成功 !=0 - 失败
|
||||
* @brief 解析密文
|
||||
*/
|
||||
public native static int DecryptData(long sdk, String encrypt_key, String encrypt_msg, long msg);
|
||||
|
||||
public native static void DestroySdk(long sdk);
|
||||
/**
|
||||
* Destroy sdk.
|
||||
*
|
||||
* @param sdk the sdk
|
||||
*/
|
||||
public native static void DestroySdk(long sdk);
|
||||
|
||||
public native static long NewSlice();
|
||||
/**
|
||||
* New slice long.
|
||||
*
|
||||
* @return the long
|
||||
*/
|
||||
public native static long NewSlice();
|
||||
|
||||
/**
|
||||
* @return
|
||||
* @brief 释放slice，和NewSlice成对使用
|
||||
*/
|
||||
public native static void FreeSlice(long slice);
|
||||
/**
|
||||
* Free slice.
|
||||
*
|
||||
* @param slice the slice
|
||||
* @return
|
||||
* @brief 释放slice ，和NewSlice成对使用
|
||||
*/
|
||||
public native static void FreeSlice(long slice);
|
||||
|
||||
/**
|
||||
* @return 内容
|
||||
* @brief 获取slice内容
|
||||
*/
|
||||
public native static String GetContentFromSlice(long slice);
|
||||
/**
|
||||
* Get content from slice string.
|
||||
*
|
||||
* @param slice the slice
|
||||
* @return 内容 string
|
||||
* @brief 获取slice内容
|
||||
*/
|
||||
public native static String GetContentFromSlice(long slice);
|
||||
|
||||
/**
|
||||
* @return 内容
|
||||
* @brief 获取slice内容长度
|
||||
*/
|
||||
public native static int GetSliceLen(long slice);
|
||||
/**
|
||||
* Get slice len int.
|
||||
*
|
||||
* @param slice the slice
|
||||
* @return 内容 int
|
||||
* @brief 获取slice内容长度
|
||||
*/
|
||||
public native static int GetSliceLen(long slice);
|
||||
|
||||
public native static long NewMediaData();
|
||||
/**
|
||||
* New media data long.
|
||||
*
|
||||
* @return the long
|
||||
*/
|
||||
public native static long NewMediaData();
|
||||
|
||||
public native static void FreeMediaData(long mediaData);
|
||||
/**
|
||||
* Free media data.
|
||||
*
|
||||
* @param mediaData the media data
|
||||
*/
|
||||
public native static void FreeMediaData(long mediaData);
|
||||
|
||||
/**
|
||||
* @return outindex
|
||||
* @brief 获取mediadata outindex
|
||||
*/
|
||||
public native static String GetOutIndexBuf(long mediaData);
|
||||
/**
|
||||
* Get out index buf string.
|
||||
*
|
||||
* @param mediaData the media data
|
||||
* @return outindex string
|
||||
* @brief 获取mediadata outindex
|
||||
*/
|
||||
public native static String GetOutIndexBuf(long mediaData);
|
||||
|
||||
/**
|
||||
* @return data
|
||||
* @brief 获取mediadata data数据
|
||||
*/
|
||||
public native static byte[] GetData(long mediaData);
|
||||
/**
|
||||
* Get data byte [ ].
|
||||
*
|
||||
* @param mediaData the media data
|
||||
* @return data byte [ ]
|
||||
* @brief 获取mediadata data数据
|
||||
*/
|
||||
public native static byte[] GetData(long mediaData);
|
||||
|
||||
public native static int GetIndexLen(long mediaData);
|
||||
/**
|
||||
* Get index len int.
|
||||
*
|
||||
* @param mediaData the media data
|
||||
* @return the int
|
||||
*/
|
||||
public native static int GetIndexLen(long mediaData);
|
||||
|
||||
public native static int GetDataLen(long mediaData);
|
||||
/**
|
||||
* Get data len int.
|
||||
*
|
||||
* @param mediaData the media data
|
||||
* @return the int
|
||||
*/
|
||||
public native static int GetDataLen(long mediaData);
|
||||
|
||||
/**
|
||||
* @return 1完成、0未完成
|
||||
* @brief 判断mediadata是否结束
|
||||
*/
|
||||
public native static int IsMediaDataFinish(long mediaData);
|
||||
/**
|
||||
* Is media data finish int.
|
||||
*
|
||||
* @param mediaData the media data
|
||||
* @return 1完成 、0未完成
|
||||
* @brief 判断mediadata是否结束
|
||||
*/
|
||||
public native static int IsMediaDataFinish(long mediaData);
|
||||
|
||||
/**
|
||||
* 判断Windows环境
|
||||
*
|
||||
* @return
|
||||
*/
|
||||
public static boolean isWindows() {
|
||||
/**
|
||||
* 判断Windows环境
|
||||
*
|
||||
* @return boolean
|
||||
*/
|
||||
public static boolean isWindows() {
|
||||
String osName = System.getProperties().getProperty("os.name");
|
||||
log.info("Loading System Libraries, Current OS Version Is: {}", osName);
|
||||
return osName.toUpperCase().contains("WINDOWS");
|
||||
}
|
||||
|
||||
/**
|
||||
* 加载系统类库
|
||||
*
|
||||
* @param libFiles 类库配置文件
|
||||
* @param prefixPath 类库文件的前缀路径
|
||||
*/
|
||||
public Finance(List<String> libFiles, String prefixPath) {
|
||||
/**
|
||||
* 加载系统类库
|
||||
*
|
||||
* @param libFiles 类库配置文件
|
||||
* @param prefixPath 类库文件的前缀路径
|
||||
*/
|
||||
public Finance(List<String> libFiles, String prefixPath) {
|
||||
boolean isWindows = Finance.isWindows();
|
||||
for (String file : libFiles) {
|
||||
String suffix = file.substring(file.lastIndexOf(".") + 1);
|
||||
@@ -168,14 +219,14 @@ public class Finance {
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* 初始化类库文件
|
||||
*
|
||||
* @param libFiles
|
||||
* @param prefixPath
|
||||
* @return
|
||||
*/
|
||||
public synchronized static Finance loadingLibraries(List<String> libFiles, String prefixPath) {
|
||||
/**
|
||||
* 初始化类库文件
|
||||
*
|
||||
* @param libFiles the lib files
|
||||
* @param prefixPath the prefix path
|
||||
* @return finance
|
||||
*/
|
||||
public synchronized static Finance loadingLibraries(List<String> libFiles, String prefixPath) {
|
||||
if (finance != null) {
|
||||
return finance;
|
||||
}
|
||||
@@ -183,12 +234,12 @@ public class Finance {
|
||||
return finance;
|
||||
}
|
||||
|
||||
/**
|
||||
* 单例sdk
|
||||
*
|
||||
* @return
|
||||
*/
|
||||
public synchronized static long SingletonSDK() {
|
||||
/**
|
||||
* 单例sdk
|
||||
*
|
||||
* @return long
|
||||
*/
|
||||
public synchronized static long SingletonSDK() {
|
||||
if (sdk > 0) {
|
||||
return sdk;
|
||||
}
|
||||
@@ -196,12 +247,13 @@ public class Finance {
|
||||
return sdk;
|
||||
}
|
||||
|
||||
/**
|
||||
* 销毁sdk,保证线程可见性
|
||||
*
|
||||
* @return
|
||||
*/
|
||||
public synchronized static void DestroySingletonSDK(long destroySDK) {
|
||||
/**
|
||||
* 销毁sdk,保证线程可见性
|
||||
*
|
||||
* @param destroySDK the destroy sdk
|
||||
* @return
|
||||
*/
|
||||
public synchronized static void DestroySingletonSDK(long destroySDK) {
|
||||
sdk = 0L;
|
||||
Finance.DestroySdk(destroySDK);
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user