使用 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 客戶端物件模型