Class Variables
Variablesクラスは、設定値配信に関連するクラスで、以下の機能を提供します。
- 設定値の取得
- 設定値の保持・管理
- 効果測定用のイベントの送信
なおVariablesクラスを利用するためには、事前にSDKの初期化が必要です。
初期化が行われていない場合、例外が発生する可能性があります。
Inheritance
Namespace: Io.Karte
Syntax
public class VariablesMethods
Fetch()
設定値を取得します。
取得は非同期で行われるため、設定値の取得完了をトリガーに処理を行いたい場合は、FetchWithCompletionを利用してください。
※事前にトラッカーの初期化が必要です。
初期化時に指定したアプリケーションキーに対応するSDKの初期化が行われていない場合は、例外が発生します。
Declaration
public static void Fetch()FetchWithCompletion(Action<Boolean>)
設定値を取得します。
設定値の取得が完了したタイミングで、引数に指定したクロージャにコールバックされます。
Variables.FetchWithCompletion ((result) => {
string str = result ? "取得成功" : "取得失敗";
});Declaration
public static void FetchWithCompletion(Action<bool> callback)Parameters
| Type | Name | Description |
|---|---|---|
| Action<System.Boolean> | callback | 取得完了通知クロージャ |
GetVariable(String)
キーに紐付くVariableオブジェクトを返します。
接客サービス側で設定値を設定していない場合であってもオブジェクトは返ります。
設定値の設定有無はVariableクラスの isDefinedプロパティを使って判定します。
Declaration
public static Variable GetVariable(string key)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | key | 設定値キー |
Returns
| Type | Description |
|---|---|
| Variable | Variableオブジェクトを返します。 |
HasSuccessfulLastFetchIn(Int32)
直近指定秒以内に成功したフェッチ結果があるかどうかを返します。
この機能はiOSのみで提供されています。
Androidでは常にfalseを返します。
Declaration
public static bool HasSuccessfulLastFetchIn(int seconds)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | seconds |
Returns
| Type | Description |
|---|---|
| System.Boolean |
LastFetchStatus()
最終フェッチ完了ステータスを返します。
この機能はiOSのみで提供されています。
Androidでは常に0を返します。
Declaration
public static int LastFetchStatus()Returns
| Type | Description |
|---|---|
| System.Int32 |
LastFetchTime()
最終フェッチ完了時間を返します。
未フェッチな場合は nil を返します。
この機能はiOSのみで提供されています。
Androidでは常にnullを返します。
Declaration
public static DateTime? LastFetchTime()Returns
| Type | Description |
|---|---|
| System.Nullable<DateTime> |
TrackClick(Variable[])
指定された設定値に関連するキャンペーン情報を元に効果測定用のイベント（message_click）を発火します。
Declaration
public static void TrackClick(Variable[] vars)Parameters
| Type | Name | Description |
|---|---|---|
| Variable[] | vars | 設定値の配列 |
TrackClick(Variable[], JObject)
指定された設定値に関連するキャンペーン情報を元に効果測定用のイベント（message_click）を発火します。
Declaration
public static void TrackClick(Variable[] vars, JObject values)Parameters
| Type | Name | Description |
|---|---|---|
| Variable[] | vars | 設定値の配列 |
| JObject | values | イベントに紐付けるカスタムオブジェクト |
TrackOpen(Variable[])
指定された設定値に関連するキャンペーン情報を元に効果測定用のイベント（message_open）を発火します。
Declaration
public static void TrackOpen(Variable[] vars)Parameters
| Type | Name | Description |
|---|---|---|
| Variable[] | vars | 設定値の配列 |
TrackOpen(Variable[], JObject)
指定された設定値に関連するキャンペーン情報を元に効果測定用のイベント（message_open）を発火します。
Declaration
public static void TrackOpen(Variable[] vars, JObject values)Parameters
| Type | Name | Description |
|---|---|---|
| Variable[] | vars | 設定値の配列 |
| JObject | values | イベントに紐付けるカスタムオブジェクト |