RTXServer SDK Java語(yǔ)言支持文檔

1、RTX Server SDK Java 語(yǔ)言開(kāi)發(fā)指導(dǎo)語(yǔ)言開(kāi)發(fā)指導(dǎo)目目 錄錄RTX Server SDK Java 語(yǔ)言開(kāi)發(fā)指導(dǎo) .1一、功能說(shuō)明.2二、配置環(huán)境.2三、文件說(shuō)明.3四、開(kāi)發(fā)向?qū)?以 Eclipse 為例).3五、接口說(shuō)明.51系統(tǒng)函數(shù).52擴(kuò)展函數(shù).7六、RTX2010 與 RTX3.61 Java 語(yǔ)言支持的差異 .11七、BUG 解決 .12一、功能說(shuō)明一、功能說(shuō)明RTX2010 Java SDK 可以實(shí)現(xiàn)以下五大功能：1 部門(mén)用戶(hù)管理(數(shù)據(jù)同步)，可以對(duì) RTX 服務(wù)器的部門(mén)及用戶(hù)進(jìn)行操作，通過(guò)該操作可以實(shí)現(xiàn)從其他系統(tǒng)同步用戶(hù)數(shù)據(jù)到 RTX 服務(wù)器。2 單點(diǎn)登錄，登錄 O

2、A 或 ERP 時(shí) RTX 客戶(hù)端自動(dòng)登錄，不需要輸入密碼。3 待辦事宜提醒,辦公提醒，郵件到達(dá)提醒、公文到達(dá)提醒等。4 手機(jī)短信，向手機(jī)發(fā)送、接收短信，群發(fā)短信。5 狀態(tài)推送，在網(wǎng)頁(yè)上顯示用戶(hù)狀態(tài)頭像，并可以對(duì)在線用戶(hù)發(fā)起會(huì)話(huà)。二、配置環(huán)境二、配置環(huán)境1 在開(kāi)發(fā)機(jī)器安裝 RTX2010 Server SDK 包。2 進(jìn)入 Server SDK 安裝目錄(默認(rèn)路徑：x:Program FilesTencentRTXSSDK)，把該目錄下的 dll 文件及 rtxServerApi.ini 拷貝到系統(tǒng)的 System32 目錄下（RTX2008Beta2 之后的 RTX 版本安裝時(shí)已經(jīng)自動(dòng)拷貝到

3、該目錄下），如果在網(wǎng)頁(yè)調(diào)用 java 接口，需要另拷貝一份到 JDK 的 bin 目錄下。3 進(jìn)入 RTX 服務(wù)器安裝目錄下，用記事本打開(kāi) SDKPorperty.xml 文件，在里面增加開(kāi)發(fā)機(jī)器地址(如下圖所示)，保存后重啟 RTX 服務(wù)。4 拷貝 Java 目錄(默認(rèn)路徑：x:Program FilesTencentRTXSSDKDemo SourceServer SampleJava)下的 RTXSvrApi.java 及其他示例文件到您的工作目錄下。三、文件說(shuō)明三、文件說(shuō)明1 RTXSvrApi.java 是一個(gè)類(lèi)庫(kù)，里面封裝了很多方法，但沒(méi)有 main 函數(shù)，因此該文件只能編譯不能運(yùn)

4、行，主要是提供方法給外部調(diào)用。2 RTXSvrApi.java 文件里面導(dǎo)入 SDKAPIJava.dll，該 dll 是在 SDKAPIC.dll 上面封裝，SDK 目錄下的 dll 相互有聯(lián)系，因此必須把這些 dll 拷貝到 System32 下，否則編譯 RTXSvrApi.java 將出錯(cuò)，提示找不到 SDKAPIC。3 Java 目錄下的文件除了 RTXSvrApi.java，其他的都是示例文件（請(qǐng)參看示例文件（請(qǐng)參看示例文件使用各種函數(shù)）使用各種函數(shù)） 。4 RtxServerApi.ini 文件用于設(shè)置服務(wù)器的 IP 地址及端口。5 SDKPorperty.xml 文件用于 SD

