ビジネスメッセンジャーのSDKとiOSアプリとの連携

ビジネスメッセンジャーのSDKとiOSアプリとの連携

iOSアプリでのビジネスメッセンジャーのSDK(ソフトウェア開発キット)の設定

Zoho DeskでSDK(ソフトウェア開発キット)の設定後、iOSアプリとビジネスメッセンジャーのSDKを連携する必要があります。

連携するにあたって、以下の2種類の方法があります。

1.CocoaPodsを利用した自動連携iOSアプリのライブラリー管理ツールであるCocoaPodsを利用します。CocoaPodsを利用すると、外部サービスの機能をXcodeのプロジェクトに追加することができます。

2.手動連携  CocoaPodsを利用せずに、手動で連携を行います。

CocoaPodsを利用した自動連携

ビジネスメッセンジャーのSDKとアプリを連携するには、まずCocoaPodsでプロジェクトのPodfileを作成する必要があります。

Podfileを作成するには、以下の手順を実施します。

1.ターミナルで、プロジェクトの最上位のフォルダーに移動します(「xcodeproj」ファイルが含まれるフォルダーです)。
2.コマンド「$ pod init」を実行します。
3.コマンド「open -a Xcode Podfile」を実行して、XcodeのPodfileを開きます。

ファイルの内容が以下のように表示されます。
Quote
 # Uncomment this line to define a global platform for your project
# platform :ios, '13.0'
# Uncomment this line if you're using Swift
# use_frameworks!
target 'My Sample App' do
end
4.ライブラリーの作成にSwiftを利用している場合は、「use frameworks!」  の行頭にあるハッシュ記号(#)を削除してください。

ビジネスメッセンジャーのSDKをプロジェクトにインストールするには、PodfileにビジネスメッセンジャーのSDKを追加します。

追加するには、以下の手順を実施します。

1.該当のビジネスメッセンジャーのSDKを対象のPodfileに追加します。ビジネスメッセンジャーのSDKと連携するには、以下のコードをPodfileのdoブロックに追加します。 
  1. target 'My Sample App' do
    pod  'BusinessMessagingSDK'
    end  
2.Podfileを保存します。
3.ターミナルでコマンド「$ pod install」を実行します。

CocoaPodsのインストール前は、「xcodeproj」としてファイルが開きます。

インストール後は、「xcodeproj」ファイルを閉じて、「xcworkspace」ファイルを開きます。

手動連携 

ビジネスメッセンジャーのSDKと手動で連携するには、以下の手順を実施します。

1.ビジネスメッセンジャーのSDKをダウンロードします。
2.ダウンロードしたZipファイルを展開します(拡張子:.XCFramework)。
3.拡張子が「.XCFramework」のフレームワークファイルを、 Xcodeのプロジェクトの「Frameworks, Libraries, and Embedded」のセクションにドラッグ&ドロップします。

Info
ビジネスメッセンジャーのSDKは、iOS 13以降のバージョンに対応しています。
NotesビジネスメッセンジャーのSDKを連携する場合は、アプリの「info.plist」ファイルに「NSPhotoLibraryUsageDescription」、「NSCameraUsageDescription」、「NSLocationAlwaysUsageDescription」、「NSLocationWhenInUseUsageDescription」、「NSMicrophoneUsageDescription」の各キーを追加してください。
Warning
「info.plist」ファイルにこれらのキーが追加されていない場合、アプリを起動してもアプリが正常に動作しません。また、関連するビューコントローラーが存在する場合、App Storeによる認証に失敗する可能性があります。