布谷鸟二次开发接口说明.doc

布谷鸟2010二次开发接口说明(SDK R3.0)平台:.netFramework2.0森森工作室http:布谷鸟客户端插件用法2客户端插件用法:3服务器端插件用户:3客户端标准插件接口3客户端标准插件接口3属性:3方法4事件4接口代码:4客户端通讯接口7属性:7方法7事件7接口代码:8客户端文件发送接口10属性:10方法10事件10接口代码:10布谷鸟客户端多页面接口:12属性:12方法12接口代码:12布谷鸟客户端多页面Web浏览接口:14属性:14方法14事件14接口代码:15布谷鸟服务器端插件接口:17属性:17方法17事件17接口代码:18服务器端系统消息组件进行消息发送:20说明:20使用方法:20布谷鸟客户端插件用法1. 插件开发使用.net平台2. SisenMESS-Interface.dll文件是接口，在程序中需要引用3. Guid生成器.exe用于生成Guid编号，每个模块都需要用一个Guid做为标识。以免和其它插件产生冲突。客户端插件用法:客户端插件生成后，复制到布谷鸟客户端目录下的“plug_ins”目录中便可进行使用;如果您开发的插件还有其它DLL或文件，请复制到“plug_ins”目录下的” Abet_File”目录中去。服务器端插件用户:服务器端插件生成后，复制到布谷鸟服务器端目录下的“Server_Plug_in”目录中去；如果您开发的插件还有其它DLL或文件，请复制到“Server_Plug_in”目录下的” Abet_File”目录中去。客户端标准插件接口客户端标准插件接口接口名称:SisenMESS_Interface.SisenMESS_Tools_Interface说明:布谷鸟二次开发中，最基本的接口。所有插件开发，都需要实现这一接口。属性:名称类型说明备注_IDstring当前插件的标签ID此编号必须为唯一编号，不可以和其它插件冲突。_Productstring插件开发的产品名称_Companystring开发插件的公司名称_IconImage用于显示的图标此图标将会显示在布谷鸟主界面上。要求尺寸:20*20_UserNostring用户名当前登录布谷鸟的用户名_UserIdstring用户编号当前登录布谷鸟的用户编号_UserNamestring用户姓名当前登录布谷鸟的用户姓名_UserPassWordstring用户密码不可用_IsLoginedbool用户是否已登录未登录时为Flase,登录为True_ServerIpstring服务器端的IP用户登录之后，会得到当前登录的服务器的IP地址方法:名称类型说明备注_Show()Void显示(激活)窗体事件:名称类型说明备注OnSetFormSize事件申请主窗体调整尺寸示例:OnSetFormSize(this,new Size (500,600);OnSetFormLocation事件申请主窗体调整位置示例:OnSetFormLocation (this,new Point (10,10);接口代码:using System;using System.Drawing;using System.Collections.Generic;using System.Text;using System.Windows.Forms;namespace SisenMESS_Interface / / 插件标准备界面接口 / public interface SisenMESS_Tools_Interface / / 当前插件的标签ID / string _ID get; / / 插件开发的产品名称 / string _Product get; / / 公司名称 / string _Company get; / / 显示窗体 / void _Show(); / / 用于显示的图标 / Image _Icon get; / / 用户名 / string _UserNo get; set; / / 用户编号 / string _UserId get; set; / / 用户姓名 / string _UserName get; set; / / 用户密码 / string _UserPassWord get; set; / / 用户是否已登录 / bool _IsLogined get; set; / / 服务器端的IP / string _ServerIp get; set; / / 申请主窗体调整尺寸 / event OnRequestSetFormSizeEventArgsHandler OnSetFormSize; / / 申请主窗体调整尺寸 / event OnRequestSetFormLocationEventArgsHandler OnSetFormLocation; 客户端通讯接口接口名称:SisenMESS_Interface. SisenMESS_Tools_Msg_Interface说明:布谷鸟二次开发中，如果需要进行通讯，那么需要实现此接口。属性:名称类型说明备注_IDstring当前插件的标签ID标准接口已实现，此接口重用。_Productstring插件开发的产品名称_IsOnlinebool是否与服务器连接方法:名称类型说明备注_ReceiveData(object oj)Void接收消息的方法，有消息来时将被调用。_UpdateUserList(DataTable userlist_dt)Void得到当前所有用户。设置用户列表_UpdateWorkGroup(DataTable workgroup_dt)Void得到当前部门列表_UserOnline(string userid, string user_online_type, string userip)void用户上线(包括隐身-Y在线,N离线或隐身，A正忙)和用户ip地址_UserOutLine(string userid)Void用户下线事件:名称类型说明备注OnSendDate事件发送数据示例:OnSendDate (this,new SisenSendEventArgs ();OnGetUserList事件申请得到所有的用户列表OnGetWorkGroup事件申请得到所有部门OnOpenUserMsgForm事件申请打开用户聊天窗口OnOpenUserMsgForm(this, userid);接口代码:using System;using System.Collections.Generic;using System.Text;namespace SisenMESS_Interface / / 插件用于通讯的接口 / public interface SisenMESS_Tools_Msg_Interface / / 当前插件的标签ID / string _ID get; / / 插件开发的产品名称 / string _Product get; / / 是否与服务器连接 / bool _IsOnline get; set; / / 有消息来事件 / / void _ReceiveData(object oj); / / 设置用户列表 / / void _UpdateUserList(System.Data.DataTable userlist_dt); / / 设置部门列表 / / void _UpdateWorkGroup(System.Data.DataTable workgroup_dt); / / 用户上线 / / 用户编号 / 用户在线类型(包括隐身-Y在线,N离线或隐身，A正忙) / 用户ip地址 void _UserOnline(string userid, string user_online_type, string userip); / / 用户下线 / / void _UserOutLine(string userid); / / 发送数据 / event OnSendEventArgsHandler OnSendDate; / / 得到所有的用户列表时 / event OnGetUserListHandler OnGetUserList; / / 得到所有部门 / event OnGetWorkGroupHandler OnGetWorkGroup; / / 打开用户聊天窗口 / event OnOpenUserMsgFormEventArgsHandler OnOpenUserMsgForm; 客户端文件发送接口接口名称:SisenMESS_Interface. SisenMESS_Tools_SendFile_Interface说明:布谷鸟二次开发中，如果需要使用布谷鸟的文件发送功能，那么需要实现此接口。属性:名称类型说明备注_IDstring当前插件的标签ID标准接口已实现，此接口重用。SendedListList已发送的文件队列方法:名称类型说明备注_SendFileFinish(string filepath, bool IsFinish)Void当文件发送完毕之后，会调用此方法。Filepath:送的文件名称IsFinish:是否成功事件:名称类型说明备注OnSendFile事件发送文件示例:OnSendFile (this,new SisenSendFileEventArgs ();接口代码:using System;using System.Collections.Generic;using System.Text;namespace SisenMESS_Interface / / 用于文件发送的接口 / public interface SisenMESS_Tools_SendFile_Interface / / 当前插件的标签ID / string _ID get; / / 已发送的文件队列 / List SendedList get; / / 发送文件 / event OnSendFileEventArgsHandler OnSendFile; / / 发送完毕(Y/N) / / 文件路径 / 是否成功 void _SendFileFinish(string filepath, bool IsFinish); 布谷鸟客户端多页面接口:接口名称:SisenMESS_Interface. SisenMESS_Page_Interface说明:布谷鸟二次开发中，可在页面上定制出多选页插件，那么需要实现此接口。属性:名称类型说明备注_ParentFromForm主显示窗体（此窗体将做为默认的窗体，首先被打开）_IsSelectedbool是否处于被选中状态方法:名称类型说明备注_Load()Void加载窗体(当窗体被关闭之后，会调用一次这方法。)_OnSelected()Void当前被选中时，将被调用接口代码:using System;using System.Collections.Generic;using System.Text;namespace SisenMESS_Interface / / 多页面插件 / public interface SisenMESS_Page_Interface / / 主显示窗体（此窗体将做为默认的窗体，首先被打开） / System.Windows.Forms.Form _ParentFrom get; / / 加载窗体(当窗体被关闭之后，会调用一次这方法。) / void _Load(); / / 当前被选中() / void _OnSelected(); / / 是否被选中 / bool _IsSelected get; set; 布谷鸟客户端多页面Web浏览接口:接口名称:SisenMESS_Interface. SisenMESS_Page_Web_Interface说明:布谷鸟二次开发中，可在页面上定制出多选页插件，那么需要实现此接口。属性:名称类型说明备注Urlstring链接地址(当地址为null时，为不显示。)IsWebBrowserContextMenuEnabledbool是否使用浏览器默认右键菜单IsShowToolBarbool是否显示出默认工具栏IsNewWindowbool是否允许弹出新窗口_IsSelectedbool是否被选中方法:名称类型说明备注_OnSelected()Void当前被选中时，将被调用事件:名称类型说明备注OnCloseWebPage事件关闭web页面接口代码:using System;using System.Collections.Generic;using System.Text;namespace SisenMESS_Interface / / 网页地址接口 / public interface SisenMESS_Page_Web_Interface / / 链接地址(当地址为null时，为不显示。) / string Url get; / / 是否使用浏览器默认右键菜单 / bool IsWebBrowserContextMenuEnabled get; / / 是否显示出默认工具栏 / bool IsShowToolBar get; / / 是否允许弹出新窗口 / bool IsNewWindow get; / / 自定义工具栏 / /System.Windows.Forms.Control Custome_Toolbar / / get; / / / 当前被选中() / void _OnSelected(); / / 是否被选中 / bool _IsSelected get; set; / / 关闭web页面 / event OnCloseWebPageEventArgsHandler OnCloseWebPage; 布谷鸟服务器端插件接口:接口名称:SisenMESS_Interface. SisenMESS_Server_Inteface说明:布谷鸟服务器端插件需要实现此接口。属性:名称类型说明备注_IDstring当前服务器端插件的标签ID(如果有客户端插件通讯，需要和客户端的ID一至)_Productstring插件开发的产品名称_Companystring公司名称_ManageApplicationNamestring管理工具的程序名称方法:名称类型说明备注_ReceiveData(object oj)Void当收到服务器端消息时，将调用此方法_UserOnline(string userid, string user_online_type, string userip)用户上线信息变化时将调用此方法.用户在线类型(包括隐身-Y在线,N离线或隐身，A正忙)用户ip地址_UserOutLine(string userid)用户下线StartService();开始服务重要StopService();停止服务重要事件:名称类型说明备注OnSend事件发送消息OnSendData事件发送数据接口代码:using System;using System.Collections.Generic;using System.Text;namespace SisenMESS_Interface / / 服务器端插件接口 / public interface SisenMESS_Server_Inteface / / 当前服务器端插件的标签ID(如果有客户端插件通讯，需要和客户端的ID一至) / string _ID get; / / 插件开发的产品名称 / string _Product get; / / 公司名称 / string _Company get; / / 管理工具的程序名称 / stri