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

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

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

备注

_ID

string

当前插件的标签ID

此编号必须为唯一编号，不可以和其它插件冲突。

_Product

插件开发的产品名称

_Company

开发插件的公司名称

_Icon

Image

用于显示的图标

此图标将会显示在布谷鸟主界面上。

要求尺寸:

20*20

_UserNo

用户名

当前登录布谷鸟的用户名

_UserId

用户编号

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

_UserName

用户姓名

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

_UserPassWord

用户密码

不可用

_IsLogined

bool

用户是否已登录

未登录时为Flase,登录为True

_ServerIp

服务器端的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

{

///<

summary>

///插件标准备界面接口

/summary>

publicinterfaceSisenMESS_Tools_Interface

{

///当前插件的标签ID

string_ID

get;

}

///插件开发的产品名称

string_Product

///公司名称

string_Company

///显示窗体

void_Show（）;

///用于显示的图标

Image_Icon

///用户名

string_UserNo

set;

///用户编号

string_UserId

///用户姓名

string_UserName

///用户密码

string_UserPassWord

///用户是否已登录

bool_IsLogined

///服务器端的IP

string_ServerIp

///申请主窗体调整尺寸

eventOnRequestSetFormSizeEventArgsHandlerOnSetFormSize;

eventOnRequestSetFormLocationEventArgsHandlerOnSetFormLocation;

}

客户端通讯接口

SisenMESS_Interface.SisenMESS_Tools_Msg_Interface

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

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

_IsOnline

是否与服务器连接

_ReceiveData（objectoj）

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

_UpdateUserList（DataTableuserlist_dt）

得到当前所有用户。

设置用户列表

_UpdateWorkGroup（DataTableworkgroup_dt）

得到当前部门列表

_UserOnline（stringuserid,stringuser_online_type,stringuserip）

void

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

和用户ip地址

_UserOutLine（stringuserid）

用户下线

OnSendDate

发送数据

OnSendDate（this,newSisenSendEventArgs（））;

OnGetUserList

申请得到所有的用户列表

OnGetWorkGroup

申请得到所有部门

OnOpenUserMsgForm

申请打开用户聊天窗口

OnOpenUserMsgForm（this,userid）;

///插件用于通讯的接口

publicinterfaceSisenMESS_Tools_Msg_Interface

///是否与服务器连接

bool_IsOnline

///有消息来事件

paramname="

oj"

>

<

/param>

void_ReceiveData（objectoj）;

///设置用户列表

userlist_dt"

void_UpdateUserList（System.Data.DataTableuserlist_dt）;

///设置部门列表

workgroup_dt"

void_UpdateWorkGroup（System.Data.DataTableworkgroup_dt）;

///用户上线

userid"

用户编号<

user_online_type"

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

userip"

用户ip地址<

void_UserOnline（stringuserid,stringuser_online_type,stringuserip）;

///用户下线

void_UserOutLine（stringuserid）;

///发送数据

eventOnSendEventArgsHandlerOnSendDate;

///得到所有的用户列表时

eventOnGetUserListHandlerOnGetUserList;

///得到所有部门

eventOnGetWorkGroupHandlerOnGetWorkGroup;

///打开用户聊天窗口

eventOnOpenUserMsgFormEventArgsHandlerOnOpenUserMsgForm;

客户端文件发送接口

SisenMESS_Interface.SisenMESS_Tools_SendFile_Interface

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

SendedList

List<

string>

已发送的文件队列

_SendFileFinish（stringfilepath,boolIsFinish）

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

Filepath:

送的文件名称

IsFinish:

是否成功

OnSendFile

发送文件

OnSendFile（this,newSisenSendFileEventArgs（））;

///用于文件发送的接口

publicinterfaceSisenMESS_Tools_SendFile_Interface

///已发送的文件队列

List<

SendedList

///发送文件

eventOnSendFileEventArgsHandlerOnSendFile;

///发送完毕（Y/N）

filepath"

文件路径<

IsFinish"

是否成功<

void_SendFileFinish（stringfilepath,boolIsFinish）;

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

SisenMESS_Interface.SisenMESS_Page_Interface

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

_ParentFrom

Form

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

_IsSelected

是否处于被选中状态

_Load（）

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

）

_OnSelected（）

当前被选中时，将被调用

///多页面插件

publicinterfaceSisenMESS_Page_Interface

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

System.Windows.Forms.Form_ParentFrom

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

void_Load（）;

///当前被选中（）

void_OnSelected（）;

///是否被选中

bool_IsSelected

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

SisenMESS_Interface.SisenMESS_Page_Web_Interface

Url

链接地址（当地址为null时，为不显示。

IsWebBrowserContextMenuEnabled

是否使用浏览器默认右键菜单

IsShowToolBar

是否显示出默认工具栏

IsNewWindow

是否允许弹出新窗口

是否被选中

OnCloseWebPage

关闭web页面

///网页地址接口

publicinterfaceSisenMESS_Page_Web_Interface

///链接地址（当地址为null时，为不显示。

stringUrl

///是否使用浏览器默认右键菜单

boolIsWebBrowserContextMenuEnabled

///是否显示出默认工具栏

boolIsShowToolBar

///是否允许弹出新窗口

boolIsNewWindow

/////<

/////自定义工具栏

//System.Windows.Forms.ControlCustome_Toolbar

//{

//get;

//}

///关闭web页面

eventOnCloseWebPageEventArgsHandlerOnCloseWebPage;

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

SisenMESS_Interface.SisenMESS_Server_Inteface

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

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

公司名称

_ManageApplicationName

管理工具的程序名称

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

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

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

用户ip地址

StartService（）;

开始服务

重要

StopService（）;

停止服务

OnSend

发送消息

OnSendData

///服务器端插件接口

publicinterfaceSisenMESS_Server_Inteface

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

///管理工具的程序名称

string_ManageApplicationName

///发送消息

eventOnSendEventArgsHandlerOnSend;

eventOnSendDataEventArgsHandlerOnSendData;

///