UserSync

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

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

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

  • 指定されたURL文字列にWebView連携用のクエリパラメータを付与します。

    Declaration

    Swift

    @available(*, deprecated, message: "User sync function using query parameters is deprecated. It will be removed in the future. Use setUserSyncSript.")
@objc(appendingQueryParameterWithURLString:)
public static func appendingQueryParameter(_ urlString: String) -> String

    Parameters

    urlString

    連携するページのURL文字列

    Return Value

    連携用のクエリパラメータを付与したURL文字列を返します。指定されたURL文字列の形式が正しくない場合、またはSDKの初期化が行われていない場合は、引数に指定したURL文字列を返します。

  • 指定されたURLにWebView連携用のクエリパラメータを付与します。

    Declaration

    Swift

    @available(*, deprecated, message: "User sync function using query parameters is deprecated. It will be removed in the future. Use setUserSyncSript.")
@objc(appendingQueryParameterWithURL:)
public static func appendingQueryParameter(_ url: URL) -> URL

    Parameters

    url

    連携するページのURL

    Return Value

    連携用のクエリパラメータを付与したURLを返します。SDKの初期化が行われていない場合は、引数に指定したURLを返します。

  • WKWebViewに連携用のスクリプトを設定します。
    スクリプトはユーザースクリプトとして設定されます。

    なおSDKの初期化が行われていない場合は設定されません。

    Declaration

    Swift

    @objc(setUserSyncScriptWithWebView:)
public static func setUserSyncScript(_ webView: WKWebView)

    Parameters

    webView

    WKWebView

  • WebViewに連携するためのスクリプトを生成します。
    スクリプトをユーザースクリプトとしてWebViewに設定することで連携できます。

    なおSDKの初期化が行われていない場合はnilが返却されます。

    Declaration

    Swift

    @objc(getUserSyncScript)
public static func getUserSyncScript() -> String?

    Return Value

    生成したスクリプト文字列を返します。SDKの初期化が行われていない場合は nil を返します。