From 38383b343e4b8cd2b6714b3f7f7909a641a06ccf Mon Sep 17 00:00:00 2001 From: MickeyMoz Date: Wed, 14 Aug 2019 13:55:01 +0000 Subject: [PATCH] Update docs (20190814-135500) --- docs/api/alltypes/index.md | 8 +-- docs/api/index.md | 1 + .../-device-capability/-s-e-n-d_-t-a-b.md | 2 +- .../-device-capability/index.md | 2 +- .../-device-push-subscription/auth-key.md | 2 +- .../-device-push-subscription/endpoint.md | 2 +- .../-device-push-subscription/index.md | 2 +- .../-device-push-subscription/public-key.md | 2 +- .../-device-type/-t-a-b-l-e-t.md | 5 ++ .../-device-type/-t-v.md | 5 ++ .../-device-type/-u-n-k-n-o-w-n.md | 2 +- .../-device-type/-v-r.md | 5 ++ .../-device-type/index.md | 3 ++ .../-device/capabilities.md | 2 +- .../-device/device-type.md | 2 +- .../-device/display-name.md | 2 +- .../-device/id.md | 2 +- .../-device/index.md | 2 +- .../-device/is-current-device.md | 2 +- .../-device/last-access-time.md | 2 +- .../-device/subscription-expired.md | 2 +- .../-device/subscription.md | 2 +- .../begin-o-auth-flow-async.md | 2 +- .../-o-auth-account/index.md | 2 +- .../begin-o-auth-flow-async.md | 4 +- .../begin-pairing-flow-async.md | 2 +- .../check-authorization-status-async.md | 2 +- .../complete-o-auth-flow-async.md | 2 +- .../-firefox-account/device-constellation.md | 2 +- .../-firefox-account/disconnect-async.md | 2 +- .../-firefox-account/from-j-s-o-n-string.md | 2 +- .../get-access-token-async.md | 2 +- .../get-connection-success-u-r-l.md | 2 +- .../-firefox-account/get-profile-async.md | 4 +- .../get-token-server-endpoint-u-r-l.md | 2 +- .../-firefox-account/index.md | 2 +- .../migrate-from-session-token-async.md | 2 +- .../-firefox-account/to-j-s-o-n-string.md | 2 +- .../mozilla.components.service.fxa/into.md | 12 ++--- .../into.md | 2 +- .../into.md | 2 +- .../into.md | 2 +- .../into.md | 2 +- .../into.md | 2 +- .../-functional-histogram/-init-.md | 24 +++++++++ .../buckets-per-magnitude.md | 5 ++ .../-functional-histogram}/count.md | 4 +- .../-functional-histogram/index.md | 40 +++++++++++++++ .../-functional-histogram/log-base.md | 5 ++ .../-functional-histogram}/sum.md | 6 +-- .../-functional-histogram}/values.md | 4 +- .../-precomputed-histogram/-init-.md | 23 +++++++++ .../-precomputed-histogram}/bucket-count.md | 4 +- .../-precomputed-histogram}/count.md | 4 +- .../-precomputed-histogram}/histogram-type.md | 4 +- .../-precomputed-histogram/index.md | 41 +++++++++++++++ .../-precomputed-histogram}/range-max.md | 4 +- .../-precomputed-histogram}/range-min.md | 4 +- .../-precomputed-histogram}/sum.md | 4 +- .../-precomputed-histogram}/values.md | 4 +- .../index.md | 10 ++++ .../-common-metric-data/index.md | 5 +- .../accumulate-samples.md | 2 +- .../-custom-distribution-metric-type/index.md | 4 +- .../test-get-value.md | 2 +- .../accumulate-samples.md | 4 +- .../index.md | 11 ++-- .../-init-.md | 14 +++++ .../accumulate-samples.md | 16 ++++++ .../accumulate.md | 11 ++++ .../category.md | 8 +++ .../disabled.md | 8 +++ .../-memory-distribution-metric-type/index.md | 51 +++++++++++++++++++ .../lifetime.md | 8 +++ .../memory-unit.md | 5 ++ .../-memory-distribution-metric-type}/name.md | 6 +-- .../send-in-pings.md | 8 +++ .../test-get-value.md | 22 ++++++++ .../test-has-value.md | 19 +++++++ .../-memory-unit/-byte.md | 5 ++ .../-memory-unit/-gigabyte.md | 5 ++ .../-memory-unit/-kilobyte.md | 5 ++ .../-memory-unit/-megabyte.md | 5 ++ .../-memory-unit/index.md | 18 +++++++ .../accumulate-samples.md | 2 +- .../-timing-distribution-metric-type/index.md | 4 +- .../test-get-value.md | 2 +- .../index.md | 8 +-- .../-custom-distribution-data/-init-.md | 27 ---------- .../-custom-distribution-data/category.md | 8 --- .../-custom-distribution-data/index.md | 47 ----------------- .../-timing-distribution-data/-init-.md | 32 ------------ .../-timing-distribution-data/category.md | 8 --- .../-timing-distribution-data/index.md | 48 ----------------- .../-timing-distribution-data/name.md | 8 --- .../index.md | 2 - docs/api/package-list | 1 + 97 files changed, 473 insertions(+), 273 deletions(-) create mode 100644 docs/api/mozilla.components.concept.sync/-device-type/-t-a-b-l-e-t.md create mode 100644 docs/api/mozilla.components.concept.sync/-device-type/-t-v.md create mode 100644 docs/api/mozilla.components.concept.sync/-device-type/-v-r.md create mode 100644 docs/api/mozilla.components.service.glean.histogram/-functional-histogram/-init-.md create mode 100644 docs/api/mozilla.components.service.glean.histogram/-functional-histogram/buckets-per-magnitude.md rename docs/api/{mozilla.components.service.glean.storages/-timing-distribution-data => mozilla.components.service.glean.histogram/-functional-histogram}/count.md (58%) create mode 100644 docs/api/mozilla.components.service.glean.histogram/-functional-histogram/index.md create mode 100644 docs/api/mozilla.components.service.glean.histogram/-functional-histogram/log-base.md rename docs/api/{mozilla.components.service.glean.storages/-timing-distribution-data => mozilla.components.service.glean.histogram/-functional-histogram}/sum.md (51%) rename docs/api/{mozilla.components.service.glean.storages/-timing-distribution-data => mozilla.components.service.glean.histogram/-functional-histogram}/values.md (73%) create mode 100644 docs/api/mozilla.components.service.glean.histogram/-precomputed-histogram/-init-.md rename docs/api/{mozilla.components.service.glean.storages/-custom-distribution-data => mozilla.components.service.glean.histogram/-precomputed-histogram}/bucket-count.md (59%) rename docs/api/{mozilla.components.service.glean.storages/-custom-distribution-data => mozilla.components.service.glean.histogram/-precomputed-histogram}/count.md (58%) rename docs/api/{mozilla.components.service.glean.storages/-custom-distribution-data => mozilla.components.service.glean.histogram/-precomputed-histogram}/histogram-type.md (74%) create mode 100644 docs/api/mozilla.components.service.glean.histogram/-precomputed-histogram/index.md rename docs/api/{mozilla.components.service.glean.storages/-custom-distribution-data => mozilla.components.service.glean.histogram/-precomputed-histogram}/range-max.md (61%) rename docs/api/{mozilla.components.service.glean.storages/-custom-distribution-data => mozilla.components.service.glean.histogram/-precomputed-histogram}/range-min.md (61%) rename docs/api/{mozilla.components.service.glean.storages/-custom-distribution-data => mozilla.components.service.glean.histogram/-precomputed-histogram}/sum.md (64%) rename docs/api/{mozilla.components.service.glean.storages/-custom-distribution-data => mozilla.components.service.glean.histogram/-precomputed-histogram}/values.md (73%) create mode 100644 docs/api/mozilla.components.service.glean.histogram/index.md rename docs/api/mozilla.components.service.glean.private/{-histogram-base => -histogram-metric-base}/accumulate-samples.md (76%) rename docs/api/mozilla.components.service.glean.private/{-histogram-base => -histogram-metric-base}/index.md (53%) create mode 100644 docs/api/mozilla.components.service.glean.private/-memory-distribution-metric-type/-init-.md create mode 100644 docs/api/mozilla.components.service.glean.private/-memory-distribution-metric-type/accumulate-samples.md create mode 100644 docs/api/mozilla.components.service.glean.private/-memory-distribution-metric-type/accumulate.md create mode 100644 docs/api/mozilla.components.service.glean.private/-memory-distribution-metric-type/category.md create mode 100644 docs/api/mozilla.components.service.glean.private/-memory-distribution-metric-type/disabled.md create mode 100644 docs/api/mozilla.components.service.glean.private/-memory-distribution-metric-type/index.md create mode 100644 docs/api/mozilla.components.service.glean.private/-memory-distribution-metric-type/lifetime.md create mode 100644 docs/api/mozilla.components.service.glean.private/-memory-distribution-metric-type/memory-unit.md rename docs/api/{mozilla.components.service.glean.storages/-custom-distribution-data => mozilla.components.service.glean.private/-memory-distribution-metric-type}/name.md (51%) create mode 100644 docs/api/mozilla.components.service.glean.private/-memory-distribution-metric-type/send-in-pings.md create mode 100644 docs/api/mozilla.components.service.glean.private/-memory-distribution-metric-type/test-get-value.md create mode 100644 docs/api/mozilla.components.service.glean.private/-memory-distribution-metric-type/test-has-value.md create mode 100644 docs/api/mozilla.components.service.glean.private/-memory-unit/-byte.md create mode 100644 docs/api/mozilla.components.service.glean.private/-memory-unit/-gigabyte.md create mode 100644 docs/api/mozilla.components.service.glean.private/-memory-unit/-kilobyte.md create mode 100644 docs/api/mozilla.components.service.glean.private/-memory-unit/-megabyte.md create mode 100644 docs/api/mozilla.components.service.glean.private/-memory-unit/index.md delete mode 100644 docs/api/mozilla.components.service.glean.storages/-custom-distribution-data/-init-.md delete mode 100644 docs/api/mozilla.components.service.glean.storages/-custom-distribution-data/category.md delete mode 100644 docs/api/mozilla.components.service.glean.storages/-custom-distribution-data/index.md delete mode 100644 docs/api/mozilla.components.service.glean.storages/-timing-distribution-data/-init-.md delete mode 100644 docs/api/mozilla.components.service.glean.storages/-timing-distribution-data/category.md delete mode 100644 docs/api/mozilla.components.service.glean.storages/-timing-distribution-data/index.md delete mode 100644 docs/api/mozilla.components.service.glean.storages/-timing-distribution-data/name.md diff --git a/docs/api/alltypes/index.md b/docs/api/alltypes/index.md index 4e9c644019e..05c1c3c034c 100644 --- a/docs/api/alltypes/index.md +++ b/docs/api/alltypes/index.md @@ -117,7 +117,6 @@ | [org.mozilla.telemetry.measurement.CreatedDateMeasurementNew](../org.mozilla.telemetry.measurement/-created-date-measurement-new/index.md) | The field 'created' from CreatedDateMeasurement will be deprecated for the `createdDate` field | | [org.mozilla.telemetry.measurement.CreatedTimestampMeasurement](../org.mozilla.telemetry.measurement/-created-timestamp-measurement/index.md) | | | [org.mozilla.telemetry.measurement.CreatedTimestampMeasurementNew](../org.mozilla.telemetry.measurement/-created-timestamp-measurement-new/index.md) | The field 'created' from CreatedTimestampMeasurement will be deprecated for the `createdTimestamp` field | -| [mozilla.components.service.glean.storages.CustomDistributionData](../mozilla.components.service.glean.storages/-custom-distribution-data/index.md) | This class represents the structure of a custom distribution according to the pipeline schema. It is meant to help serialize and deserialize data to the correct format for transport and storage, as well as including a helper function to calculate the bucket sizes. | | [mozilla.components.service.glean.private.CustomDistributionMetricType](../mozilla.components.service.glean.private/-custom-distribution-metric-type/index.md) | This implements the developer facing API for recording custom distribution metrics. | | [mozilla.components.browser.domains.CustomDomains](../mozilla.components.browser.domains/-custom-domains/index.md) | Contains functionality to manage custom domains for auto-completion. | | [mozilla.components.browser.domains.autocomplete.CustomDomainsProvider](../mozilla.components.browser.domains.autocomplete/-custom-domains-provider/index.md) | Provides autocomplete functionality for domains based on a list managed by [CustomDomains](../mozilla.components.browser.domains/-custom-domains/index.md). | @@ -211,6 +210,7 @@ | [androidx.fragment.app.Fragment](../mozilla.components.lib.state.ext/androidx.fragment.app.-fragment/index.md) (extensions in package mozilla.components.lib.state.ext) | | | [mozilla.components.service.fretboard.Fretboard](../mozilla.components.service.fretboard/-fretboard/index.md) | Entry point of the library | | [mozilla.components.feature.session.FullScreenFeature](../mozilla.components.feature.session/-full-screen-feature/index.md) | Feature implementation for handling fullscreen mode (exiting and back button presses). | +| [mozilla.components.service.glean.histogram.FunctionalHistogram](../mozilla.components.service.glean.histogram/-functional-histogram/index.md) | This class represents a histogram where the bucketing is performed by a function, rather than pre-computed buckets. It is meant to help serialize and deserialize data to the correct format for transport and storage, as well as performing the calculations to determine the correct bucket for each sample. | | [mozilla.components.service.fxa.manager.FxaAccountManager](../mozilla.components.service.fxa.manager/-fxa-account-manager/index.md) | An account manager which encapsulates various internal details of an account lifecycle and provides an observer interface along with a public API for interacting with an account. The internal state machine abstracts over state space as exposed by the fxaclient library, not the internal states experienced by lower-level representation of a Firefox Account; those are opaque to us. | | [mozilla.components.service.fxa.FxaDeviceConstellation](../mozilla.components.service.fxa/-fxa-device-constellation/index.md) | Provides an implementation of [DeviceConstellation](../mozilla.components.concept.sync/-device-constellation/index.md) backed by a [FirefoxAccount](#). | | [mozilla.components.service.fxa.FxaException](../mozilla.components.service.fxa/-fxa-exception.md) | High-level exception class for the exceptions thrown in the Rust library. | @@ -248,7 +248,7 @@ | [mozilla.components.lib.jexl.grammar.GrammarElement](../mozilla.components.lib.jexl.grammar/-grammar-element/index.md) | | | [mozilla.components.concept.fetch.Header](../mozilla.components.concept.fetch/-header/index.md) | Represents a [Header](../mozilla.components.concept.fetch/-header/index.md) containing of a [name](../mozilla.components.concept.fetch/-header/name.md) and [value](../mozilla.components.concept.fetch/-header/value.md). | | [mozilla.components.concept.fetch.Headers](../mozilla.components.concept.fetch/-headers/index.md) | A collection of HTTP [Headers](../mozilla.components.concept.fetch/-headers/index.md) (immutable) of a [Request](../mozilla.components.concept.fetch/-request/index.md) or [Response](../mozilla.components.concept.fetch/-response/index.md). | -| [mozilla.components.service.glean.private.HistogramBase](../mozilla.components.service.glean.private/-histogram-base/index.md) | A common interface to be implemented by all the histogram-like metric types supported by the Glean SDK. | +| [mozilla.components.service.glean.private.HistogramMetricBase](../mozilla.components.service.glean.private/-histogram-metric-base/index.md) | A common interface to be implemented by all the histogram-like metric types supported by the Glean SDK. | | [mozilla.components.service.glean.private.HistogramType](../mozilla.components.service.glean.private/-histogram-type/index.md) | Enumeration of the different kinds of histograms supported by metrics based on histograms. | | [mozilla.components.concept.storage.HistoryAutocompleteResult](../mozilla.components.concept.storage/-history-autocomplete-result/index.md) | Describes an autocompletion result against history storage. | | [mozilla.components.feature.session.HistoryDelegate](../mozilla.components.feature.session/-history-delegate/index.md) | Implementation of the [HistoryTrackingDelegate](../mozilla.components.concept.engine.history/-history-tracking-delegate/index.md) which delegates work to an instance of [HistoryStorage](../mozilla.components.concept.storage/-history-storage/index.md). | @@ -336,9 +336,11 @@ | [mozilla.components.feature.media.MediaFeature](../mozilla.components.feature.media/-media-feature/index.md) | Feature implementation for media playback in web content. This feature takes care of: | | [mozilla.components.feature.media.state.MediaState](../mozilla.components.feature.media.state/-media-state/index.md) | Accumulated state of all [Media](../mozilla.components.concept.engine.media/-media/index.md) of all [Session](../mozilla.components.browser.session/-session/index.md)s. | | [mozilla.components.feature.media.state.MediaStateMachine](../mozilla.components.feature.media.state/-media-state-machine/index.md) | A state machine that subscribes to all [Session](../mozilla.components.browser.session/-session/index.md) instances and watches changes to their [Media](../mozilla.components.concept.engine.media/-media/index.md) to create an aggregated [MediaState](../mozilla.components.feature.media.state/-media-state/index.md). | +| [mozilla.components.service.glean.private.MemoryDistributionMetricType](../mozilla.components.service.glean.private/-memory-distribution-metric-type/index.md) | This implements the developer facing API for recording memory distribution metrics. | | [mozilla.components.browser.icons.loader.MemoryIconLoader](../mozilla.components.browser.icons.loader/-memory-icon-loader/index.md) | An [IconLoader](../mozilla.components.browser.icons.loader/-icon-loader/index.md) implementation that loads icons from an in-memory cache. | | [mozilla.components.browser.icons.preparer.MemoryIconPreparer](../mozilla.components.browser.icons.preparer/-memory-icon-preparer/index.md) | An [IconPreprarer](../mozilla.components.browser.icons.preparer/-icon-preprarer/index.md) implementation that will add known resource URLs (from an in-memory cache) to the request if the request doesn't contain a list of resources yet. | | [mozilla.components.browser.icons.processor.MemoryIconProcessor](../mozilla.components.browser.icons.processor/-memory-icon-processor/index.md) | An [IconProcessor](../mozilla.components.browser.icons.processor/-icon-processor/index.md) implementation that saves icons in the in-memory cache. | +| [mozilla.components.service.glean.private.MemoryUnit](../mozilla.components.service.glean.private/-memory-unit/index.md) | Enumeration of different resolutions supported by the MemoryDistribution metric type. | | [mozilla.components.feature.push.MessageBus](../mozilla.components.feature.push/-message-bus/index.md) | An implementation of [Bus](../mozilla.components.concept.push/-bus/index.md) where the event type is restricted to an enum. | | [mozilla.components.concept.engine.webextension.MessageHandler](../mozilla.components.concept.engine.webextension/-message-handler/index.md) | A handler for all messaging related events, usable for both content and background scripts. | | [org.mozilla.telemetry.measurement.MetricsMeasurement](../org.mozilla.telemetry.measurement/-metrics-measurement/index.md) | | @@ -398,6 +400,7 @@ | [mozilla.components.service.pocket.PocketListenEndpoint](../mozilla.components.service.pocket/-pocket-listen-endpoint/index.md) | Makes requests to the Pocket Listen API and returns the requested data. | | [mozilla.components.service.pocket.net.PocketResponse](../mozilla.components.service.pocket.net/-pocket-response/index.md) | A response from the Pocket API: the subclasses determine the type of the result and contain usable data. | | [mozilla.components.concept.engine.webextension.Port](../mozilla.components.concept.engine.webextension/-port/index.md) | Represents a port for exchanging messages: https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/runtime/Port | +| [mozilla.components.service.glean.histogram.PrecomputedHistogram](../mozilla.components.service.glean.histogram/-precomputed-histogram/index.md) | This class represents the structure of a custom distribution. It is meant to help serialize and deserialize data to the correct format for transport and storage, as well as including helper functions to calculate the bucket sizes. | | [mozilla.components.concept.engine.mediaquery.PreferredColorScheme](../mozilla.components.concept.engine.mediaquery/-preferred-color-scheme/index.md) | A simple data class used to suggest to page content that the user prefers a particular color scheme. | | [org.mozilla.telemetry.measurement.ProcessStartTimestampMeasurement](../org.mozilla.telemetry.measurement/-process-start-timestamp-measurement/index.md) | | | [mozilla.components.concept.sync.Profile](../mozilla.components.concept.sync/-profile/index.md) | | @@ -581,7 +584,6 @@ | [mozilla.components.service.glean.private.TimeUnit](../mozilla.components.service.glean.private/-time-unit/index.md) | Enumeration of different resolutions supported by the Timespan and TimingDistribution metric types. | | [mozilla.components.service.glean.private.TimespanMetricType](../mozilla.components.service.glean.private/-timespan-metric-type/index.md) | This implements the developer facing API for recording timespans. | | [org.mozilla.telemetry.measurement.TimezoneOffsetMeasurement](../org.mozilla.telemetry.measurement/-timezone-offset-measurement/index.md) | | -| [mozilla.components.service.glean.storages.TimingDistributionData](../mozilla.components.service.glean.storages/-timing-distribution-data/index.md) | This class represents the structure of a timing distribution according to the pipeline schema. It is meant to help serialize and deserialize data to the correct format for transport and storage, as well as performing the calculations to determine the correct bucket for each sample. | | [mozilla.components.service.glean.private.TimingDistributionMetricType](../mozilla.components.service.glean.private/-timing-distribution-metric-type/index.md) | This implements the developer facing API for recording timing distribution metrics. | | [mozilla.components.browser.icons.preparer.TippyTopIconPreparer](../mozilla.components.browser.icons.preparer/-tippy-top-icon-preparer/index.md) | [IconPreprarer](../mozilla.components.browser.icons.preparer/-icon-preprarer/index.md) implementation that looks up the host in our "tippy top" list. If it can find a match then it inserts the icon URL into the request. | | [mozilla.components.lib.jexl.lexer.Token](../mozilla.components.lib.jexl.lexer/-token/index.md) | A token emitted by the [Lexer](#). | diff --git a/docs/api/index.md b/docs/api/index.md index 4a9223ff65f..8ebb5e0fd08 100644 --- a/docs/api/index.md +++ b/docs/api/index.md @@ -148,6 +148,7 @@ | [mozilla.components.service.glean.config](mozilla.components.service.glean.config/index.md) | | | [mozilla.components.service.glean.debug](mozilla.components.service.glean.debug/index.md) | | | [mozilla.components.service.glean.error](mozilla.components.service.glean.error/index.md) | | +| [mozilla.components.service.glean.histogram](mozilla.components.service.glean.histogram/index.md) | | | [mozilla.components.service.glean.private](mozilla.components.service.glean.private/index.md) | | | [mozilla.components.service.glean.storages](mozilla.components.service.glean.storages/index.md) | | | [mozilla.components.service.glean.testing](mozilla.components.service.glean.testing/index.md) | | diff --git a/docs/api/mozilla.components.concept.sync/-device-capability/-s-e-n-d_-t-a-b.md b/docs/api/mozilla.components.concept.sync/-device-capability/-s-e-n-d_-t-a-b.md index 79a9094c0df..a594192c7e3 100644 --- a/docs/api/mozilla.components.concept.sync/-device-capability/-s-e-n-d_-t-a-b.md +++ b/docs/api/mozilla.components.concept.sync/-device-capability/-s-e-n-d_-t-a-b.md @@ -2,4 +2,4 @@ # SEND_TAB -`SEND_TAB` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/sync/src/main/java/mozilla/components/concept/sync/Devices.kt#L146) \ No newline at end of file +`SEND_TAB` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/sync/src/main/java/mozilla/components/concept/sync/Devices.kt#L149) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.sync/-device-capability/index.md b/docs/api/mozilla.components.concept.sync/-device-capability/index.md index 74e369351e6..51db6f91764 100644 --- a/docs/api/mozilla.components.concept.sync/-device-capability/index.md +++ b/docs/api/mozilla.components.concept.sync/-device-capability/index.md @@ -2,7 +2,7 @@ # DeviceCapability -`enum class DeviceCapability` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/sync/src/main/java/mozilla/components/concept/sync/Devices.kt#L145) +`enum class DeviceCapability` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/sync/src/main/java/mozilla/components/concept/sync/Devices.kt#L148) Capabilities that a [Device](../-device/index.md) may have. diff --git a/docs/api/mozilla.components.concept.sync/-device-push-subscription/auth-key.md b/docs/api/mozilla.components.concept.sync/-device-push-subscription/auth-key.md index acf5c9eaa9b..2fe901eee3d 100644 --- a/docs/api/mozilla.components.concept.sync/-device-push-subscription/auth-key.md +++ b/docs/api/mozilla.components.concept.sync/-device-push-subscription/auth-key.md @@ -2,4 +2,4 @@ # authKey -`val authKey: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/sync/src/main/java/mozilla/components/concept/sync/Devices.kt#L139) \ No newline at end of file +`val authKey: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/sync/src/main/java/mozilla/components/concept/sync/Devices.kt#L142) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.sync/-device-push-subscription/endpoint.md b/docs/api/mozilla.components.concept.sync/-device-push-subscription/endpoint.md index 4f80b06d731..a32001df645 100644 --- a/docs/api/mozilla.components.concept.sync/-device-push-subscription/endpoint.md +++ b/docs/api/mozilla.components.concept.sync/-device-push-subscription/endpoint.md @@ -2,4 +2,4 @@ # endpoint -`val endpoint: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/sync/src/main/java/mozilla/components/concept/sync/Devices.kt#L137) \ No newline at end of file +`val endpoint: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/sync/src/main/java/mozilla/components/concept/sync/Devices.kt#L140) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.sync/-device-push-subscription/index.md b/docs/api/mozilla.components.concept.sync/-device-push-subscription/index.md index 596ef744575..abcc268acb8 100644 --- a/docs/api/mozilla.components.concept.sync/-device-push-subscription/index.md +++ b/docs/api/mozilla.components.concept.sync/-device-push-subscription/index.md @@ -2,7 +2,7 @@ # DevicePushSubscription -`data class DevicePushSubscription` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/sync/src/main/java/mozilla/components/concept/sync/Devices.kt#L136) +`data class DevicePushSubscription` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/sync/src/main/java/mozilla/components/concept/sync/Devices.kt#L139) Describes an Autopush-compatible push channel subscription. diff --git a/docs/api/mozilla.components.concept.sync/-device-push-subscription/public-key.md b/docs/api/mozilla.components.concept.sync/-device-push-subscription/public-key.md index fa977a5e92a..894d232580c 100644 --- a/docs/api/mozilla.components.concept.sync/-device-push-subscription/public-key.md +++ b/docs/api/mozilla.components.concept.sync/-device-push-subscription/public-key.md @@ -2,4 +2,4 @@ # publicKey -`val publicKey: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/sync/src/main/java/mozilla/components/concept/sync/Devices.kt#L138) \ No newline at end of file +`val publicKey: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/sync/src/main/java/mozilla/components/concept/sync/Devices.kt#L141) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.sync/-device-type/-t-a-b-l-e-t.md b/docs/api/mozilla.components.concept.sync/-device-type/-t-a-b-l-e-t.md new file mode 100644 index 00000000000..57a805760c1 --- /dev/null +++ b/docs/api/mozilla.components.concept.sync/-device-type/-t-a-b-l-e-t.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.concept.sync](../index.md) / [DeviceType](index.md) / [TABLET](./-t-a-b-l-e-t.md) + +# TABLET + +`TABLET` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/sync/src/main/java/mozilla/components/concept/sync/Devices.kt#L130) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.sync/-device-type/-t-v.md b/docs/api/mozilla.components.concept.sync/-device-type/-t-v.md new file mode 100644 index 00000000000..70d67b2d174 --- /dev/null +++ b/docs/api/mozilla.components.concept.sync/-device-type/-t-v.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.concept.sync](../index.md) / [DeviceType](index.md) / [TV](./-t-v.md) + +# TV + +`TV` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/sync/src/main/java/mozilla/components/concept/sync/Devices.kt#L131) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.sync/-device-type/-u-n-k-n-o-w-n.md b/docs/api/mozilla.components.concept.sync/-device-type/-u-n-k-n-o-w-n.md index eca1878aa94..3a252db525a 100644 --- a/docs/api/mozilla.components.concept.sync/-device-type/-u-n-k-n-o-w-n.md +++ b/docs/api/mozilla.components.concept.sync/-device-type/-u-n-k-n-o-w-n.md @@ -2,4 +2,4 @@ # UNKNOWN -`UNKNOWN` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/sync/src/main/java/mozilla/components/concept/sync/Devices.kt#L130) \ No newline at end of file +`UNKNOWN` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/sync/src/main/java/mozilla/components/concept/sync/Devices.kt#L133) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.sync/-device-type/-v-r.md b/docs/api/mozilla.components.concept.sync/-device-type/-v-r.md new file mode 100644 index 00000000000..dd7116ff56a --- /dev/null +++ b/docs/api/mozilla.components.concept.sync/-device-type/-v-r.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.concept.sync](../index.md) / [DeviceType](index.md) / [VR](./-v-r.md) + +# VR + +`VR` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/sync/src/main/java/mozilla/components/concept/sync/Devices.kt#L132) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.sync/-device-type/index.md b/docs/api/mozilla.components.concept.sync/-device-type/index.md index 58ae04feaa0..8c973c79fd5 100644 --- a/docs/api/mozilla.components.concept.sync/-device-type/index.md +++ b/docs/api/mozilla.components.concept.sync/-device-type/index.md @@ -12,6 +12,9 @@ Describes a type of the physical device in the constellation. |---|---| | [DESKTOP](-d-e-s-k-t-o-p.md) | | | [MOBILE](-m-o-b-i-l-e.md) | | +| [TABLET](-t-a-b-l-e-t.md) | | +| [TV](-t-v.md) | | +| [VR](-v-r.md) | | | [UNKNOWN](-u-n-k-n-o-w-n.md) | | ### Extension Functions diff --git a/docs/api/mozilla.components.concept.sync/-device/capabilities.md b/docs/api/mozilla.components.concept.sync/-device/capabilities.md index 0647cf6f306..617e52363bc 100644 --- a/docs/api/mozilla.components.concept.sync/-device/capabilities.md +++ b/docs/api/mozilla.components.concept.sync/-device/capabilities.md @@ -2,4 +2,4 @@ # capabilities -`val capabilities: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`DeviceCapability`](../-device-capability/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/sync/src/main/java/mozilla/components/concept/sync/Devices.kt#L158) \ No newline at end of file +`val capabilities: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`DeviceCapability`](../-device-capability/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/sync/src/main/java/mozilla/components/concept/sync/Devices.kt#L161) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.sync/-device/device-type.md b/docs/api/mozilla.components.concept.sync/-device/device-type.md index 025da9e37d2..0008d02b1e1 100644 --- a/docs/api/mozilla.components.concept.sync/-device/device-type.md +++ b/docs/api/mozilla.components.concept.sync/-device/device-type.md @@ -2,4 +2,4 @@ # deviceType -`val deviceType: `[`DeviceType`](../-device-type/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/sync/src/main/java/mozilla/components/concept/sync/Devices.kt#L155) \ No newline at end of file +`val deviceType: `[`DeviceType`](../-device-type/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/sync/src/main/java/mozilla/components/concept/sync/Devices.kt#L158) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.sync/-device/display-name.md b/docs/api/mozilla.components.concept.sync/-device/display-name.md index 1adefb4ad3a..67f47426a01 100644 --- a/docs/api/mozilla.components.concept.sync/-device/display-name.md +++ b/docs/api/mozilla.components.concept.sync/-device/display-name.md @@ -2,4 +2,4 @@ # displayName -`val displayName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/sync/src/main/java/mozilla/components/concept/sync/Devices.kt#L154) \ No newline at end of file +`val displayName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/sync/src/main/java/mozilla/components/concept/sync/Devices.kt#L157) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.sync/-device/id.md b/docs/api/mozilla.components.concept.sync/-device/id.md index a6eab15154d..87aad02296a 100644 --- a/docs/api/mozilla.components.concept.sync/-device/id.md +++ b/docs/api/mozilla.components.concept.sync/-device/id.md @@ -2,4 +2,4 @@ # id -`val id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/sync/src/main/java/mozilla/components/concept/sync/Devices.kt#L153) \ No newline at end of file +`val id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/sync/src/main/java/mozilla/components/concept/sync/Devices.kt#L156) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.sync/-device/index.md b/docs/api/mozilla.components.concept.sync/-device/index.md index 77e4b89fd44..5b6830eaba3 100644 --- a/docs/api/mozilla.components.concept.sync/-device/index.md +++ b/docs/api/mozilla.components.concept.sync/-device/index.md @@ -2,7 +2,7 @@ # Device -`data class Device` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/sync/src/main/java/mozilla/components/concept/sync/Devices.kt#L152) +`data class Device` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/sync/src/main/java/mozilla/components/concept/sync/Devices.kt#L155) Describes a device in the [DeviceConstellation](../-device-constellation/index.md). diff --git a/docs/api/mozilla.components.concept.sync/-device/is-current-device.md b/docs/api/mozilla.components.concept.sync/-device/is-current-device.md index 2b7ecb42294..3b989074fc2 100644 --- a/docs/api/mozilla.components.concept.sync/-device/is-current-device.md +++ b/docs/api/mozilla.components.concept.sync/-device/is-current-device.md @@ -2,4 +2,4 @@ # isCurrentDevice -`val isCurrentDevice: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/sync/src/main/java/mozilla/components/concept/sync/Devices.kt#L156) \ No newline at end of file +`val isCurrentDevice: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/sync/src/main/java/mozilla/components/concept/sync/Devices.kt#L159) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.sync/-device/last-access-time.md b/docs/api/mozilla.components.concept.sync/-device/last-access-time.md index 3ef8ce67614..ec2ebea2eac 100644 --- a/docs/api/mozilla.components.concept.sync/-device/last-access-time.md +++ b/docs/api/mozilla.components.concept.sync/-device/last-access-time.md @@ -2,4 +2,4 @@ # lastAccessTime -`val lastAccessTime: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/sync/src/main/java/mozilla/components/concept/sync/Devices.kt#L157) \ No newline at end of file +`val lastAccessTime: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/sync/src/main/java/mozilla/components/concept/sync/Devices.kt#L160) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.sync/-device/subscription-expired.md b/docs/api/mozilla.components.concept.sync/-device/subscription-expired.md index 8c571fcd15d..eaa3d780e7c 100644 --- a/docs/api/mozilla.components.concept.sync/-device/subscription-expired.md +++ b/docs/api/mozilla.components.concept.sync/-device/subscription-expired.md @@ -2,4 +2,4 @@ # subscriptionExpired -`val subscriptionExpired: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/sync/src/main/java/mozilla/components/concept/sync/Devices.kt#L159) \ No newline at end of file +`val subscriptionExpired: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/sync/src/main/java/mozilla/components/concept/sync/Devices.kt#L162) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.sync/-device/subscription.md b/docs/api/mozilla.components.concept.sync/-device/subscription.md index abfcaa05053..61ca8a23903 100644 --- a/docs/api/mozilla.components.concept.sync/-device/subscription.md +++ b/docs/api/mozilla.components.concept.sync/-device/subscription.md @@ -2,4 +2,4 @@ # subscription -`val subscription: `[`DevicePushSubscription`](../-device-push-subscription/index.md)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/sync/src/main/java/mozilla/components/concept/sync/Devices.kt#L160) \ No newline at end of file +`val subscription: `[`DevicePushSubscription`](../-device-push-subscription/index.md)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/sync/src/main/java/mozilla/components/concept/sync/Devices.kt#L163) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.sync/-o-auth-account/begin-o-auth-flow-async.md b/docs/api/mozilla.components.concept.sync/-o-auth-account/begin-o-auth-flow-async.md index f8d8cdbc43c..bab370fe497 100644 --- a/docs/api/mozilla.components.concept.sync/-o-auth-account/begin-o-auth-flow-async.md +++ b/docs/api/mozilla.components.concept.sync/-o-auth-account/begin-o-auth-flow-async.md @@ -2,4 +2,4 @@ # beginOAuthFlowAsync -`abstract fun beginOAuthFlowAsync(scopes: `[`Set`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>, wantsKeys: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): Deferred<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/sync/src/main/java/mozilla/components/concept/sync/OAuthAccount.kt#L28) \ No newline at end of file +`abstract fun beginOAuthFlowAsync(scopes: `[`Set`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>): Deferred<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/sync/src/main/java/mozilla/components/concept/sync/OAuthAccount.kt#L28) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.sync/-o-auth-account/index.md b/docs/api/mozilla.components.concept.sync/-o-auth-account/index.md index 3b0276849a6..589fab584b2 100644 --- a/docs/api/mozilla.components.concept.sync/-o-auth-account/index.md +++ b/docs/api/mozilla.components.concept.sync/-o-auth-account/index.md @@ -10,7 +10,7 @@ Facilitates testing consumers of FirefoxAccount. | Name | Summary | |---|---| -| [beginOAuthFlowAsync](begin-o-auth-flow-async.md) | `abstract fun beginOAuthFlowAsync(scopes: `[`Set`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>, wantsKeys: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): Deferred<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?>` | +| [beginOAuthFlowAsync](begin-o-auth-flow-async.md) | `abstract fun beginOAuthFlowAsync(scopes: `[`Set`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>): Deferred<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?>` | | [beginPairingFlowAsync](begin-pairing-flow-async.md) | `abstract fun beginPairingFlowAsync(pairingUrl: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, scopes: `[`Set`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>): Deferred<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?>` | | [checkAuthorizationStatusAsync](check-authorization-status-async.md) | `abstract fun checkAuthorizationStatusAsync(singleScope: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): Deferred<`[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`?>` | | [completeOAuthFlowAsync](complete-o-auth-flow-async.md) | `abstract fun completeOAuthFlowAsync(code: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, state: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): Deferred<`[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`>` | diff --git a/docs/api/mozilla.components.service.fxa/-firefox-account/begin-o-auth-flow-async.md b/docs/api/mozilla.components.service.fxa/-firefox-account/begin-o-auth-flow-async.md index 21a3260f005..de11b5fc4b8 100644 --- a/docs/api/mozilla.components.service.fxa/-firefox-account/begin-o-auth-flow-async.md +++ b/docs/api/mozilla.components.service.fxa/-firefox-account/begin-o-auth-flow-async.md @@ -2,7 +2,7 @@ # beginOAuthFlowAsync -`fun beginOAuthFlowAsync(scopes: `[`Set`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>, wantsKeys: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): Deferred<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FirefoxAccount.kt#L109) +`fun beginOAuthFlowAsync(scopes: `[`Set`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>): Deferred<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FirefoxAccount.kt#L108) Overrides [OAuthAccount.beginOAuthFlowAsync](../../mozilla.components.concept.sync/-o-auth-account/begin-o-auth-flow-async.md) @@ -12,8 +12,6 @@ Constructs a URL used to begin the OAuth flow for the requested scopes and keys. `scopes` - List of OAuth scopes for which the client wants access -`wantsKeys` - Fetch keys for end-to-end encryption of data from Mozilla-hosted services - **Return** Deferred that resolves to the flow URL when complete diff --git a/docs/api/mozilla.components.service.fxa/-firefox-account/begin-pairing-flow-async.md b/docs/api/mozilla.components.service.fxa/-firefox-account/begin-pairing-flow-async.md index 553018a86e3..5573e9ff268 100644 --- a/docs/api/mozilla.components.service.fxa/-firefox-account/begin-pairing-flow-async.md +++ b/docs/api/mozilla.components.service.fxa/-firefox-account/begin-pairing-flow-async.md @@ -2,7 +2,7 @@ # beginPairingFlowAsync -`fun beginPairingFlowAsync(pairingUrl: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, scopes: `[`Set`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>): Deferred<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FirefoxAccount.kt#L117) +`fun beginPairingFlowAsync(pairingUrl: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, scopes: `[`Set`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>): Deferred<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FirefoxAccount.kt#L116) Overrides [OAuthAccount.beginPairingFlowAsync](../../mozilla.components.concept.sync/-o-auth-account/begin-pairing-flow-async.md) diff --git a/docs/api/mozilla.components.service.fxa/-firefox-account/check-authorization-status-async.md b/docs/api/mozilla.components.service.fxa/-firefox-account/check-authorization-status-async.md index e1aed3ceac7..583f564dd4d 100644 --- a/docs/api/mozilla.components.service.fxa/-firefox-account/check-authorization-status-async.md +++ b/docs/api/mozilla.components.service.fxa/-firefox-account/check-authorization-status-async.md @@ -2,7 +2,7 @@ # checkAuthorizationStatusAsync -`fun checkAuthorizationStatusAsync(singleScope: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): Deferred<`[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`?>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FirefoxAccount.kt#L212) +`fun checkAuthorizationStatusAsync(singleScope: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): Deferred<`[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`?>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FirefoxAccount.kt#L211) Overrides [OAuthAccount.checkAuthorizationStatusAsync](../../mozilla.components.concept.sync/-o-auth-account/check-authorization-status-async.md) diff --git a/docs/api/mozilla.components.service.fxa/-firefox-account/complete-o-auth-flow-async.md b/docs/api/mozilla.components.service.fxa/-firefox-account/complete-o-auth-flow-async.md index a9efa1b760b..ee9a2e5c71d 100644 --- a/docs/api/mozilla.components.service.fxa/-firefox-account/complete-o-auth-flow-async.md +++ b/docs/api/mozilla.components.service.fxa/-firefox-account/complete-o-auth-flow-async.md @@ -2,7 +2,7 @@ # completeOAuthFlowAsync -`fun completeOAuthFlowAsync(code: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, state: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): Deferred<`[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FirefoxAccount.kt#L176) +`fun completeOAuthFlowAsync(code: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, state: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): Deferred<`[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FirefoxAccount.kt#L175) Overrides [OAuthAccount.completeOAuthFlowAsync](../../mozilla.components.concept.sync/-o-auth-account/complete-o-auth-flow-async.md) diff --git a/docs/api/mozilla.components.service.fxa/-firefox-account/device-constellation.md b/docs/api/mozilla.components.service.fxa/-firefox-account/device-constellation.md index 240c5fea756..63c914d49ba 100644 --- a/docs/api/mozilla.components.service.fxa/-firefox-account/device-constellation.md +++ b/docs/api/mozilla.components.service.fxa/-firefox-account/device-constellation.md @@ -2,7 +2,7 @@ # deviceConstellation -`fun deviceConstellation(): `[`DeviceConstellation`](../../mozilla.components.concept.sync/-device-constellation/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FirefoxAccount.kt#L260) +`fun deviceConstellation(): `[`DeviceConstellation`](../../mozilla.components.concept.sync/-device-constellation/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FirefoxAccount.kt#L259) Overrides [OAuthAccount.deviceConstellation](../../mozilla.components.concept.sync/-o-auth-account/device-constellation.md) diff --git a/docs/api/mozilla.components.service.fxa/-firefox-account/disconnect-async.md b/docs/api/mozilla.components.service.fxa/-firefox-account/disconnect-async.md index 7fd88a579be..0f138d68f25 100644 --- a/docs/api/mozilla.components.service.fxa/-firefox-account/disconnect-async.md +++ b/docs/api/mozilla.components.service.fxa/-firefox-account/disconnect-async.md @@ -2,7 +2,7 @@ # disconnectAsync -`fun disconnectAsync(): Deferred<`[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FirefoxAccount.kt#L250) +`fun disconnectAsync(): Deferred<`[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FirefoxAccount.kt#L249) Overrides [OAuthAccount.disconnectAsync](../../mozilla.components.concept.sync/-o-auth-account/disconnect-async.md) diff --git a/docs/api/mozilla.components.service.fxa/-firefox-account/from-j-s-o-n-string.md b/docs/api/mozilla.components.service.fxa/-firefox-account/from-j-s-o-n-string.md index 735187fa21a..6630ee77688 100644 --- a/docs/api/mozilla.components.service.fxa/-firefox-account/from-j-s-o-n-string.md +++ b/docs/api/mozilla.components.service.fxa/-firefox-account/from-j-s-o-n-string.md @@ -2,7 +2,7 @@ # fromJSONString -`fun fromJSONString(json: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, persistCallback: `[`PersistCallback`](../-persist-callback.md)`? = null): `[`FirefoxAccount`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FirefoxAccount.kt#L288) +`fun fromJSONString(json: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, persistCallback: `[`PersistCallback`](../-persist-callback.md)`? = null): `[`FirefoxAccount`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FirefoxAccount.kt#L287) Restores the account's authentication state from a JSON string produced by [FirefoxAccount.toJSONString](to-j-s-o-n-string.md). diff --git a/docs/api/mozilla.components.service.fxa/-firefox-account/get-access-token-async.md b/docs/api/mozilla.components.service.fxa/-firefox-account/get-access-token-async.md index e19d5e61dfb..96429321019 100644 --- a/docs/api/mozilla.components.service.fxa/-firefox-account/get-access-token-async.md +++ b/docs/api/mozilla.components.service.fxa/-firefox-account/get-access-token-async.md @@ -2,7 +2,7 @@ # getAccessTokenAsync -`fun getAccessTokenAsync(singleScope: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): Deferred<`[`AccessTokenInfo`](../../mozilla.components.concept.sync/-access-token-info/index.md)`?>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FirefoxAccount.kt#L191) +`fun getAccessTokenAsync(singleScope: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): Deferred<`[`AccessTokenInfo`](../../mozilla.components.concept.sync/-access-token-info/index.md)`?>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FirefoxAccount.kt#L190) Overrides [OAuthAccount.getAccessTokenAsync](../../mozilla.components.concept.sync/-o-auth-account/get-access-token-async.md) diff --git a/docs/api/mozilla.components.service.fxa/-firefox-account/get-connection-success-u-r-l.md b/docs/api/mozilla.components.service.fxa/-firefox-account/get-connection-success-u-r-l.md index 4c87423f5c0..962a932b7b7 100644 --- a/docs/api/mozilla.components.service.fxa/-firefox-account/get-connection-success-u-r-l.md +++ b/docs/api/mozilla.components.service.fxa/-firefox-account/get-connection-success-u-r-l.md @@ -2,7 +2,7 @@ # getConnectionSuccessURL -`fun getConnectionSuccessURL(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FirefoxAccount.kt#L166) +`fun getConnectionSuccessURL(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FirefoxAccount.kt#L165) Fetches the connection success url. diff --git a/docs/api/mozilla.components.service.fxa/-firefox-account/get-profile-async.md b/docs/api/mozilla.components.service.fxa/-firefox-account/get-profile-async.md index 0959dba5f1e..bf00e08d7b0 100644 --- a/docs/api/mozilla.components.service.fxa/-firefox-account/get-profile-async.md +++ b/docs/api/mozilla.components.service.fxa/-firefox-account/get-profile-async.md @@ -2,7 +2,7 @@ # getProfileAsync -`fun getProfileAsync(ignoreCache: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): Deferred<`[`Profile`](../../mozilla.components.concept.sync/-profile/index.md)`?>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FirefoxAccount.kt#L132) +`fun getProfileAsync(ignoreCache: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): Deferred<`[`Profile`](../../mozilla.components.concept.sync/-profile/index.md)`?>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FirefoxAccount.kt#L131) Overrides [OAuthAccount.getProfileAsync](../../mozilla.components.concept.sync/-o-auth-account/get-profile-async.md) @@ -16,7 +16,7 @@ or from the server (requires the client to have access to the profile scope). **Return** Profile (optional, if successfully retrieved) representing the user's basic profile info -`fun getProfileAsync(): Deferred<`[`Profile`](../../mozilla.components.concept.sync/-profile/index.md)`?>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FirefoxAccount.kt#L154) +`fun getProfileAsync(): Deferred<`[`Profile`](../../mozilla.components.concept.sync/-profile/index.md)`?>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FirefoxAccount.kt#L153) Overrides [OAuthAccount.getProfileAsync](../../mozilla.components.concept.sync/-o-auth-account/get-profile-async.md) diff --git a/docs/api/mozilla.components.service.fxa/-firefox-account/get-token-server-endpoint-u-r-l.md b/docs/api/mozilla.components.service.fxa/-firefox-account/get-token-server-endpoint-u-r-l.md index a2f2744a653..703c4c49769 100644 --- a/docs/api/mozilla.components.service.fxa/-firefox-account/get-token-server-endpoint-u-r-l.md +++ b/docs/api/mozilla.components.service.fxa/-firefox-account/get-token-server-endpoint-u-r-l.md @@ -2,7 +2,7 @@ # getTokenServerEndpointURL -`fun getTokenServerEndpointURL(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FirefoxAccount.kt#L159) +`fun getTokenServerEndpointURL(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FirefoxAccount.kt#L158) Overrides [OAuthAccount.getTokenServerEndpointURL](../../mozilla.components.concept.sync/-o-auth-account/get-token-server-endpoint-u-r-l.md) diff --git a/docs/api/mozilla.components.service.fxa/-firefox-account/index.md b/docs/api/mozilla.components.service.fxa/-firefox-account/index.md index e553e621867..48562c5acc4 100644 --- a/docs/api/mozilla.components.service.fxa/-firefox-account/index.md +++ b/docs/api/mozilla.components.service.fxa/-firefox-account/index.md @@ -16,7 +16,7 @@ FirefoxAccount represents the authentication state of a client. | Name | Summary | |---|---| -| [beginOAuthFlowAsync](begin-o-auth-flow-async.md) | `fun beginOAuthFlowAsync(scopes: `[`Set`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>, wantsKeys: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): Deferred<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?>`
Constructs a URL used to begin the OAuth flow for the requested scopes and keys. | +| [beginOAuthFlowAsync](begin-o-auth-flow-async.md) | `fun beginOAuthFlowAsync(scopes: `[`Set`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>): Deferred<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?>`
Constructs a URL used to begin the OAuth flow for the requested scopes and keys. | | [beginPairingFlowAsync](begin-pairing-flow-async.md) | `fun beginPairingFlowAsync(pairingUrl: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, scopes: `[`Set`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>): Deferred<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?>` | | [checkAuthorizationStatusAsync](check-authorization-status-async.md) | `fun checkAuthorizationStatusAsync(singleScope: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): Deferred<`[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`?>`
This method should be called when a request made with an OAuth token failed with an authentication error. It will re-build cached state and perform a connectivity check. | | [close](close.md) | `fun close(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | diff --git a/docs/api/mozilla.components.service.fxa/-firefox-account/migrate-from-session-token-async.md b/docs/api/mozilla.components.service.fxa/-firefox-account/migrate-from-session-token-async.md index 771587d4a5e..7473bc28f5c 100644 --- a/docs/api/mozilla.components.service.fxa/-firefox-account/migrate-from-session-token-async.md +++ b/docs/api/mozilla.components.service.fxa/-firefox-account/migrate-from-session-token-async.md @@ -2,7 +2,7 @@ # migrateFromSessionTokenAsync -`fun migrateFromSessionTokenAsync(sessionToken: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, kSync: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, kXCS: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): Deferred<`[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FirefoxAccount.kt#L140) +`fun migrateFromSessionTokenAsync(sessionToken: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, kSync: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, kXCS: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): Deferred<`[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FirefoxAccount.kt#L139) Overrides [OAuthAccount.migrateFromSessionTokenAsync](../../mozilla.components.concept.sync/-o-auth-account/migrate-from-session-token-async.md) diff --git a/docs/api/mozilla.components.service.fxa/-firefox-account/to-j-s-o-n-string.md b/docs/api/mozilla.components.service.fxa/-firefox-account/to-j-s-o-n-string.md index 327a2a8ede3..c6b22c0cea4 100644 --- a/docs/api/mozilla.components.service.fxa/-firefox-account/to-j-s-o-n-string.md +++ b/docs/api/mozilla.components.service.fxa/-firefox-account/to-j-s-o-n-string.md @@ -2,7 +2,7 @@ # toJSONString -`fun toJSONString(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FirefoxAccount.kt#L271) +`fun toJSONString(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FirefoxAccount.kt#L270) Overrides [OAuthAccount.toJSONString](../../mozilla.components.concept.sync/-o-auth-account/to-j-s-o-n-string.md) diff --git a/docs/api/mozilla.components.service.fxa/into.md b/docs/api/mozilla.components.service.fxa/into.md index be127b26740..33734015127 100644 --- a/docs/api/mozilla.components.service.fxa/into.md +++ b/docs/api/mozilla.components.service.fxa/into.md @@ -2,9 +2,9 @@ # into -`fun `[`DeviceType`](../mozilla.components.concept.sync/-device-type/index.md)`.into(): Type` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/Types.kt#L80) -`fun `[`DeviceCapability`](../mozilla.components.concept.sync/-device-capability/index.md)`.into(): Capability` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/Types.kt#L88) -`fun `[`DevicePushSubscription`](../mozilla.components.concept.sync/-device-push-subscription/index.md)`.into(): PushSubscription` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/Types.kt#L100) -`fun `[`Device`](../mozilla.components.concept.sync/-device/index.md)`.into(): Device` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/Types.kt#L129) -`fun `[`TabData`](../mozilla.components.concept.sync/-tab-data/index.md)`.into(): TabHistoryEntry` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/Types.kt#L149) -`fun `[`TabReceived`](../mozilla.components.concept.sync/-device-event/-tab-received/index.md)`.into(): TabReceived` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/Types.kt#L163) \ No newline at end of file +`fun `[`DeviceType`](../mozilla.components.concept.sync/-device-type/index.md)`.into(): Type` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/Types.kt#L83) +`fun `[`DeviceCapability`](../mozilla.components.concept.sync/-device-capability/index.md)`.into(): Capability` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/Types.kt#L94) +`fun `[`DevicePushSubscription`](../mozilla.components.concept.sync/-device-push-subscription/index.md)`.into(): PushSubscription` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/Types.kt#L106) +`fun `[`Device`](../mozilla.components.concept.sync/-device/index.md)`.into(): Device` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/Types.kt#L135) +`fun `[`TabData`](../mozilla.components.concept.sync/-tab-data/index.md)`.into(): TabHistoryEntry` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/Types.kt#L155) +`fun `[`TabReceived`](../mozilla.components.concept.sync/-device-event/-tab-received/index.md)`.into(): TabReceived` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/Types.kt#L169) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fxa/mozilla.appservices.fxaclient.-account-event.-tab-received/into.md b/docs/api/mozilla.components.service.fxa/mozilla.appservices.fxaclient.-account-event.-tab-received/into.md index e34068a70f2..730046061cd 100644 --- a/docs/api/mozilla.components.service.fxa/mozilla.appservices.fxaclient.-account-event.-tab-received/into.md +++ b/docs/api/mozilla.components.service.fxa/mozilla.appservices.fxaclient.-account-event.-tab-received/into.md @@ -2,4 +2,4 @@ # into -`fun TabReceived.into(): `[`TabReceived`](../../mozilla.components.concept.sync/-device-event/-tab-received/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/Types.kt#L156) \ No newline at end of file +`fun TabReceived.into(): `[`TabReceived`](../../mozilla.components.concept.sync/-device-event/-tab-received/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/Types.kt#L162) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fxa/mozilla.appservices.fxaclient.-device.-capability/into.md b/docs/api/mozilla.components.service.fxa/mozilla.appservices.fxaclient.-device.-capability/into.md index c1653757550..62d5cb8de64 100644 --- a/docs/api/mozilla.components.service.fxa/mozilla.appservices.fxaclient.-device.-capability/into.md +++ b/docs/api/mozilla.components.service.fxa/mozilla.appservices.fxaclient.-device.-capability/into.md @@ -2,4 +2,4 @@ # into -`fun Capability.into(): `[`DeviceCapability`](../../mozilla.components.concept.sync/-device-capability/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/Types.kt#L94) \ No newline at end of file +`fun Capability.into(): `[`DeviceCapability`](../../mozilla.components.concept.sync/-device-capability/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/Types.kt#L100) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fxa/mozilla.appservices.fxaclient.-device.-push-subscription/into.md b/docs/api/mozilla.components.service.fxa/mozilla.appservices.fxaclient.-device.-push-subscription/into.md index 72e5fe793e3..ccc8259cb5f 100644 --- a/docs/api/mozilla.components.service.fxa/mozilla.appservices.fxaclient.-device.-push-subscription/into.md +++ b/docs/api/mozilla.components.service.fxa/mozilla.appservices.fxaclient.-device.-push-subscription/into.md @@ -2,4 +2,4 @@ # into -`fun PushSubscription.into(): `[`DevicePushSubscription`](../../mozilla.components.concept.sync/-device-push-subscription/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/Types.kt#L108) \ No newline at end of file +`fun PushSubscription.into(): `[`DevicePushSubscription`](../../mozilla.components.concept.sync/-device-push-subscription/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/Types.kt#L114) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fxa/mozilla.appservices.fxaclient.-device/into.md b/docs/api/mozilla.components.service.fxa/mozilla.appservices.fxaclient.-device/into.md index f98228d0244..5b13d0a90f4 100644 --- a/docs/api/mozilla.components.service.fxa/mozilla.appservices.fxaclient.-device/into.md +++ b/docs/api/mozilla.components.service.fxa/mozilla.appservices.fxaclient.-device/into.md @@ -2,4 +2,4 @@ # into -`fun Device.into(): `[`Device`](../../mozilla.components.concept.sync/-device/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/Types.kt#L116) \ No newline at end of file +`fun Device.into(): `[`Device`](../../mozilla.components.concept.sync/-device/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/Types.kt#L122) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fxa/mozilla.appservices.fxaclient.-tab-history-entry/into.md b/docs/api/mozilla.components.service.fxa/mozilla.appservices.fxaclient.-tab-history-entry/into.md index 1644c7c4bc8..8d4ffeccfd1 100644 --- a/docs/api/mozilla.components.service.fxa/mozilla.appservices.fxaclient.-tab-history-entry/into.md +++ b/docs/api/mozilla.components.service.fxa/mozilla.appservices.fxaclient.-tab-history-entry/into.md @@ -2,4 +2,4 @@ # into -`fun TabHistoryEntry.into(): `[`TabData`](../../mozilla.components.concept.sync/-tab-data/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/Types.kt#L142) \ No newline at end of file +`fun TabHistoryEntry.into(): `[`TabData`](../../mozilla.components.concept.sync/-tab-data/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/Types.kt#L148) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.glean.histogram/-functional-histogram/-init-.md b/docs/api/mozilla.components.service.glean.histogram/-functional-histogram/-init-.md new file mode 100644 index 00000000000..05744a14cce --- /dev/null +++ b/docs/api/mozilla.components.service.glean.histogram/-functional-histogram/-init-.md @@ -0,0 +1,24 @@ +[android-components](../../index.md) / [mozilla.components.service.glean.histogram](../index.md) / [FunctionalHistogram](index.md) / [<init>](./-init-.md) + +# <init> + +`FunctionalHistogram(logBase: `[`Double`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)`, bucketsPerMagnitude: `[`Double`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)`, values: `[`MutableMap`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-map/index.html)`<`[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`, `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`> = mutableMapOf(), sum: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)` = 0)` + +This class represents a histogram where the bucketing is performed by a +function, rather than pre-computed buckets. It is meant to help serialize +and deserialize data to the correct format for transport and storage, as well +as performing the calculations to determine the correct bucket for each sample. + +The bucket index of a given sample is determined with the following function: + +``` + i = ⌊n log₂(𝑥)⌋ +``` + +In other words, there are n buckets for each power of 2 magnitude. + +### Parameters + +`values` - a map containing the minimum bucket value mapped to the accumulated count + +`sum` - the accumulated sum of all the samples in the histogram \ No newline at end of file diff --git a/docs/api/mozilla.components.service.glean.histogram/-functional-histogram/buckets-per-magnitude.md b/docs/api/mozilla.components.service.glean.histogram/-functional-histogram/buckets-per-magnitude.md new file mode 100644 index 00000000000..f0f5476c262 --- /dev/null +++ b/docs/api/mozilla.components.service.glean.histogram/-functional-histogram/buckets-per-magnitude.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.glean.histogram](../index.md) / [FunctionalHistogram](index.md) / [bucketsPerMagnitude](./buckets-per-magnitude.md) + +# bucketsPerMagnitude + +`val bucketsPerMagnitude: `[`Double`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/histogram/FunctionalHistogram.kt#L29) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.glean.storages/-timing-distribution-data/count.md b/docs/api/mozilla.components.service.glean.histogram/-functional-histogram/count.md similarity index 58% rename from docs/api/mozilla.components.service.glean.storages/-timing-distribution-data/count.md rename to docs/api/mozilla.components.service.glean.histogram/-functional-histogram/count.md index 4b7bbf4b6fd..aae5620cbd1 100644 --- a/docs/api/mozilla.components.service.glean.storages/-timing-distribution-data/count.md +++ b/docs/api/mozilla.components.service.glean.histogram/-functional-histogram/count.md @@ -1,5 +1,5 @@ -[android-components](../../index.md) / [mozilla.components.service.glean.storages](../index.md) / [TimingDistributionData](index.md) / [count](./count.md) +[android-components](../../index.md) / [mozilla.components.service.glean.histogram](../index.md) / [FunctionalHistogram](index.md) / [count](./count.md) # count -`val count: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/storages/TimingDistributionsStorageEngine.kt#L292) \ No newline at end of file +`val count: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/histogram/FunctionalHistogram.kt#L128) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.glean.histogram/-functional-histogram/index.md b/docs/api/mozilla.components.service.glean.histogram/-functional-histogram/index.md new file mode 100644 index 00000000000..0f19da8c928 --- /dev/null +++ b/docs/api/mozilla.components.service.glean.histogram/-functional-histogram/index.md @@ -0,0 +1,40 @@ +[android-components](../../index.md) / [mozilla.components.service.glean.histogram](../index.md) / [FunctionalHistogram](./index.md) + +# FunctionalHistogram + +`data class FunctionalHistogram` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/histogram/FunctionalHistogram.kt#L27) + +This class represents a histogram where the bucketing is performed by a +function, rather than pre-computed buckets. It is meant to help serialize +and deserialize data to the correct format for transport and storage, as well +as performing the calculations to determine the correct bucket for each sample. + +The bucket index of a given sample is determined with the following function: + +``` + i = ⌊n log₂(𝑥)⌋ +``` + +In other words, there are n buckets for each power of 2 magnitude. + +### Parameters + +`values` - a map containing the minimum bucket value mapped to the accumulated count + +`sum` - the accumulated sum of all the samples in the histogram + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `FunctionalHistogram(logBase: `[`Double`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)`, bucketsPerMagnitude: `[`Double`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)`, values: `[`MutableMap`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-map/index.html)`<`[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`, `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`> = mutableMapOf(), sum: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)` = 0)`
This class represents a histogram where the bucketing is performed by a function, rather than pre-computed buckets. It is meant to help serialize and deserialize data to the correct format for transport and storage, as well as performing the calculations to determine the correct bucket for each sample. | + +### Properties + +| Name | Summary | +|---|---| +| [bucketsPerMagnitude](buckets-per-magnitude.md) | `val bucketsPerMagnitude: `[`Double`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) | +| [count](count.md) | `val count: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) | +| [logBase](log-base.md) | `val logBase: `[`Double`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) | +| [sum](sum.md) | `var sum: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
the accumulated sum of all the samples in the histogram | +| [values](values.md) | `val values: `[`MutableMap`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-map/index.html)`<`[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`, `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`>`
a map containing the minimum bucket value mapped to the accumulated count | diff --git a/docs/api/mozilla.components.service.glean.histogram/-functional-histogram/log-base.md b/docs/api/mozilla.components.service.glean.histogram/-functional-histogram/log-base.md new file mode 100644 index 00000000000..e5570bf0f53 --- /dev/null +++ b/docs/api/mozilla.components.service.glean.histogram/-functional-histogram/log-base.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.glean.histogram](../index.md) / [FunctionalHistogram](index.md) / [logBase](./log-base.md) + +# logBase + +`val logBase: `[`Double`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/histogram/FunctionalHistogram.kt#L28) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.glean.storages/-timing-distribution-data/sum.md b/docs/api/mozilla.components.service.glean.histogram/-functional-histogram/sum.md similarity index 51% rename from docs/api/mozilla.components.service.glean.storages/-timing-distribution-data/sum.md rename to docs/api/mozilla.components.service.glean.histogram/-functional-histogram/sum.md index 4f5154bf101..15476e06dab 100644 --- a/docs/api/mozilla.components.service.glean.storages/-timing-distribution-data/sum.md +++ b/docs/api/mozilla.components.service.glean.histogram/-functional-histogram/sum.md @@ -1,8 +1,8 @@ -[android-components](../../index.md) / [mozilla.components.service.glean.storages](../index.md) / [TimingDistributionData](index.md) / [sum](./sum.md) +[android-components](../../index.md) / [mozilla.components.service.glean.histogram](../index.md) / [FunctionalHistogram](index.md) / [sum](./sum.md) # sum -`var sum: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/storages/TimingDistributionsStorageEngine.kt#L197) +`var sum: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/histogram/FunctionalHistogram.kt#L32) -the accumulated sum of all the samples in the timing distribution +the accumulated sum of all the samples in the histogram diff --git a/docs/api/mozilla.components.service.glean.storages/-timing-distribution-data/values.md b/docs/api/mozilla.components.service.glean.histogram/-functional-histogram/values.md similarity index 73% rename from docs/api/mozilla.components.service.glean.storages/-timing-distribution-data/values.md rename to docs/api/mozilla.components.service.glean.histogram/-functional-histogram/values.md index a791cd78126..064b963505c 100644 --- a/docs/api/mozilla.components.service.glean.storages/-timing-distribution-data/values.md +++ b/docs/api/mozilla.components.service.glean.histogram/-functional-histogram/values.md @@ -1,8 +1,8 @@ -[android-components](../../index.md) / [mozilla.components.service.glean.storages](../index.md) / [TimingDistributionData](index.md) / [values](./values.md) +[android-components](../../index.md) / [mozilla.components.service.glean.histogram](../index.md) / [FunctionalHistogram](index.md) / [values](./values.md) # values -`val values: `[`MutableMap`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-map/index.html)`<`[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`, `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/storages/TimingDistributionsStorageEngine.kt#L196) +`val values: `[`MutableMap`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-map/index.html)`<`[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`, `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/histogram/FunctionalHistogram.kt#L31) a map containing the minimum bucket value mapped to the accumulated count diff --git a/docs/api/mozilla.components.service.glean.histogram/-precomputed-histogram/-init-.md b/docs/api/mozilla.components.service.glean.histogram/-precomputed-histogram/-init-.md new file mode 100644 index 00000000000..a8739214334 --- /dev/null +++ b/docs/api/mozilla.components.service.glean.histogram/-precomputed-histogram/-init-.md @@ -0,0 +1,23 @@ +[android-components](../../index.md) / [mozilla.components.service.glean.histogram](../index.md) / [PrecomputedHistogram](index.md) / [<init>](./-init-.md) + +# <init> + +`PrecomputedHistogram(rangeMin: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`, rangeMax: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`, bucketCount: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, histogramType: `[`HistogramType`](../../mozilla.components.service.glean.private/-histogram-type/index.md)`, values: `[`MutableMap`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-map/index.html)`<`[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`, `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`> = mutableMapOf(), sum: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)` = 0)` + +This class represents the structure of a custom distribution. It is meant +to help serialize and deserialize data to the correct format for transport and +storage, as well as including helper functions to calculate the bucket sizes. + +### Parameters + +`rangeMin` - the minimum value that can be represented + +`rangeMax` - the maximum value that can be represented + +`bucketCount` - total number of buckets + +`histogramType` - the [HistogramType](../../mozilla.components.service.glean.private/-histogram-type/index.md) representing the bucket layout + +`values` - a map containing the bucket index mapped to the accumulated count + +`sum` - the accumulated sum of all the samples in the custom distribution \ No newline at end of file diff --git a/docs/api/mozilla.components.service.glean.storages/-custom-distribution-data/bucket-count.md b/docs/api/mozilla.components.service.glean.histogram/-precomputed-histogram/bucket-count.md similarity index 59% rename from docs/api/mozilla.components.service.glean.storages/-custom-distribution-data/bucket-count.md rename to docs/api/mozilla.components.service.glean.histogram/-precomputed-histogram/bucket-count.md index 2b2dceb1166..315f5b8e6de 100644 --- a/docs/api/mozilla.components.service.glean.storages/-custom-distribution-data/bucket-count.md +++ b/docs/api/mozilla.components.service.glean.histogram/-precomputed-histogram/bucket-count.md @@ -1,8 +1,8 @@ -[android-components](../../index.md) / [mozilla.components.service.glean.storages](../index.md) / [CustomDistributionData](index.md) / [bucketCount](./bucket-count.md) +[android-components](../../index.md) / [mozilla.components.service.glean.histogram](../index.md) / [PrecomputedHistogram](index.md) / [bucketCount](./bucket-count.md) # bucketCount -`val bucketCount: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/storages/CustomDistributionsStorageEngine.kt#L150) +`val bucketCount: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/histogram/PrecomputedHistogram.kt#L29) total number of buckets diff --git a/docs/api/mozilla.components.service.glean.storages/-custom-distribution-data/count.md b/docs/api/mozilla.components.service.glean.histogram/-precomputed-histogram/count.md similarity index 58% rename from docs/api/mozilla.components.service.glean.storages/-custom-distribution-data/count.md rename to docs/api/mozilla.components.service.glean.histogram/-precomputed-histogram/count.md index eb197d61710..a8af107099d 100644 --- a/docs/api/mozilla.components.service.glean.storages/-custom-distribution-data/count.md +++ b/docs/api/mozilla.components.service.glean.histogram/-precomputed-histogram/count.md @@ -1,5 +1,5 @@ -[android-components](../../index.md) / [mozilla.components.service.glean.storages](../index.md) / [CustomDistributionData](index.md) / [count](./count.md) +[android-components](../../index.md) / [mozilla.components.service.glean.histogram](../index.md) / [PrecomputedHistogram](index.md) / [count](./count.md) # count -`val count: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/storages/CustomDistributionsStorageEngine.kt#L232) \ No newline at end of file +`val count: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/histogram/PrecomputedHistogram.kt#L103) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.glean.storages/-custom-distribution-data/histogram-type.md b/docs/api/mozilla.components.service.glean.histogram/-precomputed-histogram/histogram-type.md similarity index 74% rename from docs/api/mozilla.components.service.glean.storages/-custom-distribution-data/histogram-type.md rename to docs/api/mozilla.components.service.glean.histogram/-precomputed-histogram/histogram-type.md index cb01ea6de63..929a62b84e6 100644 --- a/docs/api/mozilla.components.service.glean.storages/-custom-distribution-data/histogram-type.md +++ b/docs/api/mozilla.components.service.glean.histogram/-precomputed-histogram/histogram-type.md @@ -1,8 +1,8 @@ -[android-components](../../index.md) / [mozilla.components.service.glean.storages](../index.md) / [CustomDistributionData](index.md) / [histogramType](./histogram-type.md) +[android-components](../../index.md) / [mozilla.components.service.glean.histogram](../index.md) / [PrecomputedHistogram](index.md) / [histogramType](./histogram-type.md) # histogramType -`val histogramType: `[`HistogramType`](../../mozilla.components.service.glean.private/-histogram-type/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/storages/CustomDistributionsStorageEngine.kt#L151) +`val histogramType: `[`HistogramType`](../../mozilla.components.service.glean.private/-histogram-type/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/histogram/PrecomputedHistogram.kt#L30) the [HistogramType](../../mozilla.components.service.glean.private/-histogram-type/index.md) representing the bucket layout diff --git a/docs/api/mozilla.components.service.glean.histogram/-precomputed-histogram/index.md b/docs/api/mozilla.components.service.glean.histogram/-precomputed-histogram/index.md new file mode 100644 index 00000000000..d02f0fa9e81 --- /dev/null +++ b/docs/api/mozilla.components.service.glean.histogram/-precomputed-histogram/index.md @@ -0,0 +1,41 @@ +[android-components](../../index.md) / [mozilla.components.service.glean.histogram](../index.md) / [PrecomputedHistogram](./index.md) + +# PrecomputedHistogram + +`data class PrecomputedHistogram` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/histogram/PrecomputedHistogram.kt#L26) + +This class represents the structure of a custom distribution. It is meant +to help serialize and deserialize data to the correct format for transport and +storage, as well as including helper functions to calculate the bucket sizes. + +### Parameters + +`rangeMin` - the minimum value that can be represented + +`rangeMax` - the maximum value that can be represented + +`bucketCount` - total number of buckets + +`histogramType` - the [HistogramType](../../mozilla.components.service.glean.private/-histogram-type/index.md) representing the bucket layout + +`values` - a map containing the bucket index mapped to the accumulated count + +`sum` - the accumulated sum of all the samples in the custom distribution + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `PrecomputedHistogram(rangeMin: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`, rangeMax: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`, bucketCount: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, histogramType: `[`HistogramType`](../../mozilla.components.service.glean.private/-histogram-type/index.md)`, values: `[`MutableMap`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-map/index.html)`<`[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`, `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`> = mutableMapOf(), sum: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)` = 0)`
This class represents the structure of a custom distribution. It is meant to help serialize and deserialize data to the correct format for transport and storage, as well as including helper functions to calculate the bucket sizes. | + +### Properties + +| Name | Summary | +|---|---| +| [bucketCount](bucket-count.md) | `val bucketCount: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
total number of buckets | +| [count](count.md) | `val count: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) | +| [histogramType](histogram-type.md) | `val histogramType: `[`HistogramType`](../../mozilla.components.service.glean.private/-histogram-type/index.md)
the [HistogramType](../../mozilla.components.service.glean.private/-histogram-type/index.md) representing the bucket layout | +| [rangeMax](range-max.md) | `val rangeMax: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
the maximum value that can be represented | +| [rangeMin](range-min.md) | `val rangeMin: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
the minimum value that can be represented | +| [sum](sum.md) | `var sum: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
the accumulated sum of all the samples in the custom distribution | +| [values](values.md) | `val values: `[`MutableMap`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-map/index.html)`<`[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`, `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`>`
a map containing the bucket index mapped to the accumulated count | diff --git a/docs/api/mozilla.components.service.glean.storages/-custom-distribution-data/range-max.md b/docs/api/mozilla.components.service.glean.histogram/-precomputed-histogram/range-max.md similarity index 61% rename from docs/api/mozilla.components.service.glean.storages/-custom-distribution-data/range-max.md rename to docs/api/mozilla.components.service.glean.histogram/-precomputed-histogram/range-max.md index 5d056c91eaa..8ca2e096f95 100644 --- a/docs/api/mozilla.components.service.glean.storages/-custom-distribution-data/range-max.md +++ b/docs/api/mozilla.components.service.glean.histogram/-precomputed-histogram/range-max.md @@ -1,8 +1,8 @@ -[android-components](../../index.md) / [mozilla.components.service.glean.storages](../index.md) / [CustomDistributionData](index.md) / [rangeMax](./range-max.md) +[android-components](../../index.md) / [mozilla.components.service.glean.histogram](../index.md) / [PrecomputedHistogram](index.md) / [rangeMax](./range-max.md) # rangeMax -`val rangeMax: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/storages/CustomDistributionsStorageEngine.kt#L149) +`val rangeMax: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/histogram/PrecomputedHistogram.kt#L28) the maximum value that can be represented diff --git a/docs/api/mozilla.components.service.glean.storages/-custom-distribution-data/range-min.md b/docs/api/mozilla.components.service.glean.histogram/-precomputed-histogram/range-min.md similarity index 61% rename from docs/api/mozilla.components.service.glean.storages/-custom-distribution-data/range-min.md rename to docs/api/mozilla.components.service.glean.histogram/-precomputed-histogram/range-min.md index 31250fe566f..d7426b88085 100644 --- a/docs/api/mozilla.components.service.glean.storages/-custom-distribution-data/range-min.md +++ b/docs/api/mozilla.components.service.glean.histogram/-precomputed-histogram/range-min.md @@ -1,8 +1,8 @@ -[android-components](../../index.md) / [mozilla.components.service.glean.storages](../index.md) / [CustomDistributionData](index.md) / [rangeMin](./range-min.md) +[android-components](../../index.md) / [mozilla.components.service.glean.histogram](../index.md) / [PrecomputedHistogram](index.md) / [rangeMin](./range-min.md) # rangeMin -`val rangeMin: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/storages/CustomDistributionsStorageEngine.kt#L148) +`val rangeMin: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/histogram/PrecomputedHistogram.kt#L27) the minimum value that can be represented diff --git a/docs/api/mozilla.components.service.glean.storages/-custom-distribution-data/sum.md b/docs/api/mozilla.components.service.glean.histogram/-precomputed-histogram/sum.md similarity index 64% rename from docs/api/mozilla.components.service.glean.storages/-custom-distribution-data/sum.md rename to docs/api/mozilla.components.service.glean.histogram/-precomputed-histogram/sum.md index 9ecf4868774..5de708487ba 100644 --- a/docs/api/mozilla.components.service.glean.storages/-custom-distribution-data/sum.md +++ b/docs/api/mozilla.components.service.glean.histogram/-precomputed-histogram/sum.md @@ -1,8 +1,8 @@ -[android-components](../../index.md) / [mozilla.components.service.glean.storages](../index.md) / [CustomDistributionData](index.md) / [sum](./sum.md) +[android-components](../../index.md) / [mozilla.components.service.glean.histogram](../index.md) / [PrecomputedHistogram](index.md) / [sum](./sum.md) # sum -`var sum: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/storages/CustomDistributionsStorageEngine.kt#L154) +`var sum: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/histogram/PrecomputedHistogram.kt#L33) the accumulated sum of all the samples in the custom distribution diff --git a/docs/api/mozilla.components.service.glean.storages/-custom-distribution-data/values.md b/docs/api/mozilla.components.service.glean.histogram/-precomputed-histogram/values.md similarity index 73% rename from docs/api/mozilla.components.service.glean.storages/-custom-distribution-data/values.md rename to docs/api/mozilla.components.service.glean.histogram/-precomputed-histogram/values.md index d6613766c18..109c6073b09 100644 --- a/docs/api/mozilla.components.service.glean.storages/-custom-distribution-data/values.md +++ b/docs/api/mozilla.components.service.glean.histogram/-precomputed-histogram/values.md @@ -1,8 +1,8 @@ -[android-components](../../index.md) / [mozilla.components.service.glean.storages](../index.md) / [CustomDistributionData](index.md) / [values](./values.md) +[android-components](../../index.md) / [mozilla.components.service.glean.histogram](../index.md) / [PrecomputedHistogram](index.md) / [values](./values.md) # values -`val values: `[`MutableMap`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-map/index.html)`<`[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`, `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/storages/CustomDistributionsStorageEngine.kt#L153) +`val values: `[`MutableMap`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-map/index.html)`<`[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`, `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/histogram/PrecomputedHistogram.kt#L32) a map containing the bucket index mapped to the accumulated count diff --git a/docs/api/mozilla.components.service.glean.histogram/index.md b/docs/api/mozilla.components.service.glean.histogram/index.md new file mode 100644 index 00000000000..193b4ebe28e --- /dev/null +++ b/docs/api/mozilla.components.service.glean.histogram/index.md @@ -0,0 +1,10 @@ +[android-components](../index.md) / [mozilla.components.service.glean.histogram](./index.md) + +## Package mozilla.components.service.glean.histogram + +### Types + +| Name | Summary | +|---|---| +| [FunctionalHistogram](-functional-histogram/index.md) | `data class FunctionalHistogram`
This class represents a histogram where the bucketing is performed by a function, rather than pre-computed buckets. It is meant to help serialize and deserialize data to the correct format for transport and storage, as well as performing the calculations to determine the correct bucket for each sample. | +| [PrecomputedHistogram](-precomputed-histogram/index.md) | `data class PrecomputedHistogram`
This class represents the structure of a custom distribution. It is meant to help serialize and deserialize data to the correct format for transport and storage, as well as including helper functions to calculate the bucket sizes. | diff --git a/docs/api/mozilla.components.service.glean.private/-common-metric-data/index.md b/docs/api/mozilla.components.service.glean.private/-common-metric-data/index.md index 2946a2817ca..b92367cac15 100644 --- a/docs/api/mozilla.components.service.glean.private/-common-metric-data/index.md +++ b/docs/api/mozilla.components.service.glean.private/-common-metric-data/index.md @@ -30,12 +30,13 @@ metric types. |---|---| | [BooleanMetricType](../-boolean-metric-type/index.md) | `data class BooleanMetricType : `[`CommonMetricData`](./index.md)
This implements the developer facing API for recording boolean metrics. | | [CounterMetricType](../-counter-metric-type/index.md) | `data class CounterMetricType : `[`CommonMetricData`](./index.md)
This implements the developer facing API for recording counter metrics. | -| [CustomDistributionMetricType](../-custom-distribution-metric-type/index.md) | `data class CustomDistributionMetricType : `[`CommonMetricData`](./index.md)`, `[`HistogramBase`](../-histogram-base/index.md)
This implements the developer facing API for recording custom distribution metrics. | +| [CustomDistributionMetricType](../-custom-distribution-metric-type/index.md) | `data class CustomDistributionMetricType : `[`CommonMetricData`](./index.md)`, `[`HistogramMetricBase`](../-histogram-metric-base/index.md)
This implements the developer facing API for recording custom distribution metrics. | | [DatetimeMetricType](../-datetime-metric-type/index.md) | `data class DatetimeMetricType : `[`CommonMetricData`](./index.md)
This implements the developer facing API for recording datetime metrics. | | [EventMetricType](../-event-metric-type/index.md) | `data class EventMetricType> : `[`CommonMetricData`](./index.md)
This implements the developer facing API for recording events. | | [LabeledMetricType](../-labeled-metric-type/index.md) | `data class LabeledMetricType : `[`CommonMetricData`](./index.md)
This implements the developer facing API for labeled metrics. | +| [MemoryDistributionMetricType](../-memory-distribution-metric-type/index.md) | `data class MemoryDistributionMetricType : `[`CommonMetricData`](./index.md)`, `[`HistogramMetricBase`](../-histogram-metric-base/index.md)
This implements the developer facing API for recording memory distribution metrics. | | [StringListMetricType](../-string-list-metric-type/index.md) | `data class StringListMetricType : `[`CommonMetricData`](./index.md)
This implements the developer facing API for recording string list metrics. | | [StringMetricType](../-string-metric-type/index.md) | `data class StringMetricType : `[`CommonMetricData`](./index.md)
This implements the developer facing API for recording string metrics. | | [TimespanMetricType](../-timespan-metric-type/index.md) | `data class TimespanMetricType : `[`CommonMetricData`](./index.md)
This implements the developer facing API for recording timespans. | -| [TimingDistributionMetricType](../-timing-distribution-metric-type/index.md) | `data class TimingDistributionMetricType : `[`CommonMetricData`](./index.md)`, `[`HistogramBase`](../-histogram-base/index.md)
This implements the developer facing API for recording timing distribution metrics. | +| [TimingDistributionMetricType](../-timing-distribution-metric-type/index.md) | `data class TimingDistributionMetricType : `[`CommonMetricData`](./index.md)`, `[`HistogramMetricBase`](../-histogram-metric-base/index.md)
This implements the developer facing API for recording timing distribution metrics. | | [UuidMetricType](../-uuid-metric-type/index.md) | `data class UuidMetricType : `[`CommonMetricData`](./index.md)
This implements the developer facing API for recording uuids. | diff --git a/docs/api/mozilla.components.service.glean.private/-custom-distribution-metric-type/accumulate-samples.md b/docs/api/mozilla.components.service.glean.private/-custom-distribution-metric-type/accumulate-samples.md index a93b51ba507..baf2aa571e0 100644 --- a/docs/api/mozilla.components.service.glean.private/-custom-distribution-metric-type/accumulate-samples.md +++ b/docs/api/mozilla.components.service.glean.private/-custom-distribution-metric-type/accumulate-samples.md @@ -4,7 +4,7 @@ `fun accumulateSamples(samples: `[`LongArray`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long-array/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/private/CustomDistributionMetricType.kt#L53) -Overrides [HistogramBase.accumulateSamples](../-histogram-base/accumulate-samples.md) +Overrides [HistogramMetricBase.accumulateSamples](../-histogram-metric-base/accumulate-samples.md) Accumulates the provided samples in the metric. diff --git a/docs/api/mozilla.components.service.glean.private/-custom-distribution-metric-type/index.md b/docs/api/mozilla.components.service.glean.private/-custom-distribution-metric-type/index.md index 3ac4470c560..32fbb126c62 100644 --- a/docs/api/mozilla.components.service.glean.private/-custom-distribution-metric-type/index.md +++ b/docs/api/mozilla.components.service.glean.private/-custom-distribution-metric-type/index.md @@ -2,7 +2,7 @@ # CustomDistributionMetricType -`data class CustomDistributionMetricType : `[`CommonMetricData`](../-common-metric-data/index.md)`, `[`HistogramBase`](../-histogram-base/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/private/CustomDistributionMetricType.kt#L30) +`data class CustomDistributionMetricType : `[`CommonMetricData`](../-common-metric-data/index.md)`, `[`HistogramMetricBase`](../-histogram-metric-base/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/private/CustomDistributionMetricType.kt#L30) This implements the developer facing API for recording custom distribution metrics. @@ -53,7 +53,7 @@ allowing developers to record values that were previously registered in the metr | Name | Summary | |---|---| | [accumulateSamples](accumulate-samples.md) | `fun accumulateSamples(samples: `[`LongArray`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long-array/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Accumulates the provided samples in the metric. | -| [testGetValue](test-get-value.md) | `fun testGetValue(pingName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = sendInPings.first()): `[`CustomDistributionData`](../../mozilla.components.service.glean.storages/-custom-distribution-data/index.md)
Returns the stored value for testing purposes only. This function will attempt to await the last task (if any) writing to the the metric's storage engine before returning a value. | +| [testGetValue](test-get-value.md) | `fun testGetValue(pingName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = sendInPings.first()): `[`PrecomputedHistogram`](../../mozilla.components.service.glean.histogram/-precomputed-histogram/index.md)
Returns the stored value for testing purposes only. This function will attempt to await the last task (if any) writing to the the metric's storage engine before returning a value. | | [testHasValue](test-has-value.md) | `fun testHasValue(pingName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = sendInPings.first()): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Tests whether a value is stored for the metric for testing purposes only. This function will attempt to await the last task (if any) writing to the the metric's storage engine before returning a value. | ### Inherited Functions diff --git a/docs/api/mozilla.components.service.glean.private/-custom-distribution-metric-type/test-get-value.md b/docs/api/mozilla.components.service.glean.private/-custom-distribution-metric-type/test-get-value.md index 0d81ff4c66e..7781627ee79 100644 --- a/docs/api/mozilla.components.service.glean.private/-custom-distribution-metric-type/test-get-value.md +++ b/docs/api/mozilla.components.service.glean.private/-custom-distribution-metric-type/test-get-value.md @@ -2,7 +2,7 @@ # testGetValue -`fun testGetValue(pingName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = sendInPings.first()): `[`CustomDistributionData`](../../mozilla.components.service.glean.storages/-custom-distribution-data/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/private/CustomDistributionMetricType.kt#L100) +`fun testGetValue(pingName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = sendInPings.first()): `[`PrecomputedHistogram`](../../mozilla.components.service.glean.histogram/-precomputed-histogram/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/private/CustomDistributionMetricType.kt#L100) Returns the stored value for testing purposes only. This function will attempt to await the last task (if any) writing to the the metric's storage engine before returning a value. diff --git a/docs/api/mozilla.components.service.glean.private/-histogram-base/accumulate-samples.md b/docs/api/mozilla.components.service.glean.private/-histogram-metric-base/accumulate-samples.md similarity index 76% rename from docs/api/mozilla.components.service.glean.private/-histogram-base/accumulate-samples.md rename to docs/api/mozilla.components.service.glean.private/-histogram-metric-base/accumulate-samples.md index ab1d42f2317..69936a76c58 100644 --- a/docs/api/mozilla.components.service.glean.private/-histogram-base/accumulate-samples.md +++ b/docs/api/mozilla.components.service.glean.private/-histogram-metric-base/accumulate-samples.md @@ -1,8 +1,8 @@ -[android-components](../../index.md) / [mozilla.components.service.glean.private](../index.md) / [HistogramBase](index.md) / [accumulateSamples](./accumulate-samples.md) +[android-components](../../index.md) / [mozilla.components.service.glean.private](../index.md) / [HistogramMetricBase](index.md) / [accumulateSamples](./accumulate-samples.md) # accumulateSamples -`abstract fun accumulateSamples(samples: `[`LongArray`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long-array/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/private/HistogramBase.kt#L17) +`abstract fun accumulateSamples(samples: `[`LongArray`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long-array/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/private/HistogramMetricBase.kt#L17) Accumulates the provided samples in the metric. diff --git a/docs/api/mozilla.components.service.glean.private/-histogram-base/index.md b/docs/api/mozilla.components.service.glean.private/-histogram-metric-base/index.md similarity index 53% rename from docs/api/mozilla.components.service.glean.private/-histogram-base/index.md rename to docs/api/mozilla.components.service.glean.private/-histogram-metric-base/index.md index 9fd20f12e92..c2468c4f59c 100644 --- a/docs/api/mozilla.components.service.glean.private/-histogram-base/index.md +++ b/docs/api/mozilla.components.service.glean.private/-histogram-metric-base/index.md @@ -1,8 +1,8 @@ -[android-components](../../index.md) / [mozilla.components.service.glean.private](../index.md) / [HistogramBase](./index.md) +[android-components](../../index.md) / [mozilla.components.service.glean.private](../index.md) / [HistogramMetricBase](./index.md) -# HistogramBase +# HistogramMetricBase -`interface HistogramBase` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/private/HistogramBase.kt#L11) +`interface HistogramMetricBase` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/private/HistogramMetricBase.kt#L11) A common interface to be implemented by all the histogram-like metric types supported by the Glean SDK. @@ -17,5 +17,6 @@ supported by the Glean SDK. | Name | Summary | |---|---| -| [CustomDistributionMetricType](../-custom-distribution-metric-type/index.md) | `data class CustomDistributionMetricType : `[`CommonMetricData`](../-common-metric-data/index.md)`, `[`HistogramBase`](./index.md)
This implements the developer facing API for recording custom distribution metrics. | -| [TimingDistributionMetricType](../-timing-distribution-metric-type/index.md) | `data class TimingDistributionMetricType : `[`CommonMetricData`](../-common-metric-data/index.md)`, `[`HistogramBase`](./index.md)
This implements the developer facing API for recording timing distribution metrics. | +| [CustomDistributionMetricType](../-custom-distribution-metric-type/index.md) | `data class CustomDistributionMetricType : `[`CommonMetricData`](../-common-metric-data/index.md)`, `[`HistogramMetricBase`](./index.md)
This implements the developer facing API for recording custom distribution metrics. | +| [MemoryDistributionMetricType](../-memory-distribution-metric-type/index.md) | `data class MemoryDistributionMetricType : `[`CommonMetricData`](../-common-metric-data/index.md)`, `[`HistogramMetricBase`](./index.md)
This implements the developer facing API for recording memory distribution metrics. | +| [TimingDistributionMetricType](../-timing-distribution-metric-type/index.md) | `data class TimingDistributionMetricType : `[`CommonMetricData`](../-common-metric-data/index.md)`, `[`HistogramMetricBase`](./index.md)
This implements the developer facing API for recording timing distribution metrics. | diff --git a/docs/api/mozilla.components.service.glean.private/-memory-distribution-metric-type/-init-.md b/docs/api/mozilla.components.service.glean.private/-memory-distribution-metric-type/-init-.md new file mode 100644 index 00000000000..d49fc710f58 --- /dev/null +++ b/docs/api/mozilla.components.service.glean.private/-memory-distribution-metric-type/-init-.md @@ -0,0 +1,14 @@ +[android-components](../../index.md) / [mozilla.components.service.glean.private](../index.md) / [MemoryDistributionMetricType](index.md) / [<init>](./-init-.md) + +# <init> + +`MemoryDistributionMetricType(disabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`, category: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, lifetime: `[`Lifetime`](../-lifetime/index.md)`, name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, sendInPings: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>, memoryUnit: `[`MemoryUnit`](../-memory-unit/index.md)`)` + +This implements the developer facing API for recording memory distribution metrics. + +To prevent the number of buckets from being unbounded, values larger than 1 TB +are truncated to 1 TB. + +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. + diff --git a/docs/api/mozilla.components.service.glean.private/-memory-distribution-metric-type/accumulate-samples.md b/docs/api/mozilla.components.service.glean.private/-memory-distribution-metric-type/accumulate-samples.md new file mode 100644 index 00000000000..5cf68011d66 --- /dev/null +++ b/docs/api/mozilla.components.service.glean.private/-memory-distribution-metric-type/accumulate-samples.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.service.glean.private](../index.md) / [MemoryDistributionMetricType](index.md) / [accumulateSamples](./accumulate-samples.md) + +# accumulateSamples + +`fun accumulateSamples(samples: `[`LongArray`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long-array/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/private/MemoryDistributionMetricType.kt#L62) + +Overrides [HistogramMetricBase.accumulateSamples](../-histogram-metric-base/accumulate-samples.md) + +Accumulates the provided samples, in the unit specified by `memoryUnit`, +to the distribution. + +This function is intended for GeckoView use only. + +### Parameters + +`samples` - the [LongArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long-array/index.html) holding the samples to be recorded by the metric. \ No newline at end of file diff --git a/docs/api/mozilla.components.service.glean.private/-memory-distribution-metric-type/accumulate.md b/docs/api/mozilla.components.service.glean.private/-memory-distribution-metric-type/accumulate.md new file mode 100644 index 00000000000..d0ecfd1ea63 --- /dev/null +++ b/docs/api/mozilla.components.service.glean.private/-memory-distribution-metric-type/accumulate.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.service.glean.private](../index.md) / [MemoryDistributionMetricType](index.md) / [accumulate](./accumulate.md) + +# accumulate + +`fun accumulate(sample: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/private/MemoryDistributionMetricType.kt#L38) + +Record a single value, in the unit specified by `memoryUnit`, to the distribution. + +### Parameters + +`sample` - the value \ No newline at end of file diff --git a/docs/api/mozilla.components.service.glean.private/-memory-distribution-metric-type/category.md b/docs/api/mozilla.components.service.glean.private/-memory-distribution-metric-type/category.md new file mode 100644 index 00000000000..f93fa2de629 --- /dev/null +++ b/docs/api/mozilla.components.service.glean.private/-memory-distribution-metric-type/category.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.glean.private](../index.md) / [MemoryDistributionMetricType](index.md) / [category](./category.md) + +# category + +`val category: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/private/MemoryDistributionMetricType.kt#L24) + +Overrides [CommonMetricData.category](../-common-metric-data/category.md) + diff --git a/docs/api/mozilla.components.service.glean.private/-memory-distribution-metric-type/disabled.md b/docs/api/mozilla.components.service.glean.private/-memory-distribution-metric-type/disabled.md new file mode 100644 index 00000000000..6fa456c2053 --- /dev/null +++ b/docs/api/mozilla.components.service.glean.private/-memory-distribution-metric-type/disabled.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.glean.private](../index.md) / [MemoryDistributionMetricType](index.md) / [disabled](./disabled.md) + +# disabled + +`val disabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/private/MemoryDistributionMetricType.kt#L23) + +Overrides [CommonMetricData.disabled](../-common-metric-data/disabled.md) + diff --git a/docs/api/mozilla.components.service.glean.private/-memory-distribution-metric-type/index.md b/docs/api/mozilla.components.service.glean.private/-memory-distribution-metric-type/index.md new file mode 100644 index 00000000000..9b02b3b621e --- /dev/null +++ b/docs/api/mozilla.components.service.glean.private/-memory-distribution-metric-type/index.md @@ -0,0 +1,51 @@ +[android-components](../../index.md) / [mozilla.components.service.glean.private](../index.md) / [MemoryDistributionMetricType](./index.md) + +# MemoryDistributionMetricType + +`data class MemoryDistributionMetricType : `[`CommonMetricData`](../-common-metric-data/index.md)`, `[`HistogramMetricBase`](../-histogram-metric-base/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/private/MemoryDistributionMetricType.kt#L22) + +This implements the developer facing API for recording memory distribution metrics. + +To prevent the number of buckets from being unbounded, values larger than 1 TB +are truncated to 1 TB. + +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. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `MemoryDistributionMetricType(disabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`, category: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, lifetime: `[`Lifetime`](../-lifetime/index.md)`, name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, sendInPings: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>, memoryUnit: `[`MemoryUnit`](../-memory-unit/index.md)`)`
This implements the developer facing API for recording memory distribution metrics. | + +### Properties + +| Name | Summary | +|---|---| +| [category](category.md) | `val category: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [disabled](disabled.md) | `val disabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [lifetime](lifetime.md) | `val lifetime: `[`Lifetime`](../-lifetime/index.md) | +| [memoryUnit](memory-unit.md) | `val memoryUnit: `[`MemoryUnit`](../-memory-unit/index.md) | +| [name](name.md) | `val name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [sendInPings](send-in-pings.md) | `val sendInPings: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>` | + +### Inherited Properties + +| Name | Summary | +|---|---| +| [identifier](../-common-metric-data/identifier.md) | `open val identifier: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + +### Functions + +| Name | Summary | +|---|---| +| [accumulate](accumulate.md) | `fun accumulate(sample: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Record a single value, in the unit specified by `memoryUnit`, to the distribution. | +| [accumulateSamples](accumulate-samples.md) | `fun accumulateSamples(samples: `[`LongArray`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long-array/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Accumulates the provided samples, in the unit specified by `memoryUnit`, to the distribution. | +| [testGetValue](test-get-value.md) | `fun testGetValue(pingName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = sendInPings.first()): `[`FunctionalHistogram`](../../mozilla.components.service.glean.histogram/-functional-histogram/index.md)
Returns the stored value for testing purposes only. This function will attempt to await the last task (if any) writing to the the metric's storage engine before returning a value. | +| [testHasValue](test-has-value.md) | `fun testHasValue(pingName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = sendInPings.first()): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Tests whether a value is stored for the metric for testing purposes only. This function will attempt to await the last task (if any) writing to the the metric's storage engine before returning a value. | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [shouldRecord](../-common-metric-data/should-record.md) | `open fun shouldRecord(logger: `[`Logger`](../../mozilla.components.support.base.log.logger/-logger/index.md)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | diff --git a/docs/api/mozilla.components.service.glean.private/-memory-distribution-metric-type/lifetime.md b/docs/api/mozilla.components.service.glean.private/-memory-distribution-metric-type/lifetime.md new file mode 100644 index 00000000000..e93addd59ab --- /dev/null +++ b/docs/api/mozilla.components.service.glean.private/-memory-distribution-metric-type/lifetime.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.glean.private](../index.md) / [MemoryDistributionMetricType](index.md) / [lifetime](./lifetime.md) + +# lifetime + +`val lifetime: `[`Lifetime`](../-lifetime/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/private/MemoryDistributionMetricType.kt#L25) + +Overrides [CommonMetricData.lifetime](../-common-metric-data/lifetime.md) + diff --git a/docs/api/mozilla.components.service.glean.private/-memory-distribution-metric-type/memory-unit.md b/docs/api/mozilla.components.service.glean.private/-memory-distribution-metric-type/memory-unit.md new file mode 100644 index 00000000000..5f2cc9bdc84 --- /dev/null +++ b/docs/api/mozilla.components.service.glean.private/-memory-distribution-metric-type/memory-unit.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.glean.private](../index.md) / [MemoryDistributionMetricType](index.md) / [memoryUnit](./memory-unit.md) + +# memoryUnit + +`val memoryUnit: `[`MemoryUnit`](../-memory-unit/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/private/MemoryDistributionMetricType.kt#L28) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.glean.storages/-custom-distribution-data/name.md b/docs/api/mozilla.components.service.glean.private/-memory-distribution-metric-type/name.md similarity index 51% rename from docs/api/mozilla.components.service.glean.storages/-custom-distribution-data/name.md rename to docs/api/mozilla.components.service.glean.private/-memory-distribution-metric-type/name.md index 308e103253e..950eda457b8 100644 --- a/docs/api/mozilla.components.service.glean.storages/-custom-distribution-data/name.md +++ b/docs/api/mozilla.components.service.glean.private/-memory-distribution-metric-type/name.md @@ -1,8 +1,8 @@ -[android-components](../../index.md) / [mozilla.components.service.glean.storages](../index.md) / [CustomDistributionData](index.md) / [name](./name.md) +[android-components](../../index.md) / [mozilla.components.service.glean.private](../index.md) / [MemoryDistributionMetricType](index.md) / [name](./name.md) # name -`val name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/storages/CustomDistributionsStorageEngine.kt#L147) +`val name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/private/MemoryDistributionMetricType.kt#L26) -of the metric +Overrides [CommonMetricData.name](../-common-metric-data/name.md) diff --git a/docs/api/mozilla.components.service.glean.private/-memory-distribution-metric-type/send-in-pings.md b/docs/api/mozilla.components.service.glean.private/-memory-distribution-metric-type/send-in-pings.md new file mode 100644 index 00000000000..35aca6aed6f --- /dev/null +++ b/docs/api/mozilla.components.service.glean.private/-memory-distribution-metric-type/send-in-pings.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.glean.private](../index.md) / [MemoryDistributionMetricType](index.md) / [sendInPings](./send-in-pings.md) + +# sendInPings + +`val sendInPings: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/private/MemoryDistributionMetricType.kt#L27) + +Overrides [CommonMetricData.sendInPings](../-common-metric-data/send-in-pings.md) + diff --git a/docs/api/mozilla.components.service.glean.private/-memory-distribution-metric-type/test-get-value.md b/docs/api/mozilla.components.service.glean.private/-memory-distribution-metric-type/test-get-value.md new file mode 100644 index 00000000000..bd7b438e5fc --- /dev/null +++ b/docs/api/mozilla.components.service.glean.private/-memory-distribution-metric-type/test-get-value.md @@ -0,0 +1,22 @@ +[android-components](../../index.md) / [mozilla.components.service.glean.private](../index.md) / [MemoryDistributionMetricType](index.md) / [testGetValue](./test-get-value.md) + +# testGetValue + +`fun testGetValue(pingName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = sendInPings.first()): `[`FunctionalHistogram`](../../mozilla.components.service.glean.histogram/-functional-histogram/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/private/MemoryDistributionMetricType.kt#L106) + +Returns the stored value for testing purposes only. This function will attempt to await the +last task (if any) writing to the the metric's storage engine before returning a value. + +### Parameters + +`pingName` - represents the name of the ping to retrieve the metric for. Defaults + to the either the first value in [defaultStorageDestinations](#) or the first + value in [sendInPings](send-in-pings.md) + +### Exceptions + +`NullPointerException` - if no value is stored + +**Return** +value of the stored metric + diff --git a/docs/api/mozilla.components.service.glean.private/-memory-distribution-metric-type/test-has-value.md b/docs/api/mozilla.components.service.glean.private/-memory-distribution-metric-type/test-has-value.md new file mode 100644 index 00000000000..f9475689e18 --- /dev/null +++ b/docs/api/mozilla.components.service.glean.private/-memory-distribution-metric-type/test-has-value.md @@ -0,0 +1,19 @@ +[android-components](../../index.md) / [mozilla.components.service.glean.private](../index.md) / [MemoryDistributionMetricType](index.md) / [testHasValue](./test-has-value.md) + +# testHasValue + +`fun testHasValue(pingName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = sendInPings.first()): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/private/MemoryDistributionMetricType.kt#L88) + +Tests whether a value is stored for the metric for testing purposes only. This function will +attempt to await the last task (if any) writing to the the metric's storage engine before +returning a value. + +### Parameters + +`pingName` - represents the name of the ping to retrieve the metric for. Defaults + to the either the first value in [defaultStorageDestinations](#) or the first + value in [sendInPings](send-in-pings.md) + +**Return** +true if metric value exists, otherwise false + diff --git a/docs/api/mozilla.components.service.glean.private/-memory-unit/-byte.md b/docs/api/mozilla.components.service.glean.private/-memory-unit/-byte.md new file mode 100644 index 00000000000..bfb5ec47d9a --- /dev/null +++ b/docs/api/mozilla.components.service.glean.private/-memory-unit/-byte.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.glean.private](../index.md) / [MemoryUnit](index.md) / [Byte](./-byte.md) + +# Byte + +`Byte` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/private/MemoryUnit.kt#L13) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.glean.private/-memory-unit/-gigabyte.md b/docs/api/mozilla.components.service.glean.private/-memory-unit/-gigabyte.md new file mode 100644 index 00000000000..3f34f7f0f7d --- /dev/null +++ b/docs/api/mozilla.components.service.glean.private/-memory-unit/-gigabyte.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.glean.private](../index.md) / [MemoryUnit](index.md) / [Gigabyte](./-gigabyte.md) + +# Gigabyte + +`Gigabyte` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/private/MemoryUnit.kt#L16) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.glean.private/-memory-unit/-kilobyte.md b/docs/api/mozilla.components.service.glean.private/-memory-unit/-kilobyte.md new file mode 100644 index 00000000000..368d0b073e3 --- /dev/null +++ b/docs/api/mozilla.components.service.glean.private/-memory-unit/-kilobyte.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.glean.private](../index.md) / [MemoryUnit](index.md) / [Kilobyte](./-kilobyte.md) + +# Kilobyte + +`Kilobyte` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/private/MemoryUnit.kt#L14) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.glean.private/-memory-unit/-megabyte.md b/docs/api/mozilla.components.service.glean.private/-memory-unit/-megabyte.md new file mode 100644 index 00000000000..a1751808c69 --- /dev/null +++ b/docs/api/mozilla.components.service.glean.private/-memory-unit/-megabyte.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.glean.private](../index.md) / [MemoryUnit](index.md) / [Megabyte](./-megabyte.md) + +# Megabyte + +`Megabyte` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/private/MemoryUnit.kt#L15) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.glean.private/-memory-unit/index.md b/docs/api/mozilla.components.service.glean.private/-memory-unit/index.md new file mode 100644 index 00000000000..f55af417b23 --- /dev/null +++ b/docs/api/mozilla.components.service.glean.private/-memory-unit/index.md @@ -0,0 +1,18 @@ +[android-components](../../index.md) / [mozilla.components.service.glean.private](../index.md) / [MemoryUnit](./index.md) + +# MemoryUnit + +`enum class MemoryUnit` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/private/MemoryUnit.kt#L12) + +Enumeration of different resolutions supported by the MemoryDistribution metric type. + +These use the power-of-2 values of these units, that is, Kilobyte is pedantically a Kibibyte. + +### Enum Values + +| Name | Summary | +|---|---| +| [Byte](-byte.md) | | +| [Kilobyte](-kilobyte.md) | | +| [Megabyte](-megabyte.md) | | +| [Gigabyte](-gigabyte.md) | | diff --git a/docs/api/mozilla.components.service.glean.private/-timing-distribution-metric-type/accumulate-samples.md b/docs/api/mozilla.components.service.glean.private/-timing-distribution-metric-type/accumulate-samples.md index 908ef96fcd7..eb4de749bd0 100644 --- a/docs/api/mozilla.components.service.glean.private/-timing-distribution-metric-type/accumulate-samples.md +++ b/docs/api/mozilla.components.service.glean.private/-timing-distribution-metric-type/accumulate-samples.md @@ -4,7 +4,7 @@ `fun accumulateSamples(samples: `[`LongArray`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long-array/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/private/TimingDistributionMetricType.kt#L105) -Overrides [HistogramBase.accumulateSamples](../-histogram-base/accumulate-samples.md) +Overrides [HistogramMetricBase.accumulateSamples](../-histogram-metric-base/accumulate-samples.md) Accumulates the provided samples in the metric. diff --git a/docs/api/mozilla.components.service.glean.private/-timing-distribution-metric-type/index.md b/docs/api/mozilla.components.service.glean.private/-timing-distribution-metric-type/index.md index 7fec343be66..032dd7d28ab 100644 --- a/docs/api/mozilla.components.service.glean.private/-timing-distribution-metric-type/index.md +++ b/docs/api/mozilla.components.service.glean.private/-timing-distribution-metric-type/index.md @@ -2,7 +2,7 @@ # TimingDistributionMetricType -`data class TimingDistributionMetricType : `[`CommonMetricData`](../-common-metric-data/index.md)`, `[`HistogramBase`](../-histogram-base/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/private/TimingDistributionMetricType.kt#L28) +`data class TimingDistributionMetricType : `[`CommonMetricData`](../-common-metric-data/index.md)`, `[`HistogramMetricBase`](../-histogram-metric-base/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/private/TimingDistributionMetricType.kt#L28) This implements the developer facing API for recording timing distribution metrics. @@ -47,7 +47,7 @@ allowing developers to record values that were previously registered in the metr | [cancel](cancel.md) | `fun cancel(timerId: `[`GleanTimerId`](../../mozilla.components.service.glean.timing/-glean-timer-id.md)`?): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Abort a previous [start](start.md) call. No error is recorded if no [start](start.md) was called. | | [start](start.md) | `fun start(): `[`GleanTimerId`](../../mozilla.components.service.glean.timing/-glean-timer-id.md)`?`
Start tracking time for the provided metric and [GleanTimerId](../../mozilla.components.service.glean.timing/-glean-timer-id.md). This records an error if it’s already tracking time (i.e. start was already called with no corresponding [stopAndAccumulate](stop-and-accumulate.md)): in that case the original start time will be preserved. | | [stopAndAccumulate](stop-and-accumulate.md) | `fun stopAndAccumulate(timerId: `[`GleanTimerId`](../../mozilla.components.service.glean.timing/-glean-timer-id.md)`?): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Stop tracking time for the provided metric and associated timer id. Add a count to the corresponding bucket in the timing distribution. This will record an error if no [start](start.md) was called. | -| [testGetValue](test-get-value.md) | `fun testGetValue(pingName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = sendInPings.first()): `[`TimingDistributionData`](../../mozilla.components.service.glean.storages/-timing-distribution-data/index.md)
Returns the stored value for testing purposes only. This function will attempt to await the last task (if any) writing to the the metric's storage engine before returning a value. | +| [testGetValue](test-get-value.md) | `fun testGetValue(pingName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = sendInPings.first()): `[`FunctionalHistogram`](../../mozilla.components.service.glean.histogram/-functional-histogram/index.md)
Returns the stored value for testing purposes only. This function will attempt to await the last task (if any) writing to the the metric's storage engine before returning a value. | | [testHasValue](test-has-value.md) | `fun testHasValue(pingName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = sendInPings.first()): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Tests whether a value is stored for the metric for testing purposes only. This function will attempt to await the last task (if any) writing to the the metric's storage engine before returning a value. | ### Inherited Functions diff --git a/docs/api/mozilla.components.service.glean.private/-timing-distribution-metric-type/test-get-value.md b/docs/api/mozilla.components.service.glean.private/-timing-distribution-metric-type/test-get-value.md index 88fc0d26264..f9e9e9ca0ba 100644 --- a/docs/api/mozilla.components.service.glean.private/-timing-distribution-metric-type/test-get-value.md +++ b/docs/api/mozilla.components.service.glean.private/-timing-distribution-metric-type/test-get-value.md @@ -2,7 +2,7 @@ # testGetValue -`fun testGetValue(pingName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = sendInPings.first()): `[`TimingDistributionData`](../../mozilla.components.service.glean.storages/-timing-distribution-data/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/private/TimingDistributionMetricType.kt#L149) +`fun testGetValue(pingName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = sendInPings.first()): `[`FunctionalHistogram`](../../mozilla.components.service.glean.histogram/-functional-histogram/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/private/TimingDistributionMetricType.kt#L149) Returns the stored value for testing purposes only. This function will attempt to await the last task (if any) writing to the the metric's storage engine before returning a value. diff --git a/docs/api/mozilla.components.service.glean.private/index.md b/docs/api/mozilla.components.service.glean.private/index.md index 00983ffbeda..a019aa4b115 100644 --- a/docs/api/mozilla.components.service.glean.private/index.md +++ b/docs/api/mozilla.components.service.glean.private/index.md @@ -9,18 +9,20 @@ | [BooleanMetricType](-boolean-metric-type/index.md) | `data class BooleanMetricType : `[`CommonMetricData`](-common-metric-data/index.md)
This implements the developer facing API for recording boolean metrics. | | [CommonMetricData](-common-metric-data/index.md) | `interface CommonMetricData`
This defines the common set of data shared across all the different metric types. | | [CounterMetricType](-counter-metric-type/index.md) | `data class CounterMetricType : `[`CommonMetricData`](-common-metric-data/index.md)
This implements the developer facing API for recording counter metrics. | -| [CustomDistributionMetricType](-custom-distribution-metric-type/index.md) | `data class CustomDistributionMetricType : `[`CommonMetricData`](-common-metric-data/index.md)`, `[`HistogramBase`](-histogram-base/index.md)
This implements the developer facing API for recording custom distribution metrics. | +| [CustomDistributionMetricType](-custom-distribution-metric-type/index.md) | `data class CustomDistributionMetricType : `[`CommonMetricData`](-common-metric-data/index.md)`, `[`HistogramMetricBase`](-histogram-metric-base/index.md)
This implements the developer facing API for recording custom distribution metrics. | | [DatetimeMetricType](-datetime-metric-type/index.md) | `data class DatetimeMetricType : `[`CommonMetricData`](-common-metric-data/index.md)
This implements the developer facing API for recording datetime metrics. | | [EventMetricType](-event-metric-type/index.md) | `data class EventMetricType> : `[`CommonMetricData`](-common-metric-data/index.md)
This implements the developer facing API for recording events. | -| [HistogramBase](-histogram-base/index.md) | `interface HistogramBase`
A common interface to be implemented by all the histogram-like metric types supported by the Glean SDK. | +| [HistogramMetricBase](-histogram-metric-base/index.md) | `interface HistogramMetricBase`
A common interface to be implemented by all the histogram-like metric types supported by the Glean SDK. | | [HistogramType](-histogram-type/index.md) | `enum class HistogramType`
Enumeration of the different kinds of histograms supported by metrics based on histograms. | | [LabeledMetricType](-labeled-metric-type/index.md) | `data class LabeledMetricType : `[`CommonMetricData`](-common-metric-data/index.md)
This implements the developer facing API for labeled metrics. | | [Lifetime](-lifetime/index.md) | `enum class Lifetime`
Enumeration of different metric lifetimes. | +| [MemoryDistributionMetricType](-memory-distribution-metric-type/index.md) | `data class MemoryDistributionMetricType : `[`CommonMetricData`](-common-metric-data/index.md)`, `[`HistogramMetricBase`](-histogram-metric-base/index.md)
This implements the developer facing API for recording memory distribution metrics. | +| [MemoryUnit](-memory-unit/index.md) | `enum class MemoryUnit`
Enumeration of different resolutions supported by the MemoryDistribution metric type. | | [NoExtraKeys](-no-extra-keys/index.md) | `enum class NoExtraKeys`
An enum with no values for convenient use as the default set of extra keys that an [EventMetricType](-event-metric-type/index.md) can accept. | | [PingType](-ping-type/index.md) | `data class PingType`
This implements the developer facing API for custom pings. | | [StringListMetricType](-string-list-metric-type/index.md) | `data class StringListMetricType : `[`CommonMetricData`](-common-metric-data/index.md)
This implements the developer facing API for recording string list metrics. | | [StringMetricType](-string-metric-type/index.md) | `data class StringMetricType : `[`CommonMetricData`](-common-metric-data/index.md)
This implements the developer facing API for recording string metrics. | | [TimeUnit](-time-unit/index.md) | `enum class TimeUnit`
Enumeration of different resolutions supported by the Timespan and TimingDistribution metric types. | | [TimespanMetricType](-timespan-metric-type/index.md) | `data class TimespanMetricType : `[`CommonMetricData`](-common-metric-data/index.md)
This implements the developer facing API for recording timespans. | -| [TimingDistributionMetricType](-timing-distribution-metric-type/index.md) | `data class TimingDistributionMetricType : `[`CommonMetricData`](-common-metric-data/index.md)`, `[`HistogramBase`](-histogram-base/index.md)
This implements the developer facing API for recording timing distribution metrics. | +| [TimingDistributionMetricType](-timing-distribution-metric-type/index.md) | `data class TimingDistributionMetricType : `[`CommonMetricData`](-common-metric-data/index.md)`, `[`HistogramMetricBase`](-histogram-metric-base/index.md)
This implements the developer facing API for recording timing distribution metrics. | | [UuidMetricType](-uuid-metric-type/index.md) | `data class UuidMetricType : `[`CommonMetricData`](-common-metric-data/index.md)
This implements the developer facing API for recording uuids. | diff --git a/docs/api/mozilla.components.service.glean.storages/-custom-distribution-data/-init-.md b/docs/api/mozilla.components.service.glean.storages/-custom-distribution-data/-init-.md deleted file mode 100644 index 9d6f1abda05..00000000000 --- a/docs/api/mozilla.components.service.glean.storages/-custom-distribution-data/-init-.md +++ /dev/null @@ -1,27 +0,0 @@ -[android-components](../../index.md) / [mozilla.components.service.glean.storages](../index.md) / [CustomDistributionData](index.md) / [<init>](./-init-.md) - -# <init> - -`CustomDistributionData(category: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, rangeMin: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`, rangeMax: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`, bucketCount: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, histogramType: `[`HistogramType`](../../mozilla.components.service.glean.private/-histogram-type/index.md)`, values: `[`MutableMap`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-map/index.html)`<`[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`, `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`> = mutableMapOf(), sum: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)` = 0)` - -This class represents the structure of a custom distribution according to the pipeline schema. It -is meant to help serialize and deserialize data to the correct format for transport and storage, -as well as including a helper function to calculate the bucket sizes. - -### Parameters - -`category` - of the metric - -`name` - of the metric - -`bucketCount` - total number of buckets - -`rangeMin` - the minimum value that can be represented - -`rangeMax` - the maximum value that can be represented - -`histogramType` - the [HistogramType](../../mozilla.components.service.glean.private/-histogram-type/index.md) representing the bucket layout - -`values` - a map containing the bucket index mapped to the accumulated count - -`sum` - the accumulated sum of all the samples in the custom distribution \ No newline at end of file diff --git a/docs/api/mozilla.components.service.glean.storages/-custom-distribution-data/category.md b/docs/api/mozilla.components.service.glean.storages/-custom-distribution-data/category.md deleted file mode 100644 index 1edec934a35..00000000000 --- a/docs/api/mozilla.components.service.glean.storages/-custom-distribution-data/category.md +++ /dev/null @@ -1,8 +0,0 @@ -[android-components](../../index.md) / [mozilla.components.service.glean.storages](../index.md) / [CustomDistributionData](index.md) / [category](./category.md) - -# category - -`val category: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/storages/CustomDistributionsStorageEngine.kt#L146) - -of the metric - diff --git a/docs/api/mozilla.components.service.glean.storages/-custom-distribution-data/index.md b/docs/api/mozilla.components.service.glean.storages/-custom-distribution-data/index.md deleted file mode 100644 index bd633eaae43..00000000000 --- a/docs/api/mozilla.components.service.glean.storages/-custom-distribution-data/index.md +++ /dev/null @@ -1,47 +0,0 @@ -[android-components](../../index.md) / [mozilla.components.service.glean.storages](../index.md) / [CustomDistributionData](./index.md) - -# CustomDistributionData - -`data class CustomDistributionData` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/storages/CustomDistributionsStorageEngine.kt#L145) - -This class represents the structure of a custom distribution according to the pipeline schema. It -is meant to help serialize and deserialize data to the correct format for transport and storage, -as well as including a helper function to calculate the bucket sizes. - -### Parameters - -`category` - of the metric - -`name` - of the metric - -`bucketCount` - total number of buckets - -`rangeMin` - the minimum value that can be represented - -`rangeMax` - the maximum value that can be represented - -`histogramType` - the [HistogramType](../../mozilla.components.service.glean.private/-histogram-type/index.md) representing the bucket layout - -`values` - a map containing the bucket index mapped to the accumulated count - -`sum` - the accumulated sum of all the samples in the custom distribution - -### Constructors - -| Name | Summary | -|---|---| -| [<init>](-init-.md) | `CustomDistributionData(category: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, rangeMin: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`, rangeMax: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`, bucketCount: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, histogramType: `[`HistogramType`](../../mozilla.components.service.glean.private/-histogram-type/index.md)`, values: `[`MutableMap`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-map/index.html)`<`[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`, `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`> = mutableMapOf(), sum: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)` = 0)`
This class represents the structure of a custom distribution according to the pipeline schema. It is meant to help serialize and deserialize data to the correct format for transport and storage, as well as including a helper function to calculate the bucket sizes. | - -### Properties - -| Name | Summary | -|---|---| -| [bucketCount](bucket-count.md) | `val bucketCount: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
total number of buckets | -| [category](category.md) | `val category: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
of the metric | -| [count](count.md) | `val count: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) | -| [histogramType](histogram-type.md) | `val histogramType: `[`HistogramType`](../../mozilla.components.service.glean.private/-histogram-type/index.md)
the [HistogramType](../../mozilla.components.service.glean.private/-histogram-type/index.md) representing the bucket layout | -| [name](name.md) | `val name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
of the metric | -| [rangeMax](range-max.md) | `val rangeMax: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
the maximum value that can be represented | -| [rangeMin](range-min.md) | `val rangeMin: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
the minimum value that can be represented | -| [sum](sum.md) | `var sum: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
the accumulated sum of all the samples in the custom distribution | -| [values](values.md) | `val values: `[`MutableMap`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-map/index.html)`<`[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`, `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`>`
a map containing the bucket index mapped to the accumulated count | diff --git a/docs/api/mozilla.components.service.glean.storages/-timing-distribution-data/-init-.md b/docs/api/mozilla.components.service.glean.storages/-timing-distribution-data/-init-.md deleted file mode 100644 index a145067c04b..00000000000 --- a/docs/api/mozilla.components.service.glean.storages/-timing-distribution-data/-init-.md +++ /dev/null @@ -1,32 +0,0 @@ -[android-components](../../index.md) / [mozilla.components.service.glean.storages](../index.md) / [TimingDistributionData](index.md) / [<init>](./-init-.md) - -# <init> - -`TimingDistributionData(category: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, values: `[`MutableMap`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-map/index.html)`<`[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`, `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`> = mutableMapOf(), sum: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)` = 0)` - -This class represents the structure of a timing distribution according to the pipeline schema. It -is meant to help serialize and deserialize data to the correct format for transport and storage, -as well as performing the calculations to determine the correct bucket for each sample. - -The bucket index of a given sample is determined with the following function: - -``` - i = ⌊n log₂(𝑥)⌋ -``` - -In other words, there are n buckets for each power of 2 magnitude. - -The value of 8 for n was determined experimentally based on existing data to have sufficient -resolution. - -Samples greater than 10 minutes in length are truncated to 10 minutes. - -### Parameters - -`category` - of the metric - -`name` - of the metric - -`values` - a map containing the minimum bucket value mapped to the accumulated count - -`sum` - the accumulated sum of all the samples in the timing distribution \ No newline at end of file diff --git a/docs/api/mozilla.components.service.glean.storages/-timing-distribution-data/category.md b/docs/api/mozilla.components.service.glean.storages/-timing-distribution-data/category.md deleted file mode 100644 index 414a2aef854..00000000000 --- a/docs/api/mozilla.components.service.glean.storages/-timing-distribution-data/category.md +++ /dev/null @@ -1,8 +0,0 @@ -[android-components](../../index.md) / [mozilla.components.service.glean.storages](../index.md) / [TimingDistributionData](index.md) / [category](./category.md) - -# category - -`val category: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/storages/TimingDistributionsStorageEngine.kt#L193) - -of the metric - diff --git a/docs/api/mozilla.components.service.glean.storages/-timing-distribution-data/index.md b/docs/api/mozilla.components.service.glean.storages/-timing-distribution-data/index.md deleted file mode 100644 index f6fe2163587..00000000000 --- a/docs/api/mozilla.components.service.glean.storages/-timing-distribution-data/index.md +++ /dev/null @@ -1,48 +0,0 @@ -[android-components](../../index.md) / [mozilla.components.service.glean.storages](../index.md) / [TimingDistributionData](./index.md) - -# TimingDistributionData - -`data class TimingDistributionData` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/storages/TimingDistributionsStorageEngine.kt#L192) - -This class represents the structure of a timing distribution according to the pipeline schema. It -is meant to help serialize and deserialize data to the correct format for transport and storage, -as well as performing the calculations to determine the correct bucket for each sample. - -The bucket index of a given sample is determined with the following function: - -``` - i = ⌊n log₂(𝑥)⌋ -``` - -In other words, there are n buckets for each power of 2 magnitude. - -The value of 8 for n was determined experimentally based on existing data to have sufficient -resolution. - -Samples greater than 10 minutes in length are truncated to 10 minutes. - -### Parameters - -`category` - of the metric - -`name` - of the metric - -`values` - a map containing the minimum bucket value mapped to the accumulated count - -`sum` - the accumulated sum of all the samples in the timing distribution - -### Constructors - -| Name | Summary | -|---|---| -| [<init>](-init-.md) | `TimingDistributionData(category: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, values: `[`MutableMap`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-map/index.html)`<`[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`, `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`> = mutableMapOf(), sum: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)` = 0)`
This class represents the structure of a timing distribution according to the pipeline schema. It is meant to help serialize and deserialize data to the correct format for transport and storage, as well as performing the calculations to determine the correct bucket for each sample. | - -### Properties - -| Name | Summary | -|---|---| -| [category](category.md) | `val category: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
of the metric | -| [count](count.md) | `val count: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) | -| [name](name.md) | `val name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
of the metric | -| [sum](sum.md) | `var sum: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
the accumulated sum of all the samples in the timing distribution | -| [values](values.md) | `val values: `[`MutableMap`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-map/index.html)`<`[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`, `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`>`
a map containing the minimum bucket value mapped to the accumulated count | diff --git a/docs/api/mozilla.components.service.glean.storages/-timing-distribution-data/name.md b/docs/api/mozilla.components.service.glean.storages/-timing-distribution-data/name.md deleted file mode 100644 index 3b9c4b130b2..00000000000 --- a/docs/api/mozilla.components.service.glean.storages/-timing-distribution-data/name.md +++ /dev/null @@ -1,8 +0,0 @@ -[android-components](../../index.md) / [mozilla.components.service.glean.storages](../index.md) / [TimingDistributionData](index.md) / [name](./name.md) - -# name - -`val name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/storages/TimingDistributionsStorageEngine.kt#L194) - -of the metric - diff --git a/docs/api/mozilla.components.service.glean.storages/index.md b/docs/api/mozilla.components.service.glean.storages/index.md index 871ca5f434f..15a69fe3b55 100644 --- a/docs/api/mozilla.components.service.glean.storages/index.md +++ b/docs/api/mozilla.components.service.glean.storages/index.md @@ -6,7 +6,5 @@ | Name | Summary | |---|---| -| [CustomDistributionData](-custom-distribution-data/index.md) | `data class CustomDistributionData`
This class represents the structure of a custom distribution according to the pipeline schema. It is meant to help serialize and deserialize data to the correct format for transport and storage, as well as including a helper function to calculate the bucket sizes. | | [RecordedEventData](-recorded-event-data/index.md) | `data class RecordedEventData` | | [RecordedExperimentData](-recorded-experiment-data/index.md) | `data class RecordedExperimentData` | -| [TimingDistributionData](-timing-distribution-data/index.md) | `data class TimingDistributionData`
This class represents the structure of a timing distribution according to the pipeline schema. It is meant to help serialize and deserialize data to the correct format for transport and storage, as well as performing the calculations to determine the correct bucket for each sample. | diff --git a/docs/api/package-list b/docs/api/package-list index c470f7fbdcf..2a144d9de68 100644 --- a/docs/api/package-list +++ b/docs/api/package-list @@ -199,6 +199,7 @@ mozilla.components.service.glean mozilla.components.service.glean.config mozilla.components.service.glean.debug mozilla.components.service.glean.error +mozilla.components.service.glean.histogram mozilla.components.service.glean.private mozilla.components.service.glean.storages mozilla.components.service.glean.testing