Merge pull request #588 from patrick-rodgers/dev

adding support for list.RenderListDataAsStream

Author: patrick-rodgers

src/sharepoint/lists.ts

@@ -8,7 +8,7 @@ import { SharePointQueryable, SharePointQueryableInstance, SharePointQueryableCo
 import { SharePointQueryableSecurable } from "./sharepointqueryablesecurable";
 import { Util } from "../utils/util";
 import { TypedHash } from "../collections/collections";
-import { ControlMode, RenderListData, ChangeQuery, CamlQuery, ChangeLogitemQuery, ListFormData } from "./types";
+import { ControlMode, RenderListData, ChangeQuery, CamlQuery, ChangeLogitemQuery, ListFormData, RenderListDataParameters } from "./types";
 import { UserCustomActions } from "./usercustomactions";
 import { spExtractODataId } from "./odata";
 import { NotSupportedInBatchException } from "../utils/exceptions";
@@ -379,6 +379,28 @@ export class List extends SharePointQueryableSecurable {
         });
     }
 
+    /**
+     * Returns the data for the specified query view
+     * 
+     * @param parameters The parameters to be used to render list data as JSON string.
+     * @param overrideParameters The parameters that are used to override and extend the regular SPRenderListDataParameters.
+     */
+    public renderListDataAsStream(parameters: RenderListDataParameters, overrideParameters: any = null): Promise<any> {
+
+        const postBody = {
+            overrideParameters: Util.extend({
+                "__metadata": { "type": "SP.RenderListDataOverrideParameters" },
+            }, overrideParameters),
+            parameters: Util.extend({
+                "__metadata": { "type": "SP.RenderListDataParameters" },
+            }, parameters),
+        };
+
+        return this.clone(List, "RenderListDataAsStream", true).postCore({
+            body: JSON.stringify(postBody),
+        });
+    }
+
     /**
      * Gets the field values and field schema attributes for a list item.
      */

src/sharepoint/types.ts

@@ -1388,3 +1388,18 @@ export interface WikiPageCreationInformation {
      */
     WikiHtmlContent: string;
 }
+
+export enum RenderListDataOptions {
+    None = 0,
+    ContextInfo = 1,
+    ListData = 2,
+    ListSchema = 4,
+    MenuView = 8,
+}
+
+export interface RenderListDataParameters {
+    ViewXml?: string;
+    Paging?: string;
+    FolderServerRelativeUrl?: string;
+    RenderOptions?: RenderListDataOptions;
+}