android-components / mozilla.components.service.glean / StringMetricType

# StringMetricType

`data class StringMetricType : CommonMetricData` (source)

This implements the developer facing API for recording string metrics.

Instances of this class type are automatically generated by the parsers at build time, allowing developers to record values that were previously registered in the metrics.yaml file.

The string API only exposes the set method, which takes care of validating the input data and making sure that limits are enforced.

### Constructors

<init> | `StringMetricType(disabled: Boolean, category: String, lifetime: Lifetime, name: String, sendInPings: List<String>)` This implements the developer facing API for recording string metrics.

### Properties

category | `val category: String`
defaultStorageDestinations | `val defaultStorageDestinations: List<String>` Defines the names of the storages the metric defaults to when "default" is used as the destination storage. Note that every metric type will need to override this.
disabled | `val disabled: Boolean`
lifetime | `val lifetime: Lifetime`
name | `val name: String`
sendInPings | `val sendInPings: List<String>`

### Functions

set | `fun set(value: String): Unit` Set a string value.

### Inherited Functions

getStorageNames | `open fun getStorageNames(): List<String>` Get the list of storage names the metric will record to. This automatically expands DEFAULT_STORAGE_NAME to the list of default storages for the metric.
shouldRecord | `open fun shouldRecord(logger: Logger): Boolean`