Package 

Object KarteApp.Companion

    • Method Summary

      Modifier and Type Method Description
      final Unit setup(Context context, String appKey, Config config) SDKの初期化を行います。初期化オプションが未指定の場合は、デフォルト設定で初期化が行われます。 初期化オプションのデフォルト値については Configuration クラスを参照してください。なお初期化後に初期化オプションを変更した場合、その変更はSDKには反映されません。また既に初期化されている状態で呼び出した場合は何もしません。
      final Unit setup(Context context, Config config) SDKの初期化を行います。初期化オプションが未指定の場合は、デフォルト設定で初期化が行われます。 初期化オプションのデフォルト値については Configuration クラスを参照してください。なお初期化後に初期化オプションを変更した場合、その変更はSDKには反映されません。また既に初期化されている状態で呼び出した場合は何もしません。
      final Unit setLogLevel(LogLevel level) ログレベルを設定します。なおデフォルトのログレベルは LogLevel.WARN です。
      final Unit register(Library library) ライブラリを登録します。なお登録処理は KarteApp.setup(appKey:) を呼び出す前に行う必要があります。
      final Unit unregister(Library library) ライブラリの登録を解除します。
      final Unit optIn() オプトインします。なお初期化が行われていない状態で呼び出した場合はオプトインは行われません。
      final Unit optOut() オプトアウトします。なお初期化が行われていない状態で呼び出した場合はオプトアウトは行われません。
      final Unit renewVisitorId() ビジターIDを再生成します。ビジターIDの再生成は、現在のユーザーとは異なるユーザーとして計測したい場合などに行います。 例えば、アプリケーションでログアウトした際などがこれに該当します。なお初期化が行われていない状態で呼び出した場合は再生成は行われません。
      final Unit onNewIntent(Intent intent) 渡されたintentを使用してKARTEのDeeplink処理を行います。launchModeにsingleTopなどを利用していて、Activity.onNewIntentにて渡される新しいintentで、KARTEのdeeplink処理を行いたい場合に呼び出してください。
      final Boolean openUrl(Uri uri, Context context) URLを開きます。 SDK内部で利用するために用意している機能であり、通常利用で使用することはありません。
      final Boolean getIsOptOut()
      final String getVisitorId()

      • Methods inherited from class io.karte.android.KarteApp.Companion

        equals, hashCode, toString

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • setup

        @JvmOverloads() final Unit setup(Context context, String appKey, Config config)

        SDKの初期化を行います。

        初期化オプションが未指定の場合は、デフォルト設定で初期化が行われます。 初期化オプションのデフォルト値については Configuration クラスを参照してください。

        なお初期化後に初期化オプションを変更した場合、その変更はSDKには反映されません。

        また既に初期化されている状態で呼び出した場合は何もしません。

        Parameters:
        context - Context
        appKey - アプリケーションキー
        config - 設定

      • setup

        @JvmOverloads() final Unit setup(Context context, Config config)

        SDKの初期化を行います。

        初期化オプションが未指定の場合は、デフォルト設定で初期化が行われます。 初期化オプションのデフォルト値については Configuration クラスを参照してください。

        なお初期化後に初期化オプションを変更した場合、その変更はSDKには反映されません。

        また既に初期化されている状態で呼び出した場合は何もしません。

        Parameters:
        context - Context
        config - 設定

      • setLogLevel

         final Unit setLogLevel(LogLevel level)

        ログレベルを設定します。

        なおデフォルトのログレベルは LogLevel.WARN です。

        Parameters:
        level - ログレベル

      • register

         final Unit register(Library library)

        ライブラリを登録します。

        なお登録処理は KarteApp.setup(appKey:) を呼び出す前に行う必要があります。

        Parameters:
        library - Library を実装したインスタンス

      • unregister

         final Unit unregister(Library library)

        ライブラリの登録を解除します。

        Parameters:
        library - Library を実装したインスタンス

      • optIn

         final Unit optIn()

        オプトインします。

        なお初期化が行われていない状態で呼び出した場合はオプトインは行われません。

      • optOut

         final Unit optOut()

        オプトアウトします。

        なお初期化が行われていない状態で呼び出した場合はオプトアウトは行われません。

      • renewVisitorId

         final Unit renewVisitorId()

        ビジターIDを再生成します。

        ビジターIDの再生成は、現在のユーザーとは異なるユーザーとして計測したい場合などに行います。 例えば、アプリケーションでログアウトした際などがこれに該当します。

        なお初期化が行われていない状態で呼び出した場合は再生成は行われません。

      • onNewIntent

         final Unit onNewIntent(Intent intent)

        渡されたintentを使用してKARTEのDeeplink処理を行います。

        launchModeにsingleTopなどを利用していて、Activity.onNewIntentにて渡される新しいintentで、KARTEのdeeplink処理を行いたい場合に呼び出してください。

        Parameters:
        intent - Activity.onNewIntent等で新しく渡されたIntent

      • openUrl

         final Boolean openUrl(Uri uri, Context context)

        URLを開きます。 SDK内部で利用するために用意している機能であり、通常利用で使用することはありません。

        Parameters:
        uri - 対象のURI
        context - Context