Integrate the User SDK
Integrate the User SDK into your application
To use User SDK in an iOS app you need to install
SudoUser pod via CocoaPods.Install CocoaPods by running the following command:
shell
sudo gem install cocoapods
Initialize CocoaPods for your app project by running the following command from the project's root directory:
shell
pod init
Open the createdPodfilein a text editor and addSudoUserpod as a dependency to your app target.
Podfile
target 'YOUR-APP-NAME' do
use_frameworks!
pod 'SudoUser'
# other pods
end
Install pod dependencies by running the following command:
shell
pod install --repo-update
Instantiating and initializing a client:
Swift
do {
let client: SudoUserClient = try DefaultSudoUserClient(keyNamespace: "<your-application-name>")
catch let error {
// Handle initialization error. An error might be thrown due to invalid
// or missing confiugration file.
}
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.
To use User SDK in an Android app you need to add
SudoUser library as a dependency to your project.Edit the app module Gradle script (build.gradle) and add SudoUser library as a dependency.
Gradle
dependencies {
api 'com.sudoplatform:sudouser:$latest_version'
}
Edit AndroidManifest.xml to add the following app permissions:
Diff
<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+ xmlns:tools="http://schemas.android.com/tools"
package="com.sudoplatform.sampleapp">
+ <uses-permission android:name="android.permission.INTERNET" />
+ <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
+ <uses-permission android:name="android.permission.WAKE_LOCK" />
+ <uses-permission android:name="android.permission.READ_PHONE_STATE" />
+ <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
+ <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
+ <queries>
+ <intent>
+ <action android:name="android.intent.action.VIEW" />
+ <data android:scheme="https" />
+ </intent>
+ <intent>
+ <action android:name=
+ "android.support.customtabs.action.CustomTabsService" />
+ </intent>
+ </queries>
<application
+ tools:replace="android:allowBackup"
+ android:allowBackup="false"
Instantiating and initializing a client:
Kotlin
val client = SudoUserClient.builder(appContext)
.setNamespace("<your-application-name>")
.build()
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.
To use the Sudo User SDK in a Web or Node.js project, you must add
@sudoplatform/sudo-user as a dependency to your project.yarn add '@sudoplatform/sudo-user'
# or
npm install --save '@sudoplatform/sudo-user'
Instantiating and initializing a client:
TypeScript
import { DefaultConfigurationManager } from '@sudoplatform/sudo-common'
// Set configuration (content of file downloaded in previous step) in the configuration manager
DefaultConfigurationManager.getInstance().setConfig(configJson)
// Instantiate and initialize the client
const client = new DefaultSudoUserClient()
Last modified 24d ago