Xamarin.CloudDrive.Connector

A wrapper around some of the most common cloud drives, to be easily used with xamarin apps. What started as a specific microsoft onedrive connector, now evolved to a generic library with multiple implementations (including an onedrive one).

Install instructions

You can add the library to your project using some of the nuget packages: onedrive or localdrive :

dotnet add package Xamarin.CloudDrive.Connector.OneDrive
dotnet add package Xamarin.CloudDrive.Connector.LocalDrive

To use the onedrive implementation, you will need a microsoft application id that you can get following this guide.

Example project

There is an example project on the example directory. A simple file picker using both implementations (localDrive and oneDrive) to show how to configure and execute to whole thing.
Just replace {YOUR_MICROSOFT_APPLICATION_ID} with the microsoft application id that you received following the guide mentioned above.

How to use the OneDrive implementation

Replace {YOUR_MICROSOFT_APPLICATION_ID} with the microsoft application id that you received following the guide mentioned above.

Android project : MainActivity.cs

protected override void OnCreate(Bundle savedInstanceState)
{
   ...
   Xamarin.Forms.Forms.Init(this, savedInstanceState);
   Xamarin.CloudDrive.Connector.OneDriveService.Init(this, 
      "{YOUR_MICROSOFT_APPLICATION_ID}", 
      "msal{YOUR_MICROSOFT_APPLICATION_ID}://auth", 
      "User.Read", "Files.Read.All");
   ...
}

protected override void OnActivityResult(int requestCode, Result resultCode, Intent data)
{
   base.OnActivityResult(requestCode, resultCode, data);
   Xamarin.CloudDrive.Connector.OneDriveService.SetAuthenticationResult(requestCode, resultCode, data);
}

Android project : AndroidManifest.xml

<application ...>
   <activity android:name="microsoft.identity.client.BrowserTabActivity">
      <intent-filter>
         <action android:name="android.intent.action.VIEW" />
         <category android:name="android.intent.category.DEFAULT" />
         <category android:name="android.intent.category.BROWSABLE" />
         <data android:scheme="msal{YOUR_MICROSOFT_APPLICATION_ID}" android:host="auth" />
      </intent-filter>
   </activity>
</application>

Simplest get-started example

using Xamarin.CloudDrive.Connector;

// Init method on the mainActivity has placed instance on dependency service
var service = DependencyService.Get<OneDriveService>();

// user will be asked for credentials 
if (await service.ConnectAsync()) { 

   // user profile [id, name, mail, picture]
   var profile = await service.GetProfile(); 

   // user's drivers including shared ones
   var drivesList = await service.GetDrives(); 
   var drive = drivesList.First();

   // list directories on a directory 
   var directoriesList = await service.GetDirectories(drive);
   var directory = directoriesList.First();

   // list files on a directory 
   var filesList = await service.GetFiles(directory);
   var file = filesList.First();

   // download file content
   byte[] fileContent = await service.Download(file.ID);
   
   // upload file overwriting its content
   file = await service.Upload(file.ID, fileContent);

   // any other call availabled on the oneDrive documentation 
   // could be called throught generics helper methods
   service.Client.GetAsync();
   service.Client.PostAsync();
   service.Client.PutAsync();

   // at some point you may call disconnect to clear user auth data
   // doing so, next time user will be asked credentials again
   // not disconnecting, will continue to use same credentials
   await service.DisconnectAsync();
}

iOS project

TODO
i have no mac or iDevice, any help here will be appreciated

How to use the LocalDrive implementation

This implementation is used to access local external card data

Android project : MainActivity.cs

protected override void OnCreate(Bundle savedInstanceState)
{
   ...
   Xamarin.Forms.Forms.Init(this, savedInstanceState);
   Xamarin.CloudDrive.Connector.LocalDriveService.Init(this, savedInstanceState);
   ...
}

public override void OnRequestPermissionsResult(int requestCode, string[] permissions, [GeneratedEnum] Permission[] grantResults)
{
   Xamarin.Essentials.Platform.OnRequestPermissionsResult(requestCode, permissions, grantResults);
   base.OnRequestPermissionsResult(requestCode, permissions, grantResults);
}

Simplest get-started example

using Xamarin.CloudDrive.Connector;

// Init method on the mainActivity has placed instance on dependency service
var service = DependencyService.Get<OneDriveService>();

// user will be asked to authorize storage permissions 
if (await service.ConnectAsync()) { 

   // device's external cards 
   var drivesList = await service.GetDrives(); 
   var drive = drivesList.First();

   // list directories on a directory 
   var directoriesList = await service.GetDirectories(drive);
   var directory = directoriesList.First();

   // list files on a directory 
   var filesList = await service.GetFiles(directory);
   var file = filesList.First();

   // open file content
   byte[] fileContent = await service.Download(file.ID);
   
   // overwrite file content
   file = await service.Upload(file.ID, fileContent);

}

Build using

• .Net Core
• Microsoft Identity
• Microsoft Graph API
• xUnit
• vsCode

Changelog

v1.0.*

The specific OneDrive package evolved to a generic library with multiple implementations.

This version has breaking changes with previous versions

v0.4.*

Upgrading component version

v0.3.*

Upgrading MsBuild.Sdk.Extras dependency.
Upgrading Xamarin.Forms dependency.
Upgrading Microsoft Identity Client dependency.
Removing UWP scenarios and projects.

v0.2.*

Upgrading Microsoft Identity Client.

v0.1.*

Trying to learn and apply unit tests (quantum physics for me).
Conditional framework's builds according to platform specifics, need because android requires some extras steps on acquiring token.
Extending the HttpClient library to accommodate token acquisition.
Implementing the plugin concept using profile as the first try.
Preparing projects to be build, packed and deploy by the server.
Provide a sample application. Implementing the UploadAsync method to send file content to drive. SearchFiles overloads to allow searching on specific folder.
Methods for listing folder's childs.

Authors

• Leverson Carlos
• other contributors

License

MIT License - see the LICENSE file for details.