Table of contents
- Device requirement
- Prerequisites
- Azure client application registration
- Configure the project
- Run the project
- How the sample affects your tenant data
- Understand the code
- Questions and comments
- Additional resources
Looking to build cool apps that help people work with their Office 365 data? Explore, learn, and understand the Microsoft Graph SDK by using this Snippets sample. This sample shows you how to access multiple resources, including Microsoft Azure Active Directory and Office 365, by making calls to the Microsoft Graph SDK in an Android application.
You can explore the following operations in Microsoft Graph:
Me
- Get information about the signed in user.
- Get the user's responsibilities.
- Get the user's manager.
- Get the user's direct reports.
- Get the user's group membership
- Get the user's photo.
Users
- Get users from your tenant's directory.
- Get users filtered by criteria from your tenant's directory.
- Create a new user.
Events
- Get the signed-in user's events.
- Create a new event for the user.
- Update a user's event.
- Delete a user's event.
Messages
Groups
- Get all groups in your tenant's directory.
- Create a new group.
- Get information about a specific group in the tenant.
- Delete a group.
- Get a group's members.
- Get a group's owners.
Drives
- Gets the signed-in user's drive.
- Gets all of the files in the user's root folder.
- Creates a new file in the user's root folder.
- Downloads a file from the user's root folder.
- Updates the contents of a file in the user's root folder.
- Deletes a file in the user's root folder.
- Renames a file in the user's root folder.
- Creates a folder under the user's root folder.
##Device requirement To run snippets project, your device must meet the following requirement:
- Android API level 16 or newer
###Prerequisites To use the Microsoft Graph SDK snippets project, you need the following:
- The latest version of Android Studio.
- The Gradle build automation system.
- An Office 365 account. You can sign up for an Office 365 Developer subscription that includes the resources you need to start building Office 365 apps.
- Java Development Kit (JDK) 7.
- A registered Azure application with a client id and redirect URI value. See Grant permissions to the Snippets application in Azure for details about how to create the correct permissions.
##Azure client application registration
- Sign in to the Azure Management Portal, using your Azure AD credentials.
- Click Active Directory on the left menu, then select the directory for your Office 365 tenant.
- On the top menu, click Applications.
- Click Add from the bottom menu.
- On the What do you want to do page, click Add an application my organization is developing.
- On the Tell us about your application page, specify Android Snippet Sample for the application name and select NATIVE CLIENT APPLICATION for type.
- Click the arrow button on the bottom-right corner of the page.
- On the Application information page, specify a Redirect URI for example
http://localhost/androidsnippets
, and then select the check box in the lower-right corner of the page. - After the application has been successfully added, you will be taken to the Quick Start page for the application. From there, select Configure in the top menu.
- In the permissions to other applications section, add the Microsoft Graph application.
- For the Microsoft Graph application, add the following permissions:
- Sign in and read user profile
- Have full access to all files user can access
- Have full access to user calendars
- Read and write access to user mail
- Send mail as a user
- Read user mail
- Read and write directory data
- Read all users' basic profiles
- Read and write all groups
- Click Save in the bottom menu.
- Note the values specified for Client ID on the Configure page. You will need these later when you configure the project.
##Configure the project
- Download or clone the snippets sample.
- Start Android Studio.
- From the Welcome to Android Studio dialog box, choose Import project (Eclipse ADT, Gradle, etc).
- Select the settings.gradle file in the android-java-snippets-sample folder, and then click OK.
- Respond to the dialog box ("Gradle Sync: Gradle settings for this project are not configured yet. Would you like the project to use the Gradle wrapper? ") by clicking the OK button to use the Gradle wrapper.
- Open the ServiceConstants.java file in the com.microsoft.graph.snippets package.
- Find the
CLIENT_ID
string and set its value to the client id you registered in Azure. - Find the
REDIRECT_URI
string and set its value to the redirect URI you registered in Azure.
##Run the project After you've built the project you can run it on an emulator or device.
- Run the project.
- Click the Connect to Microsoft Graph button to sign in.
- Enter your credentials.
- Review and accept the permission scopes requested by the app.
- Click an operation in the main activity to show operation details.
- Click the RUN button to start the operation and wait for the operation to finish.
- Click in the Raw Object text box to copy the box contents to the emulator/device clipboard.
- Click the back button on the toolbar to return to the operation list.
- (Optional) Click the overflow menu to get the Disconnect menu option.
##How the sample affects your tenant data This sample runs commands that create, read, update, or delete data. When running commands that delete or edit data, the sample creates fake entities. The fake entities are deleted or edited so that your actual tenant data is unaffected. The sample will leave behind fake entities on your tenant.
##Understand the code The snippets project uses these classes to manage interactions with Microsoft Graph:
###Sample project organization The snippets project is comprised of two modules. The modular design enables you to build a new app based on this sample by importing the modules into your app. After you've imported the modules, use the code in the snippets app module as an example of how to call methods in the other sample modules.
###Modules in the snippets project
o365-Auth
. This module contains the library calls to authenticate a user with Microsoft Graph.app
. The UI and business logic module. SDK operations are started in the snippet classes in this module.
###Snippet classes A snippet runs a single operation and returns the results. Snippets are found in the app module. Snippets set the state required to make the calls on the Microsoft Graph service classes described below.
AbstractSnippet
DrivesSnippets
EventsSnippets
GroupsSnippets
MeSnippets
MessageSnippets
UsersSnippets
###Authentication classes The authentication classes are found in the o365-Auth module. These classes use the Microsoft Azure Active Directory Library (ADAL) for Android to connect to Microsoft Graph.
AuthenticationManager
. Encapsulates user connect and disconnect logic in addition to Azure app authorization.AzureADModule
. Authentication helper class.AzureAppCompatActivity
. Dependency injection helper.
If you'd like to contribute to this sample, see CONTRIBUTING.MD.
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.
We'd love to get your feedback about the Microsoft Graph SDK Snippets sample for Android. You can send your feedback to us in the Issues section of this repository.
General questions about Microsoft Graph development should be posted to Stack Overflow. Make sure that your questions are tagged with [microsoftgraph].
- Get started with Office 365 APIs powered by Microsoft Graph
- Microsoft Graph overview
- Microsoft Graph SDK for Android
- Connect Sample for Android Using the Microsoft Graph SDK
Copyright (c) 2015 Microsoft. All rights reserved.