Show / Hide Table of Contents

Class Variable

Variableクラスは、設定値配信に関連する機能で、設定値と配信元の接客サービスの情報を保持する機能を提供します。

Variablesクラスを経由して初期化されるため、個別で初期化して使用することはありません。

Inheritance
System.Object
Variable
Namespace: Io.Karte
Syntax
public class Variable

Methods

GetBool(Boolean)

設定値を真偽値として返します。

Declaration
public bool GetBool(bool defaultValue)
Parameters
Type Name Description
System.Boolean defaultValue

設定値が未設定の場合に利用する値

Returns
Type Description
System.Boolean

設定値を真偽値として返します。

なお以下の場合は、デフォルト値を返します。

  • 接客サービス側で設定値が未設定

GetDouble(Double)

設定値を浮動小数点数として返します。

Declaration
public double GetDouble(double defaultValue)
Parameters
Type Name Description
System.Double defaultValue

設定値が未設定の場合に利用する値

Returns
Type Description
System.Double

設定値を浮動小数点値として返します。

なお以下の場合は、デフォルト値を返します。

  • 接客サービス側で設定値が未設定
  • 設定値が数値として扱えない

GetInt(Int32)

設定値を整数値として返します。

Declaration
public int GetInt(int defaultValue)
Parameters
Type Name Description
System.Int32 defaultValue

設定値が未設定の場合に利用する値

Returns
Type Description
System.Int32

設定値を整数値として返します。

値が浮動小数点数の場合、浮動小数点以下は切り捨てられます。

なお以下の場合は、デフォルト値を返します。

  • 接客サービス側で設定値が未設定
  • 設定値が数値として扱えない

GetJsonArray(Object[])

設定値をobjectの配列として返します。

Declaration
public object[] GetJsonArray(object[] defaultValue)
Parameters
Type Name Description
System.Object[] defaultValue

設定値が未設定の場合に利用する値

Returns
Type Description
System.Object[]

設定値をobjectの配列として返します。

なお以下の場合は、デフォルト値を返します。

  • 接客サービス側で設定値が未設定
  • 設定値がobjectの配列として扱えない

GetJsonObject(JObject)

設定値をJObject値として返します。

Declaration
public JObject GetJsonObject(JObject defaultValue)
Parameters
Type Name Description
JObject defaultValue
Returns
Type Description
JObject

設定値をJObject値として返します。

なお以下の場合は、デフォルト値を返します。

  • 接客サービス側で設定値が未設定
  • 設定値がJObject値として扱えない

GetString(String)

設定値を文字列値として返します。

Declaration
public string GetString(string defaultValue)
Parameters
Type Name Description
System.String defaultValue

設定値が未設定の場合に利用する値

Returns
Type Description
System.String

設定値を文字列値として返します。

接客サービス側で設定値が未設定の場合は、引数として指定したデフォルト値を返します。

In This Article
Back to top Generated by DocFX