Install SDK

Prev Next

Available in Classic and VPC

The following guides you on how to use Android, iOS, and Unity SDK.
You can integrate the chat and dashboard by installing the SDK and configuring the environment.

Required specifications

Javascript/Typescript

  • Microsoft Edge 13 or later
  • Chrome 16 or later
  • Firewall 11 or later
  • Safari 7 or later
  • Opera 12.1 or later
  • iOS Safari 7 or later
  • Android Browser 4.4 (KitKat) or later

Unity

  • Minimum specifications: 2020 or later (If you need support for a lower version of Unity, make an inquiry at Inquiry channel.)
  • Users of Unity Editor on 2020.3.X / 2021.1.X version should use 2020.3.15f2 or later / 2021.1.16f1 or later (Unity Editor bug fixes for AAB version builds).

Android (Kotlin)

  • Compile and target SDK version 33

iOS (Swift)

  • iOS 12.0 or later
  • Xcode 15.0 or later (source)
  • Cocoapods

Install SDK and configure the environment

Javascript/Typescript

  • https://unpkg.com/ncloudchat/ncloudchat.min.js

Add the script provided through CDN between heads.

<head>
    <script src="https://unpkg.com/ncloudchat/ncloudchat.min.js"></script>
</head>
Note

Version information can be found at https://www.npmjs.com/package/ncloudchat.

Ncloud Chat JavaScript SDK is provided as an npm package and is also available through Yarn.

# using npm
npm install ncloudchat

# using yarn
yarn add ncloudchat

Android (Kotlin)

After adding the Android app in Firebase Console, download the "google-services.json" file and place it in the root folder of the project's app module.

  1. After adding the file, include the following content in setting.bundle.gradle.kts of the project.
dependencyResolutionManagement {
    repositories {
        ...
        google()
        // nbase repo
        maven(url = "https://repo.nbase.io/repository/nbase-releases")
        ...
    }
}
  1. Add the following content in bundle.gradle.kts of the app module.
plugins {
    ...
    id("com.google.gms.google-services")
}

 dependencies {
    implementation("io.nbase:nbasesdk:latest.release")
    implementation("io.nbase:nbase-adapter-cloudchat:latest.release")
    implementation("com.google.firebase:firebase-messaging-ktx:23.2.1")
}

If you are using ProGuard, add the following content to ProGuard rules.

-dontwarn com.nbase.**
-dontwarn com.samsung.**
-keep class com.nbase.** { *; }

iOS (Swift)

Open Podfile and add the following:

platform :ios, '12.0'

# Project main target
target 'Project main target' do
...
  pod 'Socket.IO-Client-Swift', '16.1.0'
  pod 'NChat', '3.0.28'
...
end

Run pod install to complete the SDK installation.

Note
  • Add Apollo Package Manager
    If No such module 'Apollo' error occurs, run the Swift Package Manager and add the Apollo framework.

ncloudchat-iOS-Apollo01.png

Click the '+' button, then add Add Package Collection ' https://github.com/apollographql/apollo-ios.git '
Select apollo-ios and then select the project main target in Add Package.

ncloudchat-iOS-Apollo02.png

Unity

To download Ncloud Chat Unity SDK and configure your project in Unity, follow these steps:

  1. On the NAVER Cloud Platform console, click i_menu > Services > Business Applications > Ncloud Chat in order.
  2. Click the management page URL for the project to log in to the dashboard.
  3. Download from the GitHub repository page.
  4. For samples, download from the GitHub repository page as well.
  5. Run Unity, and create a project.
  6. In Unity, click Assets > Import Package > Custom Package... in order.
  7. Import the downloaded 'NcloudChat.Unity.SDK.[version].unitypackage' file from the dashboard.
  8. Select all files in the package, and then click the [Import] button.
  9. Save the project.