Kameleoon.Client (kameleoon_client v0.9.1)

Copy Markdown

Elixir wrapper over a native Kameleoon client Rustler resource.

Summary

Types

t()

Functions

add_data(client, visitor_code, data, opts \\ [])
evaluate_audiences(client, visitor_code)
flush(client, visitor_code)
flush_instant(client, visitor_code)
get_datafile(client)
get_engine_tracking_code(client, visitor_code)
get_remote_data(client, key)
get_remote_visitor_data(client, visitor_code, opts \\ [])
get_variation(client, visitor_code, feature_key, opts \\ [])
get_variations(client, visitor_code, opts \\ [])
get_visitor_code(client, cookies, default_visitor_code \\ nil)
get_visitor_warehouse_audience(client, visitor_code, custom_data_index, opts \\ [])
initialize(client, opts \\ [])
is_feature_active?(client, visitor_code, feature_key, opts \\ [])
is_ready?(client)
on_datafile_update(client, fun) deprecated

Registers a zero-argument callback invoked whenever the data file (configuration) is updated.

set_event_handler(client, event_type, handler)

Registers a handler for an SDK event type, or clears it by passing nil.

set_forced_variation(client, visitor_code, experiment_id, variation_key \\ nil, opts \\ [])
set_legal_consent(client, visitor_code, consent, cookies \\ nil)
track_conversion(client, visitor_code, goal_id, opts \\ [])

Types

t()

@type t() :: %Kameleoon.Client{
  environment: String.t() | nil,
  events: GenServer.server(),
  native: term(),
  site_code: String.t() | nil
}

Functions

add_data(client, visitor_code, data, opts \\ [])

@spec add_data(t(), String.t(), struct() | [struct()], keyword()) ::
  :ok | {:error, Kameleoon.Error.t()}

evaluate_audiences(client, visitor_code)

@spec evaluate_audiences(t(), String.t()) :: :ok | {:error, Kameleoon.Error.t()}

flush(client, visitor_code)

@spec flush(t(), String.t()) :: :ok | {:error, Kameleoon.Error.t()}

flush_instant(client, visitor_code)

@spec flush_instant(t(), String.t()) :: :ok | {:error, Kameleoon.Error.t()}

get_datafile(client)

@spec get_datafile(t()) ::
  {:ok, Kameleoon.Types.DataFile.t()} | {:error, Kameleoon.Error.t()}

get_engine_tracking_code(client, visitor_code)

@spec get_engine_tracking_code(t(), String.t()) ::
  {:ok, String.t()} | {:error, Kameleoon.Error.t()}

get_remote_data(client, key)

@spec get_remote_data(t(), String.t()) ::
  {:ok, String.t()} | {:error, Kameleoon.Error.t()}

get_remote_visitor_data(client, visitor_code, opts \\ [])

@spec get_remote_visitor_data(t(), String.t(), keyword()) ::
  :ok | {:error, Kameleoon.Error.t()}

get_variation(client, visitor_code, feature_key, opts \\ [])

@spec get_variation(t(), String.t(), String.t(), keyword()) ::
  {:ok, Kameleoon.Types.Variation.t()} | {:error, Kameleoon.Error.t()}

get_variations(client, visitor_code, opts \\ [])

@spec get_variations(t(), String.t(), keyword()) ::
  {:ok, %{required(String.t()) => Kameleoon.Types.Variation.t()}}
  | {:error, Kameleoon.Error.t()}

get_visitor_code(client, cookies, default_visitor_code \\ nil)

@spec get_visitor_code(t(), Kameleoon.CookieAccessor.t(), String.t() | nil) ::
  {:ok, String.t(), Kameleoon.CookieAccessor.state()}
  | {:error, Kameleoon.Error.t()}

get_visitor_warehouse_audience(client, visitor_code, custom_data_index, opts \\ [])

@spec get_visitor_warehouse_audience(t(), String.t(), non_neg_integer(), keyword()) ::
  :ok | {:error, Kameleoon.Error.t()}

initialize(client, opts \\ [])

@spec initialize(
  t(),
  keyword()
) :: :ok | {:error, Kameleoon.Error.t()}

is_feature_active?(client, visitor_code, feature_key, opts \\ [])

@spec is_feature_active?(t(), String.t(), String.t(), keyword()) ::
  {:ok, boolean()} | {:error, Kameleoon.Error.t()}

is_ready?(client)

@spec is_ready?(t()) :: boolean()

on_datafile_update(client, fun)

This function is deprecated. Use set_event_handler(client, :datafile_update, handler) instead. 
@spec on_datafile_update(t(), (-> any()) | nil) :: :ok | {:error, Kameleoon.Error.t()}

Registers a zero-argument callback invoked whenever the data file (configuration) is updated.

Deprecated: use set_event_handler/3 with :datafile_update instead, which also reports the update source and the data file modification date.

set_event_handler(client, event_type, handler)

@spec set_event_handler(
  t(),
  Kameleoon.Native.Events.event_type(),
  (term() -> any()) | nil
) ::
  :ok | {:error, Kameleoon.Error.t()}

Registers a handler for an SDK event type, or clears it by passing nil.

The handler is a one-argument function which receives an event struct. At most one handler is kept per event type per client, so registering a handler replaces the previous one.

Supported event types and the events they deliver:

Handlers run in their own task, so a crashing handler is logged and never affects the SDK, and a slow handler does not delay the SDK's own work.

Kameleoon.Client.set_event_handler(client, :http_request, fn
  %HttpRequestSucceeded{request_type: type, http_status: status, duration_ms: ms} ->
    :telemetry.execute([:kameleoon, :request], %{duration_ms: ms}, %{type: type, status: status})

  %HttpRequestFailed{request_type: type, failure: failure} ->
    Logger.warning("kameleoon #{type} request failed: #{failure.reason}")
end)

set_forced_variation(client, visitor_code, experiment_id, variation_key \\ nil, opts \\ [])

@spec set_forced_variation(
  t(),
  String.t(),
  non_neg_integer(),
  String.t() | nil,
  keyword()
) ::
  :ok | {:error, Kameleoon.Error.t()}

track_conversion(client, visitor_code, goal_id, opts \\ [])

@spec track_conversion(t(), String.t(), non_neg_integer(), keyword()) ::
  :ok | {:error, Kameleoon.Error.t()}