[ { "path": ".gitignore", "content": "*.sln.docstates\n*.suo\n*.user\n*.userosscache\n*.sln.ide\nTestResults/*\n.vs/*\n\n# UWP project files\nproject.lock.json\n*StoreKey.pfx\nPackage.StoreAssociation.xml\n\n# Build results\n**/[Dd]ebug/\n**/[Dd]ebugPublic/\n**/[Rr]elease/\n**/[Rr]eleases/\n**/x64/\n**/x86/\n**/build/\n**/bld/\n**/[Bb]in/\n**/[Oo]bj/\n/lib\n\n# NuGet\n*.nupkg\n**/packages/*\n!**/packages/build/\n\n# VS project upgrade files\n_UpgradeReport_Files/\nBackup*/\nUpgradeLog*.XML\nUpgradeLog*.htm" }, { "path": "Common/Microsoft.OneDriveSDK.nuspec", "content": "\n\n \n Microsoft.OneDriveSDK\n 2.0.7\n OneDrive .NET SDK\n Microsoft\n Microsoft\n false\n Integrate the OneDrive API into your .NET App!\n Copyright 2016 Microsoft Corporation\n https://github.com/OneDrive/onedrive-sdk-csharp\n http://msdn.microsoft.com/en-US/cc300389\n https://dev.onedrive.com/images/OneDriveCloud.png\n onedrive sharepoint files livesdk liveconnect cloud storage microsoftaccount windowsliveid microsoftid windowsphone windowsstore metro xaml html\n \n \n \n \n \n \n\n \n \n \n \n \n" }, { "path": "LICENSE.txt", "content": "OneDrive SDK for CSharp\n\nCopyright 2015 Microsoft Corporation\n\nAll right reserved.\n\nMIT License\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in\nall copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\nTHE SOFTWARE.\n" }, { "path": "OneDriveSdk.sln", "content": "\nMicrosoft Visual Studio Solution File, Format Version 12.00\n# Visual Studio 14\nVisualStudioVersion = 14.0.25123.0\nMinimumVisualStudioVersion = 10.0.40219.1\nProject(\"{2150E333-8FDC-42A3-9474-1A3956D46DE8}\") = \"src\", \"src\", \"{2EFD6E75-C1E0-4600-88D6-BFEDAD24A50A}\"\n\tProjectSection(SolutionItems) = preProject\n\t\tCommon\\Microsoft.OneDriveSDK.nuspec = Common\\Microsoft.OneDriveSDK.nuspec\n\tEndProjectSection\nEndProject\nProject(\"{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}\") = \"Microsoft.OneDrive.Sdk\", \"src\\OneDriveSdk\\Microsoft.OneDrive.Sdk.csproj\", \"{1368527B-D7B2-46AD-893D-6DC8C073D819}\"\nEndProject\nProject(\"{2150E333-8FDC-42A3-9474-1A3956D46DE8}\") = \"tests\", \"tests\", \"{369050EF-15AF-4B0E-98DF-085B91E1B68D}\"\nEndProject\nProject(\"{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}\") = \"Test.OneDrive.Sdk\", \"tests\\Test.OneDriveSdk\\Test.OneDrive.Sdk.csproj\", \"{E3A990AA-5628-42AA-A8D4-1C599602DD96}\"\nEndProject\nGlobal\n\tGlobalSection(SolutionConfigurationPlatforms) = preSolution\n\t\tDebug|Any CPU = Debug|Any CPU\n\t\tDebug|ARM = Debug|ARM\n\t\tDebug|x64 = Debug|x64\n\t\tDebug|x86 = Debug|x86\n\t\tRelease|Any CPU = Release|Any CPU\n\t\tRelease|ARM = Release|ARM\n\t\tRelease|x64 = Release|x64\n\t\tRelease|x86 = Release|x86\n\tEndGlobalSection\n\tGlobalSection(ProjectConfigurationPlatforms) = postSolution\n\t\t{1368527B-D7B2-46AD-893D-6DC8C073D819}.Debug|Any CPU.ActiveCfg = Debug|Any CPU\n\t\t{1368527B-D7B2-46AD-893D-6DC8C073D819}.Debug|Any CPU.Build.0 = Debug|Any CPU\n\t\t{1368527B-D7B2-46AD-893D-6DC8C073D819}.Debug|ARM.ActiveCfg = Debug|Any CPU\n\t\t{1368527B-D7B2-46AD-893D-6DC8C073D819}.Debug|ARM.Build.0 = Debug|Any CPU\n\t\t{1368527B-D7B2-46AD-893D-6DC8C073D819}.Debug|x64.ActiveCfg = Debug|Any CPU\n\t\t{1368527B-D7B2-46AD-893D-6DC8C073D819}.Debug|x64.Build.0 = Debug|Any CPU\n\t\t{1368527B-D7B2-46AD-893D-6DC8C073D819}.Debug|x86.ActiveCfg = Debug|Any CPU\n\t\t{1368527B-D7B2-46AD-893D-6DC8C073D819}.Debug|x86.Build.0 = Debug|Any CPU\n\t\t{1368527B-D7B2-46AD-893D-6DC8C073D819}.Release|Any CPU.ActiveCfg = Release|Any CPU\n\t\t{1368527B-D7B2-46AD-893D-6DC8C073D819}.Release|Any CPU.Build.0 = Release|Any CPU\n\t\t{1368527B-D7B2-46AD-893D-6DC8C073D819}.Release|ARM.ActiveCfg = Release|Any CPU\n\t\t{1368527B-D7B2-46AD-893D-6DC8C073D819}.Release|ARM.Build.0 = Release|Any CPU\n\t\t{1368527B-D7B2-46AD-893D-6DC8C073D819}.Release|x64.ActiveCfg = Release|Any CPU\n\t\t{1368527B-D7B2-46AD-893D-6DC8C073D819}.Release|x64.Build.0 = Release|Any CPU\n\t\t{1368527B-D7B2-46AD-893D-6DC8C073D819}.Release|x86.ActiveCfg = Release|Any CPU\n\t\t{1368527B-D7B2-46AD-893D-6DC8C073D819}.Release|x86.Build.0 = Release|Any CPU\n\t\t{E3A990AA-5628-42AA-A8D4-1C599602DD96}.Debug|Any CPU.ActiveCfg = Debug|Any CPU\n\t\t{E3A990AA-5628-42AA-A8D4-1C599602DD96}.Debug|Any CPU.Build.0 = Debug|Any CPU\n\t\t{E3A990AA-5628-42AA-A8D4-1C599602DD96}.Debug|ARM.ActiveCfg = Debug|Any CPU\n\t\t{E3A990AA-5628-42AA-A8D4-1C599602DD96}.Debug|ARM.Build.0 = Debug|Any CPU\n\t\t{E3A990AA-5628-42AA-A8D4-1C599602DD96}.Debug|x64.ActiveCfg = Debug|Any CPU\n\t\t{E3A990AA-5628-42AA-A8D4-1C599602DD96}.Debug|x64.Build.0 = Debug|Any CPU\n\t\t{E3A990AA-5628-42AA-A8D4-1C599602DD96}.Debug|x86.ActiveCfg = Debug|Any CPU\n\t\t{E3A990AA-5628-42AA-A8D4-1C599602DD96}.Debug|x86.Build.0 = Debug|Any CPU\n\t\t{E3A990AA-5628-42AA-A8D4-1C599602DD96}.Release|Any CPU.ActiveCfg = Release|Any CPU\n\t\t{E3A990AA-5628-42AA-A8D4-1C599602DD96}.Release|ARM.ActiveCfg = Release|Any CPU\n\t\t{E3A990AA-5628-42AA-A8D4-1C599602DD96}.Release|x64.ActiveCfg = Release|Any CPU\n\t\t{E3A990AA-5628-42AA-A8D4-1C599602DD96}.Release|x86.ActiveCfg = Release|Any CPU\n\tEndGlobalSection\n\tGlobalSection(SolutionProperties) = preSolution\n\t\tHideSolutionNode = FALSE\n\tEndGlobalSection\n\tGlobalSection(NestedProjects) = preSolution\n\t\t{1368527B-D7B2-46AD-893D-6DC8C073D819} = {2EFD6E75-C1E0-4600-88D6-BFEDAD24A50A}\n\t\t{E3A990AA-5628-42AA-A8D4-1C599602DD96} = {369050EF-15AF-4B0E-98DF-085B91E1B68D}\n\tEndGlobalSection\nEndGlobal\n" }, { "path": "README.md", "content": "# OneDrive SDK for CSharp\n\n[![Build status](https://ci.appveyor.com/api/projects/status/fs9ddrmdev37v012/branch/master?svg=true)](https://ci.appveyor.com/project/OneDrive/onedrive-sdk-csharp/branch/master)\n\nIntegrate the [OneDrive API](https://dev.onedrive.com/README.htm) into your C#\nproject!\n\nThe OneDrive SDK is built as a Portable Class Library and targets the following\nframeworks: \n\n* .NET 4.5.1 \n* .NET for Windows Store apps \n* Windows Phone 8.1 and higher\n\nAzure Active Directory authentication is available for:\n\n* Windows Forms apps\n* UWP apps\n* Windows 8.1 apps\n\n## Installation via Nuget\n\nTo install the OneDrive SDK via NuGet\n\n* Search for `Microsoft.OneDriveSDK` in the NuGet Library, or\n* Type `Install-Package Microsoft.OneDriveSDK` into the Package Manager Console.\n\n## Getting started\n\n### 1. Register your application\n\nRegister your application for OneDrive by following [these](https://dev.onedrive.com/app-registration.htm) steps.\n\n### 2. Setting your application Id and scopes\n\nYour app must requests permissions in order to access a user's OneDrive. To do this, specify your app ID and scopes, or permission level.\nFor more information, see [Authentication scopes](https://dev.onedrive.com/auth/msa_oauth.htm#authentication-scopes).\n\n### 3. Getting an authenticated OneDriveClient object\n\nYou must get a **OneDriveClient** object in order for your app to make requests to the service, but first you must have an instance of an object that implements `IAuthenticationProvider` in Microsoft.Graph.Core.\nAn example of such an imlementation can be found [MSA Auth Adapter repository](https://github.com/OneDrive/onedrive-sdk-dotnet-msa-auth-adapter). You should create the `IAuthenticationProvider`, authenticate\nusing `AuthenticateUserAsync()`, and then create a `OneDriveClient` using the auth provider as a constructor argument. You must also provide the ClientId of your app, the return URL you have specified for your app,\nand the base URL for the API. Below is a sample of that pattern for authentication on the OneDrive service.\n\n```csharp\nvar msaAuthProvider = new myAuthProvider(\n myClientId,\n \"https://login.live.com/oauth20_desktop.srf\",\n { \"onedrive.readonly\", \"wl.signin\" });\nawait msaAuthProvider.AuthenticateUserAsync();\nvar oneDriveClient = new OneDriveClient(\"https://api.onedrive.com/v1.0\", msaAuthProvider);\n```\n\nAfter that, you will be able to use the `oneDriveClient` object to make calls to the service. For more information, see [Authenticate your C# app for OneDrive](docs/auth.md).\n\n### 4. Making requests to the service\n\nOnce you have a OneDriveClient that is authenticated you can begin to make calls against the service. The requests against the service look like OneDrive's [REST API](https://dev.onedrive.com/README.htm).\n\nTo retrieve a user's drive:\n\n```csharp\n var drive = await oneDriveClient\n .Drive\n .Request()\n .GetAsync();\n```\n\n`GetAsync` will return a `Drive` object on success and throw a `Microsoft.Graph.ServiceException` on error.\n\nTo get the current user's root folder of their drive:\n\n```csharp\n var rootItem = await oneDriveClient\n .Drive\n .Root\n .Request()\n .GetAsync();\n```\n\n`GetAsync` will return an `Item` object on success and throw a `Microsoft.Graph.ServiceException` on error.\n\nFor a general overview of how the SDK is designed, see [overview](docs/overview.md).\n\nThe following sample applications are also available:\n* [OneDrive API Browser](https://github.com/OneDrive/onedrive-sample-apibrowser-dotnet) - Windows Forms app\n* [OneDrive Photo Browser](https://github.com/OneDrive/onedrive-sample-photobrowser-uwp) - Windows Universal app\n* [OneDrive Webhooks](https://github.com/OneDrive/onedrive-webhooks-aspnet) - ASP.NET MVC app\n\nTo run the OneDrivePhotoBrowser sample app your machine will need to be configured for [UWP app development](https://msdn.microsoft.com/en-us/library/windows/apps/dn609832.aspx) and the project must be associated with the Windows Store.\n\n## Documentation and resources\n\n* [Overview](docs/overview.md)\n* [Auth](docs/auth.md)\n* [Items](docs/items.md)\n* [Chunked uploads](docs/chunked-uploads.md)\n* [Collections](docs/collections.md)\n* [Errors](docs/errors.md)\n* [OneDrive API](http://dev.onedrive.com)\n\n## Issues\n\nTo view or log issues, see [issues](https://github.com/OneDrive/onedrive-sdk-csharp/issues).\n\n## Other resources\n\n* NuGet Package: [https://www.nuget.org/packages/Microsoft.OneDriveSDK](https://www.nuget.org/packages/Microsoft.OneDriveSDK)\n\n\n## License\n\n[License](LICENSE.txt)\n\nThis project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.\n" }, { "path": "docs/auth.md", "content": "Authenticate your C# app for OneDrive\n=====\n\nTo authenticate your app to use OneDrive, you need to instantiate an object that implements `IAuthenticationProvider` from Microsoft.Graph and call `AuthenticateAsync` on it. Then, you must create a `OneDriveClient` object and pass in your auth provider as an argument. Note that if the user changes their password, your app must re-authenticate. If you see `401` error codes, this is most likely the case. See [Error codes for the OneDrive C# SDK](errors.md) for more info.\n\n**Note** This topic assumes that you are familiar with app authentication. For more info about authentication in OneDrive, see [Authentication for the OneDrive API](https://dev.onedrive.com/auth/readme.htm).\n\n## Standard authentication components\n\nWhen implementing `IAuthenticationProvider`, a standard set of parameters will be required:\n\n| Parameter | Description |\n|:----------|:------------|\n| _clientId_ | The client ID of the app. Required. |\n| _returnUrl_ | A redirect URL. Required. |\n| _baseUrl_ | URL where the target OneDrive service is found. Required. |\n| _scopes_ | Permissions that your app requires from the user. Required. |\n| _client\\_secret_ | The client secret created for your app. Optional. Not available for Windows Store 8.1, Windows Phone 8.1, and Universal Windows Platform (UWP) apps. |\n\nIn addition to _clientId_, _returnURL_, _scopes_, and _client\\_secret_ the method takes in implementations for a client type, credential cache, HTTP provider, and a service info provider or web authentication UI. If not provided, the default implementations of each item will be used.\n\n### ClientType\nA single client can only call OneDrive for Consumer or OneDrive for Business, not both. The target service is configured implicitly by the `IAuthenticationProvider` and the _baseUrl_ passed into the `OneDriveClient` constructor.\n\nIf the application would like to interact with both OneDrive for Consumer and OneDrive for Business, a client should be created for each.\n\n\n## More Information\nMore information, and a fuller example of authentication, can be found at the [MSA Auth Adapter repository](https://github.com/OneDrive/onedrive-sdk-dotnet-msa-auth-adapter)." }, { "path": "docs/chunked-uploads.md", "content": "# Chunked Uploads\n## Uploading large files and pausing/resuming uploads\n\nChunked uploads are easy using `Helpers.ChunkedUploadProvider`. The easiest way to upload a large file\nlooks like this:\n\n```csharp\nvar session = await oneDriveClient.ItemWithPath(uploadPath).CreateSession().Request().PostAsync();\nvar provider = new ChunkedUploadProvider(session, oneDriveClient, fileStream);\n\nvar uploadedItem = await provider.UploadAsync();\n```\n\nYour file will upload in default-sized chunks (5MiB). You can also adjust chunk size by adding a parameter to the `ChunkedUploadProvider`\nconstructor: `new ChunkedUploadProvider(session, oneDriveClient, fileStream, 1024*1024); // 1 MiB`.\n\n## Controlling and Monitoring Large Uploads\n\nYou may want to monitor the progress of an upload (perhaps to show a progress bar to the user). You can get finer control of uploading each chunk using\nthe skeleton below. You will certainly need to make a few modifications. Also, you can check out how the [ChunkedUploadProvider](../src/OneDriveSdk/Helpers/ChunkedUploadProvider.cs)\n\n```csharp\n// Get the provider\nvar myMaxChunkSize = 5*1024*1024; // 5MB\nvar session = await oneDriveClient.ItemWithPath(uploadPath).CreateSession().Request().PostAsync();\nvar provider = new ChunkedUploadProvider(session, oneDriveClient, fileStream, myMaxChunkSize);\n\n// Setup the chunk request necessities\nvar chunkRequests = provider.GetUploadChunkRequests();\nvar readBuffer = new byte[myMaxChunkSize];\nvar trackedExceptions = new List();\nItem itemResult = null;\n\n//upload the chunks\nforeach(var request in chunkRequests)\n{\n // Do your updates here: update progress bar, etc.\n // ...\n // Send chunk request\n var result = await provider.GetChunkRequestResponseAsync(request, readBuffer, trackedExceptions);\n \n if(result.UploadSucceeded)\n {\n itemResult = result.ItemResponse;\n }\n}\n\n// Check that upload succeeded\nif (itemResult == null)\n{\n // Retry the upload\n // ...\n}\n```\n\n" }, { "path": "docs/collections.md", "content": "Collections in the OneDrive SDK for C#\n=====\n\nYou can use the OneDrive SDK for C# to work with item collections in OneDrive.\n\n## Getting a collection\n\nTo retrieve a collection, like a folder's children, you call `GetAsync`:\n\n```csharp\nawait oneDriveClient\n .Drive\n\t\t .Items[itemId]\n\t\t .Children\n\t\t .Request()\n\t\t .GetAsync();\n```\n\n`GetAsync` returns an `ICollectionPage` implementation on success and throws a `OneDriveException` on error. For children collections, the type returned is `IChildrenCollectionPage`, which inherits `ICollectionPage`.\n\n`IChildrenCollectionPage` contains three properties: \n\n|Name |Description |\n|--------------------|---------------------------------------------------------------------------------------------------------------------------------------------|\n|**CurrentPage** |An `IList`. |\n|**NextPageRequest** |An `IChildrenPageRequest` used to get to the next page of items, if another page exists. This value will be null if there is not a next page.|\n|**AdditionData** |An `IDictionary` to any additional values returned by the service. In this case, none. |\n\n## Adding to a collection\n\nSome collections, like the children of a folder, can be changed. To add a folder to the children of an item, you can call the `AddAsync` method:\n\n```csharp\nvar folderToCreate = new Item { Name = \"New folder\", Folder = new Folder() };\nvar newFolder = await oneDriveClient\n .Drive\n\t\t\t\t\t\t .Items[itemId]\n\t\t\t\t\t\t .Children\n\t\t\t\t\t\t .Request()\n\t\t\t\t\t\t .AddAsync(folderToCreate);\n```\n\n`AddAsync` returns the created item on success and throws a `OneDriveException` on error.\n\n## Expanding a collection\n\nTo expand a collection, you call `Expand` on the collection request object with the string value of the expand:\n\n```csharp\nvar children = await oneDriveClient\n .Drive\n\t\t\t\t\t\t .Items[itemId]\n\t\t\t\t\t\t .Children\n\t\t\t\t\t\t .Request()\n\t\t\t\t\t\t .Expand(\"thumbnails\")\n\t\t\t\t\t\t .GetAsync();\n```\n\n## Special collections\n\nSome API calls will return collections with added properties. These properties will always be in the additional data dictionary. These collections are also their own objects (subclasses of `ICollectionPage`) that will have these properties attached to them. \n\nTo get the delta of an item you call:\n\n```csharp\nvar deltaCollectionPage = await oneDriveClient\n .Drive\n\t\t\t\t\t\t\t\t\t.Items[itemId]\n\t\t\t\t\t\t\t\t\t.Delta(deltaToken)\n\t\t\t\t\t\t\t\t\t.Request()\n\t\t\t\t\t\t\t\t\t.GetAsync();\n```\n\n`IItemDeltaCollectionPage` is an `ICollectionPage` object with a `Token` property and a `DeltaLink` property. The token link can be used to pass into `Delta:` when you want to check for more changes. You can also construct a delta request with the `DeltaLink` property. The `NextPageRequest` is an `IItemDeltaRequest` to be used for paging purposes and will be null when there are no more changes." }, { "path": "docs/errors.md", "content": "Handling errors in the OneDrive SDK for C#\n=====\n\nErrors in the OneDrive SDK for C# behave just like errors returned from the OneDrive service. You can read more about them [here](https://github.com/OneDrive/onedrive-api-docs/blob/master/misc/errors.md).\n\nAnytime you make a request against the service there is the potential for an error. You will see that all requests to the service can return an error. In the case of an error, the request will throw a `OneDriveException` object with an inner `Error` object that contains the service error details.\n\n## Checking the error\n\nThere are a few different types of errors that can occur during a network call. These error codes are defined in [OneDriveErrorCodes.cs](../src/OneDriveSdk/Enums/OneDriveErrorCodes.cs).\n\n### Checking the error code\nYou can easily check if an error has a specific code by calling `IsMatch` on the error code value. `IsMatch` is not case sensitive:\n```csharp\nif (exception.IsMatch(OneDriveErrorCode.AccessDenied.ToString())\n{\n // Handle access denied error\n}\n```\n\nEach error object has a `Message` property as well as code. This message is for debugging purposes and is not be meant to be displayed to the user. Common error codes are defined in [OneDriveErrorCodes.cs](../src/OneDriveSdk/Enums/OneDriveErrorCodes.cs).\n\n\n### Authentication errors\n\nThere can be errors during the authentication process. Authentication errors will have the code `AuthenticationFailed`. Authentication cancelled errors will have the code `AuthenticationCancelled`.\n\n```csharp\nif (exception.IsMatch(OneDriveErrorCode.AuthenticationFailure.ToString())\n{\n // Handle auth error\n}\n```\n\nThe `Message` property will contain more detailed error information if available." }, { "path": "docs/items.md", "content": "Items in the OneDrive SDK for C#\n=====\n\nItems in the OneDrive SDK for C# behave just like items through the OneDrive API. All actions on items described in the OneDrive API are available through the SDK. For more information, see the [Items Reference](https://dev.onedrive.com/README.htm#item-resource). \n\nThe examples below assume that you have [Authenticated](/docs/auth.md) your app with a **OneDriveClient** object.\n\n* [Get an Item](#get-an-item)\n* [Delete an Item](#delete-an-item)\n* [Get Children for an Item](#get-children-for-an-item)\n* [Create a folder](#create-a-folder)\n* [Uploading contents](#uploading-contents)\n* [Downloading contents](#downloading-contents)\n* [Moving and updating an Item](#moving-and-updating-an-item)\n* [Copy an Item](#copy-an-item)\n\nGet an Item\n---------------\n### 1. By ID\n\n```csharp\nvar item = await oneDriveClient\n .Items[itemId]\n .Request()\n .GetAsync();\n```\n\n### 2. By path\n\n```csharp\nvar item = await oneDriveClient\n .Drive\n .Root\n .ItemWithPath(\"path/to/file/txt\")\n .Request()\n .GetAsync();\n```\n\nAccess an item by parent reference path:\n```csharp\nvar item = await oneDriveClient\n .ItemWithPath(parentItem.ParentReference.Path + \"/\" + parentItem.Name + \"/relative/path\")\n .Request()\n .GetAsync();\n```\n\nDelete an Item\n---------------\n```csharp\nawait oneDriveClient\n .Drive\n .Items[itemId]\n .Request()\n .DeleteAsync();\n```\n\nGet children for an Item\n-------------------------\n\nMore info about collections [here](/docs/collections.md).\n\n```csharp\nawait oneDriveClient\n .Drive\n .Items[itemId]\n .Children\n .Request()\n .GetAsync();\n```\n\nCreate a folder\n-------------------------\n\n### 1. By POST to a known folder ID\n\n```csharp\nvar folderToCreate = new Item { Folder = new Folder(), Name = \"folder name\" };\nvar createdFolder = await oneDriveClient\n .Drive\n .Items[itemId]\n .Children\n .Request()\n .AddAsync(folderToCreate);\n```\n\n### 2. By PUT to a known folder ID\n\n```csharp\nvar folderToCreate = new Item { Folder = new Folder() };\nvar createdFolder = await oneDriveClient\n .Drive\n .Items[itemId]\n .ItemWithPath(\"folder name\")\n .Request()\n .CreateAsync(folderToCreate);\n```\n\n### 3. By PUT with a given path\n\n```csharp\nvar folderToCreate = new Item { Folder = new Folder() };\nvar createdFolder = await oneDriveClient\n .Drive\n .Root\n .ItemWithPath(\"folder/subfolder\")\n .Request()\n .CreateAsync(folderToCreate);\n```\n\nNote: If the specified path does not exist, every folder name in the path will also be created.\n\nUploading contents\n------------------------------\n\n```csharp\nusing (contentStream)\n{\n var uploadedItem = await oneDriveClient\n .Drive\n .Root\n .ItemWithPath(\"path/to/file.txt\")\n .Content\n .Request()\n .PutAsync(contentStream);\n}\n```\n\nDownloading contents\n------------------------------\n\n```csharp\nvar contentStream = await oneDriveClient\n .Drive\n .Items[itemId]\n .Content\n .Request()\n .GetAsync();\n```\n\nMoving and updating an Item\n--------------\nTo [move](https://dev.onedrive.com/items/move.htm) an item you must update its parent reference.\n\n```csharp\nvar updateItem = new Item { ParentReference = new ItemReference { Id = newParentId } };\nvar itemWithUpdates = await oneDriveClient\n .Drive\n .Items[itemId]\n .Request()\n .UpdateAsync(updateItem);\n```\n\nTo change an item's name you could:\n\n```csharp\nvar updateItem = new Item { Name = \"New name!\" };\nvar itemWithUpdates = await oneDriveClient\n .Drive\n .Items[itemId]\n .Request()\n .UpdateAsync(updateItem);\n\n```\n\nCopy an Item\n---------------\nCopying an item is an async action described [here](https://dev.onedrive.com/items/copy.htm).\n\n```csharp\nvar asyncStatus = await oneDriveClient\n .Drive\n .Items[itemId]\n .Copy(newItemName, new ItemReference { Id = copyLocationId })\n .Request()\n .PostAsync(); \n```\n\nThe `Copy` action returns an `IItemCopyAsyncMonitor` instance that has a method to poll the monitor URL for completion. The poll method returns the created item on completion.\n\nTo poll until the copy action completes:\n\n```csharp\nvar newItem = await asyncStatus.CompleteOperationAsync(null, CancellationToken.None);\n```\n\n`CompleteOperationAsync` takes in an `IProgress` for reporting back progress status and a `CancellationToken` for action cancellation. The method will poll until completion unless cancelled.\n" }, { "path": "docs/overview.md", "content": "OneDrive SDK for CSharp overview\n=====\n\nThe OneDrive C# SDK is designed to look just like the [OneDrive API](https://github.com/onedrive/onedrive-api-docs/). \n\n## OneDriveClient\n\nWhen accessing the OneDrive APIs, all requests will be made through a **OneDriveClient** object. For a more detailed explanation, see [Authentication](/docs/auth.md).\n\n## Resource model\n\n\nResources, like [items](/docs/items.md) or drives, are represented by `Item` and `Drive`. These objects contain properties that represent the properties of a resource. These objects are property bags and cannot make calls against the service.\n\nTo get the name of an item you would address the `Name` property. It is possible for any of these properties to be null at any time. To check if an item is a folder you can address the `Folder` property of the item. If the item is a folder, a `Folder` object that contains all of the properties described by the [folder](https://github.com/OneDrive/onedrive-api-docs/blob/master/facets/folder_facet.md) facet will be returned.\n\nSee [Resource model](https://github.com/onedrive/onedrive-api-docs/#resource-model) for more information.\n\n## Requests\n\nTo make requests against the service, you construct request objects using a request builder object. The type of the request builder will depend on the type of the object you are addressing. This is meant to mimic creating the URL for any of the OneDrive APIs.\n\n### 1. Request builders\n\nTo generate a request you chain together calls on request builder objects. You get the first request builder from the `OneDriveClient` object. To get a drive request builder you call:\n\n|Task | SDK | URL |\n|:---------------|:---------------------:|:--------------------------------|\n|Get a drive | oneDriveClient.Drive | GET api.onedrive.com/v1.0/drive/|\n \nThe call will return an `IDriveRequestBuilder` object. From drive you can continue to chain the requests to get everything else in the API, like an item.\n\n|Task | SDK | URL |\n|:---------------|:------------------------------------:|:------------------------------------------|\n|Get an item | oneDriveClient.Drive.Items[\"1234\"] | GET api.onedrive.com/v1.0/drive/items/1234|\n\n\nHere `oneDriveClient.Drive` returns an `IDriveRequestBuilder` that contains a property `Items` of type `IItemsCollectionRequestBuilder`. That builder has an accessor for the item ID and Items[\"1234\"] returns an `IItemRequestBuilder`.\n\nSimilarly to get thumbnails:\n\n|Task | SDK | URL |\n|----------------|--------------------------------|--------------------------|\n| Get thumbnails | ... Items[\"1234\"].Thumbnails | .../items/1234/thumbnails|\n\n\nHere, `oneDriveClient.Drive.Items[\"1234\"]` returns an `IItemRequestBuilder` that contains the property Thumbnails of type `IThumbnailsCollectionRequestBuilder`.\n\nThis returns a collection of [thumbnail sets](https://github.com/OneDrive/onedrive-api-docs/blob/master/resources/thumbnailSet.md). To index the collection directly you can call:\n\n|Task | SDK | URL |\n|-------------------|-------------------------------------|----------------------------|\n| Get thumbnail Set | ... Items[\"1234\"].Thumbnails[\"0\"] | ...items/1234/thumbnails/0 |\n\nTo return a thumbnail set, and to get a specific [thumbnail](https://github.com/OneDrive/onedrive-api-docs/blob/master/resources/thumbnail.md), you can add the name of the thumbnail to the URL like this:\n\n|Task | SDK | URL |\n|-----------------|-----------------------------|------------------------|\n| Get a thumbnail | ... Thumbnails[\"0\"].Small | .../thumbnails/0/small |\n\n\n### 2. Request calls\n\nAfter you build the request you call the `Request` method on the request builder. This will construct the request object needed to make calls against the service.\n\nFor an item you call:\n\n```csharp\nvar itemRequest = oneDriveClient\n .Drive\n\t\t\t\t\t .Items[itemId]\n\t\t\t\t\t .Request();\n```\n\nAll request builders have a `Request` method that can generate a request object. Request objects may have different methods on them depending on the type of request. To get an item you call:\n\n```csharp\nvar item = await oneDriveClient\n .Drive\n\t\t\t\t\t .Items[itemId]\n\t\t\t\t\t .Request()\n\t\t\t\t\t .GetAsync();\n```\n\nFor more info, see [items](/docs/items.md) and [errors](/docs/errors.md).\n\n## Query options\n\nIf you only want to retrieve certain properties of a resource you can select them. Here's how to get only the names and IDs of an item:\n\n```csharp\nvar item = await oneDriveClient\n .Drive\n\t\t\t\t\t .Items[itemId]\n\t\t\t\t\t .Request()\n\t\t\t\t\t .Select(\"name,id\")\n\t\t\t\t\t .GetAsync();\n```\n\nAll properties other than `Name` and `Id` will be null on the item.\n\nTo expand certain properties on resources you can call a similar expand method, like this:\n\n```csharp\nvar item = await oneDriveClient\n .Drive\n\t\t\t\t\t .Items[itemId]\n\t\t\t\t\t .Request()\n\t\t\t\t\t .Expand(\"thumbnails,children(expand=thumbnails)\")\n\t\t\t\t\t .GetAsync();\n```\n\nThe above call will expand thumbnails and children for the item, as well as thumbnails for all of the children.\n" }, { "path": "src/OneDriveSdk/Constants.cs", "content": "// ------------------------------------------------------------------------------\n// Copyright (c) Microsoft Corporation. All Rights Reserved. Licensed under the MIT License. See License in the project root for license information.\n// ------------------------------------------------------------------------------\n\nnamespace Microsoft.OneDrive.Sdk\n{\n public static class Constants\n {\n public const int PollingIntervalInMs = 5000;\n\n public static class Headers\n {\n public const string SdkVersionHeaderPrefix = \"onedrive\";\n }\n\n public static class Url\n {\n public const string Drive = \"drive\";\n\n public const string Root = \"root\";\n\n public const string AppRoot = \"approot\";\n \n public const string Documents = \"documents\";\n \n public const string Photos = \"photos\";\n \n public const string CameraRoll = \"cameraroll\";\n \n public const string Music = \"music\";\n }\n }\n}\n" }, { "path": "src/OneDriveSdk/Enums/OneDriveErrorCode.cs", "content": "// ------------------------------------------------------------------------------\n// Copyright (c) Microsoft Corporation. All Rights Reserved. Licensed under the MIT License. See License in the project root for license information.\n// ------------------------------------------------------------------------------\n\nnamespace Microsoft.OneDrive.Sdk\n{\n public enum OneDriveErrorCode\n {\n AccessDenied,\n ActivityLimitReached,\n GeneralException,\n InvalidRange,\n InvalidRequest,\n ItemNotFound,\n MalwareDetected,\n NameAlreadyExists,\n NotAllowed,\n NotSupported,\n ResourceModified,\n ResyncRequired,\n ServiceNotAvailable,\n Timeout,\n TooManyRedirects,\n QuotaLimitReached,\n Unauthenticated,\n }\n}\n" }, { "path": "src/OneDriveSdk/Helpers/ChunkedUploadProvider.cs", "content": "// ------------------------------------------------------------------------------\n// Copyright (c) Microsoft Corporation. All Rights Reserved. Licensed under the MIT License. See License in the project root for license information.\n// ------------------------------------------------------------------------------\n\nnamespace Microsoft.OneDrive.Sdk.Helpers\n{\n using Microsoft.Graph;\n\n using System;\n using System.Collections.Generic;\n using System.IO;\n using System.Threading.Tasks;\n\n /// \n /// Use this class to make resumable uploads or to upload large files. This\n /// class allows the client to control the size of chunks uploaded (for example, can be useful\n /// to use small chunks if the connection is slow). Also allows the client to\n /// pause an upload and resume later.\n /// \n public class ChunkedUploadProvider\n {\n private const int DefaultMaxChunkSize = 5 * 1024 * 1024;\n private const int RequiredChunkSizeIncrement = 320 * 1024;\n\n public UploadSession Session { get; private set; }\n private IBaseClient client;\n private Stream uploadStream;\n private readonly int maxChunkSize;\n private List> rangesRemaining;\n private long totalUploadLength => uploadStream.Length;\n \n /// \n /// Helps with resumable uploads. Generates chunk requests based on \n /// information, and can control uploading of requests using \n /// \n /// Session information.\n /// Client used to upload chunks.\n /// Readable, seekable stream to be uploaded. Length of session is determined via uploadStream.Length\n /// Max size of each chunk to be uploaded. Multiple of 320 KiB (320 * 1024) is required.\n /// If less than 0, default value of 5 MiB is used. .\n public ChunkedUploadProvider(UploadSession session, IBaseClient client, Stream uploadStream, int maxChunkSize = -1)\n {\n if (!uploadStream.CanRead || !uploadStream.CanSeek)\n {\n throw new ArgumentException(\"Must provide stream that can read and seek\");\n }\n\n this.Session = session;\n this.client = client;\n this.uploadStream = uploadStream;\n this.rangesRemaining = this.GetRangesRemaining(session);\n this.maxChunkSize = maxChunkSize < 0 ? DefaultMaxChunkSize : maxChunkSize;\n if (this.maxChunkSize % RequiredChunkSizeIncrement != 0)\n {\n throw new ArgumentException(\"Max chunk size must be a multiple of 320 KiB\", nameof(maxChunkSize));\n }\n }\n\n /// \n /// Get the series of requests needed to complete the upload session. Call \n /// first to update the internal session information.\n /// \n /// Options to be applied to each request.\n /// All requests currently needed to complete the upload session.\n public virtual IEnumerable GetUploadChunkRequests(IEnumerable