MapirServices Logo

Swift 5.0 Carthage Compatible SPM

MapirServices

ℹ️ MapirServices framework, helps you with networking part of using services of map.ir

Features

ℹ️ Support for All version 1 API of Map.ir

Example

The example application is the best way to see MapirServices in action. Simply open the MapirServices.xcodeproj and run the Example scheme.

Installation

Carthage

Carthage is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks.

To integrate MapirServices into your Xcode project using Carthage, specify it in your Cartfile:

github "map-ir/ios-sdk-v1-services-beta"

Run carthage update to build the framework and drag the built MapirServices.framework into your Xcode project.

On your application targets’ “Build Phases” settings tab, click the “+” icon and choose “New Run Script Phase” and add the Framework path as mentioned in Carthage Getting started Step 4, 5 and 6

Swift Package Manager

To integrate using Apple's Swift Package Manager, add the following as a dependency to your Package.swift:

dependencies: [
    .package(url: "https://github.com/map-ir/ios-sdk-v1-services-beta", from: "0.1.0")
]

Usage

  1. Get an access token from App Registration site.
  2. Add a key-value pair of your access token to your project's info.plist. Key must be "MAPIRAccessToken" and set the access token as value.
  3. First import SDK using
    import MapirServices
  4. create an singleton instance of the MPSMapirServiecs class whenever you want to use these services
    let services = MPSMapirServices.shared

License

MapirServices
Copyright (c) 2019 Map info@map.ir

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.