实战+Lotus+Sametime+8.5+Web+Client+API.docxVIP

实战Lotus Sametime 8.5 Web Client APIIBM Lotus Sametime 8.5 Web 客户端概述Lotus Sametime 8.5 版本开始支持纯网页版的客户端，并且提供了灵活的网页版客户端的定制方式。这就让企业应用开发人员可以通过一些公共 API 将 Lotus Sametime 的即时聊天，会议等功能绑定到企业应用中，企业应用因此能使其用户具有实时沟通协作的能力。公共 API 简介Sametime Web 版公共 API 从架构上自底向上可以分为三个层次：REST API，基本功能模块以及 UI API。REST API 是一些底层的与 Sametime 服务器交互数据的 API，这一层比较复杂并且不影响 Sametime Web 端的 UI 展现，不建议用户在这一层做任何修改。REST API 上面一层就是由一些 Javascript 对象包装起来的基本功能模块，这些模块封装了 REST API 的低层调用，并构成了 Sametime UI 的基础，但不包含任何 UI 的展现。UI API 是 Sametime 8.5 Web 版本的核心部件，它们实际上是由一系列的 Dojo 类组成。用户可以有选择性的引入部分 Dojo 组件来将 Sametime 8.5 的 Web 版本引入到各种 Web 应用中。引入 Sametime Web 版的几个主要步骤引入 Sametime Web 版主要是通过加载一些 Javascript 文件。清单 1 是一段示例的代码。清单 1. 加载 Sametime Web 版 script type=text/javascript src=:port /stbaseapi/baseComps.js/script script type=text/javascript var stproxyConfig = { server: :portnumber } // Dojo configuration: see Dojo Toolkit documentation var djConfig = { parseOnLoad: true }; /script 另外，为了保证 Sametime Web 版能正常显示，需要在 HTML 的 body 元素上加上一个 class=”tundra”，因为 Sametime Web 版是基于 Dojo toolkit 来构建的。Sametime 各功能模块及其 API登陆通常登陆到 Sametime 服务器需要用户提供用户名密码，但是在企业应用环境中一般都会有 SSO 的配置，就 Sametime Web 版的登陆方式而言，有三种方式都可以进行登陆。loginByPassword(username, password, initialStatus, initialStatusMessage, callBack, errorCallBack, clientId);loginByToken(username, initialStatus, initialStatusMessage, callBack, errorCallBack, clientId);loginAsAnon(username, initialStatus, initialStatusMessage, callBack, errorCallBack, clientId);其中以 loginByToken 最为常见，这种登陆方式就是以 SSO 为基础的，这里需要将配置用户当前在开发的 Web 应用，使之与 Sametime proxy 服务器建立 SSO。清单２是一段使当前用户登陆到 Sametime 的示例。清单 2. 登陆 Sametime Web 版 function loginUser() { stproxy.login.loginByToken(null, stproxy.status.AVAILABLE,I am online); } stproxy.addOnLoad(loginUser); 当用户在运行完清单１中引入 Sametime Web 版的代码后，stproxy 作为一个全局变量在浏览器中就可以使用了，这个对象是用户代码访问 Sametime Web 版的各种功能的入口，本文后面提到的各种 Sametime 功能都需从该对象进入。类似的也可以用 stproxy.login.loginByPassword 和 stproxy.login.loginAsAnon 来登陆 Sametime Web。表１列出了这几个登陆函数中的参数意义以及期待的值。表 1. 登陆参数参数 类型 描述 username String 登陆用户名