SDK のインストール

Prev Next

Classic/VPC環境で利用できます。

Android/iOS/Unity SDKの使用方法をご案内します。
SDKをインストールして環境を構成することで、チャットとダッシュボードを連携できます。

システム要件

Javascript/Typescript

  • Microsoft Edge 13以上
  • Chrome 16以上
  • Firefox 11以上
  • Safari 7以上
  • Opera 12.1以上
  • iOS Safari 7以上
  • Android Browser 4.4(Kitkat)以上

Unity

  • 最小仕様: 2020以降(下位バージョンの Unityサポートが必要な場合は、お問い合わせまでお問い合わせください)
  • 2020.3.X/2021.1.Xバージョンの Unityエディタのユーザーの場合は、2020.3.15f2以降/2021.1.16f1以降のバージョンを使用してください(AABバージョンビルド時の Unityエディタバグ修正バージョン)。

Android (Kotlin)

  • コンパイル、そしてターゲット SDKバージョン33

iOS (Swift)

  • iOS 12.0以上
  • Xcode 15.0以上(出典)
  • Cocoapods

SDKのインストールと環境設定

Javascript/Typescript

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

CDNによって提供されるスクリプトを、headと headとの間に追加します。

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

バージョン情報は、https://www.npmjs.com/package/ncloudchatから確認できます。

Ncloud Chat Javascript SDKは npmパッケージとして提供され、yarnを通じても使用できます。

# using npm
npm install ncloudchat

# using yarn
yarn add ncloudchat

Android (Kotlin)

Firebase Consoleで Androidアプリを追加した後、ダウンロードした「google-services.json」ファイルをプロジェクトアプリモジュールのルートフォルダに追加します。

  1. ファイル追加後、プロジェクトの settings.gradle.kts内に以下の内容を追加します。
dependencyResolutionManagement {
    repositories {
        ...
        google()
        // nbase repo
        maven(url = "https://repo.nbase.io/repository/nbase-releases")
        ...
    }
}
  1. appモジュールの bundle.gradle.kts内に以下の内容を追加します。
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")
}

proguardを使用する場合、proguard-rules内に以下の内容を追加します。

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

iOS (Swift)

Podfileを開いて、以下のように追加します。

platform :ios, '12.0'

# プロジェクトのメインターゲット
target「プロジェクトのメインターゲット」 do
...

  pod 'Socket.IO-Client-Swift', '16.1.0'
  pod 'NChat', '3.0.28'
...
end

pod installを実行して SDKインストールを完了します。

参考
  • Apolloパッケージマネージャの追加
    No such module「Apollo」エラー発生時に Swift Package Managerの実行後、Apolloフレームワークを追加します。

ncloudchat-iOS-Apollo01.png

「+」ボタンのクリック後に Add Package Collection 「https://github.com/apollographql/apollo-ios.git」を追加し、
apollo-iosの選択後、Add Packageでプロジェクトのメインターゲットを選択します。

ncloudchat-iOS-Apollo02.png

Unity

Ncloud Chat Unity SDKをダウンロードし、Unityでプロジェクトを構成する方法は次の通りです。

  1. NAVERクラウドプラットフォームコンソールで、i_menu > Services > Business Applications > Ncloud Chatメニューを順にクリックします。
  2. プロジェクトの管理ページ URLをクリックしてダッシュボードにログインします。
  3. GitHubリポジトリページで ダウンロード します。
  4. サンプルも GitHubリポジトリページで ダウンロード します。
  5. Unityプログラムを実行し、プロジェクトを作成します。
  6. Unityで Assets > Import Package > **Custom Package...**メニューを順にクリックします。
  7. ダッシュボードでダウンロードした「NcloudChat.Unity.SDK.[version].unitypackage」ファイルを読み取ります。
  8. パッケージにあるすべてのファイルを選択した後、 [Import] ボタンをクリックします。
  9. プロジェクトを保存します。