isabella232 / azure-mobile-apps-ios-client

iOS Client SDK for Azure Mobile Apps

Microsoft Azure Mobile Apps: iOS SDK

With Microsoft Azure Mobile Apps you can add a scalable backend to your connected client applications in minutes. To learn more, visit our Developer Center.

Getting Started

If you are new to Mobile Apps, you can get started by following our tutorials for connecting your Mobile Apps cloud backend to iOS apps.

Supported Platforms

The current release of the iOS SDK for Azure Mobile Apps supports:

• iOS versions 8.0 through 11.0
• Objective-C Projects
• Swift 3.0 Projects (with XCode 8.1)

Other platforms may work, but have not been tested.

Download Source Code

To get the source code of our SDKs and samples via git just type:

git clone https://github.com/Azure/azure-mobile-apps-iOS-client.git
cd ./azure-mobile-apps-iOS-client/

Reference Documentation

• Client SDK

• Change log

iOS Client SDK

Add a cloud backend to your iOS application in minutes with our iOS client SDK. You can download the iOS SDK directly or you can download the source code using the instructions above.

Prerequisites

The SDK requires XCode 7.0 or greater.

Integration Using CocoaPods

CocoaPods is a popular dependency manager for Swift and Objective-C Cocoa projects. The dependencies are specified in a single text file called Podfile. Cocoapods will resolve dependencies between libraries, fetch the resulting source code, then link it together in an Xcode workspace to build your project.

1. Add the following to your podfile to include MicrosoftAzureMobile:

   pod 'MicrosoftAzureMobile', '~> 3.4.0'

2. You can install the dependencies in your project:

   pod install

3. Open .xcworkspace (instead of .xcodeproj file) to start working on your project. You can import MicrosoftAzureMobile.h header in your code like this:

#import <MicrosoftAzureMobile/MicrosoftAzureMobile.h>

Integration by Copying the Binary into Your Project

1. Download the Azure Mobile iOS SDK framework zip file from Releases
2. Unzip the file. MicrosoftAzureMobile.framework is the binary to reference.

How to Build and Run the Tests

Building the SDK

1. Open the sdk\WindowsAzureMobileServices.xcodeproj file in XCode.
2. Set the active scheme option to Framework\iOS Device.
3. Build the project using Command-B. The WindowsAzureMobileServices.framework folder should be found in the build output folder under Products\<build configuration>-iphoneos.
4. Drag and drop the WindowsAzureMobileServices.framework from a Finder window into the Frameworks folder of the Project Navigator panel of your iOS application XCode project.

Running the Unit Tests

1. Open the sdk\WindowsAzureMobileServices.xcodeproj file in XCode.
2. Set the active scheme option to WindowsAzureMobileServices\* Simulator.
3. Open the Test\WindowsAzureMobileServicesFunctionalTests.m file in the Project Navigator panel of XCode.
4. In the settings.plist file, set TestAppUrl and TestAppApplicationKey to a valid URL and Application Key for a working Mobile Service.
5. Run the tests using Command-U.

Running the E2E Tests

1. Create a test server to test against, see: E2E Test Suite
2. Open the ZumoE2ETestApp\ZumoE2ETestApp.xcodeproj file in XCode.
3. Drag a copy of the WindowsAzureMobileServices.framework into the project
4. Pick the device to test and run the project

Future of Azure Mobile Apps

Microsoft is committed to fully supporting Azure Mobile Apps, including support for the latest OS release, bug fixes, documentation improvements, and community PR reviews. Please note that the product team is not currently investing in any new feature work for Azure Mobile Apps. We highly appreciate community contributions to all areas of Azure Mobile Apps.

Useful Resources

• Quickstarts
• E2E Test Suite
• Samples
• Tutorials and product overview are available at Microsoft Azure Mobile Services Developer Center.
• Our product team actively monitors the Mobile Services Developer Forum to assist you with any troubles.

Contribute Code or Provide Feedback

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.

If you would like to become an active contributor to this project please follow the instructions provided in Microsoft Azure Projects Contribution Guidelines.

If you encounter any bugs with the library please file an issue in the Issues section of the project.