本文にスキップする
Version: 5.5

PlanetKitの初期化

他の関数を呼び出す前にPlanetKitを初期化する必要があります。

Tip

ここで触れているのは、初期化に関するサンプルコードです。PlanetKit SDKを使用した全体のクライアントコードは、デモアプリのソースコードで確認できます。

初期化

PlanetKitInitialSettingBuilderオブジェクトを引数としてPlanetKitManagerinitialize()を呼び出し、PlanetKitを初期化します。このとき、必ずplanet_base_urlを設定する必要があります。

class YourApplication {
func initializePlanetKit() {
let logLevel: PlanetKitLogLevel = .simple
let logSizeLimit: PlanetKitLogSizeLimit = .small

let settingBuilder = PlanetKitInitialSettingBuilder()
.withEnableKitLogKey(level: logLevel, enable: true, logSize: logSizeLimit)
.withSetKitServerKey(serverUrl: planet_base_url)

let initialSettings = settingBuilder.build()

PlanetKitManager.shared.initialize(initialSettings: initialSettings)
...
}
}

ログの設定

デバッグは、PlanetKitInitialSettingBuilderwithEnableKitLogKey(level:enable:logSize)を使用して、初期化中にロギングを有効にしてから設定する必要があります。

ロギングの有効化

ロギングを有効にするには、withEnableKitLogKey(level:enable:logSize)を呼び出す際にenable: trueを設定します。ロギングのデフォルト設定は無効になっています。

Note

PlanetKit 5.1以上のバージョンから、ファイルでのログ出力のみ可能です。

ログレベルの設定

ログレベルを設定して、デバッグ情報の出力レベルを調整できます。

ログレベルを設定するには、withEnableKitLogKey(level:enable:logSize)levelパラメーターをPlanetKitLogLevelの値のいずれかに設定してください。使用できるログレベルの設定は、次のとおりです。

  • silent:PlanetKitがデバッグ情報を出力しません。(デフォルト値)
  • simple:PlanetKitが簡単なデバッグ情報を出力します。
  • detailed:PlanetKitが詳細なデバッグ情報を出力します。
Note
  • PlanetKit 5.2以上のバージョンからログレベルが変更されました。
  • LINE Planetチームにデバッグを依頼する際には、detailedレベルで生成されたログファイルを共有してください。

ログサイズの制限設定

ログファイルの全体のサイズ制限を設定するには、withEnableKitLogKey(level:enable:logSize)logSizeパラメーターをPlanetKitLogSizeLimitの値のいずれかに設定します。使用できるログサイズの制限設定は、次のとおりです。

  • small:ログファイルの全体のサイズ制限は、16MBです。
  • medium:ログファイルの全体のサイズ制限は、64MBです。
  • large:ログファイルの全体のサイズ制限は、256MBです。(デフォルト値)
  • unlimited:ログファイルの全体のサイズに制限はありません。

関連サンプルコード

関連ドキュメント