https://github.com/inplayer-org/inplayer-ios-sdk

InPlayer's iOS API Client Wrapper
https://github.com/inplayer-org/inplayer-ios-sdk

Last synced: about 1 month ago
JSON representation

InPlayer's iOS API Client Wrapper

• Host: GitHub
• URL: https://github.com/inplayer-org/inplayer-ios-sdk
• Owner: inplayer-org
• License: mit
• Created: 2018-12-12T11:15:11.000Z (about 6 years ago)
• Default Branch: develop
• Last Pushed: 2022-10-05T22:45:08.000Z (over 2 years ago)
• Last Synced: 2024-12-01T16:02:14.829Z (about 1 month ago)
• Language: Swift
• Homepage: https://inplayer-org.github.io/inplayer-ios-sdk/
• Size: 3.1 MB
• Stars: 5
• Watchers: 27
• Forks: 2
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  

    

    


    InPlayer's iOS SDK

  



InPlayer's iOS API Client Wrapper


# Requirements

 * iOS 10.0+

 * Xcode 10.1+

 * Swift 4.2+

# Installation

## CocoaPods

[CocoaPods](https://cocoapods.org/) is a dependency manager for Cocoa projects. You can install it with the following command:

    $ gem install cocoapods

To integrate InPlayerSDK into your Xcode project using CocoaPods, specify it in your `Podfile`

    source 'https://github.com/CocoaPods/Specs.git'

    install! 'cocoapods',

         : preserve_pod_file_structure => true

    platform :ios, '10.0'

    target '' do

        use_frameworks!

        pod 'InPlayerSDK'

    end

Then, run the following command:

    $ pod install

**Note**: InPlayerSDK is build with submodules. So if you like you can add it like this in your Podfile:

    pod 'InPlayerSDK' (all features, default)

    pod 'InPlayerSDK/Core' (includes Core features - Account, Asset, Subscription)

    pod 'InPlayerSDK/Payment' (includes Core and Payment modules)

    pod 'InPlayerSDK/Notification' (includes Core and Notification modules)

## Dependencies

This SDK has dependencies that it relies on. The list consists of:

     pod 'Alamofire', '5.2.0'

     pod 'AWSIoT', '2.13.4' (only Notifications module)

## Usage

 Import `InPlayerSDK` to your file.

### Configuration

To intialize SDK and start using it, you must first do the following steps:

Create configuration object:

     let configuration = InPlayer.Configuration(clientId: "", referrer: "" environment: )

Initialize InPlayer:

    InPlayer.initialize(configuration: configuration)

### Services

InPlayerSDK consists out of five services:

`Account`, `Asset`, `Payment`, `Subscription` and `Notification`.

##### Account

Account related methods.

###### Example

Authenticate method:

    InPlayer.Account.authenticate(username: "", password: "", success: { (authorization) in

        // Successfully logged in.

    }, failure: { (error) in

        // Some error occured.

    })

##### Asset

Asset related methods:

###### Example

Get asset details:

    InPlayer.Asset.getAsset(id: , success: { (item) in

       // Successfully obtained item details.

    }, failure: { error in

       // Some error occured.

    }

Check asset access:

    InPlayer.Asset.checkAccessForAsset(id: ), success: { (itemAccess) in

        // You have access to this asset

    }, failure: { (error) in

        // Some error occured.            

    })

Additionally when checking access for asset, in `itemAccess.item` there is `content` that can be plain string or json string. In order to parse the model accordingly and have access to its properties (every type has different properties), we encorage you to use it in this matter while in `success` block:

    if let ContentType.accedo(asset) = itemAccess.item.parseContent() {

        // Parsed content is of type `accedo`, and the `asset` is the resource you can use it

    }

##### Payment

Payment related methods:

###### Example

Validate purchase:

    InPlayer.Payment.validate(receiptString: , productIdentifier: , success: {

        // Successfully validated receipt

    }, failure: { (error) in

        // Some error occured

    })

##### Subscription

Subscription related methods:

###### Example

Get account subscriptions: 

    InPlayer.Subscription.getSubscriptions(page: 1, limit: 10, success: { (list) in

        // Successfully obtained subscription list

    }, failure: { (error) in

        // Some error occured

    })

##### Notification

Notification service has three methods:

    public static func subscribe(onStatusChanged: @escaping ( _status: InPlayerNotificationStatus) -> Void,       

                                 onMessageReceived: @escaping (_ notification: InPlayerNotification) -> Void, 

                                 onError: @escaping (_ error: InPlayerError) -> Void)

   and

    public static func unsubscribe()

    public static func isSubscribed() -> Bool

###### Example:

Subscribe method:

    InPlayer.Notification.subscribe(onStatusChanged: { (status) in

        // Notification status changed

    }, onMessageReceived: { (message) in

        // Because message has type which is enum containing associated value, this is one of the ways to use it.

        if case let NotificationType.accessGranted(resource) = message.type {

            // Access was granted, you can use resource

        }

    }, failure: { (error) in

        // InPlayerError containing info about what happened

    })

# Contributing

We are thankful for any contributions made by the community. By contributing you agree to abide by

the Code of Conduct in the [Contributing Guidelines](https://github.com/inplayer-org/inplayer-ui/blob/master/.github/CONTRIBUTING.md).

# License

Licensed under the MIT License, Copyright © 2018-present InPlayer.

See [LICENSE](https://github.com/inplayer-org/inplayer-ios-sdk/blob/master/LICENSE) for more information.