使用 JavaScript 客户端对象模型(JSOM)

背景

JavaScript 对象模型是在 SharePoint 2010 中引入的。它在客户端公开了许多以前只能通过服务器端代码或专用 Web 服务访问的对象。

在 SharePoint 页面中嵌入 JavaScript

在 SharePoint 2013 中,你可以将 JavaScript 放在脚本编辑器 Web 部件中。

在 SharePoint 2010 中,你可以使用 Content Editor Web 部件的内容链接属性链接到包含嵌入脚本的 HTML 文件。

对象参考

SP 名称空间中找到的所有对象的构造函数,方法和属性都记录在此处的 SharePoint 2013 客户端对象模型参考中。

此处提供 SharePoint 2010 JavaScript 客户端对象模型参考。

JSOM 的异步编程模式

使用 JavaScript 客户端对象模型时,代码通常采用以下模式:

  1. 获取 ClientContext 对象。
  2. 使用 ClientContext 对象检索表示 SharePoint 对象模型中实体的对象,例如列表,文件夹,视图。
  3. 对要对象执行的指令进行排队。这些指令尚未传输到服务器。
  4. 使用 load 函数告诉 ClientContext 你希望从服务器接收哪些信息。
  5. 调用 ClientContext 对象的 executeQueryAsync 函数将排队的指令发送到服务器,传递两个回调函数以在成功或失败时运行。
  6. 在回调函数中,使用从服务器返回的结果。

备择方案

JSOM 的客户端替代方案包括 SharePoint 的 Web 服务, REST 端点.NET 客户端对象模型