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

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

《布谷鸟二次开发接口说明.docx》由会员分享，可在线阅读，更多相关《布谷鸟二次开发接口说明.docx（24页珍藏版）》请在冰豆网上搜索。

布谷鸟二次开发接口说明

《布谷鸟2010》二次开发接口说明

（SDKR3.0）

平台:

.netFramework2.0

森森工作室

http:

布谷鸟客户端插件用法

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

用户名

当前登录布谷鸟的用户名

_UserId

string

用户编号

当前登录布谷鸟的用户编号

_UserName

string

用户姓名

当前登录布谷鸟的用户姓名

_UserPassWord

string

用户密码

不可用

_IsLogined

bool

用户是否已登录

未登录时为Flase,登录为True

_ServerIp

string

服务器端的IP

用户登录之后，会得到当前登录的服务器的IP地址

方法:

名称

类型

说明

备注

_Show（）

Void

显示（激活）窗体

事件:

名称

类型

说明

备注

OnSetFormSize

事件

申请主窗体调整尺寸

示例:

OnSetFormSize（this,newSize（500,600））;

OnSetFormLocation

事件

申请主窗体调整位置

示例:

OnSetFormLocation（this,newPoint（10,10））;

接口代码:

usingSystem;

usingSystem.Drawing;

usingSystem.Collections.Generic;

usingSystem.Text;

usingSystem.Windows.Forms;

namespaceSisenMESS_Interface

{

///

publicinterfaceSisenMESS_Tools_Interface

{

///

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;

}

///

string_ServerIp

{

get;

set;

}

///

eventOnRequestSetFormSizeEventArgsHandlerOnSetFormSize;

///

eventOnRequestSetFormLocationEventArgsHandlerOnSetFormLocation;

}

}

客户端通讯接口

接口名称:

SisenMESS_Interface.SisenMESS_Tools_Msg_Interface

说明:

布谷鸟二次开发中，如果需要进行通讯，那么需要实现此接口。

属性:

名称

类型

说明

备注

_ID

string

当前插件的标签ID

标准接口已实现，此接口重用。

_Product

string

插件开发的产品名称

_IsOnline

bool

是否与服务器连接

方法:

名称

类型

说明

备注

_ReceiveData（objectoj）

Void

接收消息的方法，有消息来时将被调用。

_UpdateUserList（DataTableuserlist_dt）

Void

得到当前所有用户。

设置用户列表

_UpdateWorkGroup（DataTableworkgroup_dt）

Void

得到当前部门列表

_UserOnline（stringuserid,stringuser_online_type,stringuserip）

void

用户上线（包括隐身-----Y在线,N离线或隐身，A正忙）

和用户ip地址

_UserOutLine（stringuserid）

Void

用户下线

事件:

名称

类型

说明

备注

OnSendDate

事件

发送数据

示例:

OnSendDate（this,newSisenSendEventArgs（））;

OnGetUserList

事件

申请得到所有的用户列表

OnGetWorkGroup

事件

申请得到所有部门

OnOpenUserMsgForm

事件

申请打开用户聊天窗口

OnOpenUserMsgForm（this,userid）;

接口代码:

usingSystem;

usingSystem.Collections.Generic;

usingSystem.Text;

namespaceSisenMESS_Interface

{

///

publicinterfaceSisenMESS_Tools_Msg_Interface

{

///

string_ID

{

get;

}

///

string_Product

{

get;

}

///

bool_IsOnline

{

get;

set;

}

///

///

void_ReceiveData（objectoj）;

///

///

void_UpdateUserList（System.Data.DataTableuserlist_dt）;

///

///

void_UpdateWorkGroup（System.Data.DataTableworkgroup_dt）;

///

///用户编号

///用户在线类型（包括隐身-----Y在线,N离线或隐身，A正忙）

///用户ip地址

void_UserOnline（stringuserid,stringuser_online_type,stringuserip）;

///

///

void_UserOutLine（stringuserid）;

///

eventOnSendEventArgsHandlerOnSendDate;

///

eventOnGetUserListHandlerOnGetUserList;

///

eventOnGetWorkGroupHandlerOnGetWorkGroup;

///

eventOnOpenUserMsgFormEventArgsHandlerOnOpenUserMsgForm;

}

}

客户端文件发送接口

接口名称:

SisenMESS_Interface.SisenMESS_Tools_SendFile_Interface

