Search…
Integrate the Entitlements SDK
Integrate the Entitlements SDK into your application

Prerequisites

Get Started

Integrate the iOS SDK

The iOS SDK is open source and compatible with iOS 11 and above.
Cocoapods
To use the Entitlements SDK in an iOS app you need to install the SudoEntitlements pod via Cocoapods.
If your project has not already been initialized for cocoapods, run the following command from the project's root directory
1
pod init
Copied!
Open the Podfile file in a text editor and add SudoEntitlements pod as a dependency to the application
Podfile
1
target 'YOUR-APP-NAME' do
2
use_frameworks!
3
pod 'SudoEntitlements'
4
end
Copied!
Install pod dependencies by running the following command
1
pod install --repo-update
Copied!
This will update the local CocoaPods repository and install the latest version of the Entitlements SDK.
In order to instantiate a Entitlements client, make sure you have followed instructions for Getting Started and User SDK (see Prerequisites above)

Client Initialization

To instantiate a client in your application, add the following
Swift
1
import SudoEntitlements
2
​
3
let userClient = // ... see "Users" docs
4
​
5
do {
6
let entitlementsClient = DefaultSudoEntitlementsClient(
7
userClient: userClient)
8
} catch {
9
// Handle initialization error. An error might be thrown due to invalid
10
// or missing configuration file.
11
}
Copied!
You only need one client instance for a given user per device. Instantiating multiple clients with the same configuration and using them at the same time may cause unexpected runtime errors to occur.
See it in action. Be sure to take a look at the open source iOS sample app on Github that our team published as a reference for integrating the Entitlements SDK into your app as quickly and seamlessly as possible.

Integrate the Android SDK

The Android SDK is open source and compatible with Android 6 (API level 23) and above.
Gradle
Add this line to the dependencies section of the app module build.gradle and synchronize your project with Android Studio.
1
dependencies {
2
implementation 'com.sudoplatform:sudoentitlements:1.0.0'
3
}
Copied!
In order to instantiate a Entitlements client, make sure you have followed instructions for Getting Started and User SDK (see Prerequisites above)

Client Initialization

To instantiate a client in your application, add the following
Kotlin
1
val userClient = // ... see "Users" docs
2
​
3
val entitlementsClient = SudoEntitlementsClient.builder()
4
.setContext(appContext)
5
.setSudoUserClient(userClient)
6
.build()
Copied!
You only need one client instance for a given user per device. Instantiating multiple clients with the same configuration and using them at the same time may cause unexpected runtime errors to occur.
See it in action. Be sure to take a look at the open source Android sample app on Github that our team published as a reference for integrating the Entitlements SDK into your app as quickly and seamlessly as possible.

Integrate the JavaScript SDK

The JavaScript SDK is open source and compatible with CommonJS module loading.
NPM
Add this line to the dependencies section of your application's package.json file.
1
dependencies {
2
'@sudoplatform/sudo-entitlements':'^1.0.0'
3
}
Copied!
In order to instantiate a Entitlements client, make sure you have followed instructions for Getting Started and User SDK (see Prerequisites above)

Client Initialization

To instantiate a client in your application, add the following
JavaScript
1
const DefaultSudoEntitlementsClient
2
= require('@sudoplatform/sudo-entitlements')
3
.DefaultSudoEntitlementsClient
4
const userClient = // see "Users" docs
5
​
6
const entitlementsClient =
7
new DefaultSudoEntitlementsClient(userClient)
Copied!
You only need one client instance for a given user per device. Instantiating multiple clients with the same configuration and using them at the same time may cause unexpected runtime errors to occur.
See it in action. Be sure to take a look at the open source JavaScript sample app on Github that our team published as a reference for integrating the Entitlements SDK into your web application as quickly and seamlessly as possible.
Last modified 1mo ago