5、K 訪問(wèn) RTX 服務(wù)器權(quán)限管理，只有這個(gè)文件添加的IP 才能訪問(wèn) RTX 服務(wù)器。四、開(kāi)發(fā)向?qū)?、開(kāi)發(fā)向?qū)?以以 Eclipse 為例為例)1.啟動(dòng)Eclipse ，創(chuàng)建一個(gè)空白的 Java Project，如下圖所示：2.在工程 src 添加一個(gè)名為 rtx 的 package，并將 RTXSvrApi.java 拖進(jìn)這個(gè)package，如下圖所示： 注意：注意：RTXSvrApi.java 只能放進(jìn)只能放進(jìn) rtx 下，下，rtx 不能有父不能有父 package，否則會(huì)，否則會(huì)報(bào)錯(cuò)。報(bào)錯(cuò)。3. 把 SetSvrIpPort.java 拖到 src，自動(dòng)生成一個(gè)(defalt packa

6、ge)并放在這個(gè)目錄下，SvrIP 填寫(xiě)正確的 RTX 服務(wù)器 IP 地址后按 Ctrl+F11 運(yùn)行，如下圖所示：4. 把 AddDept.Java 拖到 src，自動(dòng)生成一個(gè)(defalt package)并放在這個(gè)目錄下，按 Ctrl+F11 運(yùn)行，如下圖所示：5. 進(jìn)入 RTX 用戶(hù)管理器，就可以看到剛剛添加的部門(mén)，如下圖所示：五、接口說(shuō)明五、接口說(shuō)明1系統(tǒng)函數(shù)系統(tǒng)函數(shù)語(yǔ)法：boolean Init()功能：初始化類(lèi)參數(shù)：無(wú)調(diào)用：Init()說(shuō)明：初始化 RTXSvrApi，成功返回 true，失敗返回 false語(yǔ)法：void UnInit()功能：析構(gòu)類(lèi)參數(shù)：無(wú)調(diào)用：Init()說(shuō)

7、明：析構(gòu) RTXSvrApi語(yǔ)法：int GetNewObject(String szObjectName)功能：獲取一個(gè)業(yè)務(wù)對(duì)象句柄參數(shù)：szObjectName 業(yè)務(wù)對(duì)象名稱(chēng)調(diào)用：GetNewObject(OBJNAME_RTXSYS)說(shuō)明：調(diào)用成功返回一個(gè)業(yè)務(wù)對(duì)象句柄語(yǔ)法：int GetNewPropertys()功能：獲取屬性集合句柄參數(shù)：無(wú)調(diào)用：GetNewPropertys()說(shuō)明：調(diào)用成功返回一個(gè)屬性合集的柄語(yǔ)法：int ReleaseHandle(int iHandle)功能：釋放句柄參數(shù)：iHandle 句柄調(diào)用：ReleaseHandle(iHandle) /iHandle

8、 是一個(gè)句柄說(shuō)明：調(diào)用成功釋放句柄語(yǔ)法：int AddProperty(int iPropertyHandle, String szName, String szValue)功能：向?qū)傩约咸砑訉傩詤?shù)：iPropertyHandle 屬性集合句柄，szName 屬性名，szValue 屬性值調(diào)用：AddProperty(iProp, KEY_USERNAME, UserName)說(shuō)明：調(diào)用成功向?qū)傩约咸砑右粋€(gè)屬性語(yǔ)法：int GetPropertysCount(int iHandle)功能：獲取屬性集合中屬性總數(shù)參數(shù)：iHandle 屬性集合句柄調(diào)用：GetPropertysCount(i

9、Handle)/iHandle 為屬性句柄說(shuō)明：調(diào)用成功返回屬性集合中的屬性總數(shù)語(yǔ)法：int GetPropertysItem(int iHandle, int iIndex)功能：通過(guò)索引獲取屬性集合中對(duì)應(yīng)的屬性參數(shù)：iHandle 屬性集合句柄，iIndex 索引值調(diào)用：GetPropertysItem(iHandle, i)/iHandle 為屬性句柄，i 為索引說(shuō)明：調(diào)用成功返回屬性句柄語(yǔ)法：int Call(int iObjectHandle, int iPropertyHandle, int iCmdID)功能：調(diào)用 SDK參數(shù)：iObjectHandle 業(yè)務(wù)對(duì)象句柄，iProp

10、ertyHandle 屬性集合句柄，iCmdID 命令號(hào)調(diào)用：Call(iObjectHandle, iPropertyHandle, iCmdID)說(shuō)明：調(diào)用成功返回一個(gè)結(jié)果句柄語(yǔ)法：int GetResultPropertys(int iResultHandle)功能：從結(jié)果句柄得到一個(gè)屬性集合句柄參數(shù)：iResultHandle 結(jié)果句柄調(diào)用：GetResultPropertys(int iResultHandle)說(shuō)明：調(diào)用成功返回屬性集合句柄語(yǔ)法：String GetPropertyItemName(int iHandle)功能：獲取一個(gè)屬性的名稱(chēng)參數(shù)：iHandle 屬性句柄調(diào)用：

