TOAST > TOAST SDK使用ガイド > 開始する > iOS

サポート環境

  • iOS 9.0以上
  • XCode最新バージョン(バージョン10以上)

TOAST SDKの構成

Service Cocoapods Pod Name Carthage Framework Dependency Build Settings
All ToastSDK binary "https://nh.nu/toast" ToastCore.framework
ToastCommon.framework
ToastLogger.framework
ToastIAP.framework
ToastPush.framework
Mandatory ToastCore
ToastCommon
ToastCore.framework
ToastCommon.framework
OTHER_LDFLAGS = (
"-ObjC",
"-lc++"
);
TOAST Log & Crash ToastLogger ToastLogger.framework [External & Optional]
* CrashReporter.framework (Toast)
TOAST IAP ToastIAP ToastIAP.framework * StoreKit.framework

[Optional]
* libsqlite3.tdb
TOAST Push ToastPush ToastPush.framework * UserNotifications.framework

[Optional]
* PushKit.framework

TOAST SDKをXcodeプロジェクトに適用

1. Cococapodsを使用してTOAST SDK適用

  • Podfileを作成してTOAST SDKのPodを追加します。
platform :ios, '9.0' 
use_frameworks! 

target '{YOUR PROJECT TARGET NAME}' do 
    pod 'ToastSDK' 
end 

2. Carthageを使用してTOAST SDK適用

  • Cartfileを作成してTOAST SDKを追加します。
# Full URL
binary "https://api-storage.cloud.toast.com/v1/AUTH_f9e3dc598ca142d3820e1c19343d5428/carthage/ToastSDK.json" 

# Short URL 
binary "https://nh.nu/toast"
  • 作成されたCarthage/BuildフォルダのFrameworkをXcodeプロジェクトに追加します。
    carthage_import_framework

  • プロジェクトに次のようにフレームワーク(framework)が追加されたことを確認します。 import_carthage_frameworks_complete import_carthage_frameworks_complete

  • TOAST SDKを使用するためにフレームワーク設定プロジェクト設定を行う必要があります。

サービスのいずれかの機能を選択して使用するには、サービスごとに必要なFrameworkのみ選択してプロジェクトに追加する必要があります。 サービスごとに必要なFrameworkはTOAST SDKの構成で確認できます。

3. バイナリをダウンロードしてTOAST SDK適用

  • TOASTのDownloadsページで全体iOS SDKをダウンロードできます。 import_frameworks

  • TOAST LoggerのCrash Report機能を使用するには、一緒に配布されるCrashReporter.frameworkもプロジェクトに追加する必要があります。 import_external_framework

  • プロジェクトに次のようにフレームワーク(framework)が追加されたことを確認します。 import_frameworks_complete

  • TOAST IAP機能を使用するには、StoreKit.frameworkを追加する必要があります。 linked__storekit_frameworks

  • TOAST Push機能を使用するには、UserNotifications.frameworkを追加する必要があります。 linked__usernotifications_frameworks

xcframework
  • xcframeworkを使用するとarm simulatorでもToastSDKを使用できます。 xcframework01 xcframework01

Project Settings

  • Build SettingsOther Linker Flags-lc++-ObjC項目を追加します。

    • Project Target > Build Settings > Linking > Other Linker Flags other_linker_flags
  • CrashReporter.frameworを直接ダウンロードするか、ビルドした場合はBuild SettingsEnable Bitcodeの値をNOに変更する必要があります。

    • Project Target > Build Settings > Build Options > Enable Bitcode enable_bitcode

      TOASTのDownloadsページでダウンロードしたCrashReporter.frameworkは、bitCodeをサポートします。

フレームワークのインポート

  • 使用するフレームワークをインポートします(import)。
#import <ToastCore/ToastCore.h> 
#import <ToastLogger/ToastLogger.h> 
#import <ToastIAP/ToastIAP.h> 
#import <ToastPush/ToastPush.h> 

UserID設定

  • TOASAT SDKにユーザーIDを設定できます。
  • 設定したUserIDは、TOAST SDKの各モジュールで共通使用されます。
  • TOAST Loggerのログ送信APIを呼び出すたびに、設定したユーザーIDをログと一緒にサーバーに送信します。

UserID API仕様

+ (void)setUserID:(NSString *)userID; 

UserID設定使用例

[ToastSDK setUserID:@"TOAST-USER"]; 

デバッグモード設定

  • TOAST SDKの内部ログを確認するために、デバッグモードを設定できます。
  • TOAST SDKに関するお問い合わせの際は、デバッグモードを有効にしていただくと、迅速にサポートできます。

デバッグモード設定API仕様

+ (void)setDebugMode:(BOOL)debugMode; 

デバッグモード設定使用例

[ToastSDK setDebugMode:YES];    // or NO 

[注意]アプリをリリースする場合、デバッグモードを無効化する必要があります。

TOAST Service使用

TOP