布谷鸟二次开发接口说明
- 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。
《布谷鸟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
说明:布谷鸟二次开发中,最基本的接口。
所有插件开发,都需要实现这一接口。
属性:
名称类型说明备注
_ID string当前插件的标签ID此编号必须为唯一编号,不可
以和其它插件冲突。
_Product string插件开发的产品名称
_Company string开发插件的公司名称
_Icon Image用于显示的图标此图标将会显示在布谷鸟主
界面上。
要求尺寸:20*20
_UserNo string用户名当前登录布谷鸟的用户名
:
事件:
接口代码:
using System;
using System.Drawing;
using System.Collections.Generic;
using System.Text;
using System.Windows.Forms;
namespace SisenMESS_Interface
{
///<summary>
///插件标准备界面接口
///</summary>
public interface SisenMESS_Tools_Interface {
///<summary>
///当前插件的标签ID
///</summary>
string _ID
{
get;
}
///插件开发的产品名称
///</summary>
string _Product
{
get;
}
///<summary>
///公司名称
///</summary>
string _Company
{
get;
}
///<summary>
///显示窗体
///</summary>
void _Show();
///<summary>
///用于显示的图标
///</summary>
Image _Icon
{
get;
}
///<summary>
///用户名
///</summary>
string _UserNo
{
get;
set;
}
///<summary>
///用户编号
///</summary>
string _UserId
{
get;
set;
}
///<summary>
///用户姓名
string _UserName
{
get;
set;
}
///<summary>
///用户密码
///</summary>
string _UserPassWord
{
get;
set;
}
///<summary>
///用户是否已登录
///</summary>
bool _IsLogined
{
get;
set;
}
///<summary>
///服务器端的IP
///</summary>
string _ServerIp
{
get;
set;
}
///<summary>
///申请主窗体调整尺寸
///</summary>
event OnRequestSetFormSizeEventArgsHandler OnSetFormSize;
///<summary>
///申请主窗体调整尺寸
///</summary>
event OnRequestSetFormLocationEventArgsHandler OnSetFormLocation; }
}
客户端通讯接口
接口名称:
SisenMESS_Interface. SisenMESS_Tools_Msg_Interface
说明:布谷鸟二次开发中,如果需要进行通讯,那么需要实现此接口。
属性:
:
:
接口代码:
using System;
using System.Collections.Generic;
using System.Text;
namespace SisenMESS_Interface
{
///<summary>
///插件用于通讯的接口
///</summary>
public interface SisenMESS_Tools_Msg_Interface {
///<summary>
///当前插件的标签ID
///</summary>
string _ID
{
get;
}
///<summary>
///插件开发的产品名称
///</summary>
string _Product
{
get;
}
///<summary>
///是否与服务器连接
///</summary>
bool _IsOnline
{
get;
set;
}
///<summary>
///有消息来事件
///</summary>
///<param name="oj"></param>
void _ReceiveData(object oj);
///<summary>
///设置用户列表
///</summary>
///<param name="userlist_dt"></param>
void _UpdateUserList(System.Data.DataTable userlist_dt);
///<summary>
///设置部门列表
///</summary>
///<param name="workgroup_dt"></param>
void _UpdateWorkGroup(System.Data.DataTable workgroup_dt);
///<summary>
///用户上线
///</summary>
///<param name="userid">用户编号</param>
///<param name="user_online_type">用户在线类型(包括隐身-----Y在线,N离线或隐身,A正忙)</param>
///<param name="userip">用户ip地址</param>
void _UserOnline(string userid, string user_online_type, string userip);
///<summary>
///用户下线
///</summary>
///<param name="userid"></param>
void _UserOutLine(string userid);
///<summary>
///发送数据
///</summary>
event OnSendEventArgsHandler OnSendDate;
///<summary>
///得到所有的用户列表时
///</summary>
event OnGetUserListHandler OnGetUserList;
///<summary>
///得到所有部门
///</summary>
event OnGetWorkGroupHandler OnGetWorkGroup;
///<summary>
///打开用户聊天窗口
///</summary>
event OnOpenUserMsgFormEventArgsHandler OnOpenUserMsgForm;
}
}
客户端文件发送接口
接口名称:
SisenMESS_Interface. SisenMESS_Tools_SendFile_Interface
说明:布谷鸟二次开发中,如果需要使用布谷鸟的文件发送功能,那么需要实现此接口。
属性:
方法:
:
接口代码:
///当前插件的标签ID
///</summary>
string _ID
{
get;
}
///<summary>
///已发送的文件队列
///</summary>
List<string> SendedList
{
get;
}
///<summary>
///发送文件
///</summary>
event OnSendFileEventArgsHandler OnSendFile;
///<summary>
///发送完毕(Y/N)
///</summary>
///<param name="filepath">文件路径</param>
///<param name="IsFinish">是否成功</param>
void _SendFileFinish(string filepath, bool IsFinish); }
}
布谷鸟客户端多页面接口:
接口名称:
SisenMESS_Interface. SisenMESS_Page_Interface
说明:布谷鸟二次开发中,可在页面上定制出多选页插件,那么需要实现此接口。
属性:
名称类型说明备注_ParentFrom Form主显示窗体(此窗体将做为默
认的窗体,首先被打开)
_IsSelected bool是否处于被选中状态
:
名称类型说明备注_Load()Void 加载窗体(当窗体被关闭之
后,会调用一次这方法。
)
_OnSelected() Void 当前被选中时,将被调用
接口代码:
using System;
using System.Collections.Generic;
using System.Text;
namespace SisenMESS_Interface
{
///<summary>
///多页面插件
///</summary>
public interface SisenMESS_Page_Interface
{
///<summary>
///主显示窗体(此窗体将做为默认的窗体,首先被打开)
///</summary>
System.Windows.Forms.Form _ParentFrom
{
get;
}
///<summary>
///加载窗体(当窗体被关闭之后,会调用一次这方法。
)
///</summary>
void _Load();
///<summary>
///当前被选中()
///</summary>
void _OnSelected();
///<summary>
///是否被选中
///</summary>
bool _IsSelected
{
get;
set;
}
}
}
布谷鸟客户端多页面Web浏览接口:
接口名称:
SisenMESS_Interface. SisenMESS_Page_Web_Interface
说明:布谷鸟二次开发中,可在页面上定制出多选页插件,那么需要实现此接口。
属性:
名称类型说明备注Url string链接地址(当地址为null
时,为不显示。
) IsWebBrowserContextMenuEnabled bool是否使用浏览器默认右键
菜单
IsShowToolBar bool 是否显示出默认工具栏
IsNewWindow bool 是否允许弹出新窗口
_IsSelected bool 是否被选中
:
名称类型说明备注
_OnSelected() Void 当前被选中时,将被调用
事件:
名称类型说明备注OnCloseWebPage事件关闭web页面
接口代码:
using System;
using System.Collections.Generic;
using System.Text;
namespace SisenMESS_Interface
{
///<summary>
///网页地址接口
///</summary>
public interface SisenMESS_Page_Web_Interface {
///<summary>
///链接地址(当地址为null时,为不显示。
)
///</summary>
string Url
{
get;
}
///<summary>
///是否使用浏览器默认右键菜单
///</summary>
bool IsWebBrowserContextMenuEnabled
{
get;
}
///<summary>
///是否显示出默认工具栏
///</summary>
bool IsShowToolBar
{
get;
}
///<summary>
///是否允许弹出新窗口
///</summary>
bool IsNewWindow
{
get;
}
///// <summary>
///// 自定义工具栏
///// </summary>
//System.Windows.Forms.Control Custome_Toolbar
//{
// get;
//}
///<summary>
///当前被选中()
///</summary>
void _OnSelected();
///<summary>
///是否被选中
///</summary>
bool _IsSelected
{
get;
set;
}
///<summary>
///关闭web页面
///</summary>
event OnCloseWebPageEventArgsHandler OnCloseWebPage;
}
}
布谷鸟服务器端插件接口:
接口名称:
SisenMESS_Interface. SisenMESS_Server_Inteface 说明:布谷鸟服务器端插件需要实现此接口。
属性:
:
事件:
接口代码:
using System;
using System.Collections.Generic;
using System.Text;
namespace SisenMESS_Interface
{
///<summary>
///服务器端插件接口
///</summary>
public interface SisenMESS_Server_Inteface
{
///<summary>
///当前服务器端插件的标签ID(如果有客户端插件通讯,需要和客户端的ID一至) ///</summary>
string _ID
{
get;
}
///<summary>
///插件开发的产品名称
///</summary>
string _Product
{
get;
}
///<summary>
///公司名称
///</summary>
string _Company
{
get;
}
///<summary>
///管理工具的程序名称
///</summary>
string _ManageApplicationName
{
get;
}
///<summary>
///发送消息
///</summary>
event OnSendEventArgsHandler OnSend;
///<summary>
///发送数据
///</summary>
event OnSendDataEventArgsHandler OnSendData;
///<summary>
///有消息来事件
///</summary>
///<param name="oj"></param>
void _ReceiveData(object oj);
///<summary>
///用户上线
///</summary>
///<param name="userid">用户编号</param>
///<param name="user_online_type">用户在线类型(包括隐身-----Y在线,N离线或隐身,A正忙)</param>
///<param name="userip">用户ip地址</param>
void _UserOnline(string userid, string user_online_type, string userip);
///<summary>
///用户下线
///</summary>
///<param name="userid"></param>
void _UserOutLine(string userid);
///<summary>
///开始服务
///</summary>
void StartService();
///<summary>
///停止服务
///</summary>
void StopService();
}
}
服务器端系统消息组件进行消息发送:
说明:
可以利用现有的“服务器端的系统消息插件”,可以在不使用.net二次开发的基础上实现服务器端向客户端的消息发送。
使用方法:
通过向布谷鸟服务器端安装目录下的“Server_Plug_in\Abet_File\ServerMsgList”目录下生成“*.sisenmsg”文件,布谷鸟服务器端便可以自动帮您把消息发送出去。
在“服务器端系统公告二次开发接口”目录里有文档说明
文件规则说明:
第一行:True/False(模拟用户/系统消息)
第二行:发送人编号(系统消息时可为空)
第三行:接收人编号(向所有人发送时可为空)
第四行:True/False(向所有人发送/向单一用户发送)
第五行往后:消息正文。