jsdoc/SpRestApi.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Class: SpRestApi</title>

    <script src="scripts/prettify/prettify.js"> </script>
    <script src="scripts/prettify/lang-css.js"> </script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>

<body>

<div id="main">

    <h1 class="page-title">Class: SpRestApi</h1>

    
<section>

<header>
    
        <h2>SpRestApi</h2>
        
            <div class="class-description">SpRestApi</div>
        
    
</header>

<article>
    <div class="container-overview">
    
        
    <h2>Constructor</h2>
    

    <h4 class="name" id="SpRestApi"><span class="type-signature"></span>new SpRestApi<span class="signature">(options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>

    
<div class="description">
    Initializes a new instance of the SpRestApi class, which contains methodsfor calling the SharePoint REST API.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>options</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="global.html#SpRestApiOptions">SpRestApiOptions</a></span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">The optional settings to override the     defaults.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="sp-rest-api.js.html">sp-rest-api.js</a>, <a href="sp-rest-api.js.html#line7">line 7</a>
    </li></ul></dd>
    

</dl>


    </div>

    
        <h3 class="subsection-title">Members</h3>

        
<h4 class="name" id="cachedListItems"><span class="type-signature"></span>cachedListItems<span class="type-signature"> :Array.&lt;Object></span></h4>


<div class="description">
    Array of cached SharePoint list items. Stores the data during the recursivefetch (options.recursiveFetch = true), and is cleared after anotherfetch operation begins.
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Array.&lt;Object></span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="sp-rest-api.js.html">sp-rest-api.js</a>, <a href="sp-rest-api.js.html#line119">line 119</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="options"><span class="type-signature"></span>options<span class="type-signature"> :<a href="global.html#SpRestApiOptions">SpRestApiOptions</a></span></h4>


<div class="description">
    Stores this instance's options.
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><a href="global.html#SpRestApiOptions">SpRestApiOptions</a></span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="sp-rest-api.js.html">sp-rest-api.js</a>, <a href="sp-rest-api.js.html#line111">line 111</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="~digestField"><span class="type-signature">(inner) </span>digestField<span class="type-signature"> :<a href="global.html#SpRestApiOptions">SpRestApiOptions</a></span></h4>


<div class="description">
    The default options that will be used unless overridden.
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><a href="global.html#SpRestApiOptions">SpRestApiOptions</a></span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="sp-rest-api.js.html">sp-rest-api.js</a>, <a href="sp-rest-api.js.html#line21">line 21</a>
    </li></ul></dd>
    

</dl>


        <h3 class="subsection-title">Methods</h3>

        
    <h4 class="name" id=".appendFilters"><span class="type-signature">(static) </span>appendFilters<span class="signature">(url, filters)</span><span class="type-signature"> &rarr; {string}</span></h4>

    
<div class="description">
    Appends the $filter query string to the SharePoint REST API URL.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>url</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">The base URL to which we need to append the string.     May contain other query string parameters.</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>filters</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>
|

<span class="param-type">Array.&lt;string></span>


            </td>

            
            <td class="description last">Which columns to select from a     list (instead of fetching all columns).</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="sp-rest-api.js.html">sp-rest-api.js</a>, <a href="sp-rest-api.js.html#line238">line 238</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    An URL with a string lie "...?$Filter=Title eq 'Test'".
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">string</span>


    </dd>
</dl>

    
    <h4 class="name" id=".appendSelectQueryString"><span class="type-signature">(static) </span>appendSelectQueryString<span class="signature">(url, select)</span><span class="type-signature"> &rarr; {string}</span></h4>

    
<div class="description">
    Appends the $select query string to the SharePoint REST API URL.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>url</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">The base URL to which we need to append the string.     May contain other query string parameters.</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>select</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>
|

<span class="param-type">Array.&lt;string></span>


            </td>

            
            <td class="description last">Which columns to select from a     list (instead of fetching all columns).</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="sp-rest-api.js.html">sp-rest-api.js</a>, <a href="sp-rest-api.js.html#line217">line 217</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    An URL like "...?$select=Id,Title,Approver/Title".
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">string</span>


    </dd>
</dl>

    
    <h4 class="name" id=".compactArray"><span class="type-signature">(static) </span>compactArray<span class="signature">(sourceArray)</span><span class="type-signature"> &rarr; {Array.&lt;any>}</span></h4>

    
<div class="description">
    Removes undefined, null and empty string '' values from the array andreturns a newly created array. Ideally we'd extend the Array.prototype withthis method, but due to a bug in SharePoint's wpadder.debug.js it is notpossible. See https://medium.com/@anton_ivanov/8e0dda134f79
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>sourceArray</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;any></span>


            </td>

            
            <td class="description last">An array that possibly contains empty     strings, undefined or null values.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="sp-rest-api.js.html">sp-rest-api.js</a>, <a href="sp-rest-api.js.html#line579">line 579</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    A copy of the array with the null, undefined and     empty string value removed.
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Array.&lt;any></span>


    </dd>
</dl>

    
    <h4 class="name" id=".getListItemType"><span class="type-signature">(static) </span>getListItemType<span class="signature">(listTitle)</span><span class="type-signature"> &rarr; {string}</span></h4>

    
<div class="description">
    Generates the ListItemType which is required by SharePoint when creating anew list item. It is based on the list name where characters such as spacesare replaced with sequences like _x0020_.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>listTitle</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">The display name of the list where we are     creating the new list item.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="sp-rest-api.js.html">sp-rest-api.js</a>, <a href="sp-rest-api.js.html#line445">line 445</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    A SharePoint list item type which looks like     'SP.Data.ProjectsListItem'.
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">string</span>


    </dd>
</dl>

    
    <h4 class="name" id=".replaceSharepointSpecialChars"><span class="type-signature">(static) </span>replaceSharepointSpecialChars<span class="signature">(inputString)</span><span class="type-signature"> &rarr; {string}</span></h4>

    
<div class="description">
    Replaces special characters (like underscores and spaces) thatcannot be used in SharePoint list names because SharePoint changes them to escape sequences, as seen in the function.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>inputString</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">A string that may contain an underscore or a     space, which will be replaced.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="sp-rest-api.js.html">sp-rest-api.js</a>, <a href="sp-rest-api.js.html#line460">line 460</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    The string that is safe to use in SharePoint list item     internal type.
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">string</span>


    </dd>
</dl>

    
    <h4 class="name" id="addMaxItems"><span class="type-signature"></span>addMaxItems<span class="signature">(url)</span><span class="type-signature"> &rarr; {string}</span></h4>

    
<div class="description">
    Adds the $top= string to the specified URL, to limit the max number ofitems in the response.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>url</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">the URL to add the $top string to.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="sp-rest-api.js.html">sp-rest-api.js</a>, <a href="sp-rest-api.js.html#line153">line 153</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    The URL with the added '?'/'&' character and the $top=     URL parameter.
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">string</span>


    </dd>
</dl>

    
    <h4 class="name" id="config"><span class="type-signature"></span>config<span class="signature">(options)</span><span class="type-signature"> &rarr; {<a href="SpRestApi.html">SpRestApi</a>}</span></h4>

    
<div class="description">
    Sets the SpRestApiOptions. If not called, before the request to server,the default options will be used.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>options</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="global.html#SpRestApiOptions">SpRestApiOptions</a></span>


            </td>

            
            <td class="description last">The partial SpRestApiOptions object,     where each field will override a default setting in `.defaultOptions`.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="sp-rest-api.js.html">sp-rest-api.js</a>, <a href="sp-rest-api.js.html#line140">line 140</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    This SpRestApi instance.
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="SpRestApi.html">SpRestApi</a></span>


    </dd>
</dl>

    
    <h4 class="name" id="continueRecursiveFetch"><span class="type-signature"></span>continueRecursiveFetch<span class="signature">()</span><span class="type-signature"></span></h4>

    
<div class="description">
    Keeps loading data recursively until all list items are obtained. This isto overcome SharePoint's limitation on the number of list items per query.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="sp-rest-api.js.html">sp-rest-api.js</a>, <a href="sp-rest-api.js.html#line303">line 303</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="createItem"><span class="type-signature"></span>createItem<span class="signature">(item)</span><span class="type-signature"></span></h4>

    
<div class="description">
    Creates a new item in a SharePoint list.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>item</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last">The new SharePoint list item to be created. No need     to add the __metadata attribute.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="sp-rest-api.js.html">sp-rest-api.js</a>, <a href="sp-rest-api.js.html#line369">line 369</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="deleteItem"><span class="type-signature"></span>deleteItem<span class="signature">(itemId)</span><span class="type-signature"></span></h4>

    
<div class="description">
    Deletes a single item from a SharePoint list.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>itemId</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            </td>

            
            <td class="description last">The SharePoint list item ID of the item to be     deleted.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="sp-rest-api.js.html">sp-rest-api.js</a>, <a href="sp-rest-api.js.html#line404">line 404</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="generateGetAllListItemsUrl"><span class="type-signature"></span>generateGetAllListItemsUrl<span class="signature">()</span><span class="type-signature"> &rarr; {string}</span></h4>

    
<div class="description">
    Generates the URL for fetching all items from a list. Uses in getAllItems()and in getAllItemsFromSubfolder(), as well as to create/POST a new item.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="sp-rest-api.js.html">sp-rest-api.js</a>, <a href="sp-rest-api.js.html#line185">line 185</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    The SP API URL for fetching all items from a list.
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">string</span>


    </dd>
</dl>

    
    <h4 class="name" id="generateSingleListItemUrl"><span class="type-signature"></span>generateSingleListItemUrl<span class="signature">(itemId)</span><span class="type-signature"> &rarr; {string}</span></h4>

    
<div class="description">
    Generates the URL for getting, updating or deleting a single list item.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>itemId</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            </td>

            
            <td class="description last">The list item ID of the item to be deleted.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="sp-rest-api.js.html">sp-rest-api.js</a>, <a href="sp-rest-api.js.html#line200">line 200</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    An URL ending with e.g. /Lists('MyList')/Items(761)
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">string</span>


    </dd>
</dl>

    
    <h4 class="name" id="getAllItems"><span class="type-signature"></span>getAllItems<span class="signature">()</span><span class="type-signature"></span></h4>

    
<div class="description">
    Returns all items from a list, or all items up to the SharePoint limitor the limit specified in the options.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="sp-rest-api.js.html">sp-rest-api.js</a>, <a href="sp-rest-api.js.html#line164">line 164</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="getAllItemsFromListSubfolder"><span class="type-signature"></span>getAllItemsFromListSubfolder<span class="signature">(subfolderName)</span><span class="type-signature"></span></h4>

    
<div class="description">
    Returns all list items from a subfolder of a SharePoint list. Uses a hackyway - by matching a substring of the FileRef, to avoid relying on CAML.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>subfolderName</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">The display name of the subfolder in a list.     Must not include any slashes.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="sp-rest-api.js.html">sp-rest-api.js</a>, <a href="sp-rest-api.js.html#line266">line 266</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="getContextInfo"><span class="type-signature"></span>getContextInfo<span class="signature">()</span><span class="type-signature"></span></h4>

    
<div class="description">
    Fetches the context information, most importantly authorization tokenand its expiration time.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="sp-rest-api.js.html">sp-rest-api.js</a>, <a href="sp-rest-api.js.html#line564">line 564</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="getCurrentUser"><span class="type-signature"></span>getCurrentUser<span class="signature">()</span><span class="type-signature"></span></h4>

    
<div class="description">
    Fetches the information about the current user, such as email, groups etc.Wrapper for getUserById(), gets the current user ID automatically.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="sp-rest-api.js.html">sp-rest-api.js</a>, <a href="sp-rest-api.js.html#line429">line 429</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="getItem"><span class="type-signature"></span>getItem<span class="signature">(itemId)</span><span class="type-signature"></span></h4>

    
<div class="description">
    Returns a single item from a list.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>itemId</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            </td>

            
            <td class="description last">The SharePoint list item ID of the item we need to     fetch.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="sp-rest-api.js.html">sp-rest-api.js</a>, <a href="sp-rest-api.js.html#line356">line 356</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="getUserById"><span class="type-signature"></span>getUserById<span class="signature">(userId)</span><span class="type-signature"></span></h4>

    
<div class="description">
    Fetches the SharePoint user information, including the Groups that he is amember of.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>userId</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            </td>

            
            <td class="description last">The SharePoint user ID of the user whose information     we are requesting.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="sp-rest-api.js.html">sp-rest-api.js</a>, <a href="sp-rest-api.js.html#line415">line 415</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="lists"><span class="type-signature"></span>lists<span class="signature">(listTitle)</span><span class="type-signature"> &rarr; {<a href="SpRestApi.html">SpRestApi</a>}</span></h4>

    
<div class="description">
    Sets the list title (list display name) of this SpRestApi instance.The .lists() must be called before any call to other list-relatedmethods. Equivalent to .config({listTitle: 'List Name'}).
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>listTitle</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">The display name of the SharePoint list.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="sp-rest-api.js.html">sp-rest-api.js</a>, <a href="sp-rest-api.js.html#line128">line 128</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    Returns the instance of this SpRestApi object.
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="SpRestApi.html">SpRestApi</a></span>


    </dd>
</dl>

    
    <h4 class="name" id="loadUrl"><span class="type-signature"></span>loadUrl<span class="signature">(url, method, success, error, data<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>

    
<div class="description">
    A generic function to call any URL of the SharePoint REST API. Usuallythere is no need to call this method directly.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>url</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last">The URL of the SharePoint REST API to be queried. Will     not be modified by this method.</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>method</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last">HTTP method for this request, e.g. 'GET', 'POST',     'DELETE'.</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>success</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last">Callback for successfull REST API call.</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>error</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last">Callback for failed REST API call.</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>data</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">The data to be POSTed/PUT to the server.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="sp-rest-api.js.html">sp-rest-api.js</a>, <a href="sp-rest-api.js.html#line478">line 478</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="refreshDigest"><span class="type-signature"></span>refreshDigest<span class="signature">(callback)</span><span class="type-signature"></span></h4>

    
<div class="description">
    Sends a request to SharePoint to get the SharePoint authorization token,which is required for all data requests. This is necessary in two cases:- We are loading this script from a non-SharePoint page (e.g. normal HTML);- We are refreshing the token (which expires after 30 minutes).
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>callback</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>


            </td>

            
            <td class="description last">The callback to run after the authorization     token is received successfully.Do not reuse the SpRestApi object that is used to refreshDigest to fetchother information, because onsuccess and onerror callbacks will be replaced.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="sp-rest-api.js.html">sp-rest-api.js</a>, <a href="sp-rest-api.js.html#line522">line 522</a>
    </li></ul></dd>
    

</dl>


<h5>Throws:</h5>

        
    <div class="param-desc">
    
        an exception if the token could not be refreshed.
    
    </div>


    <h4 class="name" id="updateItem"><span class="type-signature"></span>updateItem<span class="signature">(listItemId, item)</span><span class="type-signature"></span></h4>

    
<div class="description">
    Updates a single item in the SharePoint list. Only the values in columnsspecified in `data` will be overwritten.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>listItemId</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            </td>

            
            <td class="description last">The SharePoint list item ID of the item to be     updated.</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>item</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last">The partial or full SharePoint list item containing     only the columns that need to be replaced.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="sp-rest-api.js.html">sp-rest-api.js</a>, <a href="sp-rest-api.js.html#line388">line 388</a>
    </li></ul></dd>
    

</dl>


</article>

</section>


</div>

<nav>
    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="SpRestApi.html">SpRestApi</a></li></ul><h3><a href="global.html">Global</a></h3>
</nav>

<br class="clear">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Wed Aug 16 2017 17:08:49 GMT+0800 (China Standard Time)
</footer>

<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>