Skip to content

Reloadly/reloadly-sdk-ios

Repository files navigation

reloadly-swift-icon

Reloadly SDK for iOS and iPadOS

Version License Platform Build Status codecov

The Reloadly SDK enables iOS developers to easily work with Reloadly Services and build scalable solutions.

Getting Started

Sign up for Reloadly

Before you begin, you need a Reloadly account. Please see the Sign Up for Reloadly section of the knowledge-base for information about how to create a Reloadly account and retrieve your Reloadly APIs credentials.

Example

To run the example project, clone the repo, and run pod install from the Example directory first.

Demo application

You can find some examples in the Example folder. Run .workspace to test the demo application with the SDK. Please see below, on how to specify your ClientId and SecretId.

Requirements

Swift 4.0 and higher

Installation

ReloadlySDK is available through CocoaPods. To install it, simply add the following line to your Podfile:

ReloadlySDK include both of SDK's Authentication and Airtime

  pod 'ReloadlySDK/Airtime'

Also you can install separately, by default Airtime include Authentication SDK as dependency

  pod 'ReloadlySDK/Airtime'
  pod 'ReloadlySDK/Authentication'

Manually

To use this library in your project manually just drag and drop ReloadlySDK folder to your project.

Usage

Import ReloadlySDK

import ReloadlySDK

Initialise the library in the AppDelegate.

You can set ClientId, SecretId and environment in the plist file of your app. Just paste the following in your plist file:

<key>ReloadlySDKClientId</key>
<string>PUT_YOUR_RELOADLY_CLIENT_ID_HERE/string>
<key>ReloadlySDKSecretId</key>
<string>PUT_YOUR_RELOADLY_CLIENT_SECRET_HERE</string>
<key>ReloadlySDKEnvironment</key>
<string>sandbox</string>
@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {

    var window: UIWindow?

    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
        // Override point for customization after application launch.
        ReloadlyAuthentication.shared.configure()
        return true
    }
}

You can setup additional fine grained settings like logLevel, proxy configuration, environment etc.

Getting Help

GitHub issues is the preferred channel to interact with our team. Also check these community resources for getting help:

  • Checkout & search our knowledge-base
  • Talk to us live on our chat tool on our website (bottom right)
  • Ask a question on StackOverflow and tag it with reloadly-swift-sdk
  • Articulate your feature request or upvote existing ones on our Issues page
  • Take a look at our youtube series for plenty of helpful walkthroughs and tips
  • Open a case via with the Reloadly Support Center
  • If it turns out that you may have found a bug, please open an issue

Giving Feedback

We need your help in making this SDK great. Please participate in the community and contribute to this effort by submitting issues, participating in discussion forums and submitting pull requests through the following channels:

  • Submit issues - this is the preferred channel to interact with our team
  • Come join the Reloadly swift community chat on [Gitter][gitter]
  • Articulate your feature request or upvote existing ones on our Issues page
  • Send feedback directly to the team at oss@reloadly.com

License

This project is licensed under the MIT license. See the LICENSE file for more info.