View on GitHub
Install in Dash
Configuration Class Reference
Configuration
@objc(KRTConfiguration)
@objcMembers
public class Configuration : NSObject, NSCopying, CodableSDKの設定を保持するクラスです。
-
プロジェクト直下の Karte-Info.plist をロードしてデフォルト値で初期化された設定インスタンスを返します。 Karte-Info.plist が存在しない場合は nil が返ります。
Declaration
Swift
public class var `default`: Configuration? { get } -
デフォルト値で初期化された設定インスタンスを返します。
Declaration
Swift
public class var defaultConfiguration: Configuration { get } -
アプリケーションキーの取得・設定を行います。
設定ファイルから自動でロードされるアプリケーションキー以外を利用したい場合にのみ設定します。
Declaration
Swift
public var appKey: String { get set } -
APIキーの取得・設定を行います。
設定ファイルから自動でロードされるAPIキー以外を利用したい場合にのみ設定します。
Declaration
Swift
public var apiKey: String { get set } -
ベースURLの取得・設定を行います。
SDK内部で利用するプロパティであり、通常のSDK利用でこちらのプロパティを利用することはありません。
Declaration
Swift
public var baseURL: URL -
KARTEプロジェクトのデータロケーションの取得・設定を行います。
SDK内部で利用するプロパティであり、通常のSDK利用でこちらのプロパティを利用することはありません。
Declaration
Swift
public var dataLocation: String -
overlayベースURLの取得・設定を行います。
SDK内部で利用するプロパティであり、通常のSDK利用でこちらのプロパティを利用することはありません。
Declaration
Swift
public var overlayBaseURL: URL -
ドライランの利用有無の取得・設定を行います。
ドライランを有効にした場合、Tracker.track(...)等のメソッドを呼び出してもイベントの送信が行われなくなります。trueの場合はドライランが有効となり、falseの場合は無効となります。
デフォルトはfalseです。Declaration
Swift
public var isDryRun: Bool -
オプトアウトの利用有無の取得・設定を行います。
なお本設定を有効とした場合であっても、明示的に
KarteApp.optIn()を呼び出した場合はオプトイン状態で動作します。
本設定はあくまでも、オプトインまたはオプトアウトの表明を行っていない状態での動作設定を決めるものになります。trueの場合はデフォルトでオプトアウトが有効となり、falseの場合は無効となります。
デフォルトはfalseです。Declaration
Swift
public var isOptOut: Bool -
ライブラリの設定の取得・設定を行います。
Declaration
Swift
public var libraryConfigurations: [LibraryConfiguration] -
IDFA取得用の委譲先インスタンスの取得・設定を行います。
インスタンスが未設定の場合は、IDFAの情報はイベントに付与されません。Declaration
Swift
public weak var idfaDelegate: IDFADelegate? -
SDK設定インスタンスを初期化します。
Declaration
Swift
override public init() -
SDK設定インスタンスを初期化します。
Declaration
Swift
public init(appKey: String)Parameters
appKeyアプリケーションキー
-
SDK設定インスタンスを初期化します。
Declaration
Swift
public convenience init(configurator: (Configuration) -> Void)Parameters
configurator初期化ブロック
-
SDK設定インスタンスを初期化します。
SDK内部で利用する初期化関数であるため、通常のSDK利用においてこちらの関数を利用する必要はありません。
Declaration
Swift
public required init(from decoder: Decoder) throwsParameters
decoderデコーダー
-
SDK設定インスタンスを plist ファイルからロードします。
指定したパスに有効な plist ファイルが存在しない場合は nil を返します。
Declaration
Swift
public class func from(plistPath: String) -> Configuration?Parameters
plistPathplistのファイルパス
-
SDK設定インスタンスを初期化します。
Declaration
Swift
public class func config(configurator: (Configuration) -> Void) -> ConfigurationParameters
configurator初期化ブロック
-
インスタンスをコピーします。
Declaration
Swift
public func copy(with zone: NSZone? = nil) -> AnyParameters
zoneNSZone