-
- All Implemented Interfaces:
-
android.app.Application.ActivityLifecycleCallbacks
public final class KarteApp extends ActivityLifecycleCallback
KARTE SDKのエントリポイントであると共に、SDKの構成および依存ライブラリ等の管理を行うクラスです。
SDKを利用するには、KarteApp.setupを呼び出し初期化を行う必要があります。
初期化が行われていない状態では、イベントのトラッキングを始め、SDKの機能が利用できません。
なおアプリ内メッセージ等のサブモジュールについても同様です。
SDKの設定については、初期化時に一部変更することが可能です。 設定を変更して初期化を行う場合は、Configを指定してKarteApp.setupを呼び出してください。
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public classKarteApp.Companion
-
Field Summary
Fields Modifier and Type Field Description private Applicationapplicationprivate final StringappKeyprivate Configconfigprivate AppInfoappInfoprivate final StringoriginalPvIdprivate final StringpvId
-
Method Summary
Modifier and Type Method Description final <R extends LibraryConfig> RlibraryConfig(Class<R> clazz)指定したクラスのライブラリ設定を返します。 該当クラスが存在しない場合、
nullを返します。該当クラスが複数存在する場合、最初の設定のみを返します。
final Unitregister(Module module)モジュールを登録します。 final Unitunregister(Module module)モジュールの登録を解除します。 final Repositoryrepository(String namespace)永続化等に使用する Repository インスタンスを返します。 final UnitoptOutTemporarily()一時的(アプリの次回起動時まで)にオプトアウトします。なお初期化が行われていない状態で呼び出した場合はオプトアウトは行われません。 final List<Object>executeCommand(Uri uri, Boolean isDelay)コマンドスキームを処理し、結果を返します。SDK内部で利用するクラスであり、通常のSDK利用でこちらのクラスを利用することはありません。 UnitonActivityCreated(Activity activity, Bundle savedInstanceState)UnitonActivityStarted(Activity activity)UnitonActivityResumed(Activity activity)UnitonActivityPaused(Activity activity)UnitonActivityStopped(Activity activity)final ApplicationgetApplication()KarteApp.setup 呼び出し時に指定したApplicationインスタンスを返します。 final StringgetAppKey()final ConfiggetConfig()KarteApp.setup 呼び出し時に指定した設定情報を返します。初期化が行われていない場合はデフォルトの設定情報を返します。 final AppInfogetAppInfo()アプリケーション情報を返します。 final StringgetOriginalPvId()現在のオリジナルページビューIDを返します。 final StringgetPvId()final UnitsetApplication(Application application)final UnitsetConfig(Config config)final UnitsetAppInfo(AppInfo appInfo)-
Methods inherited from class io.karte.android.KarteApp
onActivityDestroyed, onActivitySaveInstanceState -
Methods inherited from class android.app.Application.ActivityLifecycleCallbacks
equals, hashCode, toString -
Methods inherited from class io.karte.android.utilities.ActivityLifecycleCallback
onActivityPostCreated, onActivityPostDestroyed, onActivityPostPaused, onActivityPostResumed, onActivityPostSaveInstanceState, onActivityPostStarted, onActivityPostStopped, onActivityPreCreated, onActivityPreDestroyed, onActivityPrePaused, onActivityPreResumed, onActivityPreSaveInstanceState, onActivityPreStarted, onActivityPreStopped -
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
Method Detail
-
libraryConfig
final <R extends LibraryConfig> R libraryConfig(Class<R> clazz)
指定したクラスのライブラリ設定を返します。
該当クラスが存在しない場合、
nullを返します。該当クラスが複数存在する場合、最初の設定のみを返します。
- Parameters:
clazz- LibraryConfigを実装したクラス
-
unregister
final Unit unregister(Module module)
モジュールの登録を解除します。
- Parameters:
module- Moduleを実装したインスタンス
-
repository
final Repository repository(String namespace)
永続化等に使用する Repository インスタンスを返します。
- Parameters:
namespace- 永続化の領域分割をするNamespaceを指定します。
-
optOutTemporarily
final Unit optOutTemporarily()
一時的(アプリの次回起動時まで)にオプトアウトします。
なお初期化が行われていない状態で呼び出した場合はオプトアウトは行われません。
-
executeCommand
@JvmOverloads() final List<Object> executeCommand(Uri uri, Boolean isDelay)
コマンドスキームを処理し、結果を返します。
SDK内部で利用するクラスであり、通常のSDK利用でこちらのクラスを利用することはありません。
- Parameters:
uri- コマンドを表現するURIisDelay- 通知タップなど、即時に実行すべきでない場合にtrueとします。デフォルトはfalseです。
-
onActivityCreated
Unit onActivityCreated(Activity activity, Bundle savedInstanceState)
-
onActivityStarted
Unit onActivityStarted(Activity activity)
-
onActivityResumed
Unit onActivityResumed(Activity activity)
-
onActivityPaused
Unit onActivityPaused(Activity activity)
-
onActivityStopped
Unit onActivityStopped(Activity activity)
-
getApplication
final Application getApplication()
KarteApp.setup 呼び出し時に指定したApplicationインスタンスを返します。
-
getConfig
final Config getConfig()
KarteApp.setup 呼び出し時に指定した設定情報を返します。
初期化が行われていない場合はデフォルトの設定情報を返します。
-
getAppInfo
final AppInfo getAppInfo()
アプリケーション情報を返します。
-
getOriginalPvId
final String getOriginalPvId()
現在のオリジナルページビューIDを返します。
-
setApplication
final Unit setApplication(Application application)
-
setAppInfo
final Unit setAppInfo(AppInfo appInfo)
-
-
-