IRtoasterCore

public protocol IRtoasterCore : ComponentBase

Undocumented

  • セットアップはされているか
    セットアップされている場合は true, それ以外は false

    Declaration

    Swift

    var isSetup: Bool { get }
  • オプトインされているか

    Throws

    RtoasterNotInitialized Rtoasterが初期化されていない場合にスローされる

    Declaration

    Swift

    var isOptedIn: Bool { get throws }
  • ユーザーID

    Throws

    RtoasterNotInitialized Rtoasterが初期化されていない場合にスローされる

    Declaration

    Swift

    var userId: String { get throws }
  • 非会員時のユーザーID

    Throws

    RtoasterNotInitialized Rtoasterが初期化されていない場合にスローされる

    Declaration

    Swift

    var defaultUserId: String { get throws }
  • トラッキング時にRtoasterに送信するユーザーID

    Throws

    RtoasterNotInitialized Rtoasterが初期化されていない場合にスローされる

    Declaration

    Swift

    var trackingUserId: String { get throws }
  • RtoasterCoreのセットアップを行う

    Throws

    RtoasterIlligalParameterError

    Declaration

    Swift

    func setup(_ parameter: RtoasterSetupParameter) throws

    Parameters

    parameter

    セットアップ用のパラメータ

  • Rtoaster Proxyの接続先の設定を行う

    Throws

    RtoasterNotInitialized Rtoasterが初期化されていない場合にスローされる

    Declaration

    Swift

    func setProxyBaseUrl(_ url: String) throws

    Parameters

    url

    接続先のURL

  • オプトインに設定する

    Throws

    RtoasterNotInitialized Rtoasterが初期化されていない場合にスローされる

    Declaration

    Swift

    func optIn() throws -> ITracker

    Return Value

    オプトイン用のトラッキングタスク

  • オプトアプトに設定する

    Throws

    RtoasterNotInitialized Rtoasterが初期化されていない場合にスローされる

    Declaration

    Swift

    func optOut() throws -> ITracker

    Return Value

    オプトアウト用のトラッキングタスク

  • ユーザーIDを設定する

    Throws

    RtoasterNotInitialized Rtoasterが初期化されていない場合にスローされる

    Declaration

    Swift

    func setUserId(userId: String, takeover: Bool) throws

    Parameters

    userId

    ユーザーID

    takeover

    これまでのユーザーIDの行動履歴を引き継ぐ場合は true を設定する

  • デバッグ用 ユーザーIDを設定する

    Throws

    RtoasterNotInitialized Rtoasterが初期化されていない場合にスローされる

    Declaration

    Swift

    func resetUserId() throws
  • トラッキングを行う

    Throws

    RtoasterNotInitialized Rtoasterが初期化されていない場合にスローされる

    Declaration

    Swift

    @discardableResult
    func track(parameter: TrackingParameter) throws -> ITracker

    Parameters

    parameter

    トラッキングのためのパラメータ

  • イベントトラッキングを行う

    Throws

    RtoasterNotInitialized Rtoasterが初期化されていない場合にスローされる

    Declaration

    Swift

    @discardableResult
    func event(parameter: TrackingParameter) throws -> ITracker

    Parameters

    parameter

    イベントトラッキングのためのパラメータ

  • レコメンドの要求を行う

    Throws

    RtoasterNotInitialized Rtoasterが初期化されていない場合にスローされる

    Declaration

    Swift

    @discardableResult
    func recommend(parameter: RecommendationParameter) throws -> IRecommender

    Parameters

    parameter

    レコメンド要求のためのパラメータ