SimpleMDM-Swift 0.10.0

SimpleMDM-Swift 0.10.0

×

Maintained by Guillaume Algis.

SimpleMDM-Swift 0.10.0

SimpleMDM-Swift

MIT Build Status Codecov CocoaPods Compatible Carthage Compatible Platform Swift version Twitter

SimpleMDM-Swift is a cross-platform (iOS, macOS, tvOS, watchOS) SDK to access the SimpleMDM API written in Swift.

Please Note: This library is not officially supported by SimpleMDM. It does not currently wrap the complete functionality of the SimpleMDM API. Use at your own risk.

Features

  • Read-only access to all exposed resources (Device, App, etc.) of the REST API
  • Supports the pagination API introduced August 15, 2018
  • Type-safe
  • Asynchronous API, relying on Result type, and Promises (optional API)
  • High test coverage
  • 100% documented
System requirements
  • Deployment target of iOS 10.0+ / macOS 10.12+ / tvOS 10.0+ / watchOS 3.0+
  • Xcode 10.2+
  • Swift 5.0.1+

Usage

📘 Full documentation is available here: https://guillaumealgis.github.io/SimpleMDM-Swift/

// Just set this once in your applicationDidBecomeActive method
SimpleMDM.APIKey = "233b7a3058694652ae6f62acfcba8be7"

// Get the device with id 42
Device.get(id: 42) { result in
    switch result {
    case let .failure(error):
        print("Could not get device: \(error)")
    case let .success(device):
        print(device.name)
    }
}

// Get all device groups
DeviceGroup.getAll { result in
    switch result {
    case let .failure(error):
        print("Could not get device groups: \(error)")
    case let .success(deviceGroups):
        print(deviceGroups.map { $0.name })
    }
}

Installation

CocoaPods

To integrate SimpleMDM-Swift into your Xcode project using CocoaPods, specify it in your Podfile:

source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '12.0'

target '<Your Target Name>' do
    pod 'SimpleMDM-Swift', '~> 0.7.0'
end

Then, run the following command:

$ pod install

Carthage

To integrate SimpleMDM-Swift into your Xcode project using Carthage, specify it in your Cartfile:

github "guillaumealgis/SimpleMDM-Swift"

Run carthage update to build the framework and drag the built SimpleMDM-Swift.framework into your Xcode project and update your run scripts as appropriate. For additional support, please visit the Carthage documentation.

Swift Package Manager

The Swift Package Manager is a tool for automating the distribution of Swift code and is integrated into the swift compiler. It is in early development, but SimpleMDM-Swift does support its use on supported platforms.

Once you have your Swift package set up, adding SimpleMDM-Swift as a dependency is as easy as adding it to the dependencies value of your Package.swift.

Swift 4

dependencies: [
    .package(url: "https://github.com/guillaumealgis/SimpleMDM-Swift.git", from: "0.1.0")
]

Apps using SimpleMDM-Swift

I'd love to hear what you have used SimpleMDM-Swift for, if you would like your app displayed here, please send a pull request!

Contributing

If you wish to contribute to SimpleMDM-Swift please fork the repository and send a pull request. Contributions and feature requests are always welcome, please do not hesitate to raise an issue!

Contributors and any people interacting on this project are expected to adhere to its code of conduct. See CODE_OF_CONDUCT.md for details.

License

SimpleMDM-Swift is released under the MIT license. See LICENSE.md for details.

Related Projects