KiiCloudStorageSDK : KiiCorp.Cloud.ABTesting Namespace

KiiExperiment Class

Represents Experiments.

Syntax

public class KiiExperiment

Remarks

Requirements

Namespace: KiiCorp.Cloud.ABTesting
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

Members

See Also: Inherited members from object.

Public Properties

[read-only]
ChosenVariation Variation . Gets chosen variation if the experiment has finished with specified variation.
[read-only]
ConversionEvents ConversionEvent[]. Gets conversion events
[read-only]
Description string . Gets the description of the experiment.
[read-only]
ID string . Gets the ID of the Experiment.
[read-only]
Status KiiExperimentStatus . Gets the status of the experiment.
[read-only]
Variations Variation[]. Gets the variations associated with this experiment
[read-only]
Version int . Gets the version of the Experiment.

Public Methods

GetAppliedVariation (Variation) : Variation
Get the variation applied to this trial. Variation will be determined by specified rate of each variation in this experiment. Current login user information will be used for sampling. If the experiment has terminated with specified variant, the specified variant will be returned regardless of login user information. If the experiment has finished without specified variant, fallback will be returned. If the status of experiment is draft or paused, fallback will be returned.
GetAppliedVariation (Variation, VariationSampler) : Variation
Get the variation applied to this trial. Sampler should return the variation according to the rate defined in this experiment. If you use KiiCorp.Cloud.ABTesting.VariationSamplerByKiiUser with current login user, It will be same as KiiExperiment.GetAppliedVariation(Variation)
static
GetByID (string) : KiiExperiment
Get the experiment which has the specified id.
static
GetByID (string, KiiExperimentCallback)
Get the experiment having the specified id in background.
GetConversionEventByName (string) : ConversionEvent
Get the Conversion Event by its name.
GetVariationByName (string) : Variation
Get the variation having the specified name.

Member Details

ChosenVariation Property

Gets chosen variation if the experiment has finished with specified variation.

Syntax

public Variation ChosenVariation { get; }

Value

Variation chosen or null if when the no variation has not been chosen.

Remarks

Requirements

Namespace: KiiCorp.Cloud.ABTesting
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

ConversionEvents Property

Gets conversion events

Syntax

public ConversionEvent[] ConversionEvents { get; }

Value

Conversion events.

Remarks

Requirements

Namespace: KiiCorp.Cloud.ABTesting
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

Description Property

Gets the description of the experiment.

Syntax

public string Description { get; }

Value

The description of the experiment.

Remarks

Requirements

Namespace: KiiCorp.Cloud.ABTesting
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

GetAppliedVariation Method

Get the variation applied to this trial. Variation will be determined by specified rate of each variation in this experiment. Current login user information will be used for sampling. If the experiment has terminated with specified variant, the specified variant will be returned regardless of login user information. If the experiment has finished without specified variant, fallback will be returned. If the status of experiment is draft or paused, fallback will be returned.

Syntax

public Variation GetAppliedVariation (Variation fallback)

Parameters

fallback
The variation to return when failed to get the applied variation. If you want to detect error, you need to set null.

Returns

Applied variation for this trial.

Remarks

Requirements

Namespace: KiiCorp.Cloud.ABTesting
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

GetAppliedVariation Method

Get the variation applied to this trial. Sampler should return the variation according to the rate defined in this experiment. If you use KiiCorp.Cloud.ABTesting.VariationSamplerByKiiUser with current login user, It will be same as KiiExperiment.GetAppliedVariation(Variation)

Syntax

public Variation GetAppliedVariation (Variation fallback, VariationSampler sampler)

Parameters

fallback
The variation to return when failed to get the applied variation. If you want to detect error, you need to set null.
sampler
Variation sampler.

Returns

Applied variation for this trial.

Remarks

Requirements

Namespace: KiiCorp.Cloud.ABTesting
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

GetByID Method

Get the experiment which has the specified id.

Syntax

public static KiiExperiment GetByID (string experimentID)

Parameters

experimentID
Experiment id.

Returns

Experiment which has the specified id.

Remarks

NOTE: This api access to server. Should not be executed in UI/Main thread.

Requirements

Namespace: KiiCorp.Cloud.ABTesting
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

GetByID Method

Get the experiment having the specified id in background.

Syntax

public static void GetByID (string experimentID, KiiExperimentCallback callback)

Parameters

experimentID
Experiment id.
callback
Called on completion of get experiment.

Returns

Experiment which has the specified id.

Remarks

NOTE: This api access to server. Should not be executed in UI/Main thread.

Requirements

Namespace: KiiCorp.Cloud.ABTesting
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

GetConversionEventByName Method

Get the Conversion Event by its name.

Syntax

public ConversionEvent GetConversionEventByName (string name)

Parameters

name
Name of the Conversion Event

Returns

Conversion Event or null if Experiment does not have conversion having specified name.

Remarks

Requirements

Namespace: KiiCorp.Cloud.ABTesting
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

GetVariationByName Method

Get the variation having the specified name.

Syntax

public Variation GetVariationByName (string name)

Parameters

name
Variation name.

Returns

variation that match the specified name. Returns null if the experiment has no variation with the specified name.

Remarks

Requirements

Namespace: KiiCorp.Cloud.ABTesting
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

ID Property

Gets the ID of the Experiment.

Syntax

public string ID { get; }

Value

ID of the Experiment.

Remarks

Requirements

Namespace: KiiCorp.Cloud.ABTesting
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

Status Property

Gets the status of the experiment.

Syntax

public KiiExperimentStatus Status { get; }

Value

Current status of experiment.

Remarks

Requirements

Namespace: KiiCorp.Cloud.ABTesting
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

Variations Property

Gets the variations associated with this experiment

Syntax

public Variation[] Variations { get; }

Value

An array of the variation.

Remarks

Requirements

Namespace: KiiCorp.Cloud.ABTesting
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

Version Property

Gets the version of the Experiment.

Syntax

public int Version { get; }

Value

Version of the Experiment.

Remarks

Requirements

Namespace: KiiCorp.Cloud.ABTesting
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0