You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jan 18, 2021. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+35-29Lines changed: 35 additions & 29 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,20 +4,20 @@
4
4
5
5
## SharePoint REST Web Services JavaScript Library
6
6
Provides a concise, promise-based API that simplifies asynchronous REST interaction with SharePoint. Easily read/write List
7
-
items, execute ad-hoc REST calls, interact with files and folders, gather site properties, and query user information. Enables rapid development of SharePoint Apps/Add-ins using the JavaScript SharePoint App Model.
7
+
items, execute REST calls, interact with files and folders, gather site properties, and query user information. Enables rapid development of SharePoint Apps/Add-ins using the JavaScript SharePoint App Model.
8
8
9
9
### Library Features:
10
10
* Simple - Most SharePoint web service calls are a few lines of code
11
-
* Modern - Lightweight, pure JavaScript solution with zero dependencies
11
+
* Modern - Lightweight, pure JavaScript solution with no other dependencies
12
12
* Elegant - Utilizes the new [ES6 Promise](http://www.datchley.name/es6-promises/) architecture for asynchronous operations
13
13
* Robust - Built for [SharePoint 2013 API](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) and [OData v3](http://www.odata.org/documentation/odata-version-3-0/)
14
14
15
15
### SharePoint Interfaces:
16
-
* List Methods - Create, read, update, and delete (CRUD) List/Library items with a single line of code
16
+
* List Methods - Create, read, update, and delete (CRUD) List/Library items, including support for paging/next
17
17
* User Methods - Get User information: Basic (ID, Email, LoginName, etc.) and UserProfile (Manager, 100+ Properties)
18
18
* Site Methods - Get Site information (Lists, Groups, Users, Roles, Subsites and Permissions)
19
-
* File/Folder Methods - Get File/Folder properties, permissions. Download files and get a folder's items.
20
-
* REST Methods - Run ad-hoc REST API calls against any available [SharePoint REST API](https://msdn.microsoft.com/en-us/library/office/dn268594.aspx) endpoint
19
+
* File/Folder Methods - Get File/Folder properties and permissions. Download files and get a folder's items.
20
+
* REST Methods - Run REST API calls against any available [SharePoint REST API](https://msdn.microsoft.com/en-us/library/office/dn268594.aspx) endpoint
21
21
* Form Population - Populate form elements using data-bind declarative binding system like Knockout or AngluarJS
22
22
23
23
### Supported Environments:
@@ -31,38 +31,38 @@ items, execute ad-hoc REST calls, interact with files and folders, gather site p
31
31
*`sprLib.rest(options)` - Returns the results of a given REST call to any [SharePoint REST API](https://msdn.microsoft.com/en-us/library/office/dn268594.aspx)
32
32
33
33
## List/Library
34
-
*`sprLib.list(listName).items(options)` - Returns an array of item objects using a variety of possible options
34
+
*`sprLib.list(listName).items(options)` - Returns an array of `SP.ListItem` objects using a variety of query options
35
35
*`sprLib.list(listName).create(item)` - Create a new list item using JSON data
36
36
*`sprLib.list(listName).update(item)` - Update an existing item using JSON data
37
37
*`sprLib.list(listName).delete(item)` - Delete an existing item using JSON data (permanently delete)
38
38
*`sprLib.list(listName).recycle(item)` - Recycle an existing item using JSON data (move to Recycle Bin)
39
-
*`sprLib.list(listName).cols()` - Returns an array of column objects with useful info (name, datatype, etc.)
0 commit comments