Source code can be found here.
Table of Contents
Overview
The Office 365 Starter Project sample uses the Office 365 API Tools client libraries to illustrate basic operations against the Files, Calendar and Contacts service endpoints in Office 365. The sample also demonstrates how to authenticate against multiple Office 365 services in a single app experience, and retrieve user information from the Users and Groups service. We'll be adding examples of how to use more APIs such as Email when we update this project, so make sure to check back. Below are the operations that you can perform with this sample:
Calendar
- Get calendar events
- Create events
- Update events
- Delete events
Contacts
- Get contacts
- Create contacts
- Update contacts
- Delete contacts
- Change contact photo
My Files
- Get files and folders
- Create text files
- Delete files or folders
- Read text file contents (OneDrive)
- Update text file contents
- Download files
- Upload files
Users and Groups
- Get display name
- Get job title
- Get profile picture
- Get user ID
- Check signed in/out state
Prerequisites and Configuration
This sample requires the following:
- Visual Studio 2013 with Update 3.
- Office 365 API Tools version 1.3.41104.1.
- An Office 365 developer site.
- To use the Files part of this project, OneDrive for Business must be setup on your tenant, which happens the first time you sign-on to OneDrive for Business via the web browser.
Configure the sample
Follow these steps to configure the sample.
- Open the O365-APIs-Start-Windows.sln file using Visual Studio 2013.
- Register and configure the app to consume Office 365 services (detailed below).
Register app to consume Office 365 APIs
You can do this via the Office 365 API Tools for Visual Studio (which automates the registration process). Be sure to download and install the Office 365 API tools from the Visual Studio Gallery.
- In the Solution Explorer window, choose Office365Starter project -> Add -> Connected Service.
- A Services Manager dialog box will appear. Choose Office 365 and Register your app.
- On the sign-in dialog box, enter the username and password for your Office 365 tenant. We recommend that you use your Office 365 Developer Site. Often, this user name will follow the pattern @.onmicrosoft.com. If you do not have a developer site, you can get a free Developer Site as part of your MSDN Benefits or sign up for a free trial. Be aware that the user must be an Tenant Admin user—but for tenants created as part of an Office 365 Developer Site, this is likely to be the case already. Also developer accounts are usually limited to one sign-in.
- After you're signed in, you will see a list of all the services. Initially, no permissions will be selected, as the app is not registered to consume any services yet.
- To register for the services used in this sample, choose the following permissions:
- (Calendar) – Have full access to users’ calendar
- (Contacts) - Have full access to users' contacts
- (My Files) – Edit or delete users’ files
- (Users and Groups) – Enable sign-on and read users' profiles
- (Users and Groups) – Access your organization's directory
- After clicking OK in the Services Manager dialog box, assemblies for connecting to Office 365 REST APIs will be added to your project.
Note: If you see any errors while installing packages during step 6, for example, Unable to find "Microsoft.Azure.ActiveDirectory.GraphClient", make sure the local path where you placed the solution is not too long/deep. Moving the solution closer to the root of your drive resolves this issue. We'll also work on shortening the folder names in a future update.
Build
After you've loaded the solution in Visual Studio, press F5 to build and debug. Run the solution and sign in with your organizational account to Office 365.
Project Files of Interest
Helper Classes
- CalendarOperations.cs
- FileOperations.cs
- UserOperations.cs
- AuthenticationHelper.cs
- ContactOperations.cs
View Models
- CalendarViewModel.cs
- EventViewModel.cs
- UserViewModel.cs
- ContactsViewModel.cs
- FilesViewModel.cs
- FileSystemItemViewModel.cs
- ContactItemViewModel.cs
Known issues
- None at the moment, but do let us know if you find any. We're listening.
Troubleshooting
- You receive an "insufficient privileges" exception when you connect to Office 365 as a normal user, i.e., someone that does not have elevated privileges and is not a global administrator. Make sure you have set the Access your organization's directory permission when you add the connected services.
- You receive errors during package installation, for example, Unable to find "Microsoft.Azure.ActiveDirectory.GraphClient". Make sure the local path where you placed the solution is not too long/deep. Moving the solution closer to the root of your drive resolves this issue. We'll also work on shortening the folder names in a future update.
- You may run into an authentication error after deploying and running if apps do not have the ability to access account information in the Windows Privacy Settings menu. Set Let my apps access my name, picture, and other account info to On. This setting can be reset by a Windows Update.
