OneDrive SDK for Android

Integrate the OneDrive API into your Android application!

1. Installation

1.1 Install AAR via Gradle

Add the maven central repository to your projects build.gradle file then add a compile dependency for com.onedrive.sdk:onedrive-sdk-android:1.3+

repository {
    jcenter()
}

dependency {
    // Include the sdk as a dependency
    compile ('com.onedrive.sdk:onedrive-sdk-android:1.3+') {
        transitive = false
    }

    // Include the gson dependency
    compile ('com.google.code.gson:gson:2.3.1')

    // Include supported authentication methods for your application
    compile ('com.microsoft.services.msa:msa-auth:0.8.+')
    compile ('com.microsoft.aad:adal:1.1.+')
}

2. Getting started

2.1 Register your application

2.2 Set your application Id and scopes

The OneDrive SDK for Android comes with Authenticator objects that have already been initialized for OneDrive with Microsoft accounts and Azure Activity Directory accounts. Replace the current settings with the required settings to start authenticating.

Application that authenicate via MSA need to have a scope of access defined to use features on OneDrive. If your application is being used in for OneDrive for business AAD will need the administrators consent for your application to communicate with OneDrive.

Note that your msa-client-id and adal-client-id should look be in GUID format like 00000000-0000-0000-0000-000000000000. For legacy MSA application, the msa-client-id should look like 0000000000000000.

final MSAAuthenticator msaAuthenticator = new MSAAuthenticator() {
    @Override
    public String getClientId() {
        return "<msa-client-id>";
    }

    @Override
    public String[] getScopes() {
        return new String[] { "onedrive.appfolder" };
    }
}

final ADALAuthenticator adalAuthenticator = new ADALAuthenticator() {
    @Override
    public String getClientId() {
        return "<adal-client-id>";
    }

    @Override
    protected String getRedirectUrl() {
        return "https://localhost";
    }
}

2.3 Get a OneDriveClient object

Once you have set the correct application Id and scopes, you must get a OneDriveClient object to make requests against the service. The SDK will store the account information for you, but when a user logs on for the first time, it will invoke UI to get the user's account information.

final IClientConfig oneDriveConfig = DefaultClientConfig.createWithAuthenticators(
                                            msaAuthenticator,
                                            adalAuthenticator);
                                            
final DefaultCallback<IOneDriveClient> callback = new DefaultCallback<IOneDriveClient>(activity) {
            @Override
            public void success(final IOneDriveClient result) {
                // OneDrive client created successfully.
            }

            @Override
            public void failure(final ClientException error) {
                // Exception happened during creation.
            }
        };
        
final IOneDriveClient oneDriveClient = new OneDriveClient.Builder()
                                            .fromConfig(oneDriveConfig)
                                            .loginAndBuildClient(getActivity(), callback);

3. Make requests against the service

Once you have an OneDriveClient that is authenticated you can begin making calls against the service. The requests against the service look like our REST API.

Get the drive

To retrieve a user's drive:

oneDriveClient
    .getDrive()
    .buildRequest()
    .get(new ICallback<Drive>() {
  @Override
  public void success(final Drive result) {
    final String msg = "Found Drive " + result.id;
    Toast.makeText(getActivity(), msg, Toast.LENGTH_SHORT)
        .show();
  }
  ...
  // Handle failure case
});

Get the root folder

To get a user's root folder of their drive:

oneDriveClient
    .getDrive()
    .getRoot()
    .buildRequest()
    .get(new ICallback<Item>() {
  @Override
  public void success(final Item result) {
    final String msg = "Found Root " + result.id;
    Toast.makeText(getActivity(), msg, Toast.LENGTH_SHORT)
        .show();
  }
  ...
  // Handle failure case
});

For a general overview of how the SDK is designed, see overview.

4. Documentation

For a more detailed documentation see:

5. Issues

For known issues, see issues.

6. Contributions

The OneDrive SDK is open for contribution. Please read how to contribute to this project here.

7. Supported Android Versions

The OneDrive SDK for Android library is supported at runtime for Android API revision 15 and greater. To build the sdk you need to install Android API revision 23 or greater.

8. License

License

9. Third Party Notices

[Third Party Notices](THIRD PARTY NOTICES)

10. Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

OneDrive/onedrive-sdk-android

OneDrive

Reviews

Repository Details