\r\n\tRequires:\r\n\t\t
\r\n\t\tpdspserverajax - is exposed is a global namespace if added to browser via script tag\r\n\t
\n\n**Author**: \"Jered McGlohon\" \n\n* [pdspserverajax](#module_pdspserverajax)\n * _static_\n * [.getContext(props)](#module_pdspserverajax.getContext) ⇒promise.<object>\n * [.getData(url)](#module_pdspserverajax.getData) ⇒ promise.<object>\n * [.getAllListResults(props)](#module_pdspserverajax.getAllListResults) ⇒ promise.<Array.<object>>\n * [.getBatchMetered(props)](#module_pdspserverajax.getBatchMetered) ⇒ promise.<Array.<object>>\n * [.getBatchProfiles(props)](#module_pdspserverajax.getBatchProfiles) ⇒ promise.<Array.<object>>\n * [.getListInfo(props)](#module_pdspserverajax.getListInfo) ⇒ promise.<object>\n * [.peopleSearch(props)](#module_pdspserverajax.peopleSearch) ⇒ promise.<Array.<object>>\n * [.ensureUser(props)](#module_pdspserverajax.ensureUser) ⇒ promise.<object>\n * [.getSiteUserInfoByEmail(props)](#module_pdspserverajax.getSiteUserInfoByEmail) ⇒ promise.<object>\n * [.getItemsByCaml(props)](#module_pdspserverajax.getItemsByCaml) ⇒ promise.<object>\n * [.getUserSitePermissions(props)](#module_pdspserverajax.getUserSitePermissions) ⇒ promise.<Array.<string>>\n * [.getUserListPermissions(props)](#module_pdspserverajax.getUserListPermissions) ⇒ promise.<Array.<sting>>\n * [.getCurrentUserGroups(props)](#module_pdspserverajax.getCurrentUserGroups) ⇒ promise.<Array.<sting>>\n * [.createItem(props)](#module_pdspserverajax.createItem) ⇒ promise.<object>\n * [.updateItem(props)](#module_pdspserverajax.updateItem) ⇒ promise.<object>\n * [.deleteItem(props)](#module_pdspserverajax.deleteItem) ⇒ promise.<object>\n * [.recycleItem(props)](#module_pdspserverajax.recycleItem) ⇒ promise.<object>\n * [.getUserProfileData(props)](#module_pdspserverajax.getUserProfileData) ⇒ promise.<Array.<object>>\n * [.getListColumns(props)](#module_pdspserverajax.getListColumns) ⇒ promise.<object>\n * [.meteredCreateItems(props)](#module_pdspserverajax.meteredCreateItems) ⇒ promise.<Array.<object>>\n * [.meteredUpdateItems(props)](#module_pdspserverajax.meteredUpdateItems) ⇒ promise.<Array.<object>>\n * [.meteredRecycleItems(props)](#module_pdspserverajax.meteredRecycleItems) ⇒ promise.<Array.<object>>\n * _inner_\n * [~itemCompletedProcessing](#module_pdspserverajax..itemCompletedProcessing) : function\n * [~itemPreProcessing](#module_pdspserverajax..itemPreProcessing) : function\n\n\n\n### pdspserverajax.getContext(props) ⇒ promise.<object>\nGets a context object for server requests.\rthe key from response is FormDigestValue\n\n**Kind**: static method of [pdspserverajax](#module_pdspserverajax) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| props | object | |\n| [props.origin] | string | |\n| props.url | string | site relative url |\n\n\n\n### pdspserverajax.getData(url) ⇒ promise.<object>\nGet data from server using the REST endpoint\n\n**Kind**: static method of [pdspserverajax](#module_pdspserverajax) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| url | string | full odata url |\n\n\n\n### pdspserverajax.getAllListResults(props) ⇒ promise.<Array.<object>>\nGets all results for server requests.\ronce the promise resolves you get an array of objects that are the servers response\n\n**Kind**: static method of [pdspserverajax](#module_pdspserverajax) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| props | object | |\n| [props.origin] | string | |\n| props.url | string | site relative url |\n| props.listGUID | string | use either listGUID or listTitle not both |\n| [props.listTitle] | string | |\n| [props.select] | string | |\n| [props.filter] | string | |\n| [props.expand] | string | |\n| [props.top] | string | |\n| [props.orderBy] | string | |\n\n\n\n### pdspserverajax.getBatchMetered(props) ⇒ promise.<Array.<object>>\nGets all items requested in the getUrls property (batch request)\n\n**Kind**: static method of [pdspserverajax](#module_pdspserverajax) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| props | object | |\n| [props.origin] | string | |\n| props.url | string | relative url of the site that contains the data |\n| props.getUrls | Array.<string> | full odata urls |\n\n\n\n### pdspserverajax.getBatchProfiles(props) ⇒ promise.<Array.<object>>\nGet user profiles from the server (batch request)\n\n**Kind**: static method of [pdspserverajax](#module_pdspserverajax) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| props | object | |\n| [props.origin] | string | |\n| props.url | string | site relative url |\n| props.profileEmails | Array.<string> | email addresses of the users you want profile data for |\n\n\n\n### pdspserverajax.getListInfo(props) ⇒ promise.<object>\nGet list or library properties from server\n\n**Kind**: static method of [pdspserverajax](#module_pdspserverajax) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| props | object | |\n| [props.origin] | string | |\n| props.url | string | a site relative url |\n| props.listGUID | string | use either listGUID or listTitle not both |\n| [props.listTitle] | string | |\n\n\n\n### pdspserverajax.peopleSearch(props) ⇒ promise.<Array.<object>>\nGet user profile info from the SharePoint search service\n\n**Kind**: static method of [pdspserverajax](#module_pdspserverajax) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| props | object | |\n| [props.origin] | string | |\n| props.url | string | site relative url |\n| props.query | string | query that is passed to search service, ex \"'\" + 'Bureau=\"'+ divisionName + '\"\\'' |\n| [props.sourceId] | string | source id for the search service to use, defaults to the out of the box people source id |\n| props.properties | Array.<string> | specify which properties you want back from the request |\n\n\n\n### pdspserverajax.ensureUser(props) ⇒ promise.<object>\nChecks if user is in the site collection user table\n\n**Kind**: static method of [pdspserverajax](#module_pdspserverajax) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| props | object | |\n| [props.origin] | string | |\n| props.url | string | site relative url |\n| props.email | string | email address of the user to check |\n\n\n\n### pdspserverajax.getSiteUserInfoByEmail(props) ⇒ promise.<object>\nGets user info from the site collection user table\n\n**Kind**: static method of [pdspserverajax](#module_pdspserverajax) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| props | object | |\n| [props.origin] | string | |\n| props.url | string | site relative url |\n| props.email | string | email address of the user to retrieve |\n\n\n\n### pdspserverajax.getItemsByCaml(props) ⇒ promise.<object>\nGet request that uses CAML to filter results\n\n**Kind**: static method of [pdspserverajax](#module_pdspserverajax) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| props | object | |\n| [props.origin] | string | |\n| props.url | string | site relative url |\n| props.query | string | CAML query |\n| props.listGUID | string | use either listGUID or listTitle not both |\n| [props.listTitle] | string | |\n\n\n\n### pdspserverajax.getUserSitePermissions(props) ⇒ promise.<Array.<string>>\nGet a users permissions to a site\n\n**Kind**: static method of [pdspserverajax](#module_pdspserverajax) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| props | object | |\n| [props.origin] | string | |\n| props.url | string | site relative url |\n| props.email | string | email of the user to get permissions for |\n\n\n\n### pdspserverajax.getUserListPermissions(props) ⇒ promise.<Array.<sting>>\nGet a users permissions to a list or library\n\n**Kind**: static method of [pdspserverajax](#module_pdspserverajax) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| props | object | |\n| [props.origin] | string | |\n| props.url | string | site relative url |\n| props.listGUID | string | use either listGUID or listTitle not both |\n| [props.listTitle] | string | |\n| props.email | string | email of the user to check permission of |\n\n\n\n### pdspserverajax.getCurrentUserGroups(props) ⇒ promise.<Array.<sting>>\nGets the SharePoint groups that a user has been added to, identify the user by passing the id number of the user for the site.\n\n**Kind**: static method of [pdspserverajax](#module_pdspserverajax) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| props | object | |\n| [props.origin] | string | |\n| props.url | string | site relative url |\n| props.userId | number | users site id number |\n\n\n\n### pdspserverajax.createItem(props) ⇒ promise.<object>\nCreates a single item in a list\n\n**Kind**: static method of [pdspserverajax](#module_pdspserverajax) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| props | object | |\n| [props.origin] | string | |\n| props.url | string | site relative url |\n| props.listGUID | string | use either listGUID or listTitle not both |\n| [props.listTitle] | string | |\n| [props.listName] | string | server name for the list |\n| props.infoToServer | object | object whos key is the column name and the value is what you want stored in that column |\n\n\n\n### pdspserverajax.updateItem(props) ⇒ promise.<object>\nUpdates a single item in a list\n\n**Kind**: static method of [pdspserverajax](#module_pdspserverajax) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| props | object | |\n| [props.origin] | string | |\n| props.url | string | site relative url |\n| props.listGUID | string | use either listGUID or listTitle not both |\n| [props.listTitle] | string | |\n| [props.listName] | string | server name for the list |\n| [props.etag] | string | etag of the item to update |\n| props.itemId | number | id of the item to update |\n| props.infoToServer | object | object whos key is the column name and the value is what you want stored in that column |\n\n\n\n### pdspserverajax.deleteItem(props) ⇒ promise.<object>\nDeletes a single item from a list or library\rbe warned if you use this function, the item you delete will be gone and unrecoverable!!!!\n\n**Kind**: static method of [pdspserverajax](#module_pdspserverajax) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| props | object | |\n| [props.origin] | string | |\n| props.url | string | site relative url |\n| props.listGUID | string | use either listGUID or listTitle not both |\n| [props.listTitle] | string | |\n| [props.etag] | string | etag of the item to update |\n| props.itemId | number | id of the item to delete |\n\n\n\n### pdspserverajax.recycleItem(props) ⇒ promise.<object>\nSends a single item to the recycle bin of the site collection\n\n**Kind**: static method of [pdspserverajax](#module_pdspserverajax) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| props | object | |\n| [props.origin] | string | |\n| props.url | string | site relative url |\n| props.listGUID | string | use either listGUID or listTitle not both |\n| [props.listTitle] | string | |\n| props.itemId | number | id of the item to recycle |\n\n\n\n### pdspserverajax.getUserProfileData(props) ⇒ promise.<Array.<object>>\nGets the profile information from the profile service\rif email is passed then that will be the profile data you get back\rif email is not passed you get current user profile data back\n\n**Kind**: static method of [pdspserverajax](#module_pdspserverajax) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| props | object | |\n| [props.origin] | string | |\n| [props.email] | string | email of the user you want profile data for |\n\n\n\n### pdspserverajax.getListColumns(props) ⇒ promise.<object>\nGet the columns of a list or library\n\n**Kind**: static method of [pdspserverajax](#module_pdspserverajax) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| props | object | |\n| [props.origin] | string | |\n| props.url | string | site relative url |\n| props.listGUID | string | use either listGUID or listTitle not both |\n| [props.listTitle] | string | |\n\n\n\n### pdspserverajax.meteredCreateItems(props) ⇒ promise.<Array.<object>>\nCreates multiple items via REST, \ritems array should contain object with a key of column name and property of value you want stored in that column\rex. {\r\tTitle: \"something\"\r}\n\n**Kind**: static method of [pdspserverajax](#module_pdspserverajax) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| props | object | |\n| props.items | Array.<object> | items to create |\n| [props.origin] | string | |\n| props.url | string | site relative url |\n| props.listGUID | string | use either listGUID or listTitle not both |\n| [props.listTitle] | string | |\n| [props.listName] | string | server name for the list |\n| [props.itemCreatedCB] | itemPreProcessing | this call back is called when an item is added to be processed |\n| [props.itemCompletedCB] | itemCompletedProcessing | this call back is called when item is completed |\n\n\n\n### pdspserverajax.meteredUpdateItems(props) ⇒ promise.<Array.<object>>\nUpdates multiple items via REST, \ritems array should contain object with 2 properties itemId and updateInfo and 1 optional property etag\rex. {\r\titemId: 3,\r\tetag: \"\"3\"\"\r\tupdateInfo: {\r\t\tTitle: \"example string\"\r\t}\r}\n\n**Kind**: static method of [pdspserverajax](#module_pdspserverajax) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| props | object | |\n| props.items | Array.<object> | items to update |\n| [props.origin] | string | |\n| props.url | string | site relative url |\n| props.listGUID | string | use either listGUID or listTitle not both |\n| [props.listTitle] | string | |\n| [props.listName] | string | server name for the list |\n| [props.itemCreatedCB] | itemPreProcessing | this call back is called when an item is added to be processed |\n| [props.itemCompletedCB] | itemCompletedProcessing | this call back is called when item is completed |\n\n\n\n### pdspserverajax.meteredRecycleItems(props) ⇒ promise.<Array.<object>>\nRecycles multiple items via REST\n\n**Kind**: static method of [pdspserverajax](#module_pdspserverajax) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| props | object | |\n| props.items | Array.<number> | ids of items to recycle |\n| [props.origin] | string | |\n| props.url | string | site relative url |\n| props.listGUID | string | use either listGUID or listTitle not both |\n| [props.listTitle] | string | |\n| [props.itemCreatedCB] | itemPreProcessing | this call back is called when an item is added to be processed |\n| [props.itemCompletedCB] | itemCompletedProcessing | this call back is called when item is completed |\n\n\n\n### pdspserverajax~itemCompletedProcessing : function\nThe processingCompletedCallback will be passed the order number and the process status (success or fail) to trigger any completed side effects\rThe order number is your id to locate elements (dom or whatever) based on the specific item processing\n\n**Kind**: inner typedef of [pdspserverajax](#module_pdspserverajax) \n\n| Param | Type |\n| --- | --- |\n| status | string | \n| index | number | \n\n\n\n### pdspserverajax~itemPreProcessing : function\nThe index and itemData to process will be passed to this function\rit MUST return a native promise.\rthe order number is your id to locate elements (dom or whatever) based on the specific item processing\n\n**Kind**: inner typedef of [pdspserverajax](#module_pdspserverajax) \n\n| Param | Type |\n| --- | --- |\n| itemData | any | \n| index | number | \n\n","maintainers":[{"name":"puredirective","email":"puredirective@gmail.com"}],"time":{"modified":"2022-06-23T16:27:15.558Z","created":"2017-05-29T15:54:33.219Z","0.0.1":"2017-05-29T15:54:33.219Z","1.1.0":"2017-06-14T01:38:20.565Z","1.2.0":"2017-06-23T01:25:40.986Z","1.2.1":"2017-06-25T14:09:24.069Z","1.2.2":"2017-06-25T14:17:32.473Z","1.2.3":"2017-06-26T23:46:48.259Z","1.2.4":"2017-06-27T00:03:17.711Z","1.2.5":"2017-06-27T22:24:18.032Z","1.2.6":"2017-07-25T02:33:03.882Z","2.0.0":"2017-08-04T01:32:13.283Z","2.0.1":"2017-09-04T00:40:52.108Z","2.0.2":"2017-09-04T12:09:45.427Z","2.1.0":"2017-09-04T23:54:53.275Z","2.1.1":"2017-09-06T01:52:59.540Z","2.1.2":"2017-09-08T23:10:06.501Z","2.1.3":"2017-09-15T01:24:13.506Z","2.1.4":"2017-10-09T00:30:21.300Z","2.1.5":"2018-02-06T00:06:57.560Z","2.1.6":"2018-02-06T01:23:05.608Z","2.1.8":"2018-03-30T10:33:21.962Z","2.2.0":"2018-09-30T18:00:36.608Z"},"license":"ISC","readmeFilename":"README.md","description":"","users":{"tmurph850":true},"homepage":"https://github.com/JoHoN8/pd-spserverajax#readme","keywords":["sharepoint","sharepoint REST","sharepoint ajax"],"repository":{"type":"git","url":"git+https://github.com/JoHoN8/pd-spserverajax.git"},"author":{"name":"Jered McGlohon","email":"puredirective@gmail.com","url":"https://github.com/JoHoN8"},"bugs":{"url":"https://github.com/JoHoN8/pd-spserverajax/issues"}}