OpenSocial API 开发人员指南.doc

OpenSocial API 开发人员指南 (OpenSocial API v0.8.1) 该指南将帮助您构建 OpenSocial 应用程序。为充分利用该指南，您应当对小工具 API 和 JavaScript 有一定的了解。该指南还提供了指向其他含有更多信息的文档的链接。 该指南已进行了修改，以反映 OpenSocial API 0.7 版更新所进行的更改。章节标记为新增！或更新来帮助您识别相对于上个版本而进行更改的编码实例。目录 编写社交应用程序 导入 OpenSocial Library 访问用户和个人资料 获取基本信息 列出好友的完整代码 使用持久化数据 发布活动 许可控制 了解更多 更新编写社交应用程序 可托管 OpenSocial 应用程序的站点称为 OpenSocial 容器。社交应用程序只是在 OpenSocial 容器上运行的应用程序。 要编写 OpenSocial 应用程序，您需要了解 JavaScript 的工作知识。OpenSocial 应用程序会作为小工具进行构建，因此您需要了解小工具如何构建，如果要想让您的应用程序用于社交网络，则您需要了解 OpenSocial JavaScript API。（如果您愿意，可使用 RESTful 或 RPC API 编写 OpenSocial 应用程序。） 许多容器提供了可能要在您的小工具中使用的 OpenSocial 规范之外的功能。要了解有关这些容器特有的功能的更多信息，请查看在《使用入门指南》中列出的容器文档。此外，许多容器提供名为沙盒的测试环境，您可在其中安全测试您的小工具。 OpenSocial API 主要针对用户。OpenSocial 小工具可帮助用户相互共享各自的活动，并访问有关好友的信息。在 OpenSocial API 中有三个主要功能区： 用户和关系。社交网络的成员都有好友。OpenSocial 应用程序会使用用户及其好友之间的连接。 持久化存储。OpenSocial 应用程序可充分利用持久化存储，这是用来存储应用程序在以后再次运行时可以检索到的数据的功能。 活动。用户可使用社交应用程序告知其他人自己正在做什么，比如正要观看影片、张贴照片等等。 许多 OpenSocial API 调用都是异步的：也就是说，调用会立即返回，但是调用请求的操作却不会立即发生。而且，调用会创建服务器请求以检索或更新信息。当进行异步调用时，您会传入回调函数。当数据从服务器返回时，OpenSocial 会调用您的回调函数。 更新导入 OpenSocial Library 每个小工具都有以下结构： ?xml version=1.0 encoding=UTF-8 ? Module ?ModulePrefs title=Standard gadget structure ?/ModulePrefs ?Content type=html ?![CDATA[ ? ? ? Gadget content and features here ?]] ?/Content /Module当您创建使用 OpenSocial 的小工具时，必须将以下行添加到ModulePrefs一节： ? Require feature=opensocial-0.8/ 这会使 OpenSocial 小工具的结构如下： ?xml version=1.0 encoding=UTF-8 ? Module ?ModulePrefs title=Standard gadget structure ? Require feature=opensocial-0.8/ ?/ModulePrefs ?Content type=html ?![CDATA[ ? ? ? Gadget content and features here ?]] ?/Content /Module 访问用户和个人资料 我们先以列有好友名称的简单实例开始。首先，务必要先了解由 OpenSocial API 定义的角色： 查看者：登录浏览器的用户。作为查看者，您可以查看自己的页面，也可以查看其他用户的个人资料。 所有者：拥有个人资料或相关应用程序的用户。 好友：被所有者或查看者在容器中加为好友的用户。 本节中讨论的“列出好友”实例可以获取查看者和查看者的好友，并显示查看者好友的列表。介绍了如何获取并管理 OpenSocial 应用程序中的数据。基本步骤如下： 构建小工具规范。 创建应用程序结构。 构建请求。 构建响应。 下面将详细讨论这些步骤。 构建小工具规范 我们通过构建标准小工具规范来开始创建小工具： ?xml version=1.0 encoding=UTF-8 ? Module ?Mod