android-components / org.mozilla.telemetry.ping / TelemetryPingBuilder

# TelemetryPingBuilder

`abstract class TelemetryPingBuilder` (source)

### Constructors

<init> | `TelemetryPingBuilder(configuration: TelemetryConfiguration, type: String, version: Int)`

### Functions

build | `open fun build(): TelemetryPing`
canBuild | `open fun canBuild(): Boolean`
generateDocumentId | `open fun generateDocumentId(): String`
getConfiguration | `open fun getConfiguration(): TelemetryConfiguration`
getType | `open fun getType(): String`

### Inheritors

TelemetryCorePingBuilder | `open class TelemetryCorePingBuilder : TelemetryPingBuilder` This mobile-specific ping is intended to provide the most critical data in a concise format, allowing for frequent uploads. Since this ping is used to measure retention, it should be sent each time the app is opened. https://gecko.readthedocs.io/en/latest/toolkit/components/telemetry/telemetry/data/core-ping.html
TelemetryEventPingBuilder | `open class TelemetryEventPingBuilder : TelemetryPingBuilder` A telemetry ping builder for pings of type "focus-event".
TelemetryMobileEventPingBuilder | `open class TelemetryMobileEventPingBuilder : TelemetryPingBuilder` A telemetry ping builder for events of type "mobile-event". See the schema for more details: https://github.com/mozilla-services/mozilla-pipeline-schemas/blob/master/schemas/telemetry/mobile-event/mobile-event.1.schema.json
TelemetryMobileMetricsPingBuilder | `open class TelemetryMobileMetricsPingBuilder : TelemetryPingBuilder` A telemetry ping builder for events of type "mobile-metrics". See the schema for more details: https://github.com/mozilla-services/mozilla-pipeline-schemas/blob/master/schemas/telemetry/mobile-metrics/mobile-metrics.1.schema.json