Support 'file description' in LargeFileUploadTask. (#533)

microsoftgraph · Dec 10, 2021 · f1fda65 · f1fda65
1 parent 5183690
commit f1fda65
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/samples/typescript/tasks/OneDriveLargeFileUploadTask.ts b/samples/typescript/tasks/OneDriveLargeFileUploadTask.ts
@@ -22,6 +22,7 @@ import { client } from "../clientInitialization/ClientWithOptions";
 async function upload() {
 	const file = fs.createReadStream("./test.pdf");
 	const fileName = "FILENAME";
+	const fileDescription = "FILEDESCRIPTION";
 	const stats = fs.statSync(`./test.pdf`);
 	const totalSize = stats.size;
 
@@ -38,6 +39,7 @@ async function upload() {
 
 	const options: OneDriveLargeFileUploadOptions = {
 		fileName,
+		fileDescription,
 		conflictBehavior: "rename",
 		rangeSize: 1024 * 1024,
 		uploadEventHandlers,

diff --git a/src/tasks/OneDriveLargeFileUploadTask.ts b/src/tasks/OneDriveLargeFileUploadTask.ts
@@ -20,13 +20,15 @@ import { getValidRangeSize } from "./OneDriveLargeFileUploadTaskUtil";
  * @interface
  * Signature to define options when creating an upload task
  * @property {string} fileName - Specifies the name of a file to be uploaded (with extension)
+ * @property {string} [fileDescription] - Specifies the description of the file to be uploaded
  * @property {string} [path] - The path to which the file needs to be uploaded
  * @property {number} [rangeSize] - Specifies the range chunk size
  * @property {string} [conflictBehavior] - Conflict behaviour option
  * @property {UploadEventHandlers} [uploadEventHandlers] - UploadEventHandlers attached to an upload task
  */
 export interface OneDriveLargeFileUploadOptions {
 	fileName: string;
+	fileDescription?: string;
 	path?: string;
 	rangeSize?: number;
 	conflictBehavior?: string;
@@ -37,10 +39,12 @@ export interface OneDriveLargeFileUploadOptions {
  * @interface
  * Signature to define options when creating an upload task
  * @property {string} fileName - Specifies the name of a file to be uploaded (with extension)
+ * @property {string} [fileDescription] - Specifies the description of the file to be uploaded
  * @property {string} [conflictBehavior] - Conflict behaviour option
  */
 interface OneDriveFileUploadSessionPayLoad {
 	fileName: string;
+	fileDescription?: string;
 	conflictBehavior?: string;
 }
 
@@ -160,6 +164,7 @@ export class OneDriveLargeFileUploadTask<T> extends LargeFileUploadTask<T> {
 		const requestUrl = OneDriveLargeFileUploadTask.constructCreateSessionUrl(options.fileName, options.path);
 		const uploadSessionPayload: OneDriveFileUploadSessionPayLoad = {
 			fileName: options.fileName,
+			fileDescription: options.fileDescription,
 			conflictBehavior: options.conflictBehavior,
 		};
 		const session = await OneDriveLargeFileUploadTask.createUploadSession(client, requestUrl, uploadSessionPayload);
@@ -185,6 +190,7 @@ export class OneDriveLargeFileUploadTask<T> extends LargeFileUploadTask<T> {
 			item: {
 				"@microsoft.graph.conflictBehavior": payloadOptions?.conflictBehavior || "rename",
 				name: payloadOptions?.fileName,
+				description: payloadOptions?.fileDescription,
 			},
 		};
 		return super.createUploadSession(client, requestUrl, payload);