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`
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

shouldRecord | `open fun shouldRecord(logger: Logger): Boolean`