Skip to content

Latest commit

 

History

History

AzureCore

README.md

Azure Core client library for iOS

This is the core framework for the Azure SDK for iOS, containing the HTTP pipeline, as well as a shared set of components that are used across all client libraries, including pipeline policies, error types, type aliases, an XML Codable implementation, and a logging system. As an end user, you don't need to manually install AzureCore because it will be installed automatically when you install other SDK libraries. If you are a client library developer, please reference the AzureCommunicationChat library as an example of how to use the shared AzureCore components in your client library.

Source code | API reference documentation

Getting started

Prerequisites

  • The client library is written in modern Swift 5. Due to this, Xcode 10.2 or higher is required to use this library.
  • You must have an Azure subscription to use this library.

Install the library

To install the Azure client libraries for iOS, we recommend you use Swift Package Manager. As an alternative, you may also integrate the libraries using CocoaPods.

Add a package dependency with Swift Package Manager

The Swift Package Manager is a tool for managing the distribution of Swift code. It’s integrated with the Swift build system to automate the process of downloading, compiling, and linking dependencies.

Xcode comes with built-in support for Swift Package Manager and source control accounts and makes it easy to leverage available Swift packages. Use Xcode to manage the versions of package dependencies and make sure your project has the most up-to-date code changes.

Xcode

To add the library to your application, follow the instructions in Adding Package Dependencies to Your App:

In order to independently version packages with Swift Package Manager, we mirror the code from azure-sdk-for-ios into separate repositories. Your Swift Package Manager-based app should target these repos instead of the azure-sdk-for-ios repo.

With your project open in Xcode 11 or later, select File > Swift Packages > Add Package Dependency... Enter the clone URL of the Swift Package Manager mirror repository: https://github.com/Azure/SwiftPM-AzureCore.git and click Next. For the version rule, specify the exact version or version range you wish to use with your application and click Next. Finally, place a checkmark next to the library, ensure your application target is selected in the Add to target dropdown, and click Finish.

Swift CLI

To add the library to your application, follow the example in Importing Dependencies:

Open your project's Package.swift file and add a new package dependency to your project's dependencies section, specifying the clone URL of this repository and the version specifier you wish to use:

// swift-tools-version:5.3
    dependencies: [
        ...
        .package(name: "AzureCore", url: "https://github.com/Azure/SwiftPM-AzureCore.git", from: "1.0.0-beta.15")
    ],

Next, for each target that needs to use the library, add it to the target's array of dependencies:

    targets: [
        ...
        .target(
            name: "MyTarget",
            dependencies: ["AzureCore", ...])
    ]
)

Integrate the client libraries with CocoaPods

CocoaPods is a dependency manager for Objective C and Swift projects. You can install it with the following command:

$ [sudo] gem install cocoapods

CocoaPods 1.5+ is required.

To integrate one or more client libraries into your project using CocoaPods, specify them in your Podfile, providing the version specifier you wish to use. To ensure compatibility when using multiple client libraries in the same project, use the same version specifier for all Azure SDK client libraries within the project:

platform :ios, '12.0'

# Comment the next line if you don't want to use dynamic frameworks
use_frameworks!

target 'MyTarget' do
  pod 'AzureCore', '1.0.0-beta.15'
  ...
end

Then, run the following command:

$ pod install

Key concepts

The main shared concepts of AzureCore (and thus, Azure SDK libraries using AzureCore) include:

  • Configuring service clients, e.g. policies, logging (HeadersPolicy et al., ClientLogger).
  • Accessing HTTP response details (HTTPResponse, HTTPResultHandler<T>).
  • Paging and asynchronous streams (PagedCollection<T>).
  • Exceptions for reporting errors from service requests in a consistent fashion. (AzureError, HTTPResponseError).
  • Abstractions for representing Azure SDK credentials. (AccessToken).

Examples

See AzureCommuncationChat for an example of using this library.

Troubleshooting

If you run into issues while using this library, please feel free to file an issue.

Next steps

Explore and install available Azure SDK libraries.

Contributing

This project welcomes contributions and suggestions. All code contributions should be made in the [Azure SDK for iOS] (https://github.com/Azure/azure-sdk-for-ios) repository.

Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repositories using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Impressions