Struct Config

pub struct Config { /* private fields */ }

Implementations

impl Config

pub fn set_fiat_currency(&self, fiat_currency: String) -> Result<()>

Set the fiat currency (ISO 4217 currency code) - not all are supported The method Config::list_currencies can used to list supported codes.

Requires network: no

pub fn set_timezone_config(&self, timezone_config: TzConfig)

Set the timezone config.

Parameters:

• timezone_config - the user’s current timezone

Requires network: no

pub fn set_analytics_config(&self, config: AnalyticsConfig) -> Result<()>

Set the analytics configuration.

This can be used to completely prevent any analytics data from being reported.

Requires network: no

pub fn get_analytics_config(&self) -> Result<AnalyticsConfig>

Get the currently configured analytics configuration.

Requires network: no

pub fn register_notification_token( &self, notification_token: String, language_iso_639_1: String, country_iso_3166_1_alpha_2: String, ) -> Result<()>

Registers a new notification token. If a token has already been registered, it will be updated.

Requires network: yes

pub fn set_feature_flag( &self, feature: FeatureFlag, flag_enabled: bool, ) -> Result<()>

Set value of a feature flag. The method will report the change to the backend and update the local database.

Parameters:

• feature - feature flag to be set.
• enable - enable or disable the feature.

Requires network: yes

pub fn list_currencies(&self) -> Vec<String>

List codes of supported fiat currencies. Please keep in mind that this method doesn’t make any network calls. It simply retrieves previously fetched values that are frequently updated by a background task.

The fetched list will be persisted across restarts to alleviate the consequences of a slow or unresponsive exchange rate service. The method will return an empty list if there is nothing persisted yet and the values are not yet fetched from the service.

Requires network: no

pub fn foreground(&self)

Call the method when the app goes to foreground, such that the user can interact with it. The library starts running the background tasks more frequently to improve user experience.

Requires network: no

pub fn background(&self)

Call the method when the app goes to background, such that the user can not interact with it. The library stops running some unnecessary tasks and runs necessary tasks less frequently. It should save battery and internet traffic.

Requires network: no