realm::App::configuration Struct Reference

#include <app.hpp>

Public Attributes
std::string	app_id
	The App ID for your Atlas Device Sync Application.
std::optional< std::string >	base_url
	A custom base URL to request against. If not set or set to nil, the default base url for app services will be returned.
std::optional< std::string >	path
	Custom location for Realm files.
std::optional< std::map< std::string, std::string > >	custom_http_headers
std::optional< std::array< char, 64 > >	metadata_encryption_key
	Custom encryption key for the metadata Realm.
bool	enable_caching = true
	Caches an App and its configuration for a given App ID. On by default.
std::optional< sync_config::proxy_config >	proxy_configuration
std::shared_ptr< networking::http_transport_client >	http_transport_client
std::shared_ptr< networking::sync_socket_provider >	sync_socket_provider

Detailed Description

Properties representing the configuration of a client that communicate with a particular Realm application.

App::configuration options cannot be modified once the App using it is created. App's configuration values are cached when the App is created so any modifications after it will not have any effect.

Member Data Documentation

http_transport_client

std::shared_ptr<networking::http_transport_client> realm::App::configuration::http_transport_client

Optionally provide a custom HTTP transport for network calls to the server.

Alternatively use realm::networking::set_http_client_factory to globally set the default HTTP transport client.

sync_socket_provider

std::shared_ptr<networking::sync_socket_provider> realm::App::configuration::sync_socket_provider

Optionally provide a custom WebSocket interface for sync.

---

The documentation for this struct was generated from the following file:

• include/cpprealm/app.hpp