android-components / mozilla.components.service.glean.config / Configuration

Configuration

data class Configuration (source)

The Configuration class describes how to configure the Glean.

Constructors

Name	Summary
<init>	Configuration(serverEndpoint: String = DEFAULT_TELEMETRY_ENDPOINT, channel: String? = null, maxEvents: Int? = null, httpClient: PingUploader = ConceptFetchHttpUploader(lazy { HttpURLConnectionClient() })) The Configuration class describes how to configure the Glean.

Properties

Name	Summary
channel	val channel: String? the release channel the application is on, if known. This will be sent along with all the pings, in the client_info section.
httpClient	val httpClient: PingUploader The HTTP client implementation to use for uploading pings.
maxEvents	val maxEvents: Int? the number of events to store before the events ping is sent
serverEndpoint	val serverEndpoint: String the server pings are sent to. Please note that this is is only meant to be changed for tests.

Functions

Name	Summary
toWrappedConfiguration	fun toWrappedConfiguration(): Configuration Convert the Android Components configuration object to the Glean SDK configuration object.

Companion Object Properties

Name	Summary
DEFAULT_TELEMETRY_ENDPOINT	const val DEFAULT_TELEMETRY_ENDPOINT: String

Extension Functions

Name	Summary
loadResourceAsString	fun Any.loadResourceAsString(path: String): String Loads a file from the resources folder and returns its content as a string object.