Table of contents
- Introduction
- Set up your environment
- Use CocoaPods to import the O365 iOS SDK
- Register your app with Microsoft Azure
- Get the Client ID and Redirect Uri into the project
- Code of Interest
- Additional resources
The Office 365 code snippets for iOS is a repository of code snippets that demonstrate how to work with Office 365 objects like mail, calendar, contacts, and files. This project uses the Office 365 SDK for iOS from Microsoft Open Technologies, Inc (MS Open Tech). This project has been tested against version 0.9.1 of the SDK. It also uses the Azure Active Directory Authentication Library (ADAL) for Objective-C.
The main benefits of using this sample:
-
Learn how the Office 365 SDK for iOS is used to make calls that target data stored in Office 365 (including Exchange Online and SharePoint Online).
-
Copy and paste code snippets that you can use in your application.
-
Learn how to use the Azure Active Directory Authentication Library (ADAL) for Objective-C.
Note: If possible, please use this sample with a "non-work" or test account in Office 365. With the current version of the project, it does not clean up the created objects in your mailbox, calendar, or contacts. At this time you will have to remove these sample mails, contacts, and calendar events manually.
To run the Office 365 code snippets for iOS you need the following:
- Xcode from Apple.
- An Office 365 account. You can get an Office 365 account by signing up for an Office 365 Developer site. This will give you access to the APIs that you can use to create apps that target Office 365 data.
- A Microsoft Azure tenant to register your application. Azure Active Directory provides identity services that applications use for authentication and authorization. A trial subscription can be acquired here: Microsoft Azure.
Important: You will also need to ensure your Azure subscription is bound to your Office 365 tenant. To do this see the Active Directory team's blog post, Creating and Managing Multiple Windows Azure Active Directories. The section Adding a new directory will explain how to do this. You can also read Set up Azure Active Directory access for your Developer Site for more information.
- Installation of CocoaPods as a dependency manager. CocoaPods will allow you to pull the Office 365 and ADAL authentication dependencies into the project.
Once you have an Office 365 account, an Azure AD account that is bound to your Office 365 Developer site, you'll need to perform the following steps:
- Install and use CocoaPods to get the Office 365 and ADAL authentication dependencies into your project. We'll show you how to do later in the section Use CocoaPods to import the O365 iOS SDK.
- Register your application with Microsoft Azure, and configure the appropriate Office 365 Exchange and SharePoint permissions.
- Enter the Azure app registration specifics (ClientID and RedirectUri) into the Office 365 iOS Snippet app.
Note: If you've never used CocoaPods before as a dependency manager you'll have to install it prior to getting your O365 iOS SDK dependencies into your project. If you already have it installed you may skip this installation step and move on to Getting the Office 365 SDK for iOS dependencies in your project.
Enter both these lines of code from the Terminal app on your Mac.
sudo gem install cocoapods
pod setup
If the install and setup were successful, you should see the message Setup completed in Terminal. For more information on CocoaPods, and its usage, see CocoaPods.
Getting the Office 365 SDK for iOS dependencies in your project. The O365 iOS Snippet app already contains a podfile that will get the Office 365 and ADAL components (pods) into your project. It's located in the root ("Podfile"). The syntax should look something similar to the next line.
target ‘sample podfile’ do
pod 'ADALiOS', '~> 1.2.1'
pod 'Office365/Outlook', '= 0.9.1'
pod 'Office365/Discovery', '= 0.9.1'
pod 'Office365/Files', '= 0.9.1'
end
You'll simply need to navigate to the project directory in the Terminal (root of the project folder) and run the following command.
pod install
Note: You should receive confirmation that these dependencies have been added to the project. If there is a syntax error in the Podfile, you will encounter an error when you run the install command.
- 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 developer site.
- 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 O365-iOS-Snippets for the application name and select NATIVE CLIENT APPLICATION for type.
- Click the arrow icon on the bottom-right corner of the page.
- On the Application information page, specify a Redirect URI, for this example, you can specify http://localhost/snippetAppProject, and then select the checkbox in the lower-right hand corner of the page. Remember this value for the below section Getting the ClientID and RedirectUri into the project.
- Once the application has been successfully added, you will be taken to the Quick Start page for the application. From here, select Configure in the top menu.
- Under permissions to other applications, add the following two permissions: Add the Office 365 SharePoint Online application, and select the Read and write user files permission. Add the Office 365 Exchange Online application, and select the Read and write user mail, Send mail as a user, Read and write user calendars, Read and write user contacts permissions.
- Copy the value specified for Client ID on the Configure page. Remember this value for the below section Getting the ClientID and RedirectUri into the project.
- Click Save in the bottom menu.
Finally you'll need to add the Client ID and Redirect Uri you recorded from the previous section Register your app with Microsoft Azure.
Browse the O365-iOS-Snippets project directory and open up the workspace (O365-iOS-Snippets.xcworkspace). In the AuthenticationManager.m file you'll see that the ClientID and RedirectUri values can be added to the top of the file. Supply the necessary values here:
// You will set your application's clientId and redirect URI. You get
// these when you register your application in Azure AD.
static NSString * const REDIRECT_URL_STRING = @"ENTER_REDIRECT_URI_HERE";
static NSString * const CLIENT_ID = @"ENTER_CLIENT_ID_HERE";
static NSString * const AUTHORITY = @"https://login.microsoftonline.com/common";
The common directory in the project contains the files needed to work with Office 365 including authentication, creating Outlook and SharePoint client objects to make Office 365 API calls, and the snippets. Another file of interest is the the MasterViewController.m. Outside of some UI logic, it defines the Office 365 snippets run in this project (Get Event, Create message, etc) and calls into the snippets library (Office365Snippets.m).
Office 365 code snippets
The code snippets are located in these files:
Office365Snippets.h
Office365Snippets.m
Authentication with Azure AD
The code that uses the ADAL SDK for Objective C to authenticate with Azure AD is located in the following files:
AuthenticationManager.h
AuthenticationManager.m
Outlook Services and SharePoint client creation
The code for creating your Outlook Services and SharePoint clients is located in the following files:
Office365ClientFetcher.h
Office365ClientFetcher.m
The code in these files creates the Outlook Services, SharePoint, and Discovery client objects. The Outlook Services and SharePoint client objects perform the calls against the Office 365 Exchange and SharePoint services. The Discovery client makes calls to get service URLs for the Outlook Services and SharePoint clients. The clients use the AuthenticationManager code to get the application an access and refresh token to act on behalf of the authenticated user. The access and refresh token will be cached. The next time a user attempts to access the service, the access token will be issued. If the access token has expired, the client will issue the refresh token to get a new access token.
Discovery Service
The Office 365 Discovery service code to retrieve the Exchange and SharePoint service endpoints/URLs is located in the following file:
Office365Snippets.m (fetchDiscoveryServiceEndpoints method)
This sample begins the authentication process automatically when it starts. The ViewDidLoad method in MasterViewController.m calls the method fetchDiscoveryServiceEndpoints method. The fetchDiscoveryServiceEndpoint method creates a Discovery client which authenticates the user.
- Office 365 Connect app for iOS
- Office 365 Profile Sample for iOS
- Email Peek - An iOS app built using Office 365
- Office 365 APIs documentation
- Office 365 API code samples and videos
- File REST operations reference
- Calendar REST operations reference
- Mail REST operations reference
- Contacts REST operations reference
- Office Dev Center
- Microsoft Azure Active Directory Authentication Library (ADAL) for iOS and OSX
- Office 365 SDK for iOS
- UI Library for Microsoft RMS SDK v4.1 for iOS
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.