Variable

@objc(KRTVariable)
public class Variable : NSObject, Codable

設定値とそれに付随する情報を保持するためのクラスです。
設定値の他に、接客サービスIDやアクションIDを保持しています。

  • キャンペーンIDを返します。
    設定値が未定義の場合は nil を返します。

    Declaration

    Swift

    @objc
    public var campaignId: String?
  • アクションIDを返します。
    設定値が未定義の場合は nil を返します。

    Declaration

    Swift

    @objc
    public var shortenId: String?
  • 設定値名を返します。

    Declaration

    Swift

    @objc
    public var name: String
  • 設定値が定義済みであるかどうか返します。
    定義済みの場合は true を、未定義の場合は false を返します。

    Declaration

    Swift

    @objc
    public var isDefined: Bool { get }
  • 設定値(文字列)を返します。
    設定値が未定義の場合は nil を返します。

    Declaration

    Swift

    @objc
    public var string: String? { get }
  • 設定値(配列)を返します。
    以下の場合において nil を返します。

    • 設定値が未定義の場合
    • 設定値(JSON文字列)のパースができない場合

    Declaration

    Swift

    @objc
    public var array: [Any]? { get }
  • 設定値(辞書)を返します。
    以下の場合において nil を返します。

    • 設定値が未定義の場合
    • 設定値(JSON文字列)のパースができない場合

    Declaration

    Swift

    @objc
    public var dictionary: [String : Any]? { get }
  • 設定値インスタンスを初期化します。

    Declaration

    Swift

    @objc
    public init(name: String)

    Parameters

    name

    設定値名

  • 設定値(文字列)を返します。
    なお設定値が未定義の場合は、デフォルト値を返します。

    Declaration

    Swift

    @objc(stringWithDefaultValue:)
    public func string(default value: String) -> String

    Parameters

    value

    デフォルト値

    Return Value

    設定値(文字列)

  • 設定値(整数)を返します。
    なお設定値が数値でない場合は、デフォルト値を返します。

    Declaration

    Swift

    @objc(integerWithDefaultValue:)
    public func integer(default value: Int) -> Int

    Parameters

    value

    デフォルト値

    Return Value

    設定値(整数)

  • 設定値(浮動小数点数)を返します。
    なお設定値が数値でない場合は、デフォルト値を返します。

    Declaration

    Swift

    @objc(doubleWithDefaultValue:)
    public func double(default value: Double) -> Double

    Parameters

    value

    デフォルト値

    Return Value

    設定値(浮動小数点数)

  • 設定値(ブール値)を返します。
    なおブール値への変換ルールについては こちら を参照してください。

    設定値が未定義の場合は、デフォルト値を返します。

    Declaration

    Swift

    @objc(boolWithDefaultValue:)
    public func bool(default value: Bool) -> Bool

    Parameters

    value

    デフォルト値

    Return Value

    設定値(ブール値)

  • 設定値(配列)を返します。
    以下の場合においてデフォルト値を返します。

    • 設定値が未定義の場合
    • 設定値(JSON文字列)のパースができない場合

    Declaration

    Swift

    @objc(arrayWithDefaultValue:)
    public func array(default value: [Any]) -> [Any]

    Parameters

    value

    デフォルト値

    Return Value

    設定値(配列)

  • 設定値(辞書)を返します。
    以下の場合においてデフォルト値を返します。

    • 設定値が未定義の場合
    • 設定値(JSON文字列)のパースができない場合

    Declaration

    Swift

    @objc(dictionaryWithDefaultValue:)
    public func dictionary(default value: [String : Any]) -> [String : Any]

    Parameters

    value

    デフォルト値

    Return Value

    設定値(辞書)