11、GetPropertyItemName(iHandle)說(shuō)明：調(diào)用成功返回屬性句柄對(duì)應(yīng)的屬性名語(yǔ)法：String GetPropertyItemValue(int iHandle)功能：獲取一個(gè)屬性的值參數(shù)：iHandle 屬性句柄調(diào)用：GetPropertyItemName(iHandle)說(shuō)明：調(diào)用成功返回屬性句柄對(duì)應(yīng)的屬性值語(yǔ)法：int GetResultInnerCode(int iHandle)功能：獲取內(nèi)部錯(cuò)誤代碼參數(shù)：iHandle 返回結(jié)果句柄調(diào)用：GetResultInnerCode(int iHandle)說(shuō)明：獲取返回結(jié)果錯(cuò)誤代碼,返回 0 表示調(diào)用成功，返回其他表示出錯(cuò)

12、語(yǔ)法：String GetResultErrString(int iHandle)功能：獲取內(nèi)部錯(cuò)誤信息參數(shù)：iHandle 返回結(jié)果句柄調(diào)用：GetResultInnerCode(iHandle)說(shuō)明：返回錯(cuò)誤描述2擴(kuò)展函數(shù)擴(kuò)展函數(shù)/ 配置文件操作語(yǔ)法：void setServerIP(String strIP)功能：設(shè)置服務(wù)器 IP參數(shù)：strIP 為 RTX 服務(wù)器 IP 地址調(diào)用：setServerIP(“”)說(shuō)明：調(diào)用成功將設(shè)置 System32 下 rtxServerApi.ini 的 host 為指定的 IP 地址語(yǔ)法：void setServerPort(in

13、t iPort)功能：設(shè)置服務(wù)器端口參數(shù)：iPort 為 RTX 服務(wù)器 SDK 服務(wù)器端口，默認(rèn)為 6000調(diào)用：setServerPort(6000)說(shuō)明：調(diào)用成功將設(shè)置 System32 下 rtxServerApi.ini 的 Port 為指定的端口語(yǔ)法：String getServerIP()功能：獲取服務(wù)器地址參數(shù)：無(wú)調(diào)用：getServerIP()說(shuō)明：調(diào)用成功將返回 System32 下 rtxServerApi.ini 的 IP 地址語(yǔ)法：void getServerPort()功能：設(shè)置服務(wù)器端口參數(shù)：無(wú)調(diào)用：getServerIP()說(shuō)明：調(diào)用成功將設(shè)置 System32

14、 下 rtxServerApi.ini 的端口/ 部門(mén)數(shù)據(jù)操作語(yǔ)法：int addDept(String deptId,String DetpInfo,String DeptName,String ParentDeptId )功能：添加部門(mén)參數(shù)：deptId 部門(mén) ID、DetpInfo 部門(mén)信息、DeptName 部門(mén)名稱(chēng)、ParentDeptId 父部門(mén)ID調(diào)用：addDept (“1”,”測(cè)試部門(mén)信息”,”測(cè)試部門(mén)”,”0”)說(shuō)明：成功返回 0，失敗返回其他。語(yǔ)法：setDept(String deptId,String DetpInfo,String DeptName,String P

15、arentDeptId )功能：修改部門(mén)參數(shù)：deptId 部門(mén) ID、DetpInfo 部門(mén)信息、DeptName 部門(mén)名稱(chēng)、ParentDeptId 父部門(mén)ID調(diào)用：setDept (“1”,”測(cè)試部門(mén)信息”,”財(cái)務(wù)部”,”0”)說(shuō)明：成功返回 0，失敗返回其他。語(yǔ)法：deleteDept(String deptId,String type)功能：刪除部門(mén)參數(shù)：deptId 部門(mén) ID、type 刪除類(lèi)型（0 為不刪除部門(mén)下用戶(hù)，1 為刪除部門(mén)下用戶(hù)）調(diào)用：deleteDept (“1”,”1”)說(shuō)明：成功返回 0，失敗返回其他。語(yǔ)法：int deptIsExist(String dept

16、Id)功能：查看部門(mén)是否存在參數(shù)：deptId 部門(mén) ID調(diào)用：deleteDept (“1”)說(shuō)明：成功返回 0，失敗返回其他。語(yǔ)法：String getDeptUsers(String DeptID)功能：獲取部門(mén)下用戶(hù)參數(shù)：deptId 部門(mén) ID調(diào)用：getDeptUsers (“1”)說(shuō)明：成功返回 String的用戶(hù)數(shù)組，失敗返回 null。語(yǔ)法：StringgetChildDepts(String DeptID)功能：獲取子部門(mén)列表參數(shù)：deptId 部門(mén) ID調(diào)用：getChildDepts (“0”)說(shuō)明：成功返回 String的子部門(mén) ID 數(shù)組，失敗返回 null。/用戶(hù)

