Classes

The following classes are available globally.

  • コマンドスキームを処理するためのクラスです。

    SDK内部で利用するクラスであり、通常のSDK利用でこちらのクラスを利用することはありません。

    See more

    Declaration

    Swift

    @objc(KRTCommandHandler)
public class CommandHandler : NSObject
    extension CommandHandler: Library
    extension CommandHandler: DeepLinkModule

  • SDKの設定を保持するクラスです。

    See more

    Declaration

    Swift

    @objc(KRTConfiguration)
@objcMembers
public class Configuration : NSObject, NSCopying, Codable

  • SDKの実験的な設定を保持するクラスです。

    See more

    Declaration

    Swift

    @objc(KRTExperimentalConfiguration)
@objcMembers
public class ExperimentalConfiguration : Configuration

  • deep link イベントを処理するためのクラスです。

    SDK内部で利用するクラスであり、通常のSDK利用でこちらのクラスを利用することはありません。

    See more

    Declaration

    Swift

    @objc(KRTDeepLinkEvent)
public class DeepLinkEvent : NSObject
    extension DeepLinkEvent: Library
    extension DeepLinkEvent: DeepLinkModule

  • WebView 連携するためのクラスです。

    Webページを開くWebViewに連携用のスクリプトを設定することで、WebとAppのユーザーの紐付けが行われます。
    なお連携を行うためにはWebページに、KARTEのタグが埋め込まれている必要があります。

    See more

    Declaration

    Swift

    @objc(KRTUserSync)
public class UserSync : NSObject, Codable

  • KARTE SDKのエントリポイントであると共に、SDKの構成および依存ライブラリ等の管理を行うクラスです。

    SDKを利用するには、KarteApp.setup(appKey:) を呼び出し初期化を行う必要があります。
    初期化が行われていない状態では、イベントのトラッキングを始め、SDKの機能が利用できません。
    なおアプリ内メッセージ等のサブモジュールについても同様です。

    SDKの設定については、初期化時に一部変更することが可能です。 設定を変更して初期化を行う場合は、KarteApp.setup(appKey:configuration:)を呼び出してください。

    See more

    Declaration

    Swift

    @objc(KRTApp)
public class KarteApp : NSObject

  • イベントトラッキングを行うためのクラスです。

    送信するイベントの種類に応じて、複数のメソッドが用意されております。

    track

    任意の名前のイベントを送る場合に利用します。

    identify

    ユーザーに関する情報（ユーザーIDや名前、メールアドレス等）を送る場合に利用します。

    view

    画面表示に関する情報を送る場合に利用します。
    通常は viewDidAppear: 等で呼び出します。

    なおViewイベントに関しては、イベントの送信だけではなくアプリ上で画面遷移が発生したことを認識するためのものとしても利用されます。
    具体的には、Viewイベントを発火させたタイミングで、既にアプリ内メッセージが表示されている場合は、自動でアプリ内メッセージを非表示にします。
    また ネイティブアプリにおける接客表示制限 オプションを有効にした場合にも、ここで設定した認識結果が利用されます。

    iPad OS における Split View / Slide Over 対応について

    iPad OS の Split View / Slide Over に対応するために、イニシャライザに UIView を引数として取るものがあります。
    Split View / Slide Over を有効がアプリケーションでは、UIView を引数として取るイニシャライザを利用することで適切なシーンにアプリ内メッセージを表示することが可能です。

    See more

    Declaration

    Swift

    public class Tracker : NSObject

  • イベントトラッキングを行うためのクラスです。

    送信するイベントの種類に応じて、複数のメソッドが用意されております。

    track

    任意の名前のイベントを送る場合に利用します。

    identify

    ユーザーに関する情報（ユーザーIDや名前、メールアドレス等）を送る場合に利用します。

    view

    画面表示に関する情報を送る場合に利用します。
    通常は viewDidAppear: 等で呼び出します。

    なおViewイベントに関しては、イベントの送信だけではなくアプリ上で画面遷移が発生したことを認識するためのものとしても利用されます。
    具体的には、Viewイベントを発火させたタイミングで、既にアプリ内メッセージが表示されている場合は、自動でアプリ内メッセージを非表示にします。
    また ネイティブアプリにおける接客表示制限 オプションを有効にした場合にも、ここで設定した認識結果が利用されます。

    iPad OS における Split View / Slide Over 対応について

    iPad OS の Split View / Slide Over に対応するために、イニシャライザに UIView を引数として取るものがあります。
    Split View / Slide Over を有効がアプリケーションでは、UIView を引数として取るイニシャライザを利用することで適切なシーンにアプリ内メッセージを表示することが可能です。

    See more

    Declaration

    Swift

    @objc(KRTTracker)
public class TrackerObjectiveC : NSObject