Module ldclient_config

ldclient_config module.

Description

ldclient_config module

Acts as a storage interface for SDK client instance settings.

Data Types

instance()

instance() = #{sdk_key => string(), base_uri => string(), events_uri => string(), stream_uri => string(), feature_store => atom(), events_capacity => pos_integer(), events_flush_interval => pos_integer(), events_dispatcher => atom(), user_keys_capacity => pos_integer(), inline_users_in_events => boolean(), private_attributes => private_attributes(), stream => boolean(), polling_interval => pos_integer(), polling_update_requestor => atom(), offline => boolean(), redis_host => string(), redis_port => pos_integer(), redis_database => integer(), redis_password => string(), redis_prefix => string(), cache_ttl => integer(), use_ldd => boolean()}

private_attributes()

private_attributes() = all | [ldclient_user:attribute()]

Function Index

get_event_schema/0
get_registered_tags/0Get all registered tags.
get_user_agent/0
get_value/2Gets application environment variable value.
init/0Initialize settings environment map.
register/2Register settings for a new client instance.
unregister/1Unregister settings for a client instance.

Function Details

get_event_schema/0

get_event_schema() -> string()

get_registered_tags/0

get_registered_tags() -> [atom()]

Get all registered tags

get_user_agent/0

get_user_agent() -> string()

get_value/2

get_value(Tag::atom(), Key::atom()) -> undefined | term()

Gets application environment variable value

This is a convenience function to retrieve application environment variables in one place. Tag is the instance tag. Key is the key of the configuration option.

init/0

init() -> ok

Initialize settings environment map

Initializes an empty map for instance settings in application environment.

register/2

register(Tag::atom(), Settings::instance()) -> ok

Register settings for a new client instance

unregister/1

unregister(Tag::atom()) -> ok

Unregister settings for a client instance


Generated by EDoc