17、數(shù)據(jù)操作語(yǔ)法：int addUser(String UserName, String DeptID, String ChsName, String Pwd )功能：添加用戶(hù)參數(shù)：UserName 用戶(hù)帳號(hào)、DeptID 部門(mén) ID、ChsName 用戶(hù)姓名、ChsName 密碼調(diào)用：addUser(“herolin”, “1”, “林堅(jiān)華”, “123” )說(shuō)明：返回 0 表示成功，其他表示失敗語(yǔ)法：int deleteUser(String UserName)功能：刪除用戶(hù)參數(shù)：UserName 用戶(hù)帳號(hào)調(diào)用：deleteUser (“herolin”)說(shuō)明：返回 0 表示成功，其他表示失敗

18、語(yǔ)法：int userIsExist (String UserName)功能：查看用戶(hù)是否存在參數(shù)：UserName 用戶(hù)帳號(hào)調(diào)用：userIsExist (“herolin”)說(shuō)明：成功返回 0，失敗返回其他。語(yǔ)法：String GetUserSimpleInfo(String UserName)功能：查看用戶(hù)簡(jiǎn)單資料參數(shù)：UserName 用戶(hù)帳號(hào)調(diào)用：GetUserSimpleInfo (“herolin” )說(shuō)明：調(diào)用成功返回一個(gè) String 類(lèi)型的二維數(shù)組，失敗返回 null語(yǔ)法：int SetUserSimpleInfo(String UserName,String ChsNam

19、e,String email,String gender,String mobile,String phone,String pwd)功能：設(shè)置用戶(hù)簡(jiǎn)單資料參數(shù)：UserName 用戶(hù)帳號(hào)、ChsName 用戶(hù)姓名、email 郵箱地址、gender 性別、mobile 手機(jī)、pwd 密碼調(diào)用：SetUserSimpleInfo(“herolin”, “林堅(jiān)華”, “”,”0”,”135101435x”, 4”, “123”)說(shuō)明：成功返回 0，失敗返回其他。語(yǔ)法：int SetUserSimpleInfoEx(String UserName, String De

20、ptID, String ChsName,String email,String gender,String mobile,String phone,String pwd)功能：設(shè)置用戶(hù)簡(jiǎn)單資料參數(shù)：UserName 用戶(hù)帳號(hào)、DeptID 部門(mén) ID、ChsName 用戶(hù)姓名、email 郵箱地址、gender 性別、mobile 手機(jī)、pwd 密碼調(diào)用：SetUserSimpleInfo(“herolin”, 2,“林堅(jiān)華”, “”,”0”,”135101435x”, 4”, “123”)說(shuō)明：成功返回 0，失敗返回其他。語(yǔ)法：StringGetUserDet

21、ailInfo (String UserName)功能：查看用戶(hù)詳細(xì)資料參數(shù)：UserName 用戶(hù)帳號(hào)調(diào)用：GetUserDetailInfo (“herolin” )說(shuō)明：調(diào)用成功返回一個(gè) String 類(lèi)型的二維數(shù)組，失敗返回 null語(yǔ)法：int setUserDetailInfo(String UserName,String ADDRESS,String AGE,String BIRTHDAY, String BLOODTYPE,String CITY,String COLLAGE,String CONSTELLATION,String COUNTRY,String FAX, Str

22、ing HOMEPAGE,String MEMO,String POSITION,String POSTCODE,String PROVINCE,String STREET, String PHONE,String MOBILE)功能：設(shè)置用戶(hù)詳細(xì)資料參數(shù)：UserName 用戶(hù)帳號(hào)、ADDRESS 地址、AGE 年齡、BIRTHDAY 生日、BLOODTYPE 血型、CITY 城市、COLLAGE 大學(xué)、CONSTELLATION 星座、COUNTRY國(guó)家、FAX 傳真、HOMEPAGE 個(gè)人主頁(yè)、MEMO 個(gè)人說(shuō)明、POSITION 職位、PROVINCE 省份、STREET 街道、PHO

