/// <summary>
/// Uploads the contents of sourceFileStream to the service as the contents for itemId. This method can
/// be used to replace the contents of an existing file or create a new file if the itemReference property
/// is set to a path-only.
/// </summary>
/// <param name="itemReference"></param>
/// <param name="sourceFileStream"></param>
/// <param name="options"></param>
/// <returns></returns>
public async Task <ODItem> PutContentsAsync(ODItemReference itemReference, Stream sourceFileStream, ItemUploadOptions options)
{
if (!itemReference.IsValid())
{
throw new ArgumentException("ItemReference was invalid. Requires either an ID or Path");
}
if (null == options)
{
throw new ArgumentNullException("options");
}
if (null == sourceFileStream)
{
throw new ArgumentNullException("sourceFileStream");
}
if (sourceFileStream.Length > MaxRegularUploadSize)
{
throw new ODException("Stream is longer than the maximum upload size allowed.");
}
long localItemSize;
if (!sourceFileStream.TryGetLength(out localItemSize))
{
throw new ODException("Couldn't get length of sourceFileStream.");
}
Uri serviceUri = UriForItemReference(itemReference);
return(await UploadToUrl(sourceFileStream, options, localItemSize, serviceUri));
}
/// <summary>
/// Generates a service request to download the binary contents of a file based on an item ID.
/// </summary>
/// <param name="itemReference"></param>
/// <param name = "options"></param>
/// <returns></returns>
public async Task <Stream> DownloadStreamForItemAsync(ODItemReference itemReference, StreamDownloadOptions options)
{
if (!itemReference.IsValid())
{
throw new ArgumentException("ItemReference was invalid. Requires either an ID or Path");
}
Uri serviceUri = UriForItemReference(itemReference, ApiConstants.ContentRelationshipName);
var request = await CreateHttpRequestAsync(serviceUri, ApiConstants.HttpGet);
options.ModifyRequest(request);
var response = await GetHttpResponseAsync(request);
if (response.StatusCode == System.Net.HttpStatusCode.Found)
{
Uri downloadUri = new Uri(response.Headers[ApiConstants.LocationHeaderName]);
request = await CreateHttpRequestAsync(downloadUri, ApiConstants.HttpGet);
options.ModifyRequest(request);
response = await GetHttpResponseAsync(request);
}
var responseStream = await response.GetResponseStreamAsync();
return(responseStream);
}
/// <summary>
/// Update an item referenced by itemReference with the changes in the changes parameter.
/// All fields that are not changed in an Item should be set to null before passing the item
/// into this call.
/// </summary>
/// <param name="itemReference"></param>
/// <param name="changes"></param>
/// <returns></returns>
public async Task <ODItem> PatchItemAsync(ODItemReference itemReference, ODItem changes)
{
if (!itemReference.IsValid())
{
throw new ArgumentException("itemReference is not a valid reference.");
}
if (null == changes)
{
throw new ArgumentNullException("changes");
}
Uri serviceUri = UriForItemReference(itemReference);
var request = await CreateHttpRequestAsync(serviceUri, ApiConstants.HttpPatch);
await SerializeObjectToRequestBody(changes, request);
var response = await GetHttpResponseAsync(request);
if (response.StatusCode.IsSuccess())
{
return(await response.ConvertToDataModel <ODItem>());
}
else
{
throw await response.ToException();
}
}
/// <summary>
/// Upload a file from a URL.
/// </summary>
/// <param name="parentItemReference"></param>
/// <param name="sourceUrl"></param>
/// <param name="destinationFilename"></param>
/// <returns></returns>
public async Task <ODAsyncTask> UploadFromUrlAsync(ODItemReference parentItemReference, string sourceUrl, string destinationFilename)
{
if (!destinationFilename.ValidFilename())
{
throw new ArgumentException("destinationFilename contains invalid characters.");
}
if (!parentItemReference.IsValid())
{
throw new ArgumentException("parentItemReference was invalid. Requires either an ID or Path");
}
if (string.IsNullOrEmpty(sourceUrl))
{
throw new ArgumentNullException("sourceUrl");
}
Uri serviceUri = UriForItemReference(parentItemReference, ApiConstants.ChildrenRelationshipName);
var request = await CreateHttpRequestAsync(serviceUri, ApiConstants.HttpPost);
AddAsyncHeaders(request);
var uploadItem = new ODItem {
Name = destinationFilename, File = new Facets.FileFacet(), SourceUrlAnnotation = sourceUrl
};
await SerializeObjectToRequestBody(uploadItem, request);
return(await AsyncTaskResultForRequest(request, serviceUri));
}
/// <summary>
/// Deletes the item on the server with the specified item-id.
/// </summary>
/// <param name="itemReference"></param>
/// <param name="options"></param>
/// <returns></returns>
public async Task <bool> DeleteItemAsync(ODItemReference itemReference, ItemDeleteOptions options)
{
if (!itemReference.IsValid())
{
throw new ArgumentException("itemReference was invalid. Requires either an ID or Path");
}
if (null == options)
{
throw new ArgumentNullException("options");
}
Uri serviceUri = UriForItemReference(itemReference);
var request = await CreateHttpRequestAsync(serviceUri, ApiConstants.HttpDelete);
options.ModifyRequest(request);
var response = await GetHttpResponseAsync(request);
if (response.StatusCode == System.Net.HttpStatusCode.NoContent)
{
return(true);
}
else
{
throw await response.ToException();
}
}
/// <summary>
/// Uploads a file using the resumable fragment upload API, splitting the file into smaller pieces to upload.
/// </summary>
/// <param name="parentItemReference"></param>
/// <param name="filename"></param>
/// <param name="sourceFileStream"></param>
/// <param name="options"></param>
/// <returns></returns>
public async Task <ODItem> UploadLargeFileAsync(ODItemReference parentItemReference, string filename, Stream sourceFileStream, ItemUploadOptions options)
{
if (!parentItemReference.IsValid())
{
throw new ArgumentException("parentItemReference isn't valid");
}
if (string.IsNullOrEmpty(filename))
{
throw new ArgumentNullException("filename");
}
if (!filename.ValidFilename())
{
throw new ArgumentException("filename contains invalid characters");
}
if (null == sourceFileStream)
{
throw new ArgumentNullException("sourceFileStream");
}
if (null == options)
{
throw new ArgumentNullException("options");
}
string navigation = string.Concat(":/", filename, ":/", ApiConstants.UploadCreateSessionAction);
Uri serviceUri = UriForItemReference(parentItemReference, navigation);
return(await StartLargeFileTransfer(serviceUri, sourceFileStream, options));
}
/// <summary>
/// Copy an item to a new location, optionally providing a new name.
/// </summary>
/// <param name="originalItemReference"></param>
/// <param name="destinationParentItemReference"></param>
/// <param name="optionalFilename"></param>
/// <returns></returns>
public async Task <ODAsyncTask> CopyItemAsync(ODItemReference originalItemReference, ODItemReference destinationParentItemReference, string optionalFilename = null)
{
if (!originalItemReference.IsValid())
{
throw new ArgumentException("originalItemReference");
}
if (!destinationParentItemReference.IsValid())
{
throw new ArgumentException("destinationParentItemReference");
}
Uri serviceUri = UriForItemReference(originalItemReference, ApiConstants.CopyItemAction);
var request = await CreateHttpRequestAsync(serviceUri, ApiConstants.HttpPost);
AddAsyncHeaders(request);
var postBody = new
{
parentReference = destinationParentItemReference,
name = optionalFilename
};
await SerializeObjectToRequestBody(postBody, request);
return(await AsyncTaskResultForRequest(request, serviceUri));
}
/// <summary>
/// Return a collection of children of an item referenced by item-id
/// </summary>
/// <param name="itemReference"></param>
/// <param name="childrenRetrievalOptions"></param>
/// <returns></returns>
public async Task<ODItemCollection> GetChildrenOfItemAsync(ODItemReference itemReference, ChildrenRetrievalOptions childrenRetrievalOptions)
{
if (!itemReference.IsValid())
throw new ArgumentException("ItemReference was invalid. Requires either an ID or Path");
var queryParams = ODataOptionsToQueryString(childrenRetrievalOptions);
Uri serviceUri = UriForItemReference(itemReference, ApiConstants.ChildrenRelationshipName, queryParams);
return await DataModelForRequest<ODItemCollection>(serviceUri, ApiConstants.HttpGet);
}
/// <summary>
/// Retrieve an ODItem for an item with a particular item-id
/// </summary>
/// <param name="itemReference"></param>
/// <param name="itemRetrievalOptions"></param>
/// <returns></returns>
public async Task<ODItem> GetItemAsync(ODItemReference itemReference, ItemRetrievalOptions itemRetrievalOptions)
{
if (!itemReference.IsValid())
throw new ArgumentException("ItemReference was invalid. Requires either an ID or Path");
var queryParams = ODataOptionsToQueryString(itemRetrievalOptions);
var serviceUri = UriForItemReference(itemReference, null, queryParams);
return await DataModelForRequest<ODItem>(serviceUri, ApiConstants.HttpGet);
}
/// <summary>
/// Retrieve an ODItem for an item with a particular item-id
/// </summary>
/// <param name="itemReference"></param>
/// <param name="itemRetrievalOptions"></param>
/// <returns></returns>
public async Task <ODItem> GetItemAsync(ODItemReference itemReference, ItemRetrievalOptions itemRetrievalOptions)
{
if (!itemReference.IsValid())
{
throw new ArgumentException("ItemReference was invalid. Requires either an ID or Path");
}
var queryParams = ODataOptionsToQueryString(itemRetrievalOptions);
var serviceUri = UriForItemReference(itemReference, null, queryParams);
return(await DataModelForRequest <ODItem>(serviceUri, ApiConstants.HttpGet));
}
/// <summary>
/// Return a collection of children of an item referenced by item-id
/// </summary>
/// <param name="itemReference"></param>
/// <param name="childrenRetrievalOptions"></param>
/// <returns></returns>
public async Task <ODItemCollection> GetChildrenOfItemAsync(ODItemReference itemReference, ChildrenRetrievalOptions childrenRetrievalOptions)
{
if (!itemReference.IsValid())
{
throw new ArgumentException("ItemReference was invalid. Requires either an ID or Path");
}
var queryParams = ODataOptionsToQueryString(childrenRetrievalOptions);
Uri serviceUri = UriForItemReference(itemReference, ApiConstants.ChildrenRelationshipName, queryParams);
return(await DataModelForRequest <ODItemCollection>(serviceUri, ApiConstants.HttpGet));
}
/// <summary>
/// Return a collection of thumbnails available for an item referenced by item-id
/// </summary>
/// <param name="itemReference"></param>
/// <param name="thumbnailOptions"></param>
/// <returns></returns>
public async Task<ODThumbnailSet[]> GetThumbnailsForItemAsync(ODItemReference itemReference, ThumbnailRetrievalOptions thumbnailOptions)
{
if (!itemReference.IsValid())
throw new ArgumentException("ItemReference was invalid. Requires either an ID or Path");
var queryParams = ODataOptionsToQueryString(thumbnailOptions);
Uri serviceUri = UriForItemReference(itemReference, ApiConstants.ThumbnailsRelationshipName, queryParams);
var results = await DataModelForRequest<ODCollectionResponse<ODThumbnailSet>>(serviceUri, ApiConstants.HttpGet);
if (null != results && results.Collection != null)
{
return results.Collection;
}
return null;
}
/// <summary>
/// Return a collection of thumbnails available for an item referenced by item-id
/// </summary>
/// <param name="itemReference"></param>
/// <param name="thumbnailOptions"></param>
/// <returns></returns>
public async Task <ODThumbnailSet[]> GetThumbnailsForItemAsync(ODItemReference itemReference, ThumbnailRetrievalOptions thumbnailOptions)
{
if (!itemReference.IsValid())
{
throw new ArgumentException("ItemReference was invalid. Requires either an ID or Path");
}
var queryParams = ODataOptionsToQueryString(thumbnailOptions);
Uri serviceUri = UriForItemReference(itemReference, ApiConstants.ThumbnailsRelationshipName, queryParams);
var results = await DataModelForRequest <ODCollectionResponse <ODThumbnailSet> >(serviceUri, ApiConstants.HttpGet);
if (null != results && results.Collection != null)
{
return(results.Collection);
}
return(null);
}
/// <summary>
/// Uploads a file using the resumable fragment upload API, splitting the file into smaller pieces to upload.
///
/// You can use this method to replace an existing item (using itemReference.Id) or to upload a new item
/// (using itemReference.Path).
/// </summary>
/// <param name="itemReference"></param>
/// <param name="sourceFileStream"></param>
/// <param name="options"></param>
/// <returns></returns>
public async Task <ODItem> UploadLargeFileAsync(ODItemReference itemReference, Stream sourceFileStream, ItemUploadOptions options)
{
if (!itemReference.IsValid())
{
throw new ArgumentException("parentItemReference isn't valid");
}
if (null == sourceFileStream)
{
throw new ArgumentNullException("sourceFileStream");
}
if (null == options)
{
throw new ArgumentNullException("options");
}
Uri serviceUri = UriForItemReference(itemReference, ApiConstants.UploadCreateSessionAction);
return(await StartLargeFileTransfer(serviceUri, sourceFileStream, options));
}
public async Task <ODPermission> CreateSharingLinkAsync(ODItemReference itemReference, OneDrive.Facets.LinkType type)
{
if (!itemReference.IsValid())
{
throw new ArgumentException("itemReference");
}
Uri serviceUri = UriForItemReference(itemReference, ApiConstants.CreateLinkAction);
var request = await CreateHttpRequestAsync(serviceUri, ApiConstants.HttpPost);
var postBody = new
{
type = type
};
await SerializeObjectToRequestBody(postBody, request);
return(await DataModelForRequest <ODPermission>(request));
}
/// <summary>
/// Returns change information for items at and below the specified item-id.
/// </summary>
/// <param name="rootItemReference"></param>
/// <param name="options"></param>
/// <returns></returns>
public async Task <ODViewChangesResult> ViewChangesAsync(ODItemReference rootItemReference, ViewChangesOptions options)
{
if (!rootItemReference.IsValid())
{
throw new ArgumentException("rootItemReference was invalid. Requires either an ID or Path");
}
if (null == options)
{
throw new ArgumentNullException("options");
}
var queryParams = new QueryStringBuilder();
options.ModifyQueryString(queryParams);
Uri serviceUri = UriForItemReference(rootItemReference, ApiConstants.ViewChangesServiceAction, queryParams);
var request = await CreateHttpRequestAsync(serviceUri, ApiConstants.HttpGet);
return(await DataModelForRequest <ODViewChangesResult>(request));
}
/// <summary>
/// Upload a new file to a parent folder item.
/// </summary>
/// <param name="parentItemReference">Item ID for the parent folder.</param>
/// <param name="filename">Filename of the new file to create</param>
/// <param name="sourceFileStream">Data stream for the new file</param>
/// <param name="options">Upload options</param>
/// <returns></returns>
public async Task <ODItem> PutNewFileToParentItemAsync(ODItemReference parentItemReference, string filename, Stream sourceFileStream, ItemUploadOptions options)
{
if (!filename.ValidFilename())
{
throw new ArgumentException("Filename contains invalid characters.");
}
if (!parentItemReference.IsValid())
{
throw new ArgumentException("parentItemReference was invalid. Requires either an ID or Path");
}
if (null == options)
{
throw new ArgumentNullException("options");
}
if (null == sourceFileStream)
{
throw new ArgumentNullException("sourceFileStream");
}
if (sourceFileStream.Length > MaxRegularUploadSize)
{
throw new ODException("Stream is longer than the maximum upload size allowed.");
}
long localItemSize;
if (!sourceFileStream.TryGetLength(out localItemSize))
{
System.Diagnostics.Debug.WriteLine("Warning: Couldn't determine length of sourceFileStream.");
}
string navigationValue = string.Concat(ApiConstants.ChildrenRelationshipName, UrlSeperator, filename, UrlSeperator, ApiConstants.ContentRelationshipName);
Uri serviceUri = UriForItemReference(parentItemReference, navigationValue);
await CreateHttpRequestAsync(serviceUri, ApiConstants.HttpPut);
return(await UploadToUrl(sourceFileStream, options, localItemSize, serviceUri));
}
/// <summary>
/// Search for items matching a given search query
/// </summary>
/// <param name="rootItemReference"></param>
/// <param name="searchQuery"></param>
/// <param name="itemRetrievalOptions"></param>
/// <returns></returns>
public async Task <ODItemCollection> SearchForItemsAsync(ODItemReference rootItemReference, string searchQuery, ItemRetrievalOptions itemRetrievalOptions)
{
if (!rootItemReference.IsValid())
{
throw new ArgumentException("rootItemReference was invalid. Requires either an ID or Path");
}
if (null == searchQuery)
{
throw new ArgumentNullException("searchQuery");
}
if (null == itemRetrievalOptions)
{
throw new ArgumentNullException("itemRetrievalOptions");
}
var queryParams = ODataOptionsToQueryString(itemRetrievalOptions);
queryParams.Add(ApiConstants.SearchQueryParameterKey, searchQuery);
Uri serviceUri = UriForItemReference(rootItemReference, ApiConstants.SearchServiceAction, queryParams);
var request = await CreateHttpRequestAsync(serviceUri, ApiConstants.HttpGet);
return(await DataModelForRequest <ODItemCollection>(request));
}
/// <summary>
/// Create a new folder as a child of an existing folder, speciifed by parentFolderId.
/// </summary>
/// <param name="parentItemReference"></param>
/// <param name="newFolderName"></param>
/// <returns></returns>
public async Task <ODItem> CreateFolderAsync(ODItemReference parentItemReference, string newFolderName)
{
if (!parentItemReference.IsValid())
{
throw new ArgumentException("parentItemReference was invalid. Requires either an ID or Path");
}
if (string.IsNullOrEmpty(newFolderName))
{
throw new ArgumentNullException("newFolderName");
}
Uri serviceUri = UriForItemReference(parentItemReference, ApiConstants.ChildrenRelationshipName);
var request = await CreateHttpRequestAsync(serviceUri, ApiConstants.HttpPost);
request.ContentType = ApiConstants.ContentTypeJson;
var body = new { name = newFolderName, folder = new { } };
await SerializeObjectToRequestBody(body, request);
var item = await DataModelForRequest <ODItem>(request);
return(item);
}
/// <summary>
/// Upload a new file to a parent folder item.
/// </summary>
/// <param name="parentItemReference">Item ID for the parent folder.</param>
/// <param name="filename">Filename of the new file to create</param>
/// <param name="sourceFileStream">Data stream for the new file</param>
/// <param name="options">Upload options</param>
/// <returns></returns>
public async Task<ODItem> PutNewFileToParentItemAsync(ODItemReference parentItemReference, string filename, Stream sourceFileStream, ItemUploadOptions options)
{
if (!filename.ValidFilename())
throw new ArgumentException("Filename contains invalid characters.");
if (!parentItemReference.IsValid())
throw new ArgumentException("parentItemReference was invalid. Requires either an ID or Path");
if (null == options)
throw new ArgumentNullException("options");
if (null == sourceFileStream)
throw new ArgumentNullException("sourceFileStream");
if (sourceFileStream.Length > MaxRegularUploadSize)
throw new ODException("Stream is longer than the maximum upload size allowed.");
long localItemSize;
if (!sourceFileStream.TryGetLength(out localItemSize))
{
System.Diagnostics.Debug.WriteLine("Warning: Couldn't determine length of sourceFileStream.");
}
string navigationValue = string.Concat(ApiConstants.ChildrenRelationshipName, UrlSeperator, filename, UrlSeperator, ApiConstants.ContentRelationshipName);
Uri serviceUri = UriForItemReference(parentItemReference, navigationValue);
await CreateHttpRequestAsync(serviceUri, ApiConstants.HttpPut);
return await UploadToUrl(sourceFileStream, options, localItemSize, serviceUri);
}
/// <summary>
/// Upload a file from a URL.
/// </summary>
/// <param name="parentItemReference"></param>
/// <param name="sourceUrl"></param>
/// <param name="destinationFilename"></param>
/// <returns></returns>
public async Task<ODAsyncTask> UploadFromUrlAsync(ODItemReference parentItemReference, string sourceUrl, string destinationFilename)
{
if (!destinationFilename.ValidFilename())
throw new ArgumentException("destinationFilename contains invalid characters.");
if (!parentItemReference.IsValid())
throw new ArgumentException("parentItemReference was invalid. Requires either an ID or Path");
if (string.IsNullOrEmpty(sourceUrl))
throw new ArgumentNullException("sourceUrl");
Uri serviceUri = UriForItemReference(parentItemReference, ApiConstants.ChildrenRelationshipName);
var request = await CreateHttpRequestAsync(serviceUri, ApiConstants.HttpPost);
AddAsyncHeaders(request);
var uploadItem = new ODItem { Name = destinationFilename, File = new Facets.FileFacet(), SourceUrlAnnotation = sourceUrl };
await SerializeObjectToRequestBody(uploadItem, request);
return await AsyncTaskResultForRequest(request, serviceUri);
}
/// <summary>
/// Create a new folder as a child of an existing folder, speciifed by parentFolderId.
/// </summary>
/// <param name="parentItemReference"></param>
/// <param name="newFolderName"></param>
/// <returns></returns>
public async Task<ODItem> CreateFolderAsync(ODItemReference parentItemReference, string newFolderName)
{
if (!parentItemReference.IsValid())
throw new ArgumentException("parentItemReference was invalid. Requires either an ID or Path");
if (string.IsNullOrEmpty(newFolderName))
throw new ArgumentNullException("newFolderName");
Uri serviceUri = UriForItemReference(parentItemReference, ApiConstants.ChildrenRelationshipName);
var request = await CreateHttpRequestAsync(serviceUri, ApiConstants.HttpPost);
request.ContentType = ApiConstants.ContentTypeJson;
var body = new { name = newFolderName, folder = new { } };
await SerializeObjectToRequestBody(body, request);
var item = await DataModelForRequest<ODItem>(request);
return item;
}
/// <summary>
/// Deletes the item on the server with the specified item-id.
/// </summary>
/// <param name="itemReference"></param>
/// <param name="options"></param>
/// <returns></returns>
public async Task<bool> DeleteItemAsync(ODItemReference itemReference, ItemDeleteOptions options)
{
if (!itemReference.IsValid())
throw new ArgumentException("itemReference was invalid. Requires either an ID or Path");
if (null == options)
throw new ArgumentNullException("options");
Uri serviceUri = UriForItemReference(itemReference);
var request = await CreateHttpRequestAsync(serviceUri, ApiConstants.HttpDelete);
options.ModifyRequest(request);
var response = await GetHttpResponseAsync(request);
if (response.StatusCode == System.Net.HttpStatusCode.NoContent)
{
return true;
}
else
{
throw await response.ToException();
}
}
/// <summary>
/// Update an item referenced by itemReference with the changes in the changes parameter.
/// All fields that are not changed in an Item should be set to null before passing the item
/// into this call.
/// </summary>
/// <param name="itemReference"></param>
/// <param name="changes"></param>
/// <returns></returns>
public async Task<ODItem> PatchItemAsync(ODItemReference itemReference, ODItem changes)
{
if (!itemReference.IsValid()) throw new ArgumentException("itemReference is not a valid reference.");
if (null == changes) throw new ArgumentNullException("changes");
Uri serviceUri = UriForItemReference(itemReference);
var request = await CreateHttpRequestAsync(serviceUri, ApiConstants.HttpPatch);
await SerializeObjectToRequestBody(changes, request);
var response = await GetHttpResponseAsync(request);
if (response.StatusCode.IsSuccess())
{
return await response.ConvertToDataModel<ODItem>();
}
else
{
throw await response.ToException();
}
}
/// <summary>
/// Copy an item to a new location, optionally providing a new name.
/// </summary>
/// <param name="originalItemReference"></param>
/// <param name="destinationParentItemReference"></param>
/// <param name="optionalFilename"></param>
/// <returns></returns>
public async Task<ODAsyncTask> CopyItemAsync(ODItemReference originalItemReference, ODItemReference destinationParentItemReference, string optionalFilename = null)
{
if (!originalItemReference.IsValid())
throw new ArgumentException("originalItemReference");
if (!destinationParentItemReference.IsValid())
throw new ArgumentException("destinationParentItemReference");
Uri serviceUri = UriForItemReference(originalItemReference, ApiConstants.CopyItemAction);
var request = await CreateHttpRequestAsync(serviceUri, ApiConstants.HttpPost);
AddAsyncHeaders(request);
var postBody = new
{
parentReference = destinationParentItemReference,
name = optionalFilename
};
await SerializeObjectToRequestBody(postBody, request);
return await AsyncTaskResultForRequest(request, serviceUri);
}
public async Task<ODPermission> CreateSharingLinkAsync(ODItemReference itemReference, OneDrive.Facets.LinkType type)
{
if (!itemReference.IsValid())
throw new ArgumentException("itemReference");
Uri serviceUri = UriForItemReference(itemReference, ApiConstants.CreateLinkAction);
var request = await CreateHttpRequestAsync(serviceUri, ApiConstants.HttpPost);
var postBody = new
{
type = type
};
await SerializeObjectToRequestBody(postBody, request);
return await DataModelForRequest<ODPermission>(request);
}
/// <summary>
/// Returns change information for items at and below the specified item-id.
/// </summary>
/// <param name="rootItemReference"></param>
/// <param name="options"></param>
/// <returns></returns>
public async Task<ODViewChangesResult> ViewChangesAsync(ODItemReference rootItemReference, ViewChangesOptions options)
{
if (!rootItemReference.IsValid())
throw new ArgumentException("rootItemReference was invalid. Requires either an ID or Path");
if (null == options)
throw new ArgumentNullException("options");
var queryParams = new QueryStringBuilder();
options.ModifyQueryString(queryParams);
Uri serviceUri = UriForItemReference(rootItemReference, ApiConstants.ViewChangesServiceAction, queryParams);
var request = await CreateHttpRequestAsync(serviceUri, ApiConstants.HttpGet);
return await DataModelForRequest<ODViewChangesResult>(request);
}
/// <summary>
/// Search for items matching a given search query
/// </summary>
/// <param name="rootItemReference"></param>
/// <param name="searchQuery"></param>
/// <param name="itemRetrievalOptions"></param>
/// <returns></returns>
public async Task<ODItemCollection> SearchForItemsAsync(ODItemReference rootItemReference, string searchQuery, ItemRetrievalOptions itemRetrievalOptions)
{
if (!rootItemReference.IsValid())
throw new ArgumentException("rootItemReference was invalid. Requires either an ID or Path");
if (null == searchQuery)
throw new ArgumentNullException("searchQuery");
if (null == itemRetrievalOptions)
throw new ArgumentNullException("itemRetrievalOptions");
var queryParams = ODataOptionsToQueryString(itemRetrievalOptions);
queryParams.Add(ApiConstants.SearchQueryParameterKey, searchQuery);
Uri serviceUri = UriForItemReference(rootItemReference, ApiConstants.SearchServiceAction, queryParams);
var request = await CreateHttpRequestAsync(serviceUri, ApiConstants.HttpGet);
return await DataModelForRequest<ODItemCollection>(request);
}
/// <summary>
/// Generates a service request to download the binary contents of a file based on an item ID.
/// </summary>
/// <param name="itemReference"></param>
/// <param name = "options"></param>
/// <returns></returns>
public async Task<Stream> DownloadStreamForItemAsync(ODItemReference itemReference, StreamDownloadOptions options)
{
if (!itemReference.IsValid())
throw new ArgumentException("ItemReference was invalid. Requires either an ID or Path");
Uri serviceUri = UriForItemReference(itemReference, ApiConstants.ContentRelationshipName);
var request = await CreateHttpRequestAsync(serviceUri, ApiConstants.HttpGet);
options.ModifyRequest(request);
var response = await GetHttpResponseAsync(request);
if (response.StatusCode == System.Net.HttpStatusCode.Found)
{
Uri downloadUri = new Uri(response.Headers[ApiConstants.LocationHeaderName]);
request = await CreateHttpRequestAsync(downloadUri, ApiConstants.HttpGet);
options.ModifyRequest(request);
response = await GetHttpResponseAsync(request);
}
var responseStream = await response.GetResponseStreamAsync();
return responseStream;
}
/// <summary>
/// Uploads a file using the resumable fragment upload API, splitting the file into smaller pieces to upload.
///
/// You can use this method to replace an existing item (using itemReference.Id) or to upload a new item
/// (using itemReference.Path).
/// </summary>
/// <param name="itemReference"></param>
/// <param name="sourceFileStream"></param>
/// <param name="options"></param>
/// <returns></returns>
public async Task<ODItem> UploadLargeFileAsync(ODItemReference itemReference, Stream sourceFileStream, ItemUploadOptions options)
{
if (!itemReference.IsValid())
throw new ArgumentException("parentItemReference isn't valid");
if (null == sourceFileStream)
throw new ArgumentNullException("sourceFileStream");
if (null == options)
throw new ArgumentNullException("options");
Uri serviceUri = UriForItemReference(itemReference, ApiConstants.UploadCreateSessionAction);
return await StartLargeFileTransfer(serviceUri, sourceFileStream, options);
}
/// <summary>
/// Uploads the contents of sourceFileStream to the service as the contents for itemId. This method can
/// be used to replace the contents of an existing file or create a new file if the itemReference property
/// is set to a path-only.
/// </summary>
/// <param name="itemReference"></param>
/// <param name="sourceFileStream"></param>
/// <param name="options"></param>
/// <returns></returns>
public async Task<ODItem> PutContentsAsync(ODItemReference itemReference, Stream sourceFileStream, ItemUploadOptions options)
{
if (!itemReference.IsValid())
throw new ArgumentException("ItemReference was invalid. Requires either an ID or Path");
if (null == options)
throw new ArgumentNullException("options");
if (null == sourceFileStream)
throw new ArgumentNullException("sourceFileStream");
if (sourceFileStream.Length > MaxRegularUploadSize)
throw new ODException("Stream is longer than the maximum upload size allowed.");
long localItemSize;
if (!sourceFileStream.TryGetLength(out localItemSize))
{
throw new ODException("Couldn't get length of sourceFileStream.");
}
Uri serviceUri = UriForItemReference(itemReference);
return await UploadToUrl(sourceFileStream, options, localItemSize, serviceUri);
}
/// <summary>
/// Uploads a file using the resumable fragment upload API, splitting the file into smaller pieces to upload.
/// </summary>
/// <param name="parentItemReference"></param>
/// <param name="filename"></param>
/// <param name="sourceFileStream"></param>
/// <param name="options"></param>
/// <returns></returns>
public async Task<ODItem> UploadLargeFileAsync(ODItemReference parentItemReference, string filename, Stream sourceFileStream, ItemUploadOptions options)
{
if (!parentItemReference.IsValid())
throw new ArgumentException("parentItemReference isn't valid");
if (string.IsNullOrEmpty(filename))
throw new ArgumentNullException("filename");
if (!filename.ValidFilename())
throw new ArgumentException("filename contains invalid characters");
if (null == sourceFileStream)
throw new ArgumentNullException("sourceFileStream");
if (null == options)
throw new ArgumentNullException("options");
string navigation = string.Concat(":/", filename, ":/", ApiConstants.UploadCreateSessionAction);
Uri serviceUri = UriForItemReference(parentItemReference, navigation);
return await StartLargeFileTransfer(serviceUri, sourceFileStream, options);
}