说明:

布谷鸟二次开发中，如果需要使用布谷鸟的文件发送功能，那么需要实现此接口。

属性:

名称

类型

说明

备注

_ID

string

当前插件的标签ID

标准接口已实现，此接口重用。

SendedList

List

已发送的文件队列

方法:

名称

类型

说明

备注

_SendFileFinish（stringfilepath,boolIsFinish）

Void

当文件发送完毕之后，会调用此方法。

Filepath:

送的文件名称

IsFinish:

是否成功

事件:

名称

类型

说明

备注

OnSendFile

事件

发送文件

示例:

OnSendFile（this,newSisenSendFileEventArgs（））;

接口代码:

usingSystem;

usingSystem.Collections.Generic;

usingSystem.Text;

namespaceSisenMESS_Interface

{

///

publicinterfaceSisenMESS_Tools_SendFile_Interface

{

///

string_ID

{

get;

}

///

ListSendedList

{

get;

}

///

eventOnSendFileEventArgsHandlerOnSendFile;

///

///文件路径

///是否成功

void_SendFileFinish（stringfilepath,boolIsFinish）;

}

}

布谷鸟客户端多页面接口:

接口名称:

SisenMESS_Interface.SisenMESS_Page_Interface

说明:

布谷鸟二次开发中，可在页面上定制出多选页插件，那么需要实现此接口。

属性:

名称

类型

说明

备注

_ParentFrom

Form

主显示窗体（此窗体将做为默认的窗体，首先被打开）

_IsSelected

bool

是否处于被选中状态

方法:

名称

类型

说明

备注

_Load（）

Void

加载窗体（当窗体被关闭之后，会调用一次这方法。

）

_OnSelected（）

Void

当前被选中时，将被调用

接口代码:

usingSystem;

usingSystem.Collections.Generic;

usingSystem.Text;

namespaceSisenMESS_Interface

{

///

publicinterfaceSisenMESS_Page_Interface

{

///

System.Windows.Forms.Form_ParentFrom

{

get;

}

///

void_Load（）;

///

void_OnSelected（）;

///

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页面

接口代码:

usingSystem;

usingSystem.Collections.Generic;

usingSystem.Text;

namespaceSisenMESS_Interface

{

///

publicinterfaceSisenMESS_Page_Web_Interface

{

///

stringUrl

{

get;

}

///

boolIsWebBrowserContextMenuEnabled

{

get;

}

///

boolIsShowToolBar

{

get;

}

///

boolIsNewWindow

{

get;

}

/////

//System.Windows.Forms.ControlCustome_Toolbar

//{

//get;

//}

///

void_OnSelected（）;

///

bool_IsSelected

{

get;

set;

}

///

eventOnCloseWebPageEventArgsHandlerOnCloseWebPage;

}

}

布谷鸟服务器端插件接口:

接口名称:

SisenMESS_Interface.SisenMESS_Server_Inteface

说明:

布谷鸟服务器端插件需要实现此接口。

属性:

名称

类型

说明

备注

_ID

string

当前服务器端插件的标签ID（如果有客户端插件通讯，需要和客户端的ID一至）

_Product

string

插件开发的产品名称

_Company

string

公司名称

_ManageApplicationName

string

管理工具的程序名称

方法:

名称

类型

说明

备注

_ReceiveData（objectoj）

Void

当收到服务器端消息时，将调用此方法

_UserOnline（stringuserid,stringuser_online_type,stringuserip）

用户上线信息变化时将调用此方法.

用户在线类型（包括隐身-----Y在线,N离线或隐身，A正忙）

用户ip地址

_UserOutLine（stringuserid）

用户下线

StartService（）;

开始服务

重要

StopService（）;

停止服务

重要

事件:

名称

类型

说明

备注

OnSend

事件

发送消息

OnSendData

事件

发送数据

接口代码:

usingSystem;

usingSystem.Collections.Generic;

usingSystem.Text;

namespaceSisenMESS_Interface

{

///

publicinterfaceSisenMESS_Server_Inteface

{

///

string_ID

{

get;

}

///

string_Product

{

get;

}

///

string_Company

{

get;

}

///

string_ManageApplicationName

{

get;

}

///

eventOnSendEventArgsHandlerOnSend;

///

eventOnSendDataEventArgsHandlerOnSendData;

///