23、NE 電話(huà)、MOBILE 手機(jī)調(diào)用：setUserDetailInfo(“herolin”, “深圳市 xx 街道”, “23”, “19840201”, “1”,”深圳”, “深大”, “9”, “中國(guó)”, 9”, “”, “沒(méi)有個(gè)人說(shuō)明”, “員工”, “510650”, “廣東省”, “xx 街”, 4”, “1351014353x”)說(shuō)明：成功返回 0，失敗返回其他。/SessionKey操作語(yǔ)法：String getSessionKey(String UserName)功能：獲取 SessionKey參數(shù)：UserName

24、用戶(hù)帳號(hào)調(diào)用：getSessionKey (“herolin”)說(shuō)明：成功返回 String 類(lèi)型的 SessionKey，失敗返回 null。/消息提醒語(yǔ)法：int sendNotify(String receivers,String title,String msg, String type,String delayTime)功能：發(fā)送消息提醒 參數(shù)：receivers 接收者、title 標(biāo)題、msg 信息內(nèi)容、type 消息類(lèi)型、delayTime 顯示時(shí)間調(diào)用：sendNotify (“herolin”,”公司公文”,”xx 同事升級(jí) xx 部門(mén)總經(jīng)理”,”0”,”0”)說(shuō)明：成功返

25、回 0，失敗返回其他。/發(fā)送短信語(yǔ)法：int sendSms(String sender, String receiver, String smsInfo,int autoCut, int noTitle)功能：發(fā)送手機(jī)短信 參數(shù)：sender 發(fā)送者、receiver 接收者、smsInfo 短信內(nèi)容、autoCut 是否自動(dòng)拆分、noTitle 是否有標(biāo)題調(diào)用：sendSms(“herolin”, , “SDK 短信測(cè)試”, “1”, “0”)說(shuō)明：成功返回 0，失敗返回其他。/導(dǎo)入導(dǎo)出用戶(hù)數(shù)據(jù)語(yǔ)法：int exportXmldata ()功能：導(dǎo)出 RTX 用戶(hù)

26、數(shù)據(jù)為 xml 參數(shù)：無(wú)調(diào)用：exportXmldata ()說(shuō)明：成功返回 String 類(lèi)弄的 xml 字符串，失敗返回 null。語(yǔ)法：int importXmldata(String xmldata)功能：導(dǎo)入 xml 用戶(hù)數(shù)據(jù)到 RTX 服務(wù)器參數(shù)：xmldata xml 格式用戶(hù)數(shù)據(jù)調(diào)用：importXmldata(xmldata)/xmldata 為 xml 格式的 RTX 用戶(hù)數(shù)據(jù)說(shuō)明：成功返回 String 類(lèi)弄的 xml 字符串，失敗返回 null。/查看用戶(hù)在線狀態(tài)語(yǔ)法：int QueryUserState(String UserName)功能：查看用戶(hù)狀態(tài)參數(shù)：User

27、Name 用戶(hù)帳號(hào)調(diào)用：QueryUserState(“herolin”)說(shuō)明：返回 0 離線、1 在線、2 離開(kāi)、-984 用戶(hù)不存在，其他表示調(diào)用失敗/根據(jù)部門(mén)ID查部門(mén)名稱(chēng)語(yǔ)法：String GetDeptName(String deptID)功能：查部門(mén)名稱(chēng)參數(shù)：deptID 用戶(hù)帳號(hào)調(diào)用：GetDeptName(“2”)說(shuō)明：成功返回 String 類(lèi)型的部門(mén)名稱(chēng)，失敗返回 null。六、六、RTX2010 與與 RTX3.61 Java 語(yǔ)言支持的差異語(yǔ)言支持的差異1 RTX2010 支持一個(gè)用戶(hù)所屬多個(gè)部門(mén)， 因此有可能出現(xiàn)用戶(hù)所屬部門(mén) ID 為兩個(gè)以上,所以通過(guò) SDK 查看用戶(hù)簡(jiǎn)單資料時(shí)，返回 DeptID 帶有 “；”，主要用于區(qū)分多個(gè)部門(mén) ID。2 RTX 2010 Server 強(qiáng)加了 SDK 訪問(wèn)安性,因此通過(guò) http 方式訪問(wèn) cgi