diff --git a/docs/api/0.21/browser-domains/alltypes/index.md b/docs/api/0.21/browser-domains/alltypes/index.md new file mode 100644 index 00000000000..7b4549b2eb3 --- /dev/null +++ b/docs/api/0.21/browser-domains/alltypes/index.md @@ -0,0 +1,10 @@ +--- +title: alltypes - +--- + +### All Types + +| [mozilla.components.browser.domains.CustomDomains](../mozilla.components.browser.domains/-custom-domains/index.html) | Contains functionality to manage custom domains for auto-completion. | +| [mozilla.components.browser.domains.DomainAutoCompleteProvider](../mozilla.components.browser.domains/-domain-auto-complete-provider/index.html) | Provides autocomplete functionality for domains, based on a provided list of assets (see [Domains](../mozilla.components.browser.domains/-domains/index.html)) and/or a custom domain list managed by [CustomDomains](../mozilla.components.browser.domains/-custom-domains/index.html). | +| [mozilla.components.browser.domains.Domains](../mozilla.components.browser.domains/-domains/index.html) | Contains functionality to access domain lists shipped as part of this module's assets. | + diff --git a/docs/api/0.21/browser-domains/index.md b/docs/api/0.21/browser-domains/index.md new file mode 100644 index 00000000000..21ef9cc2d95 --- /dev/null +++ b/docs/api/0.21/browser-domains/index.md @@ -0,0 +1,11 @@ +--- +title: +--- + +### Packages + +| [mozilla.components.browser.domains](mozilla.components.browser.domains/index.html) | | + +### Index + +[All Types](alltypes/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-domains/mozilla.components.browser.domains/-custom-domains/add.md b/docs/api/0.21/browser-domains/mozilla.components.browser.domains/-custom-domains/add.md new file mode 100644 index 00000000000..440bbeda86c --- /dev/null +++ b/docs/api/0.21/browser-domains/mozilla.components.browser.domains/-custom-domains/add.md @@ -0,0 +1,17 @@ +--- +title: CustomDomains.add - +--- + +[mozilla.components.browser.domains](../index.html) / [CustomDomains](index.html) / [add](./add.html) + +# add + +`fun add(context: Context, domain: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Adds the provided domain to preferences. + +### Parameters + +`context` - the application context + +`domain` - the domain to add \ No newline at end of file diff --git a/docs/api/0.21/browser-domains/mozilla.components.browser.domains/-custom-domains/index.md b/docs/api/0.21/browser-domains/mozilla.components.browser.domains/-custom-domains/index.md new file mode 100644 index 00000000000..366597c8a17 --- /dev/null +++ b/docs/api/0.21/browser-domains/mozilla.components.browser.domains/-custom-domains/index.md @@ -0,0 +1,19 @@ +--- +title: CustomDomains - +--- + +[mozilla.components.browser.domains](../index.html) / [CustomDomains](./index.html) + +# CustomDomains + +`object CustomDomains` + +Contains functionality to manage custom domains for auto-completion. + +### Functions + +| [add](add.html) | `fun add(context: Context, domain: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Adds the provided domain to preferences. | +| [load](load.html) | `fun load(context: Context): `[`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)`>`
Loads the previously added/saved custom domains from preferences. | +| [remove](remove.html) | `fun remove(context: Context, domains: `[`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)`>): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Removes the provided domain from preferences. | +| [save](save.html) | `fun save(context: Context, domains: `[`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)`>): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Saves the provided domains to preferences. | + diff --git a/docs/api/0.21/browser-domains/mozilla.components.browser.domains/-custom-domains/load.md b/docs/api/0.21/browser-domains/mozilla.components.browser.domains/-custom-domains/load.md new file mode 100644 index 00000000000..aad3afd6852 --- /dev/null +++ b/docs/api/0.21/browser-domains/mozilla.components.browser.domains/-custom-domains/load.md @@ -0,0 +1,19 @@ +--- +title: CustomDomains.load - +--- + +[mozilla.components.browser.domains](../index.html) / [CustomDomains](index.html) / [load](./load.html) + +# load + +`fun load(context: Context): `[`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)`>` + +Loads the previously added/saved custom domains from preferences. + +### Parameters + +`context` - the application context + +**Return** +list of custom domains + diff --git a/docs/api/0.21/browser-domains/mozilla.components.browser.domains/-custom-domains/remove.md b/docs/api/0.21/browser-domains/mozilla.components.browser.domains/-custom-domains/remove.md new file mode 100644 index 00000000000..c54e43108b5 --- /dev/null +++ b/docs/api/0.21/browser-domains/mozilla.components.browser.domains/-custom-domains/remove.md @@ -0,0 +1,17 @@ +--- +title: CustomDomains.remove - +--- + +[mozilla.components.browser.domains](../index.html) / [CustomDomains](index.html) / [remove](./remove.html) + +# remove + +`fun remove(context: Context, domains: `[`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)`>): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Removes the provided domain from preferences. + +### Parameters + +`context` - the application context + +`domains` - the domain to remove \ No newline at end of file diff --git a/docs/api/0.21/browser-domains/mozilla.components.browser.domains/-custom-domains/save.md b/docs/api/0.21/browser-domains/mozilla.components.browser.domains/-custom-domains/save.md new file mode 100644 index 00000000000..6ab40ecbf36 --- /dev/null +++ b/docs/api/0.21/browser-domains/mozilla.components.browser.domains/-custom-domains/save.md @@ -0,0 +1,17 @@ +--- +title: CustomDomains.save - +--- + +[mozilla.components.browser.domains](../index.html) / [CustomDomains](index.html) / [save](./save.html) + +# save + +`fun save(context: Context, domains: `[`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)`>): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Saves the provided domains to preferences. + +### Parameters + +`context` - the application context + +`domains` - list of domains \ No newline at end of file diff --git a/docs/api/0.21/browser-domains/mozilla.components.browser.domains/-domain-auto-complete-provider/-autocomplete-source/-c-u-s-t-o-m_-l-i-s-t.md b/docs/api/0.21/browser-domains/mozilla.components.browser.domains/-domain-auto-complete-provider/-autocomplete-source/-c-u-s-t-o-m_-l-i-s-t.md new file mode 100644 index 00000000000..c886c8a2a00 --- /dev/null +++ b/docs/api/0.21/browser-domains/mozilla.components.browser.domains/-domain-auto-complete-provider/-autocomplete-source/-c-u-s-t-o-m_-l-i-s-t.md @@ -0,0 +1,9 @@ +--- +title: DomainAutoCompleteProvider.AutocompleteSource.CUSTOM_LIST - +--- + +[mozilla.components.browser.domains](../../index.html) / [DomainAutoCompleteProvider](../index.html) / [AutocompleteSource](index.html) / [CUSTOM_LIST](./-c-u-s-t-o-m_-l-i-s-t.html) + +# CUSTOM_LIST + +`const val CUSTOM_LIST: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-domains/mozilla.components.browser.domains/-domain-auto-complete-provider/-autocomplete-source/-d-e-f-a-u-l-t_-l-i-s-t.md b/docs/api/0.21/browser-domains/mozilla.components.browser.domains/-domain-auto-complete-provider/-autocomplete-source/-d-e-f-a-u-l-t_-l-i-s-t.md new file mode 100644 index 00000000000..6bfeed25fe9 --- /dev/null +++ b/docs/api/0.21/browser-domains/mozilla.components.browser.domains/-domain-auto-complete-provider/-autocomplete-source/-d-e-f-a-u-l-t_-l-i-s-t.md @@ -0,0 +1,9 @@ +--- +title: DomainAutoCompleteProvider.AutocompleteSource.DEFAULT_LIST - +--- + +[mozilla.components.browser.domains](../../index.html) / [DomainAutoCompleteProvider](../index.html) / [AutocompleteSource](index.html) / [DEFAULT_LIST](./-d-e-f-a-u-l-t_-l-i-s-t.html) + +# DEFAULT_LIST + +`const val DEFAULT_LIST: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-domains/mozilla.components.browser.domains/-domain-auto-complete-provider/-autocomplete-source/index.md b/docs/api/0.21/browser-domains/mozilla.components.browser.domains/-domain-auto-complete-provider/-autocomplete-source/index.md new file mode 100644 index 00000000000..862c1218e21 --- /dev/null +++ b/docs/api/0.21/browser-domains/mozilla.components.browser.domains/-domain-auto-complete-provider/-autocomplete-source/index.md @@ -0,0 +1,15 @@ +--- +title: DomainAutoCompleteProvider.AutocompleteSource - +--- + +[mozilla.components.browser.domains](../../index.html) / [DomainAutoCompleteProvider](../index.html) / [AutocompleteSource](./index.html) + +# AutocompleteSource + +`object AutocompleteSource` + +### Properties + +| [CUSTOM_LIST](-c-u-s-t-o-m_-l-i-s-t.html) | `const val CUSTOM_LIST: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [DEFAULT_LIST](-d-e-f-a-u-l-t_-l-i-s-t.html) | `const val DEFAULT_LIST: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + diff --git a/docs/api/0.21/browser-domains/mozilla.components.browser.domains/-domain-auto-complete-provider/-init-.md b/docs/api/0.21/browser-domains/mozilla.components.browser.domains/-domain-auto-complete-provider/-init-.md new file mode 100644 index 00000000000..c7d2b83d4d1 --- /dev/null +++ b/docs/api/0.21/browser-domains/mozilla.components.browser.domains/-domain-auto-complete-provider/-init-.md @@ -0,0 +1,14 @@ +--- +title: DomainAutoCompleteProvider. - +--- + +[mozilla.components.browser.domains](../index.html) / [DomainAutoCompleteProvider](index.html) / [<init>](./-init-.html) + +# <init> + +`DomainAutoCompleteProvider()` + +Provides autocomplete functionality for domains, based on a provided list +of assets (see [Domains](../-domains/index.html)) and/or a custom domain list managed by +[CustomDomains](../-custom-domains/index.html). + diff --git a/docs/api/0.21/browser-domains/mozilla.components.browser.domains/-domain-auto-complete-provider/-result/-init-.md b/docs/api/0.21/browser-domains/mozilla.components.browser.domains/-domain-auto-complete-provider/-result/-init-.md new file mode 100644 index 00000000000..1fffcb4ec29 --- /dev/null +++ b/docs/api/0.21/browser-domains/mozilla.components.browser.domains/-domain-auto-complete-provider/-result/-init-.md @@ -0,0 +1,12 @@ +--- +title: DomainAutoCompleteProvider.Result. - +--- + +[mozilla.components.browser.domains](../../index.html) / [DomainAutoCompleteProvider](../index.html) / [Result](index.html) / [<init>](./-init-.html) + +# <init> + +`Result(text: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, source: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, size: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` + +Represents a result of auto-completion. + diff --git a/docs/api/0.21/browser-domains/mozilla.components.browser.domains/-domain-auto-complete-provider/-result/index.md b/docs/api/0.21/browser-domains/mozilla.components.browser.domains/-domain-auto-complete-provider/-result/index.md new file mode 100644 index 00000000000..09033c2467f --- /dev/null +++ b/docs/api/0.21/browser-domains/mozilla.components.browser.domains/-domain-auto-complete-provider/-result/index.md @@ -0,0 +1,23 @@ +--- +title: DomainAutoCompleteProvider.Result - +--- + +[mozilla.components.browser.domains](../../index.html) / [DomainAutoCompleteProvider](../index.html) / [Result](./index.html) + +# Result + +`data class Result` + +Represents a result of auto-completion. + +### Constructors + +| [<init>](-init-.html) | `Result(text: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, source: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, size: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)`
Represents a result of auto-completion. | + +### Properties + +| [size](size.html) | `val size: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
total number of available autocomplete domains in this source | +| [source](source.html) | `val source: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
the source identifier of the autocomplete source | +| [text](text.html) | `val text: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
the result text starting with the raw search text as passed to [autocomplete](../autocomplete.html) followed by the completion text (e.g. moz => mozilla.org) | +| [url](url.html) | `val url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
the complete url (containing the protocol) as provided when the domain was saved. (e.g. https://mozilla.org) | + diff --git a/docs/api/0.21/browser-domains/mozilla.components.browser.domains/-domain-auto-complete-provider/-result/size.md b/docs/api/0.21/browser-domains/mozilla.components.browser.domains/-domain-auto-complete-provider/-result/size.md new file mode 100644 index 00000000000..6bf93484910 --- /dev/null +++ b/docs/api/0.21/browser-domains/mozilla.components.browser.domains/-domain-auto-complete-provider/-result/size.md @@ -0,0 +1,17 @@ +--- +title: DomainAutoCompleteProvider.Result.size - +--- + +[mozilla.components.browser.domains](../../index.html) / [DomainAutoCompleteProvider](../index.html) / [Result](index.html) / [size](./size.html) + +# size + +`val size: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +total number of available autocomplete domains +in this source + +### Property + +`size` - total number of available autocomplete domains +in this source \ No newline at end of file diff --git a/docs/api/0.21/browser-domains/mozilla.components.browser.domains/-domain-auto-complete-provider/-result/source.md b/docs/api/0.21/browser-domains/mozilla.components.browser.domains/-domain-auto-complete-provider/-result/source.md new file mode 100644 index 00000000000..5b2c9d3026b --- /dev/null +++ b/docs/api/0.21/browser-domains/mozilla.components.browser.domains/-domain-auto-complete-provider/-result/source.md @@ -0,0 +1,15 @@ +--- +title: DomainAutoCompleteProvider.Result.source - +--- + +[mozilla.components.browser.domains](../../index.html) / [DomainAutoCompleteProvider](../index.html) / [Result](index.html) / [source](./source.html) + +# source + +`val source: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) + +the source identifier of the autocomplete source + +### Property + +`source` - the source identifier of the autocomplete source \ No newline at end of file diff --git a/docs/api/0.21/browser-domains/mozilla.components.browser.domains/-domain-auto-complete-provider/-result/text.md b/docs/api/0.21/browser-domains/mozilla.components.browser.domains/-domain-auto-complete-provider/-result/text.md new file mode 100644 index 00000000000..636c4820660 --- /dev/null +++ b/docs/api/0.21/browser-domains/mozilla.components.browser.domains/-domain-auto-complete-provider/-result/text.md @@ -0,0 +1,17 @@ +--- +title: DomainAutoCompleteProvider.Result.text - +--- + +[mozilla.components.browser.domains](../../index.html) / [DomainAutoCompleteProvider](../index.html) / [Result](index.html) / [text](./text.html) + +# text + +`val text: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) + +the result text starting with the raw search text as passed +to [autocomplete](../autocomplete.html) followed by the completion text (e.g. moz => mozilla.org) + +### Property + +`text` - the result text starting with the raw search text as passed +to [autocomplete](../autocomplete.html) followed by the completion text (e.g. moz => mozilla.org) \ No newline at end of file diff --git a/docs/api/0.21/browser-domains/mozilla.components.browser.domains/-domain-auto-complete-provider/-result/url.md b/docs/api/0.21/browser-domains/mozilla.components.browser.domains/-domain-auto-complete-provider/-result/url.md new file mode 100644 index 00000000000..6e76583ba63 --- /dev/null +++ b/docs/api/0.21/browser-domains/mozilla.components.browser.domains/-domain-auto-complete-provider/-result/url.md @@ -0,0 +1,17 @@ +--- +title: DomainAutoCompleteProvider.Result.url - +--- + +[mozilla.components.browser.domains](../../index.html) / [DomainAutoCompleteProvider](../index.html) / [Result](index.html) / [url](./url.html) + +# url + +`val url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) + +the complete url (containing the protocol) as provided +when the domain was saved. (e.g. https://mozilla.org) + +### Property + +`url` - the complete url (containing the protocol) as provided +when the domain was saved. (e.g. https://mozilla.org) \ No newline at end of file diff --git a/docs/api/0.21/browser-domains/mozilla.components.browser.domains/-domain-auto-complete-provider/autocomplete.md b/docs/api/0.21/browser-domains/mozilla.components.browser.domains/-domain-auto-complete-provider/autocomplete.md new file mode 100644 index 00000000000..aff70f0b8d2 --- /dev/null +++ b/docs/api/0.21/browser-domains/mozilla.components.browser.domains/-domain-auto-complete-provider/autocomplete.md @@ -0,0 +1,21 @@ +--- +title: DomainAutoCompleteProvider.autocomplete - +--- + +[mozilla.components.browser.domains](../index.html) / [DomainAutoCompleteProvider](index.html) / [autocomplete](./autocomplete.html) + +# autocomplete + +`fun autocomplete(rawText: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Result`](-result/index.html) + +Computes an autocomplete suggestion for the given text, and invokes the +provided callback, passing the result. + +### Parameters + +`rawText` - text to be auto completed + +**Return** +the result of auto-completion. If no match is found an empty +result object is returned. + diff --git a/docs/api/0.21/browser-domains/mozilla.components.browser.domains/-domain-auto-complete-provider/index.md b/docs/api/0.21/browser-domains/mozilla.components.browser.domains/-domain-auto-complete-provider/index.md new file mode 100644 index 00000000000..8a48b406a20 --- /dev/null +++ b/docs/api/0.21/browser-domains/mozilla.components.browser.domains/-domain-auto-complete-provider/index.md @@ -0,0 +1,28 @@ +--- +title: DomainAutoCompleteProvider - +--- + +[mozilla.components.browser.domains](../index.html) / [DomainAutoCompleteProvider](./index.html) + +# DomainAutoCompleteProvider + +`class DomainAutoCompleteProvider` + +Provides autocomplete functionality for domains, based on a provided list +of assets (see [Domains](../-domains/index.html)) and/or a custom domain list managed by +[CustomDomains](../-custom-domains/index.html). + +### Types + +| [AutocompleteSource](-autocomplete-source/index.html) | `object AutocompleteSource` | +| [Result](-result/index.html) | `data class Result`
Represents a result of auto-completion. | + +### Constructors + +| [<init>](-init-.html) | `DomainAutoCompleteProvider()`
Provides autocomplete functionality for domains, based on a provided list of assets (see [Domains](../-domains/index.html)) and/or a custom domain list managed by [CustomDomains](../-custom-domains/index.html). | + +### Functions + +| [autocomplete](autocomplete.html) | `fun autocomplete(rawText: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Result`](-result/index.html)
Computes an autocomplete suggestion for the given text, and invokes the provided callback, passing the result. | +| [initialize](initialize.html) | `fun initialize(context: Context, useShippedDomains: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = true, useCustomDomains: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, loadDomainsFromDisk: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = true): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Initializes this provider instance by making sure the shipped and/or custom domains are loaded. | + diff --git a/docs/api/0.21/browser-domains/mozilla.components.browser.domains/-domain-auto-complete-provider/initialize.md b/docs/api/0.21/browser-domains/mozilla.components.browser.domains/-domain-auto-complete-provider/initialize.md new file mode 100644 index 00000000000..17dfebbf61a --- /dev/null +++ b/docs/api/0.21/browser-domains/mozilla.components.browser.domains/-domain-auto-complete-provider/initialize.md @@ -0,0 +1,25 @@ +--- +title: DomainAutoCompleteProvider.initialize - +--- + +[mozilla.components.browser.domains](../index.html) / [DomainAutoCompleteProvider](index.html) / [initialize](./initialize.html) + +# initialize + +`fun initialize(context: Context, useShippedDomains: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = true, useCustomDomains: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, loadDomainsFromDisk: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = true): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Initializes this provider instance by making sure the shipped and/or custom +domains are loaded. + +### Parameters + +`context` - the application context + +`useShippedDomains` - true (default) if the domains provided by this +module should be used, otherwise false. + +`useCustomDomains` - true if the custom domains provided by +[CustomDomains](../-custom-domains/index.html) should be used, otherwise false (default). + +`loadDomainsFromDisk` - true (default) if domains should be loaded, +otherwise false. This parameter is for testing purposes only. \ No newline at end of file diff --git a/docs/api/0.21/browser-domains/mozilla.components.browser.domains/-domains/index.md b/docs/api/0.21/browser-domains/mozilla.components.browser.domains/-domains/index.md new file mode 100644 index 00000000000..68632279170 --- /dev/null +++ b/docs/api/0.21/browser-domains/mozilla.components.browser.domains/-domains/index.md @@ -0,0 +1,17 @@ +--- +title: Domains - +--- + +[mozilla.components.browser.domains](../index.html) / [Domains](./index.html) + +# Domains + +`object Domains` + +Contains functionality to access domain lists shipped as part of this +module's assets. + +### Functions + +| [load](load.html) | `fun load(context: Context): `[`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)`>`
Loads the domains applicable to the app's locale, plus the domains in the 'global' list. | + diff --git a/docs/api/0.21/browser-domains/mozilla.components.browser.domains/-domains/load.md b/docs/api/0.21/browser-domains/mozilla.components.browser.domains/-domains/load.md new file mode 100644 index 00000000000..c6067c05782 --- /dev/null +++ b/docs/api/0.21/browser-domains/mozilla.components.browser.domains/-domains/load.md @@ -0,0 +1,20 @@ +--- +title: Domains.load - +--- + +[mozilla.components.browser.domains](../index.html) / [Domains](index.html) / [load](./load.html) + +# load + +`fun load(context: Context): `[`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)`>` + +Loads the domains applicable to the app's locale, plus the domains +in the 'global' list. + +### Parameters + +`context` - the application context + +**Return** +list of domains + diff --git a/docs/api/0.21/browser-domains/mozilla.components.browser.domains/index.md b/docs/api/0.21/browser-domains/mozilla.components.browser.domains/index.md new file mode 100644 index 00000000000..bd8bbb0e93a --- /dev/null +++ b/docs/api/0.21/browser-domains/mozilla.components.browser.domains/index.md @@ -0,0 +1,14 @@ +--- +title: mozilla.components.browser.domains - +--- + +[mozilla.components.browser.domains](./index.html) + +## Package mozilla.components.browser.domains + +### Types + +| [CustomDomains](-custom-domains/index.html) | `object CustomDomains`
Contains functionality to manage custom domains for auto-completion. | +| [DomainAutoCompleteProvider](-domain-auto-complete-provider/index.html) | `class DomainAutoCompleteProvider`
Provides autocomplete functionality for domains, based on a provided list of assets (see [Domains](-domains/index.html)) and/or a custom domain list managed by [CustomDomains](-custom-domains/index.html). | +| [Domains](-domains/index.html) | `object Domains`
Contains functionality to access domain lists shipped as part of this module's assets. | + diff --git a/docs/api/0.21/browser-domains/package-list b/docs/api/0.21/browser-domains/package-list new file mode 100644 index 00000000000..0281958cf50 --- /dev/null +++ b/docs/api/0.21/browser-domains/package-list @@ -0,0 +1,4 @@ +$dokka.format:jekyll +$dokka.linkExtension:html + +mozilla.components.browser.domains diff --git a/docs/api/0.21/browser-engine-gecko-beta/alltypes/index.md b/docs/api/0.21/browser-engine-gecko-beta/alltypes/index.md new file mode 100644 index 00000000000..1cfc1d07a31 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko-beta/alltypes/index.md @@ -0,0 +1,10 @@ +--- +title: alltypes - +--- + +### All Types + +| [mozilla.components.browser.engine.gecko.GeckoEngine](../mozilla.components.browser.engine.gecko/-gecko-engine/index.html) | Gecko-based implementation of Engine interface. | +| [mozilla.components.browser.engine.gecko.GeckoEngineSession](../mozilla.components.browser.engine.gecko/-gecko-engine-session/index.html) | Gecko-based EngineSession implementation. | +| [mozilla.components.browser.engine.gecko.GeckoEngineView](../mozilla.components.browser.engine.gecko/-gecko-engine-view/index.html) | Gecko-based EngineView implementation. | + diff --git a/docs/api/0.21/browser-engine-gecko-beta/index.md b/docs/api/0.21/browser-engine-gecko-beta/index.md new file mode 100644 index 00000000000..73c91a4345a --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko-beta/index.md @@ -0,0 +1,11 @@ +--- +title: +--- + +### Packages + +| [mozilla.components.browser.engine.gecko](mozilla.components.browser.engine.gecko/index.html) | | + +### Index + +[All Types](alltypes/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine-session/-init-.md b/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine-session/-init-.md new file mode 100644 index 00000000000..3195df3b7f0 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine-session/-init-.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngineSession. - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineSession](index.html) / [<init>](./-init-.html) + +# <init> + +`GeckoEngineSession(runtime: GeckoRuntime, privateMode: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, defaultSettings: Settings? = null)` + +Gecko-based EngineSession implementation. + diff --git a/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine-session/clear-find-matches.md b/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine-session/clear-find-matches.md new file mode 100644 index 00000000000..48f1c099519 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine-session/clear-find-matches.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngineSession.clearFindMatches - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineSession](index.html) / [clearFindMatches](./clear-find-matches.html) + +# clearFindMatches + +`fun clearFindMatches(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +See [EngineSession.clearFindMatches](#) + diff --git a/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine-session/disable-tracking-protection.md b/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine-session/disable-tracking-protection.md new file mode 100644 index 00000000000..3a512c3c448 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine-session/disable-tracking-protection.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngineSession.disableTrackingProtection - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineSession](index.html) / [disableTrackingProtection](./disable-tracking-protection.html) + +# disableTrackingProtection + +`fun disableTrackingProtection(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +See [EngineSession.disableTrackingProtection](#) + diff --git a/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine-session/enable-tracking-protection.md b/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine-session/enable-tracking-protection.md new file mode 100644 index 00000000000..54cd6f91337 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine-session/enable-tracking-protection.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngineSession.enableTrackingProtection - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineSession](index.html) / [enableTrackingProtection](./enable-tracking-protection.html) + +# enableTrackingProtection + +`fun enableTrackingProtection(policy: TrackingProtectionPolicy): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +See [EngineSession.enableTrackingProtection](#) + diff --git a/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine-session/find-all.md b/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine-session/find-all.md new file mode 100644 index 00000000000..a626a07cd04 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine-session/find-all.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngineSession.findAll - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineSession](index.html) / [findAll](./find-all.html) + +# findAll + +`fun findAll(text: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +See [EngineSession.findAll](#) + diff --git a/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine-session/find-next.md b/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine-session/find-next.md new file mode 100644 index 00000000000..9eb2e9bc834 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine-session/find-next.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngineSession.findNext - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineSession](index.html) / [findNext](./find-next.html) + +# findNext + +`fun findNext(forward: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +See [EngineSession.findNext](#) + diff --git a/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine-session/go-back.md b/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine-session/go-back.md new file mode 100644 index 00000000000..5cdd738bf8e --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine-session/go-back.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngineSession.goBack - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineSession](index.html) / [goBack](./go-back.html) + +# goBack + +`fun goBack(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +See [EngineSession.goBack](#) + diff --git a/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine-session/go-forward.md b/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine-session/go-forward.md new file mode 100644 index 00000000000..8653995e2b7 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine-session/go-forward.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngineSession.goForward - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineSession](index.html) / [goForward](./go-forward.html) + +# goForward + +`fun goForward(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +See [EngineSession.goForward](#) + diff --git a/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine-session/handle-long-click.md b/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine-session/handle-long-click.md new file mode 100644 index 00000000000..e2f227a160d --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine-session/handle-long-click.md @@ -0,0 +1,9 @@ +--- +title: GeckoEngineSession.handleLongClick - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineSession](index.html) / [handleLongClick](./handle-long-click.html) + +# handleLongClick + +`fun handleLongClick(elementSrc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?, elementType: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, uri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null): HitResult?` \ No newline at end of file diff --git a/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine-session/index.md b/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine-session/index.md new file mode 100644 index 00000000000..50e788cca44 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine-session/index.md @@ -0,0 +1,38 @@ +--- +title: GeckoEngineSession - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineSession](./index.html) + +# GeckoEngineSession + +`class GeckoEngineSession : EngineSession` + +Gecko-based EngineSession implementation. + +### Constructors + +| [<init>](-init-.html) | `GeckoEngineSession(runtime: GeckoRuntime, privateMode: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, defaultSettings: Settings? = null)`
Gecko-based EngineSession implementation. | + +### Properties + +| [settings](settings.html) | `val settings: Settings`
See [EngineSession.settings](#) | + +### Functions + +| [clearFindMatches](clear-find-matches.html) | `fun clearFindMatches(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.clearFindMatches](#) | +| [disableTrackingProtection](disable-tracking-protection.html) | `fun disableTrackingProtection(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.disableTrackingProtection](#) | +| [enableTrackingProtection](enable-tracking-protection.html) | `fun enableTrackingProtection(policy: TrackingProtectionPolicy): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.enableTrackingProtection](#) | +| [findAll](find-all.html) | `fun findAll(text: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.findAll](#) | +| [findNext](find-next.html) | `fun findNext(forward: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.findNext](#) | +| [goBack](go-back.html) | `fun goBack(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.goBack](#) | +| [goForward](go-forward.html) | `fun goForward(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.goForward](#) | +| [handleLongClick](handle-long-click.html) | `fun handleLongClick(elementSrc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?, elementType: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, uri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null): HitResult?` | +| [loadData](load-data.html) | `fun loadData(data: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, mimeType: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, encoding: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.loadData](#) | +| [loadUrl](load-url.html) | `fun loadUrl(url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.loadUrl](#) | +| [reload](reload.html) | `fun reload(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.reload](#) | +| [restoreState](restore-state.html) | `fun restoreState(state: `[`Map`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`>): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.restoreState](#) | +| [saveState](save-state.html) | `fun saveState(): `[`Map`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`>`
See [EngineSession.saveState](#) | +| [setDesktopMode](set-desktop-mode.html) | `fun setDesktopMode(enable: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`, reload: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.settings](#) | +| [stopLoading](stop-loading.html) | `fun stopLoading(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.stopLoading](#) | + diff --git a/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine-session/load-data.md b/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine-session/load-data.md new file mode 100644 index 00000000000..15f929ec4d3 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine-session/load-data.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngineSession.loadData - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineSession](index.html) / [loadData](./load-data.html) + +# loadData + +`fun loadData(data: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, mimeType: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, encoding: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +See [EngineSession.loadData](#) + diff --git a/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine-session/load-url.md b/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine-session/load-url.md new file mode 100644 index 00000000000..2b2aae2ee42 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine-session/load-url.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngineSession.loadUrl - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineSession](index.html) / [loadUrl](./load-url.html) + +# loadUrl + +`fun loadUrl(url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +See [EngineSession.loadUrl](#) + diff --git a/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine-session/reload.md b/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine-session/reload.md new file mode 100644 index 00000000000..0d42c52d7b4 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine-session/reload.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngineSession.reload - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineSession](index.html) / [reload](./reload.html) + +# reload + +`fun reload(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +See [EngineSession.reload](#) + diff --git a/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine-session/restore-state.md b/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine-session/restore-state.md new file mode 100644 index 00000000000..d6ab9b7ea81 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine-session/restore-state.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngineSession.restoreState - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineSession](index.html) / [restoreState](./restore-state.html) + +# restoreState + +`fun restoreState(state: `[`Map`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`>): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +See [EngineSession.restoreState](#) + diff --git a/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine-session/save-state.md b/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine-session/save-state.md new file mode 100644 index 00000000000..c37f0b9173e --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine-session/save-state.md @@ -0,0 +1,22 @@ +--- +title: GeckoEngineSession.saveState - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineSession](index.html) / [saveState](./save-state.html) + +# saveState + +`fun saveState(): `[`Map`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`>` + +See [EngineSession.saveState](#) + +GeckoView provides a String representing the entire session state. We +store this String using a single Map entry with key GECKO_STATE_KEY. + +See https://bugzilla.mozilla.org/show_bug.cgi?id=1441810 for +discussion on sync vs. async, where a decision was made that +callers should provide synchronous wrappers, if needed. In case we're +asking for the state when persisting, a separate (independent) thread +is used so we're not blocking anything else. In case of calling this +method from onPause or similar, we also want a synchronous response. + diff --git a/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine-session/set-desktop-mode.md b/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine-session/set-desktop-mode.md new file mode 100644 index 00000000000..9147464c355 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine-session/set-desktop-mode.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngineSession.setDesktopMode - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineSession](index.html) / [setDesktopMode](./set-desktop-mode.html) + +# setDesktopMode + +`fun setDesktopMode(enable: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`, reload: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +See [EngineSession.settings](#) + diff --git a/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine-session/settings.md b/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine-session/settings.md new file mode 100644 index 00000000000..d71ec1951c8 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine-session/settings.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngineSession.settings - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineSession](index.html) / [settings](./settings.html) + +# settings + +`val settings: Settings` + +See [EngineSession.settings](#) + diff --git a/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine-session/stop-loading.md b/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine-session/stop-loading.md new file mode 100644 index 00000000000..6f216b281c5 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine-session/stop-loading.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngineSession.stopLoading - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineSession](index.html) / [stopLoading](./stop-loading.html) + +# stopLoading + +`fun stopLoading(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +See [EngineSession.stopLoading](#) + diff --git a/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine-view/-init-.md b/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine-view/-init-.md new file mode 100644 index 00000000000..08343a60b7c --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine-view/-init-.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngineView. - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineView](index.html) / [<init>](./-init-.html) + +# <init> + +`GeckoEngineView(context: Context, attrs: AttributeSet? = null, defStyleAttr: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = 0)` + +Gecko-based EngineView implementation. + diff --git a/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine-view/index.md b/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine-view/index.md new file mode 100644 index 00000000000..563557cfe21 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine-view/index.md @@ -0,0 +1,20 @@ +--- +title: GeckoEngineView - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineView](./index.html) + +# GeckoEngineView + +`class GeckoEngineView : FrameLayout, EngineView` + +Gecko-based EngineView implementation. + +### Constructors + +| [<init>](-init-.html) | `GeckoEngineView(context: Context, attrs: AttributeSet? = null, defStyleAttr: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = 0)`
Gecko-based EngineView implementation. | + +### Functions + +| [render](render.html) | `fun render(session: EngineSession): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Render the content of the given session. | + diff --git a/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine-view/render.md b/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine-view/render.md new file mode 100644 index 00000000000..a9f1ddf2e34 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine-view/render.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngineView.render - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineView](index.html) / [render](./render.html) + +# render + +`fun render(session: EngineSession): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Render the content of the given session. + diff --git a/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine/-init-.md b/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine/-init-.md new file mode 100644 index 00000000000..23fade13a6a --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine/-init-.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngine. - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngine](index.html) / [<init>](./-init-.html) + +# <init> + +`GeckoEngine(runtime: GeckoRuntime, defaultSettings: Settings? = null)` + +Gecko-based implementation of Engine interface. + diff --git a/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine/create-session.md b/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine/create-session.md new file mode 100644 index 00000000000..886bc4b4f3e --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine/create-session.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngine.createSession - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngine](index.html) / [createSession](./create-session.html) + +# createSession + +`fun createSession(private: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): EngineSession` + +Creates a new Gecko-based EngineSession. + diff --git a/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine/create-view.md b/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine/create-view.md new file mode 100644 index 00000000000..fb946cf9361 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine/create-view.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngine.createView - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngine](index.html) / [createView](./create-view.html) + +# createView + +`fun createView(context: Context, attrs: AttributeSet?): EngineView` + +Creates a new Gecko-based EngineView. + diff --git a/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine/index.md b/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine/index.md new file mode 100644 index 00000000000..c812c5e086e --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine/index.md @@ -0,0 +1,26 @@ +--- +title: GeckoEngine - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngine](./index.html) + +# GeckoEngine + +`class GeckoEngine : Engine` + +Gecko-based implementation of Engine interface. + +### Constructors + +| [<init>](-init-.html) | `GeckoEngine(runtime: GeckoRuntime, defaultSettings: Settings? = null)`
Gecko-based implementation of Engine interface. | + +### Properties + +| [settings](settings.html) | `val settings: Settings`
See [Engine.settings](#) | + +### Functions + +| [createSession](create-session.html) | `fun createSession(private: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): EngineSession`
Creates a new Gecko-based EngineSession. | +| [createView](create-view.html) | `fun createView(context: Context, attrs: AttributeSet?): EngineView`
Creates a new Gecko-based EngineView. | +| [name](name.html) | `fun name(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + diff --git a/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine/name.md b/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine/name.md new file mode 100644 index 00000000000..98b85744962 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine/name.md @@ -0,0 +1,9 @@ +--- +title: GeckoEngine.name - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngine](index.html) / [name](./name.html) + +# name + +`fun name(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine/settings.md b/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine/settings.md new file mode 100644 index 00000000000..631f0211af5 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/-gecko-engine/settings.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngine.settings - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngine](index.html) / [settings](./settings.html) + +# settings + +`val settings: Settings` + +See [Engine.settings](#) + diff --git a/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/index.md b/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/index.md new file mode 100644 index 00000000000..4de0c5dfbe5 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko-beta/mozilla.components.browser.engine.gecko/index.md @@ -0,0 +1,14 @@ +--- +title: mozilla.components.browser.engine.gecko - +--- + +[mozilla.components.browser.engine.gecko](./index.html) + +## Package mozilla.components.browser.engine.gecko + +### Types + +| [GeckoEngine](-gecko-engine/index.html) | `class GeckoEngine : Engine`
Gecko-based implementation of Engine interface. | +| [GeckoEngineSession](-gecko-engine-session/index.html) | `class GeckoEngineSession : EngineSession`
Gecko-based EngineSession implementation. | +| [GeckoEngineView](-gecko-engine-view/index.html) | `class GeckoEngineView : FrameLayout, EngineView`
Gecko-based EngineView implementation. | + diff --git a/docs/api/0.21/browser-engine-gecko-beta/package-list b/docs/api/0.21/browser-engine-gecko-beta/package-list new file mode 100644 index 00000000000..92480f41ee0 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko-beta/package-list @@ -0,0 +1,4 @@ +$dokka.format:jekyll +$dokka.linkExtension:html + +mozilla.components.browser.engine.gecko diff --git a/docs/api/0.21/browser-engine-gecko-nightly/alltypes/index.md b/docs/api/0.21/browser-engine-gecko-nightly/alltypes/index.md new file mode 100644 index 00000000000..1cfc1d07a31 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko-nightly/alltypes/index.md @@ -0,0 +1,10 @@ +--- +title: alltypes - +--- + +### All Types + +| [mozilla.components.browser.engine.gecko.GeckoEngine](../mozilla.components.browser.engine.gecko/-gecko-engine/index.html) | Gecko-based implementation of Engine interface. | +| [mozilla.components.browser.engine.gecko.GeckoEngineSession](../mozilla.components.browser.engine.gecko/-gecko-engine-session/index.html) | Gecko-based EngineSession implementation. | +| [mozilla.components.browser.engine.gecko.GeckoEngineView](../mozilla.components.browser.engine.gecko/-gecko-engine-view/index.html) | Gecko-based EngineView implementation. | + diff --git a/docs/api/0.21/browser-engine-gecko-nightly/index.md b/docs/api/0.21/browser-engine-gecko-nightly/index.md new file mode 100644 index 00000000000..73c91a4345a --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko-nightly/index.md @@ -0,0 +1,11 @@ +--- +title: +--- + +### Packages + +| [mozilla.components.browser.engine.gecko](mozilla.components.browser.engine.gecko/index.html) | | + +### Index + +[All Types](alltypes/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine-session/-init-.md b/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine-session/-init-.md new file mode 100644 index 00000000000..3195df3b7f0 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine-session/-init-.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngineSession. - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineSession](index.html) / [<init>](./-init-.html) + +# <init> + +`GeckoEngineSession(runtime: GeckoRuntime, privateMode: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, defaultSettings: Settings? = null)` + +Gecko-based EngineSession implementation. + diff --git a/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine-session/clear-find-matches.md b/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine-session/clear-find-matches.md new file mode 100644 index 00000000000..48f1c099519 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine-session/clear-find-matches.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngineSession.clearFindMatches - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineSession](index.html) / [clearFindMatches](./clear-find-matches.html) + +# clearFindMatches + +`fun clearFindMatches(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +See [EngineSession.clearFindMatches](#) + diff --git a/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine-session/disable-tracking-protection.md b/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine-session/disable-tracking-protection.md new file mode 100644 index 00000000000..3a512c3c448 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine-session/disable-tracking-protection.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngineSession.disableTrackingProtection - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineSession](index.html) / [disableTrackingProtection](./disable-tracking-protection.html) + +# disableTrackingProtection + +`fun disableTrackingProtection(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +See [EngineSession.disableTrackingProtection](#) + diff --git a/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine-session/enable-tracking-protection.md b/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine-session/enable-tracking-protection.md new file mode 100644 index 00000000000..54cd6f91337 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine-session/enable-tracking-protection.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngineSession.enableTrackingProtection - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineSession](index.html) / [enableTrackingProtection](./enable-tracking-protection.html) + +# enableTrackingProtection + +`fun enableTrackingProtection(policy: TrackingProtectionPolicy): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +See [EngineSession.enableTrackingProtection](#) + diff --git a/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine-session/find-all.md b/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine-session/find-all.md new file mode 100644 index 00000000000..a626a07cd04 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine-session/find-all.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngineSession.findAll - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineSession](index.html) / [findAll](./find-all.html) + +# findAll + +`fun findAll(text: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +See [EngineSession.findAll](#) + diff --git a/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine-session/find-next.md b/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine-session/find-next.md new file mode 100644 index 00000000000..9eb2e9bc834 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine-session/find-next.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngineSession.findNext - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineSession](index.html) / [findNext](./find-next.html) + +# findNext + +`fun findNext(forward: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +See [EngineSession.findNext](#) + diff --git a/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine-session/go-back.md b/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine-session/go-back.md new file mode 100644 index 00000000000..5cdd738bf8e --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine-session/go-back.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngineSession.goBack - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineSession](index.html) / [goBack](./go-back.html) + +# goBack + +`fun goBack(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +See [EngineSession.goBack](#) + diff --git a/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine-session/go-forward.md b/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine-session/go-forward.md new file mode 100644 index 00000000000..8653995e2b7 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine-session/go-forward.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngineSession.goForward - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineSession](index.html) / [goForward](./go-forward.html) + +# goForward + +`fun goForward(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +See [EngineSession.goForward](#) + diff --git a/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine-session/handle-long-click.md b/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine-session/handle-long-click.md new file mode 100644 index 00000000000..e2f227a160d --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine-session/handle-long-click.md @@ -0,0 +1,9 @@ +--- +title: GeckoEngineSession.handleLongClick - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineSession](index.html) / [handleLongClick](./handle-long-click.html) + +# handleLongClick + +`fun handleLongClick(elementSrc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?, elementType: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, uri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null): HitResult?` \ No newline at end of file diff --git a/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine-session/index.md b/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine-session/index.md new file mode 100644 index 00000000000..50e788cca44 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine-session/index.md @@ -0,0 +1,38 @@ +--- +title: GeckoEngineSession - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineSession](./index.html) + +# GeckoEngineSession + +`class GeckoEngineSession : EngineSession` + +Gecko-based EngineSession implementation. + +### Constructors + +| [<init>](-init-.html) | `GeckoEngineSession(runtime: GeckoRuntime, privateMode: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, defaultSettings: Settings? = null)`
Gecko-based EngineSession implementation. | + +### Properties + +| [settings](settings.html) | `val settings: Settings`
See [EngineSession.settings](#) | + +### Functions + +| [clearFindMatches](clear-find-matches.html) | `fun clearFindMatches(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.clearFindMatches](#) | +| [disableTrackingProtection](disable-tracking-protection.html) | `fun disableTrackingProtection(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.disableTrackingProtection](#) | +| [enableTrackingProtection](enable-tracking-protection.html) | `fun enableTrackingProtection(policy: TrackingProtectionPolicy): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.enableTrackingProtection](#) | +| [findAll](find-all.html) | `fun findAll(text: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.findAll](#) | +| [findNext](find-next.html) | `fun findNext(forward: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.findNext](#) | +| [goBack](go-back.html) | `fun goBack(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.goBack](#) | +| [goForward](go-forward.html) | `fun goForward(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.goForward](#) | +| [handleLongClick](handle-long-click.html) | `fun handleLongClick(elementSrc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?, elementType: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, uri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null): HitResult?` | +| [loadData](load-data.html) | `fun loadData(data: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, mimeType: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, encoding: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.loadData](#) | +| [loadUrl](load-url.html) | `fun loadUrl(url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.loadUrl](#) | +| [reload](reload.html) | `fun reload(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.reload](#) | +| [restoreState](restore-state.html) | `fun restoreState(state: `[`Map`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`>): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.restoreState](#) | +| [saveState](save-state.html) | `fun saveState(): `[`Map`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`>`
See [EngineSession.saveState](#) | +| [setDesktopMode](set-desktop-mode.html) | `fun setDesktopMode(enable: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`, reload: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.settings](#) | +| [stopLoading](stop-loading.html) | `fun stopLoading(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.stopLoading](#) | + diff --git a/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine-session/load-data.md b/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine-session/load-data.md new file mode 100644 index 00000000000..15f929ec4d3 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine-session/load-data.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngineSession.loadData - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineSession](index.html) / [loadData](./load-data.html) + +# loadData + +`fun loadData(data: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, mimeType: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, encoding: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +See [EngineSession.loadData](#) + diff --git a/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine-session/load-url.md b/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine-session/load-url.md new file mode 100644 index 00000000000..2b2aae2ee42 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine-session/load-url.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngineSession.loadUrl - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineSession](index.html) / [loadUrl](./load-url.html) + +# loadUrl + +`fun loadUrl(url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +See [EngineSession.loadUrl](#) + diff --git a/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine-session/reload.md b/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine-session/reload.md new file mode 100644 index 00000000000..0d42c52d7b4 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine-session/reload.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngineSession.reload - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineSession](index.html) / [reload](./reload.html) + +# reload + +`fun reload(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +See [EngineSession.reload](#) + diff --git a/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine-session/restore-state.md b/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine-session/restore-state.md new file mode 100644 index 00000000000..d6ab9b7ea81 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine-session/restore-state.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngineSession.restoreState - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineSession](index.html) / [restoreState](./restore-state.html) + +# restoreState + +`fun restoreState(state: `[`Map`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`>): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +See [EngineSession.restoreState](#) + diff --git a/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine-session/save-state.md b/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine-session/save-state.md new file mode 100644 index 00000000000..c37f0b9173e --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine-session/save-state.md @@ -0,0 +1,22 @@ +--- +title: GeckoEngineSession.saveState - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineSession](index.html) / [saveState](./save-state.html) + +# saveState + +`fun saveState(): `[`Map`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`>` + +See [EngineSession.saveState](#) + +GeckoView provides a String representing the entire session state. We +store this String using a single Map entry with key GECKO_STATE_KEY. + +See https://bugzilla.mozilla.org/show_bug.cgi?id=1441810 for +discussion on sync vs. async, where a decision was made that +callers should provide synchronous wrappers, if needed. In case we're +asking for the state when persisting, a separate (independent) thread +is used so we're not blocking anything else. In case of calling this +method from onPause or similar, we also want a synchronous response. + diff --git a/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine-session/set-desktop-mode.md b/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine-session/set-desktop-mode.md new file mode 100644 index 00000000000..9147464c355 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine-session/set-desktop-mode.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngineSession.setDesktopMode - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineSession](index.html) / [setDesktopMode](./set-desktop-mode.html) + +# setDesktopMode + +`fun setDesktopMode(enable: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`, reload: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +See [EngineSession.settings](#) + diff --git a/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine-session/settings.md b/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine-session/settings.md new file mode 100644 index 00000000000..d71ec1951c8 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine-session/settings.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngineSession.settings - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineSession](index.html) / [settings](./settings.html) + +# settings + +`val settings: Settings` + +See [EngineSession.settings](#) + diff --git a/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine-session/stop-loading.md b/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine-session/stop-loading.md new file mode 100644 index 00000000000..6f216b281c5 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine-session/stop-loading.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngineSession.stopLoading - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineSession](index.html) / [stopLoading](./stop-loading.html) + +# stopLoading + +`fun stopLoading(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +See [EngineSession.stopLoading](#) + diff --git a/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine-view/-init-.md b/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine-view/-init-.md new file mode 100644 index 00000000000..08343a60b7c --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine-view/-init-.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngineView. - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineView](index.html) / [<init>](./-init-.html) + +# <init> + +`GeckoEngineView(context: Context, attrs: AttributeSet? = null, defStyleAttr: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = 0)` + +Gecko-based EngineView implementation. + diff --git a/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine-view/index.md b/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine-view/index.md new file mode 100644 index 00000000000..563557cfe21 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine-view/index.md @@ -0,0 +1,20 @@ +--- +title: GeckoEngineView - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineView](./index.html) + +# GeckoEngineView + +`class GeckoEngineView : FrameLayout, EngineView` + +Gecko-based EngineView implementation. + +### Constructors + +| [<init>](-init-.html) | `GeckoEngineView(context: Context, attrs: AttributeSet? = null, defStyleAttr: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = 0)`
Gecko-based EngineView implementation. | + +### Functions + +| [render](render.html) | `fun render(session: EngineSession): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Render the content of the given session. | + diff --git a/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine-view/render.md b/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine-view/render.md new file mode 100644 index 00000000000..a9f1ddf2e34 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine-view/render.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngineView.render - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineView](index.html) / [render](./render.html) + +# render + +`fun render(session: EngineSession): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Render the content of the given session. + diff --git a/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine/-init-.md b/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine/-init-.md new file mode 100644 index 00000000000..23fade13a6a --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine/-init-.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngine. - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngine](index.html) / [<init>](./-init-.html) + +# <init> + +`GeckoEngine(runtime: GeckoRuntime, defaultSettings: Settings? = null)` + +Gecko-based implementation of Engine interface. + diff --git a/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine/create-session.md b/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine/create-session.md new file mode 100644 index 00000000000..886bc4b4f3e --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine/create-session.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngine.createSession - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngine](index.html) / [createSession](./create-session.html) + +# createSession + +`fun createSession(private: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): EngineSession` + +Creates a new Gecko-based EngineSession. + diff --git a/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine/create-view.md b/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine/create-view.md new file mode 100644 index 00000000000..fb946cf9361 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine/create-view.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngine.createView - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngine](index.html) / [createView](./create-view.html) + +# createView + +`fun createView(context: Context, attrs: AttributeSet?): EngineView` + +Creates a new Gecko-based EngineView. + diff --git a/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine/index.md b/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine/index.md new file mode 100644 index 00000000000..c812c5e086e --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine/index.md @@ -0,0 +1,26 @@ +--- +title: GeckoEngine - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngine](./index.html) + +# GeckoEngine + +`class GeckoEngine : Engine` + +Gecko-based implementation of Engine interface. + +### Constructors + +| [<init>](-init-.html) | `GeckoEngine(runtime: GeckoRuntime, defaultSettings: Settings? = null)`
Gecko-based implementation of Engine interface. | + +### Properties + +| [settings](settings.html) | `val settings: Settings`
See [Engine.settings](#) | + +### Functions + +| [createSession](create-session.html) | `fun createSession(private: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): EngineSession`
Creates a new Gecko-based EngineSession. | +| [createView](create-view.html) | `fun createView(context: Context, attrs: AttributeSet?): EngineView`
Creates a new Gecko-based EngineView. | +| [name](name.html) | `fun name(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + diff --git a/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine/name.md b/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine/name.md new file mode 100644 index 00000000000..98b85744962 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine/name.md @@ -0,0 +1,9 @@ +--- +title: GeckoEngine.name - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngine](index.html) / [name](./name.html) + +# name + +`fun name(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine/settings.md b/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine/settings.md new file mode 100644 index 00000000000..631f0211af5 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/-gecko-engine/settings.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngine.settings - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngine](index.html) / [settings](./settings.html) + +# settings + +`val settings: Settings` + +See [Engine.settings](#) + diff --git a/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/index.md b/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/index.md new file mode 100644 index 00000000000..4de0c5dfbe5 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko-nightly/mozilla.components.browser.engine.gecko/index.md @@ -0,0 +1,14 @@ +--- +title: mozilla.components.browser.engine.gecko - +--- + +[mozilla.components.browser.engine.gecko](./index.html) + +## Package mozilla.components.browser.engine.gecko + +### Types + +| [GeckoEngine](-gecko-engine/index.html) | `class GeckoEngine : Engine`
Gecko-based implementation of Engine interface. | +| [GeckoEngineSession](-gecko-engine-session/index.html) | `class GeckoEngineSession : EngineSession`
Gecko-based EngineSession implementation. | +| [GeckoEngineView](-gecko-engine-view/index.html) | `class GeckoEngineView : FrameLayout, EngineView`
Gecko-based EngineView implementation. | + diff --git a/docs/api/0.21/browser-engine-gecko-nightly/package-list b/docs/api/0.21/browser-engine-gecko-nightly/package-list new file mode 100644 index 00000000000..92480f41ee0 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko-nightly/package-list @@ -0,0 +1,4 @@ +$dokka.format:jekyll +$dokka.linkExtension:html + +mozilla.components.browser.engine.gecko diff --git a/docs/api/0.21/browser-engine-gecko/alltypes/index.md b/docs/api/0.21/browser-engine-gecko/alltypes/index.md new file mode 100644 index 00000000000..02078c9deb2 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko/alltypes/index.md @@ -0,0 +1,11 @@ +--- +title: alltypes - +--- + +### All Types + +| [mozilla.components.browser.engine.gecko.GeckoEngine](../mozilla.components.browser.engine.gecko/-gecko-engine/index.html) | Gecko-based implementation of Engine interface. | +| [mozilla.components.browser.engine.gecko.GeckoEngineException](../mozilla.components.browser.engine.gecko/-gecko-engine-exception/index.html) | Exception type used for errors caught when interacting with Gecko. | +| [mozilla.components.browser.engine.gecko.GeckoEngineSession](../mozilla.components.browser.engine.gecko/-gecko-engine-session/index.html) | Gecko-based EngineSession implementation. | +| [mozilla.components.browser.engine.gecko.GeckoEngineView](../mozilla.components.browser.engine.gecko/-gecko-engine-view/index.html) | Gecko-based EngineView implementation. | + diff --git a/docs/api/0.21/browser-engine-gecko/index.md b/docs/api/0.21/browser-engine-gecko/index.md new file mode 100644 index 00000000000..73c91a4345a --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko/index.md @@ -0,0 +1,11 @@ +--- +title: +--- + +### Packages + +| [mozilla.components.browser.engine.gecko](mozilla.components.browser.engine.gecko/index.html) | | + +### Index + +[All Types](alltypes/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-exception/-init-.md b/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-exception/-init-.md new file mode 100644 index 00000000000..51a9663bd78 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-exception/-init-.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngineException. - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineException](index.html) / [<init>](./-init-.html) + +# <init> + +`GeckoEngineException(message: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)` + +Exception type used for errors caught when interacting with Gecko. + diff --git a/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-exception/index.md b/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-exception/index.md new file mode 100644 index 00000000000..4a41e485005 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-exception/index.md @@ -0,0 +1,16 @@ +--- +title: GeckoEngineException - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineException](./index.html) + +# GeckoEngineException + +`class GeckoEngineException : `[`RuntimeException`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-runtime-exception/index.html) + +Exception type used for errors caught when interacting with Gecko. + +### Constructors + +| [<init>](-init-.html) | `GeckoEngineException(message: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)`
Exception type used for errors caught when interacting with Gecko. | + diff --git a/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-session/-init-.md b/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-session/-init-.md new file mode 100644 index 00000000000..cbd322ffd4a --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-session/-init-.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngineSession. - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineSession](index.html) / [<init>](./-init-.html) + +# <init> + +`GeckoEngineSession(runtime: GeckoRuntime, privateMode: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false)` + +Gecko-based EngineSession implementation. + diff --git a/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-session/clear-find-matches.md b/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-session/clear-find-matches.md new file mode 100644 index 00000000000..48f1c099519 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-session/clear-find-matches.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngineSession.clearFindMatches - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineSession](index.html) / [clearFindMatches](./clear-find-matches.html) + +# clearFindMatches + +`fun clearFindMatches(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +See [EngineSession.clearFindMatches](#) + diff --git a/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-session/disable-tracking-protection.md b/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-session/disable-tracking-protection.md new file mode 100644 index 00000000000..3a512c3c448 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-session/disable-tracking-protection.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngineSession.disableTrackingProtection - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineSession](index.html) / [disableTrackingProtection](./disable-tracking-protection.html) + +# disableTrackingProtection + +`fun disableTrackingProtection(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +See [EngineSession.disableTrackingProtection](#) + diff --git a/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-session/enable-tracking-protection.md b/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-session/enable-tracking-protection.md new file mode 100644 index 00000000000..54cd6f91337 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-session/enable-tracking-protection.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngineSession.enableTrackingProtection - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineSession](index.html) / [enableTrackingProtection](./enable-tracking-protection.html) + +# enableTrackingProtection + +`fun enableTrackingProtection(policy: TrackingProtectionPolicy): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +See [EngineSession.enableTrackingProtection](#) + diff --git a/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-session/find-all.md b/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-session/find-all.md new file mode 100644 index 00000000000..a626a07cd04 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-session/find-all.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngineSession.findAll - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineSession](index.html) / [findAll](./find-all.html) + +# findAll + +`fun findAll(text: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +See [EngineSession.findAll](#) + diff --git a/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-session/find-next.md b/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-session/find-next.md new file mode 100644 index 00000000000..9eb2e9bc834 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-session/find-next.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngineSession.findNext - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineSession](index.html) / [findNext](./find-next.html) + +# findNext + +`fun findNext(forward: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +See [EngineSession.findNext](#) + diff --git a/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-session/go-back.md b/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-session/go-back.md new file mode 100644 index 00000000000..5cdd738bf8e --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-session/go-back.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngineSession.goBack - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineSession](index.html) / [goBack](./go-back.html) + +# goBack + +`fun goBack(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +See [EngineSession.goBack](#) + diff --git a/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-session/go-forward.md b/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-session/go-forward.md new file mode 100644 index 00000000000..8653995e2b7 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-session/go-forward.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngineSession.goForward - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineSession](index.html) / [goForward](./go-forward.html) + +# goForward + +`fun goForward(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +See [EngineSession.goForward](#) + diff --git a/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-session/handle-long-click.md b/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-session/handle-long-click.md new file mode 100644 index 00000000000..e2f227a160d --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-session/handle-long-click.md @@ -0,0 +1,9 @@ +--- +title: GeckoEngineSession.handleLongClick - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineSession](index.html) / [handleLongClick](./handle-long-click.html) + +# handleLongClick + +`fun handleLongClick(elementSrc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?, elementType: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, uri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null): HitResult?` \ No newline at end of file diff --git a/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-session/index.md b/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-session/index.md new file mode 100644 index 00000000000..fbcbd95e811 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-session/index.md @@ -0,0 +1,38 @@ +--- +title: GeckoEngineSession - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineSession](./index.html) + +# GeckoEngineSession + +`class GeckoEngineSession : EngineSession` + +Gecko-based EngineSession implementation. + +### Constructors + +| [<init>](-init-.html) | `GeckoEngineSession(runtime: GeckoRuntime, privateMode: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false)`
Gecko-based EngineSession implementation. | + +### Properties + +| [settings](settings.html) | `val settings: Settings`
See [EngineSession.settings](#) | + +### Functions + +| [clearFindMatches](clear-find-matches.html) | `fun clearFindMatches(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.clearFindMatches](#) | +| [disableTrackingProtection](disable-tracking-protection.html) | `fun disableTrackingProtection(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.disableTrackingProtection](#) | +| [enableTrackingProtection](enable-tracking-protection.html) | `fun enableTrackingProtection(policy: TrackingProtectionPolicy): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.enableTrackingProtection](#) | +| [findAll](find-all.html) | `fun findAll(text: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.findAll](#) | +| [findNext](find-next.html) | `fun findNext(forward: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.findNext](#) | +| [goBack](go-back.html) | `fun goBack(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.goBack](#) | +| [goForward](go-forward.html) | `fun goForward(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.goForward](#) | +| [handleLongClick](handle-long-click.html) | `fun handleLongClick(elementSrc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?, elementType: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, uri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null): HitResult?` | +| [loadData](load-data.html) | `fun loadData(data: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, mimeType: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, encoding: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.loadData](#) | +| [loadUrl](load-url.html) | `fun loadUrl(url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.loadUrl](#) | +| [reload](reload.html) | `fun reload(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.reload](#) | +| [restoreState](restore-state.html) | `fun restoreState(state: `[`Map`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`>): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.restoreState](#) | +| [saveState](save-state.html) | `fun saveState(): `[`Map`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`>`
See [EngineSession.saveState](#) | +| [setDesktopMode](set-desktop-mode.html) | `fun setDesktopMode(enable: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`, reload: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.settings](#) | +| [stopLoading](stop-loading.html) | `fun stopLoading(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.stopLoading](#) | + diff --git a/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-session/load-data.md b/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-session/load-data.md new file mode 100644 index 00000000000..15f929ec4d3 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-session/load-data.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngineSession.loadData - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineSession](index.html) / [loadData](./load-data.html) + +# loadData + +`fun loadData(data: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, mimeType: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, encoding: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +See [EngineSession.loadData](#) + diff --git a/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-session/load-url.md b/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-session/load-url.md new file mode 100644 index 00000000000..2b2aae2ee42 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-session/load-url.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngineSession.loadUrl - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineSession](index.html) / [loadUrl](./load-url.html) + +# loadUrl + +`fun loadUrl(url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +See [EngineSession.loadUrl](#) + diff --git a/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-session/reload.md b/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-session/reload.md new file mode 100644 index 00000000000..0d42c52d7b4 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-session/reload.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngineSession.reload - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineSession](index.html) / [reload](./reload.html) + +# reload + +`fun reload(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +See [EngineSession.reload](#) + diff --git a/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-session/restore-state.md b/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-session/restore-state.md new file mode 100644 index 00000000000..d6ab9b7ea81 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-session/restore-state.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngineSession.restoreState - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineSession](index.html) / [restoreState](./restore-state.html) + +# restoreState + +`fun restoreState(state: `[`Map`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`>): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +See [EngineSession.restoreState](#) + diff --git a/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-session/save-state.md b/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-session/save-state.md new file mode 100644 index 00000000000..c37f0b9173e --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-session/save-state.md @@ -0,0 +1,22 @@ +--- +title: GeckoEngineSession.saveState - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineSession](index.html) / [saveState](./save-state.html) + +# saveState + +`fun saveState(): `[`Map`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`>` + +See [EngineSession.saveState](#) + +GeckoView provides a String representing the entire session state. We +store this String using a single Map entry with key GECKO_STATE_KEY. + +See https://bugzilla.mozilla.org/show_bug.cgi?id=1441810 for +discussion on sync vs. async, where a decision was made that +callers should provide synchronous wrappers, if needed. In case we're +asking for the state when persisting, a separate (independent) thread +is used so we're not blocking anything else. In case of calling this +method from onPause or similar, we also want a synchronous response. + diff --git a/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-session/set-desktop-mode.md b/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-session/set-desktop-mode.md new file mode 100644 index 00000000000..9147464c355 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-session/set-desktop-mode.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngineSession.setDesktopMode - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineSession](index.html) / [setDesktopMode](./set-desktop-mode.html) + +# setDesktopMode + +`fun setDesktopMode(enable: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`, reload: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +See [EngineSession.settings](#) + diff --git a/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-session/settings.md b/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-session/settings.md new file mode 100644 index 00000000000..d71ec1951c8 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-session/settings.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngineSession.settings - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineSession](index.html) / [settings](./settings.html) + +# settings + +`val settings: Settings` + +See [EngineSession.settings](#) + diff --git a/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-session/stop-loading.md b/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-session/stop-loading.md new file mode 100644 index 00000000000..6f216b281c5 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-session/stop-loading.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngineSession.stopLoading - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineSession](index.html) / [stopLoading](./stop-loading.html) + +# stopLoading + +`fun stopLoading(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +See [EngineSession.stopLoading](#) + diff --git a/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-view/-init-.md b/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-view/-init-.md new file mode 100644 index 00000000000..08343a60b7c --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-view/-init-.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngineView. - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineView](index.html) / [<init>](./-init-.html) + +# <init> + +`GeckoEngineView(context: Context, attrs: AttributeSet? = null, defStyleAttr: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = 0)` + +Gecko-based EngineView implementation. + diff --git a/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-view/index.md b/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-view/index.md new file mode 100644 index 00000000000..563557cfe21 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-view/index.md @@ -0,0 +1,20 @@ +--- +title: GeckoEngineView - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineView](./index.html) + +# GeckoEngineView + +`class GeckoEngineView : FrameLayout, EngineView` + +Gecko-based EngineView implementation. + +### Constructors + +| [<init>](-init-.html) | `GeckoEngineView(context: Context, attrs: AttributeSet? = null, defStyleAttr: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = 0)`
Gecko-based EngineView implementation. | + +### Functions + +| [render](render.html) | `fun render(session: EngineSession): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Render the content of the given session. | + diff --git a/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-view/render.md b/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-view/render.md new file mode 100644 index 00000000000..a9f1ddf2e34 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine-view/render.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngineView.render - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngineView](index.html) / [render](./render.html) + +# render + +`fun render(session: EngineSession): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Render the content of the given session. + diff --git a/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine/-init-.md b/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine/-init-.md new file mode 100644 index 00000000000..23fade13a6a --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine/-init-.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngine. - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngine](index.html) / [<init>](./-init-.html) + +# <init> + +`GeckoEngine(runtime: GeckoRuntime, defaultSettings: Settings? = null)` + +Gecko-based implementation of Engine interface. + diff --git a/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine/create-session.md b/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine/create-session.md new file mode 100644 index 00000000000..886bc4b4f3e --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine/create-session.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngine.createSession - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngine](index.html) / [createSession](./create-session.html) + +# createSession + +`fun createSession(private: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): EngineSession` + +Creates a new Gecko-based EngineSession. + diff --git a/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine/create-view.md b/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine/create-view.md new file mode 100644 index 00000000000..fb946cf9361 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine/create-view.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngine.createView - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngine](index.html) / [createView](./create-view.html) + +# createView + +`fun createView(context: Context, attrs: AttributeSet?): EngineView` + +Creates a new Gecko-based EngineView. + diff --git a/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine/index.md b/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine/index.md new file mode 100644 index 00000000000..cb94474b0ae --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine/index.md @@ -0,0 +1,26 @@ +--- +title: GeckoEngine - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngine](./index.html) + +# GeckoEngine + +`class GeckoEngine : Engine` + +Gecko-based implementation of Engine interface. + +### Constructors + +| [<init>](-init-.html) | `GeckoEngine(runtime: GeckoRuntime, defaultSettings: Settings? = null)`
Gecko-based implementation of Engine interface. | + +### Properties + +| [settings](settings.html) | `val settings: Settings`
See [Engine.settings](#) | + +### Functions + +| [createSession](create-session.html) | `fun createSession(private: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): EngineSession`
Creates a new Gecko-based EngineSession. | +| [createView](create-view.html) | `fun createView(context: Context, attrs: AttributeSet?): EngineView`
Creates a new Gecko-based EngineView. | +| [name](name.html) | `fun name(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
See [Engine.name](#) | + diff --git a/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine/name.md b/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine/name.md new file mode 100644 index 00000000000..d3d2108f7be --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine/name.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngine.name - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngine](index.html) / [name](./name.html) + +# name + +`fun name(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) + +See [Engine.name](#) + diff --git a/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine/settings.md b/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine/settings.md new file mode 100644 index 00000000000..631f0211af5 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/-gecko-engine/settings.md @@ -0,0 +1,12 @@ +--- +title: GeckoEngine.settings - +--- + +[mozilla.components.browser.engine.gecko](../index.html) / [GeckoEngine](index.html) / [settings](./settings.html) + +# settings + +`val settings: Settings` + +See [Engine.settings](#) + diff --git a/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/index.md b/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/index.md new file mode 100644 index 00000000000..3a8349afbad --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko/mozilla.components.browser.engine.gecko/index.md @@ -0,0 +1,18 @@ +--- +title: mozilla.components.browser.engine.gecko - +--- + +[mozilla.components.browser.engine.gecko](./index.html) + +## Package mozilla.components.browser.engine.gecko + +### Types + +| [GeckoEngine](-gecko-engine/index.html) | `class GeckoEngine : Engine`
Gecko-based implementation of Engine interface. | +| [GeckoEngineSession](-gecko-engine-session/index.html) | `class GeckoEngineSession : EngineSession`
Gecko-based EngineSession implementation. | +| [GeckoEngineView](-gecko-engine-view/index.html) | `class GeckoEngineView : FrameLayout, EngineView`
Gecko-based EngineView implementation. | + +### Exceptions + +| [GeckoEngineException](-gecko-engine-exception/index.html) | `class GeckoEngineException : `[`RuntimeException`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-runtime-exception/index.html)
Exception type used for errors caught when interacting with Gecko. | + diff --git a/docs/api/0.21/browser-engine-gecko/package-list b/docs/api/0.21/browser-engine-gecko/package-list new file mode 100644 index 00000000000..92480f41ee0 --- /dev/null +++ b/docs/api/0.21/browser-engine-gecko/package-list @@ -0,0 +1,4 @@ +$dokka.format:jekyll +$dokka.linkExtension:html + +mozilla.components.browser.engine.gecko diff --git a/docs/api/0.21/browser-engine-system/alltypes/index.md b/docs/api/0.21/browser-engine-system/alltypes/index.md new file mode 100644 index 00000000000..621be2b7f8f --- /dev/null +++ b/docs/api/0.21/browser-engine-system/alltypes/index.md @@ -0,0 +1,15 @@ +--- +title: alltypes - +--- + +### All Types + +| [mozilla.components.browser.engine.system.matcher.ReversibleString](../mozilla.components.browser.engine.system.matcher/-reversible-string/index.html) | A String wrapper utility that allows for efficient string reversal. We regularly need to reverse strings. The standard way of doing this in Java would be to copy the string to reverse (e.g. using StringBuffer.reverse()). This seems wasteful when we only read our Strings character by character, in which case can just transpose positions as needed. | +| [mozilla.components.browser.engine.system.ScheduledLoad](../mozilla.components.browser.engine.system/-scheduled-load/index.html) | Used for when we need to schedule loading a url or data with a mime type, if there isn't a session already created. | +| [kotlin.String](../mozilla.components.browser.engine.system.matcher/kotlin.-string/index.html) (extensions in package mozilla.components.browser.engine.system.matcher) | | +| [mozilla.components.browser.engine.system.SystemEngine](../mozilla.components.browser.engine.system/-system-engine/index.html) | WebView-based implementation of the Engine interface. | +| [mozilla.components.browser.engine.system.SystemEngineSession](../mozilla.components.browser.engine.system/-system-engine-session/index.html) | WebView-based EngineSession implementation. | +| [mozilla.components.browser.engine.system.SystemEngineView](../mozilla.components.browser.engine.system/-system-engine-view/index.html) | WebView-based implementation of EngineView. | +| [mozilla.components.browser.engine.system.matcher.Trie](../mozilla.components.browser.engine.system.matcher/-trie/index.html) | Simple implementation of a Trie, used for indexing URLs. | +| [mozilla.components.browser.engine.system.matcher.UrlMatcher](../mozilla.components.browser.engine.system.matcher/-url-matcher/index.html) | Provides functionality to process categorized URL black/white lists and match URLs against these lists. | + diff --git a/docs/api/0.21/browser-engine-system/index.md b/docs/api/0.21/browser-engine-system/index.md new file mode 100644 index 00000000000..d9dff6b71e6 --- /dev/null +++ b/docs/api/0.21/browser-engine-system/index.md @@ -0,0 +1,12 @@ +--- +title: +--- + +### Packages + +| [mozilla.components.browser.engine.system](mozilla.components.browser.engine.system/index.html) | | +| [mozilla.components.browser.engine.system.matcher](mozilla.components.browser.engine.system.matcher/index.html) | | + +### Index + +[All Types](alltypes/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-reversible-string/char-at.md b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-reversible-string/char-at.md new file mode 100644 index 00000000000..152be549522 --- /dev/null +++ b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-reversible-string/char-at.md @@ -0,0 +1,9 @@ +--- +title: ReversibleString.charAt - +--- + +[mozilla.components.browser.engine.system.matcher](../index.html) / [ReversibleString](index.html) / [charAt](./char-at.html) + +# charAt + +`abstract fun charAt(position: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Char`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-reversible-string/create.md b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-reversible-string/create.md new file mode 100644 index 00000000000..c15d78446d9 --- /dev/null +++ b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-reversible-string/create.md @@ -0,0 +1,12 @@ +--- +title: ReversibleString.create - +--- + +[mozilla.components.browser.engine.system.matcher](../index.html) / [ReversibleString](index.html) / [create](./create.html) + +# create + +`fun create(string: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`ReversibleString`](index.html) + +Create a [ReversibleString](index.html) for the provided [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html). + diff --git a/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-reversible-string/index.md b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-reversible-string/index.md new file mode 100644 index 00000000000..07c8e0bdbb6 --- /dev/null +++ b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-reversible-string/index.md @@ -0,0 +1,34 @@ +--- +title: ReversibleString - +--- + +[mozilla.components.browser.engine.system.matcher](../index.html) / [ReversibleString](./index.html) + +# ReversibleString + +`abstract class ReversibleString` + +A String wrapper utility that allows for efficient string reversal. We +regularly need to reverse strings. The standard way of doing this in Java +would be to copy the string to reverse (e.g. using StringBuffer.reverse()). +This seems wasteful when we only read our Strings character by character, +in which case can just transpose positions as needed. + +### Properties + +| [isReversed](is-reversed.html) | `abstract val isReversed: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [offsetEnd](offset-end.html) | `val offsetEnd: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [offsetStart](offset-start.html) | `val offsetStart: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [string](string.html) | `val string: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + +### Functions + +| [charAt](char-at.html) | `abstract fun charAt(position: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Char`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char/index.html) | +| [length](length.html) | `fun length(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Returns the length of this string. | +| [reverse](reverse.html) | `fun reverse(): `[`ReversibleString`](./index.md)
Reverses this string. | +| [substring](substring.html) | `abstract fun substring(startIndex: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`ReversibleString`](./index.md) | + +### Companion Object Functions + +| [create](create.html) | `fun create(string: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`ReversibleString`](./index.md)
Create a [ReversibleString](./index.md) for the provided [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html). | + diff --git a/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-reversible-string/is-reversed.md b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-reversible-string/is-reversed.md new file mode 100644 index 00000000000..fbdfcd7159f --- /dev/null +++ b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-reversible-string/is-reversed.md @@ -0,0 +1,9 @@ +--- +title: ReversibleString.isReversed - +--- + +[mozilla.components.browser.engine.system.matcher](../index.html) / [ReversibleString](index.html) / [isReversed](./is-reversed.html) + +# isReversed + +`abstract val isReversed: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-reversible-string/length.md b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-reversible-string/length.md new file mode 100644 index 00000000000..2fe35d2aa9e --- /dev/null +++ b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-reversible-string/length.md @@ -0,0 +1,12 @@ +--- +title: ReversibleString.length - +--- + +[mozilla.components.browser.engine.system.matcher](../index.html) / [ReversibleString](index.html) / [length](./length.html) + +# length + +`fun length(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +Returns the length of this string. + diff --git a/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-reversible-string/offset-end.md b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-reversible-string/offset-end.md new file mode 100644 index 00000000000..4880841fc70 --- /dev/null +++ b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-reversible-string/offset-end.md @@ -0,0 +1,9 @@ +--- +title: ReversibleString.offsetEnd - +--- + +[mozilla.components.browser.engine.system.matcher](../index.html) / [ReversibleString](index.html) / [offsetEnd](./offset-end.html) + +# offsetEnd + +`protected val offsetEnd: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-reversible-string/offset-start.md b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-reversible-string/offset-start.md new file mode 100644 index 00000000000..6f114a2bc3f --- /dev/null +++ b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-reversible-string/offset-start.md @@ -0,0 +1,9 @@ +--- +title: ReversibleString.offsetStart - +--- + +[mozilla.components.browser.engine.system.matcher](../index.html) / [ReversibleString](index.html) / [offsetStart](./offset-start.html) + +# offsetStart + +`protected val offsetStart: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-reversible-string/reverse.md b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-reversible-string/reverse.md new file mode 100644 index 00000000000..49f1d3f988c --- /dev/null +++ b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-reversible-string/reverse.md @@ -0,0 +1,12 @@ +--- +title: ReversibleString.reverse - +--- + +[mozilla.components.browser.engine.system.matcher](../index.html) / [ReversibleString](index.html) / [reverse](./reverse.html) + +# reverse + +`fun reverse(): `[`ReversibleString`](index.html) + +Reverses this string. + diff --git a/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-reversible-string/string.md b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-reversible-string/string.md new file mode 100644 index 00000000000..ec50feccfb4 --- /dev/null +++ b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-reversible-string/string.md @@ -0,0 +1,9 @@ +--- +title: ReversibleString.string - +--- + +[mozilla.components.browser.engine.system.matcher](../index.html) / [ReversibleString](index.html) / [string](./string.html) + +# string + +`protected val string: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-reversible-string/substring.md b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-reversible-string/substring.md new file mode 100644 index 00000000000..8f7e5964542 --- /dev/null +++ b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-reversible-string/substring.md @@ -0,0 +1,9 @@ +--- +title: ReversibleString.substring - +--- + +[mozilla.components.browser.engine.system.matcher](../index.html) / [ReversibleString](index.html) / [substring](./substring.html) + +# substring + +`abstract fun substring(startIndex: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`ReversibleString`](index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-trie/-init-.md b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-trie/-init-.md new file mode 100644 index 00000000000..76205114940 --- /dev/null +++ b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-trie/-init-.md @@ -0,0 +1,12 @@ +--- +title: Trie. - +--- + +[mozilla.components.browser.engine.system.matcher](../index.html) / [Trie](index.html) / [<init>](./-init-.html) + +# <init> + +`Trie(character: `[`Char`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char/index.html)`, parent: `[`Trie`](index.html)`?)` + +Simple implementation of a Trie, used for indexing URLs. + diff --git a/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-trie/children.md b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-trie/children.md new file mode 100644 index 00000000000..b7d782c7c8f --- /dev/null +++ b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-trie/children.md @@ -0,0 +1,9 @@ +--- +title: Trie.children - +--- + +[mozilla.components.browser.engine.system.matcher](../index.html) / [Trie](index.html) / [children](./children.html) + +# children + +`val children: SparseArray<`[`Trie`](index.html)`>` \ No newline at end of file diff --git a/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-trie/create-node.md b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-trie/create-node.md new file mode 100644 index 00000000000..1019e7aafb8 --- /dev/null +++ b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-trie/create-node.md @@ -0,0 +1,17 @@ +--- +title: Trie.createNode - +--- + +[mozilla.components.browser.engine.system.matcher](../index.html) / [Trie](index.html) / [createNode](./create-node.html) + +# createNode + +`open fun createNode(character: `[`Char`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char/index.html)`, parent: `[`Trie`](index.html)`): `[`Trie`](index.html) + +Creates a new node for the provided character and parent node. + +### Parameters + +`character` - the character this node represents + +`parent` - the parent of this node \ No newline at end of file diff --git a/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-trie/create-root-node.md b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-trie/create-root-node.md new file mode 100644 index 00000000000..02efa660270 --- /dev/null +++ b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-trie/create-root-node.md @@ -0,0 +1,12 @@ +--- +title: Trie.createRootNode - +--- + +[mozilla.components.browser.engine.system.matcher](../index.html) / [Trie](index.html) / [createRootNode](./create-root-node.html) + +# createRootNode + +`fun createRootNode(): `[`Trie`](index.html) + +Creates a new root node. + diff --git a/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-trie/find-node.md b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-trie/find-node.md new file mode 100644 index 00000000000..e4e713e7f93 --- /dev/null +++ b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-trie/find-node.md @@ -0,0 +1,20 @@ +--- +title: Trie.findNode - +--- + +[mozilla.components.browser.engine.system.matcher](../index.html) / [Trie](index.html) / [findNode](./find-node.html) + +# findNode + +`fun findNode(string: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Trie`](index.html)`?` +`fun findNode(string: `[`ReversibleString`](../-reversible-string/index.html)`): `[`Trie`](index.html)`?` + +Finds the node corresponding to the provided string. + +### Parameters + +`string` - the string to search. + +**Return** +the corresponding node if found, otherwise null. + diff --git a/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-trie/index.md b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-trie/index.md new file mode 100644 index 00000000000..91bb3b86e8e --- /dev/null +++ b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-trie/index.md @@ -0,0 +1,30 @@ +--- +title: Trie - +--- + +[mozilla.components.browser.engine.system.matcher](../index.html) / [Trie](./index.html) + +# Trie + +`open class Trie` + +Simple implementation of a Trie, used for indexing URLs. + +### Constructors + +| [<init>](-init-.html) | `Trie(character: `[`Char`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char/index.html)`, parent: `[`Trie`](./index.md)`?)`
Simple implementation of a Trie, used for indexing URLs. | + +### Properties + +| [children](children.html) | `val children: SparseArray<`[`Trie`](./index.md)`>` | + +### Functions + +| [createNode](create-node.html) | `open fun createNode(character: `[`Char`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char/index.html)`, parent: `[`Trie`](./index.md)`): `[`Trie`](./index.md)
Creates a new node for the provided character and parent node. | +| [findNode](find-node.html) | `fun findNode(string: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Trie`](./index.md)`?`
`fun findNode(string: `[`ReversibleString`](../-reversible-string/index.html)`): `[`Trie`](./index.md)`?`
Finds the node corresponding to the provided string. | +| [put](put.html) | `fun put(string: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Trie`](./index.md)
`fun put(string: `[`ReversibleString`](../-reversible-string/index.html)`): `[`Trie`](./index.md)
Adds new nodes (recursively) for all chars in the provided string.`fun put(character: `[`Char`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char/index.html)`): `[`Trie`](./index.md)
Adds a new node for the provided character if none exists. | + +### Companion Object Functions + +| [createRootNode](create-root-node.html) | `fun createRootNode(): `[`Trie`](./index.md)
Creates a new root node. | + diff --git a/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-trie/put.md b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-trie/put.md new file mode 100644 index 00000000000..03661a81c74 --- /dev/null +++ b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-trie/put.md @@ -0,0 +1,31 @@ +--- +title: Trie.put - +--- + +[mozilla.components.browser.engine.system.matcher](../index.html) / [Trie](index.html) / [put](./put.html) + +# put + +`fun put(string: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Trie`](index.html) +`fun put(string: `[`ReversibleString`](../-reversible-string/index.html)`): `[`Trie`](index.html) + +Adds new nodes (recursively) for all chars in the provided string. + +### Parameters + +`string` - the string for which a node should be added. + +**Return** +the newly created node or the existing one. + +`fun put(character: `[`Char`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char/index.html)`): `[`Trie`](index.html) + +Adds a new node for the provided character if none exists. + +### Parameters + +`character` - the character for which a node should be added. + +**Return** +the newly created node or the existing one. + diff --git a/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-url-matcher/-init-.md b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-url-matcher/-init-.md new file mode 100644 index 00000000000..47e4a06f787 --- /dev/null +++ b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-url-matcher/-init-.md @@ -0,0 +1,9 @@ +--- +title: UrlMatcher. - +--- + +[mozilla.components.browser.engine.system.matcher](../index.html) / [UrlMatcher](index.html) / [<init>](./-init-.html) + +# <init> + +`UrlMatcher(patterns: `[`Array`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>)` \ No newline at end of file diff --git a/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-url-matcher/create-matcher.md b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-url-matcher/create-matcher.md new file mode 100644 index 00000000000..b49b4c1af12 --- /dev/null +++ b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-url-matcher/create-matcher.md @@ -0,0 +1,33 @@ +--- +title: UrlMatcher.createMatcher - +--- + +[mozilla.components.browser.engine.system.matcher](../index.html) / [UrlMatcher](index.html) / [createMatcher](./create-matcher.html) + +# createMatcher + +`fun createMatcher(context: Context, blackListFile: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, overrides: `[`IntArray`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int-array/index.html)`?, whiteListFile: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`UrlMatcher`](index.html) + +Creates a new matcher instance for the provided URL lists. + +### Parameters + +`context` - the application context + +`blackListFile` - resource ID to a JSON file containing the black list + +`overrides` - array of resource ID to JSON files containing black list overrides + +`whiteListFile` - resource ID to a JSON file containing the white list`fun createMatcher(context: Context, black: `[`Reader`](http://docs.oracle.com/javase/6/docs/api/java/io/Reader.html)`, overrides: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Reader`](http://docs.oracle.com/javase/6/docs/api/java/io/Reader.html)`>?, white: `[`Reader`](http://docs.oracle.com/javase/6/docs/api/java/io/Reader.html)`): `[`UrlMatcher`](index.html) + +Creates a new matcher instance for the provided URL lists. + +### Parameters + +`context` - the application context + +`black` - reader containing the black list + +`overrides` - array of resource ID to JSON files containing black list overrides + +`white` - resource ID to a JSON file containing the white list \ No newline at end of file diff --git a/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-url-matcher/index.md b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-url-matcher/index.md new file mode 100644 index 00000000000..68906afcb68 --- /dev/null +++ b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-url-matcher/index.md @@ -0,0 +1,26 @@ +--- +title: UrlMatcher - +--- + +[mozilla.components.browser.engine.system.matcher](../index.html) / [UrlMatcher](./index.html) + +# UrlMatcher + +`class UrlMatcher : OnSharedPreferenceChangeListener` + +Provides functionality to process categorized URL black/white lists and match +URLs against these lists. + +### Constructors + +| [<init>](-init-.html) | `UrlMatcher(patterns: `[`Array`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>)` | + +### Functions + +| [matches](matches.html) | `fun matches(resourceURI: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, pageURI: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
`fun matches(resourceURI: Uri, pageURI: Uri): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Checks if the given page URI is blacklisted for the given resource URI. Returns true if the site (page URI) is allowed to access the resource URI, otherwise false. | +| [onSharedPreferenceChanged](on-shared-preference-changed.html) | `fun onSharedPreferenceChanged(sharedPreferences: SharedPreferences, prefName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | + +### Companion Object Functions + +| [createMatcher](create-matcher.html) | `fun createMatcher(context: Context, blackListFile: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, overrides: `[`IntArray`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int-array/index.html)`?, whiteListFile: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`UrlMatcher`](./index.md)
`fun createMatcher(context: Context, black: `[`Reader`](http://docs.oracle.com/javase/6/docs/api/java/io/Reader.html)`, overrides: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Reader`](http://docs.oracle.com/javase/6/docs/api/java/io/Reader.html)`>?, white: `[`Reader`](http://docs.oracle.com/javase/6/docs/api/java/io/Reader.html)`): `[`UrlMatcher`](./index.md)
Creates a new matcher instance for the provided URL lists. | + diff --git a/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-url-matcher/matches.md b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-url-matcher/matches.md new file mode 100644 index 00000000000..a91c6daba36 --- /dev/null +++ b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-url-matcher/matches.md @@ -0,0 +1,20 @@ +--- +title: UrlMatcher.matches - +--- + +[mozilla.components.browser.engine.system.matcher](../index.html) / [UrlMatcher](index.html) / [matches](./matches.html) + +# matches + +`fun matches(resourceURI: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, pageURI: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) +`fun matches(resourceURI: Uri, pageURI: Uri): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Checks if the given page URI is blacklisted for the given resource URI. +Returns true if the site (page URI) is allowed to access +the resource URI, otherwise false. + +### Parameters + +`resourceURI` - URI of a resource to be loaded by the page + +`pageURI` - URI of the page \ No newline at end of file diff --git a/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-url-matcher/on-shared-preference-changed.md b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-url-matcher/on-shared-preference-changed.md new file mode 100644 index 00000000000..bddb64b1aea --- /dev/null +++ b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/-url-matcher/on-shared-preference-changed.md @@ -0,0 +1,9 @@ +--- +title: UrlMatcher.onSharedPreferenceChanged - +--- + +[mozilla.components.browser.engine.system.matcher](../index.html) / [UrlMatcher](index.html) / [onSharedPreferenceChanged](./on-shared-preference-changed.html) + +# onSharedPreferenceChanged + +`fun onSharedPreferenceChanged(sharedPreferences: SharedPreferences, prefName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/index.md b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/index.md new file mode 100644 index 00000000000..d9bb194b45c --- /dev/null +++ b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/index.md @@ -0,0 +1,18 @@ +--- +title: mozilla.components.browser.engine.system.matcher - +--- + +[mozilla.components.browser.engine.system.matcher](./index.html) + +## Package mozilla.components.browser.engine.system.matcher + +### Types + +| [ReversibleString](-reversible-string/index.html) | `abstract class ReversibleString`
A String wrapper utility that allows for efficient string reversal. We regularly need to reverse strings. The standard way of doing this in Java would be to copy the string to reverse (e.g. using StringBuffer.reverse()). This seems wasteful when we only read our Strings character by character, in which case can just transpose positions as needed. | +| [Trie](-trie/index.html) | `open class Trie`
Simple implementation of a Trie, used for indexing URLs. | +| [UrlMatcher](-url-matcher/index.html) | `class UrlMatcher : OnSharedPreferenceChangeListener`
Provides functionality to process categorized URL black/white lists and match URLs against these lists. | + +### Extensions for External Classes + +| [kotlin.String](kotlin.-string/index.html) | | + diff --git a/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/kotlin.-string/index.md b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/kotlin.-string/index.md new file mode 100644 index 00000000000..d7b97ec026f --- /dev/null +++ b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/kotlin.-string/index.md @@ -0,0 +1,11 @@ +--- +title: mozilla.components.browser.engine.system.matcher.kotlin.String - +--- + +[mozilla.components.browser.engine.system.matcher](../index.html) / [kotlin.String](./index.html) + +### Extensions for kotlin.String + +| [reverse](reverse.html) | `fun `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`.reverse(): `[`ReversibleString`](../-reversible-string/index.html) | +| [reversible](reversible.html) | `fun `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`.reversible(): `[`ReversibleString`](../-reversible-string/index.html) | + diff --git a/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/kotlin.-string/reverse.md b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/kotlin.-string/reverse.md new file mode 100644 index 00000000000..f7bb0de5f57 --- /dev/null +++ b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/kotlin.-string/reverse.md @@ -0,0 +1,9 @@ +--- +title: reverse - +--- + +[mozilla.components.browser.engine.system.matcher](../index.html) / [kotlin.String](index.html) / [reverse](./reverse.html) + +# reverse + +`fun `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`.reverse(): `[`ReversibleString`](../-reversible-string/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/kotlin.-string/reversible.md b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/kotlin.-string/reversible.md new file mode 100644 index 00000000000..d60e4ae834f --- /dev/null +++ b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system.matcher/kotlin.-string/reversible.md @@ -0,0 +1,9 @@ +--- +title: reversible - +--- + +[mozilla.components.browser.engine.system.matcher](../index.html) / [kotlin.String](index.html) / [reversible](./reversible.html) + +# reversible + +`fun `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`.reversible(): `[`ReversibleString`](../-reversible-string/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-scheduled-load/-init-.md b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-scheduled-load/-init-.md new file mode 100644 index 00000000000..fb366eb91d5 --- /dev/null +++ b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-scheduled-load/-init-.md @@ -0,0 +1,14 @@ +--- +title: ScheduledLoad. - +--- + +[mozilla.components.browser.engine.system](../index.html) / [ScheduledLoad](index.html) / [<init>](./-init-.html) + +# <init> + +`ScheduledLoad(data: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, mimeType: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)` +`ScheduledLoad()``ScheduledLoad(url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?, data: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, mimeType: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null)` + +Used for when we need to schedule loading a url or data with a mime type, if there isn't +a session already created. + diff --git a/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-scheduled-load/data.md b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-scheduled-load/data.md new file mode 100644 index 00000000000..104e6b89b30 --- /dev/null +++ b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-scheduled-load/data.md @@ -0,0 +1,9 @@ +--- +title: ScheduledLoad.data - +--- + +[mozilla.components.browser.engine.system](../index.html) / [ScheduledLoad](index.html) / [data](./data.html) + +# data + +`val data: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` \ No newline at end of file diff --git a/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-scheduled-load/index.md b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-scheduled-load/index.md new file mode 100644 index 00000000000..9973ef948cb --- /dev/null +++ b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-scheduled-load/index.md @@ -0,0 +1,23 @@ +--- +title: ScheduledLoad - +--- + +[mozilla.components.browser.engine.system](../index.html) / [ScheduledLoad](./index.html) + +# ScheduledLoad + +`data class ScheduledLoad` + +Used for when we need to schedule loading a url or data with a mime type, if there isn't +a session already created. + +### Constructors + +| [<init>](-init-.html) | `ScheduledLoad(data: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, mimeType: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)`
`ScheduledLoad()``ScheduledLoad(url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?, data: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, mimeType: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null)`
Used for when we need to schedule loading a url or data with a mime type, if there isn't a session already created. | + +### Properties + +| [data](data.html) | `val data: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` | +| [mimeType](mime-type.html) | `val mimeType: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` | +| [url](url.html) | `val url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` | + diff --git a/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-scheduled-load/mime-type.md b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-scheduled-load/mime-type.md new file mode 100644 index 00000000000..5100a9aca0f --- /dev/null +++ b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-scheduled-load/mime-type.md @@ -0,0 +1,9 @@ +--- +title: ScheduledLoad.mimeType - +--- + +[mozilla.components.browser.engine.system](../index.html) / [ScheduledLoad](index.html) / [mimeType](./mime-type.html) + +# mimeType + +`val mimeType: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` \ No newline at end of file diff --git a/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-scheduled-load/url.md b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-scheduled-load/url.md new file mode 100644 index 00000000000..afb25abafd9 --- /dev/null +++ b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-scheduled-load/url.md @@ -0,0 +1,9 @@ +--- +title: ScheduledLoad.url - +--- + +[mozilla.components.browser.engine.system](../index.html) / [ScheduledLoad](index.html) / [url](./url.html) + +# url + +`val url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` \ No newline at end of file diff --git a/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-session/-init-.md b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-session/-init-.md new file mode 100644 index 00000000000..ecaf728220c --- /dev/null +++ b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-session/-init-.md @@ -0,0 +1,12 @@ +--- +title: SystemEngineSession. - +--- + +[mozilla.components.browser.engine.system](../index.html) / [SystemEngineSession](index.html) / [<init>](./-init-.html) + +# <init> + +`SystemEngineSession(defaultSettings: Settings? = null)` + +WebView-based EngineSession implementation. + diff --git a/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-session/clear-find-matches.md b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-session/clear-find-matches.md new file mode 100644 index 00000000000..d8f83ac176a --- /dev/null +++ b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-session/clear-find-matches.md @@ -0,0 +1,12 @@ +--- +title: SystemEngineSession.clearFindMatches - +--- + +[mozilla.components.browser.engine.system](../index.html) / [SystemEngineSession](index.html) / [clearFindMatches](./clear-find-matches.html) + +# clearFindMatches + +`fun clearFindMatches(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +See [EngineSession.clearFindResults](#) + diff --git a/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-session/disable-tracking-protection.md b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-session/disable-tracking-protection.md new file mode 100644 index 00000000000..a2da3d81818 --- /dev/null +++ b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-session/disable-tracking-protection.md @@ -0,0 +1,12 @@ +--- +title: SystemEngineSession.disableTrackingProtection - +--- + +[mozilla.components.browser.engine.system](../index.html) / [SystemEngineSession](index.html) / [disableTrackingProtection](./disable-tracking-protection.html) + +# disableTrackingProtection + +`fun disableTrackingProtection(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +See [EngineSession.disableTrackingProtection](#) + diff --git a/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-session/enable-tracking-protection.md b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-session/enable-tracking-protection.md new file mode 100644 index 00000000000..40853b3dab4 --- /dev/null +++ b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-session/enable-tracking-protection.md @@ -0,0 +1,18 @@ +--- +title: SystemEngineSession.enableTrackingProtection - +--- + +[mozilla.components.browser.engine.system](../index.html) / [SystemEngineSession](index.html) / [enableTrackingProtection](./enable-tracking-protection.html) + +# enableTrackingProtection + +`fun enableTrackingProtection(policy: TrackingProtectionPolicy): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +See [EngineSession.enableTrackingProtection](#) + +Note that specifying tracking protection policies at run-time is +not supported by [SystemEngine](../-system-engine/index.html). Tracking protection is always active +for all URLs provided in domain_blacklist.json and domain_overrides.json, +which both support specifying categories. See [UrlMatcher](#) for how to +enable/disable specific categories. + diff --git a/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-session/find-all.md b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-session/find-all.md new file mode 100644 index 00000000000..ff97b9fb220 --- /dev/null +++ b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-session/find-all.md @@ -0,0 +1,12 @@ +--- +title: SystemEngineSession.findAll - +--- + +[mozilla.components.browser.engine.system](../index.html) / [SystemEngineSession](index.html) / [findAll](./find-all.html) + +# findAll + +`fun findAll(text: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +See [EngineSession.findAll](#) + diff --git a/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-session/find-next.md b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-session/find-next.md new file mode 100644 index 00000000000..b488d5515f1 --- /dev/null +++ b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-session/find-next.md @@ -0,0 +1,12 @@ +--- +title: SystemEngineSession.findNext - +--- + +[mozilla.components.browser.engine.system](../index.html) / [SystemEngineSession](index.html) / [findNext](./find-next.html) + +# findNext + +`fun findNext(forward: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +See [EngineSession.findNext](#) + diff --git a/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-session/go-back.md b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-session/go-back.md new file mode 100644 index 00000000000..8a051854344 --- /dev/null +++ b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-session/go-back.md @@ -0,0 +1,12 @@ +--- +title: SystemEngineSession.goBack - +--- + +[mozilla.components.browser.engine.system](../index.html) / [SystemEngineSession](index.html) / [goBack](./go-back.html) + +# goBack + +`fun goBack(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +See [EngineSession.goBack](#) + diff --git a/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-session/go-forward.md b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-session/go-forward.md new file mode 100644 index 00000000000..38e286d8cf2 --- /dev/null +++ b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-session/go-forward.md @@ -0,0 +1,12 @@ +--- +title: SystemEngineSession.goForward - +--- + +[mozilla.components.browser.engine.system](../index.html) / [SystemEngineSession](index.html) / [goForward](./go-forward.html) + +# goForward + +`fun goForward(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +See [EngineSession.goForward](#) + diff --git a/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-session/index.md b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-session/index.md new file mode 100644 index 00000000000..9d0e9eea63f --- /dev/null +++ b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-session/index.md @@ -0,0 +1,37 @@ +--- +title: SystemEngineSession - +--- + +[mozilla.components.browser.engine.system](../index.html) / [SystemEngineSession](./index.html) + +# SystemEngineSession + +`class SystemEngineSession : EngineSession` + +WebView-based EngineSession implementation. + +### Constructors + +| [<init>](-init-.html) | `SystemEngineSession(defaultSettings: Settings? = null)`
WebView-based EngineSession implementation. | + +### Properties + +| [settings](settings.html) | `val settings: Settings`
See [EngineSession.settings](#) | + +### Functions + +| [clearFindMatches](clear-find-matches.html) | `fun clearFindMatches(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.clearFindResults](#) | +| [disableTrackingProtection](disable-tracking-protection.html) | `fun disableTrackingProtection(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.disableTrackingProtection](#) | +| [enableTrackingProtection](enable-tracking-protection.html) | `fun enableTrackingProtection(policy: TrackingProtectionPolicy): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.enableTrackingProtection](#) | +| [findAll](find-all.html) | `fun findAll(text: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.findAll](#) | +| [findNext](find-next.html) | `fun findNext(forward: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.findNext](#) | +| [goBack](go-back.html) | `fun goBack(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.goBack](#) | +| [goForward](go-forward.html) | `fun goForward(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.goForward](#) | +| [loadData](load-data.html) | `fun loadData(data: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, mimeType: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, encoding: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.loadData](#) | +| [loadUrl](load-url.html) | `fun loadUrl(url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.loadUrl](#) | +| [reload](reload.html) | `fun reload(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.reload](#) | +| [restoreState](restore-state.html) | `fun restoreState(state: `[`Map`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`>): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.restoreState](#) | +| [saveState](save-state.html) | `fun saveState(): `[`Map`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`>`
See [EngineSession.saveState](#) | +| [setDesktopMode](set-desktop-mode.html) | `fun setDesktopMode(enable: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`, reload: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.setDesktopMode](#) | +| [stopLoading](stop-loading.html) | `fun stopLoading(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.stopLoading](#) | + diff --git a/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-session/load-data.md b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-session/load-data.md new file mode 100644 index 00000000000..eb6c2b37608 --- /dev/null +++ b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-session/load-data.md @@ -0,0 +1,12 @@ +--- +title: SystemEngineSession.loadData - +--- + +[mozilla.components.browser.engine.system](../index.html) / [SystemEngineSession](index.html) / [loadData](./load-data.html) + +# loadData + +`fun loadData(data: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, mimeType: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, encoding: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +See [EngineSession.loadData](#) + diff --git a/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-session/load-url.md b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-session/load-url.md new file mode 100644 index 00000000000..996d57ef1c7 --- /dev/null +++ b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-session/load-url.md @@ -0,0 +1,12 @@ +--- +title: SystemEngineSession.loadUrl - +--- + +[mozilla.components.browser.engine.system](../index.html) / [SystemEngineSession](index.html) / [loadUrl](./load-url.html) + +# loadUrl + +`fun loadUrl(url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +See [EngineSession.loadUrl](#) + diff --git a/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-session/reload.md b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-session/reload.md new file mode 100644 index 00000000000..8b9d1691975 --- /dev/null +++ b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-session/reload.md @@ -0,0 +1,12 @@ +--- +title: SystemEngineSession.reload - +--- + +[mozilla.components.browser.engine.system](../index.html) / [SystemEngineSession](index.html) / [reload](./reload.html) + +# reload + +`fun reload(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +See [EngineSession.reload](#) + diff --git a/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-session/restore-state.md b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-session/restore-state.md new file mode 100644 index 00000000000..3ba0e819608 --- /dev/null +++ b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-session/restore-state.md @@ -0,0 +1,12 @@ +--- +title: SystemEngineSession.restoreState - +--- + +[mozilla.components.browser.engine.system](../index.html) / [SystemEngineSession](index.html) / [restoreState](./restore-state.html) + +# restoreState + +`fun restoreState(state: `[`Map`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`>): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +See [EngineSession.restoreState](#) + diff --git a/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-session/save-state.md b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-session/save-state.md new file mode 100644 index 00000000000..90f84c718ed --- /dev/null +++ b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-session/save-state.md @@ -0,0 +1,12 @@ +--- +title: SystemEngineSession.saveState - +--- + +[mozilla.components.browser.engine.system](../index.html) / [SystemEngineSession](index.html) / [saveState](./save-state.html) + +# saveState + +`fun saveState(): `[`Map`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`>` + +See [EngineSession.saveState](#) + diff --git a/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-session/set-desktop-mode.md b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-session/set-desktop-mode.md new file mode 100644 index 00000000000..1c701c2484a --- /dev/null +++ b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-session/set-desktop-mode.md @@ -0,0 +1,12 @@ +--- +title: SystemEngineSession.setDesktopMode - +--- + +[mozilla.components.browser.engine.system](../index.html) / [SystemEngineSession](index.html) / [setDesktopMode](./set-desktop-mode.html) + +# setDesktopMode + +`fun setDesktopMode(enable: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`, reload: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +See [EngineSession.setDesktopMode](#) + diff --git a/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-session/settings.md b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-session/settings.md new file mode 100644 index 00000000000..0463e0e397d --- /dev/null +++ b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-session/settings.md @@ -0,0 +1,12 @@ +--- +title: SystemEngineSession.settings - +--- + +[mozilla.components.browser.engine.system](../index.html) / [SystemEngineSession](index.html) / [settings](./settings.html) + +# settings + +`val settings: Settings` + +See [EngineSession.settings](#) + diff --git a/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-session/stop-loading.md b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-session/stop-loading.md new file mode 100644 index 00000000000..eccaa0c6a95 --- /dev/null +++ b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-session/stop-loading.md @@ -0,0 +1,12 @@ +--- +title: SystemEngineSession.stopLoading - +--- + +[mozilla.components.browser.engine.system](../index.html) / [SystemEngineSession](index.html) / [stopLoading](./stop-loading.html) + +# stopLoading + +`fun stopLoading(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +See [EngineSession.stopLoading](#) + diff --git a/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-view/-image-handler/-init-.md b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-view/-image-handler/-init-.md new file mode 100644 index 00000000000..453bc52ba05 --- /dev/null +++ b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-view/-image-handler/-init-.md @@ -0,0 +1,9 @@ +--- +title: SystemEngineView.ImageHandler. - +--- + +[mozilla.components.browser.engine.system](../../index.html) / [SystemEngineView](../index.html) / [ImageHandler](index.html) / [<init>](./-init-.html) + +# <init> + +`ImageHandler(session: `[`SystemEngineSession`](../../-system-engine-session/index.html)`?)` \ No newline at end of file diff --git a/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-view/-image-handler/handle-message.md b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-view/-image-handler/handle-message.md new file mode 100644 index 00000000000..796e9ff8c94 --- /dev/null +++ b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-view/-image-handler/handle-message.md @@ -0,0 +1,9 @@ +--- +title: SystemEngineView.ImageHandler.handleMessage - +--- + +[mozilla.components.browser.engine.system](../../index.html) / [SystemEngineView](../index.html) / [ImageHandler](index.html) / [handleMessage](./handle-message.html) + +# handleMessage + +`fun handleMessage(msg: Message): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-view/-image-handler/index.md b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-view/-image-handler/index.md new file mode 100644 index 00000000000..b09fb5636e5 --- /dev/null +++ b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-view/-image-handler/index.md @@ -0,0 +1,22 @@ +--- +title: SystemEngineView.ImageHandler - +--- + +[mozilla.components.browser.engine.system](../../index.html) / [SystemEngineView](../index.html) / [ImageHandler](./index.html) + +# ImageHandler + +`class ImageHandler : Handler` + +### Constructors + +| [<init>](-init-.html) | `ImageHandler(session: `[`SystemEngineSession`](../../-system-engine-session/index.html)`?)` | + +### Properties + +| [session](session.html) | `val session: `[`SystemEngineSession`](../../-system-engine-session/index.html)`?` | + +### Functions + +| [handleMessage](handle-message.html) | `fun handleMessage(msg: Message): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | + diff --git a/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-view/-image-handler/session.md b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-view/-image-handler/session.md new file mode 100644 index 00000000000..ce8b0ed0a28 --- /dev/null +++ b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-view/-image-handler/session.md @@ -0,0 +1,9 @@ +--- +title: SystemEngineView.ImageHandler.session - +--- + +[mozilla.components.browser.engine.system](../../index.html) / [SystemEngineView](../index.html) / [ImageHandler](index.html) / [session](./session.html) + +# session + +`val session: `[`SystemEngineSession`](../../-system-engine-session/index.html)`?` \ No newline at end of file diff --git a/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-view/-init-.md b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-view/-init-.md new file mode 100644 index 00000000000..925c65d1794 --- /dev/null +++ b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-view/-init-.md @@ -0,0 +1,12 @@ +--- +title: SystemEngineView. - +--- + +[mozilla.components.browser.engine.system](../index.html) / [SystemEngineView](index.html) / [<init>](./-init-.html) + +# <init> + +`SystemEngineView(context: Context, attrs: AttributeSet? = null, defStyleAttr: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = 0)` + +WebView-based implementation of EngineView. + diff --git a/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-view/index.md b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-view/index.md new file mode 100644 index 00000000000..0dbcd7746cc --- /dev/null +++ b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-view/index.md @@ -0,0 +1,25 @@ +--- +title: SystemEngineView - +--- + +[mozilla.components.browser.engine.system](../index.html) / [SystemEngineView](./index.html) + +# SystemEngineView + +`class SystemEngineView : FrameLayout, EngineView, OnLongClickListener` + +WebView-based implementation of EngineView. + +### Types + +| [ImageHandler](-image-handler/index.html) | `class ImageHandler : Handler` | + +### Constructors + +| [<init>](-init-.html) | `SystemEngineView(context: Context, attrs: AttributeSet? = null, defStyleAttr: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = 0)`
WebView-based implementation of EngineView. | + +### Functions + +| [onLongClick](on-long-click.html) | `fun onLongClick(view: View?): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [render](render.html) | `fun render(session: EngineSession): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Render the content of the given session. | + diff --git a/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-view/on-long-click.md b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-view/on-long-click.md new file mode 100644 index 00000000000..b7ed8e9b4ea --- /dev/null +++ b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-view/on-long-click.md @@ -0,0 +1,9 @@ +--- +title: SystemEngineView.onLongClick - +--- + +[mozilla.components.browser.engine.system](../index.html) / [SystemEngineView](index.html) / [onLongClick](./on-long-click.html) + +# onLongClick + +`fun onLongClick(view: View?): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-view/render.md b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-view/render.md new file mode 100644 index 00000000000..c05916c4449 --- /dev/null +++ b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine-view/render.md @@ -0,0 +1,12 @@ +--- +title: SystemEngineView.render - +--- + +[mozilla.components.browser.engine.system](../index.html) / [SystemEngineView](index.html) / [render](./render.html) + +# render + +`fun render(session: EngineSession): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Render the content of the given session. + diff --git a/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine/-init-.md b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine/-init-.md new file mode 100644 index 00000000000..7b248ad2b7c --- /dev/null +++ b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine/-init-.md @@ -0,0 +1,12 @@ +--- +title: SystemEngine. - +--- + +[mozilla.components.browser.engine.system](../index.html) / [SystemEngine](index.html) / [<init>](./-init-.html) + +# <init> + +`SystemEngine(defaultSettings: DefaultSettings? = null)` + +WebView-based implementation of the Engine interface. + diff --git a/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine/create-session.md b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine/create-session.md new file mode 100644 index 00000000000..849d1c11e16 --- /dev/null +++ b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine/create-session.md @@ -0,0 +1,12 @@ +--- +title: SystemEngine.createSession - +--- + +[mozilla.components.browser.engine.system](../index.html) / [SystemEngine](index.html) / [createSession](./create-session.html) + +# createSession + +`fun createSession(private: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): EngineSession` + +Creates a new WebView-based EngineSession implementation. + diff --git a/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine/create-view.md b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine/create-view.md new file mode 100644 index 00000000000..f01ab4f25d9 --- /dev/null +++ b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine/create-view.md @@ -0,0 +1,12 @@ +--- +title: SystemEngine.createView - +--- + +[mozilla.components.browser.engine.system](../index.html) / [SystemEngine](index.html) / [createView](./create-view.html) + +# createView + +`fun createView(context: Context, attrs: AttributeSet?): EngineView` + +Creates a new WebView-based EngineView implementation. + diff --git a/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine/index.md b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine/index.md new file mode 100644 index 00000000000..c96d5b83168 --- /dev/null +++ b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine/index.md @@ -0,0 +1,26 @@ +--- +title: SystemEngine - +--- + +[mozilla.components.browser.engine.system](../index.html) / [SystemEngine](./index.html) + +# SystemEngine + +`class SystemEngine : Engine` + +WebView-based implementation of the Engine interface. + +### Constructors + +| [<init>](-init-.html) | `SystemEngine(defaultSettings: DefaultSettings? = null)`
WebView-based implementation of the Engine interface. | + +### Properties + +| [settings](settings.html) | `val settings: Settings`
See [Engine.settings](#) | + +### Functions + +| [createSession](create-session.html) | `fun createSession(private: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): EngineSession`
Creates a new WebView-based EngineSession implementation. | +| [createView](create-view.html) | `fun createView(context: Context, attrs: AttributeSet?): EngineView`
Creates a new WebView-based EngineView implementation. | +| [name](name.html) | `fun name(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
See [Engine.name](#) | + diff --git a/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine/name.md b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine/name.md new file mode 100644 index 00000000000..87fdc68eb08 --- /dev/null +++ b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine/name.md @@ -0,0 +1,12 @@ +--- +title: SystemEngine.name - +--- + +[mozilla.components.browser.engine.system](../index.html) / [SystemEngine](index.html) / [name](./name.html) + +# name + +`fun name(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) + +See [Engine.name](#) + diff --git a/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine/settings.md b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine/settings.md new file mode 100644 index 00000000000..ecbc5c8909f --- /dev/null +++ b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/-system-engine/settings.md @@ -0,0 +1,12 @@ +--- +title: SystemEngine.settings - +--- + +[mozilla.components.browser.engine.system](../index.html) / [SystemEngine](index.html) / [settings](./settings.html) + +# settings + +`val settings: Settings` + +See [Engine.settings](#) + diff --git a/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/index.md b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/index.md new file mode 100644 index 00000000000..2e66f9697a2 --- /dev/null +++ b/docs/api/0.21/browser-engine-system/mozilla.components.browser.engine.system/index.md @@ -0,0 +1,15 @@ +--- +title: mozilla.components.browser.engine.system - +--- + +[mozilla.components.browser.engine.system](./index.html) + +## Package mozilla.components.browser.engine.system + +### Types + +| [ScheduledLoad](-scheduled-load/index.html) | `data class ScheduledLoad`
Used for when we need to schedule loading a url or data with a mime type, if there isn't a session already created. | +| [SystemEngine](-system-engine/index.html) | `class SystemEngine : Engine`
WebView-based implementation of the Engine interface. | +| [SystemEngineSession](-system-engine-session/index.html) | `class SystemEngineSession : EngineSession`
WebView-based EngineSession implementation. | +| [SystemEngineView](-system-engine-view/index.html) | `class SystemEngineView : FrameLayout, EngineView, OnLongClickListener`
WebView-based implementation of EngineView. | + diff --git a/docs/api/0.21/browser-engine-system/package-list b/docs/api/0.21/browser-engine-system/package-list new file mode 100644 index 00000000000..1c5775ff959 --- /dev/null +++ b/docs/api/0.21/browser-engine-system/package-list @@ -0,0 +1,6 @@ +$dokka.format:jekyll +$dokka.linkExtension:html +$dokka.location:mozilla.components.browser.engine.system.matcher$reverse(kotlin.String)mozilla.components.browser.engine.system.matcher/kotlin.-string/reverse.html +$dokka.location:mozilla.components.browser.engine.system.matcher$reversible(kotlin.String)mozilla.components.browser.engine.system.matcher/kotlin.-string/reversible.html +mozilla.components.browser.engine.system +mozilla.components.browser.engine.system.matcher diff --git a/docs/api/0.21/browser-errorpages/alltypes/index.md b/docs/api/0.21/browser-errorpages/alltypes/index.md new file mode 100644 index 00000000000..70ac02d0cd7 --- /dev/null +++ b/docs/api/0.21/browser-errorpages/alltypes/index.md @@ -0,0 +1,8 @@ +--- +title: alltypes - +--- + +### All Types + +| [mozilla.components.browser.errorpages.ErrorPages](../mozilla.components.browser.errorpages/-error-pages/index.html) | | + diff --git a/docs/api/0.21/browser-errorpages/index.md b/docs/api/0.21/browser-errorpages/index.md new file mode 100644 index 00000000000..7b2f4d52c78 --- /dev/null +++ b/docs/api/0.21/browser-errorpages/index.md @@ -0,0 +1,11 @@ +--- +title: +--- + +### Packages + +| [mozilla.components.browser.errorpages](mozilla.components.browser.errorpages/index.html) | | + +### Index + +[All Types](alltypes/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-errorpages/mozilla.components.browser.errorpages/-error-pages/-error-type/-c-o-n-n-e-c-t-i-o-n_-f-a-i-l-u-r-e.md b/docs/api/0.21/browser-errorpages/mozilla.components.browser.errorpages/-error-pages/-error-type/-c-o-n-n-e-c-t-i-o-n_-f-a-i-l-u-r-e.md new file mode 100644 index 00000000000..f63ae6145d6 --- /dev/null +++ b/docs/api/0.21/browser-errorpages/mozilla.components.browser.errorpages/-error-pages/-error-type/-c-o-n-n-e-c-t-i-o-n_-f-a-i-l-u-r-e.md @@ -0,0 +1,15 @@ +--- +title: ErrorPages.ErrorType.CONNECTION_FAILURE - +--- + +[mozilla.components.browser.errorpages](../../index.html) / [ErrorPages](../index.html) / [ErrorType](index.html) / [CONNECTION_FAILURE](./-c-o-n-n-e-c-t-i-o-n_-f-a-i-l-u-r-e.html) + +# CONNECTION_FAILURE + +`CONNECTION_FAILURE` + +### Inherited Properties + +| [messageRes](message-res.html) | `val messageRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [titleRes](title-res.html) | `val titleRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | + diff --git a/docs/api/0.21/browser-errorpages/mozilla.components.browser.errorpages/-error-pages/-error-type/-c-o-n-n-e-c-t.md b/docs/api/0.21/browser-errorpages/mozilla.components.browser.errorpages/-error-pages/-error-type/-c-o-n-n-e-c-t.md new file mode 100644 index 00000000000..a87e41a679b --- /dev/null +++ b/docs/api/0.21/browser-errorpages/mozilla.components.browser.errorpages/-error-pages/-error-type/-c-o-n-n-e-c-t.md @@ -0,0 +1,15 @@ +--- +title: ErrorPages.ErrorType.CONNECT - +--- + +[mozilla.components.browser.errorpages](../../index.html) / [ErrorPages](../index.html) / [ErrorType](index.html) / [CONNECT](./-c-o-n-n-e-c-t.html) + +# CONNECT + +`CONNECT` + +### Inherited Properties + +| [messageRes](message-res.html) | `val messageRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [titleRes](title-res.html) | `val titleRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | + diff --git a/docs/api/0.21/browser-errorpages/mozilla.components.browser.errorpages/-error-pages/-error-type/-f-a-i-l-e-d_-s-s-l_-h-a-n-d-s-h-a-k-e.md b/docs/api/0.21/browser-errorpages/mozilla.components.browser.errorpages/-error-pages/-error-type/-f-a-i-l-e-d_-s-s-l_-h-a-n-d-s-h-a-k-e.md new file mode 100644 index 00000000000..f7f0ee8c8b9 --- /dev/null +++ b/docs/api/0.21/browser-errorpages/mozilla.components.browser.errorpages/-error-pages/-error-type/-f-a-i-l-e-d_-s-s-l_-h-a-n-d-s-h-a-k-e.md @@ -0,0 +1,15 @@ +--- +title: ErrorPages.ErrorType.FAILED_SSL_HANDSHAKE - +--- + +[mozilla.components.browser.errorpages](../../index.html) / [ErrorPages](../index.html) / [ErrorType](index.html) / [FAILED_SSL_HANDSHAKE](./-f-a-i-l-e-d_-s-s-l_-h-a-n-d-s-h-a-k-e.html) + +# FAILED_SSL_HANDSHAKE + +`FAILED_SSL_HANDSHAKE` + +### Inherited Properties + +| [messageRes](message-res.html) | `val messageRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [titleRes](title-res.html) | `val titleRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | + diff --git a/docs/api/0.21/browser-errorpages/mozilla.components.browser.errorpages/-error-pages/-error-type/-g-e-n-e-r-i-c.md b/docs/api/0.21/browser-errorpages/mozilla.components.browser.errorpages/-error-pages/-error-type/-g-e-n-e-r-i-c.md new file mode 100644 index 00000000000..7439e1d7c04 --- /dev/null +++ b/docs/api/0.21/browser-errorpages/mozilla.components.browser.errorpages/-error-pages/-error-type/-g-e-n-e-r-i-c.md @@ -0,0 +1,15 @@ +--- +title: ErrorPages.ErrorType.GENERIC - +--- + +[mozilla.components.browser.errorpages](../../index.html) / [ErrorPages](../index.html) / [ErrorType](index.html) / [GENERIC](./-g-e-n-e-r-i-c.html) + +# GENERIC + +`GENERIC` + +### Inherited Properties + +| [messageRes](message-res.html) | `val messageRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [titleRes](title-res.html) | `val titleRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | + diff --git a/docs/api/0.21/browser-errorpages/mozilla.components.browser.errorpages/-error-pages/-error-type/-h-o-s-t_-l-o-o-k-u-p.md b/docs/api/0.21/browser-errorpages/mozilla.components.browser.errorpages/-error-pages/-error-type/-h-o-s-t_-l-o-o-k-u-p.md new file mode 100644 index 00000000000..cc0f740f2d5 --- /dev/null +++ b/docs/api/0.21/browser-errorpages/mozilla.components.browser.errorpages/-error-pages/-error-type/-h-o-s-t_-l-o-o-k-u-p.md @@ -0,0 +1,15 @@ +--- +title: ErrorPages.ErrorType.HOST_LOOKUP - +--- + +[mozilla.components.browser.errorpages](../../index.html) / [ErrorPages](../index.html) / [ErrorType](index.html) / [HOST_LOOKUP](./-h-o-s-t_-l-o-o-k-u-p.html) + +# HOST_LOOKUP + +`HOST_LOOKUP` + +### Inherited Properties + +| [messageRes](message-res.html) | `val messageRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [titleRes](title-res.html) | `val titleRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | + diff --git a/docs/api/0.21/browser-errorpages/mozilla.components.browser.errorpages/-error-pages/-error-type/-m-a-l-f-o-r-m-e-d_-u-r-i.md b/docs/api/0.21/browser-errorpages/mozilla.components.browser.errorpages/-error-pages/-error-type/-m-a-l-f-o-r-m-e-d_-u-r-i.md new file mode 100644 index 00000000000..f6536d88a7f --- /dev/null +++ b/docs/api/0.21/browser-errorpages/mozilla.components.browser.errorpages/-error-pages/-error-type/-m-a-l-f-o-r-m-e-d_-u-r-i.md @@ -0,0 +1,15 @@ +--- +title: ErrorPages.ErrorType.MALFORMED_URI - +--- + +[mozilla.components.browser.errorpages](../../index.html) / [ErrorPages](../index.html) / [ErrorType](index.html) / [MALFORMED_URI](./-m-a-l-f-o-r-m-e-d_-u-r-i.html) + +# MALFORMED_URI + +`MALFORMED_URI` + +### Inherited Properties + +| [messageRes](message-res.html) | `val messageRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [titleRes](title-res.html) | `val titleRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | + diff --git a/docs/api/0.21/browser-errorpages/mozilla.components.browser.errorpages/-error-pages/-error-type/-r-e-d-i-r-e-c-t_-l-o-o-p.md b/docs/api/0.21/browser-errorpages/mozilla.components.browser.errorpages/-error-pages/-error-type/-r-e-d-i-r-e-c-t_-l-o-o-p.md new file mode 100644 index 00000000000..7a2e2552cce --- /dev/null +++ b/docs/api/0.21/browser-errorpages/mozilla.components.browser.errorpages/-error-pages/-error-type/-r-e-d-i-r-e-c-t_-l-o-o-p.md @@ -0,0 +1,15 @@ +--- +title: ErrorPages.ErrorType.REDIRECT_LOOP - +--- + +[mozilla.components.browser.errorpages](../../index.html) / [ErrorPages](../index.html) / [ErrorType](index.html) / [REDIRECT_LOOP](./-r-e-d-i-r-e-c-t_-l-o-o-p.html) + +# REDIRECT_LOOP + +`REDIRECT_LOOP` + +### Inherited Properties + +| [messageRes](message-res.html) | `val messageRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [titleRes](title-res.html) | `val titleRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | + diff --git a/docs/api/0.21/browser-errorpages/mozilla.components.browser.errorpages/-error-pages/-error-type/-t-i-m-e-o-u-t.md b/docs/api/0.21/browser-errorpages/mozilla.components.browser.errorpages/-error-pages/-error-type/-t-i-m-e-o-u-t.md new file mode 100644 index 00000000000..ba5ca5a451a --- /dev/null +++ b/docs/api/0.21/browser-errorpages/mozilla.components.browser.errorpages/-error-pages/-error-type/-t-i-m-e-o-u-t.md @@ -0,0 +1,15 @@ +--- +title: ErrorPages.ErrorType.TIMEOUT - +--- + +[mozilla.components.browser.errorpages](../../index.html) / [ErrorPages](../index.html) / [ErrorType](index.html) / [TIMEOUT](./-t-i-m-e-o-u-t.html) + +# TIMEOUT + +`TIMEOUT` + +### Inherited Properties + +| [messageRes](message-res.html) | `val messageRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [titleRes](title-res.html) | `val titleRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | + diff --git a/docs/api/0.21/browser-errorpages/mozilla.components.browser.errorpages/-error-pages/-error-type/-u-n-s-u-p-p-o-r-t-e-d_-p-r-o-t-o-c-o-l.md b/docs/api/0.21/browser-errorpages/mozilla.components.browser.errorpages/-error-pages/-error-type/-u-n-s-u-p-p-o-r-t-e-d_-p-r-o-t-o-c-o-l.md new file mode 100644 index 00000000000..c36960f22f1 --- /dev/null +++ b/docs/api/0.21/browser-errorpages/mozilla.components.browser.errorpages/-error-pages/-error-type/-u-n-s-u-p-p-o-r-t-e-d_-p-r-o-t-o-c-o-l.md @@ -0,0 +1,15 @@ +--- +title: ErrorPages.ErrorType.UNSUPPORTED_PROTOCOL - +--- + +[mozilla.components.browser.errorpages](../../index.html) / [ErrorPages](../index.html) / [ErrorType](index.html) / [UNSUPPORTED_PROTOCOL](./-u-n-s-u-p-p-o-r-t-e-d_-p-r-o-t-o-c-o-l.html) + +# UNSUPPORTED_PROTOCOL + +`UNSUPPORTED_PROTOCOL` + +### Inherited Properties + +| [messageRes](message-res.html) | `val messageRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [titleRes](title-res.html) | `val titleRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | + diff --git a/docs/api/0.21/browser-errorpages/mozilla.components.browser.errorpages/-error-pages/-error-type/index.md b/docs/api/0.21/browser-errorpages/mozilla.components.browser.errorpages/-error-pages/-error-type/index.md new file mode 100644 index 00000000000..203efb4ba75 --- /dev/null +++ b/docs/api/0.21/browser-errorpages/mozilla.components.browser.errorpages/-error-pages/-error-type/index.md @@ -0,0 +1,29 @@ +--- +title: ErrorPages.ErrorType - +--- + +[mozilla.components.browser.errorpages](../../index.html) / [ErrorPages](../index.html) / [ErrorType](./index.html) + +# ErrorType + +`enum class ErrorType` + +Enum containing all supported error types that we can display an error page for. + +### Enum Values + +| [GENERIC](-g-e-n-e-r-i-c.html) | | +| [CONNECTION_FAILURE](-c-o-n-n-e-c-t-i-o-n_-f-a-i-l-u-r-e.html) | | +| [HOST_LOOKUP](-h-o-s-t_-l-o-o-k-u-p.html) | | +| [CONNECT](-c-o-n-n-e-c-t.html) | | +| [TIMEOUT](-t-i-m-e-o-u-t.html) | | +| [REDIRECT_LOOP](-r-e-d-i-r-e-c-t_-l-o-o-p.html) | | +| [UNSUPPORTED_PROTOCOL](-u-n-s-u-p-p-o-r-t-e-d_-p-r-o-t-o-c-o-l.html) | | +| [MALFORMED_URI](-m-a-l-f-o-r-m-e-d_-u-r-i.html) | | +| [FAILED_SSL_HANDSHAKE](-f-a-i-l-e-d_-s-s-l_-h-a-n-d-s-h-a-k-e.html) | | + +### Properties + +| [messageRes](message-res.html) | `val messageRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [titleRes](title-res.html) | `val titleRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | + diff --git a/docs/api/0.21/browser-errorpages/mozilla.components.browser.errorpages/-error-pages/-error-type/message-res.md b/docs/api/0.21/browser-errorpages/mozilla.components.browser.errorpages/-error-pages/-error-type/message-res.md new file mode 100644 index 00000000000..cf7bfedcf31 --- /dev/null +++ b/docs/api/0.21/browser-errorpages/mozilla.components.browser.errorpages/-error-pages/-error-type/message-res.md @@ -0,0 +1,9 @@ +--- +title: ErrorPages.ErrorType.messageRes - +--- + +[mozilla.components.browser.errorpages](../../index.html) / [ErrorPages](../index.html) / [ErrorType](index.html) / [messageRes](./message-res.html) + +# messageRes + +`val messageRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-errorpages/mozilla.components.browser.errorpages/-error-pages/-error-type/title-res.md b/docs/api/0.21/browser-errorpages/mozilla.components.browser.errorpages/-error-pages/-error-type/title-res.md new file mode 100644 index 00000000000..b79e6f90ea6 --- /dev/null +++ b/docs/api/0.21/browser-errorpages/mozilla.components.browser.errorpages/-error-pages/-error-type/title-res.md @@ -0,0 +1,9 @@ +--- +title: ErrorPages.ErrorType.titleRes - +--- + +[mozilla.components.browser.errorpages](../../index.html) / [ErrorPages](../index.html) / [ErrorType](index.html) / [titleRes](./title-res.html) + +# titleRes + +`val titleRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-errorpages/mozilla.components.browser.errorpages/-error-pages/create-error-page.md b/docs/api/0.21/browser-errorpages/mozilla.components.browser.errorpages/-error-pages/create-error-page.md new file mode 100644 index 00000000000..4549e1f6cc4 --- /dev/null +++ b/docs/api/0.21/browser-errorpages/mozilla.components.browser.errorpages/-error-pages/create-error-page.md @@ -0,0 +1,12 @@ +--- +title: ErrorPages.createErrorPage - +--- + +[mozilla.components.browser.errorpages](../index.html) / [ErrorPages](index.html) / [createErrorPage](./create-error-page.html) + +# createErrorPage + +`fun createErrorPage(context: Context, errorType: `[`ErrorType`](-error-type/index.html)`): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) + +Load and generate error page for the given error type. + diff --git a/docs/api/0.21/browser-errorpages/mozilla.components.browser.errorpages/-error-pages/index.md b/docs/api/0.21/browser-errorpages/mozilla.components.browser.errorpages/-error-pages/index.md new file mode 100644 index 00000000000..6155d7400ee --- /dev/null +++ b/docs/api/0.21/browser-errorpages/mozilla.components.browser.errorpages/-error-pages/index.md @@ -0,0 +1,19 @@ +--- +title: ErrorPages - +--- + +[mozilla.components.browser.errorpages](../index.html) / [ErrorPages](./index.html) + +# ErrorPages + +`object ErrorPages` + +### Types + +| [ErrorType](-error-type/index.html) | `enum class ErrorType`
Enum containing all supported error types that we can display an error page for. | + +### Functions + +| [createErrorPage](create-error-page.html) | `fun createErrorPage(context: Context, errorType: `[`ErrorType`](-error-type/index.html)`): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Load and generate error page for the given error type. | +| [mapWebViewErrorCodeToErrorType](map-web-view-error-code-to-error-type.html) | `fun mapWebViewErrorCodeToErrorType(errorCode: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`ErrorType`](-error-type/index.html)
Map a WebView error code (WebViewClient.ERROR_*) to an element of the ErrorType enum. | + diff --git a/docs/api/0.21/browser-errorpages/mozilla.components.browser.errorpages/-error-pages/map-web-view-error-code-to-error-type.md b/docs/api/0.21/browser-errorpages/mozilla.components.browser.errorpages/-error-pages/map-web-view-error-code-to-error-type.md new file mode 100644 index 00000000000..76973d8dc69 --- /dev/null +++ b/docs/api/0.21/browser-errorpages/mozilla.components.browser.errorpages/-error-pages/map-web-view-error-code-to-error-type.md @@ -0,0 +1,12 @@ +--- +title: ErrorPages.mapWebViewErrorCodeToErrorType - +--- + +[mozilla.components.browser.errorpages](../index.html) / [ErrorPages](index.html) / [mapWebViewErrorCodeToErrorType](./map-web-view-error-code-to-error-type.html) + +# mapWebViewErrorCodeToErrorType + +`fun mapWebViewErrorCodeToErrorType(errorCode: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`ErrorType`](-error-type/index.html) + +Map a WebView error code (WebViewClient.ERROR_*) to an element of the ErrorType enum. + diff --git a/docs/api/0.21/browser-errorpages/mozilla.components.browser.errorpages/index.md b/docs/api/0.21/browser-errorpages/mozilla.components.browser.errorpages/index.md new file mode 100644 index 00000000000..69b1cea5438 --- /dev/null +++ b/docs/api/0.21/browser-errorpages/mozilla.components.browser.errorpages/index.md @@ -0,0 +1,12 @@ +--- +title: mozilla.components.browser.errorpages - +--- + +[mozilla.components.browser.errorpages](./index.html) + +## Package mozilla.components.browser.errorpages + +### Types + +| [ErrorPages](-error-pages/index.html) | `object ErrorPages` | + diff --git a/docs/api/0.21/browser-errorpages/package-list b/docs/api/0.21/browser-errorpages/package-list new file mode 100644 index 00000000000..6105264177d --- /dev/null +++ b/docs/api/0.21/browser-errorpages/package-list @@ -0,0 +1,4 @@ +$dokka.format:jekyll +$dokka.linkExtension:html + +mozilla.components.browser.errorpages diff --git a/docs/api/0.21/browser-menu/alltypes/index.md b/docs/api/0.21/browser-menu/alltypes/index.md new file mode 100644 index 00000000000..ca90a532070 --- /dev/null +++ b/docs/api/0.21/browser-menu/alltypes/index.md @@ -0,0 +1,14 @@ +--- +title: alltypes - +--- + +### All Types + +| [mozilla.components.browser.menu.BrowserMenu](../mozilla.components.browser.menu/-browser-menu/index.html) | A popup menu composed of BrowserMenuItem objects. | +| [mozilla.components.browser.menu.BrowserMenuBuilder](../mozilla.components.browser.menu/-browser-menu-builder/index.html) | Helper class for building browser menus. | +| [mozilla.components.browser.menu.BrowserMenuItem](../mozilla.components.browser.menu/-browser-menu-item/index.html) | Interface to be implemented by menu items to be shown in the browser menu. | +| [mozilla.components.browser.menu.item.BrowserMenuItemToolbar](../mozilla.components.browser.menu.item/-browser-menu-item-toolbar/index.html) | A toolbar of buttons to show inside the browser menu. | +| [mozilla.components.browser.menu.BrowserMenuItemViewHolder](../mozilla.components.browser.menu/-browser-menu-item-view-holder/index.html) | | +| [mozilla.components.browser.menu.item.SimpleBrowserMenuCheckbox](../mozilla.components.browser.menu.item/-simple-browser-menu-checkbox/index.html) | A simple browser menu checkbox. | +| [mozilla.components.browser.menu.item.SimpleBrowserMenuItem](../mozilla.components.browser.menu.item/-simple-browser-menu-item/index.html) | A simple browser menu item displaying text. | + diff --git a/docs/api/0.21/browser-menu/index.md b/docs/api/0.21/browser-menu/index.md new file mode 100644 index 00000000000..9acdba98a64 --- /dev/null +++ b/docs/api/0.21/browser-menu/index.md @@ -0,0 +1,12 @@ +--- +title: +--- + +### Packages + +| [mozilla.components.browser.menu](mozilla.components.browser.menu/index.html) | | +| [mozilla.components.browser.menu.item](mozilla.components.browser.menu.item/index.html) | | + +### Index + +[All Types](alltypes/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/-button/-init-.md b/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/-button/-init-.md new file mode 100644 index 00000000000..64233bce933 --- /dev/null +++ b/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/-button/-init-.md @@ -0,0 +1,21 @@ +--- +title: BrowserMenuItemToolbar.Button. - +--- + +[mozilla.components.browser.menu.item](../../index.html) / [BrowserMenuItemToolbar](../index.html) / [Button](index.html) / [<init>](./-init-.html) + +# <init> + +`Button(imageResource: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, contentDescription: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, iconTintColorResource: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = 0, listener: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`)` + +A button to be shown in a toolbar inside the browser menu. + +### Parameters + +`imageResource` - ID of a drawable resource to be shown as icon. + +`contentDescription` - The button's content description, used for accessibility support. + +`iconTintColorResource` - Optional ID of color resource to tint the icon. + +`listener` - Callback to be invoked when the button is pressed. \ No newline at end of file diff --git a/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/-button/content-description.md b/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/-button/content-description.md new file mode 100644 index 00000000000..fc1a3fcdcc9 --- /dev/null +++ b/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/-button/content-description.md @@ -0,0 +1,12 @@ +--- +title: BrowserMenuItemToolbar.Button.contentDescription - +--- + +[mozilla.components.browser.menu.item](../../index.html) / [BrowserMenuItemToolbar](../index.html) / [Button](index.html) / [contentDescription](./content-description.html) + +# contentDescription + +`val contentDescription: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) + +The button's content description, used for accessibility support. + diff --git a/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/-button/icon-tint-color-resource.md b/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/-button/icon-tint-color-resource.md new file mode 100644 index 00000000000..0e02c973199 --- /dev/null +++ b/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/-button/icon-tint-color-resource.md @@ -0,0 +1,12 @@ +--- +title: BrowserMenuItemToolbar.Button.iconTintColorResource - +--- + +[mozilla.components.browser.menu.item](../../index.html) / [BrowserMenuItemToolbar](../index.html) / [Button](index.html) / [iconTintColorResource](./icon-tint-color-resource.html) + +# iconTintColorResource + +`val iconTintColorResource: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +Optional ID of color resource to tint the icon. + diff --git a/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/-button/image-resource.md b/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/-button/image-resource.md new file mode 100644 index 00000000000..08c2657ba70 --- /dev/null +++ b/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/-button/image-resource.md @@ -0,0 +1,12 @@ +--- +title: BrowserMenuItemToolbar.Button.imageResource - +--- + +[mozilla.components.browser.menu.item](../../index.html) / [BrowserMenuItemToolbar](../index.html) / [Button](index.html) / [imageResource](./image-resource.html) + +# imageResource + +`val imageResource: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +ID of a drawable resource to be shown as icon. + diff --git a/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/-button/index.md b/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/-button/index.md new file mode 100644 index 00000000000..cd49fa8d49d --- /dev/null +++ b/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/-button/index.md @@ -0,0 +1,33 @@ +--- +title: BrowserMenuItemToolbar.Button - +--- + +[mozilla.components.browser.menu.item](../../index.html) / [BrowserMenuItemToolbar](../index.html) / [Button](./index.html) + +# Button + +`class Button` + +A button to be shown in a toolbar inside the browser menu. + +### Parameters + +`imageResource` - ID of a drawable resource to be shown as icon. + +`contentDescription` - The button's content description, used for accessibility support. + +`iconTintColorResource` - Optional ID of color resource to tint the icon. + +`listener` - Callback to be invoked when the button is pressed. + +### Constructors + +| [<init>](-init-.html) | `Button(imageResource: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, contentDescription: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, iconTintColorResource: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = 0, listener: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`)`
A button to be shown in a toolbar inside the browser menu. | + +### Properties + +| [contentDescription](content-description.html) | `val contentDescription: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
The button's content description, used for accessibility support. | +| [iconTintColorResource](icon-tint-color-resource.html) | `val iconTintColorResource: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Optional ID of color resource to tint the icon. | +| [imageResource](image-resource.html) | `val imageResource: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
ID of a drawable resource to be shown as icon. | +| [listener](listener.html) | `val listener: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Callback to be invoked when the button is pressed. | + diff --git a/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/-button/listener.md b/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/-button/listener.md new file mode 100644 index 00000000000..5387eeb1786 --- /dev/null +++ b/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/-button/listener.md @@ -0,0 +1,12 @@ +--- +title: BrowserMenuItemToolbar.Button.listener - +--- + +[mozilla.components.browser.menu.item](../../index.html) / [BrowserMenuItemToolbar](../index.html) / [Button](index.html) / [listener](./listener.html) + +# listener + +`val listener: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Callback to be invoked when the button is pressed. + diff --git a/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/-init-.md b/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/-init-.md new file mode 100644 index 00000000000..be1d12f88af --- /dev/null +++ b/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/-init-.md @@ -0,0 +1,12 @@ +--- +title: BrowserMenuItemToolbar. - +--- + +[mozilla.components.browser.menu.item](../index.html) / [BrowserMenuItemToolbar](index.html) / [<init>](./-init-.html) + +# <init> + +`BrowserMenuItemToolbar(items: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Button`](-button/index.html)`>)` + +A toolbar of buttons to show inside the browser menu. + diff --git a/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/bind.md b/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/bind.md new file mode 100644 index 00000000000..1a1da50ec54 --- /dev/null +++ b/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/bind.md @@ -0,0 +1,14 @@ +--- +title: BrowserMenuItemToolbar.bind - +--- + +[mozilla.components.browser.menu.item](../index.html) / [BrowserMenuItemToolbar](index.html) / [bind](./bind.html) + +# bind + +`fun bind(menu: `[`BrowserMenu`](../../mozilla.components.browser.menu/-browser-menu/index.html)`, view: View): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Overrides [BrowserMenuItem.bind](../../mozilla.components.browser.menu/-browser-menu-item/bind.html) + +Called by the browser menu to display the data of this item using the passed view. + diff --git a/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/get-layout-resource.md b/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/get-layout-resource.md new file mode 100644 index 00000000000..e56c01879b9 --- /dev/null +++ b/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/get-layout-resource.md @@ -0,0 +1,15 @@ +--- +title: BrowserMenuItemToolbar.getLayoutResource - +--- + +[mozilla.components.browser.menu.item](../index.html) / [BrowserMenuItemToolbar](index.html) / [getLayoutResource](./get-layout-resource.html) + +# getLayoutResource + +`fun getLayoutResource(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +Overrides [BrowserMenuItem.getLayoutResource](../../mozilla.components.browser.menu/-browser-menu-item/get-layout-resource.html) + +Returns the layout resource ID of the layout to be inflated for showing a menu item of this +type. + diff --git a/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/index.md b/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/index.md new file mode 100644 index 00000000000..465cfad5c15 --- /dev/null +++ b/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/index.md @@ -0,0 +1,29 @@ +--- +title: BrowserMenuItemToolbar - +--- + +[mozilla.components.browser.menu.item](../index.html) / [BrowserMenuItemToolbar](./index.html) + +# BrowserMenuItemToolbar + +`class BrowserMenuItemToolbar : `[`BrowserMenuItem`](../../mozilla.components.browser.menu/-browser-menu-item/index.html) + +A toolbar of buttons to show inside the browser menu. + +### Types + +| [Button](-button/index.html) | `class Button`
A button to be shown in a toolbar inside the browser menu. | + +### Constructors + +| [<init>](-init-.html) | `BrowserMenuItemToolbar(items: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Button`](-button/index.html)`>)`
A toolbar of buttons to show inside the browser menu. | + +### Properties + +| [visible](visible.html) | `val visible: () -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Lambda expression that returns true if this item should be shown in the menu. Returns false if this item should be hidden. | + +### Functions + +| [bind](bind.html) | `fun bind(menu: `[`BrowserMenu`](../../mozilla.components.browser.menu/-browser-menu/index.html)`, view: View): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Called by the browser menu to display the data of this item using the passed view. | +| [getLayoutResource](get-layout-resource.html) | `fun getLayoutResource(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Returns the layout resource ID of the layout to be inflated for showing a menu item of this type. | + diff --git a/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/visible.md b/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/visible.md new file mode 100644 index 00000000000..aac8106bc8a --- /dev/null +++ b/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/visible.md @@ -0,0 +1,15 @@ +--- +title: BrowserMenuItemToolbar.visible - +--- + +[mozilla.components.browser.menu.item](../index.html) / [BrowserMenuItemToolbar](index.html) / [visible](./visible.html) + +# visible + +`val visible: () -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Overrides [BrowserMenuItem.visible](../../mozilla.components.browser.menu/-browser-menu-item/visible.html) + +Lambda expression that returns true if this item should be shown in the menu. Returns false +if this item should be hidden. + diff --git a/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/-simple-browser-menu-checkbox/-init-.md b/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/-simple-browser-menu-checkbox/-init-.md new file mode 100644 index 00000000000..bd595823c46 --- /dev/null +++ b/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/-simple-browser-menu-checkbox/-init-.md @@ -0,0 +1,19 @@ +--- +title: SimpleBrowserMenuCheckbox. - +--- + +[mozilla.components.browser.menu.item](../index.html) / [SimpleBrowserMenuCheckbox](index.html) / [<init>](./-init-.html) + +# <init> + +`SimpleBrowserMenuCheckbox(label: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, initialState: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, listener: (`[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`)` + +A simple browser menu checkbox. + +### Parameters + +`label` - The visible label of this menu item. + +`initialState` - The initial value the checkbox should have. + +`listener` - Callback to be invoked when this menu item is checked. \ No newline at end of file diff --git a/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/-simple-browser-menu-checkbox/bind.md b/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/-simple-browser-menu-checkbox/bind.md new file mode 100644 index 00000000000..85e1eb48fc4 --- /dev/null +++ b/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/-simple-browser-menu-checkbox/bind.md @@ -0,0 +1,14 @@ +--- +title: SimpleBrowserMenuCheckbox.bind - +--- + +[mozilla.components.browser.menu.item](../index.html) / [SimpleBrowserMenuCheckbox](index.html) / [bind](./bind.html) + +# bind + +`fun bind(menu: `[`BrowserMenu`](../../mozilla.components.browser.menu/-browser-menu/index.html)`, view: View): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Overrides [BrowserMenuItem.bind](../../mozilla.components.browser.menu/-browser-menu-item/bind.html) + +Called by the browser menu to display the data of this item using the passed view. + diff --git a/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/-simple-browser-menu-checkbox/get-layout-resource.md b/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/-simple-browser-menu-checkbox/get-layout-resource.md new file mode 100644 index 00000000000..0aee0f4853c --- /dev/null +++ b/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/-simple-browser-menu-checkbox/get-layout-resource.md @@ -0,0 +1,15 @@ +--- +title: SimpleBrowserMenuCheckbox.getLayoutResource - +--- + +[mozilla.components.browser.menu.item](../index.html) / [SimpleBrowserMenuCheckbox](index.html) / [getLayoutResource](./get-layout-resource.html) + +# getLayoutResource + +`fun getLayoutResource(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +Overrides [BrowserMenuItem.getLayoutResource](../../mozilla.components.browser.menu/-browser-menu-item/get-layout-resource.html) + +Returns the layout resource ID of the layout to be inflated for showing a menu item of this +type. + diff --git a/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/-simple-browser-menu-checkbox/index.md b/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/-simple-browser-menu-checkbox/index.md new file mode 100644 index 00000000000..56a1b0df26a --- /dev/null +++ b/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/-simple-browser-menu-checkbox/index.md @@ -0,0 +1,33 @@ +--- +title: SimpleBrowserMenuCheckbox - +--- + +[mozilla.components.browser.menu.item](../index.html) / [SimpleBrowserMenuCheckbox](./index.html) + +# SimpleBrowserMenuCheckbox + +`class SimpleBrowserMenuCheckbox : `[`BrowserMenuItem`](../../mozilla.components.browser.menu/-browser-menu-item/index.html) + +A simple browser menu checkbox. + +### Parameters + +`label` - The visible label of this menu item. + +`initialState` - The initial value the checkbox should have. + +`listener` - Callback to be invoked when this menu item is checked. + +### Constructors + +| [<init>](-init-.html) | `SimpleBrowserMenuCheckbox(label: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, initialState: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, listener: (`[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`)`
A simple browser menu checkbox. | + +### Properties + +| [visible](visible.html) | `var visible: () -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Lambda expression that returns true if this item should be shown in the menu. Returns false if this item should be hidden. | + +### Functions + +| [bind](bind.html) | `fun bind(menu: `[`BrowserMenu`](../../mozilla.components.browser.menu/-browser-menu/index.html)`, view: View): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Called by the browser menu to display the data of this item using the passed view. | +| [getLayoutResource](get-layout-resource.html) | `fun getLayoutResource(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Returns the layout resource ID of the layout to be inflated for showing a menu item of this type. | + diff --git a/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/-simple-browser-menu-checkbox/visible.md b/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/-simple-browser-menu-checkbox/visible.md new file mode 100644 index 00000000000..bb1c35a2859 --- /dev/null +++ b/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/-simple-browser-menu-checkbox/visible.md @@ -0,0 +1,15 @@ +--- +title: SimpleBrowserMenuCheckbox.visible - +--- + +[mozilla.components.browser.menu.item](../index.html) / [SimpleBrowserMenuCheckbox](index.html) / [visible](./visible.html) + +# visible + +`var visible: () -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Overrides [BrowserMenuItem.visible](../../mozilla.components.browser.menu/-browser-menu-item/visible.html) + +Lambda expression that returns true if this item should be shown in the menu. Returns false +if this item should be hidden. + diff --git a/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/-simple-browser-menu-item/-init-.md b/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/-simple-browser-menu-item/-init-.md new file mode 100644 index 00000000000..8b50ba25909 --- /dev/null +++ b/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/-simple-browser-menu-item/-init-.md @@ -0,0 +1,17 @@ +--- +title: SimpleBrowserMenuItem. - +--- + +[mozilla.components.browser.menu.item](../index.html) / [SimpleBrowserMenuItem](index.html) / [<init>](./-init-.html) + +# <init> + +`SimpleBrowserMenuItem(label: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, listener: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`)` + +A simple browser menu item displaying text. + +### Parameters + +`label` - The visible label of this menu item. + +`listener` - Callback to be invoked when this menu item is clicked. \ No newline at end of file diff --git a/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/-simple-browser-menu-item/bind.md b/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/-simple-browser-menu-item/bind.md new file mode 100644 index 00000000000..3752f2dfbf8 --- /dev/null +++ b/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/-simple-browser-menu-item/bind.md @@ -0,0 +1,14 @@ +--- +title: SimpleBrowserMenuItem.bind - +--- + +[mozilla.components.browser.menu.item](../index.html) / [SimpleBrowserMenuItem](index.html) / [bind](./bind.html) + +# bind + +`fun bind(menu: `[`BrowserMenu`](../../mozilla.components.browser.menu/-browser-menu/index.html)`, view: View): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Overrides [BrowserMenuItem.bind](../../mozilla.components.browser.menu/-browser-menu-item/bind.html) + +Called by the browser menu to display the data of this item using the passed view. + diff --git a/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/-simple-browser-menu-item/get-layout-resource.md b/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/-simple-browser-menu-item/get-layout-resource.md new file mode 100644 index 00000000000..0ed3737e2b9 --- /dev/null +++ b/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/-simple-browser-menu-item/get-layout-resource.md @@ -0,0 +1,15 @@ +--- +title: SimpleBrowserMenuItem.getLayoutResource - +--- + +[mozilla.components.browser.menu.item](../index.html) / [SimpleBrowserMenuItem](index.html) / [getLayoutResource](./get-layout-resource.html) + +# getLayoutResource + +`fun getLayoutResource(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +Overrides [BrowserMenuItem.getLayoutResource](../../mozilla.components.browser.menu/-browser-menu-item/get-layout-resource.html) + +Returns the layout resource ID of the layout to be inflated for showing a menu item of this +type. + diff --git a/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/-simple-browser-menu-item/index.md b/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/-simple-browser-menu-item/index.md new file mode 100644 index 00000000000..efbe4151e0a --- /dev/null +++ b/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/-simple-browser-menu-item/index.md @@ -0,0 +1,31 @@ +--- +title: SimpleBrowserMenuItem - +--- + +[mozilla.components.browser.menu.item](../index.html) / [SimpleBrowserMenuItem](./index.html) + +# SimpleBrowserMenuItem + +`class SimpleBrowserMenuItem : `[`BrowserMenuItem`](../../mozilla.components.browser.menu/-browser-menu-item/index.html) + +A simple browser menu item displaying text. + +### Parameters + +`label` - The visible label of this menu item. + +`listener` - Callback to be invoked when this menu item is clicked. + +### Constructors + +| [<init>](-init-.html) | `SimpleBrowserMenuItem(label: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, listener: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`)`
A simple browser menu item displaying text. | + +### Properties + +| [visible](visible.html) | `var visible: () -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Lambda expression that returns true if this item should be shown in the menu. Returns false if this item should be hidden. | + +### Functions + +| [bind](bind.html) | `fun bind(menu: `[`BrowserMenu`](../../mozilla.components.browser.menu/-browser-menu/index.html)`, view: View): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Called by the browser menu to display the data of this item using the passed view. | +| [getLayoutResource](get-layout-resource.html) | `fun getLayoutResource(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Returns the layout resource ID of the layout to be inflated for showing a menu item of this type. | + diff --git a/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/-simple-browser-menu-item/visible.md b/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/-simple-browser-menu-item/visible.md new file mode 100644 index 00000000000..de7e75bf9d1 --- /dev/null +++ b/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/-simple-browser-menu-item/visible.md @@ -0,0 +1,15 @@ +--- +title: SimpleBrowserMenuItem.visible - +--- + +[mozilla.components.browser.menu.item](../index.html) / [SimpleBrowserMenuItem](index.html) / [visible](./visible.html) + +# visible + +`var visible: () -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Overrides [BrowserMenuItem.visible](../../mozilla.components.browser.menu/-browser-menu-item/visible.html) + +Lambda expression that returns true if this item should be shown in the menu. Returns false +if this item should be hidden. + diff --git a/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/index.md b/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/index.md new file mode 100644 index 00000000000..60a77d2ff7f --- /dev/null +++ b/docs/api/0.21/browser-menu/mozilla.components.browser.menu.item/index.md @@ -0,0 +1,14 @@ +--- +title: mozilla.components.browser.menu.item - +--- + +[mozilla.components.browser.menu.item](./index.html) + +## Package mozilla.components.browser.menu.item + +### Types + +| [BrowserMenuItemToolbar](-browser-menu-item-toolbar/index.html) | `class BrowserMenuItemToolbar : `[`BrowserMenuItem`](../mozilla.components.browser.menu/-browser-menu-item/index.html)
A toolbar of buttons to show inside the browser menu. | +| [SimpleBrowserMenuCheckbox](-simple-browser-menu-checkbox/index.html) | `class SimpleBrowserMenuCheckbox : `[`BrowserMenuItem`](../mozilla.components.browser.menu/-browser-menu-item/index.html)
A simple browser menu checkbox. | +| [SimpleBrowserMenuItem](-simple-browser-menu-item/index.html) | `class SimpleBrowserMenuItem : `[`BrowserMenuItem`](../mozilla.components.browser.menu/-browser-menu-item/index.html)
A simple browser menu item displaying text. | + diff --git a/docs/api/0.21/browser-menu/mozilla.components.browser.menu/-browser-menu-builder/-init-.md b/docs/api/0.21/browser-menu/mozilla.components.browser.menu/-browser-menu-builder/-init-.md new file mode 100644 index 00000000000..135081a8520 --- /dev/null +++ b/docs/api/0.21/browser-menu/mozilla.components.browser.menu/-browser-menu-builder/-init-.md @@ -0,0 +1,15 @@ +--- +title: BrowserMenuBuilder. - +--- + +[mozilla.components.browser.menu](../index.html) / [BrowserMenuBuilder](index.html) / [<init>](./-init-.html) + +# <init> + +`BrowserMenuBuilder(items: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`BrowserMenuItem`](../-browser-menu-item/index.html)`>)` + +Helper class for building browser menus. + +### Parameters + +`items` - List of BrowserMenuItem objects to compose the menu from. \ No newline at end of file diff --git a/docs/api/0.21/browser-menu/mozilla.components.browser.menu/-browser-menu-builder/build.md b/docs/api/0.21/browser-menu/mozilla.components.browser.menu/-browser-menu-builder/build.md new file mode 100644 index 00000000000..86ce0b94db7 --- /dev/null +++ b/docs/api/0.21/browser-menu/mozilla.components.browser.menu/-browser-menu-builder/build.md @@ -0,0 +1,9 @@ +--- +title: BrowserMenuBuilder.build - +--- + +[mozilla.components.browser.menu](../index.html) / [BrowserMenuBuilder](index.html) / [build](./build.html) + +# build + +`fun build(context: Context): `[`BrowserMenu`](../-browser-menu/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-menu/mozilla.components.browser.menu/-browser-menu-builder/index.md b/docs/api/0.21/browser-menu/mozilla.components.browser.menu/-browser-menu-builder/index.md new file mode 100644 index 00000000000..4d5edceae34 --- /dev/null +++ b/docs/api/0.21/browser-menu/mozilla.components.browser.menu/-browser-menu-builder/index.md @@ -0,0 +1,24 @@ +--- +title: BrowserMenuBuilder - +--- + +[mozilla.components.browser.menu](../index.html) / [BrowserMenuBuilder](./index.html) + +# BrowserMenuBuilder + +`class BrowserMenuBuilder` + +Helper class for building browser menus. + +### Parameters + +`items` - List of BrowserMenuItem objects to compose the menu from. + +### Constructors + +| [<init>](-init-.html) | `BrowserMenuBuilder(items: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`BrowserMenuItem`](../-browser-menu-item/index.html)`>)`
Helper class for building browser menus. | + +### Functions + +| [build](build.html) | `fun build(context: Context): `[`BrowserMenu`](../-browser-menu/index.html) | + diff --git a/docs/api/0.21/browser-menu/mozilla.components.browser.menu/-browser-menu-item-view-holder/-init-.md b/docs/api/0.21/browser-menu/mozilla.components.browser.menu/-browser-menu-item-view-holder/-init-.md new file mode 100644 index 00000000000..5821ff350ab --- /dev/null +++ b/docs/api/0.21/browser-menu/mozilla.components.browser.menu/-browser-menu-item-view-holder/-init-.md @@ -0,0 +1,9 @@ +--- +title: BrowserMenuItemViewHolder. - +--- + +[mozilla.components.browser.menu](../index.html) / [BrowserMenuItemViewHolder](index.html) / [<init>](./-init-.html) + +# <init> + +`BrowserMenuItemViewHolder(itemView: View?)` \ No newline at end of file diff --git a/docs/api/0.21/browser-menu/mozilla.components.browser.menu/-browser-menu-item-view-holder/index.md b/docs/api/0.21/browser-menu/mozilla.components.browser.menu/-browser-menu-item-view-holder/index.md new file mode 100644 index 00000000000..1395c4e896d --- /dev/null +++ b/docs/api/0.21/browser-menu/mozilla.components.browser.menu/-browser-menu-item-view-holder/index.md @@ -0,0 +1,14 @@ +--- +title: BrowserMenuItemViewHolder - +--- + +[mozilla.components.browser.menu](../index.html) / [BrowserMenuItemViewHolder](./index.html) + +# BrowserMenuItemViewHolder + +`class BrowserMenuItemViewHolder : ViewHolder` + +### Constructors + +| [<init>](-init-.html) | `BrowserMenuItemViewHolder(itemView: View?)` | + diff --git a/docs/api/0.21/browser-menu/mozilla.components.browser.menu/-browser-menu-item/bind.md b/docs/api/0.21/browser-menu/mozilla.components.browser.menu/-browser-menu-item/bind.md new file mode 100644 index 00000000000..ab29226db6a --- /dev/null +++ b/docs/api/0.21/browser-menu/mozilla.components.browser.menu/-browser-menu-item/bind.md @@ -0,0 +1,12 @@ +--- +title: BrowserMenuItem.bind - +--- + +[mozilla.components.browser.menu](../index.html) / [BrowserMenuItem](index.html) / [bind](./bind.html) + +# bind + +`abstract fun bind(menu: `[`BrowserMenu`](../-browser-menu/index.html)`, view: View): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Called by the browser menu to display the data of this item using the passed view. + diff --git a/docs/api/0.21/browser-menu/mozilla.components.browser.menu/-browser-menu-item/get-layout-resource.md b/docs/api/0.21/browser-menu/mozilla.components.browser.menu/-browser-menu-item/get-layout-resource.md new file mode 100644 index 00000000000..0f07b7b34c4 --- /dev/null +++ b/docs/api/0.21/browser-menu/mozilla.components.browser.menu/-browser-menu-item/get-layout-resource.md @@ -0,0 +1,13 @@ +--- +title: BrowserMenuItem.getLayoutResource - +--- + +[mozilla.components.browser.menu](../index.html) / [BrowserMenuItem](index.html) / [getLayoutResource](./get-layout-resource.html) + +# getLayoutResource + +`abstract fun getLayoutResource(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +Returns the layout resource ID of the layout to be inflated for showing a menu item of this +type. + diff --git a/docs/api/0.21/browser-menu/mozilla.components.browser.menu/-browser-menu-item/index.md b/docs/api/0.21/browser-menu/mozilla.components.browser.menu/-browser-menu-item/index.md new file mode 100644 index 00000000000..1ccc6bc7aec --- /dev/null +++ b/docs/api/0.21/browser-menu/mozilla.components.browser.menu/-browser-menu-item/index.md @@ -0,0 +1,27 @@ +--- +title: BrowserMenuItem - +--- + +[mozilla.components.browser.menu](../index.html) / [BrowserMenuItem](./index.html) + +# BrowserMenuItem + +`interface BrowserMenuItem` + +Interface to be implemented by menu items to be shown in the browser menu. + +### Properties + +| [visible](visible.html) | `abstract val visible: () -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Lambda expression that returns true if this item should be shown in the menu. Returns false if this item should be hidden. | + +### Functions + +| [bind](bind.html) | `abstract fun bind(menu: `[`BrowserMenu`](../-browser-menu/index.html)`, view: View): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Called by the browser menu to display the data of this item using the passed view. | +| [getLayoutResource](get-layout-resource.html) | `abstract fun getLayoutResource(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Returns the layout resource ID of the layout to be inflated for showing a menu item of this type. | + +### Inheritors + +| [BrowserMenuItemToolbar](../../mozilla.components.browser.menu.item/-browser-menu-item-toolbar/index.html) | `class BrowserMenuItemToolbar : `[`BrowserMenuItem`](./index.md)
A toolbar of buttons to show inside the browser menu. | +| [SimpleBrowserMenuCheckbox](../../mozilla.components.browser.menu.item/-simple-browser-menu-checkbox/index.html) | `class SimpleBrowserMenuCheckbox : `[`BrowserMenuItem`](./index.md)
A simple browser menu checkbox. | +| [SimpleBrowserMenuItem](../../mozilla.components.browser.menu.item/-simple-browser-menu-item/index.html) | `class SimpleBrowserMenuItem : `[`BrowserMenuItem`](./index.md)
A simple browser menu item displaying text. | + diff --git a/docs/api/0.21/browser-menu/mozilla.components.browser.menu/-browser-menu-item/visible.md b/docs/api/0.21/browser-menu/mozilla.components.browser.menu/-browser-menu-item/visible.md new file mode 100644 index 00000000000..0091b7c7986 --- /dev/null +++ b/docs/api/0.21/browser-menu/mozilla.components.browser.menu/-browser-menu-item/visible.md @@ -0,0 +1,13 @@ +--- +title: BrowserMenuItem.visible - +--- + +[mozilla.components.browser.menu](../index.html) / [BrowserMenuItem](index.html) / [visible](./visible.html) + +# visible + +`abstract val visible: () -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Lambda expression that returns true if this item should be shown in the menu. Returns false +if this item should be hidden. + diff --git a/docs/api/0.21/browser-menu/mozilla.components.browser.menu/-browser-menu/dismiss.md b/docs/api/0.21/browser-menu/mozilla.components.browser.menu/-browser-menu/dismiss.md new file mode 100644 index 00000000000..dccadeadcaf --- /dev/null +++ b/docs/api/0.21/browser-menu/mozilla.components.browser.menu/-browser-menu/dismiss.md @@ -0,0 +1,9 @@ +--- +title: BrowserMenu.dismiss - +--- + +[mozilla.components.browser.menu](../index.html) / [BrowserMenu](index.html) / [dismiss](./dismiss.html) + +# dismiss + +`fun dismiss(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-menu/mozilla.components.browser.menu/-browser-menu/index.md b/docs/api/0.21/browser-menu/mozilla.components.browser.menu/-browser-menu/index.md new file mode 100644 index 00000000000..7a4808482ee --- /dev/null +++ b/docs/api/0.21/browser-menu/mozilla.components.browser.menu/-browser-menu/index.md @@ -0,0 +1,17 @@ +--- +title: BrowserMenu - +--- + +[mozilla.components.browser.menu](../index.html) / [BrowserMenu](./index.html) + +# BrowserMenu + +`class BrowserMenu` + +A popup menu composed of BrowserMenuItem objects. + +### Functions + +| [dismiss](dismiss.html) | `fun dismiss(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [show](show.html) | `fun show(anchor: View): PopupWindow` | + diff --git a/docs/api/0.21/browser-menu/mozilla.components.browser.menu/-browser-menu/show.md b/docs/api/0.21/browser-menu/mozilla.components.browser.menu/-browser-menu/show.md new file mode 100644 index 00000000000..3874ba0c899 --- /dev/null +++ b/docs/api/0.21/browser-menu/mozilla.components.browser.menu/-browser-menu/show.md @@ -0,0 +1,9 @@ +--- +title: BrowserMenu.show - +--- + +[mozilla.components.browser.menu](../index.html) / [BrowserMenu](index.html) / [show](./show.html) + +# show + +`fun show(anchor: View): PopupWindow` \ No newline at end of file diff --git a/docs/api/0.21/browser-menu/mozilla.components.browser.menu/index.md b/docs/api/0.21/browser-menu/mozilla.components.browser.menu/index.md new file mode 100644 index 00000000000..17ead4cf060 --- /dev/null +++ b/docs/api/0.21/browser-menu/mozilla.components.browser.menu/index.md @@ -0,0 +1,15 @@ +--- +title: mozilla.components.browser.menu - +--- + +[mozilla.components.browser.menu](./index.html) + +## Package mozilla.components.browser.menu + +### Types + +| [BrowserMenu](-browser-menu/index.html) | `class BrowserMenu`
A popup menu composed of BrowserMenuItem objects. | +| [BrowserMenuBuilder](-browser-menu-builder/index.html) | `class BrowserMenuBuilder`
Helper class for building browser menus. | +| [BrowserMenuItem](-browser-menu-item/index.html) | `interface BrowserMenuItem`
Interface to be implemented by menu items to be shown in the browser menu. | +| [BrowserMenuItemViewHolder](-browser-menu-item-view-holder/index.html) | `class BrowserMenuItemViewHolder : ViewHolder` | + diff --git a/docs/api/0.21/browser-menu/package-list b/docs/api/0.21/browser-menu/package-list new file mode 100644 index 00000000000..d0666c7431e --- /dev/null +++ b/docs/api/0.21/browser-menu/package-list @@ -0,0 +1,5 @@ +$dokka.format:jekyll +$dokka.linkExtension:html + +mozilla.components.browser.menu +mozilla.components.browser.menu.item diff --git a/docs/api/0.21/browser-search/alltypes/index.md b/docs/api/0.21/browser-search/alltypes/index.md new file mode 100644 index 00000000000..5c94f5cd510 --- /dev/null +++ b/docs/api/0.21/browser-search/alltypes/index.md @@ -0,0 +1,19 @@ +--- +title: alltypes - +--- + +### All Types + +| [mozilla.components.browser.search.provider.AssetsSearchEngineProvider](../mozilla.components.browser.search.provider/-assets-search-engine-provider/index.html) | SearchEngineProvider implementation to load the included search engines from assets. | +| [mozilla.components.browser.search.suggestions.JSONResponse](../mozilla.components.browser.search.suggestions/-j-s-o-n-response.html) | The Parser is a function that takes a JSON Response and maps it to a Suggestion list. | +| [mozilla.components.browser.search.provider.localization.LocaleSearchLocalizationProvider](../mozilla.components.browser.search.provider.localization/-locale-search-localization-provider/index.html) | LocalizationProvider implementation that only provides the language and country from the system's default languageTag. | +| [mozilla.components.browser.search.suggestions.ResponseParser](../mozilla.components.browser.search.suggestions/-response-parser.html) | | +| [mozilla.components.browser.search.SearchEngine](../mozilla.components.browser.search/-search-engine/index.html) | A data class representing a search engine. | +| [mozilla.components.browser.search.provider.filter.SearchEngineFilter](../mozilla.components.browser.search.provider.filter/-search-engine-filter/index.html) | Interface for classes that want to filter the list of search engines a SearchEngineProvider implementation loads. | +| [mozilla.components.browser.search.SearchEngineManager](../mozilla.components.browser.search/-search-engine-manager/index.html) | This class provides access to a centralized registry of search engines. | +| [mozilla.components.browser.search.SearchEngineParser](../mozilla.components.browser.search/-search-engine-parser/index.html) | A very simple parser for search plugins. | +| [mozilla.components.browser.search.provider.SearchEngineProvider](../mozilla.components.browser.search.provider/-search-engine-provider/index.html) | Interface for classes that load search engines from a specific source. | +| [mozilla.components.browser.search.provider.localization.SearchLocalizationProvider](../mozilla.components.browser.search.provider.localization/-search-localization-provider/index.html) | Class providing language, country and optionally region (actual location) of the user/device to customize the search experience. | +| [mozilla.components.browser.search.suggestions.SearchSuggestionClient](../mozilla.components.browser.search.suggestions/-search-suggestion-client/index.html) | Provides an interface to get search suggestions from a given SearchEngine. | +| [mozilla.components.browser.search.suggestions.SearchSuggestionFetcher](../mozilla.components.browser.search.suggestions/-search-suggestion-fetcher.html) | Async function responsible for taking a URL and returning the results | + diff --git a/docs/api/0.21/browser-search/index.md b/docs/api/0.21/browser-search/index.md new file mode 100644 index 00000000000..5206749cf58 --- /dev/null +++ b/docs/api/0.21/browser-search/index.md @@ -0,0 +1,15 @@ +--- +title: +--- + +### Packages + +| [mozilla.components.browser.search](mozilla.components.browser.search/index.html) | | +| [mozilla.components.browser.search.provider](mozilla.components.browser.search.provider/index.html) | | +| [mozilla.components.browser.search.provider.filter](mozilla.components.browser.search.provider.filter/index.html) | | +| [mozilla.components.browser.search.provider.localization](mozilla.components.browser.search.provider.localization/index.html) | | +| [mozilla.components.browser.search.suggestions](mozilla.components.browser.search.suggestions/index.html) | | + +### Index + +[All Types](alltypes/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-search/mozilla.components.browser.search.provider.filter/-search-engine-filter/filter.md b/docs/api/0.21/browser-search/mozilla.components.browser.search.provider.filter/-search-engine-filter/filter.md new file mode 100644 index 00000000000..c9fd489bb1e --- /dev/null +++ b/docs/api/0.21/browser-search/mozilla.components.browser.search.provider.filter/-search-engine-filter/filter.md @@ -0,0 +1,13 @@ +--- +title: SearchEngineFilter.filter - +--- + +[mozilla.components.browser.search.provider.filter](../index.html) / [SearchEngineFilter](index.html) / [filter](./filter.html) + +# filter + +`abstract fun filter(context: Context, searchEngine: `[`SearchEngine`](../../mozilla.components.browser.search/-search-engine/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Returns true if the given search engine should be returned by the provider or false if this +search engine should be ignored. + diff --git a/docs/api/0.21/browser-search/mozilla.components.browser.search.provider.filter/-search-engine-filter/index.md b/docs/api/0.21/browser-search/mozilla.components.browser.search.provider.filter/-search-engine-filter/index.md new file mode 100644 index 00000000000..7cffa1f8489 --- /dev/null +++ b/docs/api/0.21/browser-search/mozilla.components.browser.search.provider.filter/-search-engine-filter/index.md @@ -0,0 +1,17 @@ +--- +title: SearchEngineFilter - +--- + +[mozilla.components.browser.search.provider.filter](../index.html) / [SearchEngineFilter](./index.html) + +# SearchEngineFilter + +`interface SearchEngineFilter` + +Interface for classes that want to filter the list of search engines a SearchEngineProvider +implementation loads. + +### Functions + +| [filter](filter.html) | `abstract fun filter(context: Context, searchEngine: `[`SearchEngine`](../../mozilla.components.browser.search/-search-engine/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Returns true if the given search engine should be returned by the provider or false if this search engine should be ignored. | + diff --git a/docs/api/0.21/browser-search/mozilla.components.browser.search.provider.filter/index.md b/docs/api/0.21/browser-search/mozilla.components.browser.search.provider.filter/index.md new file mode 100644 index 00000000000..476518f4481 --- /dev/null +++ b/docs/api/0.21/browser-search/mozilla.components.browser.search.provider.filter/index.md @@ -0,0 +1,12 @@ +--- +title: mozilla.components.browser.search.provider.filter - +--- + +[mozilla.components.browser.search.provider.filter](./index.html) + +## Package mozilla.components.browser.search.provider.filter + +### Types + +| [SearchEngineFilter](-search-engine-filter/index.html) | `interface SearchEngineFilter`
Interface for classes that want to filter the list of search engines a SearchEngineProvider implementation loads. | + diff --git a/docs/api/0.21/browser-search/mozilla.components.browser.search.provider.localization/-locale-search-localization-provider/-init-.md b/docs/api/0.21/browser-search/mozilla.components.browser.search.provider.localization/-locale-search-localization-provider/-init-.md new file mode 100644 index 00000000000..efa5f2e884a --- /dev/null +++ b/docs/api/0.21/browser-search/mozilla.components.browser.search.provider.localization/-locale-search-localization-provider/-init-.md @@ -0,0 +1,13 @@ +--- +title: LocaleSearchLocalizationProvider. - +--- + +[mozilla.components.browser.search.provider.localization](../index.html) / [LocaleSearchLocalizationProvider](index.html) / [<init>](./-init-.html) + +# <init> + +`LocaleSearchLocalizationProvider()` + +LocalizationProvider implementation that only provides the language and country from the system's +default languageTag. + diff --git a/docs/api/0.21/browser-search/mozilla.components.browser.search.provider.localization/-locale-search-localization-provider/country.md b/docs/api/0.21/browser-search/mozilla.components.browser.search.provider.localization/-locale-search-localization-provider/country.md new file mode 100644 index 00000000000..e7f66793119 --- /dev/null +++ b/docs/api/0.21/browser-search/mozilla.components.browser.search.provider.localization/-locale-search-localization-provider/country.md @@ -0,0 +1,16 @@ +--- +title: LocaleSearchLocalizationProvider.country - +--- + +[mozilla.components.browser.search.provider.localization](../index.html) / [LocaleSearchLocalizationProvider](index.html) / [country](./country.html) + +# country + +`val country: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) + +Overrides [SearchLocalizationProvider.country](../-search-localization-provider/country.html) + +ISO 3166 alpha-2 country code or UN M.49 numeric-3 area code. + +Example: "US" (United States), "FR" (France), "029" (Caribbean) + diff --git a/docs/api/0.21/browser-search/mozilla.components.browser.search.provider.localization/-locale-search-localization-provider/index.md b/docs/api/0.21/browser-search/mozilla.components.browser.search.provider.localization/-locale-search-localization-provider/index.md new file mode 100644 index 00000000000..34fd57189d3 --- /dev/null +++ b/docs/api/0.21/browser-search/mozilla.components.browser.search.provider.localization/-locale-search-localization-provider/index.md @@ -0,0 +1,27 @@ +--- +title: LocaleSearchLocalizationProvider - +--- + +[mozilla.components.browser.search.provider.localization](../index.html) / [LocaleSearchLocalizationProvider](./index.html) + +# LocaleSearchLocalizationProvider + +`class LocaleSearchLocalizationProvider : `[`SearchLocalizationProvider`](../-search-localization-provider/index.html) + +LocalizationProvider implementation that only provides the language and country from the system's +default languageTag. + +### Constructors + +| [<init>](-init-.html) | `LocaleSearchLocalizationProvider()`
LocalizationProvider implementation that only provides the language and country from the system's default languageTag. | + +### Properties + +| [country](country.html) | `val country: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
ISO 3166 alpha-2 country code or UN M.49 numeric-3 area code. | +| [language](language.html) | `val language: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
ISO 639 alpha-2 or alpha-3 language code, or registered language subtags up to 8 alpha letters (for future enhancements). | +| [region](region.html) | `val region: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
Optional actual location (region only) of the user/device. ISO 3166 alpha-2 country code or UN M.49 numeric-3 area code. | + +### Inherited Properties + +| [languageTag](../-search-localization-provider/language-tag.html) | `val languageTag: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Returns a language tag of the form -. | + diff --git a/docs/api/0.21/browser-search/mozilla.components.browser.search.provider.localization/-locale-search-localization-provider/language.md b/docs/api/0.21/browser-search/mozilla.components.browser.search.provider.localization/-locale-search-localization-provider/language.md new file mode 100644 index 00000000000..a87d0889831 --- /dev/null +++ b/docs/api/0.21/browser-search/mozilla.components.browser.search.provider.localization/-locale-search-localization-provider/language.md @@ -0,0 +1,17 @@ +--- +title: LocaleSearchLocalizationProvider.language - +--- + +[mozilla.components.browser.search.provider.localization](../index.html) / [LocaleSearchLocalizationProvider](index.html) / [language](./language.html) + +# language + +`val language: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) + +Overrides [SearchLocalizationProvider.language](../-search-localization-provider/language.html) + +ISO 639 alpha-2 or alpha-3 language code, or registered language subtags up to 8 alpha letters +(for future enhancements). + +Example: "en" (English), "ja" (Japanese), "kok" (Konkani) + diff --git a/docs/api/0.21/browser-search/mozilla.components.browser.search.provider.localization/-locale-search-localization-provider/region.md b/docs/api/0.21/browser-search/mozilla.components.browser.search.provider.localization/-locale-search-localization-provider/region.md new file mode 100644 index 00000000000..2abddfc26cb --- /dev/null +++ b/docs/api/0.21/browser-search/mozilla.components.browser.search.provider.localization/-locale-search-localization-provider/region.md @@ -0,0 +1,21 @@ +--- +title: LocaleSearchLocalizationProvider.region - +--- + +[mozilla.components.browser.search.provider.localization](../index.html) / [LocaleSearchLocalizationProvider](index.html) / [region](./region.html) + +# region + +`val region: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` + +Overrides [SearchLocalizationProvider.region](../-search-localization-provider/region.html) + +Optional actual location (region only) of the user/device. ISO 3166 alpha-2 country code or +UN M.49 numeric-3 area code. + +This value is used to customize the experience for users that use a languageTag that doesn't match +their geographic region. For example a user in Russia with "en-US" languageTag might get offered +an English version of Yandex if the region is set to "RU". + +Can be null if no location information is available. + diff --git a/docs/api/0.21/browser-search/mozilla.components.browser.search.provider.localization/-search-localization-provider/-init-.md b/docs/api/0.21/browser-search/mozilla.components.browser.search.provider.localization/-search-localization-provider/-init-.md new file mode 100644 index 00000000000..e5776dba379 --- /dev/null +++ b/docs/api/0.21/browser-search/mozilla.components.browser.search.provider.localization/-search-localization-provider/-init-.md @@ -0,0 +1,13 @@ +--- +title: SearchLocalizationProvider. - +--- + +[mozilla.components.browser.search.provider.localization](../index.html) / [SearchLocalizationProvider](index.html) / [<init>](./-init-.html) + +# <init> + +`SearchLocalizationProvider()` + +Class providing language, country and optionally region (actual location) of the user/device to +customize the search experience. + diff --git a/docs/api/0.21/browser-search/mozilla.components.browser.search.provider.localization/-search-localization-provider/country.md b/docs/api/0.21/browser-search/mozilla.components.browser.search.provider.localization/-search-localization-provider/country.md new file mode 100644 index 00000000000..59795e8f02c --- /dev/null +++ b/docs/api/0.21/browser-search/mozilla.components.browser.search.provider.localization/-search-localization-provider/country.md @@ -0,0 +1,14 @@ +--- +title: SearchLocalizationProvider.country - +--- + +[mozilla.components.browser.search.provider.localization](../index.html) / [SearchLocalizationProvider](index.html) / [country](./country.html) + +# country + +`abstract val country: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) + +ISO 3166 alpha-2 country code or UN M.49 numeric-3 area code. + +Example: "US" (United States), "FR" (France), "029" (Caribbean) + diff --git a/docs/api/0.21/browser-search/mozilla.components.browser.search.provider.localization/-search-localization-provider/index.md b/docs/api/0.21/browser-search/mozilla.components.browser.search.provider.localization/-search-localization-provider/index.md new file mode 100644 index 00000000000..fe3bca05927 --- /dev/null +++ b/docs/api/0.21/browser-search/mozilla.components.browser.search.provider.localization/-search-localization-provider/index.md @@ -0,0 +1,28 @@ +--- +title: SearchLocalizationProvider - +--- + +[mozilla.components.browser.search.provider.localization](../index.html) / [SearchLocalizationProvider](./index.html) + +# SearchLocalizationProvider + +`abstract class SearchLocalizationProvider` + +Class providing language, country and optionally region (actual location) of the user/device to +customize the search experience. + +### Constructors + +| [<init>](-init-.html) | `SearchLocalizationProvider()`
Class providing language, country and optionally region (actual location) of the user/device to customize the search experience. | + +### Properties + +| [country](country.html) | `abstract val country: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
ISO 3166 alpha-2 country code or UN M.49 numeric-3 area code. | +| [language](language.html) | `abstract val language: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
ISO 639 alpha-2 or alpha-3 language code, or registered language subtags up to 8 alpha letters (for future enhancements). | +| [languageTag](language-tag.html) | `val languageTag: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Returns a language tag of the form -. | +| [region](region.html) | `abstract val region: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
Optional actual location (region only) of the user/device. ISO 3166 alpha-2 country code or UN M.49 numeric-3 area code. | + +### Inheritors + +| [LocaleSearchLocalizationProvider](../-locale-search-localization-provider/index.html) | `class LocaleSearchLocalizationProvider : `[`SearchLocalizationProvider`](./index.md)
LocalizationProvider implementation that only provides the language and country from the system's default languageTag. | + diff --git a/docs/api/0.21/browser-search/mozilla.components.browser.search.provider.localization/-search-localization-provider/language-tag.md b/docs/api/0.21/browser-search/mozilla.components.browser.search.provider.localization/-search-localization-provider/language-tag.md new file mode 100644 index 00000000000..c9c91327792 --- /dev/null +++ b/docs/api/0.21/browser-search/mozilla.components.browser.search.provider.localization/-search-localization-provider/language-tag.md @@ -0,0 +1,14 @@ +--- +title: SearchLocalizationProvider.languageTag - +--- + +[mozilla.components.browser.search.provider.localization](../index.html) / [SearchLocalizationProvider](index.html) / [languageTag](./language-tag.html) + +# languageTag + +`val languageTag: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) + +Returns a language tag of the form -. + +Example: "en-US" (English, United States) + diff --git a/docs/api/0.21/browser-search/mozilla.components.browser.search.provider.localization/-search-localization-provider/language.md b/docs/api/0.21/browser-search/mozilla.components.browser.search.provider.localization/-search-localization-provider/language.md new file mode 100644 index 00000000000..b6db79a83b1 --- /dev/null +++ b/docs/api/0.21/browser-search/mozilla.components.browser.search.provider.localization/-search-localization-provider/language.md @@ -0,0 +1,15 @@ +--- +title: SearchLocalizationProvider.language - +--- + +[mozilla.components.browser.search.provider.localization](../index.html) / [SearchLocalizationProvider](index.html) / [language](./language.html) + +# language + +`abstract val language: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) + +ISO 639 alpha-2 or alpha-3 language code, or registered language subtags up to 8 alpha letters +(for future enhancements). + +Example: "en" (English), "ja" (Japanese), "kok" (Konkani) + diff --git a/docs/api/0.21/browser-search/mozilla.components.browser.search.provider.localization/-search-localization-provider/region.md b/docs/api/0.21/browser-search/mozilla.components.browser.search.provider.localization/-search-localization-provider/region.md new file mode 100644 index 00000000000..49e2641dc69 --- /dev/null +++ b/docs/api/0.21/browser-search/mozilla.components.browser.search.provider.localization/-search-localization-provider/region.md @@ -0,0 +1,19 @@ +--- +title: SearchLocalizationProvider.region - +--- + +[mozilla.components.browser.search.provider.localization](../index.html) / [SearchLocalizationProvider](index.html) / [region](./region.html) + +# region + +`abstract val region: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` + +Optional actual location (region only) of the user/device. ISO 3166 alpha-2 country code or +UN M.49 numeric-3 area code. + +This value is used to customize the experience for users that use a languageTag that doesn't match +their geographic region. For example a user in Russia with "en-US" languageTag might get offered +an English version of Yandex if the region is set to "RU". + +Can be null if no location information is available. + diff --git a/docs/api/0.21/browser-search/mozilla.components.browser.search.provider.localization/index.md b/docs/api/0.21/browser-search/mozilla.components.browser.search.provider.localization/index.md new file mode 100644 index 00000000000..5b74dbf260c --- /dev/null +++ b/docs/api/0.21/browser-search/mozilla.components.browser.search.provider.localization/index.md @@ -0,0 +1,13 @@ +--- +title: mozilla.components.browser.search.provider.localization - +--- + +[mozilla.components.browser.search.provider.localization](./index.html) + +## Package mozilla.components.browser.search.provider.localization + +### Types + +| [LocaleSearchLocalizationProvider](-locale-search-localization-provider/index.html) | `class LocaleSearchLocalizationProvider : `[`SearchLocalizationProvider`](-search-localization-provider/index.html)
LocalizationProvider implementation that only provides the language and country from the system's default languageTag. | +| [SearchLocalizationProvider](-search-localization-provider/index.html) | `abstract class SearchLocalizationProvider`
Class providing language, country and optionally region (actual location) of the user/device to customize the search experience. | + diff --git a/docs/api/0.21/browser-search/mozilla.components.browser.search.provider/-assets-search-engine-provider/-init-.md b/docs/api/0.21/browser-search/mozilla.components.browser.search.provider/-assets-search-engine-provider/-init-.md new file mode 100644 index 00000000000..cf0a69f1a62 --- /dev/null +++ b/docs/api/0.21/browser-search/mozilla.components.browser.search.provider/-assets-search-engine-provider/-init-.md @@ -0,0 +1,21 @@ +--- +title: AssetsSearchEngineProvider. - +--- + +[mozilla.components.browser.search.provider](../index.html) / [AssetsSearchEngineProvider](index.html) / [<init>](./-init-.html) + +# <init> + +`AssetsSearchEngineProvider(localizationProvider: `[`SearchLocalizationProvider`](../../mozilla.components.browser.search.provider.localization/-search-localization-provider/index.html)`, filters: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`SearchEngineFilter`](../../mozilla.components.browser.search.provider.filter/-search-engine-filter/index.html)`> = emptyList(), additionalIdentifiers: `[`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)`> = emptyList())` + +SearchEngineProvider implementation to load the included search engines from assets. + +A SearchLocalizationProvider implementation is used to customize the returned search engines for +the language and country of the user/device. + +Optionally SearchEngineFilter instances can be provided to remove unwanted search engines from +the loaded list. + +Optionally additionalIdentifiers to be loaded can be specified. A search engine +identifier corresponds to the search plugin XML file name (e.g. duckduckgo -> duckduckgo.xml). + diff --git a/docs/api/0.21/browser-search/mozilla.components.browser.search.provider/-assets-search-engine-provider/index.md b/docs/api/0.21/browser-search/mozilla.components.browser.search.provider/-assets-search-engine-provider/index.md new file mode 100644 index 00000000000..3be10c7d880 --- /dev/null +++ b/docs/api/0.21/browser-search/mozilla.components.browser.search.provider/-assets-search-engine-provider/index.md @@ -0,0 +1,29 @@ +--- +title: AssetsSearchEngineProvider - +--- + +[mozilla.components.browser.search.provider](../index.html) / [AssetsSearchEngineProvider](./index.html) + +# AssetsSearchEngineProvider + +`class AssetsSearchEngineProvider : `[`SearchEngineProvider`](../-search-engine-provider/index.html) + +SearchEngineProvider implementation to load the included search engines from assets. + +A SearchLocalizationProvider implementation is used to customize the returned search engines for +the language and country of the user/device. + +Optionally SearchEngineFilter instances can be provided to remove unwanted search engines from +the loaded list. + +Optionally additionalIdentifiers to be loaded can be specified. A search engine +identifier corresponds to the search plugin XML file name (e.g. duckduckgo -> duckduckgo.xml). + +### Constructors + +| [<init>](-init-.html) | `AssetsSearchEngineProvider(localizationProvider: `[`SearchLocalizationProvider`](../../mozilla.components.browser.search.provider.localization/-search-localization-provider/index.html)`, filters: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`SearchEngineFilter`](../../mozilla.components.browser.search.provider.filter/-search-engine-filter/index.html)`> = emptyList(), additionalIdentifiers: `[`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)`> = emptyList())`
SearchEngineProvider implementation to load the included search engines from assets. | + +### Functions + +| [loadSearchEngines](load-search-engines.html) | `suspend fun loadSearchEngines(context: Context): `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`SearchEngine`](../../mozilla.components.browser.search/-search-engine/index.html)`>`
Load search engines from this provider. | + diff --git a/docs/api/0.21/browser-search/mozilla.components.browser.search.provider/-assets-search-engine-provider/load-search-engines.md b/docs/api/0.21/browser-search/mozilla.components.browser.search.provider/-assets-search-engine-provider/load-search-engines.md new file mode 100644 index 00000000000..c2923f6e1f8 --- /dev/null +++ b/docs/api/0.21/browser-search/mozilla.components.browser.search.provider/-assets-search-engine-provider/load-search-engines.md @@ -0,0 +1,14 @@ +--- +title: AssetsSearchEngineProvider.loadSearchEngines - +--- + +[mozilla.components.browser.search.provider](../index.html) / [AssetsSearchEngineProvider](index.html) / [loadSearchEngines](./load-search-engines.html) + +# loadSearchEngines + +`suspend fun loadSearchEngines(context: Context): `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`SearchEngine`](../../mozilla.components.browser.search/-search-engine/index.html)`>` + +Overrides [SearchEngineProvider.loadSearchEngines](../-search-engine-provider/load-search-engines.html) + +Load search engines from this provider. + diff --git a/docs/api/0.21/browser-search/mozilla.components.browser.search.provider/-search-engine-provider/index.md b/docs/api/0.21/browser-search/mozilla.components.browser.search.provider/-search-engine-provider/index.md new file mode 100644 index 00000000000..2630e9acfb8 --- /dev/null +++ b/docs/api/0.21/browser-search/mozilla.components.browser.search.provider/-search-engine-provider/index.md @@ -0,0 +1,20 @@ +--- +title: SearchEngineProvider - +--- + +[mozilla.components.browser.search.provider](../index.html) / [SearchEngineProvider](./index.html) + +# SearchEngineProvider + +`interface SearchEngineProvider` + +Interface for classes that load search engines from a specific source. + +### Functions + +| [loadSearchEngines](load-search-engines.html) | `abstract suspend fun loadSearchEngines(context: Context): `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`SearchEngine`](../../mozilla.components.browser.search/-search-engine/index.html)`>`
Load search engines from this provider. | + +### Inheritors + +| [AssetsSearchEngineProvider](../-assets-search-engine-provider/index.html) | `class AssetsSearchEngineProvider : `[`SearchEngineProvider`](./index.md)
SearchEngineProvider implementation to load the included search engines from assets. | + diff --git a/docs/api/0.21/browser-search/mozilla.components.browser.search.provider/-search-engine-provider/load-search-engines.md b/docs/api/0.21/browser-search/mozilla.components.browser.search.provider/-search-engine-provider/load-search-engines.md new file mode 100644 index 00000000000..4864149f68c --- /dev/null +++ b/docs/api/0.21/browser-search/mozilla.components.browser.search.provider/-search-engine-provider/load-search-engines.md @@ -0,0 +1,12 @@ +--- +title: SearchEngineProvider.loadSearchEngines - +--- + +[mozilla.components.browser.search.provider](../index.html) / [SearchEngineProvider](index.html) / [loadSearchEngines](./load-search-engines.html) + +# loadSearchEngines + +`abstract suspend fun loadSearchEngines(context: Context): `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`SearchEngine`](../../mozilla.components.browser.search/-search-engine/index.html)`>` + +Load search engines from this provider. + diff --git a/docs/api/0.21/browser-search/mozilla.components.browser.search.provider/index.md b/docs/api/0.21/browser-search/mozilla.components.browser.search.provider/index.md new file mode 100644 index 00000000000..c4049ba48b1 --- /dev/null +++ b/docs/api/0.21/browser-search/mozilla.components.browser.search.provider/index.md @@ -0,0 +1,13 @@ +--- +title: mozilla.components.browser.search.provider - +--- + +[mozilla.components.browser.search.provider](./index.html) + +## Package mozilla.components.browser.search.provider + +### Types + +| [AssetsSearchEngineProvider](-assets-search-engine-provider/index.html) | `class AssetsSearchEngineProvider : `[`SearchEngineProvider`](-search-engine-provider/index.html)
SearchEngineProvider implementation to load the included search engines from assets. | +| [SearchEngineProvider](-search-engine-provider/index.html) | `interface SearchEngineProvider`
Interface for classes that load search engines from a specific source. | + diff --git a/docs/api/0.21/browser-search/mozilla.components.browser.search.suggestions/-j-s-o-n-response.md b/docs/api/0.21/browser-search/mozilla.components.browser.search.suggestions/-j-s-o-n-response.md new file mode 100644 index 00000000000..697b34cc30a --- /dev/null +++ b/docs/api/0.21/browser-search/mozilla.components.browser.search.suggestions/-j-s-o-n-response.md @@ -0,0 +1,13 @@ +--- +title: JSONResponse - +--- + +[mozilla.components.browser.search.suggestions](index.html) / [JSONResponse](./-j-s-o-n-response.html) + +# JSONResponse + +`typealias JSONResponse = `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) + +The Parser is a function that takes a JSON Response and maps +it to a Suggestion list. + diff --git a/docs/api/0.21/browser-search/mozilla.components.browser.search.suggestions/-response-parser.md b/docs/api/0.21/browser-search/mozilla.components.browser.search.suggestions/-response-parser.md new file mode 100644 index 00000000000..345c79b83de --- /dev/null +++ b/docs/api/0.21/browser-search/mozilla.components.browser.search.suggestions/-response-parser.md @@ -0,0 +1,9 @@ +--- +title: ResponseParser - +--- + +[mozilla.components.browser.search.suggestions](index.html) / [ResponseParser](./-response-parser.html) + +# ResponseParser + +`typealias ResponseParser = (`[`JSONResponse`](-j-s-o-n-response.html)`) -> `[`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)`>` \ No newline at end of file diff --git a/docs/api/0.21/browser-search/mozilla.components.browser.search.suggestions/-search-suggestion-client/-fetch-exception/-init-.md b/docs/api/0.21/browser-search/mozilla.components.browser.search.suggestions/-search-suggestion-client/-fetch-exception/-init-.md new file mode 100644 index 00000000000..70f3930560e --- /dev/null +++ b/docs/api/0.21/browser-search/mozilla.components.browser.search.suggestions/-search-suggestion-client/-fetch-exception/-init-.md @@ -0,0 +1,12 @@ +--- +title: SearchSuggestionClient.FetchException. - +--- + +[mozilla.components.browser.search.suggestions](../../index.html) / [SearchSuggestionClient](../index.html) / [FetchException](index.html) / [<init>](./-init-.html) + +# <init> + +`FetchException()` + +Exception types for errors caught while getting a list of suggestions + diff --git a/docs/api/0.21/browser-search/mozilla.components.browser.search.suggestions/-search-suggestion-client/-fetch-exception/index.md b/docs/api/0.21/browser-search/mozilla.components.browser.search.suggestions/-search-suggestion-client/-fetch-exception/index.md new file mode 100644 index 00000000000..63ac01dcce8 --- /dev/null +++ b/docs/api/0.21/browser-search/mozilla.components.browser.search.suggestions/-search-suggestion-client/-fetch-exception/index.md @@ -0,0 +1,16 @@ +--- +title: SearchSuggestionClient.FetchException - +--- + +[mozilla.components.browser.search.suggestions](../../index.html) / [SearchSuggestionClient](../index.html) / [FetchException](./index.html) + +# FetchException + +`class FetchException : `[`Exception`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html) + +Exception types for errors caught while getting a list of suggestions + +### Constructors + +| [<init>](-init-.html) | `FetchException()`
Exception types for errors caught while getting a list of suggestions | + diff --git a/docs/api/0.21/browser-search/mozilla.components.browser.search.suggestions/-search-suggestion-client/-init-.md b/docs/api/0.21/browser-search/mozilla.components.browser.search.suggestions/-search-suggestion-client/-init-.md new file mode 100644 index 00000000000..22af60b15dd --- /dev/null +++ b/docs/api/0.21/browser-search/mozilla.components.browser.search.suggestions/-search-suggestion-client/-init-.md @@ -0,0 +1,12 @@ +--- +title: SearchSuggestionClient. - +--- + +[mozilla.components.browser.search.suggestions](../index.html) / [SearchSuggestionClient](index.html) / [<init>](./-init-.html) + +# <init> + +`SearchSuggestionClient(searchEngine: `[`SearchEngine`](../../mozilla.components.browser.search/-search-engine/index.html)`, fetcher: `[`SearchSuggestionFetcher`](../-search-suggestion-fetcher.html)`)` + +Provides an interface to get search suggestions from a given SearchEngine. + diff --git a/docs/api/0.21/browser-search/mozilla.components.browser.search.suggestions/-search-suggestion-client/-response-parser-exception/-init-.md b/docs/api/0.21/browser-search/mozilla.components.browser.search.suggestions/-search-suggestion-client/-response-parser-exception/-init-.md new file mode 100644 index 00000000000..3b6773a8ae6 --- /dev/null +++ b/docs/api/0.21/browser-search/mozilla.components.browser.search.suggestions/-search-suggestion-client/-response-parser-exception/-init-.md @@ -0,0 +1,9 @@ +--- +title: SearchSuggestionClient.ResponseParserException. - +--- + +[mozilla.components.browser.search.suggestions](../../index.html) / [SearchSuggestionClient](../index.html) / [ResponseParserException](index.html) / [<init>](./-init-.html) + +# <init> + +`ResponseParserException()` \ No newline at end of file diff --git a/docs/api/0.21/browser-search/mozilla.components.browser.search.suggestions/-search-suggestion-client/-response-parser-exception/index.md b/docs/api/0.21/browser-search/mozilla.components.browser.search.suggestions/-search-suggestion-client/-response-parser-exception/index.md new file mode 100644 index 00000000000..0c79385e947 --- /dev/null +++ b/docs/api/0.21/browser-search/mozilla.components.browser.search.suggestions/-search-suggestion-client/-response-parser-exception/index.md @@ -0,0 +1,14 @@ +--- +title: SearchSuggestionClient.ResponseParserException - +--- + +[mozilla.components.browser.search.suggestions](../../index.html) / [SearchSuggestionClient](../index.html) / [ResponseParserException](./index.html) + +# ResponseParserException + +`class ResponseParserException : `[`Exception`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html) + +### Constructors + +| [<init>](-init-.html) | `ResponseParserException()` | + diff --git a/docs/api/0.21/browser-search/mozilla.components.browser.search.suggestions/-search-suggestion-client/get-suggestions.md b/docs/api/0.21/browser-search/mozilla.components.browser.search.suggestions/-search-suggestion-client/get-suggestions.md new file mode 100644 index 00000000000..927906eb01a --- /dev/null +++ b/docs/api/0.21/browser-search/mozilla.components.browser.search.suggestions/-search-suggestion-client/get-suggestions.md @@ -0,0 +1,12 @@ +--- +title: SearchSuggestionClient.getSuggestions - +--- + +[mozilla.components.browser.search.suggestions](../index.html) / [SearchSuggestionClient](index.html) / [getSuggestions](./get-suggestions.html) + +# getSuggestions + +`suspend fun getSuggestions(query: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`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)`>?` + +Gets search suggestions for a given query + diff --git a/docs/api/0.21/browser-search/mozilla.components.browser.search.suggestions/-search-suggestion-client/index.md b/docs/api/0.21/browser-search/mozilla.components.browser.search.suggestions/-search-suggestion-client/index.md new file mode 100644 index 00000000000..a9009e955e2 --- /dev/null +++ b/docs/api/0.21/browser-search/mozilla.components.browser.search.suggestions/-search-suggestion-client/index.md @@ -0,0 +1,25 @@ +--- +title: SearchSuggestionClient - +--- + +[mozilla.components.browser.search.suggestions](../index.html) / [SearchSuggestionClient](./index.html) + +# SearchSuggestionClient + +`class SearchSuggestionClient` + +Provides an interface to get search suggestions from a given SearchEngine. + +### Exceptions + +| [FetchException](-fetch-exception/index.html) | `class FetchException : `[`Exception`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html)
Exception types for errors caught while getting a list of suggestions | +| [ResponseParserException](-response-parser-exception/index.html) | `class ResponseParserException : `[`Exception`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html) | + +### Constructors + +| [<init>](-init-.html) | `SearchSuggestionClient(searchEngine: `[`SearchEngine`](../../mozilla.components.browser.search/-search-engine/index.html)`, fetcher: `[`SearchSuggestionFetcher`](../-search-suggestion-fetcher.html)`)`
Provides an interface to get search suggestions from a given SearchEngine. | + +### Functions + +| [getSuggestions](get-suggestions.html) | `suspend fun getSuggestions(query: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`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)`>?`
Gets search suggestions for a given query | + diff --git a/docs/api/0.21/browser-search/mozilla.components.browser.search.suggestions/-search-suggestion-fetcher.md b/docs/api/0.21/browser-search/mozilla.components.browser.search.suggestions/-search-suggestion-fetcher.md new file mode 100644 index 00000000000..47542001075 --- /dev/null +++ b/docs/api/0.21/browser-search/mozilla.components.browser.search.suggestions/-search-suggestion-fetcher.md @@ -0,0 +1,12 @@ +--- +title: SearchSuggestionFetcher - +--- + +[mozilla.components.browser.search.suggestions](index.html) / [SearchSuggestionFetcher](./-search-suggestion-fetcher.html) + +# SearchSuggestionFetcher + +`typealias SearchSuggestionFetcher = suspend (url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`) -> `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` + +Async function responsible for taking a URL and returning the results + diff --git a/docs/api/0.21/browser-search/mozilla.components.browser.search.suggestions/index.md b/docs/api/0.21/browser-search/mozilla.components.browser.search.suggestions/index.md new file mode 100644 index 00000000000..e7f0f9e5b89 --- /dev/null +++ b/docs/api/0.21/browser-search/mozilla.components.browser.search.suggestions/index.md @@ -0,0 +1,18 @@ +--- +title: mozilla.components.browser.search.suggestions - +--- + +[mozilla.components.browser.search.suggestions](./index.html) + +## Package mozilla.components.browser.search.suggestions + +### Types + +| [SearchSuggestionClient](-search-suggestion-client/index.html) | `class SearchSuggestionClient`
Provides an interface to get search suggestions from a given SearchEngine. | + +### Type Aliases + +| [JSONResponse](-j-s-o-n-response.html) | `typealias JSONResponse = `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
The Parser is a function that takes a JSON Response and maps it to a Suggestion list. | +| [ResponseParser](-response-parser.html) | `typealias ResponseParser = (`[`JSONResponse`](-j-s-o-n-response.html)`) -> `[`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)`>` | +| [SearchSuggestionFetcher](-search-suggestion-fetcher.html) | `typealias SearchSuggestionFetcher = suspend (url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`) -> `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
Async function responsible for taking a URL and returning the results | + diff --git a/docs/api/0.21/browser-search/mozilla.components.browser.search/-search-engine-manager/-init-.md b/docs/api/0.21/browser-search/mozilla.components.browser.search/-search-engine-manager/-init-.md new file mode 100644 index 00000000000..526923146a3 --- /dev/null +++ b/docs/api/0.21/browser-search/mozilla.components.browser.search/-search-engine-manager/-init-.md @@ -0,0 +1,13 @@ +--- +title: SearchEngineManager. - +--- + +[mozilla.components.browser.search](../index.html) / [SearchEngineManager](index.html) / [<init>](./-init-.html) + +# <init> + +`SearchEngineManager(providers: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`SearchEngineProvider`](../../mozilla.components.browser.search.provider/-search-engine-provider/index.html)`> = listOf( + AssetsSearchEngineProvider(LocaleSearchLocalizationProvider())))` + +This class provides access to a centralized registry of search engines. + diff --git a/docs/api/0.21/browser-search/mozilla.components.browser.search/-search-engine-manager/get-default-search-engine.md b/docs/api/0.21/browser-search/mozilla.components.browser.search/-search-engine-manager/get-default-search-engine.md new file mode 100644 index 00000000000..2ed6c166a29 --- /dev/null +++ b/docs/api/0.21/browser-search/mozilla.components.browser.search/-search-engine-manager/get-default-search-engine.md @@ -0,0 +1,18 @@ +--- +title: SearchEngineManager.getDefaultSearchEngine - +--- + +[mozilla.components.browser.search](../index.html) / [SearchEngineManager](index.html) / [getDefaultSearchEngine](./get-default-search-engine.html) + +# getDefaultSearchEngine + +`@Synchronized fun getDefaultSearchEngine(context: Context, name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = EMPTY): `[`SearchEngine`](../-search-engine/index.html) + +Returns the default search engine. + +The default engine is the first engine loaded by the first provider passed to the +constructor of SearchEngineManager. + +Optionally a name can be passed to this method (e.g. from the user's preferences). If +a matching search engine was loaded then this search engine will be returned instead. + diff --git a/docs/api/0.21/browser-search/mozilla.components.browser.search/-search-engine-manager/get-search-engines.md b/docs/api/0.21/browser-search/mozilla.components.browser.search/-search-engine-manager/get-search-engines.md new file mode 100644 index 00000000000..d560aca2885 --- /dev/null +++ b/docs/api/0.21/browser-search/mozilla.components.browser.search/-search-engine-manager/get-search-engines.md @@ -0,0 +1,13 @@ +--- +title: SearchEngineManager.getSearchEngines - +--- + +[mozilla.components.browser.search](../index.html) / [SearchEngineManager](index.html) / [getSearchEngines](./get-search-engines.html) + +# getSearchEngines + +`@Synchronized fun getSearchEngines(context: Context): `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`SearchEngine`](../-search-engine/index.html)`>` + +Returns all search engines. If no call to load() has been made then calling this method +will perform a load. + diff --git a/docs/api/0.21/browser-search/mozilla.components.browser.search/-search-engine-manager/index.md b/docs/api/0.21/browser-search/mozilla.components.browser.search/-search-engine-manager/index.md new file mode 100644 index 00000000000..6f8a0e1a6e9 --- /dev/null +++ b/docs/api/0.21/browser-search/mozilla.components.browser.search/-search-engine-manager/index.md @@ -0,0 +1,24 @@ +--- +title: SearchEngineManager - +--- + +[mozilla.components.browser.search](../index.html) / [SearchEngineManager](./index.html) + +# SearchEngineManager + +`class SearchEngineManager` + +This class provides access to a centralized registry of search engines. + +### Constructors + +| [<init>](-init-.html) | `SearchEngineManager(providers: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`SearchEngineProvider`](../../mozilla.components.browser.search.provider/-search-engine-provider/index.html)`> = listOf( + AssetsSearchEngineProvider(LocaleSearchLocalizationProvider())))`
This class provides access to a centralized registry of search engines. | + +### Functions + +| [getDefaultSearchEngine](get-default-search-engine.html) | `fun getDefaultSearchEngine(context: Context, name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = EMPTY): `[`SearchEngine`](../-search-engine/index.html)
Returns the default search engine. | +| [getSearchEngines](get-search-engines.html) | `fun getSearchEngines(context: Context): `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`SearchEngine`](../-search-engine/index.html)`>`
Returns all search engines. If no call to load() has been made then calling this method will perform a load. | +| [load](load.html) | `suspend fun load(context: Context): Deferred<`[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`SearchEngine`](../-search-engine/index.html)`>>`
Asynchronously load search engines from providers. | +| [registerForLocaleUpdates](register-for-locale-updates.html) | `fun registerForLocaleUpdates(context: Context): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Registers for ACTION_LOCALE_CHANGED broadcasts and automatically reloads the search engines whenever the locale changes. | + diff --git a/docs/api/0.21/browser-search/mozilla.components.browser.search/-search-engine-manager/load.md b/docs/api/0.21/browser-search/mozilla.components.browser.search/-search-engine-manager/load.md new file mode 100644 index 00000000000..0dcd98880c1 --- /dev/null +++ b/docs/api/0.21/browser-search/mozilla.components.browser.search/-search-engine-manager/load.md @@ -0,0 +1,12 @@ +--- +title: SearchEngineManager.load - +--- + +[mozilla.components.browser.search](../index.html) / [SearchEngineManager](index.html) / [load](./load.html) + +# load + +`@Synchronized suspend fun load(context: Context): Deferred<`[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`SearchEngine`](../-search-engine/index.html)`>>` + +Asynchronously load search engines from providers. + diff --git a/docs/api/0.21/browser-search/mozilla.components.browser.search/-search-engine-manager/register-for-locale-updates.md b/docs/api/0.21/browser-search/mozilla.components.browser.search/-search-engine-manager/register-for-locale-updates.md new file mode 100644 index 00000000000..83f07415fa3 --- /dev/null +++ b/docs/api/0.21/browser-search/mozilla.components.browser.search/-search-engine-manager/register-for-locale-updates.md @@ -0,0 +1,13 @@ +--- +title: SearchEngineManager.registerForLocaleUpdates - +--- + +[mozilla.components.browser.search](../index.html) / [SearchEngineManager](index.html) / [registerForLocaleUpdates](./register-for-locale-updates.html) + +# registerForLocaleUpdates + +`fun registerForLocaleUpdates(context: Context): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Registers for ACTION_LOCALE_CHANGED broadcasts and automatically reloads the search engines +whenever the locale changes. + diff --git a/docs/api/0.21/browser-search/mozilla.components.browser.search/-search-engine-parser/-init-.md b/docs/api/0.21/browser-search/mozilla.components.browser.search/-search-engine-parser/-init-.md new file mode 100644 index 00000000000..5ab6ca4d6f0 --- /dev/null +++ b/docs/api/0.21/browser-search/mozilla.components.browser.search/-search-engine-parser/-init-.md @@ -0,0 +1,12 @@ +--- +title: SearchEngineParser. - +--- + +[mozilla.components.browser.search](../index.html) / [SearchEngineParser](index.html) / [<init>](./-init-.html) + +# <init> + +`SearchEngineParser()` + +A very simple parser for search plugins. + diff --git a/docs/api/0.21/browser-search/mozilla.components.browser.search/-search-engine-parser/index.md b/docs/api/0.21/browser-search/mozilla.components.browser.search/-search-engine-parser/index.md new file mode 100644 index 00000000000..3c14477d85f --- /dev/null +++ b/docs/api/0.21/browser-search/mozilla.components.browser.search/-search-engine-parser/index.md @@ -0,0 +1,20 @@ +--- +title: SearchEngineParser - +--- + +[mozilla.components.browser.search](../index.html) / [SearchEngineParser](./index.html) + +# SearchEngineParser + +`class SearchEngineParser` + +A very simple parser for search plugins. + +### Constructors + +| [<init>](-init-.html) | `SearchEngineParser()`
A very simple parser for search plugins. | + +### Functions + +| [load](load.html) | `fun load(assetManager: AssetManager, identifier: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, path: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`SearchEngine`](../-search-engine/index.html)
Loads a SearchEngine from the given path in assets and assigns it the given identifier.`fun load(identifier: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, stream: `[`InputStream`](http://docs.oracle.com/javase/6/docs/api/java/io/InputStream.html)`): `[`SearchEngine`](../-search-engine/index.html)
Loads a SearchEngine from the given stream and assigns it the given identifier. | + diff --git a/docs/api/0.21/browser-search/mozilla.components.browser.search/-search-engine-parser/load.md b/docs/api/0.21/browser-search/mozilla.components.browser.search/-search-engine-parser/load.md new file mode 100644 index 00000000000..d25891e9a65 --- /dev/null +++ b/docs/api/0.21/browser-search/mozilla.components.browser.search/-search-engine-parser/load.md @@ -0,0 +1,18 @@ +--- +title: SearchEngineParser.load - +--- + +[mozilla.components.browser.search](../index.html) / [SearchEngineParser](index.html) / [load](./load.html) + +# load + +`fun load(assetManager: AssetManager, identifier: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, path: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`SearchEngine`](../-search-engine/index.html) + +Loads a SearchEngine from the given path in assets and assigns +it the given identifier. + +`fun load(identifier: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, stream: `[`InputStream`](http://docs.oracle.com/javase/6/docs/api/java/io/InputStream.html)`): `[`SearchEngine`](../-search-engine/index.html) + +Loads a SearchEngine from the given stream and assigns it the given +identifier. + diff --git a/docs/api/0.21/browser-search/mozilla.components.browser.search/-search-engine/build-search-url.md b/docs/api/0.21/browser-search/mozilla.components.browser.search/-search-engine/build-search-url.md new file mode 100644 index 00000000000..fb3e0eb55a2 --- /dev/null +++ b/docs/api/0.21/browser-search/mozilla.components.browser.search/-search-engine/build-search-url.md @@ -0,0 +1,12 @@ +--- +title: SearchEngine.buildSearchUrl - +--- + +[mozilla.components.browser.search](../index.html) / [SearchEngine](index.html) / [buildSearchUrl](./build-search-url.html) + +# buildSearchUrl + +`fun buildSearchUrl(searchTerm: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) + +Builds a URL to search for the given search terms with this search engine. + diff --git a/docs/api/0.21/browser-search/mozilla.components.browser.search/-search-engine/build-suggestions-u-r-l.md b/docs/api/0.21/browser-search/mozilla.components.browser.search/-search-engine/build-suggestions-u-r-l.md new file mode 100644 index 00000000000..567c7431d0e --- /dev/null +++ b/docs/api/0.21/browser-search/mozilla.components.browser.search/-search-engine/build-suggestions-u-r-l.md @@ -0,0 +1,12 @@ +--- +title: SearchEngine.buildSuggestionsURL - +--- + +[mozilla.components.browser.search](../index.html) / [SearchEngine](index.html) / [buildSuggestionsURL](./build-suggestions-u-r-l.html) + +# buildSuggestionsURL + +`fun buildSuggestionsURL(searchTerm: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` + +Builds a URL to get suggestions from this search engine. + diff --git a/docs/api/0.21/browser-search/mozilla.components.browser.search/-search-engine/can-provide-search-suggestions.md b/docs/api/0.21/browser-search/mozilla.components.browser.search/-search-engine/can-provide-search-suggestions.md new file mode 100644 index 00000000000..1e541d12605 --- /dev/null +++ b/docs/api/0.21/browser-search/mozilla.components.browser.search/-search-engine/can-provide-search-suggestions.md @@ -0,0 +1,9 @@ +--- +title: SearchEngine.canProvideSearchSuggestions - +--- + +[mozilla.components.browser.search](../index.html) / [SearchEngine](index.html) / [canProvideSearchSuggestions](./can-provide-search-suggestions.html) + +# canProvideSearchSuggestions + +`val canProvideSearchSuggestions: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-search/mozilla.components.browser.search/-search-engine/icon.md b/docs/api/0.21/browser-search/mozilla.components.browser.search/-search-engine/icon.md new file mode 100644 index 00000000000..855dca73551 --- /dev/null +++ b/docs/api/0.21/browser-search/mozilla.components.browser.search/-search-engine/icon.md @@ -0,0 +1,9 @@ +--- +title: SearchEngine.icon - +--- + +[mozilla.components.browser.search](../index.html) / [SearchEngine](index.html) / [icon](./icon.html) + +# icon + +`val icon: Bitmap` \ No newline at end of file diff --git a/docs/api/0.21/browser-search/mozilla.components.browser.search/-search-engine/identifier.md b/docs/api/0.21/browser-search/mozilla.components.browser.search/-search-engine/identifier.md new file mode 100644 index 00000000000..b9cabfb376c --- /dev/null +++ b/docs/api/0.21/browser-search/mozilla.components.browser.search/-search-engine/identifier.md @@ -0,0 +1,9 @@ +--- +title: SearchEngine.identifier - +--- + +[mozilla.components.browser.search](../index.html) / [SearchEngine](index.html) / [identifier](./identifier.html) + +# identifier + +`val identifier: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-search/mozilla.components.browser.search/-search-engine/index.md b/docs/api/0.21/browser-search/mozilla.components.browser.search/-search-engine/index.md new file mode 100644 index 00000000000..e8d72368abf --- /dev/null +++ b/docs/api/0.21/browser-search/mozilla.components.browser.search/-search-engine/index.md @@ -0,0 +1,24 @@ +--- +title: SearchEngine - +--- + +[mozilla.components.browser.search](../index.html) / [SearchEngine](./index.html) + +# SearchEngine + +`class SearchEngine` + +A data class representing a search engine. + +### Properties + +| [canProvideSearchSuggestions](can-provide-search-suggestions.html) | `val canProvideSearchSuggestions: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [icon](icon.html) | `val icon: Bitmap` | +| [identifier](identifier.html) | `val identifier: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [name](name.html) | `val name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + +### Functions + +| [buildSearchUrl](build-search-url.html) | `fun buildSearchUrl(searchTerm: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Builds a URL to search for the given search terms with this search engine. | +| [buildSuggestionsURL](build-suggestions-u-r-l.html) | `fun buildSuggestionsURL(searchTerm: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
Builds a URL to get suggestions from this search engine. | + diff --git a/docs/api/0.21/browser-search/mozilla.components.browser.search/-search-engine/name.md b/docs/api/0.21/browser-search/mozilla.components.browser.search/-search-engine/name.md new file mode 100644 index 00000000000..d8b51240137 --- /dev/null +++ b/docs/api/0.21/browser-search/mozilla.components.browser.search/-search-engine/name.md @@ -0,0 +1,9 @@ +--- +title: SearchEngine.name - +--- + +[mozilla.components.browser.search](../index.html) / [SearchEngine](index.html) / [name](./name.html) + +# name + +`val name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-search/mozilla.components.browser.search/index.md b/docs/api/0.21/browser-search/mozilla.components.browser.search/index.md new file mode 100644 index 00000000000..65a9a179304 --- /dev/null +++ b/docs/api/0.21/browser-search/mozilla.components.browser.search/index.md @@ -0,0 +1,14 @@ +--- +title: mozilla.components.browser.search - +--- + +[mozilla.components.browser.search](./index.html) + +## Package mozilla.components.browser.search + +### Types + +| [SearchEngine](-search-engine/index.html) | `class SearchEngine`
A data class representing a search engine. | +| [SearchEngineManager](-search-engine-manager/index.html) | `class SearchEngineManager`
This class provides access to a centralized registry of search engines. | +| [SearchEngineParser](-search-engine-parser/index.html) | `class SearchEngineParser`
A very simple parser for search plugins. | + diff --git a/docs/api/0.21/browser-search/package-list b/docs/api/0.21/browser-search/package-list new file mode 100644 index 00000000000..98ae883e548 --- /dev/null +++ b/docs/api/0.21/browser-search/package-list @@ -0,0 +1,8 @@ +$dokka.format:jekyll +$dokka.linkExtension:html + +mozilla.components.browser.search +mozilla.components.browser.search.provider +mozilla.components.browser.search.provider.filter +mozilla.components.browser.search.provider.localization +mozilla.components.browser.search.suggestions diff --git a/docs/api/0.21/browser-session/alltypes/index.md b/docs/api/0.21/browser-session/alltypes/index.md new file mode 100644 index 00000000000..56887e85cc8 --- /dev/null +++ b/docs/api/0.21/browser-session/alltypes/index.md @@ -0,0 +1,16 @@ +--- +title: alltypes - +--- + +### All Types + +| [mozilla.components.browser.session.tab.CustomTabActionButtonConfig](../mozilla.components.browser.session.tab/-custom-tab-action-button-config/index.html) | | +| [mozilla.components.browser.session.tab.CustomTabConfig](../mozilla.components.browser.session.tab/-custom-tab-config/index.html) | Holds configuration data for a Custom Tab. Use [createFromIntent](../mozilla.components.browser.session.tab/-custom-tab-config/create-from-intent.html) to create instances. | +| [mozilla.components.browser.session.tab.CustomTabMenuItem](../mozilla.components.browser.session.tab/-custom-tab-menu-item/index.html) | | +| [mozilla.components.browser.session.tab.CustomTabsService](../mozilla.components.browser.session.tab/-custom-tabs-service/index.html) | | +| [mozilla.components.browser.session.storage.DefaultSessionStorage](../mozilla.components.browser.session.storage/-default-session-storage/index.html) | Default implementation of [SessionStorage](../mozilla.components.browser.session.storage/-session-storage/index.html) which persists browser and engine session states to a JSON file. | +| [mozilla.components.browser.session.Download](../mozilla.components.browser.session/-download/index.html) | Value type that represents a Download. | +| [mozilla.components.browser.session.Session](../mozilla.components.browser.session/-session/index.html) | Value type that represents the state of a browser session. Changes can be observed. | +| [mozilla.components.browser.session.SessionManager](../mozilla.components.browser.session/-session-manager/index.html) | This class provides access to a centralized registry of all active sessions. | +| [mozilla.components.browser.session.storage.SessionStorage](../mozilla.components.browser.session.storage/-session-storage/index.html) | Storage component for browser and engine sessions. | + diff --git a/docs/api/0.21/browser-session/index.md b/docs/api/0.21/browser-session/index.md new file mode 100644 index 00000000000..4b8de6225a8 --- /dev/null +++ b/docs/api/0.21/browser-session/index.md @@ -0,0 +1,13 @@ +--- +title: +--- + +### Packages + +| [mozilla.components.browser.session](mozilla.components.browser.session/index.html) | | +| [mozilla.components.browser.session.storage](mozilla.components.browser.session.storage/index.html) | | +| [mozilla.components.browser.session.tab](mozilla.components.browser.session.tab/index.html) | | + +### Index + +[All Types](alltypes/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session.storage/-default-session-storage/-init-.md b/docs/api/0.21/browser-session/mozilla.components.browser.session.storage/-default-session-storage/-init-.md new file mode 100644 index 00000000000..8f6267a9b79 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session.storage/-default-session-storage/-init-.md @@ -0,0 +1,27 @@ +--- +title: DefaultSessionStorage. - +--- + +[mozilla.components.browser.session.storage](../index.html) / [DefaultSessionStorage](index.html) / [<init>](./-init-.html) + +# <init> + +`DefaultSessionStorage(context: Context, savePeriodically: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = true, saveIntervalInSeconds: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)` = 300, scheduler: `[`ScheduledExecutorService`](http://docs.oracle.com/javase/6/docs/api/java/util/concurrent/ScheduledExecutorService.html)` = Executors.newSingleThreadScheduledExecutor())` + +Default implementation of [SessionStorage](../-session-storage/index.html) which persists browser and engine +session states to a JSON file. + +The JSON format used for persisting: +{ + "version": [version](#), + "selectedSession": "[session-uuid](#)", + "[session-uuid](#)": { + "session": {} + "engineSession": {} + }, + "[session-uuid](#)": { + "session": {} + "engineSession": {} + } +} + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session.storage/-default-session-storage/index.md b/docs/api/0.21/browser-session/mozilla.components.browser.session.storage/-default-session-storage/index.md new file mode 100644 index 00000000000..2c8b776c3de --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session.storage/-default-session-storage/index.md @@ -0,0 +1,38 @@ +--- +title: DefaultSessionStorage - +--- + +[mozilla.components.browser.session.storage](../index.html) / [DefaultSessionStorage](./index.html) + +# DefaultSessionStorage + +`class DefaultSessionStorage : `[`SessionStorage`](../-session-storage/index.html) + +Default implementation of [SessionStorage](../-session-storage/index.html) which persists browser and engine +session states to a JSON file. + +The JSON format used for persisting: +{ + "version": [version](#), + "selectedSession": "[session-uuid](#)", + "[session-uuid](#)": { + "session": {} + "engineSession": {} + }, + "[session-uuid](#)": { + "session": {} + "engineSession": {} + } +} + +### Constructors + +| [<init>](-init-.html) | `DefaultSessionStorage(context: Context, savePeriodically: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = true, saveIntervalInSeconds: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)` = 300, scheduler: `[`ScheduledExecutorService`](http://docs.oracle.com/javase/6/docs/api/java/util/concurrent/ScheduledExecutorService.html)` = Executors.newSingleThreadScheduledExecutor())`
Default implementation of [SessionStorage](../-session-storage/index.html) which persists browser and engine session states to a JSON file. | + +### Functions + +| [persist](persist.html) | `fun persist(sessionManager: `[`SessionManager`](../../mozilla.components.browser.session/-session-manager/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Persists the state of the provided sessions. | +| [restore](restore.html) | `fun restore(sessionManager: `[`SessionManager`](../../mozilla.components.browser.session/-session-manager/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Restores the session storage state by reading from the latest persisted version. | +| [start](start.html) | `fun start(sessionManager: `[`SessionManager`](../../mozilla.components.browser.session/-session-manager/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Starts saving the state frequently and automatically. | +| [stop](stop.html) | `fun stop(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Stops saving the state automatically. | + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session.storage/-default-session-storage/persist.md b/docs/api/0.21/browser-session/mozilla.components.browser.session.storage/-default-session-storage/persist.md new file mode 100644 index 00000000000..497c627dde5 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session.storage/-default-session-storage/persist.md @@ -0,0 +1,21 @@ +--- +title: DefaultSessionStorage.persist - +--- + +[mozilla.components.browser.session.storage](../index.html) / [DefaultSessionStorage](index.html) / [persist](./persist.html) + +# persist + +`@Synchronized fun persist(sessionManager: `[`SessionManager`](../../mozilla.components.browser.session/-session-manager/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Overrides [SessionStorage.persist](../-session-storage/persist.html) + +Persists the state of the provided sessions. + +### Parameters + +`sessionManager` - the session manager to persist from. + +**Return** +true if the state was persisted, otherwise false. + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session.storage/-default-session-storage/restore.md b/docs/api/0.21/browser-session/mozilla.components.browser.session.storage/-default-session-storage/restore.md new file mode 100644 index 00000000000..db8766441c9 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session.storage/-default-session-storage/restore.md @@ -0,0 +1,21 @@ +--- +title: DefaultSessionStorage.restore - +--- + +[mozilla.components.browser.session.storage](../index.html) / [DefaultSessionStorage](index.html) / [restore](./restore.html) + +# restore + +`@Synchronized fun restore(sessionManager: `[`SessionManager`](../../mozilla.components.browser.session/-session-manager/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Overrides [SessionStorage.restore](../-session-storage/restore.html) + +Restores the session storage state by reading from the latest persisted version. + +### Parameters + +`sessionManager` - the session manager to restore into. + +**Return** +map of all restored sessions, and the currently selected session id. + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session.storage/-default-session-storage/start.md b/docs/api/0.21/browser-session/mozilla.components.browser.session.storage/-default-session-storage/start.md new file mode 100644 index 00000000000..a42b631b056 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session.storage/-default-session-storage/start.md @@ -0,0 +1,17 @@ +--- +title: DefaultSessionStorage.start - +--- + +[mozilla.components.browser.session.storage](../index.html) / [DefaultSessionStorage](index.html) / [start](./start.html) + +# start + +`fun start(sessionManager: `[`SessionManager`](../../mozilla.components.browser.session/-session-manager/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Overrides [SessionStorage.start](../-session-storage/start.html) + +Starts saving the state frequently and automatically. + +### Parameters + +`sessionManager` - the session manager to persist from. \ No newline at end of file diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session.storage/-default-session-storage/stop.md b/docs/api/0.21/browser-session/mozilla.components.browser.session.storage/-default-session-storage/stop.md new file mode 100644 index 00000000000..e5b7b6119f0 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session.storage/-default-session-storage/stop.md @@ -0,0 +1,14 @@ +--- +title: DefaultSessionStorage.stop - +--- + +[mozilla.components.browser.session.storage](../index.html) / [DefaultSessionStorage](index.html) / [stop](./stop.html) + +# stop + +`fun stop(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Overrides [SessionStorage.stop](../-session-storage/stop.html) + +Stops saving the state automatically. + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session.storage/-e-n-g-i-n-e_-s-e-s-s-i-o-n_-k-e-y.md b/docs/api/0.21/browser-session/mozilla.components.browser.session.storage/-e-n-g-i-n-e_-s-e-s-s-i-o-n_-k-e-y.md new file mode 100644 index 00000000000..61d7e754538 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session.storage/-e-n-g-i-n-e_-s-e-s-s-i-o-n_-k-e-y.md @@ -0,0 +1,9 @@ +--- +title: ENGINE_SESSION_KEY - +--- + +[mozilla.components.browser.session.storage](index.html) / [ENGINE_SESSION_KEY](./-e-n-g-i-n-e_-s-e-s-s-i-o-n_-k-e-y.html) + +# ENGINE_SESSION_KEY + +`const val ENGINE_SESSION_KEY: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session.storage/-f-i-l-e_-n-a-m-e_-f-o-r-m-a-t.md b/docs/api/0.21/browser-session/mozilla.components.browser.session.storage/-f-i-l-e_-n-a-m-e_-f-o-r-m-a-t.md new file mode 100644 index 00000000000..28e86cf8f3d --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session.storage/-f-i-l-e_-n-a-m-e_-f-o-r-m-a-t.md @@ -0,0 +1,9 @@ +--- +title: FILE_NAME_FORMAT - +--- + +[mozilla.components.browser.session.storage](index.html) / [FILE_NAME_FORMAT](./-f-i-l-e_-n-a-m-e_-f-o-r-m-a-t.html) + +# FILE_NAME_FORMAT + +`const val FILE_NAME_FORMAT: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session.storage/-s-e-l-e-c-t-e-d_-s-e-s-s-i-o-n_-k-e-y.md b/docs/api/0.21/browser-session/mozilla.components.browser.session.storage/-s-e-l-e-c-t-e-d_-s-e-s-s-i-o-n_-k-e-y.md new file mode 100644 index 00000000000..9be1b548ad4 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session.storage/-s-e-l-e-c-t-e-d_-s-e-s-s-i-o-n_-k-e-y.md @@ -0,0 +1,9 @@ +--- +title: SELECTED_SESSION_KEY - +--- + +[mozilla.components.browser.session.storage](index.html) / [SELECTED_SESSION_KEY](./-s-e-l-e-c-t-e-d_-s-e-s-s-i-o-n_-k-e-y.html) + +# SELECTED_SESSION_KEY + +`const val SELECTED_SESSION_KEY: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session.storage/-s-e-s-s-i-o-n_-k-e-y.md b/docs/api/0.21/browser-session/mozilla.components.browser.session.storage/-s-e-s-s-i-o-n_-k-e-y.md new file mode 100644 index 00000000000..61b80518efb --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session.storage/-s-e-s-s-i-o-n_-k-e-y.md @@ -0,0 +1,9 @@ +--- +title: SESSION_KEY - +--- + +[mozilla.components.browser.session.storage](index.html) / [SESSION_KEY](./-s-e-s-s-i-o-n_-k-e-y.html) + +# SESSION_KEY + +`const val SESSION_KEY: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session.storage/-session-storage/index.md b/docs/api/0.21/browser-session/mozilla.components.browser.session.storage/-session-storage/index.md new file mode 100644 index 00000000000..1c860578d43 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session.storage/-session-storage/index.md @@ -0,0 +1,23 @@ +--- +title: SessionStorage - +--- + +[mozilla.components.browser.session.storage](../index.html) / [SessionStorage](./index.html) + +# SessionStorage + +`interface SessionStorage` + +Storage component for browser and engine sessions. + +### Functions + +| [persist](persist.html) | `abstract fun persist(sessionManager: `[`SessionManager`](../../mozilla.components.browser.session/-session-manager/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Persists the state of the provided sessions. | +| [restore](restore.html) | `abstract fun restore(sessionManager: `[`SessionManager`](../../mozilla.components.browser.session/-session-manager/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Restores the session storage state by reading from the latest persisted version. | +| [start](start.html) | `abstract fun start(sessionManager: `[`SessionManager`](../../mozilla.components.browser.session/-session-manager/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Starts saving the state frequently and automatically. | +| [stop](stop.html) | `abstract fun stop(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Stops saving the state automatically. | + +### Inheritors + +| [DefaultSessionStorage](../-default-session-storage/index.html) | `class DefaultSessionStorage : `[`SessionStorage`](./index.md)
Default implementation of [SessionStorage](./index.md) which persists browser and engine session states to a JSON file. | + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session.storage/-session-storage/persist.md b/docs/api/0.21/browser-session/mozilla.components.browser.session.storage/-session-storage/persist.md new file mode 100644 index 00000000000..75365bdb0f4 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session.storage/-session-storage/persist.md @@ -0,0 +1,19 @@ +--- +title: SessionStorage.persist - +--- + +[mozilla.components.browser.session.storage](../index.html) / [SessionStorage](index.html) / [persist](./persist.html) + +# persist + +`abstract fun persist(sessionManager: `[`SessionManager`](../../mozilla.components.browser.session/-session-manager/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Persists the state of the provided sessions. + +### Parameters + +`sessionManager` - the session manager to persist from. + +**Return** +true if the state was persisted, otherwise false. + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session.storage/-session-storage/restore.md b/docs/api/0.21/browser-session/mozilla.components.browser.session.storage/-session-storage/restore.md new file mode 100644 index 00000000000..ad4bf915e53 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session.storage/-session-storage/restore.md @@ -0,0 +1,19 @@ +--- +title: SessionStorage.restore - +--- + +[mozilla.components.browser.session.storage](../index.html) / [SessionStorage](index.html) / [restore](./restore.html) + +# restore + +`abstract fun restore(sessionManager: `[`SessionManager`](../../mozilla.components.browser.session/-session-manager/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Restores the session storage state by reading from the latest persisted version. + +### Parameters + +`sessionManager` - the session manager to restore into. + +**Return** +map of all restored sessions, and the currently selected session id. + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session.storage/-session-storage/start.md b/docs/api/0.21/browser-session/mozilla.components.browser.session.storage/-session-storage/start.md new file mode 100644 index 00000000000..039f339a3f3 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session.storage/-session-storage/start.md @@ -0,0 +1,15 @@ +--- +title: SessionStorage.start - +--- + +[mozilla.components.browser.session.storage](../index.html) / [SessionStorage](index.html) / [start](./start.html) + +# start + +`abstract fun start(sessionManager: `[`SessionManager`](../../mozilla.components.browser.session/-session-manager/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Starts saving the state frequently and automatically. + +### Parameters + +`sessionManager` - the session manager to persist from. \ No newline at end of file diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session.storage/-session-storage/stop.md b/docs/api/0.21/browser-session/mozilla.components.browser.session.storage/-session-storage/stop.md new file mode 100644 index 00000000000..a66a6f63f56 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session.storage/-session-storage/stop.md @@ -0,0 +1,12 @@ +--- +title: SessionStorage.stop - +--- + +[mozilla.components.browser.session.storage](../index.html) / [SessionStorage](index.html) / [stop](./stop.html) + +# stop + +`abstract fun stop(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Stops saving the state automatically. + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session.storage/-v-e-r-s-i-o-n.md b/docs/api/0.21/browser-session/mozilla.components.browser.session.storage/-v-e-r-s-i-o-n.md new file mode 100644 index 00000000000..e8efbe3f329 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session.storage/-v-e-r-s-i-o-n.md @@ -0,0 +1,9 @@ +--- +title: VERSION - +--- + +[mozilla.components.browser.session.storage](index.html) / [VERSION](./-v-e-r-s-i-o-n.html) + +# VERSION + +`const val VERSION: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session.storage/-v-e-r-s-i-o-n_-k-e-y.md b/docs/api/0.21/browser-session/mozilla.components.browser.session.storage/-v-e-r-s-i-o-n_-k-e-y.md new file mode 100644 index 00000000000..1a30b749309 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session.storage/-v-e-r-s-i-o-n_-k-e-y.md @@ -0,0 +1,9 @@ +--- +title: VERSION_KEY - +--- + +[mozilla.components.browser.session.storage](index.html) / [VERSION_KEY](./-v-e-r-s-i-o-n_-k-e-y.html) + +# VERSION_KEY + +`const val VERSION_KEY: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session.storage/index.md b/docs/api/0.21/browser-session/mozilla.components.browser.session.storage/index.md new file mode 100644 index 00000000000..8ca42063e41 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session.storage/index.md @@ -0,0 +1,22 @@ +--- +title: mozilla.components.browser.session.storage - +--- + +[mozilla.components.browser.session.storage](./index.html) + +## Package mozilla.components.browser.session.storage + +### Types + +| [DefaultSessionStorage](-default-session-storage/index.html) | `class DefaultSessionStorage : `[`SessionStorage`](-session-storage/index.html)
Default implementation of [SessionStorage](-session-storage/index.html) which persists browser and engine session states to a JSON file. | +| [SessionStorage](-session-storage/index.html) | `interface SessionStorage`
Storage component for browser and engine sessions. | + +### Properties + +| [ENGINE_SESSION_KEY](-e-n-g-i-n-e_-s-e-s-s-i-o-n_-k-e-y.html) | `const val ENGINE_SESSION_KEY: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [FILE_NAME_FORMAT](-f-i-l-e_-n-a-m-e_-f-o-r-m-a-t.html) | `const val FILE_NAME_FORMAT: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [SELECTED_SESSION_KEY](-s-e-l-e-c-t-e-d_-s-e-s-s-i-o-n_-k-e-y.html) | `const val SELECTED_SESSION_KEY: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [SESSION_KEY](-s-e-s-s-i-o-n_-k-e-y.html) | `const val SESSION_KEY: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [VERSION](-v-e-r-s-i-o-n.html) | `const val VERSION: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [VERSION_KEY](-v-e-r-s-i-o-n_-k-e-y.html) | `const val VERSION_KEY: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tab-action-button-config/-init-.md b/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tab-action-button-config/-init-.md new file mode 100644 index 00000000000..74849bc0217 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tab-action-button-config/-init-.md @@ -0,0 +1,9 @@ +--- +title: CustomTabActionButtonConfig. - +--- + +[mozilla.components.browser.session.tab](../index.html) / [CustomTabActionButtonConfig](index.html) / [<init>](./-init-.html) + +# <init> + +`CustomTabActionButtonConfig(description: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, icon: Bitmap, pendingIntent: PendingIntent)` \ No newline at end of file diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tab-action-button-config/description.md b/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tab-action-button-config/description.md new file mode 100644 index 00000000000..3d7b25ce091 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tab-action-button-config/description.md @@ -0,0 +1,9 @@ +--- +title: CustomTabActionButtonConfig.description - +--- + +[mozilla.components.browser.session.tab](../index.html) / [CustomTabActionButtonConfig](index.html) / [description](./description.html) + +# description + +`val description: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tab-action-button-config/icon.md b/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tab-action-button-config/icon.md new file mode 100644 index 00000000000..555f696cb45 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tab-action-button-config/icon.md @@ -0,0 +1,9 @@ +--- +title: CustomTabActionButtonConfig.icon - +--- + +[mozilla.components.browser.session.tab](../index.html) / [CustomTabActionButtonConfig](index.html) / [icon](./icon.html) + +# icon + +`val icon: Bitmap` \ No newline at end of file diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tab-action-button-config/index.md b/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tab-action-button-config/index.md new file mode 100644 index 00000000000..dc28c649b3e --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tab-action-button-config/index.md @@ -0,0 +1,20 @@ +--- +title: CustomTabActionButtonConfig - +--- + +[mozilla.components.browser.session.tab](../index.html) / [CustomTabActionButtonConfig](./index.html) + +# CustomTabActionButtonConfig + +`data class CustomTabActionButtonConfig` + +### Constructors + +| [<init>](-init-.html) | `CustomTabActionButtonConfig(description: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, icon: Bitmap, pendingIntent: PendingIntent)` | + +### Properties + +| [description](description.html) | `val description: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [icon](icon.html) | `val icon: Bitmap` | +| [pendingIntent](pending-intent.html) | `val pendingIntent: PendingIntent` | + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tab-action-button-config/pending-intent.md b/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tab-action-button-config/pending-intent.md new file mode 100644 index 00000000000..7e28f57def2 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tab-action-button-config/pending-intent.md @@ -0,0 +1,9 @@ +--- +title: CustomTabActionButtonConfig.pendingIntent - +--- + +[mozilla.components.browser.session.tab](../index.html) / [CustomTabActionButtonConfig](index.html) / [pendingIntent](./pending-intent.html) + +# pendingIntent + +`val pendingIntent: PendingIntent` \ No newline at end of file diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tab-config/action-button-config.md b/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tab-config/action-button-config.md new file mode 100644 index 00000000000..c6e7dffc912 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tab-config/action-button-config.md @@ -0,0 +1,9 @@ +--- +title: CustomTabConfig.actionButtonConfig - +--- + +[mozilla.components.browser.session.tab](../index.html) / [CustomTabConfig](index.html) / [actionButtonConfig](./action-button-config.html) + +# actionButtonConfig + +`val actionButtonConfig: `[`CustomTabActionButtonConfig`](../-custom-tab-action-button-config/index.html)`?` \ No newline at end of file diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tab-config/close-button-icon.md b/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tab-config/close-button-icon.md new file mode 100644 index 00000000000..50a9265509d --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tab-config/close-button-icon.md @@ -0,0 +1,9 @@ +--- +title: CustomTabConfig.closeButtonIcon - +--- + +[mozilla.components.browser.session.tab](../index.html) / [CustomTabConfig](index.html) / [closeButtonIcon](./close-button-icon.html) + +# closeButtonIcon + +`val closeButtonIcon: Bitmap?` \ No newline at end of file diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tab-config/create-from-intent.md b/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tab-config/create-from-intent.md new file mode 100644 index 00000000000..8f5571e13a4 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tab-config/create-from-intent.md @@ -0,0 +1,20 @@ +--- +title: CustomTabConfig.createFromIntent - +--- + +[mozilla.components.browser.session.tab](../index.html) / [CustomTabConfig](index.html) / [createFromIntent](./create-from-intent.html) + +# createFromIntent + +`fun createFromIntent(intent: SafeIntent): `[`CustomTabConfig`](index.html) + +Creates a CustomTabConfig instance based on the provided intent. + +### Parameters + +`intent` - the intent, wrapped as a SafeIntent, which is processed +to extract configuration data. + +**Return** +the CustomTabConfig instance. + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tab-config/disable-urlbar-hiding.md b/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tab-config/disable-urlbar-hiding.md new file mode 100644 index 00000000000..9e628f4c60e --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tab-config/disable-urlbar-hiding.md @@ -0,0 +1,9 @@ +--- +title: CustomTabConfig.disableUrlbarHiding - +--- + +[mozilla.components.browser.session.tab](../index.html) / [CustomTabConfig](index.html) / [disableUrlbarHiding](./disable-urlbar-hiding.html) + +# disableUrlbarHiding + +`val disableUrlbarHiding: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tab-config/id.md b/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tab-config/id.md new file mode 100644 index 00000000000..6c05a136ab7 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tab-config/id.md @@ -0,0 +1,9 @@ +--- +title: CustomTabConfig.id - +--- + +[mozilla.components.browser.session.tab](../index.html) / [CustomTabConfig](index.html) / [id](./id.html) + +# id + +`val id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tab-config/index.md b/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tab-config/index.md new file mode 100644 index 00000000000..72508e452e8 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tab-config/index.md @@ -0,0 +1,29 @@ +--- +title: CustomTabConfig - +--- + +[mozilla.components.browser.session.tab](../index.html) / [CustomTabConfig](./index.html) + +# CustomTabConfig + +`class CustomTabConfig` + +Holds configuration data for a Custom Tab. Use [createFromIntent](create-from-intent.html) to +create instances. + +### Properties + +| [actionButtonConfig](action-button-config.html) | `val actionButtonConfig: `[`CustomTabActionButtonConfig`](../-custom-tab-action-button-config/index.html)`?` | +| [closeButtonIcon](close-button-icon.html) | `val closeButtonIcon: Bitmap?` | +| [disableUrlbarHiding](disable-urlbar-hiding.html) | `val disableUrlbarHiding: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [id](id.html) | `val id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [menuItems](menu-items.html) | `val menuItems: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`CustomTabMenuItem`](../-custom-tab-menu-item/index.html)`>` | +| [options](options.html) | `val options: `[`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)`>` | +| [showShareMenuItem](show-share-menu-item.html) | `val showShareMenuItem: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [toolbarColor](toolbar-color.html) | `val toolbarColor: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`?` | + +### Companion Object Functions + +| [createFromIntent](create-from-intent.html) | `fun createFromIntent(intent: SafeIntent): `[`CustomTabConfig`](./index.md)
Creates a CustomTabConfig instance based on the provided intent. | +| [isCustomTabIntent](is-custom-tab-intent.html) | `fun isCustomTabIntent(intent: SafeIntent): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Checks if the provided intent is a custom tab intent. | + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tab-config/is-custom-tab-intent.md b/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tab-config/is-custom-tab-intent.md new file mode 100644 index 00000000000..fe1f1a4868e --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tab-config/is-custom-tab-intent.md @@ -0,0 +1,19 @@ +--- +title: CustomTabConfig.isCustomTabIntent - +--- + +[mozilla.components.browser.session.tab](../index.html) / [CustomTabConfig](index.html) / [isCustomTabIntent](./is-custom-tab-intent.html) + +# isCustomTabIntent + +`fun isCustomTabIntent(intent: SafeIntent): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Checks if the provided intent is a custom tab intent. + +### Parameters + +`intent` - the intent to check, wrapped as a SafeIntent. + +**Return** +true if the intent is a custom tab intent, otherwise false. + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tab-config/menu-items.md b/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tab-config/menu-items.md new file mode 100644 index 00000000000..383bcffc5a1 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tab-config/menu-items.md @@ -0,0 +1,9 @@ +--- +title: CustomTabConfig.menuItems - +--- + +[mozilla.components.browser.session.tab](../index.html) / [CustomTabConfig](index.html) / [menuItems](./menu-items.html) + +# menuItems + +`val menuItems: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`CustomTabMenuItem`](../-custom-tab-menu-item/index.html)`>` \ No newline at end of file diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tab-config/options.md b/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tab-config/options.md new file mode 100644 index 00000000000..e0aca27e222 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tab-config/options.md @@ -0,0 +1,9 @@ +--- +title: CustomTabConfig.options - +--- + +[mozilla.components.browser.session.tab](../index.html) / [CustomTabConfig](index.html) / [options](./options.html) + +# options + +`val options: `[`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)`>` \ No newline at end of file diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tab-config/show-share-menu-item.md b/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tab-config/show-share-menu-item.md new file mode 100644 index 00000000000..882073fbdba --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tab-config/show-share-menu-item.md @@ -0,0 +1,9 @@ +--- +title: CustomTabConfig.showShareMenuItem - +--- + +[mozilla.components.browser.session.tab](../index.html) / [CustomTabConfig](index.html) / [showShareMenuItem](./show-share-menu-item.html) + +# showShareMenuItem + +`val showShareMenuItem: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tab-config/toolbar-color.md b/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tab-config/toolbar-color.md new file mode 100644 index 00000000000..7dcbf17f111 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tab-config/toolbar-color.md @@ -0,0 +1,9 @@ +--- +title: CustomTabConfig.toolbarColor - +--- + +[mozilla.components.browser.session.tab](../index.html) / [CustomTabConfig](index.html) / [toolbarColor](./toolbar-color.html) + +# toolbarColor + +`val toolbarColor: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`?` \ No newline at end of file diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tab-menu-item/-init-.md b/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tab-menu-item/-init-.md new file mode 100644 index 00000000000..6580b52e5b0 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tab-menu-item/-init-.md @@ -0,0 +1,9 @@ +--- +title: CustomTabMenuItem. - +--- + +[mozilla.components.browser.session.tab](../index.html) / [CustomTabMenuItem](index.html) / [<init>](./-init-.html) + +# <init> + +`CustomTabMenuItem(name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, pendingIntent: PendingIntent)` \ No newline at end of file diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tab-menu-item/index.md b/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tab-menu-item/index.md new file mode 100644 index 00000000000..676266e33ce --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tab-menu-item/index.md @@ -0,0 +1,19 @@ +--- +title: CustomTabMenuItem - +--- + +[mozilla.components.browser.session.tab](../index.html) / [CustomTabMenuItem](./index.html) + +# CustomTabMenuItem + +`data class CustomTabMenuItem` + +### Constructors + +| [<init>](-init-.html) | `CustomTabMenuItem(name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, pendingIntent: PendingIntent)` | + +### Properties + +| [name](name.html) | `val name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [pendingIntent](pending-intent.html) | `val pendingIntent: PendingIntent` | + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tab-menu-item/name.md b/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tab-menu-item/name.md new file mode 100644 index 00000000000..14819b7ebf8 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tab-menu-item/name.md @@ -0,0 +1,9 @@ +--- +title: CustomTabMenuItem.name - +--- + +[mozilla.components.browser.session.tab](../index.html) / [CustomTabMenuItem](index.html) / [name](./name.html) + +# name + +`val name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tab-menu-item/pending-intent.md b/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tab-menu-item/pending-intent.md new file mode 100644 index 00000000000..bab6810ea6d --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tab-menu-item/pending-intent.md @@ -0,0 +1,9 @@ +--- +title: CustomTabMenuItem.pendingIntent - +--- + +[mozilla.components.browser.session.tab](../index.html) / [CustomTabMenuItem](index.html) / [pendingIntent](./pending-intent.html) + +# pendingIntent + +`val pendingIntent: PendingIntent` \ No newline at end of file diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tabs-service/-init-.md b/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tabs-service/-init-.md new file mode 100644 index 00000000000..566e68dae89 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tabs-service/-init-.md @@ -0,0 +1,9 @@ +--- +title: CustomTabsService. - +--- + +[mozilla.components.browser.session.tab](../index.html) / [CustomTabsService](index.html) / [<init>](./-init-.html) + +# <init> + +`CustomTabsService()` \ No newline at end of file diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tabs-service/index.md b/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tabs-service/index.md new file mode 100644 index 00000000000..269147d42cd --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tabs-service/index.md @@ -0,0 +1,18 @@ +--- +title: CustomTabsService - +--- + +[mozilla.components.browser.session.tab](../index.html) / [CustomTabsService](./index.html) + +# CustomTabsService + +`class CustomTabsService : Service` + +### Constructors + +| [<init>](-init-.html) | `CustomTabsService()` | + +### Functions + +| [onBind](on-bind.html) | `fun onBind(intent: Intent): IBinder?` | + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tabs-service/on-bind.md b/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tabs-service/on-bind.md new file mode 100644 index 00000000000..00a22c57b6f --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/-custom-tabs-service/on-bind.md @@ -0,0 +1,9 @@ +--- +title: CustomTabsService.onBind - +--- + +[mozilla.components.browser.session.tab](../index.html) / [CustomTabsService](index.html) / [onBind](./on-bind.html) + +# onBind + +`fun onBind(intent: Intent): IBinder?` \ No newline at end of file diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/index.md b/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/index.md new file mode 100644 index 00000000000..d24518eaade --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session.tab/index.md @@ -0,0 +1,15 @@ +--- +title: mozilla.components.browser.session.tab - +--- + +[mozilla.components.browser.session.tab](./index.html) + +## Package mozilla.components.browser.session.tab + +### Types + +| [CustomTabActionButtonConfig](-custom-tab-action-button-config/index.html) | `data class CustomTabActionButtonConfig` | +| [CustomTabConfig](-custom-tab-config/index.html) | `class CustomTabConfig`
Holds configuration data for a Custom Tab. Use [createFromIntent](-custom-tab-config/create-from-intent.html) to create instances. | +| [CustomTabMenuItem](-custom-tab-menu-item/index.html) | `data class CustomTabMenuItem` | +| [CustomTabsService](-custom-tabs-service/index.html) | `class CustomTabsService : Service` | + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-download/-init-.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-download/-init-.md new file mode 100644 index 00000000000..276ae6bae1d --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-download/-init-.md @@ -0,0 +1,12 @@ +--- +title: Download. - +--- + +[mozilla.components.browser.session](../index.html) / [Download](index.html) / [<init>](./-init-.html) + +# <init> + +`Download(url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, fileName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, contentType: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, contentLength: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`? = null, userAgent: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, destinationDirectory: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = Environment.DIRECTORY_DOWNLOADS)` + +Value type that represents a Download. + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-download/content-length.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-download/content-length.md new file mode 100644 index 00000000000..5ab3a04a63a --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-download/content-length.md @@ -0,0 +1,15 @@ +--- +title: Download.contentLength - +--- + +[mozilla.components.browser.session](../index.html) / [Download](index.html) / [contentLength](./content-length.html) + +# contentLength + +`val contentLength: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`?` + +The file size reported by the server. + +### Property + +`contentLength` - The file size reported by the server. \ No newline at end of file diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-download/content-type.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-download/content-type.md new file mode 100644 index 00000000000..2dbc3795e68 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-download/content-type.md @@ -0,0 +1,15 @@ +--- +title: Download.contentType - +--- + +[mozilla.components.browser.session](../index.html) / [Download](index.html) / [contentType](./content-type.html) + +# contentType + +`val contentType: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` + +Content type (MIME type) to indicate the media type of the download. + +### Property + +`contentType` - Content type (MIME type) to indicate the media type of the download. \ No newline at end of file diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-download/destination-directory.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-download/destination-directory.md new file mode 100644 index 00000000000..59f0a4e74fc --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-download/destination-directory.md @@ -0,0 +1,15 @@ +--- +title: Download.destinationDirectory - +--- + +[mozilla.components.browser.session](../index.html) / [Download](index.html) / [destinationDirectory](./destination-directory.html) + +# destinationDirectory + +`val destinationDirectory: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) + +The matching destination directory for this type of download. + +### Property + +`destinationDirectory` - The matching destination directory for this type of download. \ No newline at end of file diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-download/file-name.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-download/file-name.md new file mode 100644 index 00000000000..b5db27640ac --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-download/file-name.md @@ -0,0 +1,15 @@ +--- +title: Download.fileName - +--- + +[mozilla.components.browser.session](../index.html) / [Download](index.html) / [fileName](./file-name.html) + +# fileName + +`val fileName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` + +A canonical filename for this download. + +### Property + +`fileName` - A canonical filename for this download. \ No newline at end of file diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-download/index.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-download/index.md new file mode 100644 index 00000000000..87a6ec73133 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-download/index.md @@ -0,0 +1,25 @@ +--- +title: Download - +--- + +[mozilla.components.browser.session](../index.html) / [Download](./index.html) + +# Download + +`data class Download` + +Value type that represents a Download. + +### Constructors + +| [<init>](-init-.html) | `Download(url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, fileName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, contentType: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, contentLength: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`? = null, userAgent: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, destinationDirectory: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = Environment.DIRECTORY_DOWNLOADS)`
Value type that represents a Download. | + +### Properties + +| [contentLength](content-length.html) | `val contentLength: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`?`
The file size reported by the server. | +| [contentType](content-type.html) | `val contentType: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
Content type (MIME type) to indicate the media type of the download. | +| [destinationDirectory](destination-directory.html) | `val destinationDirectory: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
The matching destination directory for this type of download. | +| [fileName](file-name.html) | `val fileName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
A canonical filename for this download. | +| [url](url.html) | `val url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
The full url to the content that should be downloaded. | +| [userAgent](user-agent.html) | `val userAgent: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
The user agent to be used for the download. | + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-download/url.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-download/url.md new file mode 100644 index 00000000000..00946bfff24 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-download/url.md @@ -0,0 +1,15 @@ +--- +title: Download.url - +--- + +[mozilla.components.browser.session](../index.html) / [Download](index.html) / [url](./url.html) + +# url + +`val url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) + +The full url to the content that should be downloaded. + +### Property + +`url` - The full url to the content that should be downloaded. \ No newline at end of file diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-download/user-agent.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-download/user-agent.md new file mode 100644 index 00000000000..daa38ec6806 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-download/user-agent.md @@ -0,0 +1,15 @@ +--- +title: Download.userAgent - +--- + +[mozilla.components.browser.session](../index.html) / [Download](index.html) / [userAgent](./user-agent.html) + +# userAgent + +`val userAgent: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` + +The user agent to be used for the download. + +### Property + +`userAgent` - The user agent to be used for the download. \ No newline at end of file diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/-init-.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/-init-.md new file mode 100644 index 00000000000..2816a4e18d6 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/-init-.md @@ -0,0 +1,12 @@ +--- +title: SessionManager. - +--- + +[mozilla.components.browser.session](../index.html) / [SessionManager](index.html) / [<init>](./-init-.html) + +# <init> + +`SessionManager(engine: Engine, delegate: Observable<`[`Observer`](-observer/index.html)`> = ObserverRegistry())` + +This class provides access to a centralized registry of all active sessions. + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/-n-o_-s-e-l-e-c-t-i-o-n.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/-n-o_-s-e-l-e-c-t-i-o-n.md new file mode 100644 index 00000000000..00ff4004c8d --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/-n-o_-s-e-l-e-c-t-i-o-n.md @@ -0,0 +1,9 @@ +--- +title: SessionManager.NO_SELECTION - +--- + +[mozilla.components.browser.session](../index.html) / [SessionManager](index.html) / [NO_SELECTION](./-n-o_-s-e-l-e-c-t-i-o-n.html) + +# NO_SELECTION + +`const val NO_SELECTION: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/-observer/index.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/-observer/index.md new file mode 100644 index 00000000000..63a6f4d7895 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/-observer/index.md @@ -0,0 +1,19 @@ +--- +title: SessionManager.Observer - +--- + +[mozilla.components.browser.session](../../index.html) / [SessionManager](../index.html) / [Observer](./index.html) + +# Observer + +`interface Observer` + +Interface to be implemented by classes that want to observe the session manager. + +### Functions + +| [onAllSessionsRemoved](on-all-sessions-removed.html) | `open fun onAllSessionsRemoved(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
All sessions have been removed. Note that this will callback will be invoked whenever removeAll() or removeSessions have been called on the SessionManager. This callback will NOT be invoked when just the last session has been removed by calling remove() on the SessionManager. | +| [onSessionAdded](on-session-added.html) | `open fun onSessionAdded(session: `[`Session`](../../-session/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
The given session has been added. | +| [onSessionRemoved](on-session-removed.html) | `open fun onSessionRemoved(session: `[`Session`](../../-session/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
The given session has been removed. | +| [onSessionSelected](on-session-selected.html) | `open fun onSessionSelected(session: `[`Session`](../../-session/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
The selection has changed and the given session is now the selected session. | + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/-observer/on-all-sessions-removed.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/-observer/on-all-sessions-removed.md new file mode 100644 index 00000000000..ded81aadd1d --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/-observer/on-all-sessions-removed.md @@ -0,0 +1,15 @@ +--- +title: SessionManager.Observer.onAllSessionsRemoved - +--- + +[mozilla.components.browser.session](../../index.html) / [SessionManager](../index.html) / [Observer](index.html) / [onAllSessionsRemoved](./on-all-sessions-removed.html) + +# onAllSessionsRemoved + +`open fun onAllSessionsRemoved(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +All sessions have been removed. Note that this will callback will be invoked whenever +removeAll() or removeSessions have been called on the +SessionManager. This callback will NOT be invoked when just the last +session has been removed by calling remove() on the SessionManager. + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/-observer/on-session-added.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/-observer/on-session-added.md new file mode 100644 index 00000000000..cd18e1a7e12 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/-observer/on-session-added.md @@ -0,0 +1,12 @@ +--- +title: SessionManager.Observer.onSessionAdded - +--- + +[mozilla.components.browser.session](../../index.html) / [SessionManager](../index.html) / [Observer](index.html) / [onSessionAdded](./on-session-added.html) + +# onSessionAdded + +`open fun onSessionAdded(session: `[`Session`](../../-session/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +The given session has been added. + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/-observer/on-session-removed.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/-observer/on-session-removed.md new file mode 100644 index 00000000000..0d535083b26 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/-observer/on-session-removed.md @@ -0,0 +1,12 @@ +--- +title: SessionManager.Observer.onSessionRemoved - +--- + +[mozilla.components.browser.session](../../index.html) / [SessionManager](../index.html) / [Observer](index.html) / [onSessionRemoved](./on-session-removed.html) + +# onSessionRemoved + +`open fun onSessionRemoved(session: `[`Session`](../../-session/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +The given session has been removed. + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/-observer/on-session-selected.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/-observer/on-session-selected.md new file mode 100644 index 00000000000..a4bdc3f6a85 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/-observer/on-session-selected.md @@ -0,0 +1,12 @@ +--- +title: SessionManager.Observer.onSessionSelected - +--- + +[mozilla.components.browser.session](../../index.html) / [SessionManager](../index.html) / [Observer](index.html) / [onSessionSelected](./on-session-selected.html) + +# onSessionSelected + +`open fun onSessionSelected(session: `[`Session`](../../-session/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +The selection has changed and the given session is now the selected session. + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/add.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/add.md new file mode 100644 index 00000000000..36930441e01 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/add.md @@ -0,0 +1,12 @@ +--- +title: SessionManager.add - +--- + +[mozilla.components.browser.session](../index.html) / [SessionManager](index.html) / [add](./add.html) + +# add + +`fun add(session: `[`Session`](../-session/index.html)`, selected: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, engineSession: EngineSession? = null): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Adds the provided session. + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/all.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/all.md new file mode 100644 index 00000000000..26a64925c53 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/all.md @@ -0,0 +1,12 @@ +--- +title: SessionManager.all - +--- + +[mozilla.components.browser.session](../index.html) / [SessionManager](index.html) / [all](./all.html) + +# all + +`val all: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Session`](../-session/index.html)`>` + +Returns a list of all active sessions (including CustomTab sessions). + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/engine.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/engine.md new file mode 100644 index 00000000000..e655d6265b9 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/engine.md @@ -0,0 +1,9 @@ +--- +title: SessionManager.engine - +--- + +[mozilla.components.browser.session](../index.html) / [SessionManager](index.html) / [engine](./engine.html) + +# engine + +`val engine: Engine` \ No newline at end of file diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/find-session-by-id.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/find-session-by-id.md new file mode 100644 index 00000000000..82125d49033 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/find-session-by-id.md @@ -0,0 +1,13 @@ +--- +title: SessionManager.findSessionById - +--- + +[mozilla.components.browser.session](../index.html) / [SessionManager](index.html) / [findSessionById](./find-session-by-id.html) + +# findSessionById + +`fun findSessionById(id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Session`](../-session/index.html)`?` + +Finds and returns the session with the given id. Returns null if no matching session could be +found. + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/get-engine-session.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/get-engine-session.md new file mode 100644 index 00000000000..66357380b06 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/get-engine-session.md @@ -0,0 +1,12 @@ +--- +title: SessionManager.getEngineSession - +--- + +[mozilla.components.browser.session](../index.html) / [SessionManager](index.html) / [getEngineSession](./get-engine-session.html) + +# getEngineSession + +`fun getEngineSession(session: `[`Session`](../-session/index.html)` = selectedSessionOrThrow): EngineSession?` + +Gets the linked engine session for the provided session (if it exists). + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/get-or-create-engine-session.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/get-or-create-engine-session.md new file mode 100644 index 00000000000..897f23999c8 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/get-or-create-engine-session.md @@ -0,0 +1,12 @@ +--- +title: SessionManager.getOrCreateEngineSession - +--- + +[mozilla.components.browser.session](../index.html) / [SessionManager](index.html) / [getOrCreateEngineSession](./get-or-create-engine-session.html) + +# getOrCreateEngineSession + +`fun getOrCreateEngineSession(session: `[`Session`](../-session/index.html)` = selectedSessionOrThrow): EngineSession` + +Gets the linked engine session for the provided session and creates it if needed. + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/index.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/index.md new file mode 100644 index 00000000000..a65603e9064 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/index.md @@ -0,0 +1,44 @@ +--- +title: SessionManager - +--- + +[mozilla.components.browser.session](../index.html) / [SessionManager](./index.html) + +# SessionManager + +`class SessionManager : Observable<`[`Observer`](-observer/index.html)`>` + +This class provides access to a centralized registry of all active sessions. + +### Types + +| [Observer](-observer/index.html) | `interface Observer`
Interface to be implemented by classes that want to observe the session manager. | + +### Constructors + +| [<init>](-init-.html) | `SessionManager(engine: Engine, delegate: Observable<`[`Observer`](-observer/index.html)`> = ObserverRegistry())`
This class provides access to a centralized registry of all active sessions. | + +### Properties + +| [all](all.html) | `val all: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Session`](../-session/index.html)`>`
Returns a list of all active sessions (including CustomTab sessions). | +| [engine](engine.html) | `val engine: Engine` | +| [selectedSession](selected-session.html) | `val selectedSession: `[`Session`](../-session/index.html)`?`
Gets the currently selected session if there is one. | +| [selectedSessionOrThrow](selected-session-or-throw.html) | `val selectedSessionOrThrow: `[`Session`](../-session/index.html)
Gets the currently selected session or throws an IllegalStateException if no session is selected. | +| [sessions](sessions.html) | `val sessions: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Session`](../-session/index.html)`>`
Returns a list of active sessions and filters out sessions used for CustomTabs. | +| [size](size.html) | `val size: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Returns the number of session including CustomTab sessions. | + +### Functions + +| [add](add.html) | `fun add(session: `[`Session`](../-session/index.html)`, selected: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, engineSession: EngineSession? = null): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Adds the provided session. | +| [findSessionById](find-session-by-id.html) | `fun findSessionById(id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Session`](../-session/index.html)`?`
Finds and returns the session with the given id. Returns null if no matching session could be found. | +| [getEngineSession](get-engine-session.html) | `fun getEngineSession(session: `[`Session`](../-session/index.html)` = selectedSessionOrThrow): EngineSession?`
Gets the linked engine session for the provided session (if it exists). | +| [getOrCreateEngineSession](get-or-create-engine-session.html) | `fun getOrCreateEngineSession(session: `[`Session`](../-session/index.html)` = selectedSessionOrThrow): EngineSession`
Gets the linked engine session for the provided session and creates it if needed. | +| [remove](remove.html) | `fun remove(session: `[`Session`](../-session/index.html)` = selectedSessionOrThrow): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Removes the provided session. If no session is provided then the selected session is removed. | +| [removeAll](remove-all.html) | `fun removeAll(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Removes all sessions including CustomTab sessions. | +| [removeSessions](remove-sessions.html) | `fun removeSessions(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Removes all sessions but CustomTab sessions. | +| [select](select.html) | `fun select(session: `[`Session`](../-session/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Marks the given session as selected. | + +### Companion Object Properties + +| [NO_SELECTION](-n-o_-s-e-l-e-c-t-i-o-n.html) | `const val NO_SELECTION: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/remove-all.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/remove-all.md new file mode 100644 index 00000000000..43b5c7416cd --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/remove-all.md @@ -0,0 +1,12 @@ +--- +title: SessionManager.removeAll - +--- + +[mozilla.components.browser.session](../index.html) / [SessionManager](index.html) / [removeAll](./remove-all.html) + +# removeAll + +`fun removeAll(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Removes all sessions including CustomTab sessions. + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/remove-sessions.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/remove-sessions.md new file mode 100644 index 00000000000..8bc0fcb12bb --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/remove-sessions.md @@ -0,0 +1,12 @@ +--- +title: SessionManager.removeSessions - +--- + +[mozilla.components.browser.session](../index.html) / [SessionManager](index.html) / [removeSessions](./remove-sessions.html) + +# removeSessions + +`fun removeSessions(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Removes all sessions but CustomTab sessions. + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/remove.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/remove.md new file mode 100644 index 00000000000..d8940c346c8 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/remove.md @@ -0,0 +1,12 @@ +--- +title: SessionManager.remove - +--- + +[mozilla.components.browser.session](../index.html) / [SessionManager](index.html) / [remove](./remove.html) + +# remove + +`fun remove(session: `[`Session`](../-session/index.html)` = selectedSessionOrThrow): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Removes the provided session. If no session is provided then the selected session is removed. + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/select.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/select.md new file mode 100644 index 00000000000..f82bdabfb9a --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/select.md @@ -0,0 +1,12 @@ +--- +title: SessionManager.select - +--- + +[mozilla.components.browser.session](../index.html) / [SessionManager](index.html) / [select](./select.html) + +# select + +`fun select(session: `[`Session`](../-session/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Marks the given session as selected. + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/selected-session-or-throw.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/selected-session-or-throw.md new file mode 100644 index 00000000000..d69b4297975 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/selected-session-or-throw.md @@ -0,0 +1,21 @@ +--- +title: SessionManager.selectedSessionOrThrow - +--- + +[mozilla.components.browser.session](../index.html) / [SessionManager](index.html) / [selectedSessionOrThrow](./selected-session-or-throw.html) + +# selectedSessionOrThrow + +`val selectedSessionOrThrow: `[`Session`](../-session/index.html) + +Gets the currently selected session or throws an IllegalStateException if no session is +selected. + +It's application specific whether a session manager can have no selected session (= no sessions) +or not. In applications that always have at least one session dealing with the nullable +selectedSession property can be cumbersome. In those situations, where you always +expect a session to exist, you can use selectedSessionOrThrow to avoid dealing +with null values. + +Only one session can be selected at a given time. + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/selected-session.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/selected-session.md new file mode 100644 index 00000000000..be95b88262b --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/selected-session.md @@ -0,0 +1,14 @@ +--- +title: SessionManager.selectedSession - +--- + +[mozilla.components.browser.session](../index.html) / [SessionManager](index.html) / [selectedSession](./selected-session.html) + +# selectedSession + +`val selectedSession: `[`Session`](../-session/index.html)`?` + +Gets the currently selected session if there is one. + +Only one session can be selected at a given time. + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/sessions.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/sessions.md new file mode 100644 index 00000000000..5c674c9e050 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/sessions.md @@ -0,0 +1,12 @@ +--- +title: SessionManager.sessions - +--- + +[mozilla.components.browser.session](../index.html) / [SessionManager](index.html) / [sessions](./sessions.html) + +# sessions + +`val sessions: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Session`](../-session/index.html)`>` + +Returns a list of active sessions and filters out sessions used for CustomTabs. + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/size.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/size.md new file mode 100644 index 00000000000..e18f755d58a --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session-manager/size.md @@ -0,0 +1,12 @@ +--- +title: SessionManager.size - +--- + +[mozilla.components.browser.session](../index.html) / [SessionManager](index.html) / [size](./size.html) + +# size + +`val size: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +Returns the number of session including CustomTab sessions. + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-find-result/-init-.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-find-result/-init-.md new file mode 100644 index 00000000000..72d2fd6919b --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-find-result/-init-.md @@ -0,0 +1,12 @@ +--- +title: Session.FindResult. - +--- + +[mozilla.components.browser.session](../../index.html) / [Session](../index.html) / [FindResult](index.html) / [<init>](./-init-.html) + +# <init> + +`FindResult(activeMatchOrdinal: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, numberOfMatches: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, isDoneCounting: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`)` + +A value type representing a result of a "find in page" operation. + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-find-result/active-match-ordinal.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-find-result/active-match-ordinal.md new file mode 100644 index 00000000000..0623322d7b4 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-find-result/active-match-ordinal.md @@ -0,0 +1,15 @@ +--- +title: Session.FindResult.activeMatchOrdinal - +--- + +[mozilla.components.browser.session](../../index.html) / [Session](../index.html) / [FindResult](index.html) / [activeMatchOrdinal](./active-match-ordinal.html) + +# activeMatchOrdinal + +`val activeMatchOrdinal: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +the zero-based ordinal of the currently selected match. + +### Property + +`activeMatchOrdinal` - the zero-based ordinal of the currently selected match. \ No newline at end of file diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-find-result/index.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-find-result/index.md new file mode 100644 index 00000000000..a1d888bfb40 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-find-result/index.md @@ -0,0 +1,22 @@ +--- +title: Session.FindResult - +--- + +[mozilla.components.browser.session](../../index.html) / [Session](../index.html) / [FindResult](./index.html) + +# FindResult + +`data class FindResult` + +A value type representing a result of a "find in page" operation. + +### Constructors + +| [<init>](-init-.html) | `FindResult(activeMatchOrdinal: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, numberOfMatches: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, isDoneCounting: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`)`
A value type representing a result of a "find in page" operation. | + +### Properties + +| [activeMatchOrdinal](active-match-ordinal.html) | `val activeMatchOrdinal: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
the zero-based ordinal of the currently selected match. | +| [isDoneCounting](is-done-counting.html) | `val isDoneCounting: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
true if the find operation has completed, otherwise false. | +| [numberOfMatches](number-of-matches.html) | `val numberOfMatches: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
the match count | + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-find-result/is-done-counting.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-find-result/is-done-counting.md new file mode 100644 index 00000000000..a6e34babff9 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-find-result/is-done-counting.md @@ -0,0 +1,15 @@ +--- +title: Session.FindResult.isDoneCounting - +--- + +[mozilla.components.browser.session](../../index.html) / [Session](../index.html) / [FindResult](index.html) / [isDoneCounting](./is-done-counting.html) + +# isDoneCounting + +`val isDoneCounting: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +true if the find operation has completed, otherwise false. + +### Property + +`isDoneCounting` - true if the find operation has completed, otherwise false. \ No newline at end of file diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-find-result/number-of-matches.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-find-result/number-of-matches.md new file mode 100644 index 00000000000..bdf40596f8f --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-find-result/number-of-matches.md @@ -0,0 +1,15 @@ +--- +title: Session.FindResult.numberOfMatches - +--- + +[mozilla.components.browser.session](../../index.html) / [Session](../index.html) / [FindResult](index.html) / [numberOfMatches](./number-of-matches.html) + +# numberOfMatches + +`val numberOfMatches: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +the match count + +### Property + +`numberOfMatches` - the match count \ No newline at end of file diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-init-.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-init-.md new file mode 100644 index 00000000000..8d63b60e8b1 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-init-.md @@ -0,0 +1,12 @@ +--- +title: Session. - +--- + +[mozilla.components.browser.session](../index.html) / [Session](index.html) / [<init>](./-init-.html) + +# <init> + +`Session(initialUrl: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, private: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, source: `[`Source`](-source/index.html)` = Source.NONE, id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = UUID.randomUUID().toString(), delegate: Observable<`[`Observer`](-observer/index.html)`> = ObserverRegistry())` + +Value type that represents the state of a browser session. Changes can be observed. + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-observer/index.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-observer/index.md new file mode 100644 index 00000000000..d5feb881cd0 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-observer/index.md @@ -0,0 +1,28 @@ +--- +title: Session.Observer - +--- + +[mozilla.components.browser.session](../../index.html) / [Session](../index.html) / [Observer](./index.html) + +# Observer + +`interface Observer` + +Interface to be implemented by classes that want to observe a session. + +### Functions + +| [onCustomTabConfigChanged](on-custom-tab-config-changed.html) | `open fun onCustomTabConfigChanged(session: `[`Session`](../index.html)`, customTabConfig: `[`CustomTabConfig`](../../../mozilla.components.browser.session.tab/-custom-tab-config/index.html)`?): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onDownload](on-download.html) | `open fun onDownload(session: `[`Session`](../index.html)`, download: `[`Download`](../../-download/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [onFindResult](on-find-result.html) | `open fun onFindResult(session: `[`Session`](../index.html)`, result: `[`FindResult`](../-find-result/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onLoadingStateChanged](on-loading-state-changed.html) | `open fun onLoadingStateChanged(session: `[`Session`](../index.html)`, loading: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onLongPress](on-long-press.html) | `open fun onLongPress(session: `[`Session`](../index.html)`, hitResult: HitResult): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [onNavigationStateChanged](on-navigation-state-changed.html) | `open fun onNavigationStateChanged(session: `[`Session`](../index.html)`, canGoBack: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`, canGoForward: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onProgress](on-progress.html) | `open fun onProgress(session: `[`Session`](../index.html)`, progress: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onSearch](on-search.html) | `open fun onSearch(session: `[`Session`](../index.html)`, searchTerms: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onSecurityChanged](on-security-changed.html) | `open fun onSecurityChanged(session: `[`Session`](../index.html)`, securityInfo: `[`SecurityInfo`](../-security-info/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onTitleChanged](on-title-changed.html) | `open fun onTitleChanged(session: `[`Session`](../index.html)`, title: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onTrackerBlocked](on-tracker-blocked.html) | `open fun onTrackerBlocked(session: `[`Session`](../index.html)`, blocked: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, all: `[`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)`>): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onTrackerBlockingEnabledChanged](on-tracker-blocking-enabled-changed.html) | `open fun onTrackerBlockingEnabledChanged(session: `[`Session`](../index.html)`, blockingEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onUrlChanged](on-url-changed.html) | `open fun onUrlChanged(session: `[`Session`](../index.html)`, url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-observer/on-custom-tab-config-changed.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-observer/on-custom-tab-config-changed.md new file mode 100644 index 00000000000..61dfd42273f --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-observer/on-custom-tab-config-changed.md @@ -0,0 +1,9 @@ +--- +title: Session.Observer.onCustomTabConfigChanged - +--- + +[mozilla.components.browser.session](../../index.html) / [Session](../index.html) / [Observer](index.html) / [onCustomTabConfigChanged](./on-custom-tab-config-changed.html) + +# onCustomTabConfigChanged + +`open fun onCustomTabConfigChanged(session: `[`Session`](../index.html)`, customTabConfig: `[`CustomTabConfig`](../../../mozilla.components.browser.session.tab/-custom-tab-config/index.html)`?): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-observer/on-download.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-observer/on-download.md new file mode 100644 index 00000000000..4c98060632d --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-observer/on-download.md @@ -0,0 +1,9 @@ +--- +title: Session.Observer.onDownload - +--- + +[mozilla.components.browser.session](../../index.html) / [Session](../index.html) / [Observer](index.html) / [onDownload](./on-download.html) + +# onDownload + +`open fun onDownload(session: `[`Session`](../index.html)`, download: `[`Download`](../../-download/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-observer/on-find-result.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-observer/on-find-result.md new file mode 100644 index 00000000000..51f732c106a --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-observer/on-find-result.md @@ -0,0 +1,9 @@ +--- +title: Session.Observer.onFindResult - +--- + +[mozilla.components.browser.session](../../index.html) / [Session](../index.html) / [Observer](index.html) / [onFindResult](./on-find-result.html) + +# onFindResult + +`open fun onFindResult(session: `[`Session`](../index.html)`, result: `[`FindResult`](../-find-result/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-observer/on-loading-state-changed.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-observer/on-loading-state-changed.md new file mode 100644 index 00000000000..eaead97bcce --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-observer/on-loading-state-changed.md @@ -0,0 +1,9 @@ +--- +title: Session.Observer.onLoadingStateChanged - +--- + +[mozilla.components.browser.session](../../index.html) / [Session](../index.html) / [Observer](index.html) / [onLoadingStateChanged](./on-loading-state-changed.html) + +# onLoadingStateChanged + +`open fun onLoadingStateChanged(session: `[`Session`](../index.html)`, loading: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-observer/on-long-press.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-observer/on-long-press.md new file mode 100644 index 00000000000..f41763a1c70 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-observer/on-long-press.md @@ -0,0 +1,9 @@ +--- +title: Session.Observer.onLongPress - +--- + +[mozilla.components.browser.session](../../index.html) / [Session](../index.html) / [Observer](index.html) / [onLongPress](./on-long-press.html) + +# onLongPress + +`open fun onLongPress(session: `[`Session`](../index.html)`, hitResult: HitResult): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-observer/on-navigation-state-changed.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-observer/on-navigation-state-changed.md new file mode 100644 index 00000000000..faa518a7ae4 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-observer/on-navigation-state-changed.md @@ -0,0 +1,9 @@ +--- +title: Session.Observer.onNavigationStateChanged - +--- + +[mozilla.components.browser.session](../../index.html) / [Session](../index.html) / [Observer](index.html) / [onNavigationStateChanged](./on-navigation-state-changed.html) + +# onNavigationStateChanged + +`open fun onNavigationStateChanged(session: `[`Session`](../index.html)`, canGoBack: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`, canGoForward: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-observer/on-progress.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-observer/on-progress.md new file mode 100644 index 00000000000..a9a69e28337 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-observer/on-progress.md @@ -0,0 +1,9 @@ +--- +title: Session.Observer.onProgress - +--- + +[mozilla.components.browser.session](../../index.html) / [Session](../index.html) / [Observer](index.html) / [onProgress](./on-progress.html) + +# onProgress + +`open fun onProgress(session: `[`Session`](../index.html)`, progress: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-observer/on-search.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-observer/on-search.md new file mode 100644 index 00000000000..77f9a3ebe1e --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-observer/on-search.md @@ -0,0 +1,9 @@ +--- +title: Session.Observer.onSearch - +--- + +[mozilla.components.browser.session](../../index.html) / [Session](../index.html) / [Observer](index.html) / [onSearch](./on-search.html) + +# onSearch + +`open fun onSearch(session: `[`Session`](../index.html)`, searchTerms: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-observer/on-security-changed.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-observer/on-security-changed.md new file mode 100644 index 00000000000..10891b9cb73 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-observer/on-security-changed.md @@ -0,0 +1,9 @@ +--- +title: Session.Observer.onSecurityChanged - +--- + +[mozilla.components.browser.session](../../index.html) / [Session](../index.html) / [Observer](index.html) / [onSecurityChanged](./on-security-changed.html) + +# onSecurityChanged + +`open fun onSecurityChanged(session: `[`Session`](../index.html)`, securityInfo: `[`SecurityInfo`](../-security-info/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-observer/on-title-changed.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-observer/on-title-changed.md new file mode 100644 index 00000000000..d066ec9c8f1 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-observer/on-title-changed.md @@ -0,0 +1,9 @@ +--- +title: Session.Observer.onTitleChanged - +--- + +[mozilla.components.browser.session](../../index.html) / [Session](../index.html) / [Observer](index.html) / [onTitleChanged](./on-title-changed.html) + +# onTitleChanged + +`open fun onTitleChanged(session: `[`Session`](../index.html)`, title: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-observer/on-tracker-blocked.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-observer/on-tracker-blocked.md new file mode 100644 index 00000000000..5241c333fd7 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-observer/on-tracker-blocked.md @@ -0,0 +1,9 @@ +--- +title: Session.Observer.onTrackerBlocked - +--- + +[mozilla.components.browser.session](../../index.html) / [Session](../index.html) / [Observer](index.html) / [onTrackerBlocked](./on-tracker-blocked.html) + +# onTrackerBlocked + +`open fun onTrackerBlocked(session: `[`Session`](../index.html)`, blocked: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, all: `[`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)`>): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-observer/on-tracker-blocking-enabled-changed.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-observer/on-tracker-blocking-enabled-changed.md new file mode 100644 index 00000000000..736c160be06 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-observer/on-tracker-blocking-enabled-changed.md @@ -0,0 +1,9 @@ +--- +title: Session.Observer.onTrackerBlockingEnabledChanged - +--- + +[mozilla.components.browser.session](../../index.html) / [Session](../index.html) / [Observer](index.html) / [onTrackerBlockingEnabledChanged](./on-tracker-blocking-enabled-changed.html) + +# onTrackerBlockingEnabledChanged + +`open fun onTrackerBlockingEnabledChanged(session: `[`Session`](../index.html)`, blockingEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-observer/on-url-changed.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-observer/on-url-changed.md new file mode 100644 index 00000000000..92870999a0a --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-observer/on-url-changed.md @@ -0,0 +1,9 @@ +--- +title: Session.Observer.onUrlChanged - +--- + +[mozilla.components.browser.session](../../index.html) / [Session](../index.html) / [Observer](index.html) / [onUrlChanged](./on-url-changed.html) + +# onUrlChanged + +`open fun onUrlChanged(session: `[`Session`](../index.html)`, url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-security-info/-init-.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-security-info/-init-.md new file mode 100644 index 00000000000..530a813cb62 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-security-info/-init-.md @@ -0,0 +1,12 @@ +--- +title: Session.SecurityInfo. - +--- + +[mozilla.components.browser.session](../../index.html) / [Session](../index.html) / [SecurityInfo](index.html) / [<init>](./-init-.html) + +# <init> + +`SecurityInfo(secure: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, host: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = "", issuer: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = "")` + +A value type holding security information for a Session. + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-security-info/host.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-security-info/host.md new file mode 100644 index 00000000000..2b8ca0cee98 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-security-info/host.md @@ -0,0 +1,15 @@ +--- +title: Session.SecurityInfo.host - +--- + +[mozilla.components.browser.session](../../index.html) / [Session](../index.html) / [SecurityInfo](index.html) / [host](./host.html) + +# host + +`val host: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) + +domain for which the SSL certificate was issued. + +### Property + +`host` - domain for which the SSL certificate was issued. \ No newline at end of file diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-security-info/index.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-security-info/index.md new file mode 100644 index 00000000000..d0ebf418b63 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-security-info/index.md @@ -0,0 +1,22 @@ +--- +title: Session.SecurityInfo - +--- + +[mozilla.components.browser.session](../../index.html) / [Session](../index.html) / [SecurityInfo](./index.html) + +# SecurityInfo + +`data class SecurityInfo` + +A value type holding security information for a Session. + +### Constructors + +| [<init>](-init-.html) | `SecurityInfo(secure: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, host: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = "", issuer: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = "")`
A value type holding security information for a Session. | + +### Properties + +| [host](host.html) | `val host: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
domain for which the SSL certificate was issued. | +| [issuer](issuer.html) | `val issuer: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
name of the certificate authority who issued the SSL certificate. | +| [secure](secure.html) | `val secure: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
true if the session is currently pointed to a URL with a valid SSL certificate, otherwise false. | + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-security-info/issuer.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-security-info/issuer.md new file mode 100644 index 00000000000..7a0c3ec3da2 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-security-info/issuer.md @@ -0,0 +1,15 @@ +--- +title: Session.SecurityInfo.issuer - +--- + +[mozilla.components.browser.session](../../index.html) / [Session](../index.html) / [SecurityInfo](index.html) / [issuer](./issuer.html) + +# issuer + +`val issuer: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) + +name of the certificate authority who issued the SSL certificate. + +### Property + +`issuer` - name of the certificate authority who issued the SSL certificate. \ No newline at end of file diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-security-info/secure.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-security-info/secure.md new file mode 100644 index 00000000000..f4c4eddf256 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-security-info/secure.md @@ -0,0 +1,17 @@ +--- +title: Session.SecurityInfo.secure - +--- + +[mozilla.components.browser.session](../../index.html) / [Session](../index.html) / [SecurityInfo](index.html) / [secure](./secure.html) + +# secure + +`val secure: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +true if the session is currently pointed to a URL with +a valid SSL certificate, otherwise false. + +### Property + +`secure` - true if the session is currently pointed to a URL with +a valid SSL certificate, otherwise false. \ No newline at end of file diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-source/-a-c-t-i-o-n_-s-e-n-d.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-source/-a-c-t-i-o-n_-s-e-n-d.md new file mode 100644 index 00000000000..1eb991091c6 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-source/-a-c-t-i-o-n_-s-e-n-d.md @@ -0,0 +1,12 @@ +--- +title: Session.Source.ACTION_SEND - +--- + +[mozilla.components.browser.session](../../index.html) / [Session](../index.html) / [Source](index.html) / [ACTION_SEND](./-a-c-t-i-o-n_-s-e-n-d.html) + +# ACTION_SEND + +`ACTION_SEND` + +Created to handle an ACTION_SEND (share) intent + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-source/-a-c-t-i-o-n_-v-i-e-w.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-source/-a-c-t-i-o-n_-v-i-e-w.md new file mode 100644 index 00000000000..262704bd2dd --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-source/-a-c-t-i-o-n_-v-i-e-w.md @@ -0,0 +1,12 @@ +--- +title: Session.Source.ACTION_VIEW - +--- + +[mozilla.components.browser.session](../../index.html) / [Session](../index.html) / [Source](index.html) / [ACTION_VIEW](./-a-c-t-i-o-n_-v-i-e-w.html) + +# ACTION_VIEW + +`ACTION_VIEW` + +Created to handle an ACTION_VIEW intent + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-source/-c-u-s-t-o-m_-t-a-b.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-source/-c-u-s-t-o-m_-t-a-b.md new file mode 100644 index 00000000000..1b688bacc2e --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-source/-c-u-s-t-o-m_-t-a-b.md @@ -0,0 +1,12 @@ +--- +title: Session.Source.CUSTOM_TAB - +--- + +[mozilla.components.browser.session](../../index.html) / [Session](../index.html) / [Source](index.html) / [CUSTOM_TAB](./-c-u-s-t-o-m_-t-a-b.html) + +# CUSTOM_TAB + +`CUSTOM_TAB` + +Created to handle a CustomTabs intent + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-source/-h-o-m-e_-s-c-r-e-e-n.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-source/-h-o-m-e_-s-c-r-e-e-n.md new file mode 100644 index 00000000000..f629c57ca17 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-source/-h-o-m-e_-s-c-r-e-e-n.md @@ -0,0 +1,12 @@ +--- +title: Session.Source.HOME_SCREEN - +--- + +[mozilla.components.browser.session](../../index.html) / [Session](../index.html) / [Source](index.html) / [HOME_SCREEN](./-h-o-m-e_-s-c-r-e-e-n.html) + +# HOME_SCREEN + +`HOME_SCREEN` + +User interacted with the home screen + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-source/-m-e-n-u.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-source/-m-e-n-u.md new file mode 100644 index 00000000000..faadc5c21d7 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-source/-m-e-n-u.md @@ -0,0 +1,12 @@ +--- +title: Session.Source.MENU - +--- + +[mozilla.components.browser.session](../../index.html) / [Session](../index.html) / [Source](index.html) / [MENU](./-m-e-n-u.html) + +# MENU + +`MENU` + +User interacted with a menu + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-source/-n-e-w_-t-a-b.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-source/-n-e-w_-t-a-b.md new file mode 100644 index 00000000000..74bacc6ce29 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-source/-n-e-w_-t-a-b.md @@ -0,0 +1,12 @@ +--- +title: Session.Source.NEW_TAB - +--- + +[mozilla.components.browser.session](../../index.html) / [Session](../index.html) / [Source](index.html) / [NEW_TAB](./-n-e-w_-t-a-b.html) + +# NEW_TAB + +`NEW_TAB` + +User opened a new tab + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-source/-n-o-n-e.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-source/-n-o-n-e.md new file mode 100644 index 00000000000..6fba6f85ca0 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-source/-n-o-n-e.md @@ -0,0 +1,12 @@ +--- +title: Session.Source.NONE - +--- + +[mozilla.components.browser.session](../../index.html) / [Session](../index.html) / [Source](index.html) / [NONE](./-n-o-n-e.html) + +# NONE + +`NONE` + +Default value and for testing purposes + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-source/-t-e-x-t_-s-e-l-e-c-t-i-o-n.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-source/-t-e-x-t_-s-e-l-e-c-t-i-o-n.md new file mode 100644 index 00000000000..1de2499e7a6 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-source/-t-e-x-t_-s-e-l-e-c-t-i-o-n.md @@ -0,0 +1,12 @@ +--- +title: Session.Source.TEXT_SELECTION - +--- + +[mozilla.components.browser.session](../../index.html) / [Session](../index.html) / [Source](index.html) / [TEXT_SELECTION](./-t-e-x-t_-s-e-l-e-c-t-i-o-n.html) + +# TEXT_SELECTION + +`TEXT_SELECTION` + +Default value and for testing purposes + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-source/-u-s-e-r_-e-n-t-e-r-e-d.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-source/-u-s-e-r_-e-n-t-e-r-e-d.md new file mode 100644 index 00000000000..57b46de3a42 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-source/-u-s-e-r_-e-n-t-e-r-e-d.md @@ -0,0 +1,12 @@ +--- +title: Session.Source.USER_ENTERED - +--- + +[mozilla.components.browser.session](../../index.html) / [Session](../index.html) / [Source](index.html) / [USER_ENTERED](./-u-s-e-r_-e-n-t-e-r-e-d.html) + +# USER_ENTERED + +`USER_ENTERED` + +User entered a URL or search term + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-source/index.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-source/index.md new file mode 100644 index 00000000000..135e0364674 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/-source/index.md @@ -0,0 +1,24 @@ +--- +title: Session.Source - +--- + +[mozilla.components.browser.session](../../index.html) / [Session](../index.html) / [Source](./index.html) + +# Source + +`enum class Source` + +Represents the origin of a session to describe how and why it was created. + +### Enum Values + +| [ACTION_SEND](-a-c-t-i-o-n_-s-e-n-d.html) | Created to handle an ACTION_SEND (share) intent | +| [ACTION_VIEW](-a-c-t-i-o-n_-v-i-e-w.html) | Created to handle an ACTION_VIEW intent | +| [CUSTOM_TAB](-c-u-s-t-o-m_-t-a-b.html) | Created to handle a CustomTabs intent | +| [HOME_SCREEN](-h-o-m-e_-s-c-r-e-e-n.html) | User interacted with the home screen | +| [MENU](-m-e-n-u.html) | User interacted with a menu | +| [NEW_TAB](-n-e-w_-t-a-b.html) | User opened a new tab | +| [NONE](-n-o-n-e.html) | Default value and for testing purposes | +| [TEXT_SELECTION](-t-e-x-t_-s-e-l-e-c-t-i-o-n.html) | Default value and for testing purposes | +| [USER_ENTERED](-u-s-e-r_-e-n-t-e-r-e-d.html) | User entered a URL or search term | + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/can-go-back.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/can-go-back.md new file mode 100644 index 00000000000..12fe0bbb7fc --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/can-go-back.md @@ -0,0 +1,20 @@ +--- +title: Session.canGoBack - +--- + +[mozilla.components.browser.session](../index.html) / [Session](index.html) / [canGoBack](./can-go-back.html) + +# canGoBack + +`var canGoBack: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Navigation state, true if there's an history item to go back to, otherwise false. + +**Getter** + +Navigation state, true if there's an history item to go back to, otherwise false. + +**Setter** + +Navigation state, true if there's an history item to go back to, otherwise false. + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/can-go-forward.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/can-go-forward.md new file mode 100644 index 00000000000..036a08ec589 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/can-go-forward.md @@ -0,0 +1,20 @@ +--- +title: Session.canGoForward - +--- + +[mozilla.components.browser.session](../index.html) / [Session](index.html) / [canGoForward](./can-go-forward.html) + +# canGoForward + +`var canGoForward: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Navigation state, true if there's an history item to go forward to, otherwise false. + +**Getter** + +Navigation state, true if there's an history item to go forward to, otherwise false. + +**Setter** + +Navigation state, true if there's an history item to go forward to, otherwise false. + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/custom-tab-config.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/custom-tab-config.md new file mode 100644 index 00000000000..52d22fc3b3b --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/custom-tab-config.md @@ -0,0 +1,20 @@ +--- +title: Session.customTabConfig - +--- + +[mozilla.components.browser.session](../index.html) / [Session](index.html) / [customTabConfig](./custom-tab-config.html) + +# customTabConfig + +`var customTabConfig: `[`CustomTabConfig`](../../mozilla.components.browser.session.tab/-custom-tab-config/index.html)`?` + +Configuration data in case this session is used for a Custom Tab. + +**Getter** + +Configuration data in case this session is used for a Custom Tab. + +**Setter** + +Configuration data in case this session is used for a Custom Tab. + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/download.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/download.md new file mode 100644 index 00000000000..e6a0702bb5c --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/download.md @@ -0,0 +1,20 @@ +--- +title: Session.download - +--- + +[mozilla.components.browser.session](../index.html) / [Session](index.html) / [download](./download.html) + +# download + +`var download: Consumable<`[`Download`](../-download/index.html)`>` + +Last download request if it wasn't consumed by at least one observer. + +**Getter** + +Last download request if it wasn't consumed by at least one observer. + +**Setter** + +Last download request if it wasn't consumed by at least one observer. + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/equals.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/equals.md new file mode 100644 index 00000000000..ff697eb9672 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/equals.md @@ -0,0 +1,9 @@ +--- +title: Session.equals - +--- + +[mozilla.components.browser.session](../index.html) / [Session](index.html) / [equals](./equals.html) + +# equals + +`fun equals(other: `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`?): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/find-results.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/find-results.md new file mode 100644 index 00000000000..04182798cb2 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/find-results.md @@ -0,0 +1,20 @@ +--- +title: Session.findResults - +--- + +[mozilla.components.browser.session](../index.html) / [Session](index.html) / [findResults](./find-results.html) + +# findResults + +`var findResults: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`FindResult`](-find-result/index.html)`>` + +List of results of that latest "find in page" operation. + +**Getter** + +List of results of that latest "find in page" operation. + +**Setter** + +List of results of that latest "find in page" operation. + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/hash-code.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/hash-code.md new file mode 100644 index 00000000000..716c7edb8bb --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/hash-code.md @@ -0,0 +1,9 @@ +--- +title: Session.hashCode - +--- + +[mozilla.components.browser.session](../index.html) / [Session](index.html) / [hashCode](./hash-code.html) + +# hashCode + +`fun hashCode(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/hit-result.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/hit-result.md new file mode 100644 index 00000000000..faeac221422 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/hit-result.md @@ -0,0 +1,20 @@ +--- +title: Session.hitResult - +--- + +[mozilla.components.browser.session](../index.html) / [Session](index.html) / [hitResult](./hit-result.html) + +# hitResult + +`var hitResult: Consumable` + +The target of the latest long click operation. + +**Getter** + +The target of the latest long click operation. + +**Setter** + +The target of the latest long click operation. + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/id.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/id.md new file mode 100644 index 00000000000..b92e35d0b0e --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/id.md @@ -0,0 +1,9 @@ +--- +title: Session.id - +--- + +[mozilla.components.browser.session](../index.html) / [Session](index.html) / [id](./id.html) + +# id + +`val id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/index.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/index.md new file mode 100644 index 00000000000..29d570b669f --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/index.md @@ -0,0 +1,49 @@ +--- +title: Session - +--- + +[mozilla.components.browser.session](../index.html) / [Session](./index.html) + +# Session + +`class Session : Observable<`[`Observer`](-observer/index.html)`>` + +Value type that represents the state of a browser session. Changes can be observed. + +### Types + +| [FindResult](-find-result/index.html) | `data class FindResult`
A value type representing a result of a "find in page" operation. | +| [Observer](-observer/index.html) | `interface Observer`
Interface to be implemented by classes that want to observe a session. | +| [SecurityInfo](-security-info/index.html) | `data class SecurityInfo`
A value type holding security information for a Session. | +| [Source](-source/index.html) | `enum class Source`
Represents the origin of a session to describe how and why it was created. | + +### Constructors + +| [<init>](-init-.html) | `Session(initialUrl: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, private: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, source: `[`Source`](-source/index.html)` = Source.NONE, id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = UUID.randomUUID().toString(), delegate: Observable<`[`Observer`](-observer/index.html)`> = ObserverRegistry())`
Value type that represents the state of a browser session. Changes can be observed. | + +### Properties + +| [canGoBack](can-go-back.html) | `var canGoBack: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Navigation state, true if there's an history item to go back to, otherwise false. | +| [canGoForward](can-go-forward.html) | `var canGoForward: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Navigation state, true if there's an history item to go forward to, otherwise false. | +| [customTabConfig](custom-tab-config.html) | `var customTabConfig: `[`CustomTabConfig`](../../mozilla.components.browser.session.tab/-custom-tab-config/index.html)`?`
Configuration data in case this session is used for a Custom Tab. | +| [download](download.html) | `var download: Consumable<`[`Download`](../-download/index.html)`>`
Last download request if it wasn't consumed by at least one observer. | +| [findResults](find-results.html) | `var findResults: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`FindResult`](-find-result/index.html)`>`
List of results of that latest "find in page" operation. | +| [hitResult](hit-result.html) | `var hitResult: Consumable`
The target of the latest long click operation. | +| [id](id.html) | `val id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [loading](loading.html) | `var loading: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Loading state, true if this session's url is currently loading, otherwise false. | +| [private](private.html) | `val private: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [progress](progress.html) | `var progress: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
The progress loading the current URL. | +| [searchTerms](search-terms.html) | `var searchTerms: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
The currently / last used search terms. | +| [securityInfo](security-info.html) | `var securityInfo: `[`SecurityInfo`](-security-info/index.html)
Security information indicating whether or not the current session is for a secure URL, as well as the host and SSL certificate authority, if applicable. | +| [source](source.html) | `val source: `[`Source`](-source/index.html) | +| [title](title.html) | `var title: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
The title of the currently displayed website changed. | +| [trackerBlockingEnabled](tracker-blocking-enabled.html) | `var trackerBlockingEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Tracker blocking state, true if blocking trackers is enabled, otherwise false. | +| [trackersBlocked](trackers-blocked.html) | `var trackersBlocked: `[`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)`>`
List of URIs that have been blocked in this session. | +| [url](url.html) | `var url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
The currently loading or loaded URL. | + +### Functions + +| [equals](equals.html) | `fun equals(other: `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`?): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [hashCode](hash-code.html) | `fun hashCode(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [isCustomTabSession](is-custom-tab-session.html) | `fun isCustomTabSession(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Returns whether or not this session is used for a Custom Tab. | + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/is-custom-tab-session.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/is-custom-tab-session.md new file mode 100644 index 00000000000..f8810284f8c --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/is-custom-tab-session.md @@ -0,0 +1,12 @@ +--- +title: Session.isCustomTabSession - +--- + +[mozilla.components.browser.session](../index.html) / [Session](index.html) / [isCustomTabSession](./is-custom-tab-session.html) + +# isCustomTabSession + +`fun isCustomTabSession(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Returns whether or not this session is used for a Custom Tab. + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/loading.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/loading.md new file mode 100644 index 00000000000..904ca87469a --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/loading.md @@ -0,0 +1,20 @@ +--- +title: Session.loading - +--- + +[mozilla.components.browser.session](../index.html) / [Session](index.html) / [loading](./loading.html) + +# loading + +`var loading: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Loading state, true if this session's url is currently loading, otherwise false. + +**Getter** + +Loading state, true if this session's url is currently loading, otherwise false. + +**Setter** + +Loading state, true if this session's url is currently loading, otherwise false. + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/private.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/private.md new file mode 100644 index 00000000000..4705133e14a --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/private.md @@ -0,0 +1,9 @@ +--- +title: Session.private - +--- + +[mozilla.components.browser.session](../index.html) / [Session](index.html) / [private](./private.html) + +# private + +`val private: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/progress.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/progress.md new file mode 100644 index 00000000000..8e8bd69db1d --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/progress.md @@ -0,0 +1,20 @@ +--- +title: Session.progress - +--- + +[mozilla.components.browser.session](../index.html) / [Session](index.html) / [progress](./progress.html) + +# progress + +`var progress: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +The progress loading the current URL. + +**Getter** + +The progress loading the current URL. + +**Setter** + +The progress loading the current URL. + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/search-terms.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/search-terms.md new file mode 100644 index 00000000000..3ed7828040d --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/search-terms.md @@ -0,0 +1,20 @@ +--- +title: Session.searchTerms - +--- + +[mozilla.components.browser.session](../index.html) / [Session](index.html) / [searchTerms](./search-terms.html) + +# searchTerms + +`var searchTerms: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) + +The currently / last used search terms. + +**Getter** + +The currently / last used search terms. + +**Setter** + +The currently / last used search terms. + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/security-info.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/security-info.md new file mode 100644 index 00000000000..aa793f6cdbf --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/security-info.md @@ -0,0 +1,23 @@ +--- +title: Session.securityInfo - +--- + +[mozilla.components.browser.session](../index.html) / [Session](index.html) / [securityInfo](./security-info.html) + +# securityInfo + +`var securityInfo: `[`SecurityInfo`](-security-info/index.html) + +Security information indicating whether or not the current session is +for a secure URL, as well as the host and SSL certificate authority, if applicable. + +**Getter** + +Security information indicating whether or not the current session is +for a secure URL, as well as the host and SSL certificate authority, if applicable. + +**Setter** + +Security information indicating whether or not the current session is +for a secure URL, as well as the host and SSL certificate authority, if applicable. + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/source.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/source.md new file mode 100644 index 00000000000..3203874caea --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/source.md @@ -0,0 +1,9 @@ +--- +title: Session.source - +--- + +[mozilla.components.browser.session](../index.html) / [Session](index.html) / [source](./source.html) + +# source + +`val source: `[`Source`](-source/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/title.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/title.md new file mode 100644 index 00000000000..ea59e291abd --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/title.md @@ -0,0 +1,20 @@ +--- +title: Session.title - +--- + +[mozilla.components.browser.session](../index.html) / [Session](index.html) / [title](./title.html) + +# title + +`var title: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) + +The title of the currently displayed website changed. + +**Getter** + +The title of the currently displayed website changed. + +**Setter** + +The title of the currently displayed website changed. + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/tracker-blocking-enabled.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/tracker-blocking-enabled.md new file mode 100644 index 00000000000..d90a8285db4 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/tracker-blocking-enabled.md @@ -0,0 +1,20 @@ +--- +title: Session.trackerBlockingEnabled - +--- + +[mozilla.components.browser.session](../index.html) / [Session](index.html) / [trackerBlockingEnabled](./tracker-blocking-enabled.html) + +# trackerBlockingEnabled + +`var trackerBlockingEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Tracker blocking state, true if blocking trackers is enabled, otherwise false. + +**Getter** + +Tracker blocking state, true if blocking trackers is enabled, otherwise false. + +**Setter** + +Tracker blocking state, true if blocking trackers is enabled, otherwise false. + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/trackers-blocked.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/trackers-blocked.md new file mode 100644 index 00000000000..e145c463696 --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/trackers-blocked.md @@ -0,0 +1,20 @@ +--- +title: Session.trackersBlocked - +--- + +[mozilla.components.browser.session](../index.html) / [Session](index.html) / [trackersBlocked](./trackers-blocked.html) + +# trackersBlocked + +`var trackersBlocked: `[`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)`>` + +List of URIs that have been blocked in this session. + +**Getter** + +List of URIs that have been blocked in this session. + +**Setter** + +List of URIs that have been blocked in this session. + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/url.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/url.md new file mode 100644 index 00000000000..a4f11c9c44e --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/-session/url.md @@ -0,0 +1,20 @@ +--- +title: Session.url - +--- + +[mozilla.components.browser.session](../index.html) / [Session](index.html) / [url](./url.html) + +# url + +`var url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) + +The currently loading or loaded URL. + +**Getter** + +The currently loading or loaded URL. + +**Setter** + +The currently loading or loaded URL. + diff --git a/docs/api/0.21/browser-session/mozilla.components.browser.session/index.md b/docs/api/0.21/browser-session/mozilla.components.browser.session/index.md new file mode 100644 index 00000000000..6939212bfbe --- /dev/null +++ b/docs/api/0.21/browser-session/mozilla.components.browser.session/index.md @@ -0,0 +1,14 @@ +--- +title: mozilla.components.browser.session - +--- + +[mozilla.components.browser.session](./index.html) + +## Package mozilla.components.browser.session + +### Types + +| [Download](-download/index.html) | `data class Download`
Value type that represents a Download. | +| [Session](-session/index.html) | `class Session : Observable<`[`Observer`](-session/-observer/index.html)`>`
Value type that represents the state of a browser session. Changes can be observed. | +| [SessionManager](-session-manager/index.html) | `class SessionManager : Observable<`[`Observer`](-session-manager/-observer/index.html)`>`
This class provides access to a centralized registry of all active sessions. | + diff --git a/docs/api/0.21/browser-session/package-list b/docs/api/0.21/browser-session/package-list new file mode 100644 index 00000000000..0abdccad6f6 --- /dev/null +++ b/docs/api/0.21/browser-session/package-list @@ -0,0 +1,6 @@ +$dokka.format:jekyll +$dokka.linkExtension:html + +mozilla.components.browser.session +mozilla.components.browser.session.storage +mozilla.components.browser.session.tab diff --git a/docs/api/0.21/browser-tabstray/alltypes/index.md b/docs/api/0.21/browser-tabstray/alltypes/index.md new file mode 100644 index 00000000000..0e719b4f169 --- /dev/null +++ b/docs/api/0.21/browser-tabstray/alltypes/index.md @@ -0,0 +1,10 @@ +--- +title: alltypes - +--- + +### All Types + +| [mozilla.components.browser.tabstray.BrowserTabsTray](../mozilla.components.browser.tabstray/-browser-tabs-tray/index.html) | A customizable tabs tray for browsers. | +| [mozilla.components.browser.tabstray.TabViewHolder](../mozilla.components.browser.tabstray/-tab-view-holder/index.html) | A RecyclerView ViewHolder implementation for "tab" items. | +| [mozilla.components.browser.tabstray.TabsAdapter](../mozilla.components.browser.tabstray/-tabs-adapter/index.html) | RecyclerView adapter implementation to display a list/grid of tabs. | + diff --git a/docs/api/0.21/browser-tabstray/index.md b/docs/api/0.21/browser-tabstray/index.md new file mode 100644 index 00000000000..85015f65105 --- /dev/null +++ b/docs/api/0.21/browser-tabstray/index.md @@ -0,0 +1,11 @@ +--- +title: +--- + +### Packages + +| [mozilla.components.browser.tabstray](mozilla.components.browser.tabstray/index.html) | | + +### Index + +[All Types](alltypes/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-browser-tabs-tray/-init-.md b/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-browser-tabs-tray/-init-.md new file mode 100644 index 00000000000..256e994553a --- /dev/null +++ b/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-browser-tabs-tray/-init-.md @@ -0,0 +1,12 @@ +--- +title: BrowserTabsTray. - +--- + +[mozilla.components.browser.tabstray](../index.html) / [BrowserTabsTray](index.html) / [<init>](./-init-.html) + +# <init> + +`BrowserTabsTray(context: Context, attrs: AttributeSet? = null, defStyleAttr: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = 0, tabsAdapter: `[`TabsAdapter`](../-tabs-adapter/index.html)` = TabsAdapter())` + +A customizable tabs tray for browsers. + diff --git a/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-browser-tabs-tray/as-view.md b/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-browser-tabs-tray/as-view.md new file mode 100644 index 00000000000..a00aa033f8f --- /dev/null +++ b/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-browser-tabs-tray/as-view.md @@ -0,0 +1,12 @@ +--- +title: BrowserTabsTray.asView - +--- + +[mozilla.components.browser.tabstray](../index.html) / [BrowserTabsTray](index.html) / [asView](./as-view.html) + +# asView + +`fun asView(): View` + +Convenience method to cast this object to an Android View object. + diff --git a/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-browser-tabs-tray/index.md b/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-browser-tabs-tray/index.md new file mode 100644 index 00000000000..0f08bc860a0 --- /dev/null +++ b/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-browser-tabs-tray/index.md @@ -0,0 +1,21 @@ +--- +title: BrowserTabsTray - +--- + +[mozilla.components.browser.tabstray](../index.html) / [BrowserTabsTray](./index.html) + +# BrowserTabsTray + +`class BrowserTabsTray : RecyclerView, TabsTray` + +A customizable tabs tray for browsers. + +### Constructors + +| [<init>](-init-.html) | `BrowserTabsTray(context: Context, attrs: AttributeSet? = null, defStyleAttr: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = 0, tabsAdapter: `[`TabsAdapter`](../-tabs-adapter/index.html)` = TabsAdapter())`
A customizable tabs tray for browsers. | + +### Functions + +| [asView](as-view.html) | `fun asView(): View`
Convenience method to cast this object to an Android View object. | +| [onDetachedFromWindow](on-detached-from-window.html) | `fun onDetachedFromWindow(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | + diff --git a/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-browser-tabs-tray/on-detached-from-window.md b/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-browser-tabs-tray/on-detached-from-window.md new file mode 100644 index 00000000000..f96b6b52ec8 --- /dev/null +++ b/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-browser-tabs-tray/on-detached-from-window.md @@ -0,0 +1,9 @@ +--- +title: BrowserTabsTray.onDetachedFromWindow - +--- + +[mozilla.components.browser.tabstray](../index.html) / [BrowserTabsTray](index.html) / [onDetachedFromWindow](./on-detached-from-window.html) + +# onDetachedFromWindow + +`protected fun onDetachedFromWindow(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-tab-view-holder/-init-.md b/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-tab-view-holder/-init-.md new file mode 100644 index 00000000000..12d2456f131 --- /dev/null +++ b/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-tab-view-holder/-init-.md @@ -0,0 +1,12 @@ +--- +title: TabViewHolder. - +--- + +[mozilla.components.browser.tabstray](../index.html) / [TabViewHolder](index.html) / [<init>](./-init-.html) + +# <init> + +`TabViewHolder(itemView: View)` + +A RecyclerView ViewHolder implementation for "tab" items. + diff --git a/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-tab-view-holder/bind.md b/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-tab-view-holder/bind.md new file mode 100644 index 00000000000..3ccb0283d3a --- /dev/null +++ b/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-tab-view-holder/bind.md @@ -0,0 +1,12 @@ +--- +title: TabViewHolder.bind - +--- + +[mozilla.components.browser.tabstray](../index.html) / [TabViewHolder](index.html) / [bind](./bind.html) + +# bind + +`fun bind(session: Session, isSelected: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`, observable: Observable): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Displays the data of the given session and notifies the given observable about events. + diff --git a/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-tab-view-holder/index.md b/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-tab-view-holder/index.md new file mode 100644 index 00000000000..c0b382f1827 --- /dev/null +++ b/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-tab-view-holder/index.md @@ -0,0 +1,22 @@ +--- +title: TabViewHolder - +--- + +[mozilla.components.browser.tabstray](../index.html) / [TabViewHolder](./index.html) + +# TabViewHolder + +`class TabViewHolder : ViewHolder, Observer` + +A RecyclerView ViewHolder implementation for "tab" items. + +### Constructors + +| [<init>](-init-.html) | `TabViewHolder(itemView: View)`
A RecyclerView ViewHolder implementation for "tab" items. | + +### Functions + +| [bind](bind.html) | `fun bind(session: Session, isSelected: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`, observable: Observable): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Displays the data of the given session and notifies the given observable about events. | +| [onUrlChanged](on-url-changed.html) | `fun onUrlChanged(session: Session, url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [unbind](unbind.html) | `fun unbind(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
The attached view no longer needs to display any data. | + diff --git a/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-tab-view-holder/on-url-changed.md b/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-tab-view-holder/on-url-changed.md new file mode 100644 index 00000000000..7db71e1566b --- /dev/null +++ b/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-tab-view-holder/on-url-changed.md @@ -0,0 +1,9 @@ +--- +title: TabViewHolder.onUrlChanged - +--- + +[mozilla.components.browser.tabstray](../index.html) / [TabViewHolder](index.html) / [onUrlChanged](./on-url-changed.html) + +# onUrlChanged + +`fun onUrlChanged(session: Session, url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-tab-view-holder/unbind.md b/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-tab-view-holder/unbind.md new file mode 100644 index 00000000000..82a00db7d8f --- /dev/null +++ b/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-tab-view-holder/unbind.md @@ -0,0 +1,12 @@ +--- +title: TabViewHolder.unbind - +--- + +[mozilla.components.browser.tabstray](../index.html) / [TabViewHolder](index.html) / [unbind](./unbind.html) + +# unbind + +`fun unbind(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +The attached view no longer needs to display any data. + diff --git a/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-tabs-adapter/-init-.md b/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-tabs-adapter/-init-.md new file mode 100644 index 00000000000..ca410b2d1cc --- /dev/null +++ b/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-tabs-adapter/-init-.md @@ -0,0 +1,12 @@ +--- +title: TabsAdapter. - +--- + +[mozilla.components.browser.tabstray](../index.html) / [TabsAdapter](index.html) / [<init>](./-init-.html) + +# <init> + +`TabsAdapter(delegate: Observable = ObserverRegistry())` + +RecyclerView adapter implementation to display a list/grid of tabs. + diff --git a/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-tabs-adapter/display-sessions.md b/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-tabs-adapter/display-sessions.md new file mode 100644 index 00000000000..64ba5e82f4e --- /dev/null +++ b/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-tabs-adapter/display-sessions.md @@ -0,0 +1,9 @@ +--- +title: TabsAdapter.displaySessions - +--- + +[mozilla.components.browser.tabstray](../index.html) / [TabsAdapter](index.html) / [displaySessions](./display-sessions.html) + +# displaySessions + +`fun displaySessions(sessions: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`, selectedIndex: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-tabs-adapter/get-item-count.md b/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-tabs-adapter/get-item-count.md new file mode 100644 index 00000000000..ea2817ae849 --- /dev/null +++ b/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-tabs-adapter/get-item-count.md @@ -0,0 +1,9 @@ +--- +title: TabsAdapter.getItemCount - +--- + +[mozilla.components.browser.tabstray](../index.html) / [TabsAdapter](index.html) / [getItemCount](./get-item-count.html) + +# getItemCount + +`fun getItemCount(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-tabs-adapter/index.md b/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-tabs-adapter/index.md new file mode 100644 index 00000000000..e22973f43e5 --- /dev/null +++ b/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-tabs-adapter/index.md @@ -0,0 +1,30 @@ +--- +title: TabsAdapter - +--- + +[mozilla.components.browser.tabstray](../index.html) / [TabsAdapter](./index.html) + +# TabsAdapter + +`class TabsAdapter : Adapter<`[`TabViewHolder`](../-tab-view-holder/index.html)`>, TabsTray, Observable` + +RecyclerView adapter implementation to display a list/grid of tabs. + +### Constructors + +| [<init>](-init-.html) | `TabsAdapter(delegate: Observable = ObserverRegistry())`
RecyclerView adapter implementation to display a list/grid of tabs. | + +### Functions + +| [displaySessions](display-sessions.html) | `fun displaySessions(sessions: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`, selectedIndex: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [getItemCount](get-item-count.html) | `fun getItemCount(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [onBindViewHolder](on-bind-view-holder.html) | `fun onBindViewHolder(holder: `[`TabViewHolder`](../-tab-view-holder/index.html)`, position: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onCreateViewHolder](on-create-view-holder.html) | `fun onCreateViewHolder(parent: ViewGroup, viewType: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`TabViewHolder`](../-tab-view-holder/index.html) | +| [onSessionMoved](on-session-moved.html) | `fun onSessionMoved(fromPosition: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, toPosition: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onSessionsChanged](on-sessions-changed.html) | `fun onSessionsChanged(position: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, count: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onSessionsInserted](on-sessions-inserted.html) | `fun onSessionsInserted(position: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, count: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onSessionsRemoved](on-sessions-removed.html) | `fun onSessionsRemoved(position: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, count: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onViewRecycled](on-view-recycled.html) | `fun onViewRecycled(holder: `[`TabViewHolder`](../-tab-view-holder/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [unsubscribeHolders](unsubscribe-holders.html) | `fun unsubscribeHolders(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [updateSessions](update-sessions.html) | `fun updateSessions(sessions: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`, selectedIndex: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | + diff --git a/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-tabs-adapter/on-bind-view-holder.md b/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-tabs-adapter/on-bind-view-holder.md new file mode 100644 index 00000000000..f6c67cd4459 --- /dev/null +++ b/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-tabs-adapter/on-bind-view-holder.md @@ -0,0 +1,9 @@ +--- +title: TabsAdapter.onBindViewHolder - +--- + +[mozilla.components.browser.tabstray](../index.html) / [TabsAdapter](index.html) / [onBindViewHolder](./on-bind-view-holder.html) + +# onBindViewHolder + +`fun onBindViewHolder(holder: `[`TabViewHolder`](../-tab-view-holder/index.html)`, position: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-tabs-adapter/on-create-view-holder.md b/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-tabs-adapter/on-create-view-holder.md new file mode 100644 index 00000000000..a928cccdf02 --- /dev/null +++ b/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-tabs-adapter/on-create-view-holder.md @@ -0,0 +1,9 @@ +--- +title: TabsAdapter.onCreateViewHolder - +--- + +[mozilla.components.browser.tabstray](../index.html) / [TabsAdapter](index.html) / [onCreateViewHolder](./on-create-view-holder.html) + +# onCreateViewHolder + +`fun onCreateViewHolder(parent: ViewGroup, viewType: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`TabViewHolder`](../-tab-view-holder/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-tabs-adapter/on-session-moved.md b/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-tabs-adapter/on-session-moved.md new file mode 100644 index 00000000000..5cd4cad5811 --- /dev/null +++ b/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-tabs-adapter/on-session-moved.md @@ -0,0 +1,9 @@ +--- +title: TabsAdapter.onSessionMoved - +--- + +[mozilla.components.browser.tabstray](../index.html) / [TabsAdapter](index.html) / [onSessionMoved](./on-session-moved.html) + +# onSessionMoved + +`fun onSessionMoved(fromPosition: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, toPosition: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-tabs-adapter/on-sessions-changed.md b/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-tabs-adapter/on-sessions-changed.md new file mode 100644 index 00000000000..3be199be500 --- /dev/null +++ b/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-tabs-adapter/on-sessions-changed.md @@ -0,0 +1,9 @@ +--- +title: TabsAdapter.onSessionsChanged - +--- + +[mozilla.components.browser.tabstray](../index.html) / [TabsAdapter](index.html) / [onSessionsChanged](./on-sessions-changed.html) + +# onSessionsChanged + +`fun onSessionsChanged(position: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, count: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-tabs-adapter/on-sessions-inserted.md b/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-tabs-adapter/on-sessions-inserted.md new file mode 100644 index 00000000000..4a518ce5cfa --- /dev/null +++ b/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-tabs-adapter/on-sessions-inserted.md @@ -0,0 +1,9 @@ +--- +title: TabsAdapter.onSessionsInserted - +--- + +[mozilla.components.browser.tabstray](../index.html) / [TabsAdapter](index.html) / [onSessionsInserted](./on-sessions-inserted.html) + +# onSessionsInserted + +`fun onSessionsInserted(position: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, count: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-tabs-adapter/on-sessions-removed.md b/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-tabs-adapter/on-sessions-removed.md new file mode 100644 index 00000000000..7434bdf0d83 --- /dev/null +++ b/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-tabs-adapter/on-sessions-removed.md @@ -0,0 +1,9 @@ +--- +title: TabsAdapter.onSessionsRemoved - +--- + +[mozilla.components.browser.tabstray](../index.html) / [TabsAdapter](index.html) / [onSessionsRemoved](./on-sessions-removed.html) + +# onSessionsRemoved + +`fun onSessionsRemoved(position: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, count: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-tabs-adapter/on-view-recycled.md b/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-tabs-adapter/on-view-recycled.md new file mode 100644 index 00000000000..3621fd86991 --- /dev/null +++ b/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-tabs-adapter/on-view-recycled.md @@ -0,0 +1,9 @@ +--- +title: TabsAdapter.onViewRecycled - +--- + +[mozilla.components.browser.tabstray](../index.html) / [TabsAdapter](index.html) / [onViewRecycled](./on-view-recycled.html) + +# onViewRecycled + +`fun onViewRecycled(holder: `[`TabViewHolder`](../-tab-view-holder/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-tabs-adapter/unsubscribe-holders.md b/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-tabs-adapter/unsubscribe-holders.md new file mode 100644 index 00000000000..b18b0d7e876 --- /dev/null +++ b/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-tabs-adapter/unsubscribe-holders.md @@ -0,0 +1,9 @@ +--- +title: TabsAdapter.unsubscribeHolders - +--- + +[mozilla.components.browser.tabstray](../index.html) / [TabsAdapter](index.html) / [unsubscribeHolders](./unsubscribe-holders.html) + +# unsubscribeHolders + +`fun unsubscribeHolders(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-tabs-adapter/update-sessions.md b/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-tabs-adapter/update-sessions.md new file mode 100644 index 00000000000..7a69a4c7e5c --- /dev/null +++ b/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/-tabs-adapter/update-sessions.md @@ -0,0 +1,9 @@ +--- +title: TabsAdapter.updateSessions - +--- + +[mozilla.components.browser.tabstray](../index.html) / [TabsAdapter](index.html) / [updateSessions](./update-sessions.html) + +# updateSessions + +`fun updateSessions(sessions: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`, selectedIndex: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/index.md b/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/index.md new file mode 100644 index 00000000000..07327f5354a --- /dev/null +++ b/docs/api/0.21/browser-tabstray/mozilla.components.browser.tabstray/index.md @@ -0,0 +1,14 @@ +--- +title: mozilla.components.browser.tabstray - +--- + +[mozilla.components.browser.tabstray](./index.html) + +## Package mozilla.components.browser.tabstray + +### Types + +| [BrowserTabsTray](-browser-tabs-tray/index.html) | `class BrowserTabsTray : RecyclerView, TabsTray`
A customizable tabs tray for browsers. | +| [TabViewHolder](-tab-view-holder/index.html) | `class TabViewHolder : ViewHolder, Observer`
A RecyclerView ViewHolder implementation for "tab" items. | +| [TabsAdapter](-tabs-adapter/index.html) | `class TabsAdapter : Adapter<`[`TabViewHolder`](-tab-view-holder/index.html)`>, TabsTray, Observable`
RecyclerView adapter implementation to display a list/grid of tabs. | + diff --git a/docs/api/0.21/browser-tabstray/package-list b/docs/api/0.21/browser-tabstray/package-list new file mode 100644 index 00000000000..004ed8fade3 --- /dev/null +++ b/docs/api/0.21/browser-tabstray/package-list @@ -0,0 +1,4 @@ +$dokka.format:jekyll +$dokka.linkExtension:html + +mozilla.components.browser.tabstray diff --git a/docs/api/0.21/browser-toolbar/alltypes/index.md b/docs/api/0.21/browser-toolbar/alltypes/index.md new file mode 100644 index 00000000000..1892d164455 --- /dev/null +++ b/docs/api/0.21/browser-toolbar/alltypes/index.md @@ -0,0 +1,9 @@ +--- +title: alltypes - +--- + +### All Types + +| [mozilla.components.browser.toolbar.BrowserToolbar](../mozilla.components.browser.toolbar/-browser-toolbar/index.html) | A customizable toolbar for browsers. | +| [mozilla.components.browser.toolbar.edit.EditToolbar](../mozilla.components.browser.toolbar.edit/-edit-toolbar/index.html) | Sub-component of the browser toolbar responsible for allowing the user to edit the URL. | + diff --git a/docs/api/0.21/browser-toolbar/index.md b/docs/api/0.21/browser-toolbar/index.md new file mode 100644 index 00000000000..020d77202e6 --- /dev/null +++ b/docs/api/0.21/browser-toolbar/index.md @@ -0,0 +1,12 @@ +--- +title: +--- + +### Packages + +| [mozilla.components.browser.toolbar](mozilla.components.browser.toolbar/index.html) | | +| [mozilla.components.browser.toolbar.edit](mozilla.components.browser.toolbar.edit/index.html) | | + +### Index + +[All Types](alltypes/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar.edit/-edit-toolbar/-init-.md b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar.edit/-edit-toolbar/-init-.md new file mode 100644 index 00000000000..08bb472478b --- /dev/null +++ b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar.edit/-edit-toolbar/-init-.md @@ -0,0 +1,20 @@ +--- +title: EditToolbar. - +--- + +[mozilla.components.browser.toolbar.edit](../index.html) / [EditToolbar](index.html) / [<init>](./-init-.html) + +# <init> + +`EditToolbar(context: Context, toolbar: `[`BrowserToolbar`](../../mozilla.components.browser.toolbar/-browser-toolbar/index.html)`)` + +Sub-component of the browser toolbar responsible for allowing the user to edit the URL. + +Structure: ++---------------------------------+---------+------+ +| url | actions | exit | ++---------------------------------+---------+------+ + +* url: Editable URL of the currently displayed website +* actions: Optional action icons injected by other components (e.g. barcode scanner) +* exit: Button that switches back to display mode. diff --git a/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar.edit/-edit-toolbar/focus.md b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar.edit/-edit-toolbar/focus.md new file mode 100644 index 00000000000..a7a765ddef3 --- /dev/null +++ b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar.edit/-edit-toolbar/focus.md @@ -0,0 +1,12 @@ +--- +title: EditToolbar.focus - +--- + +[mozilla.components.browser.toolbar.edit](../index.html) / [EditToolbar](index.html) / [focus](./focus.html) + +# focus + +`fun focus(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Focus the URL editing component and show the virtual keyboard if needed. + diff --git a/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar.edit/-edit-toolbar/index.md b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar.edit/-edit-toolbar/index.md new file mode 100644 index 00000000000..f56f7c58fa9 --- /dev/null +++ b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar.edit/-edit-toolbar/index.md @@ -0,0 +1,32 @@ +--- +title: EditToolbar - +--- + +[mozilla.components.browser.toolbar.edit](../index.html) / [EditToolbar](./index.html) + +# EditToolbar + +`class EditToolbar : ViewGroup` + +Sub-component of the browser toolbar responsible for allowing the user to edit the URL. + +Structure: ++---------------------------------+---------+------+ +| url | actions | exit | ++---------------------------------+---------+------+ + +* url: Editable URL of the currently displayed website +* actions: Optional action icons injected by other components (e.g. barcode scanner) +* exit: Button that switches back to display mode. + +### Constructors + +| [<init>](-init-.html) | `EditToolbar(context: Context, toolbar: `[`BrowserToolbar`](../../mozilla.components.browser.toolbar/-browser-toolbar/index.html)`)`
Sub-component of the browser toolbar responsible for allowing the user to edit the URL. | + +### Functions + +| [focus](focus.html) | `fun focus(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Focus the URL editing component and show the virtual keyboard if needed. | +| [onLayout](on-layout.html) | `fun onLayout(changed: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`, left: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, top: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, right: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, bottom: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onMeasure](on-measure.html) | `fun onMeasure(widthMeasureSpec: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, heightMeasureSpec: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [updateUrl](update-url.html) | `fun updateUrl(url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Updates the URL. This should only be called if the toolbar is not in editing mode. Otherwise this might override the URL the user is currently typing. | + diff --git a/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar.edit/-edit-toolbar/on-layout.md b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar.edit/-edit-toolbar/on-layout.md new file mode 100644 index 00000000000..4be6b2c0bd1 --- /dev/null +++ b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar.edit/-edit-toolbar/on-layout.md @@ -0,0 +1,9 @@ +--- +title: EditToolbar.onLayout - +--- + +[mozilla.components.browser.toolbar.edit](../index.html) / [EditToolbar](index.html) / [onLayout](./on-layout.html) + +# onLayout + +`protected fun onLayout(changed: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`, left: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, top: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, right: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, bottom: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar.edit/-edit-toolbar/on-measure.md b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar.edit/-edit-toolbar/on-measure.md new file mode 100644 index 00000000000..2813f307080 --- /dev/null +++ b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar.edit/-edit-toolbar/on-measure.md @@ -0,0 +1,9 @@ +--- +title: EditToolbar.onMeasure - +--- + +[mozilla.components.browser.toolbar.edit](../index.html) / [EditToolbar](index.html) / [onMeasure](./on-measure.html) + +# onMeasure + +`protected fun onMeasure(widthMeasureSpec: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, heightMeasureSpec: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar.edit/-edit-toolbar/update-url.md b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar.edit/-edit-toolbar/update-url.md new file mode 100644 index 00000000000..d9fd1975661 --- /dev/null +++ b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar.edit/-edit-toolbar/update-url.md @@ -0,0 +1,13 @@ +--- +title: EditToolbar.updateUrl - +--- + +[mozilla.components.browser.toolbar.edit](../index.html) / [EditToolbar](index.html) / [updateUrl](./update-url.html) + +# updateUrl + +`fun updateUrl(url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Updates the URL. This should only be called if the toolbar is not in editing mode. Otherwise +this might override the URL the user is currently typing. + diff --git a/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar.edit/index.md b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar.edit/index.md new file mode 100644 index 00000000000..ae78bb73f5e --- /dev/null +++ b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar.edit/index.md @@ -0,0 +1,12 @@ +--- +title: mozilla.components.browser.toolbar.edit - +--- + +[mozilla.components.browser.toolbar.edit](./index.html) + +## Package mozilla.components.browser.toolbar.edit + +### Types + +| [EditToolbar](-edit-toolbar/index.html) | `class EditToolbar : ViewGroup`
Sub-component of the browser toolbar responsible for allowing the user to edit the URL. | + diff --git a/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/-button/-init-.md b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/-button/-init-.md new file mode 100644 index 00000000000..0eeebc19503 --- /dev/null +++ b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/-button/-init-.md @@ -0,0 +1,23 @@ +--- +title: BrowserToolbar.Button. - +--- + +[mozilla.components.browser.toolbar](../../index.html) / [BrowserToolbar](../index.html) / [Button](index.html) / [<init>](./-init-.html) + +# <init> + +`Button(imageResource: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, contentDescription: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, visible: () -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = { true }, @DrawableRes background: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`? = null, listener: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`)` + +An action button to be added to the toolbar. + +### Parameters + +`imageResource` - The drawable to be shown. + +`contentDescription` - The content description to use. + +`visible` - Lambda that returns true or false to indicate whether this button should be shown. + +`background` - A custom (stateful) background drawable resource to be used. + +`listener` - Callback that will be invoked whenever the button is pressed \ No newline at end of file diff --git a/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/-button/create-view.md b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/-button/create-view.md new file mode 100644 index 00000000000..7c4946fe472 --- /dev/null +++ b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/-button/create-view.md @@ -0,0 +1,9 @@ +--- +title: BrowserToolbar.Button.createView - +--- + +[mozilla.components.browser.toolbar](../../index.html) / [BrowserToolbar](../index.html) / [Button](index.html) / [createView](./create-view.html) + +# createView + +`open fun createView(parent: ViewGroup): View` \ No newline at end of file diff --git a/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/-button/index.md b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/-button/index.md new file mode 100644 index 00000000000..a7acc90990b --- /dev/null +++ b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/-button/index.md @@ -0,0 +1,32 @@ +--- +title: BrowserToolbar.Button - +--- + +[mozilla.components.browser.toolbar](../../index.html) / [BrowserToolbar](../index.html) / [Button](./index.html) + +# Button + +`class Button : ActionButton` + +An action button to be added to the toolbar. + +### Parameters + +`imageResource` - The drawable to be shown. + +`contentDescription` - The content description to use. + +`visible` - Lambda that returns true or false to indicate whether this button should be shown. + +`background` - A custom (stateful) background drawable resource to be used. + +`listener` - Callback that will be invoked whenever the button is pressed + +### Constructors + +| [<init>](-init-.html) | `Button(imageResource: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, contentDescription: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, visible: () -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = { true }, background: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`? = null, listener: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`)`
An action button to be added to the toolbar. | + +### Functions + +| [createView](create-view.html) | `open fun createView(parent: ViewGroup): View` | + diff --git a/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/-init-.md b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/-init-.md new file mode 100644 index 00000000000..a5b91a5e062 --- /dev/null +++ b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/-init-.md @@ -0,0 +1,29 @@ +--- +title: BrowserToolbar. - +--- + +[mozilla.components.browser.toolbar](../index.html) / [BrowserToolbar](index.html) / [<init>](./-init-.html) + +# <init> + +`BrowserToolbar(context: Context, attrs: AttributeSet? = null, defStyleAttr: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = 0)` + +A customizable toolbar for browsers. + +The toolbar can switch between two modes: display and edit. The display mode displays the current +URL and controls for navigation. In edit mode the current URL can be edited. Those two modes are +implemented by the DisplayToolbar and EditToolbar classes. + +``` + +----------------+ + | BrowserToolbar | + +--------+-------+ + + + +-------+-------+ + | | +``` + ++---------v------+ +-------v--------+ +| DisplayToolbar | | EditToolbar | ++----------------+ +----------------+ + diff --git a/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/-toggle-button/-init-.md b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/-toggle-button/-init-.md new file mode 100644 index 00000000000..c648df6290e --- /dev/null +++ b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/-toggle-button/-init-.md @@ -0,0 +1,30 @@ +--- +title: BrowserToolbar.ToggleButton. - +--- + +[mozilla.components.browser.toolbar](../../index.html) / [BrowserToolbar](../index.html) / [ToggleButton](index.html) / [<init>](./-init-.html) + +# <init> + +`ToggleButton(@DrawableRes imageResource: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, @DrawableRes imageResourceSelected: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, contentDescription: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, contentDescriptionSelected: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, visible: () -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = { true }, selected: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, @DrawableRes background: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`? = null, listener: (`[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`)` + +An action button with two states, selected and unselected. When the button is pressed, the +state changes automatically. + +### Parameters + +`imageResource` - The drawable to be shown if the button is in unselected state. + +`imageResourceSelected` - The drawable to be shown if the button is in selected state. + +`contentDescription` - The content description to use if the button is in unselected state. + +`contentDescriptionSelected` - The content description to use if the button is in selected state. + +`visible` - Lambda that returns true or false to indicate whether this button should be shown. + +`selected` - Sets whether this button should be selected initially. + +`background` - A custom (stateful) background drawable resource to be used. + +`listener` - Callback that will be invoked whenever the checked state changes. \ No newline at end of file diff --git a/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/-toggle-button/create-view.md b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/-toggle-button/create-view.md new file mode 100644 index 00000000000..5d877f2e6c6 --- /dev/null +++ b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/-toggle-button/create-view.md @@ -0,0 +1,9 @@ +--- +title: BrowserToolbar.ToggleButton.createView - +--- + +[mozilla.components.browser.toolbar](../../index.html) / [BrowserToolbar](../index.html) / [ToggleButton](index.html) / [createView](./create-view.html) + +# createView + +`open fun createView(parent: ViewGroup): View` \ No newline at end of file diff --git a/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/-toggle-button/index.md b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/-toggle-button/index.md new file mode 100644 index 00000000000..2bbd8f50df8 --- /dev/null +++ b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/-toggle-button/index.md @@ -0,0 +1,39 @@ +--- +title: BrowserToolbar.ToggleButton - +--- + +[mozilla.components.browser.toolbar](../../index.html) / [BrowserToolbar](../index.html) / [ToggleButton](./index.html) + +# ToggleButton + +`class ToggleButton : ActionToggleButton` + +An action button with two states, selected and unselected. When the button is pressed, the +state changes automatically. + +### Parameters + +`imageResource` - The drawable to be shown if the button is in unselected state. + +`imageResourceSelected` - The drawable to be shown if the button is in selected state. + +`contentDescription` - The content description to use if the button is in unselected state. + +`contentDescriptionSelected` - The content description to use if the button is in selected state. + +`visible` - Lambda that returns true or false to indicate whether this button should be shown. + +`selected` - Sets whether this button should be selected initially. + +`background` - A custom (stateful) background drawable resource to be used. + +`listener` - Callback that will be invoked whenever the checked state changes. + +### Constructors + +| [<init>](-init-.html) | `ToggleButton(imageResource: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, imageResourceSelected: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, contentDescription: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, contentDescriptionSelected: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, visible: () -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = { true }, selected: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, background: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`? = null, listener: (`[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`)`
An action button with two states, selected and unselected. When the button is pressed, the state changes automatically. | + +### Functions + +| [createView](create-view.html) | `open fun createView(parent: ViewGroup): View` | + diff --git a/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/add-browser-action.md b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/add-browser-action.md new file mode 100644 index 00000000000..b93027029eb --- /dev/null +++ b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/add-browser-action.md @@ -0,0 +1,19 @@ +--- +title: BrowserToolbar.addBrowserAction - +--- + +[mozilla.components.browser.toolbar](../index.html) / [BrowserToolbar](index.html) / [addBrowserAction](./add-browser-action.html) + +# addBrowserAction + +`fun addBrowserAction(action: Action): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Adds an action to be displayed on the right side of the toolbar (outside of the URL bounding +box) in display mode. + +If there is not enough room to show all icons then some icons may be moved to an overflow +menu. + +Related: +https://developer.mozilla.org/en-US/Add-ons/WebExtensions/user_interface/Browser_action + diff --git a/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/add-navigation-action.md b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/add-navigation-action.md new file mode 100644 index 00000000000..5de83a0019e --- /dev/null +++ b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/add-navigation-action.md @@ -0,0 +1,13 @@ +--- +title: BrowserToolbar.addNavigationAction - +--- + +[mozilla.components.browser.toolbar](../index.html) / [BrowserToolbar](index.html) / [addNavigationAction](./add-navigation-action.html) + +# addNavigationAction + +`fun addNavigationAction(action: Action): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Adds an action to be display on the far left side of the toolbar. This area is usually used +on larger devices for navigation actions like "back" and "forward". + diff --git a/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/add-page-action.md b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/add-page-action.md new file mode 100644 index 00000000000..21b68257c7f --- /dev/null +++ b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/add-page-action.md @@ -0,0 +1,15 @@ +--- +title: BrowserToolbar.addPageAction - +--- + +[mozilla.components.browser.toolbar](../index.html) / [BrowserToolbar](index.html) / [addPageAction](./add-page-action.html) + +# addPageAction + +`fun addPageAction(action: Action): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Adds an action to be displayed on the right side of the URL in display mode. + +Related: +https://developer.mozilla.org/en-US/Add-ons/WebExtensions/user_interface/Page_actions + diff --git a/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/browser-action-margin.md b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/browser-action-margin.md new file mode 100644 index 00000000000..4d284b81210 --- /dev/null +++ b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/browser-action-margin.md @@ -0,0 +1,12 @@ +--- +title: BrowserToolbar.browserActionMargin - +--- + +[mozilla.components.browser.toolbar](../index.html) / [BrowserToolbar](index.html) / [browserActionMargin](./browser-action-margin.html) + +# browserActionMargin + +`var browserActionMargin: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +Gets/Sets the margin to be used between browser actions. + diff --git a/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/display-mode.md b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/display-mode.md new file mode 100644 index 00000000000..a72a683106c --- /dev/null +++ b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/display-mode.md @@ -0,0 +1,12 @@ +--- +title: BrowserToolbar.displayMode - +--- + +[mozilla.components.browser.toolbar](../index.html) / [BrowserToolbar](index.html) / [displayMode](./display-mode.html) + +# displayMode + +`fun displayMode(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Switches to URL displaying mode. + diff --git a/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/display-progress.md b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/display-progress.md new file mode 100644 index 00000000000..561e4b13cb4 --- /dev/null +++ b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/display-progress.md @@ -0,0 +1,9 @@ +--- +title: BrowserToolbar.displayProgress - +--- + +[mozilla.components.browser.toolbar](../index.html) / [BrowserToolbar](index.html) / [displayProgress](./display-progress.html) + +# displayProgress + +`fun displayProgress(progress: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/display-site-security-icon.md b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/display-site-security-icon.md new file mode 100644 index 00000000000..de590c9f39d --- /dev/null +++ b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/display-site-security-icon.md @@ -0,0 +1,12 @@ +--- +title: BrowserToolbar.displaySiteSecurityIcon - +--- + +[mozilla.components.browser.toolbar](../index.html) / [BrowserToolbar](index.html) / [displaySiteSecurityIcon](./display-site-security-icon.html) + +# displaySiteSecurityIcon + +`var displaySiteSecurityIcon: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Set/Get whether a site security icon (usually a lock or globe icon) should be next to the URL. + diff --git a/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/edit-mode.md b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/edit-mode.md new file mode 100644 index 00000000000..d75294195e0 --- /dev/null +++ b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/edit-mode.md @@ -0,0 +1,12 @@ +--- +title: BrowserToolbar.editMode - +--- + +[mozilla.components.browser.toolbar](../index.html) / [BrowserToolbar](index.html) / [editMode](./edit-mode.html) + +# editMode + +`fun editMode(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Switches to URL editing mode. + diff --git a/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/hint.md b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/hint.md new file mode 100644 index 00000000000..f6a57fb2aed --- /dev/null +++ b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/hint.md @@ -0,0 +1,12 @@ +--- +title: BrowserToolbar.hint - +--- + +[mozilla.components.browser.toolbar](../index.html) / [BrowserToolbar](index.html) / [hint](./hint.html) + +# hint + +`var hint: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) + +Sets the text to be displayed when the URL of the toolbar is empty. + diff --git a/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/index.md b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/index.md new file mode 100644 index 00000000000..0e093296949 --- /dev/null +++ b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/index.md @@ -0,0 +1,67 @@ +--- +title: BrowserToolbar - +--- + +[mozilla.components.browser.toolbar](../index.html) / [BrowserToolbar](./index.html) + +# BrowserToolbar + +`class BrowserToolbar : ViewGroup, Toolbar` + +A customizable toolbar for browsers. + +The toolbar can switch between two modes: display and edit. The display mode displays the current +URL and controls for navigation. In edit mode the current URL can be edited. Those two modes are +implemented by the DisplayToolbar and EditToolbar classes. + +``` + +----------------+ + | BrowserToolbar | + +--------+-------+ + + + +-------+-------+ + | | +``` + ++---------v------+ +-------v--------+ +| DisplayToolbar | | EditToolbar | ++----------------+ +----------------+ + +### Types + +| [Button](-button/index.html) | `class Button : ActionButton`
An action button to be added to the toolbar. | +| [ToggleButton](-toggle-button/index.html) | `class ToggleButton : ActionToggleButton`
An action button with two states, selected and unselected. When the button is pressed, the state changes automatically. | + +### Constructors + +| [<init>](-init-.html) | `BrowserToolbar(context: Context, attrs: AttributeSet? = null, defStyleAttr: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = 0)`
A customizable toolbar for browsers. | + +### Properties + +| [browserActionMargin](browser-action-margin.html) | `var browserActionMargin: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Gets/Sets the margin to be used between browser actions. | +| [displaySiteSecurityIcon](display-site-security-icon.html) | `var displaySiteSecurityIcon: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Set/Get whether a site security icon (usually a lock or globe icon) should be next to the URL. | +| [hint](hint.html) | `var hint: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Sets the text to be displayed when the URL of the toolbar is empty. | +| [onUrlClicked](on-url-clicked.html) | `var onUrlClicked: () -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Sets a lambda that will be invoked whenever the URL in display mode was clicked. Only if this lambda returns true the toolbar will switch to editing mode. Return false to not switch to editing mode and handle the click manually. | +| [url](url.html) | `var url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [urlBoxMargin](url-box-margin.html) | `var urlBoxMargin: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Gets/Sets horizontal margin of the URL box (surrounding URL and page actions) in display mode. | +| [urlBoxView](url-box-view.html) | `var urlBoxView: View?`
Gets/Sets a custom view that will be drawn as behind the URL and page actions in display mode. | + +### Functions + +| [addBrowserAction](add-browser-action.html) | `fun addBrowserAction(action: Action): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Adds an action to be displayed on the right side of the toolbar (outside of the URL bounding box) in display mode. | +| [addNavigationAction](add-navigation-action.html) | `fun addNavigationAction(action: Action): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Adds an action to be display on the far left side of the toolbar. This area is usually used on larger devices for navigation actions like "back" and "forward". | +| [addPageAction](add-page-action.html) | `fun addPageAction(action: Action): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Adds an action to be displayed on the right side of the URL in display mode. | +| [displayMode](display-mode.html) | `fun displayMode(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Switches to URL displaying mode. | +| [displayProgress](display-progress.html) | `fun displayProgress(progress: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [editMode](edit-mode.html) | `fun editMode(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Switches to URL editing mode. | +| [invalidateActions](invalidate-actions.html) | `fun invalidateActions(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Declare that the actions (navigation actions, browser actions, page actions) have changed and should be updated if needed. | +| [onBackPressed](on-back-pressed.html) | `fun onBackPressed(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [onLayout](on-layout.html) | `fun onLayout(changed: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`, left: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, top: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, right: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, bottom: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onMeasure](on-measure.html) | `fun onMeasure(widthMeasureSpec: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, heightMeasureSpec: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [setAutocompleteFilter](set-autocomplete-filter.html) | `fun setAutocompleteFilter(filter: (`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, InlineAutocompleteEditText?) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Sets autocomplete filter to be used in edit mode. | +| [setMenuBuilder](set-menu-builder.html) | `fun setMenuBuilder(menuBuilder: BrowserMenuBuilder): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Sets a BrowserMenuBuilder that will be used to create a menu when the menu button is clicked. The menu button will only be visible if a builder has been set. | +| [setOnEditFocusChangeListener](set-on-edit-focus-change-listener.html) | `fun setOnEditFocusChangeListener(listener: (`[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Sets a listener to be invoked when focus of the URL input view (in edit mode) changed. | +| [setOnUrlCommitListener](set-on-url-commit-listener.html) | `fun setOnUrlCommitListener(listener: (`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [setSearchTerms](set-search-terms.html) | `fun setSearchTerms(searchTerms: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [setUrlTextPadding](set-url-text-padding.html) | `fun setUrlTextPadding(left: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = displayToolbar.urlView.paddingLeft, top: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = displayToolbar.urlView.paddingTop, right: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = displayToolbar.urlView.paddingRight, bottom: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = displayToolbar.urlView.paddingBottom): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Sets the padding to be applied to the URL text (in display mode). | + diff --git a/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/invalidate-actions.md b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/invalidate-actions.md new file mode 100644 index 00000000000..1ee2a4c7ebb --- /dev/null +++ b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/invalidate-actions.md @@ -0,0 +1,17 @@ +--- +title: BrowserToolbar.invalidateActions - +--- + +[mozilla.components.browser.toolbar](../index.html) / [BrowserToolbar](index.html) / [invalidateActions](./invalidate-actions.html) + +# invalidateActions + +`fun invalidateActions(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Declare that the actions (navigation actions, browser actions, page actions) have changed and +should be updated if needed. + +The toolbar will call the visible lambda of every action to determine whether a +view for this action should be added or removed. Additionally bind will be +called on every visible action to update its view. + diff --git a/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/on-back-pressed.md b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/on-back-pressed.md new file mode 100644 index 00000000000..222db2aec3b --- /dev/null +++ b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/on-back-pressed.md @@ -0,0 +1,9 @@ +--- +title: BrowserToolbar.onBackPressed - +--- + +[mozilla.components.browser.toolbar](../index.html) / [BrowserToolbar](index.html) / [onBackPressed](./on-back-pressed.html) + +# onBackPressed + +`fun onBackPressed(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/on-layout.md b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/on-layout.md new file mode 100644 index 00000000000..7997b7348e2 --- /dev/null +++ b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/on-layout.md @@ -0,0 +1,9 @@ +--- +title: BrowserToolbar.onLayout - +--- + +[mozilla.components.browser.toolbar](../index.html) / [BrowserToolbar](index.html) / [onLayout](./on-layout.html) + +# onLayout + +`protected fun onLayout(changed: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`, left: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, top: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, right: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, bottom: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/on-measure.md b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/on-measure.md new file mode 100644 index 00000000000..f7582e41253 --- /dev/null +++ b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/on-measure.md @@ -0,0 +1,9 @@ +--- +title: BrowserToolbar.onMeasure - +--- + +[mozilla.components.browser.toolbar](../index.html) / [BrowserToolbar](index.html) / [onMeasure](./on-measure.html) + +# onMeasure + +`protected fun onMeasure(widthMeasureSpec: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, heightMeasureSpec: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/on-url-clicked.md b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/on-url-clicked.md new file mode 100644 index 00000000000..272801bbd47 --- /dev/null +++ b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/on-url-clicked.md @@ -0,0 +1,14 @@ +--- +title: BrowserToolbar.onUrlClicked - +--- + +[mozilla.components.browser.toolbar](../index.html) / [BrowserToolbar](index.html) / [onUrlClicked](./on-url-clicked.html) + +# onUrlClicked + +`var onUrlClicked: () -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Sets a lambda that will be invoked whenever the URL in display mode was clicked. Only if this +lambda returns true the toolbar will switch to editing mode. Return +false to not switch to editing mode and handle the click manually. + diff --git a/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/set-autocomplete-filter.md b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/set-autocomplete-filter.md new file mode 100644 index 00000000000..d03d1bd2ebf --- /dev/null +++ b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/set-autocomplete-filter.md @@ -0,0 +1,12 @@ +--- +title: BrowserToolbar.setAutocompleteFilter - +--- + +[mozilla.components.browser.toolbar](../index.html) / [BrowserToolbar](index.html) / [setAutocompleteFilter](./set-autocomplete-filter.html) + +# setAutocompleteFilter + +`fun setAutocompleteFilter(filter: (`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, InlineAutocompleteEditText?) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Sets autocomplete filter to be used in edit mode. + diff --git a/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/set-menu-builder.md b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/set-menu-builder.md new file mode 100644 index 00000000000..977fac0ce99 --- /dev/null +++ b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/set-menu-builder.md @@ -0,0 +1,13 @@ +--- +title: BrowserToolbar.setMenuBuilder - +--- + +[mozilla.components.browser.toolbar](../index.html) / [BrowserToolbar](index.html) / [setMenuBuilder](./set-menu-builder.html) + +# setMenuBuilder + +`fun setMenuBuilder(menuBuilder: BrowserMenuBuilder): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Sets a BrowserMenuBuilder that will be used to create a menu when the menu button is clicked. +The menu button will only be visible if a builder has been set. + diff --git a/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/set-on-edit-focus-change-listener.md b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/set-on-edit-focus-change-listener.md new file mode 100644 index 00000000000..eb30ab67f55 --- /dev/null +++ b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/set-on-edit-focus-change-listener.md @@ -0,0 +1,12 @@ +--- +title: BrowserToolbar.setOnEditFocusChangeListener - +--- + +[mozilla.components.browser.toolbar](../index.html) / [BrowserToolbar](index.html) / [setOnEditFocusChangeListener](./set-on-edit-focus-change-listener.html) + +# setOnEditFocusChangeListener + +`fun setOnEditFocusChangeListener(listener: (`[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Sets a listener to be invoked when focus of the URL input view (in edit mode) changed. + diff --git a/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/set-on-url-commit-listener.md b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/set-on-url-commit-listener.md new file mode 100644 index 00000000000..debb20568a3 --- /dev/null +++ b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/set-on-url-commit-listener.md @@ -0,0 +1,9 @@ +--- +title: BrowserToolbar.setOnUrlCommitListener - +--- + +[mozilla.components.browser.toolbar](../index.html) / [BrowserToolbar](index.html) / [setOnUrlCommitListener](./set-on-url-commit-listener.html) + +# setOnUrlCommitListener + +`fun setOnUrlCommitListener(listener: (`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/set-search-terms.md b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/set-search-terms.md new file mode 100644 index 00000000000..5a1ae973350 --- /dev/null +++ b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/set-search-terms.md @@ -0,0 +1,9 @@ +--- +title: BrowserToolbar.setSearchTerms - +--- + +[mozilla.components.browser.toolbar](../index.html) / [BrowserToolbar](index.html) / [setSearchTerms](./set-search-terms.html) + +# setSearchTerms + +`fun setSearchTerms(searchTerms: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/set-url-text-padding.md b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/set-url-text-padding.md new file mode 100644 index 00000000000..9479c5d5713 --- /dev/null +++ b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/set-url-text-padding.md @@ -0,0 +1,12 @@ +--- +title: BrowserToolbar.setUrlTextPadding - +--- + +[mozilla.components.browser.toolbar](../index.html) / [BrowserToolbar](index.html) / [setUrlTextPadding](./set-url-text-padding.html) + +# setUrlTextPadding + +`fun setUrlTextPadding(left: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = displayToolbar.urlView.paddingLeft, top: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = displayToolbar.urlView.paddingTop, right: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = displayToolbar.urlView.paddingRight, bottom: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = displayToolbar.urlView.paddingBottom): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Sets the padding to be applied to the URL text (in display mode). + diff --git a/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/url-box-margin.md b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/url-box-margin.md new file mode 100644 index 00000000000..cb65ccac068 --- /dev/null +++ b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/url-box-margin.md @@ -0,0 +1,12 @@ +--- +title: BrowserToolbar.urlBoxMargin - +--- + +[mozilla.components.browser.toolbar](../index.html) / [BrowserToolbar](index.html) / [urlBoxMargin](./url-box-margin.html) + +# urlBoxMargin + +`var urlBoxMargin: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +Gets/Sets horizontal margin of the URL box (surrounding URL and page actions) in display mode. + diff --git a/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/url-box-view.md b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/url-box-view.md new file mode 100644 index 00000000000..742e6de3e4a --- /dev/null +++ b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/url-box-view.md @@ -0,0 +1,12 @@ +--- +title: BrowserToolbar.urlBoxView - +--- + +[mozilla.components.browser.toolbar](../index.html) / [BrowserToolbar](index.html) / [urlBoxView](./url-box-view.html) + +# urlBoxView + +`var urlBoxView: View?` + +Gets/Sets a custom view that will be drawn as behind the URL and page actions in display mode. + diff --git a/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/url.md b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/url.md new file mode 100644 index 00000000000..946ec2590dd --- /dev/null +++ b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/-browser-toolbar/url.md @@ -0,0 +1,9 @@ +--- +title: BrowserToolbar.url - +--- + +[mozilla.components.browser.toolbar](../index.html) / [BrowserToolbar](index.html) / [url](./url.html) + +# url + +`var url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) \ No newline at end of file diff --git a/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/index.md b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/index.md new file mode 100644 index 00000000000..c9f8c2613a5 --- /dev/null +++ b/docs/api/0.21/browser-toolbar/mozilla.components.browser.toolbar/index.md @@ -0,0 +1,12 @@ +--- +title: mozilla.components.browser.toolbar - +--- + +[mozilla.components.browser.toolbar](./index.html) + +## Package mozilla.components.browser.toolbar + +### Types + +| [BrowserToolbar](-browser-toolbar/index.html) | `class BrowserToolbar : ViewGroup, Toolbar`
A customizable toolbar for browsers. | + diff --git a/docs/api/0.21/browser-toolbar/package-list b/docs/api/0.21/browser-toolbar/package-list new file mode 100644 index 00000000000..e0c2c4c7d0c --- /dev/null +++ b/docs/api/0.21/browser-toolbar/package-list @@ -0,0 +1,5 @@ +$dokka.format:jekyll +$dokka.linkExtension:html + +mozilla.components.browser.toolbar +mozilla.components.browser.toolbar.edit diff --git a/docs/api/0.21/concept-engine/alltypes/index.md b/docs/api/0.21/concept-engine/alltypes/index.md new file mode 100644 index 00000000000..cac90580df7 --- /dev/null +++ b/docs/api/0.21/concept-engine/alltypes/index.md @@ -0,0 +1,15 @@ +--- +title: alltypes - +--- + +### All Types + +| [mozilla.components.concept.engine.DefaultSettings](../mozilla.components.concept.engine/-default-settings/index.html) | [Settings](../mozilla.components.concept.engine/-settings/index.html) implementation used to set defaults for [Engine](../mozilla.components.concept.engine/-engine/index.html) and [EngineSession](../mozilla.components.concept.engine/-engine-session/index.html). | +| [mozilla.components.concept.engine.Engine](../mozilla.components.concept.engine/-engine/index.html) | Entry point for interacting with the engine implementation. | +| [mozilla.components.concept.engine.EngineSession](../mozilla.components.concept.engine/-engine-session/index.html) | Class representing a single engine session. | +| [mozilla.components.concept.engine.EngineView](../mozilla.components.concept.engine/-engine-view/index.html) | View component that renders web content. | +| [mozilla.components.concept.engine.HitResult](../mozilla.components.concept.engine/-hit-result/index.html) | Represents all the different supported types of data that can be found from long clicking an element. | +| [mozilla.components.concept.engine.request.RequestInterceptor](../mozilla.components.concept.engine.request/-request-interceptor/index.html) | Interface for classes that want to intercept load requests to allow custom behavior. | +| [mozilla.components.concept.engine.Settings](../mozilla.components.concept.engine/-settings/index.html) | Holds settings of an engine or session. Concrete engine implementations define how these settings are applied i.e. whether a setting is applied on an engine or session instance. | +| [mozilla.components.concept.engine.UnsupportedSettingException](../mozilla.components.concept.engine/-unsupported-setting-exception/index.html) | Exception thrown by default if a setting is not supported by an engine or session. | + diff --git a/docs/api/0.21/concept-engine/index.md b/docs/api/0.21/concept-engine/index.md new file mode 100644 index 00000000000..6803398cbbb --- /dev/null +++ b/docs/api/0.21/concept-engine/index.md @@ -0,0 +1,12 @@ +--- +title: +--- + +### Packages + +| [mozilla.components.concept.engine](mozilla.components.concept.engine/index.html) | | +| [mozilla.components.concept.engine.request](mozilla.components.concept.engine.request/index.html) | | + +### Index + +[All Types](alltypes/index.html) \ No newline at end of file diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine.request/-request-interceptor/-interception-response/-init-.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine.request/-request-interceptor/-interception-response/-init-.md new file mode 100644 index 00000000000..8a6be106ef8 --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine.request/-request-interceptor/-interception-response/-init-.md @@ -0,0 +1,12 @@ +--- +title: RequestInterceptor.InterceptionResponse. - +--- + +[mozilla.components.concept.engine.request](../../index.html) / [RequestInterceptor](../index.html) / [InterceptionResponse](index.html) / [<init>](./-init-.html) + +# <init> + +`InterceptionResponse(data: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, mimeType: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = "text/html", encoding: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = "UTF-8")` + +An alternative response for an intercepted request. + diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine.request/-request-interceptor/-interception-response/data.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine.request/-request-interceptor/-interception-response/data.md new file mode 100644 index 00000000000..2b41676bd5f --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine.request/-request-interceptor/-interception-response/data.md @@ -0,0 +1,9 @@ +--- +title: RequestInterceptor.InterceptionResponse.data - +--- + +[mozilla.components.concept.engine.request](../../index.html) / [RequestInterceptor](../index.html) / [InterceptionResponse](index.html) / [data](./data.html) + +# data + +`val data: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) \ No newline at end of file diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine.request/-request-interceptor/-interception-response/encoding.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine.request/-request-interceptor/-interception-response/encoding.md new file mode 100644 index 00000000000..d87e6b1b475 --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine.request/-request-interceptor/-interception-response/encoding.md @@ -0,0 +1,9 @@ +--- +title: RequestInterceptor.InterceptionResponse.encoding - +--- + +[mozilla.components.concept.engine.request](../../index.html) / [RequestInterceptor](../index.html) / [InterceptionResponse](index.html) / [encoding](./encoding.html) + +# encoding + +`val encoding: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) \ No newline at end of file diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine.request/-request-interceptor/-interception-response/index.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine.request/-request-interceptor/-interception-response/index.md new file mode 100644 index 00000000000..4a618b8cc2b --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine.request/-request-interceptor/-interception-response/index.md @@ -0,0 +1,22 @@ +--- +title: RequestInterceptor.InterceptionResponse - +--- + +[mozilla.components.concept.engine.request](../../index.html) / [RequestInterceptor](../index.html) / [InterceptionResponse](./index.html) + +# InterceptionResponse + +`data class InterceptionResponse` + +An alternative response for an intercepted request. + +### Constructors + +| [<init>](-init-.html) | `InterceptionResponse(data: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, mimeType: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = "text/html", encoding: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = "UTF-8")`
An alternative response for an intercepted request. | + +### Properties + +| [data](data.html) | `val data: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [encoding](encoding.html) | `val encoding: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [mimeType](mime-type.html) | `val mimeType: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine.request/-request-interceptor/-interception-response/mime-type.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine.request/-request-interceptor/-interception-response/mime-type.md new file mode 100644 index 00000000000..f58d72ed721 --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine.request/-request-interceptor/-interception-response/mime-type.md @@ -0,0 +1,9 @@ +--- +title: RequestInterceptor.InterceptionResponse.mimeType - +--- + +[mozilla.components.concept.engine.request](../../index.html) / [RequestInterceptor](../index.html) / [InterceptionResponse](index.html) / [mimeType](./mime-type.html) + +# mimeType + +`val mimeType: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) \ No newline at end of file diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine.request/-request-interceptor/index.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine.request/-request-interceptor/index.md new file mode 100644 index 00000000000..cdee8f6a759 --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine.request/-request-interceptor/index.md @@ -0,0 +1,20 @@ +--- +title: RequestInterceptor - +--- + +[mozilla.components.concept.engine.request](../index.html) / [RequestInterceptor](./index.html) + +# RequestInterceptor + +`interface RequestInterceptor` + +Interface for classes that want to intercept load requests to allow custom behavior. + +### Types + +| [InterceptionResponse](-interception-response/index.html) | `data class InterceptionResponse`
An alternative response for an intercepted request. | + +### Functions + +| [onLoadRequest](on-load-request.html) | `abstract fun onLoadRequest(session: `[`EngineSession`](../../mozilla.components.concept.engine/-engine-session/index.html)`, uri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`InterceptionResponse`](-interception-response/index.html)`?`
A request to open an URI. This is called before each page load to allow custom behavior implementation. | + diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine.request/-request-interceptor/on-load-request.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine.request/-request-interceptor/on-load-request.md new file mode 100644 index 00000000000..f396e29df44 --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine.request/-request-interceptor/on-load-request.md @@ -0,0 +1,20 @@ +--- +title: RequestInterceptor.onLoadRequest - +--- + +[mozilla.components.concept.engine.request](../index.html) / [RequestInterceptor](index.html) / [onLoadRequest](./on-load-request.html) + +# onLoadRequest + +`abstract fun onLoadRequest(session: `[`EngineSession`](../../mozilla.components.concept.engine/-engine-session/index.html)`, uri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`InterceptionResponse`](-interception-response/index.html)`?` + +A request to open an URI. This is called before each page load to allow custom behavior implementation. + +### Parameters + +`session` - The engine session that initiated the callback. + +**Return** +An InterceptionResponse object containing alternative content if the request should be intercepted. + null otherwise. + diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine.request/index.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine.request/index.md new file mode 100644 index 00000000000..a7d0bb363f2 --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine.request/index.md @@ -0,0 +1,12 @@ +--- +title: mozilla.components.concept.engine.request - +--- + +[mozilla.components.concept.engine.request](./index.html) + +## Package mozilla.components.concept.engine.request + +### Types + +| [RequestInterceptor](-request-interceptor/index.html) | `interface RequestInterceptor`
Interface for classes that want to intercept load requests to allow custom behavior. | + diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-default-settings/-init-.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-default-settings/-init-.md new file mode 100644 index 00000000000..4400ad4f2c6 --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-default-settings/-init-.md @@ -0,0 +1,12 @@ +--- +title: DefaultSettings. - +--- + +[mozilla.components.concept.engine](../index.html) / [DefaultSettings](index.html) / [<init>](./-init-.html) + +# <init> + +`DefaultSettings(javascriptEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = true, domStorageEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = true, trackingProtectionPolicy: `[`TrackingProtectionPolicy`](../-engine-session/-tracking-protection-policy/index.html)`? = null, requestInterceptor: `[`RequestInterceptor`](../../mozilla.components.concept.engine.request/-request-interceptor/index.html)`? = null)` + +[Settings](../-settings/index.html) implementation used to set defaults for [Engine](../-engine/index.html) and [EngineSession](../-engine-session/index.html). + diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-default-settings/dom-storage-enabled.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-default-settings/dom-storage-enabled.md new file mode 100644 index 00000000000..c59ac0d3075 --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-default-settings/dom-storage-enabled.md @@ -0,0 +1,14 @@ +--- +title: DefaultSettings.domStorageEnabled - +--- + +[mozilla.components.concept.engine](../index.html) / [DefaultSettings](index.html) / [domStorageEnabled](./dom-storage-enabled.html) + +# domStorageEnabled + +`var domStorageEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Overrides [Settings.domStorageEnabled](../-settings/dom-storage-enabled.html) + +Setting to control whether or not DOM Storage is enabled. + diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-default-settings/index.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-default-settings/index.md new file mode 100644 index 00000000000..e4828b87bdd --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-default-settings/index.md @@ -0,0 +1,23 @@ +--- +title: DefaultSettings - +--- + +[mozilla.components.concept.engine](../index.html) / [DefaultSettings](./index.html) + +# DefaultSettings + +`data class DefaultSettings : `[`Settings`](../-settings/index.html) + +[Settings](../-settings/index.html) implementation used to set defaults for [Engine](../-engine/index.html) and [EngineSession](../-engine-session/index.html). + +### Constructors + +| [<init>](-init-.html) | `DefaultSettings(javascriptEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = true, domStorageEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = true, trackingProtectionPolicy: `[`TrackingProtectionPolicy`](../-engine-session/-tracking-protection-policy/index.html)`? = null, requestInterceptor: `[`RequestInterceptor`](../../mozilla.components.concept.engine.request/-request-interceptor/index.html)`? = null)`
[Settings](../-settings/index.html) implementation used to set defaults for [Engine](../-engine/index.html) and [EngineSession](../-engine-session/index.html). | + +### Properties + +| [domStorageEnabled](dom-storage-enabled.html) | `var domStorageEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Setting to control whether or not DOM Storage is enabled. | +| [javascriptEnabled](javascript-enabled.html) | `var javascriptEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Setting to control whether or not JavaScript is enabled. | +| [requestInterceptor](request-interceptor.html) | `var requestInterceptor: `[`RequestInterceptor`](../../mozilla.components.concept.engine.request/-request-interceptor/index.html)`?`
Setting to intercept and override requests. | +| [trackingProtectionPolicy](tracking-protection-policy.html) | `var trackingProtectionPolicy: `[`TrackingProtectionPolicy`](../-engine-session/-tracking-protection-policy/index.html)`?`
Setting to control tracking protection. | + diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-default-settings/javascript-enabled.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-default-settings/javascript-enabled.md new file mode 100644 index 00000000000..5ed03de5542 --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-default-settings/javascript-enabled.md @@ -0,0 +1,14 @@ +--- +title: DefaultSettings.javascriptEnabled - +--- + +[mozilla.components.concept.engine](../index.html) / [DefaultSettings](index.html) / [javascriptEnabled](./javascript-enabled.html) + +# javascriptEnabled + +`var javascriptEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Overrides [Settings.javascriptEnabled](../-settings/javascript-enabled.html) + +Setting to control whether or not JavaScript is enabled. + diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-default-settings/request-interceptor.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-default-settings/request-interceptor.md new file mode 100644 index 00000000000..3e39ecc0eba --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-default-settings/request-interceptor.md @@ -0,0 +1,14 @@ +--- +title: DefaultSettings.requestInterceptor - +--- + +[mozilla.components.concept.engine](../index.html) / [DefaultSettings](index.html) / [requestInterceptor](./request-interceptor.html) + +# requestInterceptor + +`var requestInterceptor: `[`RequestInterceptor`](../../mozilla.components.concept.engine.request/-request-interceptor/index.html)`?` + +Overrides [Settings.requestInterceptor](../-settings/request-interceptor.html) + +Setting to intercept and override requests. + diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-default-settings/tracking-protection-policy.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-default-settings/tracking-protection-policy.md new file mode 100644 index 00000000000..06762d9b13a --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-default-settings/tracking-protection-policy.md @@ -0,0 +1,14 @@ +--- +title: DefaultSettings.trackingProtectionPolicy - +--- + +[mozilla.components.concept.engine](../index.html) / [DefaultSettings](index.html) / [trackingProtectionPolicy](./tracking-protection-policy.html) + +# trackingProtectionPolicy + +`var trackingProtectionPolicy: `[`TrackingProtectionPolicy`](../-engine-session/-tracking-protection-policy/index.html)`?` + +Overrides [Settings.trackingProtectionPolicy](../-settings/tracking-protection-policy.html) + +Setting to control tracking protection. + diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-init-.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-init-.md new file mode 100644 index 00000000000..cb85af6d264 --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-init-.md @@ -0,0 +1,14 @@ +--- +title: EngineSession. - +--- + +[mozilla.components.concept.engine](../index.html) / [EngineSession](index.html) / [<init>](./-init-.html) + +# <init> + +`EngineSession(delegate: Observable<`[`Observer`](-observer/index.html)`> = ObserverRegistry())` + +Class representing a single engine session. + +In browsers usually a session corresponds to a tab. + diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-observer/index.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-observer/index.md new file mode 100644 index 00000000000..8d4c1cfb4b8 --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-observer/index.md @@ -0,0 +1,28 @@ +--- +title: EngineSession.Observer - +--- + +[mozilla.components.concept.engine](../../index.html) / [EngineSession](../index.html) / [Observer](./index.html) + +# Observer + +`interface Observer` + +Interface to be implemented by classes that want to observe this engine session. + +### Functions + +| [onDesktopModeEnabled](on-desktop-mode-enabled.html) | `open fun onDesktopModeEnabled(enabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onExternalResource](on-external-resource.html) | `open fun onExternalResource(url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, fileName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, contentLength: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`? = null, contentType: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, cookie: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, userAgent: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onFind](on-find.html) | `open fun onFind(text: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onFindResult](on-find-result.html) | `open fun onFindResult(activeMatchOrdinal: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, numberOfMatches: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, isDoneCounting: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onLoadingStateChange](on-loading-state-change.html) | `open fun onLoadingStateChange(loading: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onLocationChange](on-location-change.html) | `open fun onLocationChange(url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onLongPress](on-long-press.html) | `open fun onLongPress(hitResult: `[`HitResult`](../../-hit-result/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onNavigationStateChange](on-navigation-state-change.html) | `open fun onNavigationStateChange(canGoBack: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`? = null, canGoForward: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`? = null): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onProgress](on-progress.html) | `open fun onProgress(progress: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onSecurityChange](on-security-change.html) | `open fun onSecurityChange(secure: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`, host: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, issuer: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onTitleChange](on-title-change.html) | `open fun onTitleChange(title: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onTrackerBlocked](on-tracker-blocked.html) | `open fun onTrackerBlocked(url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onTrackerBlockingEnabledChange](on-tracker-blocking-enabled-change.html) | `open fun onTrackerBlockingEnabledChange(enabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | + diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-observer/on-desktop-mode-enabled.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-observer/on-desktop-mode-enabled.md new file mode 100644 index 00000000000..f85b1fc0af1 --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-observer/on-desktop-mode-enabled.md @@ -0,0 +1,9 @@ +--- +title: EngineSession.Observer.onDesktopModeEnabled - +--- + +[mozilla.components.concept.engine](../../index.html) / [EngineSession](../index.html) / [Observer](index.html) / [onDesktopModeEnabled](./on-desktop-mode-enabled.html) + +# onDesktopModeEnabled + +`open fun onDesktopModeEnabled(enabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-observer/on-external-resource.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-observer/on-external-resource.md new file mode 100644 index 00000000000..be3270383aa --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-observer/on-external-resource.md @@ -0,0 +1,9 @@ +--- +title: EngineSession.Observer.onExternalResource - +--- + +[mozilla.components.concept.engine](../../index.html) / [EngineSession](../index.html) / [Observer](index.html) / [onExternalResource](./on-external-resource.html) + +# onExternalResource + +`open fun onExternalResource(url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, fileName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, contentLength: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`? = null, contentType: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, cookie: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, userAgent: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-observer/on-find-result.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-observer/on-find-result.md new file mode 100644 index 00000000000..7e2395d637f --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-observer/on-find-result.md @@ -0,0 +1,9 @@ +--- +title: EngineSession.Observer.onFindResult - +--- + +[mozilla.components.concept.engine](../../index.html) / [EngineSession](../index.html) / [Observer](index.html) / [onFindResult](./on-find-result.html) + +# onFindResult + +`open fun onFindResult(activeMatchOrdinal: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, numberOfMatches: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, isDoneCounting: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-observer/on-find.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-observer/on-find.md new file mode 100644 index 00000000000..8d3d431a1e0 --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-observer/on-find.md @@ -0,0 +1,9 @@ +--- +title: EngineSession.Observer.onFind - +--- + +[mozilla.components.concept.engine](../../index.html) / [EngineSession](../index.html) / [Observer](index.html) / [onFind](./on-find.html) + +# onFind + +`open fun onFind(text: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-observer/on-loading-state-change.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-observer/on-loading-state-change.md new file mode 100644 index 00000000000..34e4babd208 --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-observer/on-loading-state-change.md @@ -0,0 +1,9 @@ +--- +title: EngineSession.Observer.onLoadingStateChange - +--- + +[mozilla.components.concept.engine](../../index.html) / [EngineSession](../index.html) / [Observer](index.html) / [onLoadingStateChange](./on-loading-state-change.html) + +# onLoadingStateChange + +`open fun onLoadingStateChange(loading: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-observer/on-location-change.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-observer/on-location-change.md new file mode 100644 index 00000000000..6465b49c19d --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-observer/on-location-change.md @@ -0,0 +1,9 @@ +--- +title: EngineSession.Observer.onLocationChange - +--- + +[mozilla.components.concept.engine](../../index.html) / [EngineSession](../index.html) / [Observer](index.html) / [onLocationChange](./on-location-change.html) + +# onLocationChange + +`open fun onLocationChange(url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-observer/on-long-press.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-observer/on-long-press.md new file mode 100644 index 00000000000..089c42360c5 --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-observer/on-long-press.md @@ -0,0 +1,9 @@ +--- +title: EngineSession.Observer.onLongPress - +--- + +[mozilla.components.concept.engine](../../index.html) / [EngineSession](../index.html) / [Observer](index.html) / [onLongPress](./on-long-press.html) + +# onLongPress + +`open fun onLongPress(hitResult: `[`HitResult`](../../-hit-result/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-observer/on-navigation-state-change.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-observer/on-navigation-state-change.md new file mode 100644 index 00000000000..c6c0d41f15e --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-observer/on-navigation-state-change.md @@ -0,0 +1,9 @@ +--- +title: EngineSession.Observer.onNavigationStateChange - +--- + +[mozilla.components.concept.engine](../../index.html) / [EngineSession](../index.html) / [Observer](index.html) / [onNavigationStateChange](./on-navigation-state-change.html) + +# onNavigationStateChange + +`open fun onNavigationStateChange(canGoBack: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`? = null, canGoForward: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`? = null): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-observer/on-progress.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-observer/on-progress.md new file mode 100644 index 00000000000..58c1eee32ba --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-observer/on-progress.md @@ -0,0 +1,9 @@ +--- +title: EngineSession.Observer.onProgress - +--- + +[mozilla.components.concept.engine](../../index.html) / [EngineSession](../index.html) / [Observer](index.html) / [onProgress](./on-progress.html) + +# onProgress + +`open fun onProgress(progress: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-observer/on-security-change.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-observer/on-security-change.md new file mode 100644 index 00000000000..d80ea620e1f --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-observer/on-security-change.md @@ -0,0 +1,9 @@ +--- +title: EngineSession.Observer.onSecurityChange - +--- + +[mozilla.components.concept.engine](../../index.html) / [EngineSession](../index.html) / [Observer](index.html) / [onSecurityChange](./on-security-change.html) + +# onSecurityChange + +`open fun onSecurityChange(secure: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`, host: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, issuer: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-observer/on-title-change.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-observer/on-title-change.md new file mode 100644 index 00000000000..53db747e97a --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-observer/on-title-change.md @@ -0,0 +1,9 @@ +--- +title: EngineSession.Observer.onTitleChange - +--- + +[mozilla.components.concept.engine](../../index.html) / [EngineSession](../index.html) / [Observer](index.html) / [onTitleChange](./on-title-change.html) + +# onTitleChange + +`open fun onTitleChange(title: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-observer/on-tracker-blocked.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-observer/on-tracker-blocked.md new file mode 100644 index 00000000000..36df501df5b --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-observer/on-tracker-blocked.md @@ -0,0 +1,9 @@ +--- +title: EngineSession.Observer.onTrackerBlocked - +--- + +[mozilla.components.concept.engine](../../index.html) / [EngineSession](../index.html) / [Observer](index.html) / [onTrackerBlocked](./on-tracker-blocked.html) + +# onTrackerBlocked + +`open fun onTrackerBlocked(url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-observer/on-tracker-blocking-enabled-change.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-observer/on-tracker-blocking-enabled-change.md new file mode 100644 index 00000000000..1dab2126688 --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-observer/on-tracker-blocking-enabled-change.md @@ -0,0 +1,9 @@ +--- +title: EngineSession.Observer.onTrackerBlockingEnabledChange - +--- + +[mozilla.components.concept.engine](../../index.html) / [EngineSession](../index.html) / [Observer](index.html) / [onTrackerBlockingEnabledChange](./on-tracker-blocking-enabled-change.html) + +# onTrackerBlockingEnabledChange + +`open fun onTrackerBlockingEnabledChange(enabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/-a-d.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/-a-d.md new file mode 100644 index 00000000000..649854c588b --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/-a-d.md @@ -0,0 +1,9 @@ +--- +title: EngineSession.TrackingProtectionPolicy.AD - +--- + +[mozilla.components.concept.engine](../../index.html) / [EngineSession](../index.html) / [TrackingProtectionPolicy](index.html) / [AD](./-a-d.html) + +# AD + +`const val AD: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) \ No newline at end of file diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/-a-n-a-l-y-t-i-c-s.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/-a-n-a-l-y-t-i-c-s.md new file mode 100644 index 00000000000..cd233654919 --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/-a-n-a-l-y-t-i-c-s.md @@ -0,0 +1,9 @@ +--- +title: EngineSession.TrackingProtectionPolicy.ANALYTICS - +--- + +[mozilla.components.concept.engine](../../index.html) / [EngineSession](../index.html) / [TrackingProtectionPolicy](index.html) / [ANALYTICS](./-a-n-a-l-y-t-i-c-s.html) + +# ANALYTICS + +`const val ANALYTICS: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) \ No newline at end of file diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/-c-o-n-t-e-n-t.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/-c-o-n-t-e-n-t.md new file mode 100644 index 00000000000..f9f5980ab2b --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/-c-o-n-t-e-n-t.md @@ -0,0 +1,9 @@ +--- +title: EngineSession.TrackingProtectionPolicy.CONTENT - +--- + +[mozilla.components.concept.engine](../../index.html) / [EngineSession](../index.html) / [TrackingProtectionPolicy](index.html) / [CONTENT](./-c-o-n-t-e-n-t.html) + +# CONTENT + +`const val CONTENT: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) \ No newline at end of file diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/-init-.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/-init-.md new file mode 100644 index 00000000000..67715d11b87 --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/-init-.md @@ -0,0 +1,13 @@ +--- +title: EngineSession.TrackingProtectionPolicy. - +--- + +[mozilla.components.concept.engine](../../index.html) / [EngineSession](../index.html) / [TrackingProtectionPolicy](index.html) / [<init>](./-init-.html) + +# <init> + +`TrackingProtectionPolicy(categories: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` + +Represents a tracking protection policy which is a combination of +tracker categories that should be blocked. + diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/-s-o-c-i-a-l.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/-s-o-c-i-a-l.md new file mode 100644 index 00000000000..0a3ac99a264 --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/-s-o-c-i-a-l.md @@ -0,0 +1,9 @@ +--- +title: EngineSession.TrackingProtectionPolicy.SOCIAL - +--- + +[mozilla.components.concept.engine](../../index.html) / [EngineSession](../index.html) / [TrackingProtectionPolicy](index.html) / [SOCIAL](./-s-o-c-i-a-l.html) + +# SOCIAL + +`const val SOCIAL: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) \ No newline at end of file diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/all.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/all.md new file mode 100644 index 00000000000..d96944d5095 --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/all.md @@ -0,0 +1,9 @@ +--- +title: EngineSession.TrackingProtectionPolicy.all - +--- + +[mozilla.components.concept.engine](../../index.html) / [EngineSession](../index.html) / [TrackingProtectionPolicy](index.html) / [all](./all.html) + +# all + +`fun all(): `[`TrackingProtectionPolicy`](index.html) \ No newline at end of file diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/categories.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/categories.md new file mode 100644 index 00000000000..6efe3b69560 --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/categories.md @@ -0,0 +1,9 @@ +--- +title: EngineSession.TrackingProtectionPolicy.categories - +--- + +[mozilla.components.concept.engine](../../index.html) / [EngineSession](../index.html) / [TrackingProtectionPolicy](index.html) / [categories](./categories.html) + +# categories + +`val categories: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) \ No newline at end of file diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/equals.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/equals.md new file mode 100644 index 00000000000..13ae0f35dfc --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/equals.md @@ -0,0 +1,9 @@ +--- +title: EngineSession.TrackingProtectionPolicy.equals - +--- + +[mozilla.components.concept.engine](../../index.html) / [EngineSession](../index.html) / [TrackingProtectionPolicy](index.html) / [equals](./equals.html) + +# equals + +`fun equals(other: `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`?): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) \ No newline at end of file diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/hash-code.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/hash-code.md new file mode 100644 index 00000000000..a73c013472e --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/hash-code.md @@ -0,0 +1,9 @@ +--- +title: EngineSession.TrackingProtectionPolicy.hashCode - +--- + +[mozilla.components.concept.engine](../../index.html) / [EngineSession](../index.html) / [TrackingProtectionPolicy](index.html) / [hashCode](./hash-code.html) + +# hashCode + +`fun hashCode(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) \ No newline at end of file diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/index.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/index.md new file mode 100644 index 00000000000..f65cf576033 --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/index.md @@ -0,0 +1,39 @@ +--- +title: EngineSession.TrackingProtectionPolicy - +--- + +[mozilla.components.concept.engine](../../index.html) / [EngineSession](../index.html) / [TrackingProtectionPolicy](./index.html) + +# TrackingProtectionPolicy + +`class TrackingProtectionPolicy` + +Represents a tracking protection policy which is a combination of +tracker categories that should be blocked. + +### Constructors + +| [<init>](-init-.html) | `TrackingProtectionPolicy(categories: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)`
Represents a tracking protection policy which is a combination of tracker categories that should be blocked. | + +### Properties + +| [categories](categories.html) | `val categories: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | + +### Functions + +| [equals](equals.html) | `fun equals(other: `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`?): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [hashCode](hash-code.html) | `fun hashCode(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | + +### Companion Object Properties + +| [AD](-a-d.html) | `const val AD: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [ANALYTICS](-a-n-a-l-y-t-i-c-s.html) | `const val ANALYTICS: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [CONTENT](-c-o-n-t-e-n-t.html) | `const val CONTENT: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [SOCIAL](-s-o-c-i-a-l.html) | `const val SOCIAL: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | + +### Companion Object Functions + +| [all](all.html) | `fun all(): `[`TrackingProtectionPolicy`](./index.md) | +| [none](none.html) | `fun none(): `[`TrackingProtectionPolicy`](./index.md) | +| [select](select.html) | `fun select(vararg categories: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`TrackingProtectionPolicy`](./index.md) | + diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/none.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/none.md new file mode 100644 index 00000000000..c3645201aed --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/none.md @@ -0,0 +1,9 @@ +--- +title: EngineSession.TrackingProtectionPolicy.none - +--- + +[mozilla.components.concept.engine](../../index.html) / [EngineSession](../index.html) / [TrackingProtectionPolicy](index.html) / [none](./none.html) + +# none + +`fun none(): `[`TrackingProtectionPolicy`](index.html) \ No newline at end of file diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/select.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/select.md new file mode 100644 index 00000000000..b57fed8282d --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/select.md @@ -0,0 +1,9 @@ +--- +title: EngineSession.TrackingProtectionPolicy.select - +--- + +[mozilla.components.concept.engine](../../index.html) / [EngineSession](../index.html) / [TrackingProtectionPolicy](index.html) / [select](./select.html) + +# select + +`fun select(vararg categories: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`TrackingProtectionPolicy`](index.html) \ No newline at end of file diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/clear-find-matches.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/clear-find-matches.md new file mode 100644 index 00000000000..d77668d8d73 --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/clear-find-matches.md @@ -0,0 +1,12 @@ +--- +title: EngineSession.clearFindMatches - +--- + +[mozilla.components.concept.engine](../index.html) / [EngineSession](index.html) / [clearFindMatches](./clear-find-matches.html) + +# clearFindMatches + +`abstract fun clearFindMatches(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Clears the highlighted results of previous calls to [findAll](find-all.html) / [findNext](find-next.html). + diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/close.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/close.md new file mode 100644 index 00000000000..d6becb3738e --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/close.md @@ -0,0 +1,13 @@ +--- +title: EngineSession.close - +--- + +[mozilla.components.concept.engine](../index.html) / [EngineSession](index.html) / [close](./close.html) + +# close + +`@CallSuper fun close(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Close the session. This may free underlying objects. Call this when you are finished using +this session. + diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/disable-tracking-protection.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/disable-tracking-protection.md new file mode 100644 index 00000000000..b81c11fbe7b --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/disable-tracking-protection.md @@ -0,0 +1,12 @@ +--- +title: EngineSession.disableTrackingProtection - +--- + +[mozilla.components.concept.engine](../index.html) / [EngineSession](index.html) / [disableTrackingProtection](./disable-tracking-protection.html) + +# disableTrackingProtection + +`abstract fun disableTrackingProtection(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Disables tracking protection for this engine session. + diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/enable-tracking-protection.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/enable-tracking-protection.md new file mode 100644 index 00000000000..60ea1e1cf15 --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/enable-tracking-protection.md @@ -0,0 +1,15 @@ +--- +title: EngineSession.enableTrackingProtection - +--- + +[mozilla.components.concept.engine](../index.html) / [EngineSession](index.html) / [enableTrackingProtection](./enable-tracking-protection.html) + +# enableTrackingProtection + +`abstract fun enableTrackingProtection(policy: `[`TrackingProtectionPolicy`](-tracking-protection-policy/index.html)` = TrackingProtectionPolicy.all()): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Enables tracking protection for this engine session. + +### Parameters + +`policy` - the tracking protection policy to use, defaults to blocking all trackers. \ No newline at end of file diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/find-all.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/find-all.md new file mode 100644 index 00000000000..03eabafc1b9 --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/find-all.md @@ -0,0 +1,15 @@ +--- +title: EngineSession.findAll - +--- + +[mozilla.components.concept.engine](../index.html) / [EngineSession](index.html) / [findAll](./find-all.html) + +# findAll + +`abstract fun findAll(text: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Finds and highlights all occurrences of the provided String and highlights them asynchronously. + +### Parameters + +`text` - the String to search for \ No newline at end of file diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/find-next.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/find-next.md new file mode 100644 index 00000000000..702bf3d5b3a --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/find-next.md @@ -0,0 +1,16 @@ +--- +title: EngineSession.findNext - +--- + +[mozilla.components.concept.engine](../index.html) / [EngineSession](index.html) / [findNext](./find-next.html) + +# findNext + +`abstract fun findNext(forward: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Finds and highlights the next or previous match found by [findAll](find-all.html). + +### Parameters + +`forward` - true if the next match should be highlighted, false for +the previous match. \ No newline at end of file diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/go-back.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/go-back.md new file mode 100644 index 00000000000..acb9671a9ca --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/go-back.md @@ -0,0 +1,12 @@ +--- +title: EngineSession.goBack - +--- + +[mozilla.components.concept.engine](../index.html) / [EngineSession](index.html) / [goBack](./go-back.html) + +# goBack + +`abstract fun goBack(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Navigates back in the history of this session. + diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/go-forward.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/go-forward.md new file mode 100644 index 00000000000..ce06aa26458 --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/go-forward.md @@ -0,0 +1,12 @@ +--- +title: EngineSession.goForward - +--- + +[mozilla.components.concept.engine](../index.html) / [EngineSession](index.html) / [goForward](./go-forward.html) + +# goForward + +`abstract fun goForward(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Navigates forward in the history of this session. + diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/index.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/index.md new file mode 100644 index 00000000000..6f67570aeee --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/index.md @@ -0,0 +1,45 @@ +--- +title: EngineSession - +--- + +[mozilla.components.concept.engine](../index.html) / [EngineSession](./index.html) + +# EngineSession + +`abstract class EngineSession : Observable<`[`Observer`](-observer/index.html)`>` + +Class representing a single engine session. + +In browsers usually a session corresponds to a tab. + +### Types + +| [Observer](-observer/index.html) | `interface Observer`
Interface to be implemented by classes that want to observe this engine session. | +| [TrackingProtectionPolicy](-tracking-protection-policy/index.html) | `class TrackingProtectionPolicy`
Represents a tracking protection policy which is a combination of tracker categories that should be blocked. | + +### Constructors + +| [<init>](-init-.html) | `EngineSession(delegate: Observable<`[`Observer`](-observer/index.html)`> = ObserverRegistry())`
Class representing a single engine session. | + +### Properties + +| [settings](settings.html) | `abstract val settings: `[`Settings`](../-settings/index.html)
Provides access to the settings of this engine session. | + +### Functions + +| [clearFindMatches](clear-find-matches.html) | `abstract fun clearFindMatches(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Clears the highlighted results of previous calls to [findAll](find-all.html) / [findNext](find-next.html). | +| [close](close.html) | `fun close(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Close the session. This may free underlying objects. Call this when you are finished using this session. | +| [disableTrackingProtection](disable-tracking-protection.html) | `abstract fun disableTrackingProtection(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Disables tracking protection for this engine session. | +| [enableTrackingProtection](enable-tracking-protection.html) | `abstract fun enableTrackingProtection(policy: `[`TrackingProtectionPolicy`](-tracking-protection-policy/index.html)` = TrackingProtectionPolicy.all()): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Enables tracking protection for this engine session. | +| [findAll](find-all.html) | `abstract fun findAll(text: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Finds and highlights all occurrences of the provided String and highlights them asynchronously. | +| [findNext](find-next.html) | `abstract fun findNext(forward: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Finds and highlights the next or previous match found by [findAll](find-all.html). | +| [goBack](go-back.html) | `abstract fun goBack(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Navigates back in the history of this session. | +| [goForward](go-forward.html) | `abstract fun goForward(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Navigates forward in the history of this session. | +| [loadData](load-data.html) | `abstract fun loadData(data: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, mimeType: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = "text/html", encoding: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = "UTF-8"): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Loads the data with the given mimeType. Example: | +| [loadUrl](load-url.html) | `abstract fun loadUrl(url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Loads the given URL. | +| [reload](reload.html) | `abstract fun reload(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Reloads the current URL. | +| [restoreState](restore-state.html) | `abstract fun restoreState(state: `[`Map`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`>): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Restores the engine state as provided by [saveState](save-state.html). | +| [saveState](save-state.html) | `abstract fun saveState(): `[`Map`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`>`
Saves and returns the engine state. Engine implementations are not required to persist the state anywhere else than in the returned map. Engines that already provide a serialized state can use a single entry in this map to provide this state. The only requirement is that the same map can be used to restore the original state. See [restoreState](restore-state.html) and the specific engine implementation for details. | +| [setDesktopMode](set-desktop-mode.html) | `abstract fun setDesktopMode(enable: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`, reload: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Enables/disables Desktop Mode with an optional ability to reload the session right after. | +| [stopLoading](stop-loading.html) | `abstract fun stopLoading(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Stops loading the current session. | + diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/load-data.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/load-data.md new file mode 100644 index 00000000000..fca252d46b1 --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/load-data.md @@ -0,0 +1,31 @@ +--- +title: EngineSession.loadData - +--- + +[mozilla.components.concept.engine](../index.html) / [EngineSession](index.html) / [loadData](./load-data.html) + +# loadData + +`abstract fun loadData(data: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, mimeType: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = "text/html", encoding: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = "UTF-8"): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Loads the data with the given mimeType. +Example: + +``` +engineSession.loadData("Example HTML content here", "text/html") +``` + +If the data is base64 encoded, you can override the default encoding (UTF-8) with 'base64'. +Example: + +``` +engineSession.loadData("ahr0cdovl21vemlsbgeub3jn==", "text/plain", "base64") +``` + +### Parameters + +`data` - The data that should be rendering. + +`mimeType` - the data type needed by the engine to know how to render it. + +`encoding` - specifies whether the data is base64 encoded; use 'base64' else defaults to "UTF-8". \ No newline at end of file diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/load-url.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/load-url.md new file mode 100644 index 00000000000..252d6ffdb4b --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/load-url.md @@ -0,0 +1,12 @@ +--- +title: EngineSession.loadUrl - +--- + +[mozilla.components.concept.engine](../index.html) / [EngineSession](index.html) / [loadUrl](./load-url.html) + +# loadUrl + +`abstract fun loadUrl(url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Loads the given URL. + diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/reload.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/reload.md new file mode 100644 index 00000000000..4c24e8d8d45 --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/reload.md @@ -0,0 +1,12 @@ +--- +title: EngineSession.reload - +--- + +[mozilla.components.concept.engine](../index.html) / [EngineSession](index.html) / [reload](./reload.html) + +# reload + +`abstract fun reload(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Reloads the current URL. + diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/restore-state.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/restore-state.md new file mode 100644 index 00000000000..fbd7365db2e --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/restore-state.md @@ -0,0 +1,15 @@ +--- +title: EngineSession.restoreState - +--- + +[mozilla.components.concept.engine](../index.html) / [EngineSession](index.html) / [restoreState](./restore-state.html) + +# restoreState + +`abstract fun restoreState(state: `[`Map`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`>): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Restores the engine state as provided by [saveState](save-state.html). + +### Parameters + +`state` - state retrieved from [saveState](save-state.html) \ No newline at end of file diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/save-state.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/save-state.md new file mode 100644 index 00000000000..c477deaafbb --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/save-state.md @@ -0,0 +1,17 @@ +--- +title: EngineSession.saveState - +--- + +[mozilla.components.concept.engine](../index.html) / [EngineSession](index.html) / [saveState](./save-state.html) + +# saveState + +`abstract fun saveState(): `[`Map`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`>` + +Saves and returns the engine state. Engine implementations are not required +to persist the state anywhere else than in the returned map. Engines that +already provide a serialized state can use a single entry in this map to +provide this state. The only requirement is that the same map can be used +to restore the original state. See [restoreState](restore-state.html) and the specific +engine implementation for details. + diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/set-desktop-mode.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/set-desktop-mode.md new file mode 100644 index 00000000000..207e5157310 --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/set-desktop-mode.md @@ -0,0 +1,12 @@ +--- +title: EngineSession.setDesktopMode - +--- + +[mozilla.components.concept.engine](../index.html) / [EngineSession](index.html) / [setDesktopMode](./set-desktop-mode.html) + +# setDesktopMode + +`abstract fun setDesktopMode(enable: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`, reload: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Enables/disables Desktop Mode with an optional ability to reload the session right after. + diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/settings.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/settings.md new file mode 100644 index 00000000000..247f96d144c --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/settings.md @@ -0,0 +1,12 @@ +--- +title: EngineSession.settings - +--- + +[mozilla.components.concept.engine](../index.html) / [EngineSession](index.html) / [settings](./settings.html) + +# settings + +`abstract val settings: `[`Settings`](../-settings/index.html) + +Provides access to the settings of this engine session. + diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/stop-loading.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/stop-loading.md new file mode 100644 index 00000000000..8e6a134eb29 --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-session/stop-loading.md @@ -0,0 +1,12 @@ +--- +title: EngineSession.stopLoading - +--- + +[mozilla.components.concept.engine](../index.html) / [EngineSession](index.html) / [stopLoading](./stop-loading.html) + +# stopLoading + +`abstract fun stopLoading(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Stops loading the current session. + diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-view/as-view.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-view/as-view.md new file mode 100644 index 00000000000..87a7a4786a8 --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-view/as-view.md @@ -0,0 +1,12 @@ +--- +title: EngineView.asView - +--- + +[mozilla.components.concept.engine](../index.html) / [EngineView](index.html) / [asView](./as-view.html) + +# asView + +`open fun asView(): View` + +Convenience method to cast the implementation of this interface to an Android View object. + diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-view/index.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-view/index.md new file mode 100644 index 00000000000..fd27fe281f3 --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-view/index.md @@ -0,0 +1,17 @@ +--- +title: EngineView - +--- + +[mozilla.components.concept.engine](../index.html) / [EngineView](./index.html) + +# EngineView + +`interface EngineView` + +View component that renders web content. + +### Functions + +| [asView](as-view.html) | `open fun asView(): View`
Convenience method to cast the implementation of this interface to an Android View object. | +| [render](render.html) | `abstract fun render(session: `[`EngineSession`](../-engine-session/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Render the content of the given session. | + diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-view/render.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-view/render.md new file mode 100644 index 00000000000..0964bc14cbf --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine-view/render.md @@ -0,0 +1,12 @@ +--- +title: EngineView.render - +--- + +[mozilla.components.concept.engine](../index.html) / [EngineView](index.html) / [render](./render.html) + +# render + +`abstract fun render(session: `[`EngineSession`](../-engine-session/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Render the content of the given session. + diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine/create-session.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine/create-session.md new file mode 100644 index 00000000000..0f557ac4c95 --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine/create-session.md @@ -0,0 +1,19 @@ +--- +title: Engine.createSession - +--- + +[mozilla.components.concept.engine](../index.html) / [Engine](index.html) / [createSession](./create-session.html) + +# createSession + +`abstract fun createSession(private: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false): `[`EngineSession`](../-engine-session/index.html) + +Creates a new engine session. + +### Parameters + +`private` - whether or not this session should use private mode. + +**Return** +the newly created [EngineSession](../-engine-session/index.html). + diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine/create-view.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine/create-view.md new file mode 100644 index 00000000000..65a220a8af7 --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine/create-view.md @@ -0,0 +1,21 @@ +--- +title: Engine.createView - +--- + +[mozilla.components.concept.engine](../index.html) / [Engine](index.html) / [createView](./create-view.html) + +# createView + +`abstract fun createView(context: Context, attrs: AttributeSet? = null): `[`EngineView`](../-engine-view/index.html) + +Creates a new view for rendering web content. + +### Parameters + +`context` - an application context + +`attrs` - optional set of attributes + +**Return** +new newly created [EngineView](../-engine-view/index.html). + diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine/index.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine/index.md new file mode 100644 index 00000000000..9ba221f1089 --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine/index.md @@ -0,0 +1,22 @@ +--- +title: Engine - +--- + +[mozilla.components.concept.engine](../index.html) / [Engine](./index.html) + +# Engine + +`interface Engine` + +Entry point for interacting with the engine implementation. + +### Properties + +| [settings](settings.html) | `abstract val settings: `[`Settings`](../-settings/index.html)
Provides access to the settings of this engine. | + +### Functions + +| [createSession](create-session.html) | `abstract fun createSession(private: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false): `[`EngineSession`](../-engine-session/index.html)
Creates a new engine session. | +| [createView](create-view.html) | `abstract fun createView(context: Context, attrs: AttributeSet? = null): `[`EngineView`](../-engine-view/index.html)
Creates a new view for rendering web content. | +| [name](name.html) | `abstract fun name(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Returns the name of this engine. The returned string might be used in filenames and must therefore only contain valid filename characters. | + diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine/name.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine/name.md new file mode 100644 index 00000000000..f52982c9f47 --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine/name.md @@ -0,0 +1,17 @@ +--- +title: Engine.name - +--- + +[mozilla.components.concept.engine](../index.html) / [Engine](index.html) / [name](./name.html) + +# name + +`abstract fun name(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) + +Returns the name of this engine. The returned string might be used +in filenames and must therefore only contain valid filename +characters. + +**Return** +the engine name as specified by concrete implementations. + diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine/settings.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine/settings.md new file mode 100644 index 00000000000..4bdddafb8a0 --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-engine/settings.md @@ -0,0 +1,12 @@ +--- +title: Engine.settings - +--- + +[mozilla.components.concept.engine](../index.html) / [Engine](index.html) / [settings](./settings.html) + +# settings + +`abstract val settings: `[`Settings`](../-settings/index.html) + +Provides access to the settings of this engine. + diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-hit-result/-a-u-d-i-o/-init-.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-hit-result/-a-u-d-i-o/-init-.md new file mode 100644 index 00000000000..072bfc753a6 --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-hit-result/-a-u-d-i-o/-init-.md @@ -0,0 +1,12 @@ +--- +title: HitResult.AUDIO. - +--- + +[mozilla.components.concept.engine](../../index.html) / [HitResult](../index.html) / [AUDIO](index.html) / [<init>](./-init-.html) + +# <init> + +`AUDIO(src: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)` + +If the HTML element was of type 'HTMLAudioElement'. + diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-hit-result/-a-u-d-i-o/index.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-hit-result/-a-u-d-i-o/index.md new file mode 100644 index 00000000000..2656fe324b6 --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-hit-result/-a-u-d-i-o/index.md @@ -0,0 +1,20 @@ +--- +title: HitResult.AUDIO - +--- + +[mozilla.components.concept.engine](../../index.html) / [HitResult](../index.html) / [AUDIO](./index.html) + +# AUDIO + +`class AUDIO : `[`HitResult`](../index.html) + +If the HTML element was of type 'HTMLAudioElement'. + +### Constructors + +| [<init>](-init-.html) | `AUDIO(src: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)`
If the HTML element was of type 'HTMLAudioElement'. | + +### Inherited Properties + +| [src](../src.html) | `val src: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-hit-result/-e-m-a-i-l/-init-.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-hit-result/-e-m-a-i-l/-init-.md new file mode 100644 index 00000000000..6b43fe3e37b --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-hit-result/-e-m-a-i-l/-init-.md @@ -0,0 +1,12 @@ +--- +title: HitResult.EMAIL. - +--- + +[mozilla.components.concept.engine](../../index.html) / [HitResult](../index.html) / [EMAIL](index.html) / [<init>](./-init-.html) + +# <init> + +`EMAIL(src: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)` + +The type used if the URI is prepended with 'mailto:'. + diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-hit-result/-e-m-a-i-l/index.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-hit-result/-e-m-a-i-l/index.md new file mode 100644 index 00000000000..79b1b2471f7 --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-hit-result/-e-m-a-i-l/index.md @@ -0,0 +1,20 @@ +--- +title: HitResult.EMAIL - +--- + +[mozilla.components.concept.engine](../../index.html) / [HitResult](../index.html) / [EMAIL](./index.html) + +# EMAIL + +`class EMAIL : `[`HitResult`](../index.html) + +The type used if the URI is prepended with 'mailto:'. + +### Constructors + +| [<init>](-init-.html) | `EMAIL(src: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)`
The type used if the URI is prepended with 'mailto:'. | + +### Inherited Properties + +| [src](../src.html) | `val src: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-hit-result/-g-e-o/-init-.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-hit-result/-g-e-o/-init-.md new file mode 100644 index 00000000000..d855dc8ed18 --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-hit-result/-g-e-o/-init-.md @@ -0,0 +1,12 @@ +--- +title: HitResult.GEO. - +--- + +[mozilla.components.concept.engine](../../index.html) / [HitResult](../index.html) / [GEO](index.html) / [<init>](./-init-.html) + +# <init> + +`GEO(src: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)` + +The type used if the URI is prepended with 'geo:'. + diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-hit-result/-g-e-o/index.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-hit-result/-g-e-o/index.md new file mode 100644 index 00000000000..6cdd6aa625a --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-hit-result/-g-e-o/index.md @@ -0,0 +1,20 @@ +--- +title: HitResult.GEO - +--- + +[mozilla.components.concept.engine](../../index.html) / [HitResult](../index.html) / [GEO](./index.html) + +# GEO + +`class GEO : `[`HitResult`](../index.html) + +The type used if the URI is prepended with 'geo:'. + +### Constructors + +| [<init>](-init-.html) | `GEO(src: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)`
The type used if the URI is prepended with 'geo:'. | + +### Inherited Properties + +| [src](../src.html) | `val src: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-hit-result/-i-m-a-g-e/-init-.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-hit-result/-i-m-a-g-e/-init-.md new file mode 100644 index 00000000000..182d7a3f7f4 --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-hit-result/-i-m-a-g-e/-init-.md @@ -0,0 +1,12 @@ +--- +title: HitResult.IMAGE. - +--- + +[mozilla.components.concept.engine](../../index.html) / [HitResult](../index.html) / [IMAGE](index.html) / [<init>](./-init-.html) + +# <init> + +`IMAGE(src: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)` + +If the HTML element was of type 'HTMLImageElement'. + diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-hit-result/-i-m-a-g-e/index.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-hit-result/-i-m-a-g-e/index.md new file mode 100644 index 00000000000..6c9b04f78c1 --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-hit-result/-i-m-a-g-e/index.md @@ -0,0 +1,20 @@ +--- +title: HitResult.IMAGE - +--- + +[mozilla.components.concept.engine](../../index.html) / [HitResult](../index.html) / [IMAGE](./index.html) + +# IMAGE + +`class IMAGE : `[`HitResult`](../index.html) + +If the HTML element was of type 'HTMLImageElement'. + +### Constructors + +| [<init>](-init-.html) | `IMAGE(src: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)`
If the HTML element was of type 'HTMLImageElement'. | + +### Inherited Properties + +| [src](../src.html) | `val src: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-hit-result/-i-m-a-g-e_-s-r-c/-init-.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-hit-result/-i-m-a-g-e_-s-r-c/-init-.md new file mode 100644 index 00000000000..0e27f033c7d --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-hit-result/-i-m-a-g-e_-s-r-c/-init-.md @@ -0,0 +1,12 @@ +--- +title: HitResult.IMAGE_SRC. - +--- + +[mozilla.components.concept.engine](../../index.html) / [HitResult](../index.html) / [IMAGE_SRC](index.html) / [<init>](./-init-.html) + +# <init> + +`IMAGE_SRC(src: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, uri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)` + +If the HTML element was of type 'HTMLImageElement' and contained a URI. + diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-hit-result/-i-m-a-g-e_-s-r-c/index.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-hit-result/-i-m-a-g-e_-s-r-c/index.md new file mode 100644 index 00000000000..5f69d4a9917 --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-hit-result/-i-m-a-g-e_-s-r-c/index.md @@ -0,0 +1,24 @@ +--- +title: HitResult.IMAGE_SRC - +--- + +[mozilla.components.concept.engine](../../index.html) / [HitResult](../index.html) / [IMAGE_SRC](./index.html) + +# IMAGE_SRC + +`class IMAGE_SRC : `[`HitResult`](../index.html) + +If the HTML element was of type 'HTMLImageElement' and contained a URI. + +### Constructors + +| [<init>](-init-.html) | `IMAGE_SRC(src: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, uri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)`
If the HTML element was of type 'HTMLImageElement' and contained a URI. | + +### Properties + +| [uri](uri.html) | `val uri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + +### Inherited Properties + +| [src](../src.html) | `val src: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-hit-result/-i-m-a-g-e_-s-r-c/uri.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-hit-result/-i-m-a-g-e_-s-r-c/uri.md new file mode 100644 index 00000000000..20031bcb41f --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-hit-result/-i-m-a-g-e_-s-r-c/uri.md @@ -0,0 +1,9 @@ +--- +title: HitResult.IMAGE_SRC.uri - +--- + +[mozilla.components.concept.engine](../../index.html) / [HitResult](../index.html) / [IMAGE_SRC](index.html) / [uri](./uri.html) + +# uri + +`val uri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) \ No newline at end of file diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-hit-result/-p-h-o-n-e/-init-.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-hit-result/-p-h-o-n-e/-init-.md new file mode 100644 index 00000000000..471893338e9 --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-hit-result/-p-h-o-n-e/-init-.md @@ -0,0 +1,12 @@ +--- +title: HitResult.PHONE. - +--- + +[mozilla.components.concept.engine](../../index.html) / [HitResult](../index.html) / [PHONE](index.html) / [<init>](./-init-.html) + +# <init> + +`PHONE(src: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)` + +The type used if the URI is prepended with 'tel:'. + diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-hit-result/-p-h-o-n-e/index.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-hit-result/-p-h-o-n-e/index.md new file mode 100644 index 00000000000..7616f6bbb5d --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-hit-result/-p-h-o-n-e/index.md @@ -0,0 +1,20 @@ +--- +title: HitResult.PHONE - +--- + +[mozilla.components.concept.engine](../../index.html) / [HitResult](../index.html) / [PHONE](./index.html) + +# PHONE + +`class PHONE : `[`HitResult`](../index.html) + +The type used if the URI is prepended with 'tel:'. + +### Constructors + +| [<init>](-init-.html) | `PHONE(src: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)`
The type used if the URI is prepended with 'tel:'. | + +### Inherited Properties + +| [src](../src.html) | `val src: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-hit-result/-u-n-k-n-o-w-n/-init-.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-hit-result/-u-n-k-n-o-w-n/-init-.md new file mode 100644 index 00000000000..887a3cc00da --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-hit-result/-u-n-k-n-o-w-n/-init-.md @@ -0,0 +1,12 @@ +--- +title: HitResult.UNKNOWN. - +--- + +[mozilla.components.concept.engine](../../index.html) / [HitResult](../index.html) / [UNKNOWN](index.html) / [<init>](./-init-.html) + +# <init> + +`UNKNOWN(src: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)` + +Default type if we're unable to match the type to anything. It may or may not have a src. + diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-hit-result/-u-n-k-n-o-w-n/index.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-hit-result/-u-n-k-n-o-w-n/index.md new file mode 100644 index 00000000000..453bf126435 --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-hit-result/-u-n-k-n-o-w-n/index.md @@ -0,0 +1,20 @@ +--- +title: HitResult.UNKNOWN - +--- + +[mozilla.components.concept.engine](../../index.html) / [HitResult](../index.html) / [UNKNOWN](./index.html) + +# UNKNOWN + +`class UNKNOWN : `[`HitResult`](../index.html) + +Default type if we're unable to match the type to anything. It may or may not have a src. + +### Constructors + +| [<init>](-init-.html) | `UNKNOWN(src: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)`
Default type if we're unable to match the type to anything. It may or may not have a src. | + +### Inherited Properties + +| [src](../src.html) | `val src: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-hit-result/-v-i-d-e-o/-init-.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-hit-result/-v-i-d-e-o/-init-.md new file mode 100644 index 00000000000..18e297eb16e --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-hit-result/-v-i-d-e-o/-init-.md @@ -0,0 +1,12 @@ +--- +title: HitResult.VIDEO. - +--- + +[mozilla.components.concept.engine](../../index.html) / [HitResult](../index.html) / [VIDEO](index.html) / [<init>](./-init-.html) + +# <init> + +`VIDEO(src: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)` + +If the HTML element was of type 'HTMLVideoElement'. + diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-hit-result/-v-i-d-e-o/index.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-hit-result/-v-i-d-e-o/index.md new file mode 100644 index 00000000000..52f8e50c09f --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-hit-result/-v-i-d-e-o/index.md @@ -0,0 +1,20 @@ +--- +title: HitResult.VIDEO - +--- + +[mozilla.components.concept.engine](../../index.html) / [HitResult](../index.html) / [VIDEO](./index.html) + +# VIDEO + +`class VIDEO : `[`HitResult`](../index.html) + +If the HTML element was of type 'HTMLVideoElement'. + +### Constructors + +| [<init>](-init-.html) | `VIDEO(src: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)`
If the HTML element was of type 'HTMLVideoElement'. | + +### Inherited Properties + +| [src](../src.html) | `val src: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-hit-result/index.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-hit-result/index.md new file mode 100644 index 00000000000..0139ce74c24 --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-hit-result/index.md @@ -0,0 +1,39 @@ +--- +title: HitResult - +--- + +[mozilla.components.concept.engine](../index.html) / [HitResult](./index.html) + +# HitResult + +`sealed class HitResult` + +Represents all the different supported types of data that can be found from long clicking +an element. + +### Types + +| [AUDIO](-a-u-d-i-o/index.html) | `class AUDIO : `[`HitResult`](./index.md)
If the HTML element was of type 'HTMLAudioElement'. | +| [EMAIL](-e-m-a-i-l/index.html) | `class EMAIL : `[`HitResult`](./index.md)
The type used if the URI is prepended with 'mailto:'. | +| [GEO](-g-e-o/index.html) | `class GEO : `[`HitResult`](./index.md)
The type used if the URI is prepended with 'geo:'. | +| [IMAGE](-i-m-a-g-e/index.html) | `class IMAGE : `[`HitResult`](./index.md)
If the HTML element was of type 'HTMLImageElement'. | +| [IMAGE_SRC](-i-m-a-g-e_-s-r-c/index.html) | `class IMAGE_SRC : `[`HitResult`](./index.md)
If the HTML element was of type 'HTMLImageElement' and contained a URI. | +| [PHONE](-p-h-o-n-e/index.html) | `class PHONE : `[`HitResult`](./index.md)
The type used if the URI is prepended with 'tel:'. | +| [UNKNOWN](-u-n-k-n-o-w-n/index.html) | `class UNKNOWN : `[`HitResult`](./index.md)
Default type if we're unable to match the type to anything. It may or may not have a src. | +| [VIDEO](-v-i-d-e-o/index.html) | `class VIDEO : `[`HitResult`](./index.md)
If the HTML element was of type 'HTMLVideoElement'. | + +### Properties + +| [src](src.html) | `val src: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + +### Inheritors + +| [AUDIO](-a-u-d-i-o/index.html) | `class AUDIO : `[`HitResult`](./index.md)
If the HTML element was of type 'HTMLAudioElement'. | +| [EMAIL](-e-m-a-i-l/index.html) | `class EMAIL : `[`HitResult`](./index.md)
The type used if the URI is prepended with 'mailto:'. | +| [GEO](-g-e-o/index.html) | `class GEO : `[`HitResult`](./index.md)
The type used if the URI is prepended with 'geo:'. | +| [IMAGE](-i-m-a-g-e/index.html) | `class IMAGE : `[`HitResult`](./index.md)
If the HTML element was of type 'HTMLImageElement'. | +| [IMAGE_SRC](-i-m-a-g-e_-s-r-c/index.html) | `class IMAGE_SRC : `[`HitResult`](./index.md)
If the HTML element was of type 'HTMLImageElement' and contained a URI. | +| [PHONE](-p-h-o-n-e/index.html) | `class PHONE : `[`HitResult`](./index.md)
The type used if the URI is prepended with 'tel:'. | +| [UNKNOWN](-u-n-k-n-o-w-n/index.html) | `class UNKNOWN : `[`HitResult`](./index.md)
Default type if we're unable to match the type to anything. It may or may not have a src. | +| [VIDEO](-v-i-d-e-o/index.html) | `class VIDEO : `[`HitResult`](./index.md)
If the HTML element was of type 'HTMLVideoElement'. | + diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-hit-result/src.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-hit-result/src.md new file mode 100644 index 00000000000..5433334a583 --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-hit-result/src.md @@ -0,0 +1,9 @@ +--- +title: HitResult.src - +--- + +[mozilla.components.concept.engine](../index.html) / [HitResult](index.html) / [src](./src.html) + +# src + +`val src: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) \ No newline at end of file diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-settings/dom-storage-enabled.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-settings/dom-storage-enabled.md new file mode 100644 index 00000000000..8331bf7bd50 --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-settings/dom-storage-enabled.md @@ -0,0 +1,12 @@ +--- +title: Settings.domStorageEnabled - +--- + +[mozilla.components.concept.engine](../index.html) / [Settings](index.html) / [domStorageEnabled](./dom-storage-enabled.html) + +# domStorageEnabled + +`open var domStorageEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Setting to control whether or not DOM Storage is enabled. + diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-settings/index.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-settings/index.md new file mode 100644 index 00000000000..4720c2697fe --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-settings/index.md @@ -0,0 +1,25 @@ +--- +title: Settings - +--- + +[mozilla.components.concept.engine](../index.html) / [Settings](./index.html) + +# Settings + +`interface Settings` + +Holds settings of an engine or session. Concrete engine +implementations define how these settings are applied i.e. +whether a setting is applied on an engine or session instance. + +### Properties + +| [domStorageEnabled](dom-storage-enabled.html) | `open var domStorageEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Setting to control whether or not DOM Storage is enabled. | +| [javascriptEnabled](javascript-enabled.html) | `open var javascriptEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Setting to control whether or not JavaScript is enabled. | +| [requestInterceptor](request-interceptor.html) | `open var requestInterceptor: `[`RequestInterceptor`](../../mozilla.components.concept.engine.request/-request-interceptor/index.html)`?`
Setting to intercept and override requests. | +| [trackingProtectionPolicy](tracking-protection-policy.html) | `open var trackingProtectionPolicy: `[`TrackingProtectionPolicy`](../-engine-session/-tracking-protection-policy/index.html)`?`
Setting to control tracking protection. | + +### Inheritors + +| [DefaultSettings](../-default-settings/index.html) | `data class DefaultSettings : `[`Settings`](./index.md)
[Settings](./index.md) implementation used to set defaults for [Engine](../-engine/index.html) and [EngineSession](../-engine-session/index.html). | + diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-settings/javascript-enabled.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-settings/javascript-enabled.md new file mode 100644 index 00000000000..7f328c7b0cb --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-settings/javascript-enabled.md @@ -0,0 +1,12 @@ +--- +title: Settings.javascriptEnabled - +--- + +[mozilla.components.concept.engine](../index.html) / [Settings](index.html) / [javascriptEnabled](./javascript-enabled.html) + +# javascriptEnabled + +`open var javascriptEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Setting to control whether or not JavaScript is enabled. + diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-settings/request-interceptor.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-settings/request-interceptor.md new file mode 100644 index 00000000000..378c1916c9e --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-settings/request-interceptor.md @@ -0,0 +1,12 @@ +--- +title: Settings.requestInterceptor - +--- + +[mozilla.components.concept.engine](../index.html) / [Settings](index.html) / [requestInterceptor](./request-interceptor.html) + +# requestInterceptor + +`open var requestInterceptor: `[`RequestInterceptor`](../../mozilla.components.concept.engine.request/-request-interceptor/index.html)`?` + +Setting to intercept and override requests. + diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-settings/tracking-protection-policy.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-settings/tracking-protection-policy.md new file mode 100644 index 00000000000..3254559c24f --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-settings/tracking-protection-policy.md @@ -0,0 +1,12 @@ +--- +title: Settings.trackingProtectionPolicy - +--- + +[mozilla.components.concept.engine](../index.html) / [Settings](index.html) / [trackingProtectionPolicy](./tracking-protection-policy.html) + +# trackingProtectionPolicy + +`open var trackingProtectionPolicy: `[`TrackingProtectionPolicy`](../-engine-session/-tracking-protection-policy/index.html)`?` + +Setting to control tracking protection. + diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-unsupported-setting-exception/-init-.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-unsupported-setting-exception/-init-.md new file mode 100644 index 00000000000..b5ba8f73423 --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-unsupported-setting-exception/-init-.md @@ -0,0 +1,12 @@ +--- +title: UnsupportedSettingException. - +--- + +[mozilla.components.concept.engine](../index.html) / [UnsupportedSettingException](index.html) / [<init>](./-init-.html) + +# <init> + +`UnsupportedSettingException()` + +Exception thrown by default if a setting is not supported by an engine or session. + diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-unsupported-setting-exception/index.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-unsupported-setting-exception/index.md new file mode 100644 index 00000000000..c982f0742c1 --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/-unsupported-setting-exception/index.md @@ -0,0 +1,16 @@ +--- +title: UnsupportedSettingException - +--- + +[mozilla.components.concept.engine](../index.html) / [UnsupportedSettingException](./index.html) + +# UnsupportedSettingException + +`class UnsupportedSettingException : `[`RuntimeException`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-runtime-exception/index.html) + +Exception thrown by default if a setting is not supported by an engine or session. + +### Constructors + +| [<init>](-init-.html) | `UnsupportedSettingException()`
Exception thrown by default if a setting is not supported by an engine or session. | + diff --git a/docs/api/0.21/concept-engine/mozilla.components.concept.engine/index.md b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/index.md new file mode 100644 index 00000000000..3a5b9d1fb6f --- /dev/null +++ b/docs/api/0.21/concept-engine/mozilla.components.concept.engine/index.md @@ -0,0 +1,21 @@ +--- +title: mozilla.components.concept.engine - +--- + +[mozilla.components.concept.engine](./index.html) + +## Package mozilla.components.concept.engine + +### Types + +| [DefaultSettings](-default-settings/index.html) | `data class DefaultSettings : `[`Settings`](-settings/index.html)
[Settings](-settings/index.html) implementation used to set defaults for [Engine](-engine/index.html) and [EngineSession](-engine-session/index.html). | +| [Engine](-engine/index.html) | `interface Engine`
Entry point for interacting with the engine implementation. | +| [EngineSession](-engine-session/index.html) | `abstract class EngineSession : Observable<`[`Observer`](-engine-session/-observer/index.html)`>`
Class representing a single engine session. | +| [EngineView](-engine-view/index.html) | `interface EngineView`
View component that renders web content. | +| [HitResult](-hit-result/index.html) | `sealed class HitResult`
Represents all the different supported types of data that can be found from long clicking an element. | +| [Settings](-settings/index.html) | `interface Settings`
Holds settings of an engine or session. Concrete engine implementations define how these settings are applied i.e. whether a setting is applied on an engine or session instance. | + +### Exceptions + +| [UnsupportedSettingException](-unsupported-setting-exception/index.html) | `class UnsupportedSettingException : `[`RuntimeException`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-runtime-exception/index.html)
Exception thrown by default if a setting is not supported by an engine or session. | + diff --git a/docs/api/0.21/concept-engine/package-list b/docs/api/0.21/concept-engine/package-list new file mode 100644 index 00000000000..17f486e8082 --- /dev/null +++ b/docs/api/0.21/concept-engine/package-list @@ -0,0 +1,5 @@ +$dokka.format:jekyll +$dokka.linkExtension:html + +mozilla.components.concept.engine +mozilla.components.concept.engine.request diff --git a/docs/api/0.21/concept-tabstray/alltypes/index.md b/docs/api/0.21/concept-tabstray/alltypes/index.md new file mode 100644 index 00000000000..1e99c464efa --- /dev/null +++ b/docs/api/0.21/concept-tabstray/alltypes/index.md @@ -0,0 +1,8 @@ +--- +title: alltypes - +--- + +### All Types + +| [mozilla.components.concept.tabstray.TabsTray](../mozilla.components.concept.tabstray/-tabs-tray/index.html) | Generic interface for components that provide "tabs tray" functionality. | + diff --git a/docs/api/0.21/concept-tabstray/index.md b/docs/api/0.21/concept-tabstray/index.md new file mode 100644 index 00000000000..4b7b13a0d96 --- /dev/null +++ b/docs/api/0.21/concept-tabstray/index.md @@ -0,0 +1,11 @@ +--- +title: +--- + +### Packages + +| [mozilla.components.concept.tabstray](mozilla.components.concept.tabstray/index.html) | | + +### Index + +[All Types](alltypes/index.html) \ No newline at end of file diff --git a/docs/api/0.21/concept-tabstray/mozilla.components.concept.tabstray/-tabs-tray/-observer/index.md b/docs/api/0.21/concept-tabstray/mozilla.components.concept.tabstray/-tabs-tray/-observer/index.md new file mode 100644 index 00000000000..031c2384465 --- /dev/null +++ b/docs/api/0.21/concept-tabstray/mozilla.components.concept.tabstray/-tabs-tray/-observer/index.md @@ -0,0 +1,17 @@ +--- +title: TabsTray.Observer - +--- + +[mozilla.components.concept.tabstray](../../index.html) / [TabsTray](../index.html) / [Observer](./index.html) + +# Observer + +`interface Observer` + +Interface to be implemented by classes that want to observe a tabs tray. + +### Functions + +| [onTabClosed](on-tab-closed.html) | `abstract fun onTabClosed(session: Session): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
A tab has been closed. | +| [onTabSelected](on-tab-selected.html) | `abstract fun onTabSelected(session: Session): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
A new tab has been selected. | + diff --git a/docs/api/0.21/concept-tabstray/mozilla.components.concept.tabstray/-tabs-tray/-observer/on-tab-closed.md b/docs/api/0.21/concept-tabstray/mozilla.components.concept.tabstray/-tabs-tray/-observer/on-tab-closed.md new file mode 100644 index 00000000000..a32c4086ab2 --- /dev/null +++ b/docs/api/0.21/concept-tabstray/mozilla.components.concept.tabstray/-tabs-tray/-observer/on-tab-closed.md @@ -0,0 +1,12 @@ +--- +title: TabsTray.Observer.onTabClosed - +--- + +[mozilla.components.concept.tabstray](../../index.html) / [TabsTray](../index.html) / [Observer](index.html) / [onTabClosed](./on-tab-closed.html) + +# onTabClosed + +`abstract fun onTabClosed(session: Session): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +A tab has been closed. + diff --git a/docs/api/0.21/concept-tabstray/mozilla.components.concept.tabstray/-tabs-tray/-observer/on-tab-selected.md b/docs/api/0.21/concept-tabstray/mozilla.components.concept.tabstray/-tabs-tray/-observer/on-tab-selected.md new file mode 100644 index 00000000000..de4a4734995 --- /dev/null +++ b/docs/api/0.21/concept-tabstray/mozilla.components.concept.tabstray/-tabs-tray/-observer/on-tab-selected.md @@ -0,0 +1,12 @@ +--- +title: TabsTray.Observer.onTabSelected - +--- + +[mozilla.components.concept.tabstray](../../index.html) / [TabsTray](../index.html) / [Observer](index.html) / [onTabSelected](./on-tab-selected.html) + +# onTabSelected + +`abstract fun onTabSelected(session: Session): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +A new tab has been selected. + diff --git a/docs/api/0.21/concept-tabstray/mozilla.components.concept.tabstray/-tabs-tray/as-view.md b/docs/api/0.21/concept-tabstray/mozilla.components.concept.tabstray/-tabs-tray/as-view.md new file mode 100644 index 00000000000..8c52b948437 --- /dev/null +++ b/docs/api/0.21/concept-tabstray/mozilla.components.concept.tabstray/-tabs-tray/as-view.md @@ -0,0 +1,12 @@ +--- +title: TabsTray.asView - +--- + +[mozilla.components.concept.tabstray](../index.html) / [TabsTray](index.html) / [asView](./as-view.html) + +# asView + +`open fun asView(): View` + +Convenience method to cast the implementation of this interface to an Android View object. + diff --git a/docs/api/0.21/concept-tabstray/mozilla.components.concept.tabstray/-tabs-tray/display-sessions.md b/docs/api/0.21/concept-tabstray/mozilla.components.concept.tabstray/-tabs-tray/display-sessions.md new file mode 100644 index 00000000000..3a1b7ffdfbb --- /dev/null +++ b/docs/api/0.21/concept-tabstray/mozilla.components.concept.tabstray/-tabs-tray/display-sessions.md @@ -0,0 +1,19 @@ +--- +title: TabsTray.displaySessions - +--- + +[mozilla.components.concept.tabstray](../index.html) / [TabsTray](index.html) / [displaySessions](./display-sessions.html) + +# displaySessions + +`abstract fun displaySessions(sessions: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`, selectedIndex: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Displays the given list of sessions. + +This method will be invoked with the initial list of sessions that should be displayed. + +### Parameters + +`sessions` - The list of sessions to be displayed. + +`selectedIndex` - The list index of the currently selected session. \ No newline at end of file diff --git a/docs/api/0.21/concept-tabstray/mozilla.components.concept.tabstray/-tabs-tray/index.md b/docs/api/0.21/concept-tabstray/mozilla.components.concept.tabstray/-tabs-tray/index.md new file mode 100644 index 00000000000..f27d61b3abb --- /dev/null +++ b/docs/api/0.21/concept-tabstray/mozilla.components.concept.tabstray/-tabs-tray/index.md @@ -0,0 +1,26 @@ +--- +title: TabsTray - +--- + +[mozilla.components.concept.tabstray](../index.html) / [TabsTray](./index.html) + +# TabsTray + +`interface TabsTray : Observable<`[`Observer`](-observer/index.html)`>` + +Generic interface for components that provide "tabs tray" functionality. + +### Types + +| [Observer](-observer/index.html) | `interface Observer`
Interface to be implemented by classes that want to observe a tabs tray. | + +### Functions + +| [asView](as-view.html) | `open fun asView(): View`
Convenience method to cast the implementation of this interface to an Android View object. | +| [displaySessions](display-sessions.html) | `abstract fun displaySessions(sessions: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`, selectedIndex: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Displays the given list of sessions. | +| [onSessionMoved](on-session-moved.html) | `abstract fun onSessionMoved(fromPosition: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, toPosition: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Called after updateSessions() when a session changes it position. | +| [onSessionsChanged](on-sessions-changed.html) | `abstract fun onSessionsChanged(position: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, count: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Called after updateSessions() when count number of sessions are updated at the given position. | +| [onSessionsInserted](on-sessions-inserted.html) | `abstract fun onSessionsInserted(position: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, count: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Called after updateSessions() when count number of sessions are inserted at the given position. | +| [onSessionsRemoved](on-sessions-removed.html) | `abstract fun onSessionsRemoved(position: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, count: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Called after updateSessions() when count number of sessions are removed from the given position. | +| [updateSessions](update-sessions.html) | `abstract fun updateSessions(sessions: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`, selectedIndex: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Updates the list of sessions. | + diff --git a/docs/api/0.21/concept-tabstray/mozilla.components.concept.tabstray/-tabs-tray/on-session-moved.md b/docs/api/0.21/concept-tabstray/mozilla.components.concept.tabstray/-tabs-tray/on-session-moved.md new file mode 100644 index 00000000000..263e04c498a --- /dev/null +++ b/docs/api/0.21/concept-tabstray/mozilla.components.concept.tabstray/-tabs-tray/on-session-moved.md @@ -0,0 +1,12 @@ +--- +title: TabsTray.onSessionMoved - +--- + +[mozilla.components.concept.tabstray](../index.html) / [TabsTray](index.html) / [onSessionMoved](./on-session-moved.html) + +# onSessionMoved + +`abstract fun onSessionMoved(fromPosition: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, toPosition: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Called after updateSessions() when a session changes it position. + diff --git a/docs/api/0.21/concept-tabstray/mozilla.components.concept.tabstray/-tabs-tray/on-sessions-changed.md b/docs/api/0.21/concept-tabstray/mozilla.components.concept.tabstray/-tabs-tray/on-sessions-changed.md new file mode 100644 index 00000000000..51e4b73cfbd --- /dev/null +++ b/docs/api/0.21/concept-tabstray/mozilla.components.concept.tabstray/-tabs-tray/on-sessions-changed.md @@ -0,0 +1,13 @@ +--- +title: TabsTray.onSessionsChanged - +--- + +[mozilla.components.concept.tabstray](../index.html) / [TabsTray](index.html) / [onSessionsChanged](./on-sessions-changed.html) + +# onSessionsChanged + +`abstract fun onSessionsChanged(position: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, count: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Called after updateSessions() when count number of sessions are updated at the +given position. + diff --git a/docs/api/0.21/concept-tabstray/mozilla.components.concept.tabstray/-tabs-tray/on-sessions-inserted.md b/docs/api/0.21/concept-tabstray/mozilla.components.concept.tabstray/-tabs-tray/on-sessions-inserted.md new file mode 100644 index 00000000000..19048344394 --- /dev/null +++ b/docs/api/0.21/concept-tabstray/mozilla.components.concept.tabstray/-tabs-tray/on-sessions-inserted.md @@ -0,0 +1,13 @@ +--- +title: TabsTray.onSessionsInserted - +--- + +[mozilla.components.concept.tabstray](../index.html) / [TabsTray](index.html) / [onSessionsInserted](./on-sessions-inserted.html) + +# onSessionsInserted + +`abstract fun onSessionsInserted(position: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, count: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Called after updateSessions() when count number of sessions are inserted at the +given position. + diff --git a/docs/api/0.21/concept-tabstray/mozilla.components.concept.tabstray/-tabs-tray/on-sessions-removed.md b/docs/api/0.21/concept-tabstray/mozilla.components.concept.tabstray/-tabs-tray/on-sessions-removed.md new file mode 100644 index 00000000000..58fedd73b5f --- /dev/null +++ b/docs/api/0.21/concept-tabstray/mozilla.components.concept.tabstray/-tabs-tray/on-sessions-removed.md @@ -0,0 +1,13 @@ +--- +title: TabsTray.onSessionsRemoved - +--- + +[mozilla.components.concept.tabstray](../index.html) / [TabsTray](index.html) / [onSessionsRemoved](./on-sessions-removed.html) + +# onSessionsRemoved + +`abstract fun onSessionsRemoved(position: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, count: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Called after updateSessions() when count number of sessions are removed from +the given position. + diff --git a/docs/api/0.21/concept-tabstray/mozilla.components.concept.tabstray/-tabs-tray/update-sessions.md b/docs/api/0.21/concept-tabstray/mozilla.components.concept.tabstray/-tabs-tray/update-sessions.md new file mode 100644 index 00000000000..ad4d5554f1c --- /dev/null +++ b/docs/api/0.21/concept-tabstray/mozilla.components.concept.tabstray/-tabs-tray/update-sessions.md @@ -0,0 +1,21 @@ +--- +title: TabsTray.updateSessions - +--- + +[mozilla.components.concept.tabstray](../index.html) / [TabsTray](index.html) / [updateSessions](./update-sessions.html) + +# updateSessions + +`abstract fun updateSessions(sessions: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`, selectedIndex: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Updates the list of sessions. + +Calling this method is usually followed by calling onSession*() methods to indicate what +exactly has changed. This allows the tabs tray implementation to animate between the old and +new state. + +### Parameters + +`sessions` - The list of sessions to be displayed. + +`selectedIndex` - The list index of the currently selected session. \ No newline at end of file diff --git a/docs/api/0.21/concept-tabstray/mozilla.components.concept.tabstray/index.md b/docs/api/0.21/concept-tabstray/mozilla.components.concept.tabstray/index.md new file mode 100644 index 00000000000..089197ab3fc --- /dev/null +++ b/docs/api/0.21/concept-tabstray/mozilla.components.concept.tabstray/index.md @@ -0,0 +1,12 @@ +--- +title: mozilla.components.concept.tabstray - +--- + +[mozilla.components.concept.tabstray](./index.html) + +## Package mozilla.components.concept.tabstray + +### Types + +| [TabsTray](-tabs-tray/index.html) | `interface TabsTray : Observable<`[`Observer`](-tabs-tray/-observer/index.html)`>`
Generic interface for components that provide "tabs tray" functionality. | + diff --git a/docs/api/0.21/concept-tabstray/package-list b/docs/api/0.21/concept-tabstray/package-list new file mode 100644 index 00000000000..b692280f6dc --- /dev/null +++ b/docs/api/0.21/concept-tabstray/package-list @@ -0,0 +1,4 @@ +$dokka.format:jekyll +$dokka.linkExtension:html + +mozilla.components.concept.tabstray diff --git a/docs/api/0.21/concept-toolbar/alltypes/index.md b/docs/api/0.21/concept-toolbar/alltypes/index.md new file mode 100644 index 00000000000..c7dd985fa62 --- /dev/null +++ b/docs/api/0.21/concept-toolbar/alltypes/index.md @@ -0,0 +1,8 @@ +--- +title: alltypes - +--- + +### All Types + +| [mozilla.components.concept.toolbar.Toolbar](../mozilla.components.concept.toolbar/-toolbar/index.html) | Interface to be implemented by components that provide browser toolbar functionality. | + diff --git a/docs/api/0.21/concept-toolbar/index.md b/docs/api/0.21/concept-toolbar/index.md new file mode 100644 index 00000000000..f3e8b6a07c2 --- /dev/null +++ b/docs/api/0.21/concept-toolbar/index.md @@ -0,0 +1,11 @@ +--- +title: +--- + +### Packages + +| [mozilla.components.concept.toolbar](mozilla.components.concept.toolbar/index.html) | | + +### Index + +[All Types](alltypes/index.html) \ No newline at end of file diff --git a/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action-button/-init-.md b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action-button/-init-.md new file mode 100644 index 00000000000..4d2deb863c0 --- /dev/null +++ b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action-button/-init-.md @@ -0,0 +1,23 @@ +--- +title: Toolbar.ActionButton. - +--- + +[mozilla.components.concept.toolbar](../../index.html) / [Toolbar](../index.html) / [ActionButton](index.html) / [<init>](./-init-.html) + +# <init> + +`ActionButton(@DrawableRes imageResource: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, contentDescription: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, visible: () -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = { true }, @DrawableRes background: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`? = null, listener: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`)` + +An action button to be added to the toolbar. + +### Parameters + +`imageResource` - The drawable to be shown. + +`contentDescription` - The content description to use. + +`visible` - Lambda that returns true or false to indicate whether this button should be shown. + +`background` - A custom (stateful) background drawable resource to be used. + +`listener` - Callback that will be invoked whenever the button is pressed \ No newline at end of file diff --git a/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action-button/bind.md b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action-button/bind.md new file mode 100644 index 00000000000..7f9f99bbfb2 --- /dev/null +++ b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action-button/bind.md @@ -0,0 +1,12 @@ +--- +title: Toolbar.ActionButton.bind - +--- + +[mozilla.components.concept.toolbar](../../index.html) / [Toolbar](../index.html) / [ActionButton](index.html) / [bind](./bind.html) + +# bind + +`open fun bind(view: View): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Overrides [Action.bind](../-action/bind.html) + diff --git a/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action-button/create-view.md b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action-button/create-view.md new file mode 100644 index 00000000000..347fc29551b --- /dev/null +++ b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action-button/create-view.md @@ -0,0 +1,12 @@ +--- +title: Toolbar.ActionButton.createView - +--- + +[mozilla.components.concept.toolbar](../../index.html) / [Toolbar](../index.html) / [ActionButton](index.html) / [createView](./create-view.html) + +# createView + +`open fun createView(parent: ViewGroup): View` + +Overrides [Action.createView](../-action/create-view.html) + diff --git a/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action-button/index.md b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action-button/index.md new file mode 100644 index 00000000000..4298548177f --- /dev/null +++ b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action-button/index.md @@ -0,0 +1,37 @@ +--- +title: Toolbar.ActionButton - +--- + +[mozilla.components.concept.toolbar](../../index.html) / [Toolbar](../index.html) / [ActionButton](./index.html) + +# ActionButton + +`open class ActionButton : `[`Action`](../-action/index.html) + +An action button to be added to the toolbar. + +### Parameters + +`imageResource` - The drawable to be shown. + +`contentDescription` - The content description to use. + +`visible` - Lambda that returns true or false to indicate whether this button should be shown. + +`background` - A custom (stateful) background drawable resource to be used. + +`listener` - Callback that will be invoked whenever the button is pressed + +### Constructors + +| [<init>](-init-.html) | `ActionButton(imageResource: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, contentDescription: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, visible: () -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = { true }, background: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`? = null, listener: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`)`
An action button to be added to the toolbar. | + +### Properties + +| [visible](visible.html) | `open val visible: () -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Lambda that returns true or false to indicate whether this button should be shown. | + +### Functions + +| [bind](bind.html) | `open fun bind(view: View): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [createView](create-view.html) | `open fun createView(parent: ViewGroup): View` | + diff --git a/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action-button/visible.md b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action-button/visible.md new file mode 100644 index 00000000000..34b7661faf9 --- /dev/null +++ b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action-button/visible.md @@ -0,0 +1,14 @@ +--- +title: Toolbar.ActionButton.visible - +--- + +[mozilla.components.concept.toolbar](../../index.html) / [Toolbar](../index.html) / [ActionButton](index.html) / [visible](./visible.html) + +# visible + +`open val visible: () -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Overrides [Action.visible](../-action/visible.html) + +Lambda that returns true or false to indicate whether this button should be shown. + diff --git a/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action-image/-init-.md b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action-image/-init-.md new file mode 100644 index 00000000000..d91d964ba28 --- /dev/null +++ b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action-image/-init-.md @@ -0,0 +1,19 @@ +--- +title: Toolbar.ActionImage. - +--- + +[mozilla.components.concept.toolbar](../../index.html) / [Toolbar](../index.html) / [ActionImage](index.html) / [<init>](./-init-.html) + +# <init> + +`ActionImage(@DrawableRes imageResource: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, contentDescription: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null)` + +An action that just shows a static, non-clickable image. + +### Parameters + +`imageResource` - The drawable to be shown. + +`contentDescription` - Optional content description to be used. If no content description + is provided then this view will be treated as not important for + accessibility. \ No newline at end of file diff --git a/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action-image/bind.md b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action-image/bind.md new file mode 100644 index 00000000000..e4ac572e4bc --- /dev/null +++ b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action-image/bind.md @@ -0,0 +1,12 @@ +--- +title: Toolbar.ActionImage.bind - +--- + +[mozilla.components.concept.toolbar](../../index.html) / [Toolbar](../index.html) / [ActionImage](index.html) / [bind](./bind.html) + +# bind + +`open fun bind(view: View): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Overrides [Action.bind](../-action/bind.html) + diff --git a/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action-image/create-view.md b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action-image/create-view.md new file mode 100644 index 00000000000..e955a59b1cd --- /dev/null +++ b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action-image/create-view.md @@ -0,0 +1,12 @@ +--- +title: Toolbar.ActionImage.createView - +--- + +[mozilla.components.concept.toolbar](../../index.html) / [Toolbar](../index.html) / [ActionImage](index.html) / [createView](./create-view.html) + +# createView + +`open fun createView(parent: ViewGroup): View` + +Overrides [Action.createView](../-action/create-view.html) + diff --git a/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action-image/index.md b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action-image/index.md new file mode 100644 index 00000000000..dc0fb9744b0 --- /dev/null +++ b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action-image/index.md @@ -0,0 +1,33 @@ +--- +title: Toolbar.ActionImage - +--- + +[mozilla.components.concept.toolbar](../../index.html) / [Toolbar](../index.html) / [ActionImage](./index.html) + +# ActionImage + +`open class ActionImage : `[`Action`](../-action/index.html) + +An action that just shows a static, non-clickable image. + +### Parameters + +`imageResource` - The drawable to be shown. + +`contentDescription` - Optional content description to be used. If no content description + is provided then this view will be treated as not important for + accessibility. + +### Constructors + +| [<init>](-init-.html) | `ActionImage(imageResource: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, contentDescription: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null)`
An action that just shows a static, non-clickable image. | + +### Inherited Properties + +| [visible](../-action/visible.html) | `open val visible: () -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | + +### Functions + +| [bind](bind.html) | `open fun bind(view: View): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [createView](create-view.html) | `open fun createView(parent: ViewGroup): View` | + diff --git a/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action-space/-init-.md b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action-space/-init-.md new file mode 100644 index 00000000000..353e19a95c8 --- /dev/null +++ b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action-space/-init-.md @@ -0,0 +1,15 @@ +--- +title: Toolbar.ActionSpace. - +--- + +[mozilla.components.concept.toolbar](../../index.html) / [Toolbar](../index.html) / [ActionSpace](index.html) / [<init>](./-init-.html) + +# <init> + +`ActionSpace(desiredWidth: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` + +An "empty" action with a desired width to be used as "placeholder". + +### Parameters + +`desiredWidth` - The desired width in density independent pixels for this action. \ No newline at end of file diff --git a/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action-space/bind.md b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action-space/bind.md new file mode 100644 index 00000000000..b478f88330a --- /dev/null +++ b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action-space/bind.md @@ -0,0 +1,12 @@ +--- +title: Toolbar.ActionSpace.bind - +--- + +[mozilla.components.concept.toolbar](../../index.html) / [Toolbar](../index.html) / [ActionSpace](index.html) / [bind](./bind.html) + +# bind + +`open fun bind(view: View): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Overrides [Action.bind](../-action/bind.html) + diff --git a/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action-space/create-view.md b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action-space/create-view.md new file mode 100644 index 00000000000..bdf0de984fb --- /dev/null +++ b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action-space/create-view.md @@ -0,0 +1,12 @@ +--- +title: Toolbar.ActionSpace.createView - +--- + +[mozilla.components.concept.toolbar](../../index.html) / [Toolbar](../index.html) / [ActionSpace](index.html) / [createView](./create-view.html) + +# createView + +`open fun createView(parent: ViewGroup): View` + +Overrides [Action.createView](../-action/create-view.html) + diff --git a/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action-space/index.md b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action-space/index.md new file mode 100644 index 00000000000..f4bc0af7174 --- /dev/null +++ b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action-space/index.md @@ -0,0 +1,29 @@ +--- +title: Toolbar.ActionSpace - +--- + +[mozilla.components.concept.toolbar](../../index.html) / [Toolbar](../index.html) / [ActionSpace](./index.html) + +# ActionSpace + +`open class ActionSpace : `[`Action`](../-action/index.html) + +An "empty" action with a desired width to be used as "placeholder". + +### Parameters + +`desiredWidth` - The desired width in density independent pixels for this action. + +### Constructors + +| [<init>](-init-.html) | `ActionSpace(desiredWidth: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)`
An "empty" action with a desired width to be used as "placeholder". | + +### Inherited Properties + +| [visible](../-action/visible.html) | `open val visible: () -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | + +### Functions + +| [bind](bind.html) | `open fun bind(view: View): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [createView](create-view.html) | `open fun createView(parent: ViewGroup): View` | + diff --git a/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action-toggle-button/-init-.md b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action-toggle-button/-init-.md new file mode 100644 index 00000000000..58638a7008b --- /dev/null +++ b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action-toggle-button/-init-.md @@ -0,0 +1,30 @@ +--- +title: Toolbar.ActionToggleButton. - +--- + +[mozilla.components.concept.toolbar](../../index.html) / [Toolbar](../index.html) / [ActionToggleButton](index.html) / [<init>](./-init-.html) + +# <init> + +`ActionToggleButton(@DrawableRes imageResource: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, @DrawableRes imageResourceSelected: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, contentDescription: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, contentDescriptionSelected: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, visible: () -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = { true }, selected: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, @DrawableRes background: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`? = null, listener: (`[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`)` + +An action button with two states, selected and unselected. When the button is pressed, the +state changes automatically. + +### Parameters + +`imageResource` - The drawable to be shown if the button is in unselected state. + +`imageResourceSelected` - The drawable to be shown if the button is in selected state. + +`contentDescription` - The content description to use if the button is in unselected state. + +`contentDescriptionSelected` - The content description to use if the button is in selected state. + +`visible` - Lambda that returns true or false to indicate whether this button should be shown. + +`selected` - Sets whether this button should be selected initially. + +`background` - A custom (stateful) background drawable resource to be used. + +`listener` - Callback that will be invoked whenever the checked state changes. \ No newline at end of file diff --git a/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action-toggle-button/bind.md b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action-toggle-button/bind.md new file mode 100644 index 00000000000..9cbbfeeb9da --- /dev/null +++ b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action-toggle-button/bind.md @@ -0,0 +1,12 @@ +--- +title: Toolbar.ActionToggleButton.bind - +--- + +[mozilla.components.concept.toolbar](../../index.html) / [Toolbar](../index.html) / [ActionToggleButton](index.html) / [bind](./bind.html) + +# bind + +`open fun bind(view: View): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Overrides [Action.bind](../-action/bind.html) + diff --git a/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action-toggle-button/create-view.md b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action-toggle-button/create-view.md new file mode 100644 index 00000000000..6285775e6ee --- /dev/null +++ b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action-toggle-button/create-view.md @@ -0,0 +1,12 @@ +--- +title: Toolbar.ActionToggleButton.createView - +--- + +[mozilla.components.concept.toolbar](../../index.html) / [Toolbar](../index.html) / [ActionToggleButton](index.html) / [createView](./create-view.html) + +# createView + +`open fun createView(parent: ViewGroup): View` + +Overrides [Action.createView](../-action/create-view.html) + diff --git a/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action-toggle-button/index.md b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action-toggle-button/index.md new file mode 100644 index 00000000000..37103bc428d --- /dev/null +++ b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action-toggle-button/index.md @@ -0,0 +1,47 @@ +--- +title: Toolbar.ActionToggleButton - +--- + +[mozilla.components.concept.toolbar](../../index.html) / [Toolbar](../index.html) / [ActionToggleButton](./index.html) + +# ActionToggleButton + +`open class ActionToggleButton : `[`Action`](../-action/index.html) + +An action button with two states, selected and unselected. When the button is pressed, the +state changes automatically. + +### Parameters + +`imageResource` - The drawable to be shown if the button is in unselected state. + +`imageResourceSelected` - The drawable to be shown if the button is in selected state. + +`contentDescription` - The content description to use if the button is in unselected state. + +`contentDescriptionSelected` - The content description to use if the button is in selected state. + +`visible` - Lambda that returns true or false to indicate whether this button should be shown. + +`selected` - Sets whether this button should be selected initially. + +`background` - A custom (stateful) background drawable resource to be used. + +`listener` - Callback that will be invoked whenever the checked state changes. + +### Constructors + +| [<init>](-init-.html) | `ActionToggleButton(imageResource: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, imageResourceSelected: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, contentDescription: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, contentDescriptionSelected: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, visible: () -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = { true }, selected: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, background: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`? = null, listener: (`[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`)`
An action button with two states, selected and unselected. When the button is pressed, the state changes automatically. | + +### Properties + +| [visible](visible.html) | `open val visible: () -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Lambda that returns true or false to indicate whether this button should be shown. | + +### Functions + +| [bind](bind.html) | `open fun bind(view: View): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [createView](create-view.html) | `open fun createView(parent: ViewGroup): View` | +| [isSelected](is-selected.html) | `fun isSelected(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Returns the current selected state of the action. | +| [setSelected](set-selected.html) | `fun setSelected(selected: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`, notifyListener: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = true): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Changes the selected state of the action. | +| [toggle](toggle.html) | `fun toggle(notifyListener: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = true): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Changes the selected state of the action to the inverse of its current state. | + diff --git a/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action-toggle-button/is-selected.md b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action-toggle-button/is-selected.md new file mode 100644 index 00000000000..e457821e46d --- /dev/null +++ b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action-toggle-button/is-selected.md @@ -0,0 +1,12 @@ +--- +title: Toolbar.ActionToggleButton.isSelected - +--- + +[mozilla.components.concept.toolbar](../../index.html) / [Toolbar](../index.html) / [ActionToggleButton](index.html) / [isSelected](./is-selected.html) + +# isSelected + +`fun isSelected(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Returns the current selected state of the action. + diff --git a/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action-toggle-button/set-selected.md b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action-toggle-button/set-selected.md new file mode 100644 index 00000000000..535b66d2ab9 --- /dev/null +++ b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action-toggle-button/set-selected.md @@ -0,0 +1,17 @@ +--- +title: Toolbar.ActionToggleButton.setSelected - +--- + +[mozilla.components.concept.toolbar](../../index.html) / [Toolbar](../index.html) / [ActionToggleButton](index.html) / [setSelected](./set-selected.html) + +# setSelected + +`fun setSelected(selected: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`, notifyListener: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = true): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Changes the selected state of the action. + +### Parameters + +`selected` - The new selected state + +`notifyListener` - If true (default) the listener will be notified about a state change. \ No newline at end of file diff --git a/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action-toggle-button/toggle.md b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action-toggle-button/toggle.md new file mode 100644 index 00000000000..2c21ae20501 --- /dev/null +++ b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action-toggle-button/toggle.md @@ -0,0 +1,15 @@ +--- +title: Toolbar.ActionToggleButton.toggle - +--- + +[mozilla.components.concept.toolbar](../../index.html) / [Toolbar](../index.html) / [ActionToggleButton](index.html) / [toggle](./toggle.html) + +# toggle + +`fun toggle(notifyListener: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = true): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Changes the selected state of the action to the inverse of its current state. + +### Parameters + +`notifyListener` - If true (default) the listener will be notified about the state change. \ No newline at end of file diff --git a/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action-toggle-button/visible.md b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action-toggle-button/visible.md new file mode 100644 index 00000000000..5a8acf6a035 --- /dev/null +++ b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action-toggle-button/visible.md @@ -0,0 +1,14 @@ +--- +title: Toolbar.ActionToggleButton.visible - +--- + +[mozilla.components.concept.toolbar](../../index.html) / [Toolbar](../index.html) / [ActionToggleButton](index.html) / [visible](./visible.html) + +# visible + +`open val visible: () -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Overrides [Action.visible](../-action/visible.html) + +Lambda that returns true or false to indicate whether this button should be shown. + diff --git a/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action/bind.md b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action/bind.md new file mode 100644 index 00000000000..f8c0f81fd69 --- /dev/null +++ b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action/bind.md @@ -0,0 +1,9 @@ +--- +title: Toolbar.Action.bind - +--- + +[mozilla.components.concept.toolbar](../../index.html) / [Toolbar](../index.html) / [Action](index.html) / [bind](./bind.html) + +# bind + +`abstract fun bind(view: View): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action/create-view.md b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action/create-view.md new file mode 100644 index 00000000000..3f4fcdaca19 --- /dev/null +++ b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action/create-view.md @@ -0,0 +1,9 @@ +--- +title: Toolbar.Action.createView - +--- + +[mozilla.components.concept.toolbar](../../index.html) / [Toolbar](../index.html) / [Action](index.html) / [createView](./create-view.html) + +# createView + +`abstract fun createView(parent: ViewGroup): View` \ No newline at end of file diff --git a/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action/index.md b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action/index.md new file mode 100644 index 00000000000..4547b92ab84 --- /dev/null +++ b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action/index.md @@ -0,0 +1,28 @@ +--- +title: Toolbar.Action - +--- + +[mozilla.components.concept.toolbar](../../index.html) / [Toolbar](../index.html) / [Action](./index.html) + +# Action + +`interface Action` + +Generic interface for actions to be added to the toolbar. + +### Properties + +| [visible](visible.html) | `open val visible: () -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | + +### Functions + +| [bind](bind.html) | `abstract fun bind(view: View): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [createView](create-view.html) | `abstract fun createView(parent: ViewGroup): View` | + +### Inheritors + +| [ActionButton](../-action-button/index.html) | `open class ActionButton : `[`Action`](./index.md)
An action button to be added to the toolbar. | +| [ActionImage](../-action-image/index.html) | `open class ActionImage : `[`Action`](./index.md)
An action that just shows a static, non-clickable image. | +| [ActionSpace](../-action-space/index.html) | `open class ActionSpace : `[`Action`](./index.md)
An "empty" action with a desired width to be used as "placeholder". | +| [ActionToggleButton](../-action-toggle-button/index.html) | `open class ActionToggleButton : `[`Action`](./index.md)
An action button with two states, selected and unselected. When the button is pressed, the state changes automatically. | + diff --git a/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action/visible.md b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action/visible.md new file mode 100644 index 00000000000..1bd40a2494b --- /dev/null +++ b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/-action/visible.md @@ -0,0 +1,9 @@ +--- +title: Toolbar.Action.visible - +--- + +[mozilla.components.concept.toolbar](../../index.html) / [Toolbar](../index.html) / [Action](index.html) / [visible](./visible.html) + +# visible + +`open val visible: () -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) \ No newline at end of file diff --git a/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/add-browser-action.md b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/add-browser-action.md new file mode 100644 index 00000000000..bc66bdda729 --- /dev/null +++ b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/add-browser-action.md @@ -0,0 +1,15 @@ +--- +title: Toolbar.addBrowserAction - +--- + +[mozilla.components.concept.toolbar](../index.html) / [Toolbar](index.html) / [addBrowserAction](./add-browser-action.html) + +# addBrowserAction + +`abstract fun addBrowserAction(action: `[`Action`](-action/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Adds an action to be displayed on the right side of the toolbar in display mode. + +Related: +https://developer.mozilla.org/en-US/Add-ons/WebExtensions/user_interface/Browser_action + diff --git a/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/add-navigation-action.md b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/add-navigation-action.md new file mode 100644 index 00000000000..78871f7a1c6 --- /dev/null +++ b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/add-navigation-action.md @@ -0,0 +1,12 @@ +--- +title: Toolbar.addNavigationAction - +--- + +[mozilla.components.concept.toolbar](../index.html) / [Toolbar](index.html) / [addNavigationAction](./add-navigation-action.html) + +# addNavigationAction + +`abstract fun addNavigationAction(action: `[`Action`](-action/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Adds an action to be displayed on the far left side of the URL in display mode. + diff --git a/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/add-page-action.md b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/add-page-action.md new file mode 100644 index 00000000000..116236d7259 --- /dev/null +++ b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/add-page-action.md @@ -0,0 +1,15 @@ +--- +title: Toolbar.addPageAction - +--- + +[mozilla.components.concept.toolbar](../index.html) / [Toolbar](index.html) / [addPageAction](./add-page-action.html) + +# addPageAction + +`abstract fun addPageAction(action: `[`Action`](-action/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Adds an action to be displayed on the right side of the URL in display mode. + +Related: +https://developer.mozilla.org/en-US/Add-ons/WebExtensions/user_interface/Page_actions + diff --git a/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/as-view.md b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/as-view.md new file mode 100644 index 00000000000..3dbd0dee730 --- /dev/null +++ b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/as-view.md @@ -0,0 +1,12 @@ +--- +title: Toolbar.asView - +--- + +[mozilla.components.concept.toolbar](../index.html) / [Toolbar](index.html) / [asView](./as-view.html) + +# asView + +`open fun asView(): View` + +Casts this toolbar to an Android View object. + diff --git a/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/display-progress.md b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/display-progress.md new file mode 100644 index 00000000000..37e61a4fe18 --- /dev/null +++ b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/display-progress.md @@ -0,0 +1,12 @@ +--- +title: Toolbar.displayProgress - +--- + +[mozilla.components.concept.toolbar](../index.html) / [Toolbar](index.html) / [displayProgress](./display-progress.html) + +# displayProgress + +`abstract fun displayProgress(progress: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Displays the given loading progress. Expects values in the range [0,100](#). + diff --git a/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/index.md b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/index.md new file mode 100644 index 00000000000..7e5fe21a69c --- /dev/null +++ b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/index.md @@ -0,0 +1,35 @@ +--- +title: Toolbar - +--- + +[mozilla.components.concept.toolbar](../index.html) / [Toolbar](./index.html) + +# Toolbar + +`interface Toolbar` + +Interface to be implemented by components that provide browser toolbar functionality. + +### Types + +| [Action](-action/index.html) | `interface Action`
Generic interface for actions to be added to the toolbar. | +| [ActionButton](-action-button/index.html) | `open class ActionButton : `[`Action`](-action/index.html)
An action button to be added to the toolbar. | +| [ActionImage](-action-image/index.html) | `open class ActionImage : `[`Action`](-action/index.html)
An action that just shows a static, non-clickable image. | +| [ActionSpace](-action-space/index.html) | `open class ActionSpace : `[`Action`](-action/index.html)
An "empty" action with a desired width to be used as "placeholder". | +| [ActionToggleButton](-action-toggle-button/index.html) | `open class ActionToggleButton : `[`Action`](-action/index.html)
An action button with two states, selected and unselected. When the button is pressed, the state changes automatically. | + +### Properties + +| [url](url.html) | `abstract var url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Sets/Gets the URL to be displayed on the toolbar. | + +### Functions + +| [addBrowserAction](add-browser-action.html) | `abstract fun addBrowserAction(action: `[`Action`](-action/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Adds an action to be displayed on the right side of the toolbar in display mode. | +| [addNavigationAction](add-navigation-action.html) | `abstract fun addNavigationAction(action: `[`Action`](-action/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Adds an action to be displayed on the far left side of the URL in display mode. | +| [addPageAction](add-page-action.html) | `abstract fun addPageAction(action: `[`Action`](-action/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Adds an action to be displayed on the right side of the URL in display mode. | +| [asView](as-view.html) | `open fun asView(): View`
Casts this toolbar to an Android View object. | +| [displayProgress](display-progress.html) | `abstract fun displayProgress(progress: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Displays the given loading progress. Expects values in the range [0,100](#). | +| [onBackPressed](on-back-pressed.html) | `abstract fun onBackPressed(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Should be called by an activity when the user pressed the back key of the device. | +| [setOnUrlCommitListener](set-on-url-commit-listener.html) | `abstract fun setOnUrlCommitListener(listener: (`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Registers the given function to be invoked when the user selected a new URL i.e. is done editing. | +| [setSearchTerms](set-search-terms.html) | `abstract fun setSearchTerms(searchTerms: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Displays the currently used search terms as part of this Toolbar. | + diff --git a/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/on-back-pressed.md b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/on-back-pressed.md new file mode 100644 index 00000000000..b48b6c8d071 --- /dev/null +++ b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/on-back-pressed.md @@ -0,0 +1,15 @@ +--- +title: Toolbar.onBackPressed - +--- + +[mozilla.components.concept.toolbar](../index.html) / [Toolbar](index.html) / [onBackPressed](./on-back-pressed.html) + +# onBackPressed + +`abstract fun onBackPressed(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Should be called by an activity when the user pressed the back key of the device. + +**Return** +Returns true if the back press event was handled and should not be propagated further. + diff --git a/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/set-on-url-commit-listener.md b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/set-on-url-commit-listener.md new file mode 100644 index 00000000000..c832b434a1e --- /dev/null +++ b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/set-on-url-commit-listener.md @@ -0,0 +1,16 @@ +--- +title: Toolbar.setOnUrlCommitListener - +--- + +[mozilla.components.concept.toolbar](../index.html) / [Toolbar](index.html) / [setOnUrlCommitListener](./set-on-url-commit-listener.html) + +# setOnUrlCommitListener + +`abstract fun setOnUrlCommitListener(listener: (`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Registers the given function to be invoked when the user selected a new URL i.e. is done +editing. + +### Parameters + +`listener` - the listener function \ No newline at end of file diff --git a/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/set-search-terms.md b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/set-search-terms.md new file mode 100644 index 00000000000..f50d3afe747 --- /dev/null +++ b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/set-search-terms.md @@ -0,0 +1,15 @@ +--- +title: Toolbar.setSearchTerms - +--- + +[mozilla.components.concept.toolbar](../index.html) / [Toolbar](index.html) / [setSearchTerms](./set-search-terms.html) + +# setSearchTerms + +`abstract fun setSearchTerms(searchTerms: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Displays the currently used search terms as part of this Toolbar. + +### Parameters + +`searchTerms` - the search terms used by the current session \ No newline at end of file diff --git a/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/url.md b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/url.md new file mode 100644 index 00000000000..fce31e35eeb --- /dev/null +++ b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/-toolbar/url.md @@ -0,0 +1,12 @@ +--- +title: Toolbar.url - +--- + +[mozilla.components.concept.toolbar](../index.html) / [Toolbar](index.html) / [url](./url.html) + +# url + +`abstract var url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) + +Sets/Gets the URL to be displayed on the toolbar. + diff --git a/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/index.md b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/index.md new file mode 100644 index 00000000000..55e9871b689 --- /dev/null +++ b/docs/api/0.21/concept-toolbar/mozilla.components.concept.toolbar/index.md @@ -0,0 +1,12 @@ +--- +title: mozilla.components.concept.toolbar - +--- + +[mozilla.components.concept.toolbar](./index.html) + +## Package mozilla.components.concept.toolbar + +### Types + +| [Toolbar](-toolbar/index.html) | `interface Toolbar`
Interface to be implemented by components that provide browser toolbar functionality. | + diff --git a/docs/api/0.21/concept-toolbar/package-list b/docs/api/0.21/concept-toolbar/package-list new file mode 100644 index 00000000000..1ffe456672b --- /dev/null +++ b/docs/api/0.21/concept-toolbar/package-list @@ -0,0 +1,4 @@ +$dokka.format:jekyll +$dokka.linkExtension:html + +mozilla.components.concept.toolbar diff --git a/docs/api/0.21/feature-search/alltypes/index.md b/docs/api/0.21/feature-search/alltypes/index.md new file mode 100644 index 00000000000..29f02b1b2cd --- /dev/null +++ b/docs/api/0.21/feature-search/alltypes/index.md @@ -0,0 +1,8 @@ +--- +title: alltypes - +--- + +### All Types + +| [mozilla.components.feature.search.SearchUseCases](../mozilla.components.feature.search/-search-use-cases/index.html) | Contains use cases related to the search feature. | + diff --git a/docs/api/0.21/feature-search/index.md b/docs/api/0.21/feature-search/index.md new file mode 100644 index 00000000000..eb42ec80f4f --- /dev/null +++ b/docs/api/0.21/feature-search/index.md @@ -0,0 +1,11 @@ +--- +title: +--- + +### Packages + +| [mozilla.components.feature.search](mozilla.components.feature.search/index.html) | | + +### Index + +[All Types](alltypes/index.html) \ No newline at end of file diff --git a/docs/api/0.21/feature-search/mozilla.components.feature.search/-search-use-cases/-default-search-url-use-case/-init-.md b/docs/api/0.21/feature-search/mozilla.components.feature.search/-search-use-cases/-default-search-url-use-case/-init-.md new file mode 100644 index 00000000000..1ab559795ed --- /dev/null +++ b/docs/api/0.21/feature-search/mozilla.components.feature.search/-search-use-cases/-default-search-url-use-case/-init-.md @@ -0,0 +1,9 @@ +--- +title: SearchUseCases.DefaultSearchUrlUseCase. - +--- + +[mozilla.components.feature.search](../../index.html) / [SearchUseCases](../index.html) / [DefaultSearchUrlUseCase](index.html) / [<init>](./-init-.html) + +# <init> + +`DefaultSearchUrlUseCase(context: Context, searchEngineManager: SearchEngineManager, sessionManager: SessionManager)` \ No newline at end of file diff --git a/docs/api/0.21/feature-search/mozilla.components.feature.search/-search-use-cases/-default-search-url-use-case/index.md b/docs/api/0.21/feature-search/mozilla.components.feature.search/-search-use-cases/-default-search-url-use-case/index.md new file mode 100644 index 00000000000..542a02a59c8 --- /dev/null +++ b/docs/api/0.21/feature-search/mozilla.components.feature.search/-search-use-cases/-default-search-url-use-case/index.md @@ -0,0 +1,18 @@ +--- +title: SearchUseCases.DefaultSearchUrlUseCase - +--- + +[mozilla.components.feature.search](../../index.html) / [SearchUseCases](../index.html) / [DefaultSearchUrlUseCase](./index.html) + +# DefaultSearchUrlUseCase + +`class DefaultSearchUrlUseCase` + +### Constructors + +| [<init>](-init-.html) | `DefaultSearchUrlUseCase(context: Context, searchEngineManager: SearchEngineManager, sessionManager: SessionManager)` | + +### Functions + +| [invoke](invoke.html) | `fun invoke(searchTerms: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, session: Session = sessionManager.selectedSessionOrThrow): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Triggers a search using the default search engine for the provided search terms. | + diff --git a/docs/api/0.21/feature-search/mozilla.components.feature.search/-search-use-cases/-default-search-url-use-case/invoke.md b/docs/api/0.21/feature-search/mozilla.components.feature.search/-search-use-cases/-default-search-url-use-case/invoke.md new file mode 100644 index 00000000000..7c88533536b --- /dev/null +++ b/docs/api/0.21/feature-search/mozilla.components.feature.search/-search-use-cases/-default-search-url-use-case/invoke.md @@ -0,0 +1,18 @@ +--- +title: SearchUseCases.DefaultSearchUrlUseCase.invoke - +--- + +[mozilla.components.feature.search](../../index.html) / [SearchUseCases](../index.html) / [DefaultSearchUrlUseCase](index.html) / [invoke](./invoke.html) + +# invoke + +`fun invoke(searchTerms: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, session: Session = sessionManager.selectedSessionOrThrow): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Triggers a search using the default search engine for the provided search terms. + +### Parameters + +`searchTerms` - the search terms. + +`session` - the session to use, or the currently selected session if none +is provided. \ No newline at end of file diff --git a/docs/api/0.21/feature-search/mozilla.components.feature.search/-search-use-cases/-init-.md b/docs/api/0.21/feature-search/mozilla.components.feature.search/-search-use-cases/-init-.md new file mode 100644 index 00000000000..ff823ceb710 --- /dev/null +++ b/docs/api/0.21/feature-search/mozilla.components.feature.search/-search-use-cases/-init-.md @@ -0,0 +1,12 @@ +--- +title: SearchUseCases. - +--- + +[mozilla.components.feature.search](../index.html) / [SearchUseCases](index.html) / [<init>](./-init-.html) + +# <init> + +`SearchUseCases(context: Context, searchEngineManager: SearchEngineManager, sessionManager: SessionManager)` + +Contains use cases related to the search feature. + diff --git a/docs/api/0.21/feature-search/mozilla.components.feature.search/-search-use-cases/default-search.md b/docs/api/0.21/feature-search/mozilla.components.feature.search/-search-use-cases/default-search.md new file mode 100644 index 00000000000..add0134e16e --- /dev/null +++ b/docs/api/0.21/feature-search/mozilla.components.feature.search/-search-use-cases/default-search.md @@ -0,0 +1,9 @@ +--- +title: SearchUseCases.defaultSearch - +--- + +[mozilla.components.feature.search](../index.html) / [SearchUseCases](index.html) / [defaultSearch](./default-search.html) + +# defaultSearch + +`val defaultSearch: `[`DefaultSearchUrlUseCase`](-default-search-url-use-case/index.html) \ No newline at end of file diff --git a/docs/api/0.21/feature-search/mozilla.components.feature.search/-search-use-cases/index.md b/docs/api/0.21/feature-search/mozilla.components.feature.search/-search-use-cases/index.md new file mode 100644 index 00000000000..3b23375a4a3 --- /dev/null +++ b/docs/api/0.21/feature-search/mozilla.components.feature.search/-search-use-cases/index.md @@ -0,0 +1,24 @@ +--- +title: SearchUseCases - +--- + +[mozilla.components.feature.search](../index.html) / [SearchUseCases](./index.html) + +# SearchUseCases + +`class SearchUseCases` + +Contains use cases related to the search feature. + +### Types + +| [DefaultSearchUrlUseCase](-default-search-url-use-case/index.html) | `class DefaultSearchUrlUseCase` | + +### Constructors + +| [<init>](-init-.html) | `SearchUseCases(context: Context, searchEngineManager: SearchEngineManager, sessionManager: SessionManager)`
Contains use cases related to the search feature. | + +### Properties + +| [defaultSearch](default-search.html) | `val defaultSearch: `[`DefaultSearchUrlUseCase`](-default-search-url-use-case/index.html) | + diff --git a/docs/api/0.21/feature-search/mozilla.components.feature.search/index.md b/docs/api/0.21/feature-search/mozilla.components.feature.search/index.md new file mode 100644 index 00000000000..963839d269d --- /dev/null +++ b/docs/api/0.21/feature-search/mozilla.components.feature.search/index.md @@ -0,0 +1,12 @@ +--- +title: mozilla.components.feature.search - +--- + +[mozilla.components.feature.search](./index.html) + +## Package mozilla.components.feature.search + +### Types + +| [SearchUseCases](-search-use-cases/index.html) | `class SearchUseCases`
Contains use cases related to the search feature. | + diff --git a/docs/api/0.21/feature-search/package-list b/docs/api/0.21/feature-search/package-list new file mode 100644 index 00000000000..cafcc6d1da8 --- /dev/null +++ b/docs/api/0.21/feature-search/package-list @@ -0,0 +1,4 @@ +$dokka.format:jekyll +$dokka.linkExtension:html + +mozilla.components.feature.search diff --git a/docs/api/0.21/feature-session/alltypes/index.md b/docs/api/0.21/feature-session/alltypes/index.md new file mode 100644 index 00000000000..48ce6cc9435 --- /dev/null +++ b/docs/api/0.21/feature-session/alltypes/index.md @@ -0,0 +1,12 @@ +--- +title: alltypes - +--- + +### All Types + +| [mozilla.components.feature.session.EngineViewPresenter](../mozilla.components.feature.session/-engine-view-presenter/index.html) | Presenter implementation for EngineView. | +| [mozilla.components.feature.session.IntentHandler](../mozilla.components.feature.session/-intent-handler.html) | | +| [mozilla.components.feature.session.SessionFeature](../mozilla.components.feature.session/-session-feature/index.html) | Feature implementation for connecting the engine module with the session module. | +| [mozilla.components.feature.session.SessionIntentProcessor](../mozilla.components.feature.session/-session-intent-processor/index.html) | Processor for intents which should trigger session-related actions. | +| [mozilla.components.feature.session.SessionUseCases](../mozilla.components.feature.session/-session-use-cases/index.html) | Contains use cases related to the session feature. | + diff --git a/docs/api/0.21/feature-session/index.md b/docs/api/0.21/feature-session/index.md new file mode 100644 index 00000000000..91a1df2fd3c --- /dev/null +++ b/docs/api/0.21/feature-session/index.md @@ -0,0 +1,11 @@ +--- +title: +--- + +### Packages + +| [mozilla.components.feature.session](mozilla.components.feature.session/index.html) | | + +### Index + +[All Types](alltypes/index.html) \ No newline at end of file diff --git a/docs/api/0.21/feature-session/mozilla.components.feature.session/-engine-view-presenter/-init-.md b/docs/api/0.21/feature-session/mozilla.components.feature.session/-engine-view-presenter/-init-.md new file mode 100644 index 00000000000..14b380e1031 --- /dev/null +++ b/docs/api/0.21/feature-session/mozilla.components.feature.session/-engine-view-presenter/-init-.md @@ -0,0 +1,12 @@ +--- +title: EngineViewPresenter. - +--- + +[mozilla.components.feature.session](../index.html) / [EngineViewPresenter](index.html) / [<init>](./-init-.html) + +# <init> + +`EngineViewPresenter(sessionManager: SessionManager, engineView: EngineView, sessionId: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null)` + +Presenter implementation for EngineView. + diff --git a/docs/api/0.21/feature-session/mozilla.components.feature.session/-engine-view-presenter/index.md b/docs/api/0.21/feature-session/mozilla.components.feature.session/-engine-view-presenter/index.md new file mode 100644 index 00000000000..efe0c80bf83 --- /dev/null +++ b/docs/api/0.21/feature-session/mozilla.components.feature.session/-engine-view-presenter/index.md @@ -0,0 +1,22 @@ +--- +title: EngineViewPresenter - +--- + +[mozilla.components.feature.session](../index.html) / [EngineViewPresenter](./index.html) + +# EngineViewPresenter + +`class EngineViewPresenter : Observer` + +Presenter implementation for EngineView. + +### Constructors + +| [<init>](-init-.html) | `EngineViewPresenter(sessionManager: SessionManager, engineView: EngineView, sessionId: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null)`
Presenter implementation for EngineView. | + +### Functions + +| [onSessionSelected](on-session-selected.html) | `fun onSessionSelected(session: Session): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
A new session has been selected: Render it on an EngineView. | +| [start](start.html) | `fun start(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Start presenter and display data in view. | +| [stop](stop.html) | `fun stop(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Stop presenter from updating view. | + diff --git a/docs/api/0.21/feature-session/mozilla.components.feature.session/-engine-view-presenter/on-session-selected.md b/docs/api/0.21/feature-session/mozilla.components.feature.session/-engine-view-presenter/on-session-selected.md new file mode 100644 index 00000000000..053553cef06 --- /dev/null +++ b/docs/api/0.21/feature-session/mozilla.components.feature.session/-engine-view-presenter/on-session-selected.md @@ -0,0 +1,12 @@ +--- +title: EngineViewPresenter.onSessionSelected - +--- + +[mozilla.components.feature.session](../index.html) / [EngineViewPresenter](index.html) / [onSessionSelected](./on-session-selected.html) + +# onSessionSelected + +`fun onSessionSelected(session: Session): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +A new session has been selected: Render it on an EngineView. + diff --git a/docs/api/0.21/feature-session/mozilla.components.feature.session/-engine-view-presenter/start.md b/docs/api/0.21/feature-session/mozilla.components.feature.session/-engine-view-presenter/start.md new file mode 100644 index 00000000000..b414e53c608 --- /dev/null +++ b/docs/api/0.21/feature-session/mozilla.components.feature.session/-engine-view-presenter/start.md @@ -0,0 +1,12 @@ +--- +title: EngineViewPresenter.start - +--- + +[mozilla.components.feature.session](../index.html) / [EngineViewPresenter](index.html) / [start](./start.html) + +# start + +`fun start(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Start presenter and display data in view. + diff --git a/docs/api/0.21/feature-session/mozilla.components.feature.session/-engine-view-presenter/stop.md b/docs/api/0.21/feature-session/mozilla.components.feature.session/-engine-view-presenter/stop.md new file mode 100644 index 00000000000..b06a0b8d3af --- /dev/null +++ b/docs/api/0.21/feature-session/mozilla.components.feature.session/-engine-view-presenter/stop.md @@ -0,0 +1,12 @@ +--- +title: EngineViewPresenter.stop - +--- + +[mozilla.components.feature.session](../index.html) / [EngineViewPresenter](index.html) / [stop](./stop.html) + +# stop + +`fun stop(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Stop presenter from updating view. + diff --git a/docs/api/0.21/feature-session/mozilla.components.feature.session/-intent-handler.md b/docs/api/0.21/feature-session/mozilla.components.feature.session/-intent-handler.md new file mode 100644 index 00000000000..3ae6dbe9e5b --- /dev/null +++ b/docs/api/0.21/feature-session/mozilla.components.feature.session/-intent-handler.md @@ -0,0 +1,9 @@ +--- +title: IntentHandler - +--- + +[mozilla.components.feature.session](index.html) / [IntentHandler](./-intent-handler.html) + +# IntentHandler + +`typealias IntentHandler = (Intent) -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) \ No newline at end of file diff --git a/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-feature/-init-.md b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-feature/-init-.md new file mode 100644 index 00000000000..37229f92ad0 --- /dev/null +++ b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-feature/-init-.md @@ -0,0 +1,12 @@ +--- +title: SessionFeature. - +--- + +[mozilla.components.feature.session](../index.html) / [SessionFeature](index.html) / [<init>](./-init-.html) + +# <init> + +`SessionFeature(sessionManager: SessionManager, sessionUseCases: `[`SessionUseCases`](../-session-use-cases/index.html)`, engineView: EngineView, sessionStorage: SessionStorage? = null, sessionId: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null)` + +Feature implementation for connecting the engine module with the session module. + diff --git a/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-feature/handle-back-pressed.md b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-feature/handle-back-pressed.md new file mode 100644 index 00000000000..28b7ea74d32 --- /dev/null +++ b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-feature/handle-back-pressed.md @@ -0,0 +1,15 @@ +--- +title: SessionFeature.handleBackPressed - +--- + +[mozilla.components.feature.session](../index.html) / [SessionFeature](index.html) / [handleBackPressed](./handle-back-pressed.html) + +# handleBackPressed + +`fun handleBackPressed(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Handler for back pressed events in activities that use this feature. + +**Return** +true if the event was handled, otherwise false. + diff --git a/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-feature/index.md b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-feature/index.md new file mode 100644 index 00000000000..a12a7be7b4d --- /dev/null +++ b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-feature/index.md @@ -0,0 +1,22 @@ +--- +title: SessionFeature - +--- + +[mozilla.components.feature.session](../index.html) / [SessionFeature](./index.html) + +# SessionFeature + +`class SessionFeature` + +Feature implementation for connecting the engine module with the session module. + +### Constructors + +| [<init>](-init-.html) | `SessionFeature(sessionManager: SessionManager, sessionUseCases: `[`SessionUseCases`](../-session-use-cases/index.html)`, engineView: EngineView, sessionStorage: SessionStorage? = null, sessionId: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null)`
Feature implementation for connecting the engine module with the session module. | + +### Functions + +| [handleBackPressed](handle-back-pressed.html) | `fun handleBackPressed(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Handler for back pressed events in activities that use this feature. | +| [start](start.html) | `fun start(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Start feature: App is in the foreground. | +| [stop](stop.html) | `fun stop(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Stop feature: App is in the background. | + diff --git a/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-feature/start.md b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-feature/start.md new file mode 100644 index 00000000000..5bb9d61b849 --- /dev/null +++ b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-feature/start.md @@ -0,0 +1,12 @@ +--- +title: SessionFeature.start - +--- + +[mozilla.components.feature.session](../index.html) / [SessionFeature](index.html) / [start](./start.html) + +# start + +`fun start(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Start feature: App is in the foreground. + diff --git a/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-feature/stop.md b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-feature/stop.md new file mode 100644 index 00000000000..dcd76f3d566 --- /dev/null +++ b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-feature/stop.md @@ -0,0 +1,12 @@ +--- +title: SessionFeature.stop - +--- + +[mozilla.components.feature.session](../index.html) / [SessionFeature](index.html) / [stop](./stop.html) + +# stop + +`fun stop(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Stop feature: App is in the background. + diff --git a/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-intent-processor/-a-c-t-i-v-e_-s-e-s-s-i-o-n_-i-d.md b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-intent-processor/-a-c-t-i-v-e_-s-e-s-s-i-o-n_-i-d.md new file mode 100644 index 00000000000..17847ea49c4 --- /dev/null +++ b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-intent-processor/-a-c-t-i-v-e_-s-e-s-s-i-o-n_-i-d.md @@ -0,0 +1,9 @@ +--- +title: SessionIntentProcessor.ACTIVE_SESSION_ID - +--- + +[mozilla.components.feature.session](../index.html) / [SessionIntentProcessor](index.html) / [ACTIVE_SESSION_ID](./-a-c-t-i-v-e_-s-e-s-s-i-o-n_-i-d.html) + +# ACTIVE_SESSION_ID + +`const val ACTIVE_SESSION_ID: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) \ No newline at end of file diff --git a/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-intent-processor/-init-.md b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-intent-processor/-init-.md new file mode 100644 index 00000000000..1fd86adabee --- /dev/null +++ b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-intent-processor/-init-.md @@ -0,0 +1,16 @@ +--- +title: SessionIntentProcessor. - +--- + +[mozilla.components.feature.session](../index.html) / [SessionIntentProcessor](index.html) / [<init>](./-init-.html) + +# <init> + +`SessionIntentProcessor(sessionUseCases: `[`SessionUseCases`](../-session-use-cases/index.html)`, sessionManager: SessionManager, useDefaultHandlers: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = true, openNewTab: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = true)` + +Processor for intents which should trigger session-related actions. + +### Parameters + +`openNewTab` - Whether a processed Intent should open a new tab or open URLs in the currently + selected tab. \ No newline at end of file diff --git a/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-intent-processor/index.md b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-intent-processor/index.md new file mode 100644 index 00000000000..9a531753d7b --- /dev/null +++ b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-intent-processor/index.md @@ -0,0 +1,31 @@ +--- +title: SessionIntentProcessor - +--- + +[mozilla.components.feature.session](../index.html) / [SessionIntentProcessor](./index.html) + +# SessionIntentProcessor + +`class SessionIntentProcessor` + +Processor for intents which should trigger session-related actions. + +### Parameters + +`openNewTab` - Whether a processed Intent should open a new tab or open URLs in the currently + selected tab. + +### Constructors + +| [<init>](-init-.html) | `SessionIntentProcessor(sessionUseCases: `[`SessionUseCases`](../-session-use-cases/index.html)`, sessionManager: SessionManager, useDefaultHandlers: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = true, openNewTab: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = true)`
Processor for intents which should trigger session-related actions. | + +### Functions + +| [process](process.html) | `fun process(intent: Intent): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Processes the given intent by invoking the registered handler. | +| [registerHandler](register-handler.html) | `fun registerHandler(action: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, handler: `[`IntentHandler`](../-intent-handler.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Registers the given handler to be invoked for intents with the given action. If a handler is already present it will be overwritten. | +| [unregisterHandler](unregister-handler.html) | `fun unregisterHandler(action: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Removes the registered handler for the given intent action, if present. | + +### Companion Object Properties + +| [ACTIVE_SESSION_ID](-a-c-t-i-v-e_-s-e-s-s-i-o-n_-i-d.html) | `const val ACTIVE_SESSION_ID: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + diff --git a/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-intent-processor/process.md b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-intent-processor/process.md new file mode 100644 index 00000000000..18bede45e79 --- /dev/null +++ b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-intent-processor/process.md @@ -0,0 +1,19 @@ +--- +title: SessionIntentProcessor.process - +--- + +[mozilla.components.feature.session](../index.html) / [SessionIntentProcessor](index.html) / [process](./process.html) + +# process + +`fun process(intent: Intent): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Processes the given intent by invoking the registered handler. + +### Parameters + +`intent` - the intent to process + +**Return** +true if the intent was processed, otherwise false. + diff --git a/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-intent-processor/register-handler.md b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-intent-processor/register-handler.md new file mode 100644 index 00000000000..6168b39e390 --- /dev/null +++ b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-intent-processor/register-handler.md @@ -0,0 +1,18 @@ +--- +title: SessionIntentProcessor.registerHandler - +--- + +[mozilla.components.feature.session](../index.html) / [SessionIntentProcessor](index.html) / [registerHandler](./register-handler.html) + +# registerHandler + +`fun registerHandler(action: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, handler: `[`IntentHandler`](../-intent-handler.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Registers the given handler to be invoked for intents with the given action. If a +handler is already present it will be overwritten. + +### Parameters + +`action` - the intent action which should trigger the provided handler. + +`handler` - the intent handler to be registered. \ No newline at end of file diff --git a/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-intent-processor/unregister-handler.md b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-intent-processor/unregister-handler.md new file mode 100644 index 00000000000..ef4d3d3691c --- /dev/null +++ b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-intent-processor/unregister-handler.md @@ -0,0 +1,15 @@ +--- +title: SessionIntentProcessor.unregisterHandler - +--- + +[mozilla.components.feature.session](../index.html) / [SessionIntentProcessor](index.html) / [unregisterHandler](./unregister-handler.html) + +# unregisterHandler + +`fun unregisterHandler(action: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Removes the registered handler for the given intent action, if present. + +### Parameters + +`action` - the intent action for which the handler should be removed. \ No newline at end of file diff --git a/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/-go-back-use-case/index.md b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/-go-back-use-case/index.md new file mode 100644 index 00000000000..eb4c49a770e --- /dev/null +++ b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/-go-back-use-case/index.md @@ -0,0 +1,14 @@ +--- +title: SessionUseCases.GoBackUseCase - +--- + +[mozilla.components.feature.session](../../index.html) / [SessionUseCases](../index.html) / [GoBackUseCase](./index.html) + +# GoBackUseCase + +`class GoBackUseCase` + +### Functions + +| [invoke](invoke.html) | `fun invoke(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Navigates back in the history of the currently selected session | + diff --git a/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/-go-back-use-case/invoke.md b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/-go-back-use-case/invoke.md new file mode 100644 index 00000000000..2251fdb324a --- /dev/null +++ b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/-go-back-use-case/invoke.md @@ -0,0 +1,12 @@ +--- +title: SessionUseCases.GoBackUseCase.invoke - +--- + +[mozilla.components.feature.session](../../index.html) / [SessionUseCases](../index.html) / [GoBackUseCase](index.html) / [invoke](./invoke.html) + +# invoke + +`fun invoke(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Navigates back in the history of the currently selected session + diff --git a/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/-go-forward-use-case/index.md b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/-go-forward-use-case/index.md new file mode 100644 index 00000000000..5746049ecc5 --- /dev/null +++ b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/-go-forward-use-case/index.md @@ -0,0 +1,14 @@ +--- +title: SessionUseCases.GoForwardUseCase - +--- + +[mozilla.components.feature.session](../../index.html) / [SessionUseCases](../index.html) / [GoForwardUseCase](./index.html) + +# GoForwardUseCase + +`class GoForwardUseCase` + +### Functions + +| [invoke](invoke.html) | `fun invoke(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Navigates forward in the history of the currently selected session | + diff --git a/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/-go-forward-use-case/invoke.md b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/-go-forward-use-case/invoke.md new file mode 100644 index 00000000000..b360c7ec4c1 --- /dev/null +++ b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/-go-forward-use-case/invoke.md @@ -0,0 +1,12 @@ +--- +title: SessionUseCases.GoForwardUseCase.invoke - +--- + +[mozilla.components.feature.session](../../index.html) / [SessionUseCases](../index.html) / [GoForwardUseCase](index.html) / [invoke](./invoke.html) + +# invoke + +`fun invoke(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Navigates forward in the history of the currently selected session + diff --git a/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/-init-.md b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/-init-.md new file mode 100644 index 00000000000..3e2157ad6a5 --- /dev/null +++ b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/-init-.md @@ -0,0 +1,12 @@ +--- +title: SessionUseCases. - +--- + +[mozilla.components.feature.session](../index.html) / [SessionUseCases](index.html) / [<init>](./-init-.html) + +# <init> + +`SessionUseCases(sessionManager: SessionManager)` + +Contains use cases related to the session feature. + diff --git a/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/-load-data-use-case/index.md b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/-load-data-use-case/index.md new file mode 100644 index 00000000000..a220ea6ad8e --- /dev/null +++ b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/-load-data-use-case/index.md @@ -0,0 +1,14 @@ +--- +title: SessionUseCases.LoadDataUseCase - +--- + +[mozilla.components.feature.session](../../index.html) / [SessionUseCases](../index.html) / [LoadDataUseCase](./index.html) + +# LoadDataUseCase + +`class LoadDataUseCase` + +### Functions + +| [invoke](invoke.html) | `fun invoke(data: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, mimeType: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, encoding: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = "UTF-8", session: Session = sessionManager.selectedSessionOrThrow): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Loads the provided data based on the mime type using the provided session (or the currently selected session if none is provided). | + diff --git a/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/-load-data-use-case/invoke.md b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/-load-data-use-case/invoke.md new file mode 100644 index 00000000000..649d00c2be5 --- /dev/null +++ b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/-load-data-use-case/invoke.md @@ -0,0 +1,13 @@ +--- +title: SessionUseCases.LoadDataUseCase.invoke - +--- + +[mozilla.components.feature.session](../../index.html) / [SessionUseCases](../index.html) / [LoadDataUseCase](index.html) / [invoke](./invoke.html) + +# invoke + +`fun invoke(data: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, mimeType: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, encoding: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = "UTF-8", session: Session = sessionManager.selectedSessionOrThrow): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Loads the provided data based on the mime type using the provided session (or the +currently selected session if none is provided). + diff --git a/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/-load-url-use-case/index.md b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/-load-url-use-case/index.md new file mode 100644 index 00000000000..87f06d6c050 --- /dev/null +++ b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/-load-url-use-case/index.md @@ -0,0 +1,14 @@ +--- +title: SessionUseCases.LoadUrlUseCase - +--- + +[mozilla.components.feature.session](../../index.html) / [SessionUseCases](../index.html) / [LoadUrlUseCase](./index.html) + +# LoadUrlUseCase + +`class LoadUrlUseCase` + +### Functions + +| [invoke](invoke.html) | `fun invoke(url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, session: Session = sessionManager.selectedSessionOrThrow): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Loads the provided URL using the provided session (or the currently selected session if none is provided). | + diff --git a/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/-load-url-use-case/invoke.md b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/-load-url-use-case/invoke.md new file mode 100644 index 00000000000..bf56ac77b42 --- /dev/null +++ b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/-load-url-use-case/invoke.md @@ -0,0 +1,18 @@ +--- +title: SessionUseCases.LoadUrlUseCase.invoke - +--- + +[mozilla.components.feature.session](../../index.html) / [SessionUseCases](../index.html) / [LoadUrlUseCase](index.html) / [invoke](./invoke.html) + +# invoke + +`fun invoke(url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, session: Session = sessionManager.selectedSessionOrThrow): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Loads the provided URL using the provided session (or the currently +selected session if none is provided). + +### Parameters + +`url` - url to load. + +`session` - the session for which the URL should be loaded. \ No newline at end of file diff --git a/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/-reload-url-use-case/index.md b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/-reload-url-use-case/index.md new file mode 100644 index 00000000000..3a225eae8e7 --- /dev/null +++ b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/-reload-url-use-case/index.md @@ -0,0 +1,14 @@ +--- +title: SessionUseCases.ReloadUrlUseCase - +--- + +[mozilla.components.feature.session](../../index.html) / [SessionUseCases](../index.html) / [ReloadUrlUseCase](./index.html) + +# ReloadUrlUseCase + +`class ReloadUrlUseCase` + +### Functions + +| [invoke](invoke.html) | `fun invoke(session: Session = sessionManager.selectedSessionOrThrow): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Reloads the current URL of the provided session (or the currently selected session if none is provided). | + diff --git a/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/-reload-url-use-case/invoke.md b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/-reload-url-use-case/invoke.md new file mode 100644 index 00000000000..ea037c81b4a --- /dev/null +++ b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/-reload-url-use-case/invoke.md @@ -0,0 +1,16 @@ +--- +title: SessionUseCases.ReloadUrlUseCase.invoke - +--- + +[mozilla.components.feature.session](../../index.html) / [SessionUseCases](../index.html) / [ReloadUrlUseCase](index.html) / [invoke](./invoke.html) + +# invoke + +`fun invoke(session: Session = sessionManager.selectedSessionOrThrow): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Reloads the current URL of the provided session (or the currently +selected session if none is provided). + +### Parameters + +`session` - the session for which reload should be triggered. \ No newline at end of file diff --git a/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/-request-desktop-site/index.md b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/-request-desktop-site/index.md new file mode 100644 index 00000000000..ef1b289c60b --- /dev/null +++ b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/-request-desktop-site/index.md @@ -0,0 +1,14 @@ +--- +title: SessionUseCases.RequestDesktopSite - +--- + +[mozilla.components.feature.session](../../index.html) / [SessionUseCases](../index.html) / [RequestDesktopSite](./index.html) + +# RequestDesktopSite + +`class RequestDesktopSite` + +### Functions + +| [invoke](invoke.html) | `fun invoke(enable: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`, session: Session = sessionManager.selectedSessionOrThrow): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Request the desktop version of the current session and reloads the page. | + diff --git a/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/-request-desktop-site/invoke.md b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/-request-desktop-site/invoke.md new file mode 100644 index 00000000000..9456be80f7c --- /dev/null +++ b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/-request-desktop-site/invoke.md @@ -0,0 +1,12 @@ +--- +title: SessionUseCases.RequestDesktopSite.invoke - +--- + +[mozilla.components.feature.session](../../index.html) / [SessionUseCases](../index.html) / [RequestDesktopSite](index.html) / [invoke](./invoke.html) + +# invoke + +`fun invoke(enable: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`, session: Session = sessionManager.selectedSessionOrThrow): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Request the desktop version of the current session and reloads the page. + diff --git a/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/-stop-loading-use-case/index.md b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/-stop-loading-use-case/index.md new file mode 100644 index 00000000000..f1ffb4aece1 --- /dev/null +++ b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/-stop-loading-use-case/index.md @@ -0,0 +1,14 @@ +--- +title: SessionUseCases.StopLoadingUseCase - +--- + +[mozilla.components.feature.session](../../index.html) / [SessionUseCases](../index.html) / [StopLoadingUseCase](./index.html) + +# StopLoadingUseCase + +`class StopLoadingUseCase` + +### Functions + +| [invoke](invoke.html) | `fun invoke(session: Session = sessionManager.selectedSessionOrThrow): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Stops the current URL of the provided session from loading. | + diff --git a/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/-stop-loading-use-case/invoke.md b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/-stop-loading-use-case/invoke.md new file mode 100644 index 00000000000..d062e623b3a --- /dev/null +++ b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/-stop-loading-use-case/invoke.md @@ -0,0 +1,15 @@ +--- +title: SessionUseCases.StopLoadingUseCase.invoke - +--- + +[mozilla.components.feature.session](../../index.html) / [SessionUseCases](../index.html) / [StopLoadingUseCase](index.html) / [invoke](./invoke.html) + +# invoke + +`fun invoke(session: Session = sessionManager.selectedSessionOrThrow): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Stops the current URL of the provided session from loading. + +### Parameters + +`session` - the session for which loading should be stopped. \ No newline at end of file diff --git a/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/go-back.md b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/go-back.md new file mode 100644 index 00000000000..2e1ca1060e4 --- /dev/null +++ b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/go-back.md @@ -0,0 +1,9 @@ +--- +title: SessionUseCases.goBack - +--- + +[mozilla.components.feature.session](../index.html) / [SessionUseCases](index.html) / [goBack](./go-back.html) + +# goBack + +`val goBack: `[`GoBackUseCase`](-go-back-use-case/index.html) \ No newline at end of file diff --git a/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/go-forward.md b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/go-forward.md new file mode 100644 index 00000000000..7c45558c82d --- /dev/null +++ b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/go-forward.md @@ -0,0 +1,9 @@ +--- +title: SessionUseCases.goForward - +--- + +[mozilla.components.feature.session](../index.html) / [SessionUseCases](index.html) / [goForward](./go-forward.html) + +# goForward + +`val goForward: `[`GoForwardUseCase`](-go-forward-use-case/index.html) \ No newline at end of file diff --git a/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/index.md b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/index.md new file mode 100644 index 00000000000..877cad5bcc9 --- /dev/null +++ b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/index.md @@ -0,0 +1,36 @@ +--- +title: SessionUseCases - +--- + +[mozilla.components.feature.session](../index.html) / [SessionUseCases](./index.html) + +# SessionUseCases + +`class SessionUseCases` + +Contains use cases related to the session feature. + +### Types + +| [GoBackUseCase](-go-back-use-case/index.html) | `class GoBackUseCase` | +| [GoForwardUseCase](-go-forward-use-case/index.html) | `class GoForwardUseCase` | +| [LoadDataUseCase](-load-data-use-case/index.html) | `class LoadDataUseCase` | +| [LoadUrlUseCase](-load-url-use-case/index.html) | `class LoadUrlUseCase` | +| [ReloadUrlUseCase](-reload-url-use-case/index.html) | `class ReloadUrlUseCase` | +| [RequestDesktopSite](-request-desktop-site/index.html) | `class RequestDesktopSite` | +| [StopLoadingUseCase](-stop-loading-use-case/index.html) | `class StopLoadingUseCase` | + +### Constructors + +| [<init>](-init-.html) | `SessionUseCases(sessionManager: SessionManager)`
Contains use cases related to the session feature. | + +### Properties + +| [goBack](go-back.html) | `val goBack: `[`GoBackUseCase`](-go-back-use-case/index.html) | +| [goForward](go-forward.html) | `val goForward: `[`GoForwardUseCase`](-go-forward-use-case/index.html) | +| [loadData](load-data.html) | `val loadData: `[`LoadDataUseCase`](-load-data-use-case/index.html) | +| [loadUrl](load-url.html) | `val loadUrl: `[`LoadUrlUseCase`](-load-url-use-case/index.html) | +| [reload](reload.html) | `val reload: `[`ReloadUrlUseCase`](-reload-url-use-case/index.html) | +| [requestDesktopSite](request-desktop-site.html) | `val requestDesktopSite: `[`RequestDesktopSite`](-request-desktop-site/index.html) | +| [stopLoading](stop-loading.html) | `val stopLoading: `[`StopLoadingUseCase`](-stop-loading-use-case/index.html) | + diff --git a/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/load-data.md b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/load-data.md new file mode 100644 index 00000000000..e4b69a64e78 --- /dev/null +++ b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/load-data.md @@ -0,0 +1,9 @@ +--- +title: SessionUseCases.loadData - +--- + +[mozilla.components.feature.session](../index.html) / [SessionUseCases](index.html) / [loadData](./load-data.html) + +# loadData + +`val loadData: `[`LoadDataUseCase`](-load-data-use-case/index.html) \ No newline at end of file diff --git a/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/load-url.md b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/load-url.md new file mode 100644 index 00000000000..275cb681e56 --- /dev/null +++ b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/load-url.md @@ -0,0 +1,9 @@ +--- +title: SessionUseCases.loadUrl - +--- + +[mozilla.components.feature.session](../index.html) / [SessionUseCases](index.html) / [loadUrl](./load-url.html) + +# loadUrl + +`val loadUrl: `[`LoadUrlUseCase`](-load-url-use-case/index.html) \ No newline at end of file diff --git a/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/reload.md b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/reload.md new file mode 100644 index 00000000000..a80c8fe924e --- /dev/null +++ b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/reload.md @@ -0,0 +1,9 @@ +--- +title: SessionUseCases.reload - +--- + +[mozilla.components.feature.session](../index.html) / [SessionUseCases](index.html) / [reload](./reload.html) + +# reload + +`val reload: `[`ReloadUrlUseCase`](-reload-url-use-case/index.html) \ No newline at end of file diff --git a/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/request-desktop-site.md b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/request-desktop-site.md new file mode 100644 index 00000000000..87c9db9f26b --- /dev/null +++ b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/request-desktop-site.md @@ -0,0 +1,9 @@ +--- +title: SessionUseCases.requestDesktopSite - +--- + +[mozilla.components.feature.session](../index.html) / [SessionUseCases](index.html) / [requestDesktopSite](./request-desktop-site.html) + +# requestDesktopSite + +`val requestDesktopSite: `[`RequestDesktopSite`](-request-desktop-site/index.html) \ No newline at end of file diff --git a/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/stop-loading.md b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/stop-loading.md new file mode 100644 index 00000000000..20c73b13643 --- /dev/null +++ b/docs/api/0.21/feature-session/mozilla.components.feature.session/-session-use-cases/stop-loading.md @@ -0,0 +1,9 @@ +--- +title: SessionUseCases.stopLoading - +--- + +[mozilla.components.feature.session](../index.html) / [SessionUseCases](index.html) / [stopLoading](./stop-loading.html) + +# stopLoading + +`val stopLoading: `[`StopLoadingUseCase`](-stop-loading-use-case/index.html) \ No newline at end of file diff --git a/docs/api/0.21/feature-session/mozilla.components.feature.session/index.md b/docs/api/0.21/feature-session/mozilla.components.feature.session/index.md new file mode 100644 index 00000000000..ca3194ea304 --- /dev/null +++ b/docs/api/0.21/feature-session/mozilla.components.feature.session/index.md @@ -0,0 +1,19 @@ +--- +title: mozilla.components.feature.session - +--- + +[mozilla.components.feature.session](./index.html) + +## Package mozilla.components.feature.session + +### Types + +| [EngineViewPresenter](-engine-view-presenter/index.html) | `class EngineViewPresenter : Observer`
Presenter implementation for EngineView. | +| [SessionFeature](-session-feature/index.html) | `class SessionFeature`
Feature implementation for connecting the engine module with the session module. | +| [SessionIntentProcessor](-session-intent-processor/index.html) | `class SessionIntentProcessor`
Processor for intents which should trigger session-related actions. | +| [SessionUseCases](-session-use-cases/index.html) | `class SessionUseCases`
Contains use cases related to the session feature. | + +### Type Aliases + +| [IntentHandler](-intent-handler.html) | `typealias IntentHandler = (Intent) -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | + diff --git a/docs/api/0.21/feature-session/package-list b/docs/api/0.21/feature-session/package-list new file mode 100644 index 00000000000..ed924d90848 --- /dev/null +++ b/docs/api/0.21/feature-session/package-list @@ -0,0 +1,4 @@ +$dokka.format:jekyll +$dokka.linkExtension:html + +mozilla.components.feature.session diff --git a/docs/api/0.21/feature-tabs/alltypes/index.md b/docs/api/0.21/feature-tabs/alltypes/index.md new file mode 100644 index 00000000000..7e81c0a648e --- /dev/null +++ b/docs/api/0.21/feature-tabs/alltypes/index.md @@ -0,0 +1,12 @@ +--- +title: alltypes - +--- + +### All Types + +| [mozilla.components.feature.tabs.tabstray.TabsFeature](../mozilla.components.feature.tabs.tabstray/-tabs-feature/index.html) | Feature implementation for connecting a tabs tray implementation with the session module. | +| [mozilla.components.feature.tabs.toolbar.TabsToolbarFeature](../mozilla.components.feature.tabs.toolbar/-tabs-toolbar-feature/index.html) | Feature implementation for connecting a tabs tray implementation with a toolbar implementation. | +| [mozilla.components.feature.tabs.tabstray.TabsTrayInteractor](../mozilla.components.feature.tabs.tabstray/-tabs-tray-interactor/index.html) | Interactor for a tabs tray component. Subscribes to the tabs tray and invokes use cases to update the session manager. | +| [mozilla.components.feature.tabs.tabstray.TabsTrayPresenter](../mozilla.components.feature.tabs.tabstray/-tabs-tray-presenter/index.html) | Presenter implementation for a tabs tray implementation in order to update the tabs tray whenever the state of the session manager changes. | +| [mozilla.components.feature.tabs.TabsUseCases](../mozilla.components.feature.tabs/-tabs-use-cases/index.html) | Contains use cases related to the tabs feature. | + diff --git a/docs/api/0.21/feature-tabs/index.md b/docs/api/0.21/feature-tabs/index.md new file mode 100644 index 00000000000..e4e29c3c895 --- /dev/null +++ b/docs/api/0.21/feature-tabs/index.md @@ -0,0 +1,13 @@ +--- +title: +--- + +### Packages + +| [mozilla.components.feature.tabs](mozilla.components.feature.tabs/index.html) | | +| [mozilla.components.feature.tabs.tabstray](mozilla.components.feature.tabs.tabstray/index.html) | | +| [mozilla.components.feature.tabs.toolbar](mozilla.components.feature.tabs.toolbar/index.html) | | + +### Index + +[All Types](alltypes/index.html) \ No newline at end of file diff --git a/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.tabstray/-tabs-feature/-init-.md b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.tabstray/-tabs-feature/-init-.md new file mode 100644 index 00000000000..15e1e4c3f5d --- /dev/null +++ b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.tabstray/-tabs-feature/-init-.md @@ -0,0 +1,12 @@ +--- +title: TabsFeature. - +--- + +[mozilla.components.feature.tabs.tabstray](../index.html) / [TabsFeature](index.html) / [<init>](./-init-.html) + +# <init> + +`TabsFeature(tabsTray: TabsTray, sessionManager: SessionManager, tabsUseCases: `[`TabsUseCases`](../../mozilla.components.feature.tabs/-tabs-use-cases/index.html)`, closeTabsTray: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`, onTabsTrayEmpty: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)` = null)` + +Feature implementation for connecting a tabs tray implementation with the session module. + diff --git a/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.tabstray/-tabs-feature/index.md b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.tabstray/-tabs-feature/index.md new file mode 100644 index 00000000000..1db7bbc4196 --- /dev/null +++ b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.tabstray/-tabs-feature/index.md @@ -0,0 +1,21 @@ +--- +title: TabsFeature - +--- + +[mozilla.components.feature.tabs.tabstray](../index.html) / [TabsFeature](./index.html) + +# TabsFeature + +`class TabsFeature` + +Feature implementation for connecting a tabs tray implementation with the session module. + +### Constructors + +| [<init>](-init-.html) | `TabsFeature(tabsTray: TabsTray, sessionManager: SessionManager, tabsUseCases: `[`TabsUseCases`](../../mozilla.components.feature.tabs/-tabs-use-cases/index.html)`, closeTabsTray: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`, onTabsTrayEmpty: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)` = null)`
Feature implementation for connecting a tabs tray implementation with the session module. | + +### Functions + +| [start](start.html) | `fun start(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [stop](stop.html) | `fun stop(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | + diff --git a/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.tabstray/-tabs-feature/start.md b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.tabstray/-tabs-feature/start.md new file mode 100644 index 00000000000..710dd9bbc11 --- /dev/null +++ b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.tabstray/-tabs-feature/start.md @@ -0,0 +1,9 @@ +--- +title: TabsFeature.start - +--- + +[mozilla.components.feature.tabs.tabstray](../index.html) / [TabsFeature](index.html) / [start](./start.html) + +# start + +`fun start(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.tabstray/-tabs-feature/stop.md b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.tabstray/-tabs-feature/stop.md new file mode 100644 index 00000000000..e0c549a3894 --- /dev/null +++ b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.tabstray/-tabs-feature/stop.md @@ -0,0 +1,9 @@ +--- +title: TabsFeature.stop - +--- + +[mozilla.components.feature.tabs.tabstray](../index.html) / [TabsFeature](index.html) / [stop](./stop.html) + +# stop + +`fun stop(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.tabstray/-tabs-tray-interactor/-init-.md b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.tabstray/-tabs-tray-interactor/-init-.md new file mode 100644 index 00000000000..397a383d1cc --- /dev/null +++ b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.tabstray/-tabs-tray-interactor/-init-.md @@ -0,0 +1,13 @@ +--- +title: TabsTrayInteractor. - +--- + +[mozilla.components.feature.tabs.tabstray](../index.html) / [TabsTrayInteractor](index.html) / [<init>](./-init-.html) + +# <init> + +`TabsTrayInteractor(tabsTray: TabsTray, selectTabUseCase: `[`SelectTabUseCase`](../../mozilla.components.feature.tabs/-tabs-use-cases/-select-tab-use-case/index.html)`, removeTabUseCase: `[`RemoveTabUseCase`](../../mozilla.components.feature.tabs/-tabs-use-cases/-remove-tab-use-case/index.html)`, closeTabsTray: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`)` + +Interactor for a tabs tray component. Subscribes to the tabs tray and invokes use cases to update +the session manager. + diff --git a/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.tabstray/-tabs-tray-interactor/index.md b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.tabstray/-tabs-tray-interactor/index.md new file mode 100644 index 00000000000..3c9ceff9beb --- /dev/null +++ b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.tabstray/-tabs-tray-interactor/index.md @@ -0,0 +1,24 @@ +--- +title: TabsTrayInteractor - +--- + +[mozilla.components.feature.tabs.tabstray](../index.html) / [TabsTrayInteractor](./index.html) + +# TabsTrayInteractor + +`class TabsTrayInteractor : Observer` + +Interactor for a tabs tray component. Subscribes to the tabs tray and invokes use cases to update +the session manager. + +### Constructors + +| [<init>](-init-.html) | `TabsTrayInteractor(tabsTray: TabsTray, selectTabUseCase: `[`SelectTabUseCase`](../../mozilla.components.feature.tabs/-tabs-use-cases/-select-tab-use-case/index.html)`, removeTabUseCase: `[`RemoveTabUseCase`](../../mozilla.components.feature.tabs/-tabs-use-cases/-remove-tab-use-case/index.html)`, closeTabsTray: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`)`
Interactor for a tabs tray component. Subscribes to the tabs tray and invokes use cases to update the session manager. | + +### Functions + +| [onTabClosed](on-tab-closed.html) | `fun onTabClosed(session: Session): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onTabSelected](on-tab-selected.html) | `fun onTabSelected(session: Session): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [start](start.html) | `fun start(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [stop](stop.html) | `fun stop(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | + diff --git a/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.tabstray/-tabs-tray-interactor/on-tab-closed.md b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.tabstray/-tabs-tray-interactor/on-tab-closed.md new file mode 100644 index 00000000000..e09cacaeb60 --- /dev/null +++ b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.tabstray/-tabs-tray-interactor/on-tab-closed.md @@ -0,0 +1,9 @@ +--- +title: TabsTrayInteractor.onTabClosed - +--- + +[mozilla.components.feature.tabs.tabstray](../index.html) / [TabsTrayInteractor](index.html) / [onTabClosed](./on-tab-closed.html) + +# onTabClosed + +`fun onTabClosed(session: Session): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.tabstray/-tabs-tray-interactor/on-tab-selected.md b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.tabstray/-tabs-tray-interactor/on-tab-selected.md new file mode 100644 index 00000000000..f418a9b42d8 --- /dev/null +++ b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.tabstray/-tabs-tray-interactor/on-tab-selected.md @@ -0,0 +1,9 @@ +--- +title: TabsTrayInteractor.onTabSelected - +--- + +[mozilla.components.feature.tabs.tabstray](../index.html) / [TabsTrayInteractor](index.html) / [onTabSelected](./on-tab-selected.html) + +# onTabSelected + +`fun onTabSelected(session: Session): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.tabstray/-tabs-tray-interactor/start.md b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.tabstray/-tabs-tray-interactor/start.md new file mode 100644 index 00000000000..ee859875446 --- /dev/null +++ b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.tabstray/-tabs-tray-interactor/start.md @@ -0,0 +1,9 @@ +--- +title: TabsTrayInteractor.start - +--- + +[mozilla.components.feature.tabs.tabstray](../index.html) / [TabsTrayInteractor](index.html) / [start](./start.html) + +# start + +`fun start(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.tabstray/-tabs-tray-interactor/stop.md b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.tabstray/-tabs-tray-interactor/stop.md new file mode 100644 index 00000000000..d81e978e8f7 --- /dev/null +++ b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.tabstray/-tabs-tray-interactor/stop.md @@ -0,0 +1,9 @@ +--- +title: TabsTrayInteractor.stop - +--- + +[mozilla.components.feature.tabs.tabstray](../index.html) / [TabsTrayInteractor](index.html) / [stop](./stop.html) + +# stop + +`fun stop(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.tabstray/-tabs-tray-presenter/-init-.md b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.tabstray/-tabs-tray-presenter/-init-.md new file mode 100644 index 00000000000..4d10104b8c0 --- /dev/null +++ b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.tabstray/-tabs-tray-presenter/-init-.md @@ -0,0 +1,13 @@ +--- +title: TabsTrayPresenter. - +--- + +[mozilla.components.feature.tabs.tabstray](../index.html) / [TabsTrayPresenter](index.html) / [<init>](./-init-.html) + +# <init> + +`TabsTrayPresenter(tabsTray: TabsTray, sessionManager: SessionManager, closeTabsTray: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`, onTabsTrayEmpty: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)` = null)` + +Presenter implementation for a tabs tray implementation in order to update the tabs tray whenever +the state of the session manager changes. + diff --git a/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.tabstray/-tabs-tray-presenter/index.md b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.tabstray/-tabs-tray-presenter/index.md new file mode 100644 index 00000000000..b4ee2d8f028 --- /dev/null +++ b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.tabstray/-tabs-tray-presenter/index.md @@ -0,0 +1,26 @@ +--- +title: TabsTrayPresenter - +--- + +[mozilla.components.feature.tabs.tabstray](../index.html) / [TabsTrayPresenter](./index.html) + +# TabsTrayPresenter + +`class TabsTrayPresenter : Observer` + +Presenter implementation for a tabs tray implementation in order to update the tabs tray whenever +the state of the session manager changes. + +### Constructors + +| [<init>](-init-.html) | `TabsTrayPresenter(tabsTray: TabsTray, sessionManager: SessionManager, closeTabsTray: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`, onTabsTrayEmpty: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)` = null)`
Presenter implementation for a tabs tray implementation in order to update the tabs tray whenever the state of the session manager changes. | + +### Functions + +| [onAllSessionsRemoved](on-all-sessions-removed.html) | `fun onAllSessionsRemoved(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onSessionAdded](on-session-added.html) | `fun onSessionAdded(session: Session): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onSessionRemoved](on-session-removed.html) | `fun onSessionRemoved(session: Session): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onSessionSelected](on-session-selected.html) | `fun onSessionSelected(session: Session): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [start](start.html) | `fun start(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [stop](stop.html) | `fun stop(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | + diff --git a/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.tabstray/-tabs-tray-presenter/on-all-sessions-removed.md b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.tabstray/-tabs-tray-presenter/on-all-sessions-removed.md new file mode 100644 index 00000000000..00d17a8b712 --- /dev/null +++ b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.tabstray/-tabs-tray-presenter/on-all-sessions-removed.md @@ -0,0 +1,9 @@ +--- +title: TabsTrayPresenter.onAllSessionsRemoved - +--- + +[mozilla.components.feature.tabs.tabstray](../index.html) / [TabsTrayPresenter](index.html) / [onAllSessionsRemoved](./on-all-sessions-removed.html) + +# onAllSessionsRemoved + +`fun onAllSessionsRemoved(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.tabstray/-tabs-tray-presenter/on-session-added.md b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.tabstray/-tabs-tray-presenter/on-session-added.md new file mode 100644 index 00000000000..5e2583ca0dc --- /dev/null +++ b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.tabstray/-tabs-tray-presenter/on-session-added.md @@ -0,0 +1,9 @@ +--- +title: TabsTrayPresenter.onSessionAdded - +--- + +[mozilla.components.feature.tabs.tabstray](../index.html) / [TabsTrayPresenter](index.html) / [onSessionAdded](./on-session-added.html) + +# onSessionAdded + +`fun onSessionAdded(session: Session): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.tabstray/-tabs-tray-presenter/on-session-removed.md b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.tabstray/-tabs-tray-presenter/on-session-removed.md new file mode 100644 index 00000000000..e925bda5fb6 --- /dev/null +++ b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.tabstray/-tabs-tray-presenter/on-session-removed.md @@ -0,0 +1,9 @@ +--- +title: TabsTrayPresenter.onSessionRemoved - +--- + +[mozilla.components.feature.tabs.tabstray](../index.html) / [TabsTrayPresenter](index.html) / [onSessionRemoved](./on-session-removed.html) + +# onSessionRemoved + +`fun onSessionRemoved(session: Session): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.tabstray/-tabs-tray-presenter/on-session-selected.md b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.tabstray/-tabs-tray-presenter/on-session-selected.md new file mode 100644 index 00000000000..a32ad479713 --- /dev/null +++ b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.tabstray/-tabs-tray-presenter/on-session-selected.md @@ -0,0 +1,9 @@ +--- +title: TabsTrayPresenter.onSessionSelected - +--- + +[mozilla.components.feature.tabs.tabstray](../index.html) / [TabsTrayPresenter](index.html) / [onSessionSelected](./on-session-selected.html) + +# onSessionSelected + +`fun onSessionSelected(session: Session): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.tabstray/-tabs-tray-presenter/start.md b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.tabstray/-tabs-tray-presenter/start.md new file mode 100644 index 00000000000..1e712430dd2 --- /dev/null +++ b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.tabstray/-tabs-tray-presenter/start.md @@ -0,0 +1,9 @@ +--- +title: TabsTrayPresenter.start - +--- + +[mozilla.components.feature.tabs.tabstray](../index.html) / [TabsTrayPresenter](index.html) / [start](./start.html) + +# start + +`fun start(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.tabstray/-tabs-tray-presenter/stop.md b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.tabstray/-tabs-tray-presenter/stop.md new file mode 100644 index 00000000000..cb7f716e7db --- /dev/null +++ b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.tabstray/-tabs-tray-presenter/stop.md @@ -0,0 +1,9 @@ +--- +title: TabsTrayPresenter.stop - +--- + +[mozilla.components.feature.tabs.tabstray](../index.html) / [TabsTrayPresenter](index.html) / [stop](./stop.html) + +# stop + +`fun stop(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.tabstray/index.md b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.tabstray/index.md new file mode 100644 index 00000000000..ea50826c804 --- /dev/null +++ b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.tabstray/index.md @@ -0,0 +1,14 @@ +--- +title: mozilla.components.feature.tabs.tabstray - +--- + +[mozilla.components.feature.tabs.tabstray](./index.html) + +## Package mozilla.components.feature.tabs.tabstray + +### Types + +| [TabsFeature](-tabs-feature/index.html) | `class TabsFeature`
Feature implementation for connecting a tabs tray implementation with the session module. | +| [TabsTrayInteractor](-tabs-tray-interactor/index.html) | `class TabsTrayInteractor : Observer`
Interactor for a tabs tray component. Subscribes to the tabs tray and invokes use cases to update the session manager. | +| [TabsTrayPresenter](-tabs-tray-presenter/index.html) | `class TabsTrayPresenter : Observer`
Presenter implementation for a tabs tray implementation in order to update the tabs tray whenever the state of the session manager changes. | + diff --git a/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.toolbar/-tabs-toolbar-feature/-init-.md b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.toolbar/-tabs-toolbar-feature/-init-.md new file mode 100644 index 00000000000..fe3485c6ed9 --- /dev/null +++ b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.toolbar/-tabs-toolbar-feature/-init-.md @@ -0,0 +1,12 @@ +--- +title: TabsToolbarFeature. - +--- + +[mozilla.components.feature.tabs.toolbar](../index.html) / [TabsToolbarFeature](index.html) / [<init>](./-init-.html) + +# <init> + +`TabsToolbarFeature(context: Context, toolbar: Toolbar, showTabs: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`)` + +Feature implementation for connecting a tabs tray implementation with a toolbar implementation. + diff --git a/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.toolbar/-tabs-toolbar-feature/index.md b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.toolbar/-tabs-toolbar-feature/index.md new file mode 100644 index 00000000000..a88a4db3042 --- /dev/null +++ b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.toolbar/-tabs-toolbar-feature/index.md @@ -0,0 +1,16 @@ +--- +title: TabsToolbarFeature - +--- + +[mozilla.components.feature.tabs.toolbar](../index.html) / [TabsToolbarFeature](./index.html) + +# TabsToolbarFeature + +`class TabsToolbarFeature` + +Feature implementation for connecting a tabs tray implementation with a toolbar implementation. + +### Constructors + +| [<init>](-init-.html) | `TabsToolbarFeature(context: Context, toolbar: Toolbar, showTabs: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`)`
Feature implementation for connecting a tabs tray implementation with a toolbar implementation. | + diff --git a/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.toolbar/index.md b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.toolbar/index.md new file mode 100644 index 00000000000..c05c88742aa --- /dev/null +++ b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs.toolbar/index.md @@ -0,0 +1,12 @@ +--- +title: mozilla.components.feature.tabs.toolbar - +--- + +[mozilla.components.feature.tabs.toolbar](./index.html) + +## Package mozilla.components.feature.tabs.toolbar + +### Types + +| [TabsToolbarFeature](-tabs-toolbar-feature/index.html) | `class TabsToolbarFeature`
Feature implementation for connecting a tabs tray implementation with a toolbar implementation. | + diff --git a/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs/-tabs-use-cases/-add-new-private-tab-use-case/index.md b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs/-tabs-use-cases/-add-new-private-tab-use-case/index.md new file mode 100644 index 00000000000..282a0d76535 --- /dev/null +++ b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs/-tabs-use-cases/-add-new-private-tab-use-case/index.md @@ -0,0 +1,14 @@ +--- +title: TabsUseCases.AddNewPrivateTabUseCase - +--- + +[mozilla.components.feature.tabs](../../index.html) / [TabsUseCases](../index.html) / [AddNewPrivateTabUseCase](./index.html) + +# AddNewPrivateTabUseCase + +`class AddNewPrivateTabUseCase` + +### Functions + +| [invoke](invoke.html) | `fun invoke(url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, selectTab: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = true): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Add a new private tab and load the provided URL. | + diff --git a/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs/-tabs-use-cases/-add-new-private-tab-use-case/invoke.md b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs/-tabs-use-cases/-add-new-private-tab-use-case/invoke.md new file mode 100644 index 00000000000..a4cff93cf21 --- /dev/null +++ b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs/-tabs-use-cases/-add-new-private-tab-use-case/invoke.md @@ -0,0 +1,17 @@ +--- +title: TabsUseCases.AddNewPrivateTabUseCase.invoke - +--- + +[mozilla.components.feature.tabs](../../index.html) / [TabsUseCases](../index.html) / [AddNewPrivateTabUseCase](index.html) / [invoke](./invoke.html) + +# invoke + +`fun invoke(url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, selectTab: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = true): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Add a new private tab and load the provided URL. + +### Parameters + +`url` - The URL to be loaded in the new tab. + +`selectTab` - True (default) if the new tab should be selected immediately. \ No newline at end of file diff --git a/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs/-tabs-use-cases/-add-new-tab-use-case/index.md b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs/-tabs-use-cases/-add-new-tab-use-case/index.md new file mode 100644 index 00000000000..1edf5d1d98f --- /dev/null +++ b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs/-tabs-use-cases/-add-new-tab-use-case/index.md @@ -0,0 +1,14 @@ +--- +title: TabsUseCases.AddNewTabUseCase - +--- + +[mozilla.components.feature.tabs](../../index.html) / [TabsUseCases](../index.html) / [AddNewTabUseCase](./index.html) + +# AddNewTabUseCase + +`class AddNewTabUseCase` + +### Functions + +| [invoke](invoke.html) | `fun invoke(url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, selectTab: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = true): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Add a new tab and load the provided URL. | + diff --git a/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs/-tabs-use-cases/-add-new-tab-use-case/invoke.md b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs/-tabs-use-cases/-add-new-tab-use-case/invoke.md new file mode 100644 index 00000000000..72a92be68c1 --- /dev/null +++ b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs/-tabs-use-cases/-add-new-tab-use-case/invoke.md @@ -0,0 +1,17 @@ +--- +title: TabsUseCases.AddNewTabUseCase.invoke - +--- + +[mozilla.components.feature.tabs](../../index.html) / [TabsUseCases](../index.html) / [AddNewTabUseCase](index.html) / [invoke](./invoke.html) + +# invoke + +`fun invoke(url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, selectTab: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = true): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Add a new tab and load the provided URL. + +### Parameters + +`url` - The URL to be loaded in the new tab. + +`selectTab` - True (default) if the new tab should be selected immediately. \ No newline at end of file diff --git a/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs/-tabs-use-cases/-init-.md b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs/-tabs-use-cases/-init-.md new file mode 100644 index 00000000000..b5d2dc183e8 --- /dev/null +++ b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs/-tabs-use-cases/-init-.md @@ -0,0 +1,12 @@ +--- +title: TabsUseCases. - +--- + +[mozilla.components.feature.tabs](../index.html) / [TabsUseCases](index.html) / [<init>](./-init-.html) + +# <init> + +`TabsUseCases(sessionManager: SessionManager)` + +Contains use cases related to the tabs feature. + diff --git a/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs/-tabs-use-cases/-remove-tab-use-case/index.md b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs/-tabs-use-cases/-remove-tab-use-case/index.md new file mode 100644 index 00000000000..87808a4029c --- /dev/null +++ b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs/-tabs-use-cases/-remove-tab-use-case/index.md @@ -0,0 +1,14 @@ +--- +title: TabsUseCases.RemoveTabUseCase - +--- + +[mozilla.components.feature.tabs](../../index.html) / [TabsUseCases](../index.html) / [RemoveTabUseCase](./index.html) + +# RemoveTabUseCase + +`class RemoveTabUseCase` + +### Functions + +| [invoke](invoke.html) | `fun invoke(session: Session): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Removes the provided session. | + diff --git a/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs/-tabs-use-cases/-remove-tab-use-case/invoke.md b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs/-tabs-use-cases/-remove-tab-use-case/invoke.md new file mode 100644 index 00000000000..b9127dce799 --- /dev/null +++ b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs/-tabs-use-cases/-remove-tab-use-case/invoke.md @@ -0,0 +1,15 @@ +--- +title: TabsUseCases.RemoveTabUseCase.invoke - +--- + +[mozilla.components.feature.tabs](../../index.html) / [TabsUseCases](../index.html) / [RemoveTabUseCase](index.html) / [invoke](./invoke.html) + +# invoke + +`fun invoke(session: Session): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Removes the provided session. + +### Parameters + +`session` - The session to remove. \ No newline at end of file diff --git a/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs/-tabs-use-cases/-select-tab-use-case/index.md b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs/-tabs-use-cases/-select-tab-use-case/index.md new file mode 100644 index 00000000000..63d8a2198d1 --- /dev/null +++ b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs/-tabs-use-cases/-select-tab-use-case/index.md @@ -0,0 +1,14 @@ +--- +title: TabsUseCases.SelectTabUseCase - +--- + +[mozilla.components.feature.tabs](../../index.html) / [TabsUseCases](../index.html) / [SelectTabUseCase](./index.html) + +# SelectTabUseCase + +`class SelectTabUseCase` + +### Functions + +| [invoke](invoke.html) | `fun invoke(session: Session): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Marks the provided session as selected. | + diff --git a/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs/-tabs-use-cases/-select-tab-use-case/invoke.md b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs/-tabs-use-cases/-select-tab-use-case/invoke.md new file mode 100644 index 00000000000..462a0f3c559 --- /dev/null +++ b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs/-tabs-use-cases/-select-tab-use-case/invoke.md @@ -0,0 +1,15 @@ +--- +title: TabsUseCases.SelectTabUseCase.invoke - +--- + +[mozilla.components.feature.tabs](../../index.html) / [TabsUseCases](../index.html) / [SelectTabUseCase](index.html) / [invoke](./invoke.html) + +# invoke + +`fun invoke(session: Session): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Marks the provided session as selected. + +### Parameters + +`session` - The session to select. \ No newline at end of file diff --git a/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs/-tabs-use-cases/add-private-session.md b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs/-tabs-use-cases/add-private-session.md new file mode 100644 index 00000000000..f54d4254295 --- /dev/null +++ b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs/-tabs-use-cases/add-private-session.md @@ -0,0 +1,9 @@ +--- +title: TabsUseCases.addPrivateSession - +--- + +[mozilla.components.feature.tabs](../index.html) / [TabsUseCases](index.html) / [addPrivateSession](./add-private-session.html) + +# addPrivateSession + +`val addPrivateSession: `[`AddNewPrivateTabUseCase`](-add-new-private-tab-use-case/index.html) \ No newline at end of file diff --git a/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs/-tabs-use-cases/add-session.md b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs/-tabs-use-cases/add-session.md new file mode 100644 index 00000000000..91e08ca45aa --- /dev/null +++ b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs/-tabs-use-cases/add-session.md @@ -0,0 +1,9 @@ +--- +title: TabsUseCases.addSession - +--- + +[mozilla.components.feature.tabs](../index.html) / [TabsUseCases](index.html) / [addSession](./add-session.html) + +# addSession + +`val addSession: `[`AddNewTabUseCase`](-add-new-tab-use-case/index.html) \ No newline at end of file diff --git a/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs/-tabs-use-cases/index.md b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs/-tabs-use-cases/index.md new file mode 100644 index 00000000000..0aaebbadc81 --- /dev/null +++ b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs/-tabs-use-cases/index.md @@ -0,0 +1,30 @@ +--- +title: TabsUseCases - +--- + +[mozilla.components.feature.tabs](../index.html) / [TabsUseCases](./index.html) + +# TabsUseCases + +`class TabsUseCases` + +Contains use cases related to the tabs feature. + +### Types + +| [AddNewPrivateTabUseCase](-add-new-private-tab-use-case/index.html) | `class AddNewPrivateTabUseCase` | +| [AddNewTabUseCase](-add-new-tab-use-case/index.html) | `class AddNewTabUseCase` | +| [RemoveTabUseCase](-remove-tab-use-case/index.html) | `class RemoveTabUseCase` | +| [SelectTabUseCase](-select-tab-use-case/index.html) | `class SelectTabUseCase` | + +### Constructors + +| [<init>](-init-.html) | `TabsUseCases(sessionManager: SessionManager)`
Contains use cases related to the tabs feature. | + +### Properties + +| [addPrivateSession](add-private-session.html) | `val addPrivateSession: `[`AddNewPrivateTabUseCase`](-add-new-private-tab-use-case/index.html) | +| [addSession](add-session.html) | `val addSession: `[`AddNewTabUseCase`](-add-new-tab-use-case/index.html) | +| [removeSession](remove-session.html) | `val removeSession: `[`RemoveTabUseCase`](-remove-tab-use-case/index.html) | +| [selectSession](select-session.html) | `val selectSession: `[`SelectTabUseCase`](-select-tab-use-case/index.html) | + diff --git a/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs/-tabs-use-cases/remove-session.md b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs/-tabs-use-cases/remove-session.md new file mode 100644 index 00000000000..9a4f38ddab6 --- /dev/null +++ b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs/-tabs-use-cases/remove-session.md @@ -0,0 +1,9 @@ +--- +title: TabsUseCases.removeSession - +--- + +[mozilla.components.feature.tabs](../index.html) / [TabsUseCases](index.html) / [removeSession](./remove-session.html) + +# removeSession + +`val removeSession: `[`RemoveTabUseCase`](-remove-tab-use-case/index.html) \ No newline at end of file diff --git a/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs/-tabs-use-cases/select-session.md b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs/-tabs-use-cases/select-session.md new file mode 100644 index 00000000000..f477e06a322 --- /dev/null +++ b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs/-tabs-use-cases/select-session.md @@ -0,0 +1,9 @@ +--- +title: TabsUseCases.selectSession - +--- + +[mozilla.components.feature.tabs](../index.html) / [TabsUseCases](index.html) / [selectSession](./select-session.html) + +# selectSession + +`val selectSession: `[`SelectTabUseCase`](-select-tab-use-case/index.html) \ No newline at end of file diff --git a/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs/index.md b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs/index.md new file mode 100644 index 00000000000..7d80f69d40f --- /dev/null +++ b/docs/api/0.21/feature-tabs/mozilla.components.feature.tabs/index.md @@ -0,0 +1,12 @@ +--- +title: mozilla.components.feature.tabs - +--- + +[mozilla.components.feature.tabs](./index.html) + +## Package mozilla.components.feature.tabs + +### Types + +| [TabsUseCases](-tabs-use-cases/index.html) | `class TabsUseCases`
Contains use cases related to the tabs feature. | + diff --git a/docs/api/0.21/feature-tabs/package-list b/docs/api/0.21/feature-tabs/package-list new file mode 100644 index 00000000000..4c434dd041f --- /dev/null +++ b/docs/api/0.21/feature-tabs/package-list @@ -0,0 +1,6 @@ +$dokka.format:jekyll +$dokka.linkExtension:html + +mozilla.components.feature.tabs +mozilla.components.feature.tabs.tabstray +mozilla.components.feature.tabs.toolbar diff --git a/docs/api/0.21/feature-toolbar/alltypes/index.md b/docs/api/0.21/feature-toolbar/alltypes/index.md new file mode 100644 index 00000000000..f345c3a0038 --- /dev/null +++ b/docs/api/0.21/feature-toolbar/alltypes/index.md @@ -0,0 +1,11 @@ +--- +title: alltypes - +--- + +### All Types + +| [mozilla.components.feature.toolbar.SearchUseCase](../mozilla.components.feature.toolbar/-search-use-case.html) | A function representing the search use case, accepting the search terms as string. | +| [mozilla.components.feature.toolbar.ToolbarFeature](../mozilla.components.feature.toolbar/-toolbar-feature/index.html) | Feature implementation for connecting a toolbar implementation with the session module. | +| [mozilla.components.feature.toolbar.ToolbarInteractor](../mozilla.components.feature.toolbar/-toolbar-interactor/index.html) | Connects a toolbar instance to the browser engine via use cases | +| [mozilla.components.feature.toolbar.ToolbarPresenter](../mozilla.components.feature.toolbar/-toolbar-presenter/index.html) | Presenter implementation for a toolbar implementation in order to update the toolbar whenever the state of the selected session changes. | + diff --git a/docs/api/0.21/feature-toolbar/index.md b/docs/api/0.21/feature-toolbar/index.md new file mode 100644 index 00000000000..e7037af8d7f --- /dev/null +++ b/docs/api/0.21/feature-toolbar/index.md @@ -0,0 +1,11 @@ +--- +title: +--- + +### Packages + +| [mozilla.components.feature.toolbar](mozilla.components.feature.toolbar/index.html) | | + +### Index + +[All Types](alltypes/index.html) \ No newline at end of file diff --git a/docs/api/0.21/feature-toolbar/mozilla.components.feature.toolbar/-search-use-case.md b/docs/api/0.21/feature-toolbar/mozilla.components.feature.toolbar/-search-use-case.md new file mode 100644 index 00000000000..641b8c3ad7b --- /dev/null +++ b/docs/api/0.21/feature-toolbar/mozilla.components.feature.toolbar/-search-use-case.md @@ -0,0 +1,13 @@ +--- +title: SearchUseCase - +--- + +[mozilla.components.feature.toolbar](index.html) / [SearchUseCase](./-search-use-case.html) + +# SearchUseCase + +`typealias SearchUseCase = (`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +A function representing the search use case, accepting +the search terms as string. + diff --git a/docs/api/0.21/feature-toolbar/mozilla.components.feature.toolbar/-toolbar-feature/-init-.md b/docs/api/0.21/feature-toolbar/mozilla.components.feature.toolbar/-toolbar-feature/-init-.md new file mode 100644 index 00000000000..3800a0128fe --- /dev/null +++ b/docs/api/0.21/feature-toolbar/mozilla.components.feature.toolbar/-toolbar-feature/-init-.md @@ -0,0 +1,12 @@ +--- +title: ToolbarFeature. - +--- + +[mozilla.components.feature.toolbar](../index.html) / [ToolbarFeature](index.html) / [<init>](./-init-.html) + +# <init> + +`ToolbarFeature(toolbar: Toolbar, sessionManager: SessionManager, loadUrlUseCase: LoadUrlUseCase, searchUseCase: `[`SearchUseCase`](../-search-use-case.html)`? = null, sessionId: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null)` + +Feature implementation for connecting a toolbar implementation with the session module. + diff --git a/docs/api/0.21/feature-toolbar/mozilla.components.feature.toolbar/-toolbar-feature/handle-back-pressed.md b/docs/api/0.21/feature-toolbar/mozilla.components.feature.toolbar/-toolbar-feature/handle-back-pressed.md new file mode 100644 index 00000000000..c2a0d064464 --- /dev/null +++ b/docs/api/0.21/feature-toolbar/mozilla.components.feature.toolbar/-toolbar-feature/handle-back-pressed.md @@ -0,0 +1,15 @@ +--- +title: ToolbarFeature.handleBackPressed - +--- + +[mozilla.components.feature.toolbar](../index.html) / [ToolbarFeature](index.html) / [handleBackPressed](./handle-back-pressed.html) + +# handleBackPressed + +`fun handleBackPressed(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Handler for back pressed events in activities that use this feature. + +**Return** +true if the event was handled, otherwise false. + diff --git a/docs/api/0.21/feature-toolbar/mozilla.components.feature.toolbar/-toolbar-feature/index.md b/docs/api/0.21/feature-toolbar/mozilla.components.feature.toolbar/-toolbar-feature/index.md new file mode 100644 index 00000000000..5e640171522 --- /dev/null +++ b/docs/api/0.21/feature-toolbar/mozilla.components.feature.toolbar/-toolbar-feature/index.md @@ -0,0 +1,26 @@ +--- +title: ToolbarFeature - +--- + +[mozilla.components.feature.toolbar](../index.html) / [ToolbarFeature](./index.html) + +# ToolbarFeature + +`class ToolbarFeature` + +Feature implementation for connecting a toolbar implementation with the session module. + +### Constructors + +| [<init>](-init-.html) | `ToolbarFeature(toolbar: Toolbar, sessionManager: SessionManager, loadUrlUseCase: LoadUrlUseCase, searchUseCase: `[`SearchUseCase`](../-search-use-case.html)`? = null, sessionId: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null)`
Feature implementation for connecting a toolbar implementation with the session module. | + +### Properties + +| [toolbar](toolbar.html) | `val toolbar: Toolbar` | + +### Functions + +| [handleBackPressed](handle-back-pressed.html) | `fun handleBackPressed(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Handler for back pressed events in activities that use this feature. | +| [start](start.html) | `fun start(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Start feature: App is in the foreground. | +| [stop](stop.html) | `fun stop(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Stop feature: App is in the background. | + diff --git a/docs/api/0.21/feature-toolbar/mozilla.components.feature.toolbar/-toolbar-feature/start.md b/docs/api/0.21/feature-toolbar/mozilla.components.feature.toolbar/-toolbar-feature/start.md new file mode 100644 index 00000000000..d49329b2345 --- /dev/null +++ b/docs/api/0.21/feature-toolbar/mozilla.components.feature.toolbar/-toolbar-feature/start.md @@ -0,0 +1,12 @@ +--- +title: ToolbarFeature.start - +--- + +[mozilla.components.feature.toolbar](../index.html) / [ToolbarFeature](index.html) / [start](./start.html) + +# start + +`fun start(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Start feature: App is in the foreground. + diff --git a/docs/api/0.21/feature-toolbar/mozilla.components.feature.toolbar/-toolbar-feature/stop.md b/docs/api/0.21/feature-toolbar/mozilla.components.feature.toolbar/-toolbar-feature/stop.md new file mode 100644 index 00000000000..e8581ae15ee --- /dev/null +++ b/docs/api/0.21/feature-toolbar/mozilla.components.feature.toolbar/-toolbar-feature/stop.md @@ -0,0 +1,12 @@ +--- +title: ToolbarFeature.stop - +--- + +[mozilla.components.feature.toolbar](../index.html) / [ToolbarFeature](index.html) / [stop](./stop.html) + +# stop + +`fun stop(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Stop feature: App is in the background. + diff --git a/docs/api/0.21/feature-toolbar/mozilla.components.feature.toolbar/-toolbar-feature/toolbar.md b/docs/api/0.21/feature-toolbar/mozilla.components.feature.toolbar/-toolbar-feature/toolbar.md new file mode 100644 index 00000000000..32eefd194d0 --- /dev/null +++ b/docs/api/0.21/feature-toolbar/mozilla.components.feature.toolbar/-toolbar-feature/toolbar.md @@ -0,0 +1,9 @@ +--- +title: ToolbarFeature.toolbar - +--- + +[mozilla.components.feature.toolbar](../index.html) / [ToolbarFeature](index.html) / [toolbar](./toolbar.html) + +# toolbar + +`val toolbar: Toolbar` \ No newline at end of file diff --git a/docs/api/0.21/feature-toolbar/mozilla.components.feature.toolbar/-toolbar-interactor/-init-.md b/docs/api/0.21/feature-toolbar/mozilla.components.feature.toolbar/-toolbar-interactor/-init-.md new file mode 100644 index 00000000000..5764231def5 --- /dev/null +++ b/docs/api/0.21/feature-toolbar/mozilla.components.feature.toolbar/-toolbar-interactor/-init-.md @@ -0,0 +1,12 @@ +--- +title: ToolbarInteractor. - +--- + +[mozilla.components.feature.toolbar](../index.html) / [ToolbarInteractor](index.html) / [<init>](./-init-.html) + +# <init> + +`ToolbarInteractor(toolbar: Toolbar, loadUrlUseCase: LoadUrlUseCase, searchUseCase: `[`SearchUseCase`](../-search-use-case.html)`? = null)` + +Connects a toolbar instance to the browser engine via use cases + diff --git a/docs/api/0.21/feature-toolbar/mozilla.components.feature.toolbar/-toolbar-interactor/index.md b/docs/api/0.21/feature-toolbar/mozilla.components.feature.toolbar/-toolbar-interactor/index.md new file mode 100644 index 00000000000..3837638755c --- /dev/null +++ b/docs/api/0.21/feature-toolbar/mozilla.components.feature.toolbar/-toolbar-interactor/index.md @@ -0,0 +1,21 @@ +--- +title: ToolbarInteractor - +--- + +[mozilla.components.feature.toolbar](../index.html) / [ToolbarInteractor](./index.html) + +# ToolbarInteractor + +`class ToolbarInteractor` + +Connects a toolbar instance to the browser engine via use cases + +### Constructors + +| [<init>](-init-.html) | `ToolbarInteractor(toolbar: Toolbar, loadUrlUseCase: LoadUrlUseCase, searchUseCase: `[`SearchUseCase`](../-search-use-case.html)`? = null)`
Connects a toolbar instance to the browser engine via use cases | + +### Functions + +| [start](start.html) | `fun start(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Starts this interactor. Makes sure this interactor is listening to relevant UI changes and triggers the corresponding use-cases in response. | +| [stop](stop.html) | `fun stop(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Stops this interactor. | + diff --git a/docs/api/0.21/feature-toolbar/mozilla.components.feature.toolbar/-toolbar-interactor/start.md b/docs/api/0.21/feature-toolbar/mozilla.components.feature.toolbar/-toolbar-interactor/start.md new file mode 100644 index 00000000000..a9ddf1e5a4e --- /dev/null +++ b/docs/api/0.21/feature-toolbar/mozilla.components.feature.toolbar/-toolbar-interactor/start.md @@ -0,0 +1,14 @@ +--- +title: ToolbarInteractor.start - +--- + +[mozilla.components.feature.toolbar](../index.html) / [ToolbarInteractor](index.html) / [start](./start.html) + +# start + +`fun start(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Starts this interactor. Makes sure this interactor is listening +to relevant UI changes and triggers the corresponding use-cases +in response. + diff --git a/docs/api/0.21/feature-toolbar/mozilla.components.feature.toolbar/-toolbar-interactor/stop.md b/docs/api/0.21/feature-toolbar/mozilla.components.feature.toolbar/-toolbar-interactor/stop.md new file mode 100644 index 00000000000..87c6a498bd2 --- /dev/null +++ b/docs/api/0.21/feature-toolbar/mozilla.components.feature.toolbar/-toolbar-interactor/stop.md @@ -0,0 +1,12 @@ +--- +title: ToolbarInteractor.stop - +--- + +[mozilla.components.feature.toolbar](../index.html) / [ToolbarInteractor](index.html) / [stop](./stop.html) + +# stop + +`fun stop(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Stops this interactor. + diff --git a/docs/api/0.21/feature-toolbar/mozilla.components.feature.toolbar/-toolbar-presenter/-init-.md b/docs/api/0.21/feature-toolbar/mozilla.components.feature.toolbar/-toolbar-presenter/-init-.md new file mode 100644 index 00000000000..2f2d65f51a7 --- /dev/null +++ b/docs/api/0.21/feature-toolbar/mozilla.components.feature.toolbar/-toolbar-presenter/-init-.md @@ -0,0 +1,13 @@ +--- +title: ToolbarPresenter. - +--- + +[mozilla.components.feature.toolbar](../index.html) / [ToolbarPresenter](index.html) / [<init>](./-init-.html) + +# <init> + +`ToolbarPresenter(toolbar: Toolbar, sessionManager: SessionManager, sessionId: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null)` + +Presenter implementation for a toolbar implementation in order to update the toolbar whenever +the state of the selected session changes. + diff --git a/docs/api/0.21/feature-toolbar/mozilla.components.feature.toolbar/-toolbar-presenter/index.md b/docs/api/0.21/feature-toolbar/mozilla.components.feature.toolbar/-toolbar-presenter/index.md new file mode 100644 index 00000000000..862e975582e --- /dev/null +++ b/docs/api/0.21/feature-toolbar/mozilla.components.feature.toolbar/-toolbar-presenter/index.md @@ -0,0 +1,26 @@ +--- +title: ToolbarPresenter - +--- + +[mozilla.components.feature.toolbar](../index.html) / [ToolbarPresenter](./index.html) + +# ToolbarPresenter + +`class ToolbarPresenter : Observer, Observer` + +Presenter implementation for a toolbar implementation in order to update the toolbar whenever +the state of the selected session changes. + +### Constructors + +| [<init>](-init-.html) | `ToolbarPresenter(toolbar: Toolbar, sessionManager: SessionManager, sessionId: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null)`
Presenter implementation for a toolbar implementation in order to update the toolbar whenever the state of the selected session changes. | + +### Functions + +| [onProgress](on-progress.html) | `fun onProgress(session: Session, progress: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onSearch](on-search.html) | `fun onSearch(session: Session, searchTerms: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onSessionSelected](on-session-selected.html) | `fun onSessionSelected(session: Session): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
A new session has been selected: Update toolbar to display data of new session. | +| [onUrlChanged](on-url-changed.html) | `fun onUrlChanged(session: Session, url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [start](start.html) | `fun start(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Start presenter: Display data in toolbar. | +| [stop](stop.html) | `fun stop(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Stop presenter from updating the view. | + diff --git a/docs/api/0.21/feature-toolbar/mozilla.components.feature.toolbar/-toolbar-presenter/on-progress.md b/docs/api/0.21/feature-toolbar/mozilla.components.feature.toolbar/-toolbar-presenter/on-progress.md new file mode 100644 index 00000000000..a77e10717f2 --- /dev/null +++ b/docs/api/0.21/feature-toolbar/mozilla.components.feature.toolbar/-toolbar-presenter/on-progress.md @@ -0,0 +1,9 @@ +--- +title: ToolbarPresenter.onProgress - +--- + +[mozilla.components.feature.toolbar](../index.html) / [ToolbarPresenter](index.html) / [onProgress](./on-progress.html) + +# onProgress + +`fun onProgress(session: Session, progress: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/feature-toolbar/mozilla.components.feature.toolbar/-toolbar-presenter/on-search.md b/docs/api/0.21/feature-toolbar/mozilla.components.feature.toolbar/-toolbar-presenter/on-search.md new file mode 100644 index 00000000000..dfbdedfa2b0 --- /dev/null +++ b/docs/api/0.21/feature-toolbar/mozilla.components.feature.toolbar/-toolbar-presenter/on-search.md @@ -0,0 +1,9 @@ +--- +title: ToolbarPresenter.onSearch - +--- + +[mozilla.components.feature.toolbar](../index.html) / [ToolbarPresenter](index.html) / [onSearch](./on-search.html) + +# onSearch + +`fun onSearch(session: Session, searchTerms: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/feature-toolbar/mozilla.components.feature.toolbar/-toolbar-presenter/on-session-selected.md b/docs/api/0.21/feature-toolbar/mozilla.components.feature.toolbar/-toolbar-presenter/on-session-selected.md new file mode 100644 index 00000000000..4c491357248 --- /dev/null +++ b/docs/api/0.21/feature-toolbar/mozilla.components.feature.toolbar/-toolbar-presenter/on-session-selected.md @@ -0,0 +1,12 @@ +--- +title: ToolbarPresenter.onSessionSelected - +--- + +[mozilla.components.feature.toolbar](../index.html) / [ToolbarPresenter](index.html) / [onSessionSelected](./on-session-selected.html) + +# onSessionSelected + +`fun onSessionSelected(session: Session): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +A new session has been selected: Update toolbar to display data of new session. + diff --git a/docs/api/0.21/feature-toolbar/mozilla.components.feature.toolbar/-toolbar-presenter/on-url-changed.md b/docs/api/0.21/feature-toolbar/mozilla.components.feature.toolbar/-toolbar-presenter/on-url-changed.md new file mode 100644 index 00000000000..b808af35757 --- /dev/null +++ b/docs/api/0.21/feature-toolbar/mozilla.components.feature.toolbar/-toolbar-presenter/on-url-changed.md @@ -0,0 +1,9 @@ +--- +title: ToolbarPresenter.onUrlChanged - +--- + +[mozilla.components.feature.toolbar](../index.html) / [ToolbarPresenter](index.html) / [onUrlChanged](./on-url-changed.html) + +# onUrlChanged + +`fun onUrlChanged(session: Session, url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/feature-toolbar/mozilla.components.feature.toolbar/-toolbar-presenter/start.md b/docs/api/0.21/feature-toolbar/mozilla.components.feature.toolbar/-toolbar-presenter/start.md new file mode 100644 index 00000000000..fcd03cc1be0 --- /dev/null +++ b/docs/api/0.21/feature-toolbar/mozilla.components.feature.toolbar/-toolbar-presenter/start.md @@ -0,0 +1,12 @@ +--- +title: ToolbarPresenter.start - +--- + +[mozilla.components.feature.toolbar](../index.html) / [ToolbarPresenter](index.html) / [start](./start.html) + +# start + +`fun start(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Start presenter: Display data in toolbar. + diff --git a/docs/api/0.21/feature-toolbar/mozilla.components.feature.toolbar/-toolbar-presenter/stop.md b/docs/api/0.21/feature-toolbar/mozilla.components.feature.toolbar/-toolbar-presenter/stop.md new file mode 100644 index 00000000000..8c599ae7aff --- /dev/null +++ b/docs/api/0.21/feature-toolbar/mozilla.components.feature.toolbar/-toolbar-presenter/stop.md @@ -0,0 +1,12 @@ +--- +title: ToolbarPresenter.stop - +--- + +[mozilla.components.feature.toolbar](../index.html) / [ToolbarPresenter](index.html) / [stop](./stop.html) + +# stop + +`fun stop(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Stop presenter from updating the view. + diff --git a/docs/api/0.21/feature-toolbar/mozilla.components.feature.toolbar/index.md b/docs/api/0.21/feature-toolbar/mozilla.components.feature.toolbar/index.md new file mode 100644 index 00000000000..2a2528ddfc5 --- /dev/null +++ b/docs/api/0.21/feature-toolbar/mozilla.components.feature.toolbar/index.md @@ -0,0 +1,18 @@ +--- +title: mozilla.components.feature.toolbar - +--- + +[mozilla.components.feature.toolbar](./index.html) + +## Package mozilla.components.feature.toolbar + +### Types + +| [ToolbarFeature](-toolbar-feature/index.html) | `class ToolbarFeature`
Feature implementation for connecting a toolbar implementation with the session module. | +| [ToolbarInteractor](-toolbar-interactor/index.html) | `class ToolbarInteractor`
Connects a toolbar instance to the browser engine via use cases | +| [ToolbarPresenter](-toolbar-presenter/index.html) | `class ToolbarPresenter : Observer, Observer`
Presenter implementation for a toolbar implementation in order to update the toolbar whenever the state of the selected session changes. | + +### Type Aliases + +| [SearchUseCase](-search-use-case.html) | `typealias SearchUseCase = (`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
A function representing the search use case, accepting the search terms as string. | + diff --git a/docs/api/0.21/feature-toolbar/package-list b/docs/api/0.21/feature-toolbar/package-list new file mode 100644 index 00000000000..3a94c6c59ab --- /dev/null +++ b/docs/api/0.21/feature-toolbar/package-list @@ -0,0 +1,4 @@ +$dokka.format:jekyll +$dokka.linkExtension:html + +mozilla.components.feature.toolbar diff --git a/docs/api/0.21/index.md b/docs/api/0.21/index.md new file mode 100644 index 00000000000..562cfc3e07f --- /dev/null +++ b/docs/api/0.21/index.md @@ -0,0 +1,42 @@ +--- +layout: page +title: API Reference - 0.21 +permalink: /api/0.21/index +--- + + +* [browser-domains](./browser-domains/index.html) +* [browser-engine-gecko](./browser-engine-gecko/index.html) +* [browser-engine-gecko-beta](./browser-engine-gecko-beta/index.html) +* [browser-engine-gecko-nightly](./browser-engine-gecko-nightly/index.html) +* [browser-engine-system](./browser-engine-system/index.html) +* [browser-errorpages](./browser-errorpages/index.html) +* [browser-menu](./browser-menu/index.html) +* [browser-search](./browser-search/index.html) +* [browser-session](./browser-session/index.html) +* [browser-tabstray](./browser-tabstray/index.html) +* [browser-toolbar](./browser-toolbar/index.html) +* [concept-engine](./concept-engine/index.html) +* [concept-tabstray](./concept-tabstray/index.html) +* [concept-toolbar](./concept-toolbar/index.html) +* [feature-search](./feature-search/index.html) +* [feature-session](./feature-session/index.html) +* [feature-tabs](./feature-tabs/index.html) +* [feature-toolbar](./feature-toolbar/index.html) +* [lib-dataprotect](./lib-dataprotect/index.html) +* [samples-browser](./samples-browser/index.html) +* [samples-firefox-accounts](./samples-firefox-accounts/index.html) +* [samples-toolbar](./samples-toolbar/index.html) +* [service-firefox-accounts](./service-firefox-accounts/index.html) +* [service-fretboard](./service-fretboard/index.html) +* [service-telemetry](./service-telemetry/index.html) +* [support-base](./support-base/index.html) +* [support-ktx](./support-ktx/index.html) +* [support-test](./support-test/index.html) +* [support-utils](./support-utils/index.html) +* [ui-autocomplete](./ui-autocomplete/index.html) +* [ui-colors](./ui-colors/index.html) +* [ui-fonts](./ui-fonts/index.html) +* [ui-icons](./ui-icons/index.html) +* [ui-progress](./ui-progress/index.html) +* [ui-tabcounter](./ui-tabcounter/index.html) diff --git a/docs/api/0.21/lib-dataprotect/alltypes/index.md b/docs/api/0.21/lib-dataprotect/alltypes/index.md new file mode 100644 index 00000000000..0960d17b460 --- /dev/null +++ b/docs/api/0.21/lib-dataprotect/alltypes/index.md @@ -0,0 +1,8 @@ +--- +title: alltypes - +--- + +### All Types + +| [mozilla.components.lib.dataprotect.Placeholder](../mozilla.components.lib.dataprotect/-placeholder/index.html) | Just a placeholder until we land the actual component code | + diff --git a/docs/api/0.21/lib-dataprotect/index.md b/docs/api/0.21/lib-dataprotect/index.md new file mode 100644 index 00000000000..66a0e3dbd9a --- /dev/null +++ b/docs/api/0.21/lib-dataprotect/index.md @@ -0,0 +1,11 @@ +--- +title: +--- + +### Packages + +| [mozilla.components.lib.dataprotect](mozilla.components.lib.dataprotect/index.html) | | + +### Index + +[All Types](alltypes/index.html) \ No newline at end of file diff --git a/docs/api/0.21/lib-dataprotect/mozilla.components.lib.dataprotect/-placeholder/-init-.md b/docs/api/0.21/lib-dataprotect/mozilla.components.lib.dataprotect/-placeholder/-init-.md new file mode 100644 index 00000000000..d65ffc94dc5 --- /dev/null +++ b/docs/api/0.21/lib-dataprotect/mozilla.components.lib.dataprotect/-placeholder/-init-.md @@ -0,0 +1,12 @@ +--- +title: Placeholder. - +--- + +[mozilla.components.lib.dataprotect](../index.html) / [Placeholder](index.html) / [<init>](./-init-.html) + +# <init> + +`Placeholder()` + +Just a placeholder until we land the actual component code + diff --git a/docs/api/0.21/lib-dataprotect/mozilla.components.lib.dataprotect/-placeholder/index.md b/docs/api/0.21/lib-dataprotect/mozilla.components.lib.dataprotect/-placeholder/index.md new file mode 100644 index 00000000000..92ab69e3886 --- /dev/null +++ b/docs/api/0.21/lib-dataprotect/mozilla.components.lib.dataprotect/-placeholder/index.md @@ -0,0 +1,16 @@ +--- +title: Placeholder - +--- + +[mozilla.components.lib.dataprotect](../index.html) / [Placeholder](./index.html) + +# Placeholder + +`class Placeholder` + +Just a placeholder until we land the actual component code + +### Constructors + +| [<init>](-init-.html) | `Placeholder()`
Just a placeholder until we land the actual component code | + diff --git a/docs/api/0.21/lib-dataprotect/mozilla.components.lib.dataprotect/index.md b/docs/api/0.21/lib-dataprotect/mozilla.components.lib.dataprotect/index.md new file mode 100644 index 00000000000..66d4d8b79e8 --- /dev/null +++ b/docs/api/0.21/lib-dataprotect/mozilla.components.lib.dataprotect/index.md @@ -0,0 +1,12 @@ +--- +title: mozilla.components.lib.dataprotect - +--- + +[mozilla.components.lib.dataprotect](./index.html) + +## Package mozilla.components.lib.dataprotect + +### Types + +| [Placeholder](-placeholder/index.html) | `class Placeholder`
Just a placeholder until we land the actual component code | + diff --git a/docs/api/0.21/lib-dataprotect/package-list b/docs/api/0.21/lib-dataprotect/package-list new file mode 100644 index 00000000000..7a7fd133f46 --- /dev/null +++ b/docs/api/0.21/lib-dataprotect/package-list @@ -0,0 +1,4 @@ +$dokka.format:jekyll +$dokka.linkExtension:html + +mozilla.components.lib.dataprotect diff --git a/docs/api/0.21/samples-browser/alltypes/index.md b/docs/api/0.21/samples-browser/alltypes/index.md new file mode 100644 index 00000000000..eb2f6cdcc71 --- /dev/null +++ b/docs/api/0.21/samples-browser/alltypes/index.md @@ -0,0 +1,18 @@ +--- +title: alltypes - +--- + +### All Types + +| [org.mozilla.samples.browser.BackHandler](../org.mozilla.samples.browser/-back-handler/index.html) | Interface for fragments that want to handle 'back' button presses. | +| [org.mozilla.samples.browser.BrowserActivity](../org.mozilla.samples.browser/-browser-activity/index.html) | | +| [org.mozilla.samples.browser.BrowserFragment](../org.mozilla.samples.browser/-browser-fragment/index.html) | | +| [org.mozilla.samples.browser.Components](../org.mozilla.samples.browser/-components/index.html) | Helper class for lazily instantiating components needed by the application. | +| [android.content.Context](../org.mozilla.samples.browser.ext/android.content.-context/index.html) (extensions in package org.mozilla.samples.browser.ext) | | +| [org.mozilla.samples.browser.CustomTabActivity](../org.mozilla.samples.browser/-custom-tab-activity/index.html) | | +| [android.support.v4.app.Fragment](../org.mozilla.samples.browser.ext/android.support.v4.app.-fragment/index.html) (extensions in package org.mozilla.samples.browser.ext) | | +| [org.mozilla.samples.browser.IntentReceiverActivity](../org.mozilla.samples.browser/-intent-receiver-activity/index.html) | | +| [org.mozilla.samples.browser.SampleApplication](../org.mozilla.samples.browser/-sample-application/index.html) | | +| [org.mozilla.samples.browser.request.SampleRequestInterceptor](../org.mozilla.samples.browser.request/-sample-request-interceptor/index.html) | | +| [org.mozilla.samples.browser.TabsTrayFragment](../org.mozilla.samples.browser/-tabs-tray-fragment/index.html) | A fragment for displaying the tabs tray. | + diff --git a/docs/api/0.21/samples-browser/index.md b/docs/api/0.21/samples-browser/index.md new file mode 100644 index 00000000000..4b1c00b72d4 --- /dev/null +++ b/docs/api/0.21/samples-browser/index.md @@ -0,0 +1,13 @@ +--- +title: +--- + +### Packages + +| [org.mozilla.samples.browser](org.mozilla.samples.browser/index.html) | | +| [org.mozilla.samples.browser.ext](org.mozilla.samples.browser.ext/index.html) | | +| [org.mozilla.samples.browser.request](org.mozilla.samples.browser.request/index.html) | | + +### Index + +[All Types](alltypes/index.html) \ No newline at end of file diff --git a/docs/api/0.21/samples-browser/org.mozilla.samples.browser.ext/android.content.-context/application.md b/docs/api/0.21/samples-browser/org.mozilla.samples.browser.ext/android.content.-context/application.md new file mode 100644 index 00000000000..9e3c849d89c --- /dev/null +++ b/docs/api/0.21/samples-browser/org.mozilla.samples.browser.ext/android.content.-context/application.md @@ -0,0 +1,12 @@ +--- +title: application - +--- + +[org.mozilla.samples.browser.ext](../index.html) / [android.content.Context](index.html) / [application](./application.html) + +# application + +`val Context.application: `[`SampleApplication`](../../org.mozilla.samples.browser/-sample-application/index.html) + +Get the SampleApplication object from a context. + diff --git a/docs/api/0.21/samples-browser/org.mozilla.samples.browser.ext/android.content.-context/components.md b/docs/api/0.21/samples-browser/org.mozilla.samples.browser.ext/android.content.-context/components.md new file mode 100644 index 00000000000..1d80b0c0de4 --- /dev/null +++ b/docs/api/0.21/samples-browser/org.mozilla.samples.browser.ext/android.content.-context/components.md @@ -0,0 +1,12 @@ +--- +title: components - +--- + +[org.mozilla.samples.browser.ext](../index.html) / [android.content.Context](index.html) / [components](./components.html) + +# components + +`val Context.components: `[`Components`](../../org.mozilla.samples.browser/-components/index.html) + +Get the components of this application. + diff --git a/docs/api/0.21/samples-browser/org.mozilla.samples.browser.ext/android.content.-context/index.md b/docs/api/0.21/samples-browser/org.mozilla.samples.browser.ext/android.content.-context/index.md new file mode 100644 index 00000000000..63548538127 --- /dev/null +++ b/docs/api/0.21/samples-browser/org.mozilla.samples.browser.ext/android.content.-context/index.md @@ -0,0 +1,11 @@ +--- +title: org.mozilla.samples.browser.ext.android.content.Context - +--- + +[org.mozilla.samples.browser.ext](../index.html) / [android.content.Context](./index.html) + +### Extensions for android.content.Context + +| [application](application.html) | `val Context.application: `[`SampleApplication`](../../org.mozilla.samples.browser/-sample-application/index.html)
Get the SampleApplication object from a context. | +| [components](components.html) | `val Context.components: `[`Components`](../../org.mozilla.samples.browser/-components/index.html)
Get the components of this application. | + diff --git a/docs/api/0.21/samples-browser/org.mozilla.samples.browser.ext/android.support.v4.app.-fragment/components.md b/docs/api/0.21/samples-browser/org.mozilla.samples.browser.ext/android.support.v4.app.-fragment/components.md new file mode 100644 index 00000000000..b5c621895eb --- /dev/null +++ b/docs/api/0.21/samples-browser/org.mozilla.samples.browser.ext/android.support.v4.app.-fragment/components.md @@ -0,0 +1,12 @@ +--- +title: components - +--- + +[org.mozilla.samples.browser.ext](../index.html) / [android.support.v4.app.Fragment](index.html) / [components](./components.html) + +# components + +`val Fragment.components: `[`Components`](../../org.mozilla.samples.browser/-components/index.html) + +Get the components of this application. + diff --git a/docs/api/0.21/samples-browser/org.mozilla.samples.browser.ext/android.support.v4.app.-fragment/index.md b/docs/api/0.21/samples-browser/org.mozilla.samples.browser.ext/android.support.v4.app.-fragment/index.md new file mode 100644 index 00000000000..c0623e6b1fa --- /dev/null +++ b/docs/api/0.21/samples-browser/org.mozilla.samples.browser.ext/android.support.v4.app.-fragment/index.md @@ -0,0 +1,10 @@ +--- +title: org.mozilla.samples.browser.ext.android.support.v4.app.Fragment - +--- + +[org.mozilla.samples.browser.ext](../index.html) / [android.support.v4.app.Fragment](./index.html) + +### Extensions for android.support.v4.app.Fragment + +| [components](components.html) | `val Fragment.components: `[`Components`](../../org.mozilla.samples.browser/-components/index.html)
Get the components of this application. | + diff --git a/docs/api/0.21/samples-browser/org.mozilla.samples.browser.ext/index.md b/docs/api/0.21/samples-browser/org.mozilla.samples.browser.ext/index.md new file mode 100644 index 00000000000..5adcd678014 --- /dev/null +++ b/docs/api/0.21/samples-browser/org.mozilla.samples.browser.ext/index.md @@ -0,0 +1,13 @@ +--- +title: org.mozilla.samples.browser.ext - +--- + +[org.mozilla.samples.browser.ext](./index.html) + +## Package org.mozilla.samples.browser.ext + +### Extensions for External Classes + +| [android.content.Context](android.content.-context/index.html) | | +| [android.support.v4.app.Fragment](android.support.v4.app.-fragment/index.html) | | + diff --git a/docs/api/0.21/samples-browser/org.mozilla.samples.browser.request/-sample-request-interceptor/-init-.md b/docs/api/0.21/samples-browser/org.mozilla.samples.browser.request/-sample-request-interceptor/-init-.md new file mode 100644 index 00000000000..f4e4160928a --- /dev/null +++ b/docs/api/0.21/samples-browser/org.mozilla.samples.browser.request/-sample-request-interceptor/-init-.md @@ -0,0 +1,9 @@ +--- +title: SampleRequestInterceptor. - +--- + +[org.mozilla.samples.browser.request](../index.html) / [SampleRequestInterceptor](index.html) / [<init>](./-init-.html) + +# <init> + +`SampleRequestInterceptor()` \ No newline at end of file diff --git a/docs/api/0.21/samples-browser/org.mozilla.samples.browser.request/-sample-request-interceptor/index.md b/docs/api/0.21/samples-browser/org.mozilla.samples.browser.request/-sample-request-interceptor/index.md new file mode 100644 index 00000000000..42592bd44de --- /dev/null +++ b/docs/api/0.21/samples-browser/org.mozilla.samples.browser.request/-sample-request-interceptor/index.md @@ -0,0 +1,18 @@ +--- +title: SampleRequestInterceptor - +--- + +[org.mozilla.samples.browser.request](../index.html) / [SampleRequestInterceptor](./index.html) + +# SampleRequestInterceptor + +`class SampleRequestInterceptor : RequestInterceptor` + +### Constructors + +| [<init>](-init-.html) | `SampleRequestInterceptor()` | + +### Functions + +| [onLoadRequest](on-load-request.html) | `fun onLoadRequest(session: EngineSession, uri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): InterceptionResponse?` | + diff --git a/docs/api/0.21/samples-browser/org.mozilla.samples.browser.request/-sample-request-interceptor/on-load-request.md b/docs/api/0.21/samples-browser/org.mozilla.samples.browser.request/-sample-request-interceptor/on-load-request.md new file mode 100644 index 00000000000..2b50c9743b8 --- /dev/null +++ b/docs/api/0.21/samples-browser/org.mozilla.samples.browser.request/-sample-request-interceptor/on-load-request.md @@ -0,0 +1,9 @@ +--- +title: SampleRequestInterceptor.onLoadRequest - +--- + +[org.mozilla.samples.browser.request](../index.html) / [SampleRequestInterceptor](index.html) / [onLoadRequest](./on-load-request.html) + +# onLoadRequest + +`fun onLoadRequest(session: EngineSession, uri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): InterceptionResponse?` \ No newline at end of file diff --git a/docs/api/0.21/samples-browser/org.mozilla.samples.browser.request/index.md b/docs/api/0.21/samples-browser/org.mozilla.samples.browser.request/index.md new file mode 100644 index 00000000000..ab2403d66ec --- /dev/null +++ b/docs/api/0.21/samples-browser/org.mozilla.samples.browser.request/index.md @@ -0,0 +1,12 @@ +--- +title: org.mozilla.samples.browser.request - +--- + +[org.mozilla.samples.browser.request](./index.html) + +## Package org.mozilla.samples.browser.request + +### Types + +| [SampleRequestInterceptor](-sample-request-interceptor/index.html) | `class SampleRequestInterceptor : RequestInterceptor` | + diff --git a/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-back-handler/index.md b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-back-handler/index.md new file mode 100644 index 00000000000..ffd01592171 --- /dev/null +++ b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-back-handler/index.md @@ -0,0 +1,21 @@ +--- +title: BackHandler - +--- + +[org.mozilla.samples.browser](../index.html) / [BackHandler](./index.html) + +# BackHandler + +`interface BackHandler` + +Interface for fragments that want to handle 'back' button presses. + +### Functions + +| [onBackPressed](on-back-pressed.html) | `abstract fun onBackPressed(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | + +### Inheritors + +| [BrowserFragment](../-browser-fragment/index.html) | `class BrowserFragment : Fragment, `[`BackHandler`](./index.md) | +| [TabsTrayFragment](../-tabs-tray-fragment/index.html) | `class TabsTrayFragment : Fragment, `[`BackHandler`](./index.md)
A fragment for displaying the tabs tray. | + diff --git a/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-back-handler/on-back-pressed.md b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-back-handler/on-back-pressed.md new file mode 100644 index 00000000000..6a646016e42 --- /dev/null +++ b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-back-handler/on-back-pressed.md @@ -0,0 +1,9 @@ +--- +title: BackHandler.onBackPressed - +--- + +[org.mozilla.samples.browser](../index.html) / [BackHandler](index.html) / [onBackPressed](./on-back-pressed.html) + +# onBackPressed + +`abstract fun onBackPressed(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) \ No newline at end of file diff --git a/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-browser-activity/-init-.md b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-browser-activity/-init-.md new file mode 100644 index 00000000000..9f5160c492d --- /dev/null +++ b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-browser-activity/-init-.md @@ -0,0 +1,9 @@ +--- +title: BrowserActivity. - +--- + +[org.mozilla.samples.browser](../index.html) / [BrowserActivity](index.html) / [<init>](./-init-.html) + +# <init> + +`BrowserActivity()` \ No newline at end of file diff --git a/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-browser-activity/index.md b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-browser-activity/index.md new file mode 100644 index 00000000000..1042b17290a --- /dev/null +++ b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-browser-activity/index.md @@ -0,0 +1,29 @@ +--- +title: BrowserActivity - +--- + +[org.mozilla.samples.browser](../index.html) / [BrowserActivity](./index.html) + +# BrowserActivity + +`open class BrowserActivity : AppCompatActivity` + +### Constructors + +| [<init>](-init-.html) | `BrowserActivity()` | + +### Functions + +| [onBackPressed](on-back-pressed.html) | `open fun onBackPressed(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onCreate](on-create.html) | `open fun onCreate(savedInstanceState: Bundle?): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onCreateView](on-create-view.html) | `open fun onCreateView(parent: View?, name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?, context: Context, attrs: AttributeSet?): View?` | + +### Extension Properties + +| [application](../../org.mozilla.samples.browser.ext/android.content.-context/application.html) | `val Context.application: `[`SampleApplication`](../-sample-application/index.html)
Get the SampleApplication object from a context. | +| [components](../../org.mozilla.samples.browser.ext/android.content.-context/components.html) | `val Context.components: `[`Components`](../-components/index.html)
Get the components of this application. | + +### Inheritors + +| [CustomTabActivity](../-custom-tab-activity/index.html) | `class CustomTabActivity : `[`BrowserActivity`](./index.md) | + diff --git a/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-browser-activity/on-back-pressed.md b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-browser-activity/on-back-pressed.md new file mode 100644 index 00000000000..b97f9ed516a --- /dev/null +++ b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-browser-activity/on-back-pressed.md @@ -0,0 +1,9 @@ +--- +title: BrowserActivity.onBackPressed - +--- + +[org.mozilla.samples.browser](../index.html) / [BrowserActivity](index.html) / [onBackPressed](./on-back-pressed.html) + +# onBackPressed + +`open fun onBackPressed(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-browser-activity/on-create-view.md b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-browser-activity/on-create-view.md new file mode 100644 index 00000000000..f8c016a6541 --- /dev/null +++ b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-browser-activity/on-create-view.md @@ -0,0 +1,9 @@ +--- +title: BrowserActivity.onCreateView - +--- + +[org.mozilla.samples.browser](../index.html) / [BrowserActivity](index.html) / [onCreateView](./on-create-view.html) + +# onCreateView + +`open fun onCreateView(parent: View?, name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?, context: Context, attrs: AttributeSet?): View?` \ No newline at end of file diff --git a/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-browser-activity/on-create.md b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-browser-activity/on-create.md new file mode 100644 index 00000000000..d894341fe62 --- /dev/null +++ b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-browser-activity/on-create.md @@ -0,0 +1,9 @@ +--- +title: BrowserActivity.onCreate - +--- + +[org.mozilla.samples.browser](../index.html) / [BrowserActivity](index.html) / [onCreate](./on-create.html) + +# onCreate + +`protected open fun onCreate(savedInstanceState: Bundle?): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-browser-fragment/-init-.md b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-browser-fragment/-init-.md new file mode 100644 index 00000000000..885251142cb --- /dev/null +++ b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-browser-fragment/-init-.md @@ -0,0 +1,9 @@ +--- +title: BrowserFragment. - +--- + +[org.mozilla.samples.browser](../index.html) / [BrowserFragment](index.html) / [<init>](./-init-.html) + +# <init> + +`BrowserFragment()` \ No newline at end of file diff --git a/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-browser-fragment/create.md b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-browser-fragment/create.md new file mode 100644 index 00000000000..e2188225aaa --- /dev/null +++ b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-browser-fragment/create.md @@ -0,0 +1,9 @@ +--- +title: BrowserFragment.create - +--- + +[org.mozilla.samples.browser](../index.html) / [BrowserFragment](index.html) / [create](./create.html) + +# create + +`fun create(sessionId: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null): `[`BrowserFragment`](index.html) \ No newline at end of file diff --git a/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-browser-fragment/index.md b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-browser-fragment/index.md new file mode 100644 index 00000000000..6365cc7cf32 --- /dev/null +++ b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-browser-fragment/index.md @@ -0,0 +1,30 @@ +--- +title: BrowserFragment - +--- + +[org.mozilla.samples.browser](../index.html) / [BrowserFragment](./index.html) + +# BrowserFragment + +`class BrowserFragment : Fragment, `[`BackHandler`](../-back-handler/index.html) + +### Constructors + +| [<init>](-init-.html) | `BrowserFragment()` | + +### Functions + +| [onBackPressed](on-back-pressed.html) | `fun onBackPressed(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [onCreateView](on-create-view.html) | `fun onCreateView(inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?): View?` | +| [onStart](on-start.html) | `fun onStart(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onStop](on-stop.html) | `fun onStop(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onViewCreated](on-view-created.html) | `fun onViewCreated(view: View, savedInstanceState: Bundle?): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | + +### Companion Object Functions + +| [create](create.html) | `fun create(sessionId: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null): `[`BrowserFragment`](./index.md) | + +### Extension Properties + +| [components](../../org.mozilla.samples.browser.ext/android.support.v4.app.-fragment/components.html) | `val Fragment.components: `[`Components`](../-components/index.html)
Get the components of this application. | + diff --git a/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-browser-fragment/on-back-pressed.md b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-browser-fragment/on-back-pressed.md new file mode 100644 index 00000000000..74ba73f3fba --- /dev/null +++ b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-browser-fragment/on-back-pressed.md @@ -0,0 +1,12 @@ +--- +title: BrowserFragment.onBackPressed - +--- + +[org.mozilla.samples.browser](../index.html) / [BrowserFragment](index.html) / [onBackPressed](./on-back-pressed.html) + +# onBackPressed + +`fun onBackPressed(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Overrides [BackHandler.onBackPressed](../-back-handler/on-back-pressed.html) + diff --git a/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-browser-fragment/on-create-view.md b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-browser-fragment/on-create-view.md new file mode 100644 index 00000000000..d0bc1e53e35 --- /dev/null +++ b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-browser-fragment/on-create-view.md @@ -0,0 +1,9 @@ +--- +title: BrowserFragment.onCreateView - +--- + +[org.mozilla.samples.browser](../index.html) / [BrowserFragment](index.html) / [onCreateView](./on-create-view.html) + +# onCreateView + +`fun onCreateView(inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?): View?` \ No newline at end of file diff --git a/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-browser-fragment/on-start.md b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-browser-fragment/on-start.md new file mode 100644 index 00000000000..daa29b14540 --- /dev/null +++ b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-browser-fragment/on-start.md @@ -0,0 +1,9 @@ +--- +title: BrowserFragment.onStart - +--- + +[org.mozilla.samples.browser](../index.html) / [BrowserFragment](index.html) / [onStart](./on-start.html) + +# onStart + +`fun onStart(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-browser-fragment/on-stop.md b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-browser-fragment/on-stop.md new file mode 100644 index 00000000000..2c01d75e67c --- /dev/null +++ b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-browser-fragment/on-stop.md @@ -0,0 +1,9 @@ +--- +title: BrowserFragment.onStop - +--- + +[org.mozilla.samples.browser](../index.html) / [BrowserFragment](index.html) / [onStop](./on-stop.html) + +# onStop + +`fun onStop(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-browser-fragment/on-view-created.md b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-browser-fragment/on-view-created.md new file mode 100644 index 00000000000..fa79219d8f3 --- /dev/null +++ b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-browser-fragment/on-view-created.md @@ -0,0 +1,9 @@ +--- +title: BrowserFragment.onViewCreated - +--- + +[org.mozilla.samples.browser](../index.html) / [BrowserFragment](index.html) / [onViewCreated](./on-view-created.html) + +# onViewCreated + +`fun onViewCreated(view: View, savedInstanceState: Bundle?): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-components/-init-.md b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-components/-init-.md new file mode 100644 index 00000000000..c4976920dd8 --- /dev/null +++ b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-components/-init-.md @@ -0,0 +1,12 @@ +--- +title: Components. - +--- + +[org.mozilla.samples.browser](../index.html) / [Components](index.html) / [<init>](./-init-.html) + +# <init> + +`Components(applicationContext: Context)` + +Helper class for lazily instantiating components needed by the application. + diff --git a/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-components/default-search-use-case.md b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-components/default-search-use-case.md new file mode 100644 index 00000000000..688fb01bf39 --- /dev/null +++ b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-components/default-search-use-case.md @@ -0,0 +1,9 @@ +--- +title: Components.defaultSearchUseCase - +--- + +[org.mozilla.samples.browser](../index.html) / [Components](index.html) / [defaultSearchUseCase](./default-search-use-case.html) + +# defaultSearchUseCase + +`val defaultSearchUseCase: (`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-components/engine.md b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-components/engine.md new file mode 100644 index 00000000000..30c0cf3ceb0 --- /dev/null +++ b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-components/engine.md @@ -0,0 +1,9 @@ +--- +title: Components.engine - +--- + +[org.mozilla.samples.browser](../index.html) / [Components](index.html) / [engine](./engine.html) + +# engine + +`val engine: Engine` \ No newline at end of file diff --git a/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-components/index.md b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-components/index.md new file mode 100644 index 00000000000..abb8cbba8cf --- /dev/null +++ b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-components/index.md @@ -0,0 +1,27 @@ +--- +title: Components - +--- + +[org.mozilla.samples.browser](../index.html) / [Components](./index.html) + +# Components + +`class Components` + +Helper class for lazily instantiating components needed by the application. + +### Constructors + +| [<init>](-init-.html) | `Components(applicationContext: Context)`
Helper class for lazily instantiating components needed by the application. | + +### Properties + +| [defaultSearchUseCase](default-search-use-case.html) | `val defaultSearchUseCase: (`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [engine](engine.html) | `val engine: Engine` | +| [menuBuilder](menu-builder.html) | `val menuBuilder: BrowserMenuBuilder` | +| [sessionIntentProcessor](session-intent-processor.html) | `val sessionIntentProcessor: SessionIntentProcessor` | +| [sessionManager](session-manager.html) | `val sessionManager: SessionManager` | +| [sessionStorage](session-storage.html) | `val sessionStorage: DefaultSessionStorage` | +| [sessionUseCases](session-use-cases.html) | `val sessionUseCases: SessionUseCases` | +| [tabsUseCases](tabs-use-cases.html) | `val tabsUseCases: TabsUseCases` | + diff --git a/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-components/menu-builder.md b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-components/menu-builder.md new file mode 100644 index 00000000000..20136947474 --- /dev/null +++ b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-components/menu-builder.md @@ -0,0 +1,9 @@ +--- +title: Components.menuBuilder - +--- + +[org.mozilla.samples.browser](../index.html) / [Components](index.html) / [menuBuilder](./menu-builder.html) + +# menuBuilder + +`val menuBuilder: BrowserMenuBuilder` \ No newline at end of file diff --git a/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-components/session-intent-processor.md b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-components/session-intent-processor.md new file mode 100644 index 00000000000..6f82e816045 --- /dev/null +++ b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-components/session-intent-processor.md @@ -0,0 +1,9 @@ +--- +title: Components.sessionIntentProcessor - +--- + +[org.mozilla.samples.browser](../index.html) / [Components](index.html) / [sessionIntentProcessor](./session-intent-processor.html) + +# sessionIntentProcessor + +`val sessionIntentProcessor: SessionIntentProcessor` \ No newline at end of file diff --git a/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-components/session-manager.md b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-components/session-manager.md new file mode 100644 index 00000000000..bc65e10404f --- /dev/null +++ b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-components/session-manager.md @@ -0,0 +1,9 @@ +--- +title: Components.sessionManager - +--- + +[org.mozilla.samples.browser](../index.html) / [Components](index.html) / [sessionManager](./session-manager.html) + +# sessionManager + +`val sessionManager: SessionManager` \ No newline at end of file diff --git a/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-components/session-storage.md b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-components/session-storage.md new file mode 100644 index 00000000000..8d4cf71c636 --- /dev/null +++ b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-components/session-storage.md @@ -0,0 +1,9 @@ +--- +title: Components.sessionStorage - +--- + +[org.mozilla.samples.browser](../index.html) / [Components](index.html) / [sessionStorage](./session-storage.html) + +# sessionStorage + +`val sessionStorage: DefaultSessionStorage` \ No newline at end of file diff --git a/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-components/session-use-cases.md b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-components/session-use-cases.md new file mode 100644 index 00000000000..737837dfe38 --- /dev/null +++ b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-components/session-use-cases.md @@ -0,0 +1,9 @@ +--- +title: Components.sessionUseCases - +--- + +[org.mozilla.samples.browser](../index.html) / [Components](index.html) / [sessionUseCases](./session-use-cases.html) + +# sessionUseCases + +`val sessionUseCases: SessionUseCases` \ No newline at end of file diff --git a/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-components/tabs-use-cases.md b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-components/tabs-use-cases.md new file mode 100644 index 00000000000..796ac7dcce7 --- /dev/null +++ b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-components/tabs-use-cases.md @@ -0,0 +1,9 @@ +--- +title: Components.tabsUseCases - +--- + +[org.mozilla.samples.browser](../index.html) / [Components](index.html) / [tabsUseCases](./tabs-use-cases.html) + +# tabsUseCases + +`val tabsUseCases: TabsUseCases` \ No newline at end of file diff --git a/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-custom-tab-activity/-init-.md b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-custom-tab-activity/-init-.md new file mode 100644 index 00000000000..e53b98a4e88 --- /dev/null +++ b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-custom-tab-activity/-init-.md @@ -0,0 +1,9 @@ +--- +title: CustomTabActivity. - +--- + +[org.mozilla.samples.browser](../index.html) / [CustomTabActivity](index.html) / [<init>](./-init-.html) + +# <init> + +`CustomTabActivity()` \ No newline at end of file diff --git a/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-custom-tab-activity/index.md b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-custom-tab-activity/index.md new file mode 100644 index 00000000000..c18677014ce --- /dev/null +++ b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-custom-tab-activity/index.md @@ -0,0 +1,25 @@ +--- +title: CustomTabActivity - +--- + +[org.mozilla.samples.browser](../index.html) / [CustomTabActivity](./index.html) + +# CustomTabActivity + +`class CustomTabActivity : `[`BrowserActivity`](../-browser-activity/index.html) + +### Constructors + +| [<init>](-init-.html) | `CustomTabActivity()` | + +### Inherited Functions + +| [onBackPressed](../-browser-activity/on-back-pressed.html) | `open fun onBackPressed(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onCreate](../-browser-activity/on-create.html) | `open fun onCreate(savedInstanceState: Bundle?): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onCreateView](../-browser-activity/on-create-view.html) | `open fun onCreateView(parent: View?, name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?, context: Context, attrs: AttributeSet?): View?` | + +### Extension Properties + +| [application](../../org.mozilla.samples.browser.ext/android.content.-context/application.html) | `val Context.application: `[`SampleApplication`](../-sample-application/index.html)
Get the SampleApplication object from a context. | +| [components](../../org.mozilla.samples.browser.ext/android.content.-context/components.html) | `val Context.components: `[`Components`](../-components/index.html)
Get the components of this application. | + diff --git a/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-intent-receiver-activity/-init-.md b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-intent-receiver-activity/-init-.md new file mode 100644 index 00000000000..780188f016b --- /dev/null +++ b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-intent-receiver-activity/-init-.md @@ -0,0 +1,9 @@ +--- +title: IntentReceiverActivity. - +--- + +[org.mozilla.samples.browser](../index.html) / [IntentReceiverActivity](index.html) / [<init>](./-init-.html) + +# <init> + +`IntentReceiverActivity()` \ No newline at end of file diff --git a/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-intent-receiver-activity/index.md b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-intent-receiver-activity/index.md new file mode 100644 index 00000000000..a836576694e --- /dev/null +++ b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-intent-receiver-activity/index.md @@ -0,0 +1,23 @@ +--- +title: IntentReceiverActivity - +--- + +[org.mozilla.samples.browser](../index.html) / [IntentReceiverActivity](./index.html) + +# IntentReceiverActivity + +`class IntentReceiverActivity : Activity` + +### Constructors + +| [<init>](-init-.html) | `IntentReceiverActivity()` | + +### Functions + +| [onCreate](on-create.html) | `fun onCreate(savedInstanceState: Bundle?): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | + +### Extension Properties + +| [application](../../org.mozilla.samples.browser.ext/android.content.-context/application.html) | `val Context.application: `[`SampleApplication`](../-sample-application/index.html)
Get the SampleApplication object from a context. | +| [components](../../org.mozilla.samples.browser.ext/android.content.-context/components.html) | `val Context.components: `[`Components`](../-components/index.html)
Get the components of this application. | + diff --git a/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-intent-receiver-activity/on-create.md b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-intent-receiver-activity/on-create.md new file mode 100644 index 00000000000..c927033a399 --- /dev/null +++ b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-intent-receiver-activity/on-create.md @@ -0,0 +1,9 @@ +--- +title: IntentReceiverActivity.onCreate - +--- + +[org.mozilla.samples.browser](../index.html) / [IntentReceiverActivity](index.html) / [onCreate](./on-create.html) + +# onCreate + +`protected fun onCreate(savedInstanceState: Bundle?): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-sample-application/-init-.md b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-sample-application/-init-.md new file mode 100644 index 00000000000..e82330ae2e6 --- /dev/null +++ b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-sample-application/-init-.md @@ -0,0 +1,9 @@ +--- +title: SampleApplication. - +--- + +[org.mozilla.samples.browser](../index.html) / [SampleApplication](index.html) / [<init>](./-init-.html) + +# <init> + +`SampleApplication()` \ No newline at end of file diff --git a/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-sample-application/components.md b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-sample-application/components.md new file mode 100644 index 00000000000..63fb4c7553f --- /dev/null +++ b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-sample-application/components.md @@ -0,0 +1,9 @@ +--- +title: SampleApplication.components - +--- + +[org.mozilla.samples.browser](../index.html) / [SampleApplication](index.html) / [components](./components.html) + +# components + +`val components: `[`Components`](../-components/index.html) \ No newline at end of file diff --git a/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-sample-application/index.md b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-sample-application/index.md new file mode 100644 index 00000000000..ff3c1b962c2 --- /dev/null +++ b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-sample-application/index.md @@ -0,0 +1,23 @@ +--- +title: SampleApplication - +--- + +[org.mozilla.samples.browser](../index.html) / [SampleApplication](./index.html) + +# SampleApplication + +`class SampleApplication : Application` + +### Constructors + +| [<init>](-init-.html) | `SampleApplication()` | + +### Properties + +| [components](components.html) | `val components: `[`Components`](../-components/index.html) | + +### Extension Properties + +| [application](../../org.mozilla.samples.browser.ext/android.content.-context/application.html) | `val Context.application: `[`SampleApplication`](./index.md)
Get the SampleApplication object from a context. | +| [components](../../org.mozilla.samples.browser.ext/android.content.-context/components.html) | `val Context.components: `[`Components`](../-components/index.html)
Get the components of this application. | + diff --git a/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-tabs-tray-fragment/-init-.md b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-tabs-tray-fragment/-init-.md new file mode 100644 index 00000000000..dca38c3481a --- /dev/null +++ b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-tabs-tray-fragment/-init-.md @@ -0,0 +1,12 @@ +--- +title: TabsTrayFragment. - +--- + +[org.mozilla.samples.browser](../index.html) / [TabsTrayFragment](index.html) / [<init>](./-init-.html) + +# <init> + +`TabsTrayFragment()` + +A fragment for displaying the tabs tray. + diff --git a/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-tabs-tray-fragment/index.md b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-tabs-tray-fragment/index.md new file mode 100644 index 00000000000..10f17084cde --- /dev/null +++ b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-tabs-tray-fragment/index.md @@ -0,0 +1,28 @@ +--- +title: TabsTrayFragment - +--- + +[org.mozilla.samples.browser](../index.html) / [TabsTrayFragment](./index.html) + +# TabsTrayFragment + +`class TabsTrayFragment : Fragment, `[`BackHandler`](../-back-handler/index.html) + +A fragment for displaying the tabs tray. + +### Constructors + +| [<init>](-init-.html) | `TabsTrayFragment()`
A fragment for displaying the tabs tray. | + +### Functions + +| [onBackPressed](on-back-pressed.html) | `fun onBackPressed(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [onCreateView](on-create-view.html) | `fun onCreateView(inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?): View` | +| [onStart](on-start.html) | `fun onStart(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onStop](on-stop.html) | `fun onStop(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onViewCreated](on-view-created.html) | `fun onViewCreated(view: View, savedInstanceState: Bundle?): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | + +### Extension Properties + +| [components](../../org.mozilla.samples.browser.ext/android.support.v4.app.-fragment/components.html) | `val Fragment.components: `[`Components`](../-components/index.html)
Get the components of this application. | + diff --git a/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-tabs-tray-fragment/on-back-pressed.md b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-tabs-tray-fragment/on-back-pressed.md new file mode 100644 index 00000000000..55c55127868 --- /dev/null +++ b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-tabs-tray-fragment/on-back-pressed.md @@ -0,0 +1,12 @@ +--- +title: TabsTrayFragment.onBackPressed - +--- + +[org.mozilla.samples.browser](../index.html) / [TabsTrayFragment](index.html) / [onBackPressed](./on-back-pressed.html) + +# onBackPressed + +`fun onBackPressed(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Overrides [BackHandler.onBackPressed](../-back-handler/on-back-pressed.html) + diff --git a/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-tabs-tray-fragment/on-create-view.md b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-tabs-tray-fragment/on-create-view.md new file mode 100644 index 00000000000..016c57f96bf --- /dev/null +++ b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-tabs-tray-fragment/on-create-view.md @@ -0,0 +1,9 @@ +--- +title: TabsTrayFragment.onCreateView - +--- + +[org.mozilla.samples.browser](../index.html) / [TabsTrayFragment](index.html) / [onCreateView](./on-create-view.html) + +# onCreateView + +`fun onCreateView(inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?): View` \ No newline at end of file diff --git a/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-tabs-tray-fragment/on-start.md b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-tabs-tray-fragment/on-start.md new file mode 100644 index 00000000000..f0dc0f7b53a --- /dev/null +++ b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-tabs-tray-fragment/on-start.md @@ -0,0 +1,9 @@ +--- +title: TabsTrayFragment.onStart - +--- + +[org.mozilla.samples.browser](../index.html) / [TabsTrayFragment](index.html) / [onStart](./on-start.html) + +# onStart + +`fun onStart(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-tabs-tray-fragment/on-stop.md b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-tabs-tray-fragment/on-stop.md new file mode 100644 index 00000000000..24a524a265d --- /dev/null +++ b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-tabs-tray-fragment/on-stop.md @@ -0,0 +1,9 @@ +--- +title: TabsTrayFragment.onStop - +--- + +[org.mozilla.samples.browser](../index.html) / [TabsTrayFragment](index.html) / [onStop](./on-stop.html) + +# onStop + +`fun onStop(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-tabs-tray-fragment/on-view-created.md b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-tabs-tray-fragment/on-view-created.md new file mode 100644 index 00000000000..1d135ebc2a0 --- /dev/null +++ b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/-tabs-tray-fragment/on-view-created.md @@ -0,0 +1,9 @@ +--- +title: TabsTrayFragment.onViewCreated - +--- + +[org.mozilla.samples.browser](../index.html) / [TabsTrayFragment](index.html) / [onViewCreated](./on-view-created.html) + +# onViewCreated + +`fun onViewCreated(view: View, savedInstanceState: Bundle?): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/samples-browser/org.mozilla.samples.browser/index.md b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/index.md new file mode 100644 index 00000000000..0d249606680 --- /dev/null +++ b/docs/api/0.21/samples-browser/org.mozilla.samples.browser/index.md @@ -0,0 +1,19 @@ +--- +title: org.mozilla.samples.browser - +--- + +[org.mozilla.samples.browser](./index.html) + +## Package org.mozilla.samples.browser + +### Types + +| [BackHandler](-back-handler/index.html) | `interface BackHandler`
Interface for fragments that want to handle 'back' button presses. | +| [BrowserActivity](-browser-activity/index.html) | `open class BrowserActivity : AppCompatActivity` | +| [BrowserFragment](-browser-fragment/index.html) | `class BrowserFragment : Fragment, `[`BackHandler`](-back-handler/index.html) | +| [Components](-components/index.html) | `class Components`
Helper class for lazily instantiating components needed by the application. | +| [CustomTabActivity](-custom-tab-activity/index.html) | `class CustomTabActivity : `[`BrowserActivity`](-browser-activity/index.html) | +| [IntentReceiverActivity](-intent-receiver-activity/index.html) | `class IntentReceiverActivity : Activity` | +| [SampleApplication](-sample-application/index.html) | `class SampleApplication : Application` | +| [TabsTrayFragment](-tabs-tray-fragment/index.html) | `class TabsTrayFragment : Fragment, `[`BackHandler`](-back-handler/index.html)
A fragment for displaying the tabs tray. | + diff --git a/docs/api/0.21/samples-browser/package-list b/docs/api/0.21/samples-browser/package-list new file mode 100644 index 00000000000..1a61fe304bb --- /dev/null +++ b/docs/api/0.21/samples-browser/package-list @@ -0,0 +1,8 @@ +$dokka.format:jekyll +$dokka.linkExtension:html +$dokka.location:org.mozilla.samples.browser.ext$application#android.content.Contextorg.mozilla.samples.browser.ext/android.content.-context/application.html +$dokka.location:org.mozilla.samples.browser.ext$components#android.content.Contextorg.mozilla.samples.browser.ext/android.content.-context/components.html +$dokka.location:org.mozilla.samples.browser.ext$components#android.support.v4.app.Fragmentorg.mozilla.samples.browser.ext/android.support.v4.app.-fragment/components.html +org.mozilla.samples.browser +org.mozilla.samples.browser.ext +org.mozilla.samples.browser.request diff --git a/docs/api/0.21/samples-firefox-accounts/alltypes/index.md b/docs/api/0.21/samples-firefox-accounts/alltypes/index.md new file mode 100644 index 00000000000..3b91faf8a7c --- /dev/null +++ b/docs/api/0.21/samples-firefox-accounts/alltypes/index.md @@ -0,0 +1,9 @@ +--- +title: alltypes - +--- + +### All Types + +| [org.mozilla.samples.fxa.LoginFragment](../org.mozilla.samples.fxa/-login-fragment/index.html) | | +| [org.mozilla.samples.fxa.MainActivity](../org.mozilla.samples.fxa/-main-activity/index.html) | | + diff --git a/docs/api/0.21/samples-firefox-accounts/index.md b/docs/api/0.21/samples-firefox-accounts/index.md new file mode 100644 index 00000000000..6b43006d4c9 --- /dev/null +++ b/docs/api/0.21/samples-firefox-accounts/index.md @@ -0,0 +1,11 @@ +--- +title: +--- + +### Packages + +| [org.mozilla.samples.fxa](org.mozilla.samples.fxa/index.html) | | + +### Index + +[All Types](alltypes/index.html) \ No newline at end of file diff --git a/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-login-fragment/-a-u-t-h_-u-r-l.md b/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-login-fragment/-a-u-t-h_-u-r-l.md new file mode 100644 index 00000000000..4689cca7a27 --- /dev/null +++ b/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-login-fragment/-a-u-t-h_-u-r-l.md @@ -0,0 +1,9 @@ +--- +title: LoginFragment.AUTH_URL - +--- + +[org.mozilla.samples.fxa](../index.html) / [LoginFragment](index.html) / [AUTH_URL](./-a-u-t-h_-u-r-l.html) + +# AUTH_URL + +`const val AUTH_URL: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) \ No newline at end of file diff --git a/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-login-fragment/-init-.md b/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-login-fragment/-init-.md new file mode 100644 index 00000000000..cc3f5d13fe8 --- /dev/null +++ b/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-login-fragment/-init-.md @@ -0,0 +1,9 @@ +--- +title: LoginFragment. - +--- + +[org.mozilla.samples.fxa](../index.html) / [LoginFragment](index.html) / [<init>](./-init-.html) + +# <init> + +`LoginFragment()` \ No newline at end of file diff --git a/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-login-fragment/-on-login-complete-listener/index.md b/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-login-fragment/-on-login-complete-listener/index.md new file mode 100644 index 00000000000..efd6ced1a17 --- /dev/null +++ b/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-login-fragment/-on-login-complete-listener/index.md @@ -0,0 +1,18 @@ +--- +title: LoginFragment.OnLoginCompleteListener - +--- + +[org.mozilla.samples.fxa](../../index.html) / [LoginFragment](../index.html) / [OnLoginCompleteListener](./index.html) + +# OnLoginCompleteListener + +`interface OnLoginCompleteListener` + +### Functions + +| [onLoginComplete](on-login-complete.html) | `abstract fun onLoginComplete(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)`, fragment: `[`LoginFragment`](../index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | + +### Inheritors + +| [MainActivity](../../-main-activity/index.html) | `open class MainActivity : AppCompatActivity, `[`OnLoginCompleteListener`](./index.md) | + diff --git a/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-login-fragment/-on-login-complete-listener/on-login-complete.md b/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-login-fragment/-on-login-complete-listener/on-login-complete.md new file mode 100644 index 00000000000..0714fdd56a6 --- /dev/null +++ b/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-login-fragment/-on-login-complete-listener/on-login-complete.md @@ -0,0 +1,9 @@ +--- +title: LoginFragment.OnLoginCompleteListener.onLoginComplete - +--- + +[org.mozilla.samples.fxa](../../index.html) / [LoginFragment](../index.html) / [OnLoginCompleteListener](index.html) / [onLoginComplete](./on-login-complete.html) + +# onLoginComplete + +`abstract fun onLoginComplete(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)`, fragment: `[`LoginFragment`](../index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-login-fragment/-r-e-d-i-r-e-c-t_-u-r-l.md b/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-login-fragment/-r-e-d-i-r-e-c-t_-u-r-l.md new file mode 100644 index 00000000000..79456d29a6a --- /dev/null +++ b/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-login-fragment/-r-e-d-i-r-e-c-t_-u-r-l.md @@ -0,0 +1,9 @@ +--- +title: LoginFragment.REDIRECT_URL - +--- + +[org.mozilla.samples.fxa](../index.html) / [LoginFragment](index.html) / [REDIRECT_URL](./-r-e-d-i-r-e-c-t_-u-r-l.html) + +# REDIRECT_URL + +`const val REDIRECT_URL: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) \ No newline at end of file diff --git a/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-login-fragment/create.md b/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-login-fragment/create.md new file mode 100644 index 00000000000..97ddbc04a99 --- /dev/null +++ b/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-login-fragment/create.md @@ -0,0 +1,9 @@ +--- +title: LoginFragment.create - +--- + +[org.mozilla.samples.fxa](../index.html) / [LoginFragment](index.html) / [create](./create.html) + +# create + +`fun create(authUrl: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, redirectUrl: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`LoginFragment`](index.html) \ No newline at end of file diff --git a/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-login-fragment/index.md b/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-login-fragment/index.md new file mode 100644 index 00000000000..14d778e9d34 --- /dev/null +++ b/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-login-fragment/index.md @@ -0,0 +1,36 @@ +--- +title: LoginFragment - +--- + +[org.mozilla.samples.fxa](../index.html) / [LoginFragment](./index.html) + +# LoginFragment + +`class LoginFragment : Fragment` + +### Types + +| [OnLoginCompleteListener](-on-login-complete-listener/index.html) | `interface OnLoginCompleteListener` | + +### Constructors + +| [<init>](-init-.html) | `LoginFragment()` | + +### Functions + +| [onAttach](on-attach.html) | `fun onAttach(context: Context): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onCreate](on-create.html) | `fun onCreate(savedInstanceState: Bundle?): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onCreateView](on-create-view.html) | `fun onCreateView(inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?): View?` | +| [onDetach](on-detach.html) | `fun onDetach(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onPause](on-pause.html) | `fun onPause(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onResume](on-resume.html) | `fun onResume(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | + +### Companion Object Properties + +| [AUTH_URL](-a-u-t-h_-u-r-l.html) | `const val AUTH_URL: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [REDIRECT_URL](-r-e-d-i-r-e-c-t_-u-r-l.html) | `const val REDIRECT_URL: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + +### Companion Object Functions + +| [create](create.html) | `fun create(authUrl: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, redirectUrl: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`LoginFragment`](./index.md) | + diff --git a/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-login-fragment/on-attach.md b/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-login-fragment/on-attach.md new file mode 100644 index 00000000000..d266b24b0fe --- /dev/null +++ b/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-login-fragment/on-attach.md @@ -0,0 +1,9 @@ +--- +title: LoginFragment.onAttach - +--- + +[org.mozilla.samples.fxa](../index.html) / [LoginFragment](index.html) / [onAttach](./on-attach.html) + +# onAttach + +`fun onAttach(context: Context): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-login-fragment/on-create-view.md b/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-login-fragment/on-create-view.md new file mode 100644 index 00000000000..f1af13d1932 --- /dev/null +++ b/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-login-fragment/on-create-view.md @@ -0,0 +1,9 @@ +--- +title: LoginFragment.onCreateView - +--- + +[org.mozilla.samples.fxa](../index.html) / [LoginFragment](index.html) / [onCreateView](./on-create-view.html) + +# onCreateView + +`fun onCreateView(inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?): View?` \ No newline at end of file diff --git a/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-login-fragment/on-create.md b/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-login-fragment/on-create.md new file mode 100644 index 00000000000..fa064b022f8 --- /dev/null +++ b/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-login-fragment/on-create.md @@ -0,0 +1,9 @@ +--- +title: LoginFragment.onCreate - +--- + +[org.mozilla.samples.fxa](../index.html) / [LoginFragment](index.html) / [onCreate](./on-create.html) + +# onCreate + +`fun onCreate(savedInstanceState: Bundle?): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-login-fragment/on-detach.md b/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-login-fragment/on-detach.md new file mode 100644 index 00000000000..336a04606f3 --- /dev/null +++ b/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-login-fragment/on-detach.md @@ -0,0 +1,9 @@ +--- +title: LoginFragment.onDetach - +--- + +[org.mozilla.samples.fxa](../index.html) / [LoginFragment](index.html) / [onDetach](./on-detach.html) + +# onDetach + +`fun onDetach(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-login-fragment/on-pause.md b/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-login-fragment/on-pause.md new file mode 100644 index 00000000000..971409dcbc7 --- /dev/null +++ b/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-login-fragment/on-pause.md @@ -0,0 +1,9 @@ +--- +title: LoginFragment.onPause - +--- + +[org.mozilla.samples.fxa](../index.html) / [LoginFragment](index.html) / [onPause](./on-pause.html) + +# onPause + +`fun onPause(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-login-fragment/on-resume.md b/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-login-fragment/on-resume.md new file mode 100644 index 00000000000..bb8d1b4155f --- /dev/null +++ b/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-login-fragment/on-resume.md @@ -0,0 +1,9 @@ +--- +title: LoginFragment.onResume - +--- + +[org.mozilla.samples.fxa](../index.html) / [LoginFragment](index.html) / [onResume](./on-resume.html) + +# onResume + +`fun onResume(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-main-activity/-c-l-i-e-n-t_-i-d.md b/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-main-activity/-c-l-i-e-n-t_-i-d.md new file mode 100644 index 00000000000..0da280d117e --- /dev/null +++ b/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-main-activity/-c-l-i-e-n-t_-i-d.md @@ -0,0 +1,9 @@ +--- +title: MainActivity.CLIENT_ID - +--- + +[org.mozilla.samples.fxa](../index.html) / [MainActivity](index.html) / [CLIENT_ID](./-c-l-i-e-n-t_-i-d.html) + +# CLIENT_ID + +`const val CLIENT_ID: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) \ No newline at end of file diff --git a/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-main-activity/-c-o-n-f-i-g_-u-r-l.md b/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-main-activity/-c-o-n-f-i-g_-u-r-l.md new file mode 100644 index 00000000000..1cdf6bf73a0 --- /dev/null +++ b/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-main-activity/-c-o-n-f-i-g_-u-r-l.md @@ -0,0 +1,9 @@ +--- +title: MainActivity.CONFIG_URL - +--- + +[org.mozilla.samples.fxa](../index.html) / [MainActivity](index.html) / [CONFIG_URL](./-c-o-n-f-i-g_-u-r-l.html) + +# CONFIG_URL + +`const val CONFIG_URL: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) \ No newline at end of file diff --git a/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-main-activity/-f-x-a_-s-t-a-t-e_-k-e-y.md b/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-main-activity/-f-x-a_-s-t-a-t-e_-k-e-y.md new file mode 100644 index 00000000000..f9f78c8eefa --- /dev/null +++ b/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-main-activity/-f-x-a_-s-t-a-t-e_-k-e-y.md @@ -0,0 +1,9 @@ +--- +title: MainActivity.FXA_STATE_KEY - +--- + +[org.mozilla.samples.fxa](../index.html) / [MainActivity](index.html) / [FXA_STATE_KEY](./-f-x-a_-s-t-a-t-e_-k-e-y.html) + +# FXA_STATE_KEY + +`const val FXA_STATE_KEY: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) \ No newline at end of file diff --git a/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-main-activity/-f-x-a_-s-t-a-t-e_-p-r-e-f-s_-k-e-y.md b/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-main-activity/-f-x-a_-s-t-a-t-e_-p-r-e-f-s_-k-e-y.md new file mode 100644 index 00000000000..db521034047 --- /dev/null +++ b/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-main-activity/-f-x-a_-s-t-a-t-e_-p-r-e-f-s_-k-e-y.md @@ -0,0 +1,9 @@ +--- +title: MainActivity.FXA_STATE_PREFS_KEY - +--- + +[org.mozilla.samples.fxa](../index.html) / [MainActivity](index.html) / [FXA_STATE_PREFS_KEY](./-f-x-a_-s-t-a-t-e_-p-r-e-f-s_-k-e-y.html) + +# FXA_STATE_PREFS_KEY + +`const val FXA_STATE_PREFS_KEY: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) \ No newline at end of file diff --git a/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-main-activity/-init-.md b/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-main-activity/-init-.md new file mode 100644 index 00000000000..4d0d58a5b10 --- /dev/null +++ b/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-main-activity/-init-.md @@ -0,0 +1,9 @@ +--- +title: MainActivity. - +--- + +[org.mozilla.samples.fxa](../index.html) / [MainActivity](index.html) / [<init>](./-init-.html) + +# <init> + +`MainActivity()` \ No newline at end of file diff --git a/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-main-activity/-r-e-d-i-r-e-c-t_-u-r-l.md b/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-main-activity/-r-e-d-i-r-e-c-t_-u-r-l.md new file mode 100644 index 00000000000..d09937cf9c1 --- /dev/null +++ b/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-main-activity/-r-e-d-i-r-e-c-t_-u-r-l.md @@ -0,0 +1,9 @@ +--- +title: MainActivity.REDIRECT_URL - +--- + +[org.mozilla.samples.fxa](../index.html) / [MainActivity](index.html) / [REDIRECT_URL](./-r-e-d-i-r-e-c-t_-u-r-l.html) + +# REDIRECT_URL + +`const val REDIRECT_URL: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) \ No newline at end of file diff --git a/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-main-activity/index.md b/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-main-activity/index.md new file mode 100644 index 00000000000..df1756a53e1 --- /dev/null +++ b/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-main-activity/index.md @@ -0,0 +1,29 @@ +--- +title: MainActivity - +--- + +[org.mozilla.samples.fxa](../index.html) / [MainActivity](./index.html) + +# MainActivity + +`open class MainActivity : AppCompatActivity, `[`OnLoginCompleteListener`](../-login-fragment/-on-login-complete-listener/index.html) + +### Constructors + +| [<init>](-init-.html) | `MainActivity()` | + +### Functions + +| [onCreate](on-create.html) | `open fun onCreate(savedInstanceState: Bundle?): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onDestroy](on-destroy.html) | `open fun onDestroy(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onLoginComplete](on-login-complete.html) | `open fun onLoginComplete(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)`, fragment: `[`LoginFragment`](../-login-fragment/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onNewIntent](on-new-intent.html) | `open fun onNewIntent(intent: Intent): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | + +### Companion Object Properties + +| [CLIENT_ID](-c-l-i-e-n-t_-i-d.html) | `const val CLIENT_ID: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [CONFIG_URL](-c-o-n-f-i-g_-u-r-l.html) | `const val CONFIG_URL: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [FXA_STATE_KEY](-f-x-a_-s-t-a-t-e_-k-e-y.html) | `const val FXA_STATE_KEY: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [FXA_STATE_PREFS_KEY](-f-x-a_-s-t-a-t-e_-p-r-e-f-s_-k-e-y.html) | `const val FXA_STATE_PREFS_KEY: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [REDIRECT_URL](-r-e-d-i-r-e-c-t_-u-r-l.html) | `const val REDIRECT_URL: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + diff --git a/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-main-activity/on-create.md b/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-main-activity/on-create.md new file mode 100644 index 00000000000..9be4a9d4793 --- /dev/null +++ b/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-main-activity/on-create.md @@ -0,0 +1,9 @@ +--- +title: MainActivity.onCreate - +--- + +[org.mozilla.samples.fxa](../index.html) / [MainActivity](index.html) / [onCreate](./on-create.html) + +# onCreate + +`protected open fun onCreate(savedInstanceState: Bundle?): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-main-activity/on-destroy.md b/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-main-activity/on-destroy.md new file mode 100644 index 00000000000..91c70c57d3f --- /dev/null +++ b/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-main-activity/on-destroy.md @@ -0,0 +1,9 @@ +--- +title: MainActivity.onDestroy - +--- + +[org.mozilla.samples.fxa](../index.html) / [MainActivity](index.html) / [onDestroy](./on-destroy.html) + +# onDestroy + +`protected open fun onDestroy(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-main-activity/on-login-complete.md b/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-main-activity/on-login-complete.md new file mode 100644 index 00000000000..cbdf9f21283 --- /dev/null +++ b/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-main-activity/on-login-complete.md @@ -0,0 +1,12 @@ +--- +title: MainActivity.onLoginComplete - +--- + +[org.mozilla.samples.fxa](../index.html) / [MainActivity](index.html) / [onLoginComplete](./on-login-complete.html) + +# onLoginComplete + +`open fun onLoginComplete(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)`, fragment: `[`LoginFragment`](../-login-fragment/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Overrides [OnLoginCompleteListener.onLoginComplete](../-login-fragment/-on-login-complete-listener/on-login-complete.html) + diff --git a/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-main-activity/on-new-intent.md b/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-main-activity/on-new-intent.md new file mode 100644 index 00000000000..a8353543366 --- /dev/null +++ b/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/-main-activity/on-new-intent.md @@ -0,0 +1,9 @@ +--- +title: MainActivity.onNewIntent - +--- + +[org.mozilla.samples.fxa](../index.html) / [MainActivity](index.html) / [onNewIntent](./on-new-intent.html) + +# onNewIntent + +`protected open fun onNewIntent(intent: Intent): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/index.md b/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/index.md new file mode 100644 index 00000000000..a1855ddf3d4 --- /dev/null +++ b/docs/api/0.21/samples-firefox-accounts/org.mozilla.samples.fxa/index.md @@ -0,0 +1,13 @@ +--- +title: org.mozilla.samples.fxa - +--- + +[org.mozilla.samples.fxa](./index.html) + +## Package org.mozilla.samples.fxa + +### Types + +| [LoginFragment](-login-fragment/index.html) | `class LoginFragment : Fragment` | +| [MainActivity](-main-activity/index.html) | `open class MainActivity : AppCompatActivity, `[`OnLoginCompleteListener`](-login-fragment/-on-login-complete-listener/index.html) | + diff --git a/docs/api/0.21/samples-firefox-accounts/package-list b/docs/api/0.21/samples-firefox-accounts/package-list new file mode 100644 index 00000000000..ae22c7b857c --- /dev/null +++ b/docs/api/0.21/samples-firefox-accounts/package-list @@ -0,0 +1,4 @@ +$dokka.format:jekyll +$dokka.linkExtension:html + +org.mozilla.samples.fxa diff --git a/docs/api/0.21/samples-toolbar/alltypes/index.md b/docs/api/0.21/samples-toolbar/alltypes/index.md new file mode 100644 index 00000000000..a2e054d6cb8 --- /dev/null +++ b/docs/api/0.21/samples-toolbar/alltypes/index.md @@ -0,0 +1,14 @@ +--- +title: alltypes - +--- + +### All Types + +| [org.mozilla.samples.toolbar.ConfigurationAdapter](../org.mozilla.samples.toolbar/-configuration-adapter/index.html) | | +| [org.mozilla.samples.toolbar.ConfigurationViewHolder](../org.mozilla.samples.toolbar/-configuration-view-holder/index.html) | | +| [org.mozilla.samples.toolbar.Extra](../org.mozilla.samples.toolbar/-extra.html) | | +| [org.mozilla.samples.toolbar.ReloadPageAction](../org.mozilla.samples.toolbar/-reload-page-action/index.html) | A custom page action that either shows a reload button or a stop button based on the provided isLoading lambda. | +| [org.mozilla.samples.toolbar.ToolbarActivity](../org.mozilla.samples.toolbar/-toolbar-activity/index.html) | This sample application shows how to use and customize the browser-toolbar component. | +| [org.mozilla.samples.toolbar.ToolbarConfiguration](../org.mozilla.samples.toolbar/-toolbar-configuration/index.html) | | +| [org.mozilla.samples.toolbar.UrlBoxProgressView](../org.mozilla.samples.toolbar/-url-box-progress-view/index.html) | A custom view to be drawn behind the URL and page actions. Acts as a custom progress view. | + diff --git a/docs/api/0.21/samples-toolbar/index.md b/docs/api/0.21/samples-toolbar/index.md new file mode 100644 index 00000000000..54a552e64eb --- /dev/null +++ b/docs/api/0.21/samples-toolbar/index.md @@ -0,0 +1,11 @@ +--- +title: +--- + +### Packages + +| [org.mozilla.samples.toolbar](org.mozilla.samples.toolbar/index.html) | | + +### Index + +[All Types](alltypes/index.html) \ No newline at end of file diff --git a/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-configuration-adapter/-init-.md b/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-configuration-adapter/-init-.md new file mode 100644 index 00000000000..95dd3950dd9 --- /dev/null +++ b/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-configuration-adapter/-init-.md @@ -0,0 +1,9 @@ +--- +title: ConfigurationAdapter. - +--- + +[org.mozilla.samples.toolbar](../index.html) / [ConfigurationAdapter](index.html) / [<init>](./-init-.html) + +# <init> + +`ConfigurationAdapter(configuration: `[`ToolbarConfiguration`](../-toolbar-configuration/index.html)`)` \ No newline at end of file diff --git a/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-configuration-adapter/configuration.md b/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-configuration-adapter/configuration.md new file mode 100644 index 00000000000..7e633214d18 --- /dev/null +++ b/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-configuration-adapter/configuration.md @@ -0,0 +1,9 @@ +--- +title: ConfigurationAdapter.configuration - +--- + +[org.mozilla.samples.toolbar](../index.html) / [ConfigurationAdapter](index.html) / [configuration](./configuration.html) + +# configuration + +`val configuration: `[`ToolbarConfiguration`](../-toolbar-configuration/index.html) \ No newline at end of file diff --git a/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-configuration-adapter/get-item-count.md b/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-configuration-adapter/get-item-count.md new file mode 100644 index 00000000000..d089cad7b9d --- /dev/null +++ b/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-configuration-adapter/get-item-count.md @@ -0,0 +1,9 @@ +--- +title: ConfigurationAdapter.getItemCount - +--- + +[org.mozilla.samples.toolbar](../index.html) / [ConfigurationAdapter](index.html) / [getItemCount](./get-item-count.html) + +# getItemCount + +`fun getItemCount(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) \ No newline at end of file diff --git a/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-configuration-adapter/index.md b/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-configuration-adapter/index.md new file mode 100644 index 00000000000..3868579b645 --- /dev/null +++ b/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-configuration-adapter/index.md @@ -0,0 +1,24 @@ +--- +title: ConfigurationAdapter - +--- + +[org.mozilla.samples.toolbar](../index.html) / [ConfigurationAdapter](./index.html) + +# ConfigurationAdapter + +`class ConfigurationAdapter : Adapter<`[`ConfigurationViewHolder`](../-configuration-view-holder/index.html)`>` + +### Constructors + +| [<init>](-init-.html) | `ConfigurationAdapter(configuration: `[`ToolbarConfiguration`](../-toolbar-configuration/index.html)`)` | + +### Properties + +| [configuration](configuration.html) | `val configuration: `[`ToolbarConfiguration`](../-toolbar-configuration/index.html) | + +### Functions + +| [getItemCount](get-item-count.html) | `fun getItemCount(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [onBindViewHolder](on-bind-view-holder.html) | `fun onBindViewHolder(holder: `[`ConfigurationViewHolder`](../-configuration-view-holder/index.html)`, position: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onCreateViewHolder](on-create-view-holder.html) | `fun onCreateViewHolder(parent: ViewGroup, viewType: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`ConfigurationViewHolder`](../-configuration-view-holder/index.html) | + diff --git a/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-configuration-adapter/on-bind-view-holder.md b/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-configuration-adapter/on-bind-view-holder.md new file mode 100644 index 00000000000..25ce30c2f6e --- /dev/null +++ b/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-configuration-adapter/on-bind-view-holder.md @@ -0,0 +1,9 @@ +--- +title: ConfigurationAdapter.onBindViewHolder - +--- + +[org.mozilla.samples.toolbar](../index.html) / [ConfigurationAdapter](index.html) / [onBindViewHolder](./on-bind-view-holder.html) + +# onBindViewHolder + +`fun onBindViewHolder(holder: `[`ConfigurationViewHolder`](../-configuration-view-holder/index.html)`, position: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-configuration-adapter/on-create-view-holder.md b/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-configuration-adapter/on-create-view-holder.md new file mode 100644 index 00000000000..0e9d4e5e82e --- /dev/null +++ b/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-configuration-adapter/on-create-view-holder.md @@ -0,0 +1,9 @@ +--- +title: ConfigurationAdapter.onCreateViewHolder - +--- + +[org.mozilla.samples.toolbar](../index.html) / [ConfigurationAdapter](index.html) / [onCreateViewHolder](./on-create-view-holder.html) + +# onCreateViewHolder + +`fun onCreateViewHolder(parent: ViewGroup, viewType: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`ConfigurationViewHolder`](../-configuration-view-holder/index.html) \ No newline at end of file diff --git a/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-configuration-view-holder/-init-.md b/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-configuration-view-holder/-init-.md new file mode 100644 index 00000000000..8c8d0111ef7 --- /dev/null +++ b/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-configuration-view-holder/-init-.md @@ -0,0 +1,9 @@ +--- +title: ConfigurationViewHolder. - +--- + +[org.mozilla.samples.toolbar](../index.html) / [ConfigurationViewHolder](index.html) / [<init>](./-init-.html) + +# <init> + +`ConfigurationViewHolder(labelView: TextView)` \ No newline at end of file diff --git a/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-configuration-view-holder/index.md b/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-configuration-view-holder/index.md new file mode 100644 index 00000000000..7db9c90f2fc --- /dev/null +++ b/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-configuration-view-holder/index.md @@ -0,0 +1,18 @@ +--- +title: ConfigurationViewHolder - +--- + +[org.mozilla.samples.toolbar](../index.html) / [ConfigurationViewHolder](./index.html) + +# ConfigurationViewHolder + +`class ConfigurationViewHolder : ViewHolder` + +### Constructors + +| [<init>](-init-.html) | `ConfigurationViewHolder(labelView: TextView)` | + +### Properties + +| [labelView](label-view.html) | `val labelView: TextView` | + diff --git a/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-configuration-view-holder/label-view.md b/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-configuration-view-holder/label-view.md new file mode 100644 index 00000000000..92370f5e70e --- /dev/null +++ b/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-configuration-view-holder/label-view.md @@ -0,0 +1,9 @@ +--- +title: ConfigurationViewHolder.labelView - +--- + +[org.mozilla.samples.toolbar](../index.html) / [ConfigurationViewHolder](index.html) / [labelView](./label-view.html) + +# labelView + +`val labelView: TextView` \ No newline at end of file diff --git a/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-extra.md b/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-extra.md new file mode 100644 index 00000000000..6fe1a752e62 --- /dev/null +++ b/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-extra.md @@ -0,0 +1,9 @@ +--- +title: Extra - +--- + +[org.mozilla.samples.toolbar](index.html) / [Extra](./-extra.html) + +# Extra + +`object Extra` \ No newline at end of file diff --git a/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-reload-page-action/-init-.md b/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-reload-page-action/-init-.md new file mode 100644 index 00000000000..d8750205f38 --- /dev/null +++ b/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-reload-page-action/-init-.md @@ -0,0 +1,13 @@ +--- +title: ReloadPageAction. - +--- + +[org.mozilla.samples.toolbar](../index.html) / [ReloadPageAction](index.html) / [<init>](./-init-.html) + +# <init> + +`ReloadPageAction(@DrawableRes reloadImageResource: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, reloadContentDescription: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, stopImageResource: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, stopContentDescription: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, isLoading: () -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`, background: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`? = null, listener: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`)` + +A custom page action that either shows a reload button or a stop button based on the provided +isLoading lambda. + diff --git a/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-reload-page-action/bind.md b/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-reload-page-action/bind.md new file mode 100644 index 00000000000..5a60abef233 --- /dev/null +++ b/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-reload-page-action/bind.md @@ -0,0 +1,9 @@ +--- +title: ReloadPageAction.bind - +--- + +[org.mozilla.samples.toolbar](../index.html) / [ReloadPageAction](index.html) / [bind](./bind.html) + +# bind + +`fun bind(view: View): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-reload-page-action/index.md b/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-reload-page-action/index.md new file mode 100644 index 00000000000..6d83f12e3e3 --- /dev/null +++ b/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-reload-page-action/index.md @@ -0,0 +1,25 @@ +--- +title: ReloadPageAction - +--- + +[org.mozilla.samples.toolbar](../index.html) / [ReloadPageAction](./index.html) + +# ReloadPageAction + +`class ReloadPageAction : Button` + +A custom page action that either shows a reload button or a stop button based on the provided +isLoading lambda. + +### Constructors + +| [<init>](-init-.html) | `ReloadPageAction(reloadImageResource: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, reloadContentDescription: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, stopImageResource: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, stopContentDescription: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, isLoading: () -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`, background: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`? = null, listener: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`)`
A custom page action that either shows a reload button or a stop button based on the provided isLoading lambda. | + +### Properties + +| [loading](loading.html) | `var loading: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | + +### Functions + +| [bind](bind.html) | `fun bind(view: View): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | + diff --git a/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-reload-page-action/loading.md b/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-reload-page-action/loading.md new file mode 100644 index 00000000000..df5450988ca --- /dev/null +++ b/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-reload-page-action/loading.md @@ -0,0 +1,9 @@ +--- +title: ReloadPageAction.loading - +--- + +[org.mozilla.samples.toolbar](../index.html) / [ReloadPageAction](index.html) / [loading](./loading.html) + +# loading + +`var loading: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) \ No newline at end of file diff --git a/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-toolbar-activity/-init-.md b/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-toolbar-activity/-init-.md new file mode 100644 index 00000000000..36da474e6f0 --- /dev/null +++ b/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-toolbar-activity/-init-.md @@ -0,0 +1,12 @@ +--- +title: ToolbarActivity. - +--- + +[org.mozilla.samples.toolbar](../index.html) / [ToolbarActivity](index.html) / [<init>](./-init-.html) + +# <init> + +`ToolbarActivity()` + +This sample application shows how to use and customize the browser-toolbar component. + diff --git a/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-toolbar-activity/index.md b/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-toolbar-activity/index.md new file mode 100644 index 00000000000..db89a380358 --- /dev/null +++ b/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-toolbar-activity/index.md @@ -0,0 +1,21 @@ +--- +title: ToolbarActivity - +--- + +[org.mozilla.samples.toolbar](../index.html) / [ToolbarActivity](./index.html) + +# ToolbarActivity + +`class ToolbarActivity : AppCompatActivity` + +This sample application shows how to use and customize the browser-toolbar component. + +### Constructors + +| [<init>](-init-.html) | `ToolbarActivity()`
This sample application shows how to use and customize the browser-toolbar component. | + +### Functions + +| [onCreate](on-create.html) | `fun onCreate(savedInstanceState: Bundle?): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onPause](on-pause.html) | `fun onPause(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | + diff --git a/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-toolbar-activity/on-create.md b/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-toolbar-activity/on-create.md new file mode 100644 index 00000000000..1d31e2d36bc --- /dev/null +++ b/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-toolbar-activity/on-create.md @@ -0,0 +1,9 @@ +--- +title: ToolbarActivity.onCreate - +--- + +[org.mozilla.samples.toolbar](../index.html) / [ToolbarActivity](index.html) / [onCreate](./on-create.html) + +# onCreate + +`protected fun onCreate(savedInstanceState: Bundle?): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-toolbar-activity/on-pause.md b/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-toolbar-activity/on-pause.md new file mode 100644 index 00000000000..1773f5636c9 --- /dev/null +++ b/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-toolbar-activity/on-pause.md @@ -0,0 +1,9 @@ +--- +title: ToolbarActivity.onPause - +--- + +[org.mozilla.samples.toolbar](../index.html) / [ToolbarActivity](index.html) / [onPause](./on-pause.html) + +# onPause + +`protected fun onPause(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-toolbar-configuration/-d-e-f-a-u-l-t.md b/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-toolbar-configuration/-d-e-f-a-u-l-t.md new file mode 100644 index 00000000000..465835b37f0 --- /dev/null +++ b/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-toolbar-configuration/-d-e-f-a-u-l-t.md @@ -0,0 +1,14 @@ +--- +title: ToolbarConfiguration.DEFAULT - +--- + +[org.mozilla.samples.toolbar](../index.html) / [ToolbarConfiguration](index.html) / [DEFAULT](./-d-e-f-a-u-l-t.html) + +# DEFAULT + +`DEFAULT` + +### Inherited Properties + +| [label](label.html) | `val label: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + diff --git a/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-toolbar-configuration/-f-o-c-u-s_-p-h-o-n-e.md b/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-toolbar-configuration/-f-o-c-u-s_-p-h-o-n-e.md new file mode 100644 index 00000000000..9873b6eee41 --- /dev/null +++ b/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-toolbar-configuration/-f-o-c-u-s_-p-h-o-n-e.md @@ -0,0 +1,14 @@ +--- +title: ToolbarConfiguration.FOCUS_PHONE - +--- + +[org.mozilla.samples.toolbar](../index.html) / [ToolbarConfiguration](index.html) / [FOCUS_PHONE](./-f-o-c-u-s_-p-h-o-n-e.html) + +# FOCUS_PHONE + +`FOCUS_PHONE` + +### Inherited Properties + +| [label](label.html) | `val label: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + diff --git a/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-toolbar-configuration/-f-o-c-u-s_-t-a-b-l-e-t.md b/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-toolbar-configuration/-f-o-c-u-s_-t-a-b-l-e-t.md new file mode 100644 index 00000000000..10dd6ef1c4b --- /dev/null +++ b/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-toolbar-configuration/-f-o-c-u-s_-t-a-b-l-e-t.md @@ -0,0 +1,14 @@ +--- +title: ToolbarConfiguration.FOCUS_TABLET - +--- + +[org.mozilla.samples.toolbar](../index.html) / [ToolbarConfiguration](index.html) / [FOCUS_TABLET](./-f-o-c-u-s_-t-a-b-l-e-t.html) + +# FOCUS_TABLET + +`FOCUS_TABLET` + +### Inherited Properties + +| [label](label.html) | `val label: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + diff --git a/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-toolbar-configuration/-s-e-e-d-l-i-n-g.md b/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-toolbar-configuration/-s-e-e-d-l-i-n-g.md new file mode 100644 index 00000000000..0cfa2724014 --- /dev/null +++ b/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-toolbar-configuration/-s-e-e-d-l-i-n-g.md @@ -0,0 +1,14 @@ +--- +title: ToolbarConfiguration.SEEDLING - +--- + +[org.mozilla.samples.toolbar](../index.html) / [ToolbarConfiguration](index.html) / [SEEDLING](./-s-e-e-d-l-i-n-g.html) + +# SEEDLING + +`SEEDLING` + +### Inherited Properties + +| [label](label.html) | `val label: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + diff --git a/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-toolbar-configuration/index.md b/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-toolbar-configuration/index.md new file mode 100644 index 00000000000..c134a184d9d --- /dev/null +++ b/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-toolbar-configuration/index.md @@ -0,0 +1,21 @@ +--- +title: ToolbarConfiguration - +--- + +[org.mozilla.samples.toolbar](../index.html) / [ToolbarConfiguration](./index.html) + +# ToolbarConfiguration + +`enum class ToolbarConfiguration` + +### Enum Values + +| [DEFAULT](-d-e-f-a-u-l-t.html) | | +| [FOCUS_TABLET](-f-o-c-u-s_-t-a-b-l-e-t.html) | | +| [FOCUS_PHONE](-f-o-c-u-s_-p-h-o-n-e.html) | | +| [SEEDLING](-s-e-e-d-l-i-n-g.html) | | + +### Properties + +| [label](label.html) | `val label: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + diff --git a/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-toolbar-configuration/label.md b/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-toolbar-configuration/label.md new file mode 100644 index 00000000000..0a1b8e9da1c --- /dev/null +++ b/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-toolbar-configuration/label.md @@ -0,0 +1,9 @@ +--- +title: ToolbarConfiguration.label - +--- + +[org.mozilla.samples.toolbar](../index.html) / [ToolbarConfiguration](index.html) / [label](./label.html) + +# label + +`val label: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) \ No newline at end of file diff --git a/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-url-box-progress-view/-init-.md b/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-url-box-progress-view/-init-.md new file mode 100644 index 00000000000..4a736c80535 --- /dev/null +++ b/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-url-box-progress-view/-init-.md @@ -0,0 +1,12 @@ +--- +title: UrlBoxProgressView. - +--- + +[org.mozilla.samples.toolbar](../index.html) / [UrlBoxProgressView](index.html) / [<init>](./-init-.html) + +# <init> + +`UrlBoxProgressView(context: Context)` + +A custom view to be drawn behind the URL and page actions. Acts as a custom progress view. + diff --git a/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-url-box-progress-view/index.md b/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-url-box-progress-view/index.md new file mode 100644 index 00000000000..a08f4496837 --- /dev/null +++ b/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-url-box-progress-view/index.md @@ -0,0 +1,25 @@ +--- +title: UrlBoxProgressView - +--- + +[org.mozilla.samples.toolbar](../index.html) / [UrlBoxProgressView](./index.html) + +# UrlBoxProgressView + +`class UrlBoxProgressView : View` + +A custom view to be drawn behind the URL and page actions. Acts as a custom progress view. + +### Constructors + +| [<init>](-init-.html) | `UrlBoxProgressView(context: Context)`
A custom view to be drawn behind the URL and page actions. Acts as a custom progress view. | + +### Properties + +| [progress](progress.html) | `var progress: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | + +### Functions + +| [onDraw](on-draw.html) | `fun onDraw(canvas: Canvas?): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onSizeChanged](on-size-changed.html) | `fun onSizeChanged(w: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, h: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, oldw: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, oldh: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | + diff --git a/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-url-box-progress-view/on-draw.md b/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-url-box-progress-view/on-draw.md new file mode 100644 index 00000000000..5602d88a11c --- /dev/null +++ b/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-url-box-progress-view/on-draw.md @@ -0,0 +1,9 @@ +--- +title: UrlBoxProgressView.onDraw - +--- + +[org.mozilla.samples.toolbar](../index.html) / [UrlBoxProgressView](index.html) / [onDraw](./on-draw.html) + +# onDraw + +`protected fun onDraw(canvas: Canvas?): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-url-box-progress-view/on-size-changed.md b/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-url-box-progress-view/on-size-changed.md new file mode 100644 index 00000000000..539ab0d8e8a --- /dev/null +++ b/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-url-box-progress-view/on-size-changed.md @@ -0,0 +1,9 @@ +--- +title: UrlBoxProgressView.onSizeChanged - +--- + +[org.mozilla.samples.toolbar](../index.html) / [UrlBoxProgressView](index.html) / [onSizeChanged](./on-size-changed.html) + +# onSizeChanged + +`protected fun onSizeChanged(w: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, h: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, oldw: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, oldh: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-url-box-progress-view/progress.md b/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-url-box-progress-view/progress.md new file mode 100644 index 00000000000..3753d06d222 --- /dev/null +++ b/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/-url-box-progress-view/progress.md @@ -0,0 +1,9 @@ +--- +title: UrlBoxProgressView.progress - +--- + +[org.mozilla.samples.toolbar](../index.html) / [UrlBoxProgressView](index.html) / [progress](./progress.html) + +# progress + +`var progress: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) \ No newline at end of file diff --git a/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/get-toolbar-configuration.md b/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/get-toolbar-configuration.md new file mode 100644 index 00000000000..93b69b9ff10 --- /dev/null +++ b/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/get-toolbar-configuration.md @@ -0,0 +1,9 @@ +--- +title: getToolbarConfiguration - +--- + +[org.mozilla.samples.toolbar](index.html) / [getToolbarConfiguration](./get-toolbar-configuration.html) + +# getToolbarConfiguration + +`fun getToolbarConfiguration(intent: Intent): `[`ToolbarConfiguration`](-toolbar-configuration/index.html) \ No newline at end of file diff --git a/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/index.md b/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/index.md new file mode 100644 index 00000000000..6c2b570a8cd --- /dev/null +++ b/docs/api/0.21/samples-toolbar/org.mozilla.samples.toolbar/index.md @@ -0,0 +1,22 @@ +--- +title: org.mozilla.samples.toolbar - +--- + +[org.mozilla.samples.toolbar](./index.html) + +## Package org.mozilla.samples.toolbar + +### Types + +| [ConfigurationAdapter](-configuration-adapter/index.html) | `class ConfigurationAdapter : Adapter<`[`ConfigurationViewHolder`](-configuration-view-holder/index.html)`>` | +| [ConfigurationViewHolder](-configuration-view-holder/index.html) | `class ConfigurationViewHolder : ViewHolder` | +| [Extra](-extra.html) | `object Extra` | +| [ReloadPageAction](-reload-page-action/index.html) | `class ReloadPageAction : Button`
A custom page action that either shows a reload button or a stop button based on the provided isLoading lambda. | +| [ToolbarActivity](-toolbar-activity/index.html) | `class ToolbarActivity : AppCompatActivity`
This sample application shows how to use and customize the browser-toolbar component. | +| [ToolbarConfiguration](-toolbar-configuration/index.html) | `enum class ToolbarConfiguration` | +| [UrlBoxProgressView](-url-box-progress-view/index.html) | `class UrlBoxProgressView : View`
A custom view to be drawn behind the URL and page actions. Acts as a custom progress view. | + +### Functions + +| [getToolbarConfiguration](get-toolbar-configuration.html) | `fun getToolbarConfiguration(intent: Intent): `[`ToolbarConfiguration`](-toolbar-configuration/index.html) | + diff --git a/docs/api/0.21/samples-toolbar/package-list b/docs/api/0.21/samples-toolbar/package-list new file mode 100644 index 00000000000..88f1cd037ad --- /dev/null +++ b/docs/api/0.21/samples-toolbar/package-list @@ -0,0 +1,4 @@ +$dokka.format:jekyll +$dokka.linkExtension:html + +org.mozilla.samples.toolbar diff --git a/docs/api/0.21/service-firefox-accounts/alltypes/index.md b/docs/api/0.21/service-firefox-accounts/alltypes/index.md new file mode 100644 index 00000000000..9b203c51888 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/alltypes/index.md @@ -0,0 +1,18 @@ +--- +title: alltypes - +--- + +### All Types + +| [mozilla.components.service.fxa.Config](../mozilla.components.service.fxa/-config/index.html) | Config represents the server endpoint configurations needed for the authentication flow. | +| [mozilla.components.service.fxa.Error](../mozilla.components.service.fxa/-error/index.html) | | +| [mozilla.components.service.fxa.FirefoxAccount](../mozilla.components.service.fxa/-firefox-account/index.html) | FirefoxAccount represents the authentication state of a client. | +| [mozilla.components.service.fxa.FxaException](../mozilla.components.service.fxa/-fxa-exception/index.html) | Wrapper class for the exceptions thrown in the Rust library, which ensures that the error messages will be consumed and freed properly in Rust. | +| [mozilla.components.service.fxa.FxaResult](../mozilla.components.service.fxa/-fxa-result/index.html) | FxaResult is a class that represents an asynchronous result. | +| [mozilla.components.service.fxa.OAuthInfo](../mozilla.components.service.fxa/-o-auth-info/index.html) | | +| [mozilla.components.service.fxa.Profile](../mozilla.components.service.fxa/-profile/index.html) | | +| [mozilla.components.service.fxa.RawConfig](../mozilla.components.service.fxa/-raw-config/index.html) | | +| [mozilla.components.service.fxa.RawFxAccount](../mozilla.components.service.fxa/-raw-fx-account/index.html) | | +| [mozilla.components.service.fxa.RustObject](../mozilla.components.service.fxa/-rust-object/index.html) | Base class that wraps an non-optional [Pointer](#) representing a pointer to a Rust object. This class implements [Closeable](http://docs.oracle.com/javase/6/docs/api/java/io/Closeable.html) but does not provide an implementation, forcing all subclasses to implement it. This ensures that all classes that inherit from RustObject will have their [Pointer](#) destroyed when the Java wrapper is destroyed. | +| [mozilla.components.service.fxa.SyncKeys](../mozilla.components.service.fxa/-sync-keys/index.html) | | + diff --git a/docs/api/0.21/service-firefox-accounts/index.md b/docs/api/0.21/service-firefox-accounts/index.md new file mode 100644 index 00000000000..b2a91ff46c0 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/index.md @@ -0,0 +1,11 @@ +--- +title: +--- + +### Packages + +| [mozilla.components.service.fxa](mozilla.components.service.fxa/index.html) | | + +### Index + +[All Types](alltypes/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-config/-init-.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-config/-init-.md new file mode 100644 index 00000000000..ca5079297f8 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-config/-init-.md @@ -0,0 +1,13 @@ +--- +title: Config. - +--- + +[mozilla.components.service.fxa](../index.html) / [Config](index.html) / [<init>](./-init-.html) + +# <init> + +`Config(rawPointer: `[`RawConfig`](../-raw-config/index.html)`?)` + +Config represents the server endpoint configurations needed for the +authentication flow. + diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-config/custom.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-config/custom.md new file mode 100644 index 00000000000..449d82a9907 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-config/custom.md @@ -0,0 +1,15 @@ +--- +title: Config.custom - +--- + +[mozilla.components.service.fxa](../index.html) / [Config](index.html) / [custom](./custom.html) + +# custom + +`fun custom(content_base: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`FxaResult`](../-fxa-result/index.html)`<`[`Config`](index.html)`>` + +Set up endpoints used by a custom host for authentication + +### Parameters + +`content_base` - Hostname of the FxA auth service provider \ No newline at end of file diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-config/destroy.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-config/destroy.md new file mode 100644 index 00000000000..46974c4bf71 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-config/destroy.md @@ -0,0 +1,12 @@ +--- +title: Config.destroy - +--- + +[mozilla.components.service.fxa](../index.html) / [Config](index.html) / [destroy](./destroy.html) + +# destroy + +`protected fun destroy(p: `[`RawConfig`](../-raw-config/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Overrides [RustObject.destroy](../-rust-object/destroy.html) + diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-config/index.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-config/index.md new file mode 100644 index 00000000000..84f024d2cb3 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-config/index.md @@ -0,0 +1,40 @@ +--- +title: Config - +--- + +[mozilla.components.service.fxa](../index.html) / [Config](./index.html) + +# Config + +`class Config : `[`RustObject`](../-rust-object/index.html)`<`[`RawConfig`](../-raw-config/index.html)`>` + +Config represents the server endpoint configurations needed for the +authentication flow. + +### Constructors + +| [<init>](-init-.html) | `Config(rawPointer: `[`RawConfig`](../-raw-config/index.html)`?)`
Config represents the server endpoint configurations needed for the authentication flow. | + +### Properties + +| [rawPointer](raw-pointer.html) | `var rawPointer: `[`RawConfig`](../-raw-config/index.html)`?` | + +### Inherited Properties + +| [isConsumed](../-rust-object/is-consumed.html) | `val isConsumed: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | + +### Functions + +| [destroy](destroy.html) | `fun destroy(p: `[`RawConfig`](../-raw-config/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | + +### Inherited Functions + +| [close](../-rust-object/close.html) | `open fun close(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [consumePointer](../-rust-object/consume-pointer.html) | `fun consumePointer(): `[`T`](../-rust-object/index.html#T) | +| [validPointer](../-rust-object/valid-pointer.html) | `fun validPointer(): `[`T`](../-rust-object/index.html#T) | + +### Companion Object Functions + +| [custom](custom.html) | `fun custom(content_base: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`FxaResult`](../-fxa-result/index.html)`<`[`Config`](./index.md)`>`
Set up endpoints used by a custom host for authentication | +| [release](release.html) | `fun release(): `[`FxaResult`](../-fxa-result/index.html)`<`[`Config`](./index.md)`>`
Set up endpoints used in the production Firefox Accounts instance. | + diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-config/raw-pointer.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-config/raw-pointer.md new file mode 100644 index 00000000000..d4e78be1930 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-config/raw-pointer.md @@ -0,0 +1,12 @@ +--- +title: Config.rawPointer - +--- + +[mozilla.components.service.fxa](../index.html) / [Config](index.html) / [rawPointer](./raw-pointer.html) + +# rawPointer + +`var rawPointer: `[`RawConfig`](../-raw-config/index.html)`?` + +Overrides [RustObject.rawPointer](../-rust-object/raw-pointer.html) + diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-config/release.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-config/release.md new file mode 100644 index 00000000000..b28e52d0e1c --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-config/release.md @@ -0,0 +1,12 @@ +--- +title: Config.release - +--- + +[mozilla.components.service.fxa](../index.html) / [Config](index.html) / [release](./release.html) + +# release + +`fun release(): `[`FxaResult`](../-fxa-result/index.html)`<`[`Config`](index.html)`>` + +Set up endpoints used in the production Firefox Accounts instance. + diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-error/-by-reference/-init-.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-error/-by-reference/-init-.md new file mode 100644 index 00000000000..979787fa525 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-error/-by-reference/-init-.md @@ -0,0 +1,9 @@ +--- +title: Error.ByReference. - +--- + +[mozilla.components.service.fxa](../../index.html) / [Error](../index.html) / [ByReference](index.html) / [<init>](./-init-.html) + +# <init> + +`ByReference()` \ No newline at end of file diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-error/-by-reference/index.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-error/-by-reference/index.md new file mode 100644 index 00000000000..402c92ad6cc --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-error/-by-reference/index.md @@ -0,0 +1,27 @@ +--- +title: Error.ByReference - +--- + +[mozilla.components.service.fxa](../../index.html) / [Error](../index.html) / [ByReference](./index.html) + +# ByReference + +`class ByReference : `[`Error`](../index.html)`, ByReference` + +### Constructors + +| [<init>](-init-.html) | `ByReference()` | + +### Inherited Properties + +| [code](../code.html) | `var code: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [message](../message.html) | `var message: Pointer?` | + +### Inherited Functions + +| [consumeMessage](../consume-message.html) | `fun consumeMessage(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
Get and consume the error message, or null if there is none. | +| [getFieldOrder](../get-field-order.html) | `open fun getFieldOrder(): `[`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)`>` | +| [getMessage](../get-message.html) | `fun getMessage(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
Get the error message or null if there is none. | +| [isFailure](../is-failure.html) | `fun isFailure(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Does this represent failure? | +| [isSuccess](../is-success.html) | `fun isSuccess(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Does this represent success? | + diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-error/-init-.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-error/-init-.md new file mode 100644 index 00000000000..5336c2b4125 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-error/-init-.md @@ -0,0 +1,9 @@ +--- +title: Error. - +--- + +[mozilla.components.service.fxa](../index.html) / [Error](index.html) / [<init>](./-init-.html) + +# <init> + +`Error()` \ No newline at end of file diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-error/code.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-error/code.md new file mode 100644 index 00000000000..2c52079536c --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-error/code.md @@ -0,0 +1,9 @@ +--- +title: Error.code - +--- + +[mozilla.components.service.fxa](../index.html) / [Error](index.html) / [code](./code.html) + +# code + +`@JvmField var code: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-error/consume-message.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-error/consume-message.md new file mode 100644 index 00000000000..e3d58523035 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-error/consume-message.md @@ -0,0 +1,12 @@ +--- +title: Error.consumeMessage - +--- + +[mozilla.components.service.fxa](../index.html) / [Error](index.html) / [consumeMessage](./consume-message.html) + +# consumeMessage + +`fun consumeMessage(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` + +Get and consume the error message, or null if there is none. + diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-error/get-field-order.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-error/get-field-order.md new file mode 100644 index 00000000000..2fe9b17fbc2 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-error/get-field-order.md @@ -0,0 +1,9 @@ +--- +title: Error.getFieldOrder - +--- + +[mozilla.components.service.fxa](../index.html) / [Error](index.html) / [getFieldOrder](./get-field-order.html) + +# getFieldOrder + +`protected open fun getFieldOrder(): `[`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)`>` \ No newline at end of file diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-error/get-message.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-error/get-message.md new file mode 100644 index 00000000000..7fe4a70a351 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-error/get-message.md @@ -0,0 +1,12 @@ +--- +title: Error.getMessage - +--- + +[mozilla.components.service.fxa](../index.html) / [Error](index.html) / [getMessage](./get-message.html) + +# getMessage + +`fun getMessage(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` + +Get the error message or null if there is none. + diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-error/index.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-error/index.md new file mode 100644 index 00000000000..fdc407529e3 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-error/index.md @@ -0,0 +1,35 @@ +--- +title: Error - +--- + +[mozilla.components.service.fxa](../index.html) / [Error](./index.html) + +# Error + +`open class Error : Structure` + +### Types + +| [ByReference](-by-reference/index.html) | `class ByReference : `[`Error`](./index.md)`, ByReference` | + +### Constructors + +| [<init>](-init-.html) | `Error()` | + +### Properties + +| [code](code.html) | `var code: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [message](message.html) | `var message: Pointer?` | + +### Functions + +| [consumeMessage](consume-message.html) | `fun consumeMessage(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
Get and consume the error message, or null if there is none. | +| [getFieldOrder](get-field-order.html) | `open fun getFieldOrder(): `[`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)`>` | +| [getMessage](get-message.html) | `fun getMessage(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
Get the error message or null if there is none. | +| [isFailure](is-failure.html) | `fun isFailure(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Does this represent failure? | +| [isSuccess](is-success.html) | `fun isSuccess(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Does this represent success? | + +### Inheritors + +| [ByReference](-by-reference/index.html) | `class ByReference : `[`Error`](./index.md)`, ByReference` | + diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-error/is-failure.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-error/is-failure.md new file mode 100644 index 00000000000..cafe8f438a5 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-error/is-failure.md @@ -0,0 +1,12 @@ +--- +title: Error.isFailure - +--- + +[mozilla.components.service.fxa](../index.html) / [Error](index.html) / [isFailure](./is-failure.html) + +# isFailure + +`fun isFailure(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Does this represent failure? + diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-error/is-success.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-error/is-success.md new file mode 100644 index 00000000000..1e8fd6337dc --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-error/is-success.md @@ -0,0 +1,12 @@ +--- +title: Error.isSuccess - +--- + +[mozilla.components.service.fxa](../index.html) / [Error](index.html) / [isSuccess](./is-success.html) + +# isSuccess + +`fun isSuccess(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Does this represent success? + diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-error/message.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-error/message.md new file mode 100644 index 00000000000..4aec011bc90 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-error/message.md @@ -0,0 +1,9 @@ +--- +title: Error.message - +--- + +[mozilla.components.service.fxa](../index.html) / [Error](index.html) / [message](./message.html) + +# message + +`@JvmField var message: Pointer?` \ No newline at end of file diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-firefox-account/-init-.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-firefox-account/-init-.md new file mode 100644 index 00000000000..2a649b974dc --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-firefox-account/-init-.md @@ -0,0 +1,14 @@ +--- +title: FirefoxAccount. - +--- + +[mozilla.components.service.fxa](../index.html) / [FirefoxAccount](index.html) / [<init>](./-init-.html) + +# <init> + +`FirefoxAccount(config: `[`Config`](../-config/index.html)`, clientId: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, redirectUri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)``FirefoxAccount(rawPointer: `[`RawFxAccount`](../-raw-fx-account/index.html)`?)` + +FirefoxAccount represents the authentication state of a client. + +**Parameters** + diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-firefox-account/begin-o-auth-flow.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-firefox-account/begin-o-auth-flow.md new file mode 100644 index 00000000000..561d6ab5ff2 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-firefox-account/begin-o-auth-flow.md @@ -0,0 +1,21 @@ +--- +title: FirefoxAccount.beginOAuthFlow - +--- + +[mozilla.components.service.fxa](../index.html) / [FirefoxAccount](index.html) / [beginOAuthFlow](./begin-o-auth-flow.html) + +# beginOAuthFlow + +`fun beginOAuthFlow(scopes: `[`Array`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/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)`): `[`FxaResult`](../-fxa-result/index.html)`<`[`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. + +### Parameters + +`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** +FxaResult that resolves to the flow URL when complete + diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-firefox-account/complete-o-auth-flow.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-firefox-account/complete-o-auth-flow.md new file mode 100644 index 00000000000..0527e0c1fb5 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-firefox-account/complete-o-auth-flow.md @@ -0,0 +1,15 @@ +--- +title: FirefoxAccount.completeOAuthFlow - +--- + +[mozilla.components.service.fxa](../index.html) / [FirefoxAccount](index.html) / [completeOAuthFlow](./complete-o-auth-flow.html) + +# completeOAuthFlow + +`fun completeOAuthFlow(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)`): `[`FxaResult`](../-fxa-result/index.html)`<`[`OAuthInfo`](../-o-auth-info/index.html)`>` + +Authenticates the current account using the code and state parameters fetched from the +redirect URL reached after completing the sign in flow triggered by [beginOAuthFlow](begin-o-auth-flow.html). + +Modifies the FirefoxAccount state. + diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-firefox-account/destroy.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-firefox-account/destroy.md new file mode 100644 index 00000000000..f27d4f76ae7 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-firefox-account/destroy.md @@ -0,0 +1,12 @@ +--- +title: FirefoxAccount.destroy - +--- + +[mozilla.components.service.fxa](../index.html) / [FirefoxAccount](index.html) / [destroy](./destroy.html) + +# destroy + +`protected fun destroy(p: `[`RawFxAccount`](../-raw-fx-account/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Overrides [RustObject.destroy](../-rust-object/destroy.html) + diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-firefox-account/from-j-s-o-n-string.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-firefox-account/from-j-s-o-n-string.md new file mode 100644 index 00000000000..bd57f125080 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-firefox-account/from-j-s-o-n-string.md @@ -0,0 +1,16 @@ +--- +title: FirefoxAccount.fromJSONString - +--- + +[mozilla.components.service.fxa](../index.html) / [FirefoxAccount](index.html) / [fromJSONString](./from-j-s-o-n-string.html) + +# fromJSONString + +`fun fromJSONString(json: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`FxaResult`](../-fxa-result/index.html)`<`[`FirefoxAccount`](index.html)`>` + +Restores the account's authentication state from a JSON string produced by +[FirefoxAccount.toJSONString](to-j-s-o-n-string.html). + +**Return** +FxaResult<[FirefoxAccount](index.html)> representing the authentication state + diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-firefox-account/from.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-firefox-account/from.md new file mode 100644 index 00000000000..c7b10147fc6 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-firefox-account/from.md @@ -0,0 +1,9 @@ +--- +title: FirefoxAccount.from - +--- + +[mozilla.components.service.fxa](../index.html) / [FirefoxAccount](index.html) / [from](./from.html) + +# from + +`fun from(config: `[`Config`](../-config/index.html)`, clientId: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, redirectUri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, webChannelResponse: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`FxaResult`](../-fxa-result/index.html)`<`[`FirefoxAccount`](index.html)`>` \ No newline at end of file diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-firefox-account/get-o-auth-token.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-firefox-account/get-o-auth-token.md new file mode 100644 index 00000000000..2b9bc366320 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-firefox-account/get-o-auth-token.md @@ -0,0 +1,23 @@ +--- +title: FirefoxAccount.getOAuthToken - +--- + +[mozilla.components.service.fxa](../index.html) / [FirefoxAccount](index.html) / [getOAuthToken](./get-o-auth-token.html) + +# getOAuthToken + +`fun getOAuthToken(scopes: `[`Array`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>): `[`FxaResult`](../-fxa-result/index.html)`<`[`OAuthInfo`](../-o-auth-info/index.html)`>` + +Fetches a new access token for the desired scopes using an internally stored refresh token. + +### Parameters + +`scopes` - List of OAuth scopes for which the client wants access + +### Exceptions + +`FxaException.Unauthorized` - if the token could not be retrieved (eg. expired refresh token) + +**Return** +FxaResult<[OAuthInfo](../-o-auth-info/index.html)> that stores the token, along with its scopes and keys when complete + diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-firefox-account/get-profile.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-firefox-account/get-profile.md new file mode 100644 index 00000000000..3d04e9dc9e0 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-firefox-account/get-profile.md @@ -0,0 +1,28 @@ +--- +title: FirefoxAccount.getProfile - +--- + +[mozilla.components.service.fxa](../index.html) / [FirefoxAccount](index.html) / [getProfile](./get-profile.html) + +# getProfile + +`fun getProfile(ignoreCache: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`FxaResult`](../-fxa-result/index.html)`<`[`Profile`](../-profile/index.html)`>` + +Fetches the profile object for the current client either from the existing cached account, +or from the server (requires the client to have access to the profile scope). + +### Parameters + +`ignoreCache` - Fetch the profile information directly from the server + +**Return** +FxaResult<[Profile](../-profile/index.html)> representing the user's basic profile info + +`fun getProfile(): `[`FxaResult`](../-fxa-result/index.html)`<`[`Profile`](../-profile/index.html)`>` + +Convenience method to fetch the profile from a cached account by default, but fall back +to retrieval from the server. + +**Return** +FxaResult<[Profile](../-profile/index.html)> representing the user's basic profile info + diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-firefox-account/get-sync-keys.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-firefox-account/get-sync-keys.md new file mode 100644 index 00000000000..63225a06fab --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-firefox-account/get-sync-keys.md @@ -0,0 +1,12 @@ +--- +title: FirefoxAccount.getSyncKeys - +--- + +[mozilla.components.service.fxa](../index.html) / [FirefoxAccount](index.html) / [getSyncKeys](./get-sync-keys.html) + +# getSyncKeys + +`fun getSyncKeys(): `[`SyncKeys`](../-sync-keys/index.html) + +Fetches keys for encryption/decryption of Firefox Sync data. + diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-firefox-account/get-token-server-endpoint-u-r-l.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-firefox-account/get-token-server-endpoint-u-r-l.md new file mode 100644 index 00000000000..8793cac1d74 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-firefox-account/get-token-server-endpoint-u-r-l.md @@ -0,0 +1,12 @@ +--- +title: FirefoxAccount.getTokenServerEndpointURL - +--- + +[mozilla.components.service.fxa](../index.html) / [FirefoxAccount](index.html) / [getTokenServerEndpointURL](./get-token-server-endpoint-u-r-l.html) + +# getTokenServerEndpointURL + +`fun getTokenServerEndpointURL(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` + +Fetches the token server endpoint, for authentication using the SAML bearer flow. + diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-firefox-account/index.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-firefox-account/index.md new file mode 100644 index 00000000000..4a814c22191 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-firefox-account/index.md @@ -0,0 +1,49 @@ +--- +title: FirefoxAccount - +--- + +[mozilla.components.service.fxa](../index.html) / [FirefoxAccount](./index.html) + +# FirefoxAccount + +`class FirefoxAccount : `[`RustObject`](../-rust-object/index.html)`<`[`RawFxAccount`](../-raw-fx-account/index.html)`>` + +FirefoxAccount represents the authentication state of a client. + +**Parameters** + +### Constructors + +| [<init>](-init-.html) | `FirefoxAccount(config: `[`Config`](../-config/index.html)`, clientId: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, redirectUri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)``FirefoxAccount(rawPointer: `[`RawFxAccount`](../-raw-fx-account/index.html)`?)`
FirefoxAccount represents the authentication state of a client. | + +### Properties + +| [rawPointer](raw-pointer.html) | `var rawPointer: `[`RawFxAccount`](../-raw-fx-account/index.html)`?` | + +### Inherited Properties + +| [isConsumed](../-rust-object/is-consumed.html) | `val isConsumed: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | + +### Functions + +| [beginOAuthFlow](begin-o-auth-flow.html) | `fun beginOAuthFlow(scopes: `[`Array`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/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)`): `[`FxaResult`](../-fxa-result/index.html)`<`[`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. | +| [completeOAuthFlow](complete-o-auth-flow.html) | `fun completeOAuthFlow(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)`): `[`FxaResult`](../-fxa-result/index.html)`<`[`OAuthInfo`](../-o-auth-info/index.html)`>`
Authenticates the current account using the code and state parameters fetched from the redirect URL reached after completing the sign in flow triggered by [beginOAuthFlow](begin-o-auth-flow.html). | +| [destroy](destroy.html) | `fun destroy(p: `[`RawFxAccount`](../-raw-fx-account/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [getOAuthToken](get-o-auth-token.html) | `fun getOAuthToken(scopes: `[`Array`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>): `[`FxaResult`](../-fxa-result/index.html)`<`[`OAuthInfo`](../-o-auth-info/index.html)`>`
Fetches a new access token for the desired scopes using an internally stored refresh token. | +| [getProfile](get-profile.html) | `fun getProfile(ignoreCache: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`FxaResult`](../-fxa-result/index.html)`<`[`Profile`](../-profile/index.html)`>`
Fetches the profile object for the current client either from the existing cached account, or from the server (requires the client to have access to the profile scope).`fun getProfile(): `[`FxaResult`](../-fxa-result/index.html)`<`[`Profile`](../-profile/index.html)`>`
Convenience method to fetch the profile from a cached account by default, but fall back to retrieval from the server. | +| [getSyncKeys](get-sync-keys.html) | `fun getSyncKeys(): `[`SyncKeys`](../-sync-keys/index.html)
Fetches keys for encryption/decryption of Firefox Sync data. | +| [getTokenServerEndpointURL](get-token-server-endpoint-u-r-l.html) | `fun getTokenServerEndpointURL(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
Fetches the token server endpoint, for authentication using the SAML bearer flow. | +| [newAssertion](new-assertion.html) | `fun newAssertion(audience: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
Creates a new SAML assertion from the account state, which can be posted to the token server endpoint fetched from [getTokenServerEndpointURL](get-token-server-endpoint-u-r-l.html) in order to get an access token. | +| [toJSONString](to-j-s-o-n-string.html) | `fun toJSONString(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
Saves the current account's authentication state as a JSON string, for persistence in the Android KeyStore/shared preferences. The authentication state can be restored using [FirefoxAccount.fromJSONString](from-j-s-o-n-string.html). | + +### Inherited Functions + +| [close](../-rust-object/close.html) | `open fun close(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [consumePointer](../-rust-object/consume-pointer.html) | `fun consumePointer(): `[`T`](../-rust-object/index.html#T) | +| [validPointer](../-rust-object/valid-pointer.html) | `fun validPointer(): `[`T`](../-rust-object/index.html#T) | + +### Companion Object Functions + +| [from](from.html) | `fun from(config: `[`Config`](../-config/index.html)`, clientId: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, redirectUri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, webChannelResponse: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`FxaResult`](../-fxa-result/index.html)`<`[`FirefoxAccount`](./index.md)`>` | +| [fromJSONString](from-j-s-o-n-string.html) | `fun fromJSONString(json: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`FxaResult`](../-fxa-result/index.html)`<`[`FirefoxAccount`](./index.md)`>`
Restores the account's authentication state from a JSON string produced by [FirefoxAccount.toJSONString](to-j-s-o-n-string.html). | + diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-firefox-account/new-assertion.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-firefox-account/new-assertion.md new file mode 100644 index 00000000000..3ec634c8f8d --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-firefox-account/new-assertion.md @@ -0,0 +1,16 @@ +--- +title: FirefoxAccount.newAssertion - +--- + +[mozilla.components.service.fxa](../index.html) / [FirefoxAccount](index.html) / [newAssertion](./new-assertion.html) + +# newAssertion + +`fun newAssertion(audience: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` + +Creates a new SAML assertion from the account state, which can be posted to the token server +endpoint fetched from [getTokenServerEndpointURL](get-token-server-endpoint-u-r-l.html) in order to get an access token. + +**Return** +String representing the SAML assertion + diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-firefox-account/raw-pointer.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-firefox-account/raw-pointer.md new file mode 100644 index 00000000000..01840abdbdb --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-firefox-account/raw-pointer.md @@ -0,0 +1,12 @@ +--- +title: FirefoxAccount.rawPointer - +--- + +[mozilla.components.service.fxa](../index.html) / [FirefoxAccount](index.html) / [rawPointer](./raw-pointer.html) + +# rawPointer + +`var rawPointer: `[`RawFxAccount`](../-raw-fx-account/index.html)`?` + +Overrides [RustObject.rawPointer](../-rust-object/raw-pointer.html) + diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-firefox-account/to-j-s-o-n-string.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-firefox-account/to-j-s-o-n-string.md new file mode 100644 index 00000000000..14f93f5d952 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-firefox-account/to-j-s-o-n-string.md @@ -0,0 +1,17 @@ +--- +title: FirefoxAccount.toJSONString - +--- + +[mozilla.components.service.fxa](../index.html) / [FirefoxAccount](index.html) / [toJSONString](./to-j-s-o-n-string.html) + +# toJSONString + +`fun toJSONString(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` + +Saves the current account's authentication state as a JSON string, for persistence in +the Android KeyStore/shared preferences. The authentication state can be restored using +[FirefoxAccount.fromJSONString](from-j-s-o-n-string.html). + +**Return** +String containing the authentication details in JSON format + diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-fxa-exception/-init-.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-fxa-exception/-init-.md new file mode 100644 index 00000000000..19e92080a85 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-fxa-exception/-init-.md @@ -0,0 +1,13 @@ +--- +title: FxaException. - +--- + +[mozilla.components.service.fxa](../index.html) / [FxaException](index.html) / [<init>](./-init-.html) + +# <init> + +`FxaException(message: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)` + +Wrapper class for the exceptions thrown in the Rust library, which ensures that the +error messages will be consumed and freed properly in Rust. + diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-fxa-exception/-panic/-init-.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-fxa-exception/-panic/-init-.md new file mode 100644 index 00000000000..371d9cbe57b --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-fxa-exception/-panic/-init-.md @@ -0,0 +1,9 @@ +--- +title: FxaException.Panic. - +--- + +[mozilla.components.service.fxa](../../index.html) / [FxaException](../index.html) / [Panic](index.html) / [<init>](./-init-.html) + +# <init> + +`Panic(msg: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)` \ No newline at end of file diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-fxa-exception/-panic/index.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-fxa-exception/-panic/index.md new file mode 100644 index 00000000000..0ae384370f1 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-fxa-exception/-panic/index.md @@ -0,0 +1,14 @@ +--- +title: FxaException.Panic - +--- + +[mozilla.components.service.fxa](../../index.html) / [FxaException](../index.html) / [Panic](./index.html) + +# Panic + +`class Panic : `[`FxaException`](../index.html) + +### Constructors + +| [<init>](-init-.html) | `Panic(msg: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)` | + diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-fxa-exception/-unauthorized/-init-.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-fxa-exception/-unauthorized/-init-.md new file mode 100644 index 00000000000..10ad2874921 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-fxa-exception/-unauthorized/-init-.md @@ -0,0 +1,9 @@ +--- +title: FxaException.Unauthorized. - +--- + +[mozilla.components.service.fxa](../../index.html) / [FxaException](../index.html) / [Unauthorized](index.html) / [<init>](./-init-.html) + +# <init> + +`Unauthorized(msg: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)` \ No newline at end of file diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-fxa-exception/-unauthorized/index.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-fxa-exception/-unauthorized/index.md new file mode 100644 index 00000000000..7767204dd27 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-fxa-exception/-unauthorized/index.md @@ -0,0 +1,14 @@ +--- +title: FxaException.Unauthorized - +--- + +[mozilla.components.service.fxa](../../index.html) / [FxaException](../index.html) / [Unauthorized](./index.html) + +# Unauthorized + +`class Unauthorized : `[`FxaException`](../index.html) + +### Constructors + +| [<init>](-init-.html) | `Unauthorized(msg: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)` | + diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-fxa-exception/-unspecified/-init-.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-fxa-exception/-unspecified/-init-.md new file mode 100644 index 00000000000..49b0dddadb1 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-fxa-exception/-unspecified/-init-.md @@ -0,0 +1,9 @@ +--- +title: FxaException.Unspecified. - +--- + +[mozilla.components.service.fxa](../../index.html) / [FxaException](../index.html) / [Unspecified](index.html) / [<init>](./-init-.html) + +# <init> + +`Unspecified(msg: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)` \ No newline at end of file diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-fxa-exception/-unspecified/index.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-fxa-exception/-unspecified/index.md new file mode 100644 index 00000000000..d0cbd3b4fc5 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-fxa-exception/-unspecified/index.md @@ -0,0 +1,14 @@ +--- +title: FxaException.Unspecified - +--- + +[mozilla.components.service.fxa](../../index.html) / [FxaException](../index.html) / [Unspecified](./index.html) + +# Unspecified + +`class Unspecified : `[`FxaException`](../index.html) + +### Constructors + +| [<init>](-init-.html) | `Unspecified(msg: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)` | + diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-fxa-exception/from-consuming.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-fxa-exception/from-consuming.md new file mode 100644 index 00000000000..af091479079 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-fxa-exception/from-consuming.md @@ -0,0 +1,9 @@ +--- +title: FxaException.fromConsuming - +--- + +[mozilla.components.service.fxa](../index.html) / [FxaException](index.html) / [fromConsuming](./from-consuming.html) + +# fromConsuming + +`fun fromConsuming(e: `[`Error`](../-error/index.html)`): `[`FxaException`](index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-fxa-exception/index.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-fxa-exception/index.md new file mode 100644 index 00000000000..b0908eef363 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-fxa-exception/index.md @@ -0,0 +1,33 @@ +--- +title: FxaException - +--- + +[mozilla.components.service.fxa](../index.html) / [FxaException](./index.html) + +# FxaException + +`open class FxaException : `[`Exception`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html) + +Wrapper class for the exceptions thrown in the Rust library, which ensures that the +error messages will be consumed and freed properly in Rust. + +### Exceptions + +| [Panic](-panic/index.html) | `class Panic : `[`FxaException`](./index.md) | +| [Unauthorized](-unauthorized/index.html) | `class Unauthorized : `[`FxaException`](./index.md) | +| [Unspecified](-unspecified/index.html) | `class Unspecified : `[`FxaException`](./index.md) | + +### Constructors + +| [<init>](-init-.html) | `FxaException(message: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)`
Wrapper class for the exceptions thrown in the Rust library, which ensures that the error messages will be consumed and freed properly in Rust. | + +### Companion Object Functions + +| [fromConsuming](from-consuming.html) | `fun fromConsuming(e: `[`Error`](../-error/index.html)`): `[`FxaException`](./index.md) | + +### Inheritors + +| [Panic](-panic/index.html) | `class Panic : `[`FxaException`](./index.md) | +| [Unauthorized](-unauthorized/index.html) | `class Unauthorized : `[`FxaException`](./index.md) | +| [Unspecified](-unspecified/index.html) | `class Unspecified : `[`FxaException`](./index.md) | + diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-fxa-result/-init-.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-fxa-result/-init-.md new file mode 100644 index 00000000000..25212d9c307 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-fxa-result/-init-.md @@ -0,0 +1,14 @@ +--- +title: FxaResult. - +--- + +[mozilla.components.service.fxa](../index.html) / [FxaResult](index.html) / [<init>](./-init-.html) + +# <init> + +`FxaResult()` + +FxaResult is a class that represents an asynchronous result. + +**Parameters** + diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-fxa-result/-on-exception-listener/index.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-fxa-result/-on-exception-listener/index.md new file mode 100644 index 00000000000..80f8e0a9532 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-fxa-result/-on-exception-listener/index.md @@ -0,0 +1,18 @@ +--- +title: FxaResult.OnExceptionListener - +--- + +[mozilla.components.service.fxa](../../index.html) / [FxaResult](../index.html) / [OnExceptionListener](./index.html) + +# OnExceptionListener + +`@FunctionalInterface interface OnExceptionListener` + +An interface used to deliver exceptions to listeners of a [FxaResult](../index.html) + +**Parameters** + +### Functions + +| [onException](on-exception.html) | `abstract fun onException(exception: `[`Exception`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html)`): `[`FxaResult`](../index.html)`<`[`V`](index.html#V)`>?` | + diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-fxa-result/-on-exception-listener/on-exception.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-fxa-result/-on-exception-listener/on-exception.md new file mode 100644 index 00000000000..20159dccb18 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-fxa-result/-on-exception-listener/on-exception.md @@ -0,0 +1,9 @@ +--- +title: FxaResult.OnExceptionListener.onException - +--- + +[mozilla.components.service.fxa](../../index.html) / [FxaResult](../index.html) / [OnExceptionListener](index.html) / [onException](./on-exception.html) + +# onException + +`abstract fun onException(exception: `[`Exception`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html)`): `[`FxaResult`](../index.html)`<`[`V`](index.html#V)`>?` \ No newline at end of file diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-fxa-result/-on-value-listener/index.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-fxa-result/-on-value-listener/index.md new file mode 100644 index 00000000000..d551417931b --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-fxa-result/-on-value-listener/index.md @@ -0,0 +1,20 @@ +--- +title: FxaResult.OnValueListener - +--- + +[mozilla.components.service.fxa](../../index.html) / [FxaResult](../index.html) / [OnValueListener](./index.html) + +# OnValueListener + +`@FunctionalInterface interface OnValueListener` + +An interface used to deliver values to listeners of a [FxaResult](../index.html) + +**Parameters** + +**Parameters** + +### Functions + +| [onValue](on-value.html) | `abstract fun onValue(value: `[`T`](index.html#T)`): `[`FxaResult`](../index.html)`<`[`U`](index.html#U)`>?`
Called when a [FxaResult](../index.html) is completed with a value. This will be called on the same thread in which the result was completed. | + diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-fxa-result/-on-value-listener/on-value.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-fxa-result/-on-value-listener/on-value.md new file mode 100644 index 00000000000..bed4ffe5240 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-fxa-result/-on-value-listener/on-value.md @@ -0,0 +1,21 @@ +--- +title: FxaResult.OnValueListener.onValue - +--- + +[mozilla.components.service.fxa](../../index.html) / [FxaResult](../index.html) / [OnValueListener](index.html) / [onValue](./on-value.html) + +# onValue + +`abstract fun onValue(value: `[`T`](index.html#T)`): `[`FxaResult`](../index.html)`<`[`U`](index.html#U)`>?` + +Called when a [FxaResult](../index.html) is completed with a value. This will be +called on the same thread in which the result was completed. + +### Parameters + +`value` - The value of the [FxaResult](../index.html) + +**Return** +A new [FxaResult](../index.html), used for chaining results together. +May be null. + diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-fxa-result/complete-exceptionally.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-fxa-result/complete-exceptionally.md new file mode 100644 index 00000000000..c277578e7b3 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-fxa-result/complete-exceptionally.md @@ -0,0 +1,20 @@ +--- +title: FxaResult.completeExceptionally - +--- + +[mozilla.components.service.fxa](../index.html) / [FxaResult](index.html) / [completeExceptionally](./complete-exceptionally.html) + +# completeExceptionally + +`@Synchronized fun completeExceptionally(exception: `[`Exception`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +This completes the result with the specified [Exception](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html). IllegalStateException is thrown +if the result is already complete. + +### Parameters + +`exception` - The [Exception](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html) used to complete the result. + +### Exceptions + +`IllegalStateException` - \ No newline at end of file diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-fxa-result/complete.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-fxa-result/complete.md new file mode 100644 index 00000000000..308179b5d97 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-fxa-result/complete.md @@ -0,0 +1,20 @@ +--- +title: FxaResult.complete - +--- + +[mozilla.components.service.fxa](../index.html) / [FxaResult](index.html) / [complete](./complete.html) + +# complete + +`@Synchronized fun complete(value: `[`T`](index.html#T)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +This completes the result with the specified value. IllegalStateException is thrown +if the result is already complete. + +### Parameters + +`value` - The value used to complete the result. + +### Exceptions + +`IllegalStateException` - \ No newline at end of file diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-fxa-result/from-exception.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-fxa-result/from-exception.md new file mode 100644 index 00000000000..8b13f29b72a --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-fxa-result/from-exception.md @@ -0,0 +1,20 @@ +--- +title: FxaResult.fromException - +--- + +[mozilla.components.service.fxa](../index.html) / [FxaResult](index.html) / [fromException](./from-exception.html) + +# fromException + +`fun fromException(exception: `[`Exception`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html)`): `[`FxaResult`](index.html)`<`[`T`](from-exception.html#T)`>` + +This constructs a result that is completed with the specified [Exception](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html). +May not be null. + +### Parameters + +`exception` - The exception used to complete the newly created result. + +**Return** +The completed [FxaResult](index.html) + diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-fxa-result/from-value.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-fxa-result/from-value.md new file mode 100644 index 00000000000..49d6f0f2a34 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-fxa-result/from-value.md @@ -0,0 +1,19 @@ +--- +title: FxaResult.fromValue - +--- + +[mozilla.components.service.fxa](../index.html) / [FxaResult](index.html) / [fromValue](./from-value.html) + +# fromValue + +`fun fromValue(value: `[`U`](from-value.html#U)`): `[`FxaResult`](index.html)`<`[`U`](from-value.html#U)`>` + +This constructs a result that is fulfilled with the specified value. + +### Parameters + +`value` - The value used to complete the newly created result. + +**Return** +The completed [FxaResult](index.html) + diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-fxa-result/index.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-fxa-result/index.md new file mode 100644 index 00000000000..3480c2bd77b --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-fxa-result/index.md @@ -0,0 +1,35 @@ +--- +title: FxaResult - +--- + +[mozilla.components.service.fxa](../index.html) / [FxaResult](./index.html) + +# FxaResult + +`class FxaResult` + +FxaResult is a class that represents an asynchronous result. + +**Parameters** + +### Types + +| [OnExceptionListener](-on-exception-listener/index.html) | `interface OnExceptionListener`
An interface used to deliver exceptions to listeners of a [FxaResult](./index.md) | +| [OnValueListener](-on-value-listener/index.html) | `interface OnValueListener`
An interface used to deliver values to listeners of a [FxaResult](./index.md) | + +### Constructors + +| [<init>](-init-.html) | `FxaResult()`
FxaResult is a class that represents an asynchronous result. | + +### Functions + +| [complete](complete.html) | `fun complete(value: `[`T`](index.html#T)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
This completes the result with the specified value. IllegalStateException is thrown if the result is already complete. | +| [completeExceptionally](complete-exceptionally.html) | `fun completeExceptionally(exception: `[`Exception`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
This completes the result with the specified [Exception](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html). IllegalStateException is thrown if the result is already complete. | +| [then](then.html) | `fun then(fn: (value: `[`T`](index.html#T)`) -> `[`FxaResult`](./index.md)`<`[`U`](then.html#U)`>?): `[`FxaResult`](./index.md)`<`[`U`](then.html#U)`>`
Adds a value listener to be called when the [FxaResult](./index.md) is completed with a value. Listeners will be invoked on the same thread in which the [FxaResult](./index.md) was completed.`fun then(vfn: (value: `[`T`](index.html#T)`) -> `[`FxaResult`](./index.md)`<`[`U`](then.html#U)`>?, efn: (`[`Exception`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html)`) -> `[`FxaResult`](./index.md)`<`[`U`](then.html#U)`>?): `[`FxaResult`](./index.md)`<`[`U`](then.html#U)`>`
`fun then(valueListener: `[`OnValueListener`](-on-value-listener/index.html)`<`[`T`](index.html#T)`, `[`U`](then.html#U)`>, exceptionListener: `[`OnExceptionListener`](-on-exception-listener/index.html)`<`[`U`](then.html#U)`>?): `[`FxaResult`](./index.md)`<`[`U`](then.html#U)`>`
Adds listeners to be called when the [FxaResult](./index.md) is completed either with a value or [Exception](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html). Listeners will be invoked on the same thread in which the [FxaResult](./index.md) was completed. | +| [whenComplete](when-complete.html) | `fun whenComplete(fn: (value: `[`T`](index.html#T)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Adds a value listener to be called when the [FxaResult](./index.md) and the whole chain of [then](then.html) calls is completed with a value. Listeners will be invoked on the same thread in which the [FxaResult](./index.md) was completed. | + +### Companion Object Functions + +| [fromException](from-exception.html) | `fun fromException(exception: `[`Exception`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html)`): `[`FxaResult`](./index.md)`<`[`T`](from-exception.html#T)`>`
This constructs a result that is completed with the specified [Exception](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html). May not be null. | +| [fromValue](from-value.html) | `fun fromValue(value: `[`U`](from-value.html#U)`): `[`FxaResult`](./index.md)`<`[`U`](from-value.html#U)`>`
This constructs a result that is fulfilled with the specified value. | + diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-fxa-result/then.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-fxa-result/then.md new file mode 100644 index 00000000000..48f169d3126 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-fxa-result/then.md @@ -0,0 +1,42 @@ +--- +title: FxaResult.then - +--- + +[mozilla.components.service.fxa](../index.html) / [FxaResult](index.html) / [then](./then.html) + +# then + +`fun then(fn: (value: `[`T`](index.html#T)`) -> `[`FxaResult`](index.html)`<`[`U`](then.html#U)`>?): `[`FxaResult`](index.html)`<`[`U`](then.html#U)`>` + +Adds a value listener to be called when the [FxaResult](index.html) is completed with +a value. Listeners will be invoked on the same thread in which the +[FxaResult](index.html) was completed. + +### Parameters + +`fn` - A lambda expression with the same method signature as [OnValueListener](-on-value-listener/index.html), +called when the [FxaResult](index.html) is completed with a value.`fun then(vfn: (value: `[`T`](index.html#T)`) -> `[`FxaResult`](index.html)`<`[`U`](then.html#U)`>?, efn: (`[`Exception`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html)`) -> `[`FxaResult`](index.html)`<`[`U`](then.html#U)`>?): `[`FxaResult`](index.html)`<`[`U`](then.html#U)`>` + +Adds listeners to be called when the [FxaResult](index.html) is completed either with +a value or [Exception](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html). Listeners will be invoked on the same thread in which the +[FxaResult](index.html) was completed. + +### Parameters + +`vfn` - A lambda expression with the same method signature as [OnValueListener](-on-value-listener/index.html), +called when the [FxaResult](index.html) is completed with a value. + +`efn` - A lambda expression with the same method signature as [OnExceptionListener](-on-exception-listener/index.html), +called when the [FxaResult](index.html) is completed with an exception.`@Synchronized fun then(valueListener: `[`OnValueListener`](-on-value-listener/index.html)`<`[`T`](index.html#T)`, `[`U`](then.html#U)`>, exceptionListener: `[`OnExceptionListener`](-on-exception-listener/index.html)`<`[`U`](then.html#U)`>?): `[`FxaResult`](index.html)`<`[`U`](then.html#U)`>` + +Adds listeners to be called when the [FxaResult](index.html) is completed either with +a value or [Exception](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html). Listeners will be invoked on the same thread in which the +[FxaResult](index.html) was completed. + +### Parameters + +`valueListener` - An instance of [OnValueListener](-on-value-listener/index.html), called when the +[FxaResult](index.html) is completed with a value. + +`exceptionListener` - An instance of [OnExceptionListener](-on-exception-listener/index.html), called when the +[FxaResult](index.html) is completed with an [Exception](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html). \ No newline at end of file diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-fxa-result/when-complete.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-fxa-result/when-complete.md new file mode 100644 index 00000000000..cbbcd4e0e6c --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-fxa-result/when-complete.md @@ -0,0 +1,18 @@ +--- +title: FxaResult.whenComplete - +--- + +[mozilla.components.service.fxa](../index.html) / [FxaResult](index.html) / [whenComplete](./when-complete.html) + +# whenComplete + +`fun whenComplete(fn: (value: `[`T`](index.html#T)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Adds a value listener to be called when the [FxaResult](index.html) and the whole chain of [then](then.html) +calls is completed with a value. Listeners will be invoked on the same thread in +which the [FxaResult](index.html) was completed. + +### Parameters + +`fn` - A lambda expression with the same method signature as [OnValueListener](-on-value-listener/index.html), +called when the [FxaResult](index.html) is completed with a value. \ No newline at end of file diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-o-auth-info/-raw/-init-.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-o-auth-info/-raw/-init-.md new file mode 100644 index 00000000000..704f015fa61 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-o-auth-info/-raw/-init-.md @@ -0,0 +1,9 @@ +--- +title: OAuthInfo.Raw. - +--- + +[mozilla.components.service.fxa](../../index.html) / [OAuthInfo](../index.html) / [Raw](index.html) / [<init>](./-init-.html) + +# <init> + +`Raw(p: Pointer)` \ No newline at end of file diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-o-auth-info/-raw/access_token.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-o-auth-info/-raw/access_token.md new file mode 100644 index 00000000000..acff84a8c40 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-o-auth-info/-raw/access_token.md @@ -0,0 +1,9 @@ +--- +title: OAuthInfo.Raw.access_token - +--- + +[mozilla.components.service.fxa](../../index.html) / [OAuthInfo](../index.html) / [Raw](index.html) / [access_token](./access_token.html) + +# access_token + +`@JvmField var access_token: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` \ No newline at end of file diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-o-auth-info/-raw/get-field-order.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-o-auth-info/-raw/get-field-order.md new file mode 100644 index 00000000000..6e5bcd95165 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-o-auth-info/-raw/get-field-order.md @@ -0,0 +1,9 @@ +--- +title: OAuthInfo.Raw.getFieldOrder - +--- + +[mozilla.components.service.fxa](../../index.html) / [OAuthInfo](../index.html) / [Raw](index.html) / [getFieldOrder](./get-field-order.html) + +# getFieldOrder + +`protected fun getFieldOrder(): `[`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)`>` \ No newline at end of file diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-o-auth-info/-raw/index.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-o-auth-info/-raw/index.md new file mode 100644 index 00000000000..ec49f27f302 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-o-auth-info/-raw/index.md @@ -0,0 +1,24 @@ +--- +title: OAuthInfo.Raw - +--- + +[mozilla.components.service.fxa](../../index.html) / [OAuthInfo](../index.html) / [Raw](./index.html) + +# Raw + +`class Raw : Structure` + +### Constructors + +| [<init>](-init-.html) | `Raw(p: Pointer)` | + +### Properties + +| [access_token](access_token.html) | `var access_token: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` | +| [keys](keys.html) | `var keys: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` | +| [scope](scope.html) | `var scope: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` | + +### Functions + +| [getFieldOrder](get-field-order.html) | `fun getFieldOrder(): `[`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)`>` | + diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-o-auth-info/-raw/keys.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-o-auth-info/-raw/keys.md new file mode 100644 index 00000000000..7682c3135a6 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-o-auth-info/-raw/keys.md @@ -0,0 +1,9 @@ +--- +title: OAuthInfo.Raw.keys - +--- + +[mozilla.components.service.fxa](../../index.html) / [OAuthInfo](../index.html) / [Raw](index.html) / [keys](./keys.html) + +# keys + +`@JvmField var keys: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` \ No newline at end of file diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-o-auth-info/-raw/scope.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-o-auth-info/-raw/scope.md new file mode 100644 index 00000000000..db74e4780f3 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-o-auth-info/-raw/scope.md @@ -0,0 +1,9 @@ +--- +title: OAuthInfo.Raw.scope - +--- + +[mozilla.components.service.fxa](../../index.html) / [OAuthInfo](../index.html) / [Raw](index.html) / [scope](./scope.html) + +# scope + +`@JvmField var scope: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` \ No newline at end of file diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-o-auth-info/access-token.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-o-auth-info/access-token.md new file mode 100644 index 00000000000..9a9b4ce3dcf --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-o-auth-info/access-token.md @@ -0,0 +1,9 @@ +--- +title: OAuthInfo.accessToken - +--- + +[mozilla.components.service.fxa](../index.html) / [OAuthInfo](index.html) / [accessToken](./access-token.html) + +# accessToken + +`@JvmField val accessToken: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` \ No newline at end of file diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-o-auth-info/index.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-o-auth-info/index.md new file mode 100644 index 00000000000..2d691c8bb8e --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-o-auth-info/index.md @@ -0,0 +1,20 @@ +--- +title: OAuthInfo - +--- + +[mozilla.components.service.fxa](../index.html) / [OAuthInfo](./index.html) + +# OAuthInfo + +`class OAuthInfo` + +### Types + +| [Raw](-raw/index.html) | `class Raw : Structure` | + +### Properties + +| [accessToken](access-token.html) | `val accessToken: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` | +| [keys](keys.html) | `val keys: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` | +| [scope](scope.html) | `val scope: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` | + diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-o-auth-info/keys.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-o-auth-info/keys.md new file mode 100644 index 00000000000..e8227d8b00c --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-o-auth-info/keys.md @@ -0,0 +1,9 @@ +--- +title: OAuthInfo.keys - +--- + +[mozilla.components.service.fxa](../index.html) / [OAuthInfo](index.html) / [keys](./keys.html) + +# keys + +`@JvmField val keys: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` \ No newline at end of file diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-o-auth-info/scope.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-o-auth-info/scope.md new file mode 100644 index 00000000000..bd7f66fbf83 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-o-auth-info/scope.md @@ -0,0 +1,9 @@ +--- +title: OAuthInfo.scope - +--- + +[mozilla.components.service.fxa](../index.html) / [OAuthInfo](index.html) / [scope](./scope.html) + +# scope + +`@JvmField val scope: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` \ No newline at end of file diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-profile/-raw/-init-.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-profile/-raw/-init-.md new file mode 100644 index 00000000000..320686f83a5 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-profile/-raw/-init-.md @@ -0,0 +1,9 @@ +--- +title: Profile.Raw. - +--- + +[mozilla.components.service.fxa](../../index.html) / [Profile](../index.html) / [Raw](index.html) / [<init>](./-init-.html) + +# <init> + +`Raw(p: Pointer)` \ No newline at end of file diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-profile/-raw/avatar.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-profile/-raw/avatar.md new file mode 100644 index 00000000000..44f827e637f --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-profile/-raw/avatar.md @@ -0,0 +1,9 @@ +--- +title: Profile.Raw.avatar - +--- + +[mozilla.components.service.fxa](../../index.html) / [Profile](../index.html) / [Raw](index.html) / [avatar](./avatar.html) + +# avatar + +`@JvmField var avatar: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` \ No newline at end of file diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-profile/-raw/display_name.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-profile/-raw/display_name.md new file mode 100644 index 00000000000..d8c021a3bf1 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-profile/-raw/display_name.md @@ -0,0 +1,9 @@ +--- +title: Profile.Raw.display_name - +--- + +[mozilla.components.service.fxa](../../index.html) / [Profile](../index.html) / [Raw](index.html) / [display_name](./display_name.html) + +# display_name + +`@JvmField var display_name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` \ No newline at end of file diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-profile/-raw/email.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-profile/-raw/email.md new file mode 100644 index 00000000000..61798e5f909 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-profile/-raw/email.md @@ -0,0 +1,9 @@ +--- +title: Profile.Raw.email - +--- + +[mozilla.components.service.fxa](../../index.html) / [Profile](../index.html) / [Raw](index.html) / [email](./email.html) + +# email + +`@JvmField var email: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` \ No newline at end of file diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-profile/-raw/get-field-order.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-profile/-raw/get-field-order.md new file mode 100644 index 00000000000..6ccc234e1eb --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-profile/-raw/get-field-order.md @@ -0,0 +1,9 @@ +--- +title: Profile.Raw.getFieldOrder - +--- + +[mozilla.components.service.fxa](../../index.html) / [Profile](../index.html) / [Raw](index.html) / [getFieldOrder](./get-field-order.html) + +# getFieldOrder + +`protected fun getFieldOrder(): `[`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)`>` \ No newline at end of file diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-profile/-raw/index.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-profile/-raw/index.md new file mode 100644 index 00000000000..9eb581fc26a --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-profile/-raw/index.md @@ -0,0 +1,25 @@ +--- +title: Profile.Raw - +--- + +[mozilla.components.service.fxa](../../index.html) / [Profile](../index.html) / [Raw](./index.html) + +# Raw + +`class Raw : Structure` + +### Constructors + +| [<init>](-init-.html) | `Raw(p: Pointer)` | + +### Properties + +| [avatar](avatar.html) | `var avatar: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` | +| [display_name](display_name.html) | `var display_name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` | +| [email](email.html) | `var email: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` | +| [uid](uid.html) | `var uid: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` | + +### Functions + +| [getFieldOrder](get-field-order.html) | `fun getFieldOrder(): `[`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)`>` | + diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-profile/-raw/uid.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-profile/-raw/uid.md new file mode 100644 index 00000000000..2cb51d80633 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-profile/-raw/uid.md @@ -0,0 +1,9 @@ +--- +title: Profile.Raw.uid - +--- + +[mozilla.components.service.fxa](../../index.html) / [Profile](../index.html) / [Raw](index.html) / [uid](./uid.html) + +# uid + +`@JvmField var uid: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` \ No newline at end of file diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-profile/avatar.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-profile/avatar.md new file mode 100644 index 00000000000..74b3ffd7e0a --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-profile/avatar.md @@ -0,0 +1,9 @@ +--- +title: Profile.avatar - +--- + +[mozilla.components.service.fxa](../index.html) / [Profile](index.html) / [avatar](./avatar.html) + +# avatar + +`@JvmField val avatar: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` \ No newline at end of file diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-profile/display-name.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-profile/display-name.md new file mode 100644 index 00000000000..570dbb01cfa --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-profile/display-name.md @@ -0,0 +1,9 @@ +--- +title: Profile.displayName - +--- + +[mozilla.components.service.fxa](../index.html) / [Profile](index.html) / [displayName](./display-name.html) + +# displayName + +`@JvmField val displayName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` \ No newline at end of file diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-profile/email.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-profile/email.md new file mode 100644 index 00000000000..9ed55f2d8eb --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-profile/email.md @@ -0,0 +1,9 @@ +--- +title: Profile.email - +--- + +[mozilla.components.service.fxa](../index.html) / [Profile](index.html) / [email](./email.html) + +# email + +`@JvmField val email: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` \ No newline at end of file diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-profile/index.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-profile/index.md new file mode 100644 index 00000000000..3c48f48955a --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-profile/index.md @@ -0,0 +1,21 @@ +--- +title: Profile - +--- + +[mozilla.components.service.fxa](../index.html) / [Profile](./index.html) + +# Profile + +`class Profile` + +### Types + +| [Raw](-raw/index.html) | `class Raw : Structure` | + +### Properties + +| [avatar](avatar.html) | `val avatar: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` | +| [displayName](display-name.html) | `val displayName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` | +| [email](email.html) | `val email: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` | +| [uid](uid.html) | `val uid: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` | + diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-profile/uid.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-profile/uid.md new file mode 100644 index 00000000000..6f738e11b4e --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-profile/uid.md @@ -0,0 +1,9 @@ +--- +title: Profile.uid - +--- + +[mozilla.components.service.fxa](../index.html) / [Profile](index.html) / [uid](./uid.html) + +# uid + +`@JvmField val uid: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` \ No newline at end of file diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-raw-config/-init-.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-raw-config/-init-.md new file mode 100644 index 00000000000..dcdcc3bec48 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-raw-config/-init-.md @@ -0,0 +1,9 @@ +--- +title: RawConfig. - +--- + +[mozilla.components.service.fxa](../index.html) / [RawConfig](index.html) / [<init>](./-init-.html) + +# <init> + +`RawConfig()` \ No newline at end of file diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-raw-config/index.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-raw-config/index.md new file mode 100644 index 00000000000..f771c10c3fc --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-raw-config/index.md @@ -0,0 +1,14 @@ +--- +title: RawConfig - +--- + +[mozilla.components.service.fxa](../index.html) / [RawConfig](./index.html) + +# RawConfig + +`class RawConfig : PointerType` + +### Constructors + +| [<init>](-init-.html) | `RawConfig()` | + diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-raw-fx-account/-init-.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-raw-fx-account/-init-.md new file mode 100644 index 00000000000..4166d78017f --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-raw-fx-account/-init-.md @@ -0,0 +1,9 @@ +--- +title: RawFxAccount. - +--- + +[mozilla.components.service.fxa](../index.html) / [RawFxAccount](index.html) / [<init>](./-init-.html) + +# <init> + +`RawFxAccount()` \ No newline at end of file diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-raw-fx-account/index.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-raw-fx-account/index.md new file mode 100644 index 00000000000..070edc39a63 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-raw-fx-account/index.md @@ -0,0 +1,14 @@ +--- +title: RawFxAccount - +--- + +[mozilla.components.service.fxa](../index.html) / [RawFxAccount](./index.html) + +# RawFxAccount + +`class RawFxAccount : PointerType` + +### Constructors + +| [<init>](-init-.html) | `RawFxAccount()` | + diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-rust-object/-init-.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-rust-object/-init-.md new file mode 100644 index 00000000000..0b8391db643 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-rust-object/-init-.md @@ -0,0 +1,15 @@ +--- +title: RustObject. - +--- + +[mozilla.components.service.fxa](../index.html) / [RustObject](index.html) / [<init>](./-init-.html) + +# <init> + +`RustObject()` + +Base class that wraps an non-optional [Pointer](#) representing a pointer to a Rust object. +This class implements [Closeable](http://docs.oracle.com/javase/6/docs/api/java/io/Closeable.html) but does not provide an implementation, forcing all +subclasses to implement it. This ensures that all classes that inherit from RustObject +will have their [Pointer](#) destroyed when the Java wrapper is destroyed. + diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-rust-object/close.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-rust-object/close.md new file mode 100644 index 00000000000..5022755c0ba --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-rust-object/close.md @@ -0,0 +1,9 @@ +--- +title: RustObject.close - +--- + +[mozilla.components.service.fxa](../index.html) / [RustObject](index.html) / [close](./close.html) + +# close + +`open fun close(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-rust-object/consume-pointer.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-rust-object/consume-pointer.md new file mode 100644 index 00000000000..c2061916804 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-rust-object/consume-pointer.md @@ -0,0 +1,9 @@ +--- +title: RustObject.consumePointer - +--- + +[mozilla.components.service.fxa](../index.html) / [RustObject](index.html) / [consumePointer](./consume-pointer.html) + +# consumePointer + +`fun consumePointer(): `[`T`](index.html#T) \ No newline at end of file diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-rust-object/destroy.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-rust-object/destroy.md new file mode 100644 index 00000000000..f68593b216a --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-rust-object/destroy.md @@ -0,0 +1,9 @@ +--- +title: RustObject.destroy - +--- + +[mozilla.components.service.fxa](../index.html) / [RustObject](index.html) / [destroy](./destroy.html) + +# destroy + +`protected abstract fun destroy(p: `[`T`](index.html#T)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-rust-object/get-and-consume-string.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-rust-object/get-and-consume-string.md new file mode 100644 index 00000000000..249f1d982a8 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-rust-object/get-and-consume-string.md @@ -0,0 +1,9 @@ +--- +title: RustObject.getAndConsumeString - +--- + +[mozilla.components.service.fxa](../index.html) / [RustObject](index.html) / [getAndConsumeString](./get-and-consume-string.html) + +# getAndConsumeString + +`fun getAndConsumeString(stringPtr: Pointer?): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` \ No newline at end of file diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-rust-object/index.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-rust-object/index.md new file mode 100644 index 00000000000..d051ad8846b --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-rust-object/index.md @@ -0,0 +1,42 @@ +--- +title: RustObject - +--- + +[mozilla.components.service.fxa](../index.html) / [RustObject](./index.html) + +# RustObject + +`abstract class RustObject : `[`Closeable`](http://docs.oracle.com/javase/6/docs/api/java/io/Closeable.html) + +Base class that wraps an non-optional [Pointer](#) representing a pointer to a Rust object. +This class implements [Closeable](http://docs.oracle.com/javase/6/docs/api/java/io/Closeable.html) but does not provide an implementation, forcing all +subclasses to implement it. This ensures that all classes that inherit from RustObject +will have their [Pointer](#) destroyed when the Java wrapper is destroyed. + +### Constructors + +| [<init>](-init-.html) | `RustObject()`
Base class that wraps an non-optional [Pointer](#) representing a pointer to a Rust object. This class implements [Closeable](http://docs.oracle.com/javase/6/docs/api/java/io/Closeable.html) but does not provide an implementation, forcing all subclasses to implement it. This ensures that all classes that inherit from RustObject will have their [Pointer](#) destroyed when the Java wrapper is destroyed. | + +### Properties + +| [isConsumed](is-consumed.html) | `val isConsumed: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [rawPointer](raw-pointer.html) | `open var rawPointer: `[`T`](index.html#T)`?` | + +### Functions + +| [close](close.html) | `open fun close(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [consumePointer](consume-pointer.html) | `fun consumePointer(): `[`T`](index.html#T) | +| [destroy](destroy.html) | `abstract fun destroy(p: `[`T`](index.html#T)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [validPointer](valid-pointer.html) | `fun validPointer(): `[`T`](index.html#T) | + +### Companion Object Functions + +| [getAndConsumeString](get-and-consume-string.html) | `fun getAndConsumeString(stringPtr: Pointer?): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` | +| [safeAsync](safe-async.html) | `fun safeAsync(callback: (`[`ByReference`](../-error/-by-reference/index.html)`) -> `[`U`](safe-async.html#U)`): `[`FxaResult`](../-fxa-result/index.html)`<`[`U`](safe-async.html#U)`>` | +| [safeSync](safe-sync.html) | `fun safeSync(callback: (`[`ByReference`](../-error/-by-reference/index.html)`) -> `[`U`](safe-sync.html#U)`): `[`U`](safe-sync.html#U) | + +### Inheritors + +| [Config](../-config/index.html) | `class Config : `[`RustObject`](./index.md)`<`[`RawConfig`](../-raw-config/index.html)`>`
Config represents the server endpoint configurations needed for the authentication flow. | +| [FirefoxAccount](../-firefox-account/index.html) | `class FirefoxAccount : `[`RustObject`](./index.md)`<`[`RawFxAccount`](../-raw-fx-account/index.html)`>`
FirefoxAccount represents the authentication state of a client. | + diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-rust-object/is-consumed.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-rust-object/is-consumed.md new file mode 100644 index 00000000000..929029c1ddc --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-rust-object/is-consumed.md @@ -0,0 +1,9 @@ +--- +title: RustObject.isConsumed - +--- + +[mozilla.components.service.fxa](../index.html) / [RustObject](index.html) / [isConsumed](./is-consumed.html) + +# isConsumed + +`val isConsumed: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-rust-object/raw-pointer.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-rust-object/raw-pointer.md new file mode 100644 index 00000000000..6e12ea86d0e --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-rust-object/raw-pointer.md @@ -0,0 +1,9 @@ +--- +title: RustObject.rawPointer - +--- + +[mozilla.components.service.fxa](../index.html) / [RustObject](index.html) / [rawPointer](./raw-pointer.html) + +# rawPointer + +`open var rawPointer: `[`T`](index.html#T)`?` \ No newline at end of file diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-rust-object/safe-async.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-rust-object/safe-async.md new file mode 100644 index 00000000000..ea4c8385693 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-rust-object/safe-async.md @@ -0,0 +1,9 @@ +--- +title: RustObject.safeAsync - +--- + +[mozilla.components.service.fxa](../index.html) / [RustObject](index.html) / [safeAsync](./safe-async.html) + +# safeAsync + +`fun safeAsync(callback: (`[`ByReference`](../-error/-by-reference/index.html)`) -> `[`U`](safe-async.html#U)`): `[`FxaResult`](../-fxa-result/index.html)`<`[`U`](safe-async.html#U)`>` \ No newline at end of file diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-rust-object/safe-sync.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-rust-object/safe-sync.md new file mode 100644 index 00000000000..d331718fabc --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-rust-object/safe-sync.md @@ -0,0 +1,9 @@ +--- +title: RustObject.safeSync - +--- + +[mozilla.components.service.fxa](../index.html) / [RustObject](index.html) / [safeSync](./safe-sync.html) + +# safeSync + +`fun safeSync(callback: (`[`ByReference`](../-error/-by-reference/index.html)`) -> `[`U`](safe-sync.html#U)`): `[`U`](safe-sync.html#U) \ No newline at end of file diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-rust-object/valid-pointer.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-rust-object/valid-pointer.md new file mode 100644 index 00000000000..991e8919ea5 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-rust-object/valid-pointer.md @@ -0,0 +1,9 @@ +--- +title: RustObject.validPointer - +--- + +[mozilla.components.service.fxa](../index.html) / [RustObject](index.html) / [validPointer](./valid-pointer.html) + +# validPointer + +`fun validPointer(): `[`T`](index.html#T) \ No newline at end of file diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-sync-keys/-raw/-init-.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-sync-keys/-raw/-init-.md new file mode 100644 index 00000000000..ee8d805d04c --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-sync-keys/-raw/-init-.md @@ -0,0 +1,9 @@ +--- +title: SyncKeys.Raw. - +--- + +[mozilla.components.service.fxa](../../index.html) / [SyncKeys](../index.html) / [Raw](index.html) / [<init>](./-init-.html) + +# <init> + +`Raw(p: Pointer)` \ No newline at end of file diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-sync-keys/-raw/get-field-order.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-sync-keys/-raw/get-field-order.md new file mode 100644 index 00000000000..835c99ae3db --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-sync-keys/-raw/get-field-order.md @@ -0,0 +1,9 @@ +--- +title: SyncKeys.Raw.getFieldOrder - +--- + +[mozilla.components.service.fxa](../../index.html) / [SyncKeys](../index.html) / [Raw](index.html) / [getFieldOrder](./get-field-order.html) + +# getFieldOrder + +`protected fun getFieldOrder(): `[`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)`>` \ No newline at end of file diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-sync-keys/-raw/index.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-sync-keys/-raw/index.md new file mode 100644 index 00000000000..652d4ad39ba --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-sync-keys/-raw/index.md @@ -0,0 +1,23 @@ +--- +title: SyncKeys.Raw - +--- + +[mozilla.components.service.fxa](../../index.html) / [SyncKeys](../index.html) / [Raw](./index.html) + +# Raw + +`class Raw : Structure` + +### Constructors + +| [<init>](-init-.html) | `Raw(p: Pointer)` | + +### Properties + +| [sync_key](sync_key.html) | `var sync_key: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` | +| [xcs](xcs.html) | `var xcs: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` | + +### Functions + +| [getFieldOrder](get-field-order.html) | `fun getFieldOrder(): `[`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)`>` | + diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-sync-keys/-raw/sync_key.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-sync-keys/-raw/sync_key.md new file mode 100644 index 00000000000..8112787c204 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-sync-keys/-raw/sync_key.md @@ -0,0 +1,9 @@ +--- +title: SyncKeys.Raw.sync_key - +--- + +[mozilla.components.service.fxa](../../index.html) / [SyncKeys](../index.html) / [Raw](index.html) / [sync_key](./sync_key.html) + +# sync_key + +`@JvmField var sync_key: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` \ No newline at end of file diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-sync-keys/-raw/xcs.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-sync-keys/-raw/xcs.md new file mode 100644 index 00000000000..05f568cf451 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-sync-keys/-raw/xcs.md @@ -0,0 +1,9 @@ +--- +title: SyncKeys.Raw.xcs - +--- + +[mozilla.components.service.fxa](../../index.html) / [SyncKeys](../index.html) / [Raw](index.html) / [xcs](./xcs.html) + +# xcs + +`@JvmField var xcs: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` \ No newline at end of file diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-sync-keys/index.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-sync-keys/index.md new file mode 100644 index 00000000000..4c43d50b09b --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-sync-keys/index.md @@ -0,0 +1,19 @@ +--- +title: SyncKeys - +--- + +[mozilla.components.service.fxa](../index.html) / [SyncKeys](./index.html) + +# SyncKeys + +`class SyncKeys` + +### Types + +| [Raw](-raw/index.html) | `class Raw : Structure` | + +### Properties + +| [syncKey](sync-key.html) | `val syncKey: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` | +| [xcs](xcs.html) | `val xcs: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` | + diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-sync-keys/sync-key.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-sync-keys/sync-key.md new file mode 100644 index 00000000000..3d526fa4887 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-sync-keys/sync-key.md @@ -0,0 +1,9 @@ +--- +title: SyncKeys.syncKey - +--- + +[mozilla.components.service.fxa](../index.html) / [SyncKeys](index.html) / [syncKey](./sync-key.html) + +# syncKey + +`@JvmField val syncKey: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` \ No newline at end of file diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-sync-keys/xcs.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-sync-keys/xcs.md new file mode 100644 index 00000000000..09e26159c62 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/-sync-keys/xcs.md @@ -0,0 +1,9 @@ +--- +title: SyncKeys.xcs - +--- + +[mozilla.components.service.fxa](../index.html) / [SyncKeys](index.html) / [xcs](./xcs.html) + +# xcs + +`@JvmField val xcs: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` \ No newline at end of file diff --git a/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/index.md b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/index.md new file mode 100644 index 00000000000..6ae4c8c8227 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/mozilla.components.service.fxa/index.md @@ -0,0 +1,25 @@ +--- +title: mozilla.components.service.fxa - +--- + +[mozilla.components.service.fxa](./index.html) + +## Package mozilla.components.service.fxa + +### Types + +| [Config](-config/index.html) | `class Config : `[`RustObject`](-rust-object/index.html)`<`[`RawConfig`](-raw-config/index.html)`>`
Config represents the server endpoint configurations needed for the authentication flow. | +| [Error](-error/index.html) | `open class Error : Structure` | +| [FirefoxAccount](-firefox-account/index.html) | `class FirefoxAccount : `[`RustObject`](-rust-object/index.html)`<`[`RawFxAccount`](-raw-fx-account/index.html)`>`
FirefoxAccount represents the authentication state of a client. | +| [FxaResult](-fxa-result/index.html) | `class FxaResult`
FxaResult is a class that represents an asynchronous result. | +| [OAuthInfo](-o-auth-info/index.html) | `class OAuthInfo` | +| [Profile](-profile/index.html) | `class Profile` | +| [RawConfig](-raw-config/index.html) | `class RawConfig : PointerType` | +| [RawFxAccount](-raw-fx-account/index.html) | `class RawFxAccount : PointerType` | +| [RustObject](-rust-object/index.html) | `abstract class RustObject : `[`Closeable`](http://docs.oracle.com/javase/6/docs/api/java/io/Closeable.html)
Base class that wraps an non-optional [Pointer](#) representing a pointer to a Rust object. This class implements [Closeable](http://docs.oracle.com/javase/6/docs/api/java/io/Closeable.html) but does not provide an implementation, forcing all subclasses to implement it. This ensures that all classes that inherit from RustObject will have their [Pointer](#) destroyed when the Java wrapper is destroyed. | +| [SyncKeys](-sync-keys/index.html) | `class SyncKeys` | + +### Exceptions + +| [FxaException](-fxa-exception/index.html) | `open class FxaException : `[`Exception`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html)
Wrapper class for the exceptions thrown in the Rust library, which ensures that the error messages will be consumed and freed properly in Rust. | + diff --git a/docs/api/0.21/service-firefox-accounts/package-list b/docs/api/0.21/service-firefox-accounts/package-list new file mode 100644 index 00000000000..62a705023e7 --- /dev/null +++ b/docs/api/0.21/service-firefox-accounts/package-list @@ -0,0 +1,4 @@ +$dokka.format:jekyll +$dokka.linkExtension:html + +mozilla.components.service.fxa diff --git a/docs/api/0.21/service-fretboard/alltypes/index.md b/docs/api/0.21/service-fretboard/alltypes/index.md new file mode 100644 index 00000000000..afd4e6b0207 --- /dev/null +++ b/docs/api/0.21/service-fretboard/alltypes/index.md @@ -0,0 +1,22 @@ +--- +title: alltypes - +--- + +### All Types + +| [mozilla.components.service.fretboard.Experiment](../mozilla.components.service.fretboard/-experiment/index.html) | Represents an A/B test experiment, independent of the underlying storage mechanism | +| [mozilla.components.service.fretboard.ExperimentDescriptor](../mozilla.components.service.fretboard/-experiment-descriptor/index.html) | Class used to identify an experiment | +| [mozilla.components.service.fretboard.ExperimentDownloadException](../mozilla.components.service.fretboard/-experiment-download-exception/index.html) | Exception while downloading experiments from the server | +| [mozilla.components.service.fretboard.ExperimentPayload](../mozilla.components.service.fretboard/-experiment-payload/index.html) | Class which represents an experiment associated data | +| [mozilla.components.service.fretboard.ExperimentSource](../mozilla.components.service.fretboard/-experiment-source/index.html) | Represents a location where experiments are stored (Kinto, a JSON file on a server, etc) | +| [mozilla.components.service.fretboard.ExperimentStorage](../mozilla.components.service.fretboard/-experiment-storage/index.html) | Represents a location where experiments are stored locally on the device | +| [mozilla.components.service.fretboard.ExperimentsSnapshot](../mozilla.components.service.fretboard/-experiments-snapshot/index.html) | Represents an experiment sync result | +| [mozilla.components.service.fretboard.storage.flatfile.FlatFileExperimentStorage](../mozilla.components.service.fretboard.storage.flatfile/-flat-file-experiment-storage/index.html) | Class which uses a flat JSON file as an experiment storage mechanism | +| [mozilla.components.service.fretboard.Fretboard](../mozilla.components.service.fretboard/-fretboard/index.html) | Entry point of the library | +| [mozilla.components.service.fretboard.source.kinto.HttpClient](../mozilla.components.service.fretboard.source.kinto/-http-client/index.html) | Represents an http client, used to make it easy to swap implementations as needed | +| [mozilla.components.service.fretboard.JSONExperimentParser](../mozilla.components.service.fretboard/-j-s-o-n-experiment-parser/index.html) | Default JSON parsing implementation | +| [mozilla.components.service.fretboard.scheduler.jobscheduler.JobSchedulerSyncScheduler](../mozilla.components.service.fretboard.scheduler.jobscheduler/-job-scheduler-sync-scheduler/index.html) | Class used to schedule sync of experiment configuration from the server | +| [mozilla.components.service.fretboard.source.kinto.KintoExperimentSource](../mozilla.components.service.fretboard.source.kinto/-kinto-experiment-source/index.html) | Class responsible for fetching and parsing experiments from a Kinto server | +| [mozilla.components.service.fretboard.scheduler.jobscheduler.SyncJob](../mozilla.components.service.fretboard.scheduler.jobscheduler/-sync-job/index.html) | JobScheduler job used to updating the list of experiments | +| [mozilla.components.service.fretboard.ValuesProvider](../mozilla.components.service.fretboard/-values-provider/index.html) | Class used to provide custom filter values | + diff --git a/docs/api/0.21/service-fretboard/index.md b/docs/api/0.21/service-fretboard/index.md new file mode 100644 index 00000000000..826df66751e --- /dev/null +++ b/docs/api/0.21/service-fretboard/index.md @@ -0,0 +1,14 @@ +--- +title: +--- + +### Packages + +| [mozilla.components.service.fretboard](mozilla.components.service.fretboard/index.html) | | +| [mozilla.components.service.fretboard.scheduler.jobscheduler](mozilla.components.service.fretboard.scheduler.jobscheduler/index.html) | | +| [mozilla.components.service.fretboard.source.kinto](mozilla.components.service.fretboard.source.kinto/index.html) | | +| [mozilla.components.service.fretboard.storage.flatfile](mozilla.components.service.fretboard.storage.flatfile/index.html) | | + +### Index + +[All Types](alltypes/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard.scheduler.jobscheduler/-job-scheduler-sync-scheduler/-init-.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard.scheduler.jobscheduler/-job-scheduler-sync-scheduler/-init-.md new file mode 100644 index 00000000000..1e825402dd7 --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard.scheduler.jobscheduler/-job-scheduler-sync-scheduler/-init-.md @@ -0,0 +1,16 @@ +--- +title: JobSchedulerSyncScheduler. - +--- + +[mozilla.components.service.fretboard.scheduler.jobscheduler](../index.html) / [JobSchedulerSyncScheduler](index.html) / [<init>](./-init-.html) + +# <init> + +`JobSchedulerSyncScheduler(context: Context)` + +Class used to schedule sync of experiment +configuration from the server + +### Parameters + +`context` - context \ No newline at end of file diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard.scheduler.jobscheduler/-job-scheduler-sync-scheduler/index.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard.scheduler.jobscheduler/-job-scheduler-sync-scheduler/index.md new file mode 100644 index 00000000000..3c881296243 --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard.scheduler.jobscheduler/-job-scheduler-sync-scheduler/index.md @@ -0,0 +1,25 @@ +--- +title: JobSchedulerSyncScheduler - +--- + +[mozilla.components.service.fretboard.scheduler.jobscheduler](../index.html) / [JobSchedulerSyncScheduler](./index.html) + +# JobSchedulerSyncScheduler + +`class JobSchedulerSyncScheduler` + +Class used to schedule sync of experiment +configuration from the server + +### Parameters + +`context` - context + +### Constructors + +| [<init>](-init-.html) | `JobSchedulerSyncScheduler(context: Context)`
Class used to schedule sync of experiment configuration from the server | + +### Functions + +| [schedule](schedule.html) | `fun schedule(jobInfo: JobInfo): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Schedule sync with the constrains specified`fun schedule(jobId: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, serviceName: ComponentName): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Schedule sync with the default constraints (once a day) | + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard.scheduler.jobscheduler/-job-scheduler-sync-scheduler/schedule.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard.scheduler.jobscheduler/-job-scheduler-sync-scheduler/schedule.md new file mode 100644 index 00000000000..a35b9740cb8 --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard.scheduler.jobscheduler/-job-scheduler-sync-scheduler/schedule.md @@ -0,0 +1,24 @@ +--- +title: JobSchedulerSyncScheduler.schedule - +--- + +[mozilla.components.service.fretboard.scheduler.jobscheduler](../index.html) / [JobSchedulerSyncScheduler](index.html) / [schedule](./schedule.html) + +# schedule + +`fun schedule(jobInfo: JobInfo): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Schedule sync with the constrains specified + +### Parameters + +`jobInfo` - object with the job constraints`fun schedule(jobId: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, serviceName: ComponentName): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Schedule sync with the default constraints +(once a day) + +### Parameters + +`jobId` - unique identifier of the job + +`serviceName` - object with the service to run \ No newline at end of file diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard.scheduler.jobscheduler/-sync-job/-init-.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard.scheduler.jobscheduler/-sync-job/-init-.md new file mode 100644 index 00000000000..83a39e40b6d --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard.scheduler.jobscheduler/-sync-job/-init-.md @@ -0,0 +1,12 @@ +--- +title: SyncJob. - +--- + +[mozilla.components.service.fretboard.scheduler.jobscheduler](../index.html) / [SyncJob](index.html) / [<init>](./-init-.html) + +# <init> + +`SyncJob()` + +JobScheduler job used to updating the list of experiments + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard.scheduler.jobscheduler/-sync-job/get-fretboard.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard.scheduler.jobscheduler/-sync-job/get-fretboard.md new file mode 100644 index 00000000000..84b249355dc --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard.scheduler.jobscheduler/-sync-job/get-fretboard.md @@ -0,0 +1,16 @@ +--- +title: SyncJob.getFretboard - +--- + +[mozilla.components.service.fretboard.scheduler.jobscheduler](../index.html) / [SyncJob](index.html) / [getFretboard](./get-fretboard.html) + +# getFretboard + +`abstract fun getFretboard(): `[`Fretboard`](../../mozilla.components.service.fretboard/-fretboard/index.html) + +Used to provide the instance of Fretboard +the app is using + +**Return** +current Fretboard instance + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard.scheduler.jobscheduler/-sync-job/index.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard.scheduler.jobscheduler/-sync-job/index.md new file mode 100644 index 00000000000..a6a272da080 --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard.scheduler.jobscheduler/-sync-job/index.md @@ -0,0 +1,22 @@ +--- +title: SyncJob - +--- + +[mozilla.components.service.fretboard.scheduler.jobscheduler](../index.html) / [SyncJob](./index.html) + +# SyncJob + +`abstract class SyncJob : JobService` + +JobScheduler job used to updating the list of experiments + +### Constructors + +| [<init>](-init-.html) | `SyncJob()`
JobScheduler job used to updating the list of experiments | + +### Functions + +| [getFretboard](get-fretboard.html) | `abstract fun getFretboard(): `[`Fretboard`](../../mozilla.components.service.fretboard/-fretboard/index.html)
Used to provide the instance of Fretboard the app is using | +| [onStartJob](on-start-job.html) | `open fun onStartJob(params: JobParameters): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [onStopJob](on-stop-job.html) | `open fun onStopJob(params: JobParameters?): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard.scheduler.jobscheduler/-sync-job/on-start-job.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard.scheduler.jobscheduler/-sync-job/on-start-job.md new file mode 100644 index 00000000000..17b8c4bff60 --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard.scheduler.jobscheduler/-sync-job/on-start-job.md @@ -0,0 +1,9 @@ +--- +title: SyncJob.onStartJob - +--- + +[mozilla.components.service.fretboard.scheduler.jobscheduler](../index.html) / [SyncJob](index.html) / [onStartJob](./on-start-job.html) + +# onStartJob + +`open fun onStartJob(params: JobParameters): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard.scheduler.jobscheduler/-sync-job/on-stop-job.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard.scheduler.jobscheduler/-sync-job/on-stop-job.md new file mode 100644 index 00000000000..ea313723465 --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard.scheduler.jobscheduler/-sync-job/on-stop-job.md @@ -0,0 +1,9 @@ +--- +title: SyncJob.onStopJob - +--- + +[mozilla.components.service.fretboard.scheduler.jobscheduler](../index.html) / [SyncJob](index.html) / [onStopJob](./on-stop-job.html) + +# onStopJob + +`open fun onStopJob(params: JobParameters?): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard.scheduler.jobscheduler/index.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard.scheduler.jobscheduler/index.md new file mode 100644 index 00000000000..236e5a54e8f --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard.scheduler.jobscheduler/index.md @@ -0,0 +1,13 @@ +--- +title: mozilla.components.service.fretboard.scheduler.jobscheduler - +--- + +[mozilla.components.service.fretboard.scheduler.jobscheduler](./index.html) + +## Package mozilla.components.service.fretboard.scheduler.jobscheduler + +### Types + +| [JobSchedulerSyncScheduler](-job-scheduler-sync-scheduler/index.html) | `class JobSchedulerSyncScheduler`
Class used to schedule sync of experiment configuration from the server | +| [SyncJob](-sync-job/index.html) | `abstract class SyncJob : JobService`
JobScheduler job used to updating the list of experiments | + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard.source.kinto/-http-client/get.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard.source.kinto/-http-client/get.md new file mode 100644 index 00000000000..271d6808271 --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard.source.kinto/-http-client/get.md @@ -0,0 +1,22 @@ +--- +title: HttpClient.get - +--- + +[mozilla.components.service.fretboard.source.kinto](../index.html) / [HttpClient](index.html) / [get](./get.html) + +# get + +`abstract fun get(url: `[`URL`](http://docs.oracle.com/javase/6/docs/api/java/net/URL.html)`, headers: `[`Map`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>? = null): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) + +Performs a GET request to the specified URL, supplying +the provided headers + +### Parameters + +`url` - destination url + +`headers` - headers to submit with the request + +**Return** +HTTP response + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard.source.kinto/-http-client/index.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard.source.kinto/-http-client/index.md new file mode 100644 index 00000000000..14051226950 --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard.source.kinto/-http-client/index.md @@ -0,0 +1,18 @@ +--- +title: HttpClient - +--- + +[mozilla.components.service.fretboard.source.kinto](../index.html) / [HttpClient](./index.html) + +# HttpClient + +`interface HttpClient` + +Represents an http client, used to +make it easy to swap implementations +as needed + +### Functions + +| [get](get.html) | `abstract fun get(url: `[`URL`](http://docs.oracle.com/javase/6/docs/api/java/net/URL.html)`, headers: `[`Map`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>? = null): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Performs a GET request to the specified URL, supplying the provided headers | + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard.source.kinto/-kinto-experiment-source/-init-.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard.source.kinto/-kinto-experiment-source/-init-.md new file mode 100644 index 00000000000..351f4359859 --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard.source.kinto/-kinto-experiment-source/-init-.md @@ -0,0 +1,13 @@ +--- +title: KintoExperimentSource. - +--- + +[mozilla.components.service.fretboard.source.kinto](../index.html) / [KintoExperimentSource](index.html) / [<init>](./-init-.html) + +# <init> + +`KintoExperimentSource(baseUrl: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, bucketName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, collectionName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, validateSignature: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, client: `[`HttpClient`](../-http-client/index.html)` = HttpURLConnectionHttpClient())` + +Class responsible for fetching and +parsing experiments from a Kinto server + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard.source.kinto/-kinto-experiment-source/get-experiments.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard.source.kinto/-kinto-experiment-source/get-experiments.md new file mode 100644 index 00000000000..44cc1d2eecf --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard.source.kinto/-kinto-experiment-source/get-experiments.md @@ -0,0 +1,25 @@ +--- +title: KintoExperimentSource.getExperiments - +--- + +[mozilla.components.service.fretboard.source.kinto](../index.html) / [KintoExperimentSource](index.html) / [getExperiments](./get-experiments.html) + +# getExperiments + +`fun getExperiments(snapshot: `[`ExperimentsSnapshot`](../../mozilla.components.service.fretboard/-experiments-snapshot/index.html)`): `[`ExperimentsSnapshot`](../../mozilla.components.service.fretboard/-experiments-snapshot/index.html) + +Overrides [ExperimentSource.getExperiments](../../mozilla.components.service.fretboard/-experiment-source/get-experiments.html) + +Requests new experiments from the source, +parsing the response into experiments + +### Parameters + +`client` - Http client to use, provided by Fretboard + +`snapshot` - list of already downloaded experiments +(in order to process a diff response, for example) + +**Return** +modified list of experiments + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard.source.kinto/-kinto-experiment-source/index.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard.source.kinto/-kinto-experiment-source/index.md new file mode 100644 index 00000000000..35258f0cd5f --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard.source.kinto/-kinto-experiment-source/index.md @@ -0,0 +1,21 @@ +--- +title: KintoExperimentSource - +--- + +[mozilla.components.service.fretboard.source.kinto](../index.html) / [KintoExperimentSource](./index.html) + +# KintoExperimentSource + +`class KintoExperimentSource : `[`ExperimentSource`](../../mozilla.components.service.fretboard/-experiment-source/index.html) + +Class responsible for fetching and +parsing experiments from a Kinto server + +### Constructors + +| [<init>](-init-.html) | `KintoExperimentSource(baseUrl: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, bucketName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, collectionName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, validateSignature: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, client: `[`HttpClient`](../-http-client/index.html)` = HttpURLConnectionHttpClient())`
Class responsible for fetching and parsing experiments from a Kinto server | + +### Functions + +| [getExperiments](get-experiments.html) | `fun getExperiments(snapshot: `[`ExperimentsSnapshot`](../../mozilla.components.service.fretboard/-experiments-snapshot/index.html)`): `[`ExperimentsSnapshot`](../../mozilla.components.service.fretboard/-experiments-snapshot/index.html)
Requests new experiments from the source, parsing the response into experiments | + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard.source.kinto/index.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard.source.kinto/index.md new file mode 100644 index 00000000000..b66c64e4955 --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard.source.kinto/index.md @@ -0,0 +1,13 @@ +--- +title: mozilla.components.service.fretboard.source.kinto - +--- + +[mozilla.components.service.fretboard.source.kinto](./index.html) + +## Package mozilla.components.service.fretboard.source.kinto + +### Types + +| [HttpClient](-http-client/index.html) | `interface HttpClient`
Represents an http client, used to make it easy to swap implementations as needed | +| [KintoExperimentSource](-kinto-experiment-source/index.html) | `class KintoExperimentSource : `[`ExperimentSource`](../mozilla.components.service.fretboard/-experiment-source/index.html)
Class responsible for fetching and parsing experiments from a Kinto server | + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard.storage.flatfile/-flat-file-experiment-storage/-init-.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard.storage.flatfile/-flat-file-experiment-storage/-init-.md new file mode 100644 index 00000000000..99e082a1b69 --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard.storage.flatfile/-flat-file-experiment-storage/-init-.md @@ -0,0 +1,15 @@ +--- +title: FlatFileExperimentStorage. - +--- + +[mozilla.components.service.fretboard.storage.flatfile](../index.html) / [FlatFileExperimentStorage](index.html) / [<init>](./-init-.html) + +# <init> + +`FlatFileExperimentStorage(file: `[`File`](http://docs.oracle.com/javase/6/docs/api/java/io/File.html)`)` + +Class which uses a flat JSON file as an experiment storage mechanism + +### Parameters + +`file` - file where to store experiments \ No newline at end of file diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard.storage.flatfile/-flat-file-experiment-storage/index.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard.storage.flatfile/-flat-file-experiment-storage/index.md new file mode 100644 index 00000000000..240905eb736 --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard.storage.flatfile/-flat-file-experiment-storage/index.md @@ -0,0 +1,25 @@ +--- +title: FlatFileExperimentStorage - +--- + +[mozilla.components.service.fretboard.storage.flatfile](../index.html) / [FlatFileExperimentStorage](./index.html) + +# FlatFileExperimentStorage + +`class FlatFileExperimentStorage : `[`ExperimentStorage`](../../mozilla.components.service.fretboard/-experiment-storage/index.html) + +Class which uses a flat JSON file as an experiment storage mechanism + +### Parameters + +`file` - file where to store experiments + +### Constructors + +| [<init>](-init-.html) | `FlatFileExperimentStorage(file: `[`File`](http://docs.oracle.com/javase/6/docs/api/java/io/File.html)`)`
Class which uses a flat JSON file as an experiment storage mechanism | + +### Functions + +| [retrieve](retrieve.html) | `fun retrieve(): `[`ExperimentsSnapshot`](../../mozilla.components.service.fretboard/-experiments-snapshot/index.html)
Reads experiments from disk | +| [save](save.html) | `fun save(snapshot: `[`ExperimentsSnapshot`](../../mozilla.components.service.fretboard/-experiments-snapshot/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Stores the given experiments to disk | + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard.storage.flatfile/-flat-file-experiment-storage/retrieve.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard.storage.flatfile/-flat-file-experiment-storage/retrieve.md new file mode 100644 index 00000000000..7e287e9cb69 --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard.storage.flatfile/-flat-file-experiment-storage/retrieve.md @@ -0,0 +1,17 @@ +--- +title: FlatFileExperimentStorage.retrieve - +--- + +[mozilla.components.service.fretboard.storage.flatfile](../index.html) / [FlatFileExperimentStorage](index.html) / [retrieve](./retrieve.html) + +# retrieve + +`fun retrieve(): `[`ExperimentsSnapshot`](../../mozilla.components.service.fretboard/-experiments-snapshot/index.html) + +Overrides [ExperimentStorage.retrieve](../../mozilla.components.service.fretboard/-experiment-storage/retrieve.html) + +Reads experiments from disk + +**Return** +experiments from disk + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard.storage.flatfile/-flat-file-experiment-storage/save.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard.storage.flatfile/-flat-file-experiment-storage/save.md new file mode 100644 index 00000000000..6b14882d546 --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard.storage.flatfile/-flat-file-experiment-storage/save.md @@ -0,0 +1,17 @@ +--- +title: FlatFileExperimentStorage.save - +--- + +[mozilla.components.service.fretboard.storage.flatfile](../index.html) / [FlatFileExperimentStorage](index.html) / [save](./save.html) + +# save + +`fun save(snapshot: `[`ExperimentsSnapshot`](../../mozilla.components.service.fretboard/-experiments-snapshot/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Overrides [ExperimentStorage.save](../../mozilla.components.service.fretboard/-experiment-storage/save.html) + +Stores the given experiments to disk + +### Parameters + +`experiments` - list of experiments to store \ No newline at end of file diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard.storage.flatfile/index.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard.storage.flatfile/index.md new file mode 100644 index 00000000000..a5c62788f5b --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard.storage.flatfile/index.md @@ -0,0 +1,12 @@ +--- +title: mozilla.components.service.fretboard.storage.flatfile - +--- + +[mozilla.components.service.fretboard.storage.flatfile](./index.html) + +## Package mozilla.components.service.fretboard.storage.flatfile + +### Types + +| [FlatFileExperimentStorage](-flat-file-experiment-storage/index.html) | `class FlatFileExperimentStorage : `[`ExperimentStorage`](../mozilla.components.service.fretboard/-experiment-storage/index.html)
Class which uses a flat JSON file as an experiment storage mechanism | + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment-descriptor/-init-.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment-descriptor/-init-.md new file mode 100644 index 00000000000..c9d78007e3c --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment-descriptor/-init-.md @@ -0,0 +1,12 @@ +--- +title: ExperimentDescriptor. - +--- + +[mozilla.components.service.fretboard](../index.html) / [ExperimentDescriptor](index.html) / [<init>](./-init-.html) + +# <init> + +`ExperimentDescriptor(name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)` + +Class used to identify an experiment + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment-descriptor/index.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment-descriptor/index.md new file mode 100644 index 00000000000..4f20a231d3b --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment-descriptor/index.md @@ -0,0 +1,20 @@ +--- +title: ExperimentDescriptor - +--- + +[mozilla.components.service.fretboard](../index.html) / [ExperimentDescriptor](./index.html) + +# ExperimentDescriptor + +`data class ExperimentDescriptor` + +Class used to identify an experiment + +### Constructors + +| [<init>](-init-.html) | `ExperimentDescriptor(name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)`
Class used to identify an experiment | + +### Properties + +| [name](name.html) | `val name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
experiment name | + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment-descriptor/name.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment-descriptor/name.md new file mode 100644 index 00000000000..db9aab22c9d --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment-descriptor/name.md @@ -0,0 +1,15 @@ +--- +title: ExperimentDescriptor.name - +--- + +[mozilla.components.service.fretboard](../index.html) / [ExperimentDescriptor](index.html) / [name](./name.html) + +# name + +`val name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) + +experiment name + +### Property + +`name` - experiment name \ No newline at end of file diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment-download-exception/-init-.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment-download-exception/-init-.md new file mode 100644 index 00000000000..9d724c257c8 --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment-download-exception/-init-.md @@ -0,0 +1,10 @@ +--- +title: ExperimentDownloadException. - +--- + +[mozilla.components.service.fretboard](../index.html) / [ExperimentDownloadException](index.html) / [<init>](./-init-.html) + +# <init> + +`ExperimentDownloadException(message: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?)` +`ExperimentDownloadException(cause: `[`Throwable`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)`)` \ No newline at end of file diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment-download-exception/index.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment-download-exception/index.md new file mode 100644 index 00000000000..952cd560e2f --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment-download-exception/index.md @@ -0,0 +1,16 @@ +--- +title: ExperimentDownloadException - +--- + +[mozilla.components.service.fretboard](../index.html) / [ExperimentDownloadException](./index.html) + +# ExperimentDownloadException + +`class ExperimentDownloadException : `[`Exception`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html) + +Exception while downloading experiments from the server + +### Constructors + +| [<init>](-init-.html) | `ExperimentDownloadException(message: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?)`
`ExperimentDownloadException(cause: `[`Throwable`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)`)` | + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment-payload/-init-.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment-payload/-init-.md new file mode 100644 index 00000000000..d83eddad158 --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment-payload/-init-.md @@ -0,0 +1,12 @@ +--- +title: ExperimentPayload. - +--- + +[mozilla.components.service.fretboard](../index.html) / [ExperimentPayload](index.html) / [<init>](./-init-.html) + +# <init> + +`ExperimentPayload()` + +Class which represents an experiment associated data + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment-payload/get-boolean-list.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment-payload/get-boolean-list.md new file mode 100644 index 00000000000..c2b4b7dcd86 --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment-payload/get-boolean-list.md @@ -0,0 +1,19 @@ +--- +title: ExperimentPayload.getBooleanList - +--- + +[mozilla.components.service.fretboard](../index.html) / [ExperimentPayload](index.html) / [getBooleanList](./get-boolean-list.html) + +# getBooleanList + +`fun getBooleanList(key: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`>?` + +Gets a value from the payload as a list of Boolean + +### Parameters + +`key` - key + +**Return** +value under the specified key as a list of Boolean + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment-payload/get-double-list.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment-payload/get-double-list.md new file mode 100644 index 00000000000..02dc9f1fa2c --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment-payload/get-double-list.md @@ -0,0 +1,19 @@ +--- +title: ExperimentPayload.getDoubleList - +--- + +[mozilla.components.service.fretboard](../index.html) / [ExperimentPayload](index.html) / [getDoubleList](./get-double-list.html) + +# getDoubleList + +`fun getDoubleList(key: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Double`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)`>?` + +Gets a value from the payload as a list of Double + +### Parameters + +`key` - key + +**Return** +value under the specified key as a list of Double + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment-payload/get-int-list.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment-payload/get-int-list.md new file mode 100644 index 00000000000..a87a0deb8d8 --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment-payload/get-int-list.md @@ -0,0 +1,19 @@ +--- +title: ExperimentPayload.getIntList - +--- + +[mozilla.components.service.fretboard](../index.html) / [ExperimentPayload](index.html) / [getIntList](./get-int-list.html) + +# getIntList + +`fun getIntList(key: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`>?` + +Gets a value from the payload as a list of Int + +### Parameters + +`key` - key + +**Return** +value under the specified key as a list of Int + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment-payload/get-keys.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment-payload/get-keys.md new file mode 100644 index 00000000000..99f8e4bdf29 --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment-payload/get-keys.md @@ -0,0 +1,15 @@ +--- +title: ExperimentPayload.getKeys - +--- + +[mozilla.components.service.fretboard](../index.html) / [ExperimentPayload](index.html) / [getKeys](./get-keys.html) + +# getKeys + +`fun getKeys(): `[`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)`>` + +Gets all the payload keys + +**Return** +set of payload keys + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment-payload/get-long-list.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment-payload/get-long-list.md new file mode 100644 index 00000000000..a11d372bce9 --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment-payload/get-long-list.md @@ -0,0 +1,19 @@ +--- +title: ExperimentPayload.getLongList - +--- + +[mozilla.components.service.fretboard](../index.html) / [ExperimentPayload](index.html) / [getLongList](./get-long-list.html) + +# getLongList + +`fun getLongList(key: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`>?` + +Gets a value from the payload as a list of Long + +### Parameters + +`key` - key + +**Return** +value under the specified key as a list of Long + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment-payload/get-string-list.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment-payload/get-string-list.md new file mode 100644 index 00000000000..0b24d0d25bf --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment-payload/get-string-list.md @@ -0,0 +1,19 @@ +--- +title: ExperimentPayload.getStringList - +--- + +[mozilla.components.service.fretboard](../index.html) / [ExperimentPayload](index.html) / [getStringList](./get-string-list.html) + +# getStringList + +`fun getStringList(key: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`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)`>?` + +Gets a value from the payload as a list of String + +### Parameters + +`key` - key + +**Return** +value under the specified key as a list of String + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment-payload/get.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment-payload/get.md new file mode 100644 index 00000000000..6e128ba69af --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment-payload/get.md @@ -0,0 +1,19 @@ +--- +title: ExperimentPayload.get - +--- + +[mozilla.components.service.fretboard](../index.html) / [ExperimentPayload](index.html) / [get](./get.html) + +# get + +`fun get(key: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`?` + +Gets a value from the payload + +### Parameters + +`key` - key + +**Return** +value under the specified key + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment-payload/index.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment-payload/index.md new file mode 100644 index 00000000000..6f46011bf87 --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment-payload/index.md @@ -0,0 +1,27 @@ +--- +title: ExperimentPayload - +--- + +[mozilla.components.service.fretboard](../index.html) / [ExperimentPayload](./index.html) + +# ExperimentPayload + +`class ExperimentPayload` + +Class which represents an experiment associated data + +### Constructors + +| [<init>](-init-.html) | `ExperimentPayload()`
Class which represents an experiment associated data | + +### Functions + +| [get](get.html) | `fun get(key: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`?`
Gets a value from the payload | +| [getBooleanList](get-boolean-list.html) | `fun getBooleanList(key: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`>?`
Gets a value from the payload as a list of Boolean | +| [getDoubleList](get-double-list.html) | `fun getDoubleList(key: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Double`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)`>?`
Gets a value from the payload as a list of Double | +| [getIntList](get-int-list.html) | `fun getIntList(key: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`>?`
Gets a value from the payload as a list of Int | +| [getKeys](get-keys.html) | `fun getKeys(): `[`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)`>`
Gets all the payload keys | +| [getLongList](get-long-list.html) | `fun getLongList(key: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`>?`
Gets a value from the payload as a list of Long | +| [getStringList](get-string-list.html) | `fun getStringList(key: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`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)`>?`
Gets a value from the payload as a list of String | +| [put](put.html) | `fun put(key: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, value: `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Puts a value into the payload | + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment-payload/put.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment-payload/put.md new file mode 100644 index 00000000000..6d2e715d532 --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment-payload/put.md @@ -0,0 +1,17 @@ +--- +title: ExperimentPayload.put - +--- + +[mozilla.components.service.fretboard](../index.html) / [ExperimentPayload](index.html) / [put](./put.html) + +# put + +`fun put(key: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, value: `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Puts a value into the payload + +### Parameters + +`key` - key + +`value` - value to put under the key \ No newline at end of file diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment-source/get-experiments.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment-source/get-experiments.md new file mode 100644 index 00000000000..3a8edd1f8e1 --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment-source/get-experiments.md @@ -0,0 +1,23 @@ +--- +title: ExperimentSource.getExperiments - +--- + +[mozilla.components.service.fretboard](../index.html) / [ExperimentSource](index.html) / [getExperiments](./get-experiments.html) + +# getExperiments + +`abstract fun getExperiments(snapshot: `[`ExperimentsSnapshot`](../-experiments-snapshot/index.html)`): `[`ExperimentsSnapshot`](../-experiments-snapshot/index.html) + +Requests new experiments from the source, +parsing the response into experiments + +### Parameters + +`client` - Http client to use, provided by Fretboard + +`snapshot` - list of already downloaded experiments +(in order to process a diff response, for example) + +**Return** +modified list of experiments + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment-source/index.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment-source/index.md new file mode 100644 index 00000000000..10f8ea25a43 --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment-source/index.md @@ -0,0 +1,21 @@ +--- +title: ExperimentSource - +--- + +[mozilla.components.service.fretboard](../index.html) / [ExperimentSource](./index.html) + +# ExperimentSource + +`interface ExperimentSource` + +Represents a location where experiments are stored +(Kinto, a JSON file on a server, etc) + +### Functions + +| [getExperiments](get-experiments.html) | `abstract fun getExperiments(snapshot: `[`ExperimentsSnapshot`](../-experiments-snapshot/index.html)`): `[`ExperimentsSnapshot`](../-experiments-snapshot/index.html)
Requests new experiments from the source, parsing the response into experiments | + +### Inheritors + +| [KintoExperimentSource](../../mozilla.components.service.fretboard.source.kinto/-kinto-experiment-source/index.html) | `class KintoExperimentSource : `[`ExperimentSource`](./index.md)
Class responsible for fetching and parsing experiments from a Kinto server | + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment-storage/index.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment-storage/index.md new file mode 100644 index 00000000000..dfc5edace5f --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment-storage/index.md @@ -0,0 +1,22 @@ +--- +title: ExperimentStorage - +--- + +[mozilla.components.service.fretboard](../index.html) / [ExperimentStorage](./index.html) + +# ExperimentStorage + +`interface ExperimentStorage` + +Represents a location where experiments +are stored locally on the device + +### Functions + +| [retrieve](retrieve.html) | `abstract fun retrieve(): `[`ExperimentsSnapshot`](../-experiments-snapshot/index.html)
Reads experiments from disk | +| [save](save.html) | `abstract fun save(snapshot: `[`ExperimentsSnapshot`](../-experiments-snapshot/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Stores the given experiments to disk | + +### Inheritors + +| [FlatFileExperimentStorage](../../mozilla.components.service.fretboard.storage.flatfile/-flat-file-experiment-storage/index.html) | `class FlatFileExperimentStorage : `[`ExperimentStorage`](./index.md)
Class which uses a flat JSON file as an experiment storage mechanism | + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment-storage/retrieve.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment-storage/retrieve.md new file mode 100644 index 00000000000..ddb284e4cf0 --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment-storage/retrieve.md @@ -0,0 +1,15 @@ +--- +title: ExperimentStorage.retrieve - +--- + +[mozilla.components.service.fretboard](../index.html) / [ExperimentStorage](index.html) / [retrieve](./retrieve.html) + +# retrieve + +`abstract fun retrieve(): `[`ExperimentsSnapshot`](../-experiments-snapshot/index.html) + +Reads experiments from disk + +**Return** +experiments from disk + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment-storage/save.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment-storage/save.md new file mode 100644 index 00000000000..1b9002e9111 --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment-storage/save.md @@ -0,0 +1,15 @@ +--- +title: ExperimentStorage.save - +--- + +[mozilla.components.service.fretboard](../index.html) / [ExperimentStorage](index.html) / [save](./save.html) + +# save + +`abstract fun save(snapshot: `[`ExperimentsSnapshot`](../-experiments-snapshot/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Stores the given experiments to disk + +### Parameters + +`experiments` - list of experiments to store \ No newline at end of file diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/-bucket/-init-.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/-bucket/-init-.md new file mode 100644 index 00000000000..8d54c6f021d --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/-bucket/-init-.md @@ -0,0 +1,9 @@ +--- +title: Experiment.Bucket. - +--- + +[mozilla.components.service.fretboard](../../index.html) / [Experiment](../index.html) / [Bucket](index.html) / [<init>](./-init-.html) + +# <init> + +`Bucket(max: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`? = null, min: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`? = null)` \ No newline at end of file diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/-bucket/index.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/-bucket/index.md new file mode 100644 index 00000000000..19788f0d88b --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/-bucket/index.md @@ -0,0 +1,19 @@ +--- +title: Experiment.Bucket - +--- + +[mozilla.components.service.fretboard](../../index.html) / [Experiment](../index.html) / [Bucket](./index.html) + +# Bucket + +`data class Bucket` + +### Constructors + +| [<init>](-init-.html) | `Bucket(max: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`? = null, min: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`? = null)` | + +### Properties + +| [max](max.html) | `val max: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`?`
Maximum bucket (exclusive), values from 0 to 100 | +| [min](min.html) | `val min: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`?`
Minimum bucket (inclusive), values from 0 to 100 | + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/-bucket/max.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/-bucket/max.md new file mode 100644 index 00000000000..6fe69f17d83 --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/-bucket/max.md @@ -0,0 +1,12 @@ +--- +title: Experiment.Bucket.max - +--- + +[mozilla.components.service.fretboard](../../index.html) / [Experiment](../index.html) / [Bucket](index.html) / [max](./max.html) + +# max + +`val max: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`?` + +Maximum bucket (exclusive), values from 0 to 100 + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/-bucket/min.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/-bucket/min.md new file mode 100644 index 00000000000..dd386fb6bd6 --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/-bucket/min.md @@ -0,0 +1,12 @@ +--- +title: Experiment.Bucket.min - +--- + +[mozilla.components.service.fretboard](../../index.html) / [Experiment](../index.html) / [Bucket](index.html) / [min](./min.html) + +# min + +`val min: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`?` + +Minimum bucket (inclusive), values from 0 to 100 + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/-init-.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/-init-.md new file mode 100644 index 00000000000..c2e8f5a41f7 --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/-init-.md @@ -0,0 +1,14 @@ +--- +title: Experiment. - +--- + +[mozilla.components.service.fretboard](../index.html) / [Experiment](index.html) / [<init>](./-init-.html) + +# <init> + +`Experiment(id: `[`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)`, description: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, match: `[`Matcher`](-matcher/index.html)`? = null, bucket: `[`Bucket`](-bucket/index.html)`? = null, lastModified: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`? = null, payload: `[`ExperimentPayload`](../-experiment-payload/index.html)`? = null, schema: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`? = null)` + +Represents an A/B test experiment, +independent of the underlying +storage mechanism + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/-matcher/-init-.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/-matcher/-init-.md new file mode 100644 index 00000000000..338afffc7b9 --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/-matcher/-init-.md @@ -0,0 +1,9 @@ +--- +title: Experiment.Matcher. - +--- + +[mozilla.components.service.fretboard](../../index.html) / [Experiment](../index.html) / [Matcher](index.html) / [<init>](./-init-.html) + +# <init> + +`Matcher(language: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, appId: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, regions: `[`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)`>? = null, version: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, manufacturer: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, device: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, country: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, releaseChannel: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null)` \ No newline at end of file diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/-matcher/app-id.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/-matcher/app-id.md new file mode 100644 index 00000000000..7f4605ad2ab --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/-matcher/app-id.md @@ -0,0 +1,12 @@ +--- +title: Experiment.Matcher.appId - +--- + +[mozilla.components.service.fretboard](../../index.html) / [Experiment](../index.html) / [Matcher](index.html) / [appId](./app-id.html) + +# appId + +`val appId: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` + +id (package name) of the expected application, as a regex + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/-matcher/country.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/-matcher/country.md new file mode 100644 index 00000000000..41f5d8009db --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/-matcher/country.md @@ -0,0 +1,12 @@ +--- +title: Experiment.Matcher.country - +--- + +[mozilla.components.service.fretboard](../../index.html) / [Experiment](../index.html) / [Matcher](index.html) / [country](./country.html) + +# country + +`val country: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` + +Required country, as a three-letter abbreviation + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/-matcher/device.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/-matcher/device.md new file mode 100644 index 00000000000..8bc1d529464 --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/-matcher/device.md @@ -0,0 +1,12 @@ +--- +title: Experiment.Matcher.device - +--- + +[mozilla.components.service.fretboard](../../index.html) / [Experiment](../index.html) / [Matcher](index.html) / [device](./device.html) + +# device + +`val device: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` + +Required device model, as a regex + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/-matcher/index.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/-matcher/index.md new file mode 100644 index 00000000000..ddf82c8b2cf --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/-matcher/index.md @@ -0,0 +1,25 @@ +--- +title: Experiment.Matcher - +--- + +[mozilla.components.service.fretboard](../../index.html) / [Experiment](../index.html) / [Matcher](./index.html) + +# Matcher + +`data class Matcher` + +### Constructors + +| [<init>](-init-.html) | `Matcher(language: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, appId: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, regions: `[`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)`>? = null, version: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, manufacturer: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, device: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, country: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, releaseChannel: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null)` | + +### Properties + +| [appId](app-id.html) | `val appId: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
id (package name) of the expected application, as a regex | +| [country](country.html) | `val country: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
Required country, as a three-letter abbreviation | +| [device](device.html) | `val device: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
Required device model, as a regex | +| [language](language.html) | `val language: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
Language of the device, as a regex | +| [manufacturer](manufacturer.html) | `val manufacturer: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
Required device manufacturer, as a regex | +| [regions](regions.html) | `val regions: `[`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)`>?`
Regions where the experiment should be enabled | +| [releaseChannel](release-channel.html) | `val releaseChannel: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
Required app release channel (alpha, beta, ...), as a regex | +| [version](version.html) | `val version: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
Required app version, as a regex | + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/-matcher/language.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/-matcher/language.md new file mode 100644 index 00000000000..dd18bbbe21a --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/-matcher/language.md @@ -0,0 +1,12 @@ +--- +title: Experiment.Matcher.language - +--- + +[mozilla.components.service.fretboard](../../index.html) / [Experiment](../index.html) / [Matcher](index.html) / [language](./language.html) + +# language + +`val language: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` + +Language of the device, as a regex + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/-matcher/manufacturer.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/-matcher/manufacturer.md new file mode 100644 index 00000000000..7f580a00ef4 --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/-matcher/manufacturer.md @@ -0,0 +1,12 @@ +--- +title: Experiment.Matcher.manufacturer - +--- + +[mozilla.components.service.fretboard](../../index.html) / [Experiment](../index.html) / [Matcher](index.html) / [manufacturer](./manufacturer.html) + +# manufacturer + +`val manufacturer: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` + +Required device manufacturer, as a regex + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/-matcher/regions.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/-matcher/regions.md new file mode 100644 index 00000000000..b4069aab576 --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/-matcher/regions.md @@ -0,0 +1,12 @@ +--- +title: Experiment.Matcher.regions - +--- + +[mozilla.components.service.fretboard](../../index.html) / [Experiment](../index.html) / [Matcher](index.html) / [regions](./regions.html) + +# regions + +`val regions: `[`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)`>?` + +Regions where the experiment should be enabled + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/-matcher/release-channel.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/-matcher/release-channel.md new file mode 100644 index 00000000000..d5c0323d030 --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/-matcher/release-channel.md @@ -0,0 +1,12 @@ +--- +title: Experiment.Matcher.releaseChannel - +--- + +[mozilla.components.service.fretboard](../../index.html) / [Experiment](../index.html) / [Matcher](index.html) / [releaseChannel](./release-channel.html) + +# releaseChannel + +`val releaseChannel: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` + +Required app release channel (alpha, beta, ...), as a regex + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/-matcher/version.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/-matcher/version.md new file mode 100644 index 00000000000..6d8b6b2bb00 --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/-matcher/version.md @@ -0,0 +1,12 @@ +--- +title: Experiment.Matcher.version - +--- + +[mozilla.components.service.fretboard](../../index.html) / [Experiment](../index.html) / [Matcher](index.html) / [version](./version.html) + +# version + +`val version: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` + +Required app version, as a regex + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/bucket.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/bucket.md new file mode 100644 index 00000000000..c88d3f1ce57 --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/bucket.md @@ -0,0 +1,12 @@ +--- +title: Experiment.bucket - +--- + +[mozilla.components.service.fretboard](../index.html) / [Experiment](index.html) / [bucket](./bucket.html) + +# bucket + +`val bucket: `[`Bucket`](-bucket/index.html)`?` + +Experiment buckets + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/description.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/description.md new file mode 100644 index 00000000000..ec227f3362f --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/description.md @@ -0,0 +1,12 @@ +--- +title: Experiment.description - +--- + +[mozilla.components.service.fretboard](../index.html) / [Experiment](index.html) / [description](./description.html) + +# description + +`val description: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` + +Detailed description of the experiment + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/equals.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/equals.md new file mode 100644 index 00000000000..d5c8c9917c6 --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/equals.md @@ -0,0 +1,15 @@ +--- +title: Experiment.equals - +--- + +[mozilla.components.service.fretboard](../index.html) / [Experiment](index.html) / [equals](./equals.html) + +# equals + +`fun equals(other: `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`?): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Compares experiments by their id + +**Return** +true if the two experiments have the same id, false otherwise + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/hash-code.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/hash-code.md new file mode 100644 index 00000000000..0728f8e43a7 --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/hash-code.md @@ -0,0 +1,9 @@ +--- +title: Experiment.hashCode - +--- + +[mozilla.components.service.fretboard](../index.html) / [Experiment](index.html) / [hashCode](./hash-code.html) + +# hashCode + +`fun hashCode(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/id.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/id.md new file mode 100644 index 00000000000..fe2e5c352e2 --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/id.md @@ -0,0 +1,12 @@ +--- +title: Experiment.id - +--- + +[mozilla.components.service.fretboard](../index.html) / [Experiment](index.html) / [id](./id.html) + +# id + +`val id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) + +Unique identifier of the experiment + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/index.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/index.md new file mode 100644 index 00000000000..9fbd06a929b --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/index.md @@ -0,0 +1,39 @@ +--- +title: Experiment - +--- + +[mozilla.components.service.fretboard](../index.html) / [Experiment](./index.html) + +# Experiment + +`data class Experiment` + +Represents an A/B test experiment, +independent of the underlying +storage mechanism + +### Types + +| [Bucket](-bucket/index.html) | `data class Bucket` | +| [Matcher](-matcher/index.html) | `data class Matcher` | + +### Constructors + +| [<init>](-init-.html) | `Experiment(id: `[`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)`, description: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, match: `[`Matcher`](-matcher/index.html)`? = null, bucket: `[`Bucket`](-bucket/index.html)`? = null, lastModified: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`? = null, payload: `[`ExperimentPayload`](../-experiment-payload/index.html)`? = null, schema: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`? = null)`
Represents an A/B test experiment, independent of the underlying storage mechanism | + +### Properties + +| [bucket](bucket.html) | `val bucket: `[`Bucket`](-bucket/index.html)`?`
Experiment buckets | +| [description](description.html) | `val description: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
Detailed description of the experiment | +| [id](id.html) | `val id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Unique identifier of the experiment | +| [lastModified](last-modified.html) | `val lastModified: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`?`
Last modified date, as a UNIX timestamp | +| [match](match.html) | `val match: `[`Matcher`](-matcher/index.html)`?`
Filters for enabling the experiment | +| [name](name.html) | `val name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Human-readable name of the experiment | +| [payload](payload.html) | `val payload: `[`ExperimentPayload`](../-experiment-payload/index.html)`?`
Experiment associated metadata | +| [schema](schema.html) | `val schema: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`?`
Last time the experiment schema was modified (as a UNIX timestamp) | + +### Functions + +| [equals](equals.html) | `fun equals(other: `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`?): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Compares experiments by their id | +| [hashCode](hash-code.html) | `fun hashCode(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/last-modified.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/last-modified.md new file mode 100644 index 00000000000..1f3c97f46b5 --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/last-modified.md @@ -0,0 +1,12 @@ +--- +title: Experiment.lastModified - +--- + +[mozilla.components.service.fretboard](../index.html) / [Experiment](index.html) / [lastModified](./last-modified.html) + +# lastModified + +`val lastModified: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`?` + +Last modified date, as a UNIX timestamp + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/match.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/match.md new file mode 100644 index 00000000000..02f44c11fe0 --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/match.md @@ -0,0 +1,12 @@ +--- +title: Experiment.match - +--- + +[mozilla.components.service.fretboard](../index.html) / [Experiment](index.html) / [match](./match.html) + +# match + +`val match: `[`Matcher`](-matcher/index.html)`?` + +Filters for enabling the experiment + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/name.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/name.md new file mode 100644 index 00000000000..2ad4cd7fc39 --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/name.md @@ -0,0 +1,12 @@ +--- +title: Experiment.name - +--- + +[mozilla.components.service.fretboard](../index.html) / [Experiment](index.html) / [name](./name.html) + +# name + +`val name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) + +Human-readable name of the experiment + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/payload.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/payload.md new file mode 100644 index 00000000000..0e862d1bf89 --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/payload.md @@ -0,0 +1,12 @@ +--- +title: Experiment.payload - +--- + +[mozilla.components.service.fretboard](../index.html) / [Experiment](index.html) / [payload](./payload.html) + +# payload + +`val payload: `[`ExperimentPayload`](../-experiment-payload/index.html)`?` + +Experiment associated metadata + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/schema.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/schema.md new file mode 100644 index 00000000000..a1bdb646d65 --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiment/schema.md @@ -0,0 +1,13 @@ +--- +title: Experiment.schema - +--- + +[mozilla.components.service.fretboard](../index.html) / [Experiment](index.html) / [schema](./schema.html) + +# schema + +`val schema: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`?` + +Last time the experiment schema was modified +(as a UNIX timestamp) + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiments-snapshot/-init-.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiments-snapshot/-init-.md new file mode 100644 index 00000000000..3f2cf1bf508 --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiments-snapshot/-init-.md @@ -0,0 +1,12 @@ +--- +title: ExperimentsSnapshot. - +--- + +[mozilla.components.service.fretboard](../index.html) / [ExperimentsSnapshot](index.html) / [<init>](./-init-.html) + +# <init> + +`ExperimentsSnapshot(experiments: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Experiment`](../-experiment/index.html)`>, lastModified: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`?)` + +Represents an experiment sync result + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiments-snapshot/experiments.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiments-snapshot/experiments.md new file mode 100644 index 00000000000..03ca3b5eac0 --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiments-snapshot/experiments.md @@ -0,0 +1,12 @@ +--- +title: ExperimentsSnapshot.experiments - +--- + +[mozilla.components.service.fretboard](../index.html) / [ExperimentsSnapshot](index.html) / [experiments](./experiments.html) + +# experiments + +`val experiments: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Experiment`](../-experiment/index.html)`>` + +Downloaded list of experiments + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiments-snapshot/index.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiments-snapshot/index.md new file mode 100644 index 00000000000..cb3ea57bdb2 --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiments-snapshot/index.md @@ -0,0 +1,21 @@ +--- +title: ExperimentsSnapshot - +--- + +[mozilla.components.service.fretboard](../index.html) / [ExperimentsSnapshot](./index.html) + +# ExperimentsSnapshot + +`data class ExperimentsSnapshot` + +Represents an experiment sync result + +### Constructors + +| [<init>](-init-.html) | `ExperimentsSnapshot(experiments: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Experiment`](../-experiment/index.html)`>, lastModified: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`?)`
Represents an experiment sync result | + +### Properties + +| [experiments](experiments.html) | `val experiments: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Experiment`](../-experiment/index.html)`>`
Downloaded list of experiments | +| [lastModified](last-modified.html) | `val lastModified: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`?`
Last time experiments were modified on the server, as a UNIX timestamp | + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiments-snapshot/last-modified.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiments-snapshot/last-modified.md new file mode 100644 index 00000000000..023c8a67bd0 --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-experiments-snapshot/last-modified.md @@ -0,0 +1,12 @@ +--- +title: ExperimentsSnapshot.lastModified - +--- + +[mozilla.components.service.fretboard](../index.html) / [ExperimentsSnapshot](index.html) / [lastModified](./last-modified.html) + +# lastModified + +`val lastModified: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`?` + +Last time experiments were modified on the server, as a UNIX timestamp + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-fretboard/-init-.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-fretboard/-init-.md new file mode 100644 index 00000000000..101dee9a32f --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-fretboard/-init-.md @@ -0,0 +1,12 @@ +--- +title: Fretboard. - +--- + +[mozilla.components.service.fretboard](../index.html) / [Fretboard](index.html) / [<init>](./-init-.html) + +# <init> + +`Fretboard(source: `[`ExperimentSource`](../-experiment-source/index.html)`, storage: `[`ExperimentStorage`](../-experiment-storage/index.html)`, valuesProvider: `[`ValuesProvider`](../-values-provider/index.html)` = ValuesProvider())` + +Entry point of the library + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-fretboard/clear-all-overrides.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-fretboard/clear-all-overrides.md new file mode 100644 index 00000000000..6522823b79f --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-fretboard/clear-all-overrides.md @@ -0,0 +1,15 @@ +--- +title: Fretboard.clearAllOverrides - +--- + +[mozilla.components.service.fretboard](../index.html) / [Fretboard](index.html) / [clearAllOverrides](./clear-all-overrides.html) + +# clearAllOverrides + +`fun clearAllOverrides(context: Context): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Clears all experiment overrides + +### Parameters + +`context` - context \ No newline at end of file diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-fretboard/clear-override.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-fretboard/clear-override.md new file mode 100644 index 00000000000..752ae4404b9 --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-fretboard/clear-override.md @@ -0,0 +1,17 @@ +--- +title: Fretboard.clearOverride - +--- + +[mozilla.components.service.fretboard](../index.html) / [Fretboard](index.html) / [clearOverride](./clear-override.html) + +# clearOverride + +`fun clearOverride(context: Context, descriptor: `[`ExperimentDescriptor`](../-experiment-descriptor/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Clears an override for a specified experiment + +### Parameters + +`context` - context + +`descriptor` - descriptor of the experiment \ No newline at end of file diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-fretboard/experiments.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-fretboard/experiments.md new file mode 100644 index 00000000000..b3a19c783b5 --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-fretboard/experiments.md @@ -0,0 +1,12 @@ +--- +title: Fretboard.experiments - +--- + +[mozilla.components.service.fretboard](../index.html) / [Fretboard](index.html) / [experiments](./experiments.html) + +# experiments + +`val experiments: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Experiment`](../-experiment/index.html)`>` + +Provides the list of experiments (active or not) + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-fretboard/get-active-experiments.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-fretboard/get-active-experiments.md new file mode 100644 index 00000000000..9c20113b128 --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-fretboard/get-active-experiments.md @@ -0,0 +1,19 @@ +--- +title: Fretboard.getActiveExperiments - +--- + +[mozilla.components.service.fretboard](../index.html) / [Fretboard](index.html) / [getActiveExperiments](./get-active-experiments.html) + +# getActiveExperiments + +`fun getActiveExperiments(context: Context): `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Experiment`](../-experiment/index.html)`>` + +Provides the list of active experiments + +### Parameters + +`context` - context + +**Return** +active experiments + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-fretboard/get-experiment.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-fretboard/get-experiment.md new file mode 100644 index 00000000000..52170156974 --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-fretboard/get-experiment.md @@ -0,0 +1,19 @@ +--- +title: Fretboard.getExperiment - +--- + +[mozilla.components.service.fretboard](../index.html) / [Fretboard](index.html) / [getExperiment](./get-experiment.html) + +# getExperiment + +`fun getExperiment(descriptor: `[`ExperimentDescriptor`](../-experiment-descriptor/index.html)`): `[`Experiment`](../-experiment/index.html)`?` + +Gets the metadata associated with the specified experiment, even if the user is not part of it + +### Parameters + +`descriptor` - descriptor of the experiment + +**Return** +metadata associated with the experiment + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-fretboard/index.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-fretboard/index.md new file mode 100644 index 00000000000..a39a6eb9267 --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-fretboard/index.md @@ -0,0 +1,32 @@ +--- +title: Fretboard - +--- + +[mozilla.components.service.fretboard](../index.html) / [Fretboard](./index.html) + +# Fretboard + +`class Fretboard` + +Entry point of the library + +### Constructors + +| [<init>](-init-.html) | `Fretboard(source: `[`ExperimentSource`](../-experiment-source/index.html)`, storage: `[`ExperimentStorage`](../-experiment-storage/index.html)`, valuesProvider: `[`ValuesProvider`](../-values-provider/index.html)` = ValuesProvider())`
Entry point of the library | + +### Properties + +| [experiments](experiments.html) | `val experiments: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Experiment`](../-experiment/index.html)`>`
Provides the list of experiments (active or not) | + +### Functions + +| [clearAllOverrides](clear-all-overrides.html) | `fun clearAllOverrides(context: Context): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Clears all experiment overrides | +| [clearOverride](clear-override.html) | `fun clearOverride(context: Context, descriptor: `[`ExperimentDescriptor`](../-experiment-descriptor/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Clears an override for a specified experiment | +| [getActiveExperiments](get-active-experiments.html) | `fun getActiveExperiments(context: Context): `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Experiment`](../-experiment/index.html)`>`
Provides the list of active experiments | +| [getExperiment](get-experiment.html) | `fun getExperiment(descriptor: `[`ExperimentDescriptor`](../-experiment-descriptor/index.html)`): `[`Experiment`](../-experiment/index.html)`?`
Gets the metadata associated with the specified experiment, even if the user is not part of it | +| [isInExperiment](is-in-experiment.html) | `fun isInExperiment(context: Context, descriptor: `[`ExperimentDescriptor`](../-experiment-descriptor/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Checks if the user is part of the specified experiment | +| [loadExperiments](load-experiments.html) | `fun loadExperiments(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Loads experiments from local storage | +| [setOverride](set-override.html) | `fun setOverride(context: Context, descriptor: `[`ExperimentDescriptor`](../-experiment-descriptor/index.html)`, active: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Overrides a specified experiment | +| [updateExperiments](update-experiments.html) | `fun updateExperiments(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Requests new experiments from the server and saves them to local storage | +| [withExperiment](with-experiment.html) | `fun withExperiment(context: Context, descriptor: `[`ExperimentDescriptor`](../-experiment-descriptor/index.html)`, block: (`[`Experiment`](../-experiment/index.html)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Performs an action if the user is part of the specified experiment | + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-fretboard/is-in-experiment.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-fretboard/is-in-experiment.md new file mode 100644 index 00000000000..3ff620071ce --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-fretboard/is-in-experiment.md @@ -0,0 +1,22 @@ +--- +title: Fretboard.isInExperiment - +--- + +[mozilla.components.service.fretboard](../index.html) / [Fretboard](index.html) / [isInExperiment](./is-in-experiment.html) + +# isInExperiment + +`fun isInExperiment(context: Context, descriptor: `[`ExperimentDescriptor`](../-experiment-descriptor/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Checks if the user is part of +the specified experiment + +### Parameters + +`context` - context + +`descriptor` - descriptor of the experiment to check + +**Return** +true if the user is part of the specified experiment, false otherwise + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-fretboard/load-experiments.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-fretboard/load-experiments.md new file mode 100644 index 00000000000..cef36c8ac1f --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-fretboard/load-experiments.md @@ -0,0 +1,12 @@ +--- +title: Fretboard.loadExperiments - +--- + +[mozilla.components.service.fretboard](../index.html) / [Fretboard](index.html) / [loadExperiments](./load-experiments.html) + +# loadExperiments + +`@Synchronized fun loadExperiments(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Loads experiments from local storage + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-fretboard/set-override.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-fretboard/set-override.md new file mode 100644 index 00000000000..cc185142441 --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-fretboard/set-override.md @@ -0,0 +1,19 @@ +--- +title: Fretboard.setOverride - +--- + +[mozilla.components.service.fretboard](../index.html) / [Fretboard](index.html) / [setOverride](./set-override.html) + +# setOverride + +`fun setOverride(context: Context, descriptor: `[`ExperimentDescriptor`](../-experiment-descriptor/index.html)`, active: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Overrides a specified experiment + +### Parameters + +`context` - context + +`descriptor` - descriptor of the experiment + +`active` - overridden value for the experiment, true to activate it, false to deactivate \ No newline at end of file diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-fretboard/update-experiments.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-fretboard/update-experiments.md new file mode 100644 index 00000000000..6621c89313d --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-fretboard/update-experiments.md @@ -0,0 +1,13 @@ +--- +title: Fretboard.updateExperiments - +--- + +[mozilla.components.service.fretboard](../index.html) / [Fretboard](index.html) / [updateExperiments](./update-experiments.html) + +# updateExperiments + +`@Synchronized fun updateExperiments(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Requests new experiments from the server and +saves them to local storage + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-fretboard/with-experiment.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-fretboard/with-experiment.md new file mode 100644 index 00000000000..f1c1a2971b5 --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-fretboard/with-experiment.md @@ -0,0 +1,19 @@ +--- +title: Fretboard.withExperiment - +--- + +[mozilla.components.service.fretboard](../index.html) / [Fretboard](index.html) / [withExperiment](./with-experiment.html) + +# withExperiment + +`fun withExperiment(context: Context, descriptor: `[`ExperimentDescriptor`](../-experiment-descriptor/index.html)`, block: (`[`Experiment`](../-experiment/index.html)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Performs an action if the user is part of the specified experiment + +### Parameters + +`context` - context + +`descriptor` - descriptor of the experiment to check + +`block` - block of code to be executed if the user is part of the experiment \ No newline at end of file diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-j-s-o-n-experiment-parser/-init-.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-j-s-o-n-experiment-parser/-init-.md new file mode 100644 index 00000000000..a88f615146f --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-j-s-o-n-experiment-parser/-init-.md @@ -0,0 +1,12 @@ +--- +title: JSONExperimentParser. - +--- + +[mozilla.components.service.fretboard](../index.html) / [JSONExperimentParser](index.html) / [<init>](./-init-.html) + +# <init> + +`JSONExperimentParser()` + +Default JSON parsing implementation + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-j-s-o-n-experiment-parser/from-json.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-j-s-o-n-experiment-parser/from-json.md new file mode 100644 index 00000000000..369e092ae3a --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-j-s-o-n-experiment-parser/from-json.md @@ -0,0 +1,19 @@ +--- +title: JSONExperimentParser.fromJson - +--- + +[mozilla.components.service.fretboard](../index.html) / [JSONExperimentParser](index.html) / [fromJson](./from-json.html) + +# fromJson + +`fun fromJson(jsonObject: JSONObject): `[`Experiment`](../-experiment/index.html) + +Creates an experiment from its json representation + +### Parameters + +`jsonObject` - experiment json object + +**Return** +created experiment + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-j-s-o-n-experiment-parser/index.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-j-s-o-n-experiment-parser/index.md new file mode 100644 index 00000000000..3c3aa61112f --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-j-s-o-n-experiment-parser/index.md @@ -0,0 +1,21 @@ +--- +title: JSONExperimentParser - +--- + +[mozilla.components.service.fretboard](../index.html) / [JSONExperimentParser](./index.html) + +# JSONExperimentParser + +`class JSONExperimentParser` + +Default JSON parsing implementation + +### Constructors + +| [<init>](-init-.html) | `JSONExperimentParser()`
Default JSON parsing implementation | + +### Functions + +| [fromJson](from-json.html) | `fun fromJson(jsonObject: JSONObject): `[`Experiment`](../-experiment/index.html)
Creates an experiment from its json representation | +| [toJson](to-json.html) | `fun toJson(experiment: `[`Experiment`](../-experiment/index.html)`): JSONObject`
Converts the specified experiment to json | + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-j-s-o-n-experiment-parser/to-json.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-j-s-o-n-experiment-parser/to-json.md new file mode 100644 index 00000000000..7a7c964779b --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-j-s-o-n-experiment-parser/to-json.md @@ -0,0 +1,19 @@ +--- +title: JSONExperimentParser.toJson - +--- + +[mozilla.components.service.fretboard](../index.html) / [JSONExperimentParser](index.html) / [toJson](./to-json.html) + +# toJson + +`fun toJson(experiment: `[`Experiment`](../-experiment/index.html)`): JSONObject` + +Converts the specified experiment to json + +### Parameters + +`experiment` - experiment to convert + +**Return** +json representation of the experiment + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-values-provider/-init-.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-values-provider/-init-.md new file mode 100644 index 00000000000..db82145d008 --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-values-provider/-init-.md @@ -0,0 +1,13 @@ +--- +title: ValuesProvider. - +--- + +[mozilla.components.service.fretboard](../index.html) / [ValuesProvider](index.html) / [<init>](./-init-.html) + +# <init> + +`ValuesProvider()` + +Class used to provide +custom filter values + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-values-provider/get-app-id.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-values-provider/get-app-id.md new file mode 100644 index 00000000000..44c6870e1fd --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-values-provider/get-app-id.md @@ -0,0 +1,15 @@ +--- +title: ValuesProvider.getAppId - +--- + +[mozilla.components.service.fretboard](../index.html) / [ValuesProvider](index.html) / [getAppId](./get-app-id.html) + +# getAppId + +`open fun getAppId(context: Context): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) + +Provides the app id (package name) + +**Return** +app id (package name) + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-values-provider/get-country.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-values-provider/get-country.md new file mode 100644 index 00000000000..da2f092bc40 --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-values-provider/get-country.md @@ -0,0 +1,15 @@ +--- +title: ValuesProvider.getCountry - +--- + +[mozilla.components.service.fretboard](../index.html) / [ValuesProvider](index.html) / [getCountry](./get-country.html) + +# getCountry + +`open fun getCountry(context: Context): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) + +Provides the user's country + +**Return** +user's country, as a three-letter abbreviation + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-values-provider/get-device.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-values-provider/get-device.md new file mode 100644 index 00000000000..31b17434d02 --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-values-provider/get-device.md @@ -0,0 +1,15 @@ +--- +title: ValuesProvider.getDevice - +--- + +[mozilla.components.service.fretboard](../index.html) / [ValuesProvider](index.html) / [getDevice](./get-device.html) + +# getDevice + +`open fun getDevice(context: Context): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) + +Provides the device model + +**Return** +device model + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-values-provider/get-language.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-values-provider/get-language.md new file mode 100644 index 00000000000..abddb00654f --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-values-provider/get-language.md @@ -0,0 +1,15 @@ +--- +title: ValuesProvider.getLanguage - +--- + +[mozilla.components.service.fretboard](../index.html) / [ValuesProvider](index.html) / [getLanguage](./get-language.html) + +# getLanguage + +`open fun getLanguage(context: Context): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) + +Provides the user's language + +**Return** +user's language as a three-letter abbreviation + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-values-provider/get-manufacturer.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-values-provider/get-manufacturer.md new file mode 100644 index 00000000000..2cea7a60bad --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-values-provider/get-manufacturer.md @@ -0,0 +1,15 @@ +--- +title: ValuesProvider.getManufacturer - +--- + +[mozilla.components.service.fretboard](../index.html) / [ValuesProvider](index.html) / [getManufacturer](./get-manufacturer.html) + +# getManufacturer + +`open fun getManufacturer(context: Context): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) + +Provides the device manufacturer + +**Return** +device manufacturer + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-values-provider/get-region.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-values-provider/get-region.md new file mode 100644 index 00000000000..0f86fc524cb --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-values-provider/get-region.md @@ -0,0 +1,15 @@ +--- +title: ValuesProvider.getRegion - +--- + +[mozilla.components.service.fretboard](../index.html) / [ValuesProvider](index.html) / [getRegion](./get-region.html) + +# getRegion + +`open fun getRegion(context: Context): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` + +Provides the user's region + +**Return** +user's region as a three-letter abbreviation + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-values-provider/get-release-channel.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-values-provider/get-release-channel.md new file mode 100644 index 00000000000..e8bbc7e2348 --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-values-provider/get-release-channel.md @@ -0,0 +1,15 @@ +--- +title: ValuesProvider.getReleaseChannel - +--- + +[mozilla.components.service.fretboard](../index.html) / [ValuesProvider](index.html) / [getReleaseChannel](./get-release-channel.html) + +# getReleaseChannel + +`open fun getReleaseChannel(context: Context): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` + +Provides the app's release channel (alpha, beta, ...) + +**Return** +release channel of the app + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-values-provider/get-version.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-values-provider/get-version.md new file mode 100644 index 00000000000..ab1687a87b5 --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-values-provider/get-version.md @@ -0,0 +1,15 @@ +--- +title: ValuesProvider.getVersion - +--- + +[mozilla.components.service.fretboard](../index.html) / [ValuesProvider](index.html) / [getVersion](./get-version.html) + +# getVersion + +`open fun getVersion(context: Context): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) + +Provides the app version + +**Return** +app version name + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-values-provider/index.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-values-provider/index.md new file mode 100644 index 00000000000..49cca9cfc27 --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/-values-provider/index.md @@ -0,0 +1,28 @@ +--- +title: ValuesProvider - +--- + +[mozilla.components.service.fretboard](../index.html) / [ValuesProvider](./index.html) + +# ValuesProvider + +`open class ValuesProvider` + +Class used to provide +custom filter values + +### Constructors + +| [<init>](-init-.html) | `ValuesProvider()`
Class used to provide custom filter values | + +### Functions + +| [getAppId](get-app-id.html) | `open fun getAppId(context: Context): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Provides the app id (package name) | +| [getCountry](get-country.html) | `open fun getCountry(context: Context): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Provides the user's country | +| [getDevice](get-device.html) | `open fun getDevice(context: Context): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Provides the device model | +| [getLanguage](get-language.html) | `open fun getLanguage(context: Context): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Provides the user's language | +| [getManufacturer](get-manufacturer.html) | `open fun getManufacturer(context: Context): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Provides the device manufacturer | +| [getRegion](get-region.html) | `open fun getRegion(context: Context): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
Provides the user's region | +| [getReleaseChannel](get-release-channel.html) | `open fun getReleaseChannel(context: Context): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
Provides the app's release channel (alpha, beta, ...) | +| [getVersion](get-version.html) | `open fun getVersion(context: Context): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Provides the app version | + diff --git a/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/index.md b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/index.md new file mode 100644 index 00000000000..befcdfa705c --- /dev/null +++ b/docs/api/0.21/service-fretboard/mozilla.components.service.fretboard/index.md @@ -0,0 +1,24 @@ +--- +title: mozilla.components.service.fretboard - +--- + +[mozilla.components.service.fretboard](./index.html) + +## Package mozilla.components.service.fretboard + +### Types + +| [Experiment](-experiment/index.html) | `data class Experiment`
Represents an A/B test experiment, independent of the underlying storage mechanism | +| [ExperimentDescriptor](-experiment-descriptor/index.html) | `data class ExperimentDescriptor`
Class used to identify an experiment | +| [ExperimentPayload](-experiment-payload/index.html) | `class ExperimentPayload`
Class which represents an experiment associated data | +| [ExperimentSource](-experiment-source/index.html) | `interface ExperimentSource`
Represents a location where experiments are stored (Kinto, a JSON file on a server, etc) | +| [ExperimentStorage](-experiment-storage/index.html) | `interface ExperimentStorage`
Represents a location where experiments are stored locally on the device | +| [ExperimentsSnapshot](-experiments-snapshot/index.html) | `data class ExperimentsSnapshot`
Represents an experiment sync result | +| [Fretboard](-fretboard/index.html) | `class Fretboard`
Entry point of the library | +| [JSONExperimentParser](-j-s-o-n-experiment-parser/index.html) | `class JSONExperimentParser`
Default JSON parsing implementation | +| [ValuesProvider](-values-provider/index.html) | `open class ValuesProvider`
Class used to provide custom filter values | + +### Exceptions + +| [ExperimentDownloadException](-experiment-download-exception/index.html) | `class ExperimentDownloadException : `[`Exception`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html)
Exception while downloading experiments from the server | + diff --git a/docs/api/0.21/service-fretboard/package-list b/docs/api/0.21/service-fretboard/package-list new file mode 100644 index 00000000000..bbca6b1d7bf --- /dev/null +++ b/docs/api/0.21/service-fretboard/package-list @@ -0,0 +1,7 @@ +$dokka.format:jekyll +$dokka.linkExtension:html + +mozilla.components.service.fretboard +mozilla.components.service.fretboard.scheduler.jobscheduler +mozilla.components.service.fretboard.source.kinto +mozilla.components.service.fretboard.storage.flatfile diff --git a/docs/api/0.21/service-telemetry/alltypes/index.md b/docs/api/0.21/service-telemetry/alltypes/index.md new file mode 100644 index 00000000000..b37591e0e16 --- /dev/null +++ b/docs/api/0.21/service-telemetry/alltypes/index.md @@ -0,0 +1,56 @@ +--- +title: alltypes - +--- + +### All Types + +| [org.mozilla.telemetry.measurement.ArchMeasurement](../org.mozilla.telemetry.measurement/-arch-measurement/index.html) | | +| [org.mozilla.telemetry.measurement.ClientIdMeasurement](../org.mozilla.telemetry.measurement/-client-id-measurement/index.html) | A unique, randomly generated UUID for this client. | +| [org.mozilla.telemetry.util.ContextUtils](../org.mozilla.telemetry.util/-context-utils/index.html) | | +| [org.mozilla.telemetry.measurement.CreatedDateMeasurement](../org.mozilla.telemetry.measurement/-created-date-measurement/index.html) | | +| [org.mozilla.telemetry.measurement.CreatedDateMeasurementNew](../org.mozilla.telemetry.measurement/-created-date-measurement-new/index.html) | 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.html) | | +| [org.mozilla.telemetry.measurement.CreatedTimestampMeasurementNew](../org.mozilla.telemetry.measurement/-created-timestamp-measurement-new/index.html) | The field 'created' from CreatedTimestampMeasurement will be deprecated for the `createdTimestamp` field | +| [org.mozilla.telemetry.net.DebugLogClient](../org.mozilla.telemetry.net/-debug-log-client/index.html) | This client just prints pings to logcat instead of uploading them. Therefore this client is only useful for debugging purposes. | +| [org.mozilla.telemetry.measurement.DefaultSearchMeasurement](../org.mozilla.telemetry.measurement/-default-search-measurement/index.html) | | +| [org.mozilla.telemetry.measurement.DeviceMeasurement](../org.mozilla.telemetry.measurement/-device-measurement/index.html) | | +| [org.mozilla.telemetry.measurement.EventsMeasurement](../org.mozilla.telemetry.measurement/-events-measurement/index.html) | | +| [org.mozilla.telemetry.measurement.ExperimentsMeasurement](../org.mozilla.telemetry.measurement/-experiments-measurement/index.html) | | +| [org.mozilla.telemetry.storage.FileTelemetryStorage](../org.mozilla.telemetry.storage/-file-telemetry-storage/index.html) | TelemetryStorage implementation that stores pings as files on disk. | +| [org.mozilla.telemetry.util.FileUtils](../org.mozilla.telemetry.util/-file-utils/index.html) | | +| [org.mozilla.telemetry.measurement.FirstRunProfileDateMeasurement](../org.mozilla.telemetry.measurement/-first-run-profile-date-measurement/index.html) | This measurement will save the timestamp of the first time it was instantiated and report this as profile creation date. | +| [org.mozilla.telemetry.net.HttpURLConnectionTelemetryClient](../org.mozilla.telemetry.net/-http-u-r-l-connection-telemetry-client/index.html) | | +| [org.mozilla.telemetry.util.IOUtils](../org.mozilla.telemetry.util/-i-o-utils/index.html) | | +| [org.mozilla.telemetry.serialize.JSONPingSerializer](../org.mozilla.telemetry.serialize/-j-s-o-n-ping-serializer/index.html) | TelemetryPingSerializer that uses the org.json library provided by the Android system. | +| [org.mozilla.telemetry.schedule.jobscheduler.JobSchedulerTelemetryScheduler](../org.mozilla.telemetry.schedule.jobscheduler/-job-scheduler-telemetry-scheduler/index.html) | TelemetryScheduler implementation that uses Android's JobScheduler API to schedule ping uploads. | +| [org.mozilla.telemetry.measurement.LocaleMeasurement](../org.mozilla.telemetry.measurement/-locale-measurement/index.html) | | +| [org.mozilla.telemetry.measurement.MetricsMeasurement](../org.mozilla.telemetry.measurement/-metrics-measurement/index.html) | | +| [org.mozilla.telemetry.measurement.OperatingSystemMeasurement](../org.mozilla.telemetry.measurement/-operating-system-measurement/index.html) | | +| [org.mozilla.telemetry.measurement.OperatingSystemVersionMeasurement](../org.mozilla.telemetry.measurement/-operating-system-version-measurement/index.html) | | +| [org.mozilla.telemetry.measurement.ProcessStartTimestampMeasurement](../org.mozilla.telemetry.measurement/-process-start-timestamp-measurement/index.html) | | +| [org.mozilla.telemetry.measurement.SearchesMeasurement](../org.mozilla.telemetry.measurement/-searches-measurement/index.html) | A TelemetryMeasurement implementation to count the number of times a user has searched with a specific engine from a specific location. | +| [org.mozilla.telemetry.measurement.SequenceMeasurement](../org.mozilla.telemetry.measurement/-sequence-measurement/index.html) | | +| [org.mozilla.telemetry.measurement.SessionCountMeasurement](../org.mozilla.telemetry.measurement/-session-count-measurement/index.html) | | +| [org.mozilla.telemetry.measurement.SessionDurationMeasurement](../org.mozilla.telemetry.measurement/-session-duration-measurement/index.html) | | +| [org.mozilla.telemetry.measurement.SettingsMeasurement](../org.mozilla.telemetry.measurement/-settings-measurement/index.html) | | +| [org.mozilla.telemetry.measurement.StaticMeasurement](../org.mozilla.telemetry.measurement/-static-measurement/index.html) | | +| [org.mozilla.telemetry.util.StringUtils](../org.mozilla.telemetry.util/-string-utils/index.html) | | +| [org.mozilla.telemetry.Telemetry](../org.mozilla.telemetry/-telemetry/index.html) | | +| [org.mozilla.telemetry.net.TelemetryClient](../org.mozilla.telemetry.net/-telemetry-client/index.html) | | +| [org.mozilla.telemetry.config.TelemetryConfiguration](../org.mozilla.telemetry.config/-telemetry-configuration/index.html) | The TelemetryConfiguration class collects the information describing the telemetry setup of an app. There are some parts that every app needs to configure: Where should measurements store data? What servers are we actually uploading pings to? This class should provide good defaults so that in the best case it is not needed to modify the configuration. | +| [org.mozilla.telemetry.ping.TelemetryCorePingBuilder](../org.mozilla.telemetry.ping/-telemetry-core-ping-builder/index.html) | This mobile-specific ping is intended to provide the most critical data in a concise format, allowing for frequent uploads. Since this ping is used to measure retention, it should be sent each time the app is opened. https://gecko.readthedocs.io/en/latest/toolkit/components/telemetry/telemetry/data/core-ping.html | +| [org.mozilla.telemetry.event.TelemetryEvent](../org.mozilla.telemetry.event/-telemetry-event/index.html) | TelemetryEvent specifies a common events data format, which allows for broader, shared usage of data processing tools. | +| [org.mozilla.telemetry.ping.TelemetryEventPingBuilder](../org.mozilla.telemetry.ping/-telemetry-event-ping-builder/index.html) | A telemetry ping builder for pings of type "focus-event". | +| [org.mozilla.telemetry.TelemetryHolder](../org.mozilla.telemetry/-telemetry-holder/index.html) | Holder of a static reference to the Telemetry instance. This is required for background services that somehow need to get access to the configuration and storage. This is not particular nice. Hopefully we can replace this with something better. | +| [org.mozilla.telemetry.schedule.jobscheduler.TelemetryJobService](../org.mozilla.telemetry.schedule.jobscheduler/-telemetry-job-service/index.html) | | +| [org.mozilla.telemetry.measurement.TelemetryMeasurement](../org.mozilla.telemetry.measurement/-telemetry-measurement/index.html) | | +| [org.mozilla.telemetry.ping.TelemetryMobileEventPingBuilder](../org.mozilla.telemetry.ping/-telemetry-mobile-event-ping-builder/index.html) | A telemetry ping builder for events of type "mobile-event". See the schema for more details: https://github.com/mozilla-services/mozilla-pipeline-schemas/blob/master/schemas/telemetry/mobile-event/mobile-event.1.schema.json | +| [org.mozilla.telemetry.ping.TelemetryMobileMetricsPingBuilder](../org.mozilla.telemetry.ping/-telemetry-mobile-metrics-ping-builder/index.html) | A telemetry ping builder for events of type "mobile-metrics". See the schema for more details: https://github.com/mozilla-services/mozilla-pipeline-schemas/blob/master/schemas/telemetry/mobile-metrics/mobile-metrics.1.schema.json | +| [org.mozilla.telemetry.ping.TelemetryPing](../org.mozilla.telemetry.ping/-telemetry-ping/index.html) | | +| [org.mozilla.telemetry.ping.TelemetryPingBuilder](../org.mozilla.telemetry.ping/-telemetry-ping-builder/index.html) | | +| [org.mozilla.telemetry.serialize.TelemetryPingSerializer](../org.mozilla.telemetry.serialize/-telemetry-ping-serializer/index.html) | | +| [org.mozilla.telemetry.schedule.TelemetryScheduler](../org.mozilla.telemetry.schedule/-telemetry-scheduler/index.html) | | +| [org.mozilla.telemetry.storage.TelemetryStorage](../org.mozilla.telemetry.storage/-telemetry-storage/index.html) | | +| [org.mozilla.telemetry.measurement.TimezoneOffsetMeasurement](../org.mozilla.telemetry.measurement/-timezone-offset-measurement/index.html) | | +| [org.mozilla.telemetry.measurement.VersionMeasurement](../org.mozilla.telemetry.measurement/-version-measurement/index.html) | | + diff --git a/docs/api/0.21/service-telemetry/index.md b/docs/api/0.21/service-telemetry/index.md new file mode 100644 index 00000000000..7fdf3a422d4 --- /dev/null +++ b/docs/api/0.21/service-telemetry/index.md @@ -0,0 +1,21 @@ +--- +title: +--- + +### Packages + +| [org.mozilla.telemetry](org.mozilla.telemetry/index.html) | | +| [org.mozilla.telemetry.config](org.mozilla.telemetry.config/index.html) | | +| [org.mozilla.telemetry.event](org.mozilla.telemetry.event/index.html) | | +| [org.mozilla.telemetry.measurement](org.mozilla.telemetry.measurement/index.html) | | +| [org.mozilla.telemetry.net](org.mozilla.telemetry.net/index.html) | | +| [org.mozilla.telemetry.ping](org.mozilla.telemetry.ping/index.html) | | +| [org.mozilla.telemetry.schedule](org.mozilla.telemetry.schedule/index.html) | | +| [org.mozilla.telemetry.schedule.jobscheduler](org.mozilla.telemetry.schedule.jobscheduler/index.html) | | +| [org.mozilla.telemetry.serialize](org.mozilla.telemetry.serialize/index.html) | | +| [org.mozilla.telemetry.storage](org.mozilla.telemetry.storage/index.html) | | +| [org.mozilla.telemetry.util](org.mozilla.telemetry.util/index.html) | | + +### Index + +[All Types](alltypes/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/-init-.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/-init-.md new file mode 100644 index 00000000000..bdd561b8b75 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/-init-.md @@ -0,0 +1,9 @@ +--- +title: TelemetryConfiguration. - +--- + +[org.mozilla.telemetry.config](../index.html) / [TelemetryConfiguration](index.html) / [<init>](./-init-.html) + +# <init> + +`TelemetryConfiguration(context: Context)` \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/get-app-name.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/get-app-name.md new file mode 100644 index 00000000000..8e9a42f4102 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/get-app-name.md @@ -0,0 +1,12 @@ +--- +title: TelemetryConfiguration.getAppName - +--- + +[org.mozilla.telemetry.config](../index.html) / [TelemetryConfiguration](index.html) / [getAppName](./get-app-name.html) + +# getAppName + +`open fun getAppName(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) + +Get the name of the app. This value is used as one dimension when uploading telemetry to the HTTP Edge server. + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/get-app-version.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/get-app-version.md new file mode 100644 index 00000000000..ddfec377250 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/get-app-version.md @@ -0,0 +1,12 @@ +--- +title: TelemetryConfiguration.getAppVersion - +--- + +[org.mozilla.telemetry.config](../index.html) / [TelemetryConfiguration](index.html) / [getAppVersion](./get-app-version.html) + +# getAppVersion + +`open fun getAppVersion(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) + +Get the version of the app (e.g. 45.0.1). This value is used as one dimension when uploading telemetry to the HTTP Edge server. + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/get-build-id.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/get-build-id.md new file mode 100644 index 00000000000..911138b4252 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/get-build-id.md @@ -0,0 +1,12 @@ +--- +title: TelemetryConfiguration.getBuildId - +--- + +[org.mozilla.telemetry.config](../index.html) / [TelemetryConfiguration](index.html) / [getBuildId](./get-build-id.html) + +# getBuildId + +`open fun getBuildId(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) + +Get the build id of the app (e.g. 20150125030202). This value is used as one dimension when uploading telemetry to the HTTP Edge server. + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/get-class-load-timestamp-millis.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/get-class-load-timestamp-millis.md new file mode 100644 index 00000000000..6b1973d9dc1 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/get-class-load-timestamp-millis.md @@ -0,0 +1,9 @@ +--- +title: TelemetryConfiguration.getClassLoadTimestampMillis - +--- + +[org.mozilla.telemetry.config](../index.html) / [TelemetryConfiguration](index.html) / [getClassLoadTimestampMillis](./get-class-load-timestamp-millis.html) + +# getClassLoadTimestampMillis + +`open fun getClassLoadTimestampMillis(): `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/get-connect-timeout.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/get-connect-timeout.md new file mode 100644 index 00000000000..f555c56c364 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/get-connect-timeout.md @@ -0,0 +1,12 @@ +--- +title: TelemetryConfiguration.getConnectTimeout - +--- + +[org.mozilla.telemetry.config](../index.html) / [TelemetryConfiguration](index.html) / [getConnectTimeout](./get-connect-timeout.html) + +# getConnectTimeout + +`open fun getConnectTimeout(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +Returns setting for connect timeout (milliseconds). A value of 0 implies that the option is disabled (i.e., timeout of infinity). + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/get-context.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/get-context.md new file mode 100644 index 00000000000..17aad0ed311 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/get-context.md @@ -0,0 +1,12 @@ +--- +title: TelemetryConfiguration.getContext - +--- + +[org.mozilla.telemetry.config](../index.html) / [TelemetryConfiguration](index.html) / [getContext](./get-context.html) + +# getContext + +`open fun getContext(): Context` + +Application context this library is running in. + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/get-data-directory.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/get-data-directory.md new file mode 100644 index 00000000000..97ac845ab33 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/get-data-directory.md @@ -0,0 +1,12 @@ +--- +title: TelemetryConfiguration.getDataDirectory - +--- + +[org.mozilla.telemetry.config](../index.html) / [TelemetryConfiguration](index.html) / [getDataDirectory](./get-data-directory.html) + +# getDataDirectory + +`open fun getDataDirectory(): `[`File`](http://docs.oracle.com/javase/6/docs/api/java/io/File.html) + +Get the root directory where telemetry components should store data. + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/get-initial-backoff-for-upload.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/get-initial-backoff-for-upload.md new file mode 100644 index 00000000000..9c334087a3e --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/get-initial-backoff-for-upload.md @@ -0,0 +1,12 @@ +--- +title: TelemetryConfiguration.getInitialBackoffForUpload - +--- + +[org.mozilla.telemetry.config](../index.html) / [TelemetryConfiguration](index.html) / [getInitialBackoffForUpload](./get-initial-backoff-for-upload.html) + +# getInitialBackoffForUpload + +`open fun getInitialBackoffForUpload(): `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +Get the interval (in milliseconds) to wait initially after a ping upload has failed. + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/get-maximum-number-of-events-per-ping.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/get-maximum-number-of-events-per-ping.md new file mode 100644 index 00000000000..54b6b67058e --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/get-maximum-number-of-events-per-ping.md @@ -0,0 +1,12 @@ +--- +title: TelemetryConfiguration.getMaximumNumberOfEventsPerPing - +--- + +[org.mozilla.telemetry.config](../index.html) / [TelemetryConfiguration](index.html) / [getMaximumNumberOfEventsPerPing](./get-maximum-number-of-events-per-ping.html) + +# getMaximumNumberOfEventsPerPing + +`open fun getMaximumNumberOfEventsPerPing(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +Get the maximum number of events per ping. + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/get-maximum-number-of-ping-uploads-per-day.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/get-maximum-number-of-ping-uploads-per-day.md new file mode 100644 index 00000000000..8c45849eadf --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/get-maximum-number-of-ping-uploads-per-day.md @@ -0,0 +1,12 @@ +--- +title: TelemetryConfiguration.getMaximumNumberOfPingUploadsPerDay - +--- + +[org.mozilla.telemetry.config](../index.html) / [TelemetryConfiguration](index.html) / [getMaximumNumberOfPingUploadsPerDay](./get-maximum-number-of-ping-uploads-per-day.html) + +# getMaximumNumberOfPingUploadsPerDay + +`open fun getMaximumNumberOfPingUploadsPerDay(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +Get the maximum number of pings that should be uploaded per day. + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/get-maximum-number-of-pings-per-type.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/get-maximum-number-of-pings-per-type.md new file mode 100644 index 00000000000..c60af474d7c --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/get-maximum-number-of-pings-per-type.md @@ -0,0 +1,12 @@ +--- +title: TelemetryConfiguration.getMaximumNumberOfPingsPerType - +--- + +[org.mozilla.telemetry.config](../index.html) / [TelemetryConfiguration](index.html) / [getMaximumNumberOfPingsPerType](./get-maximum-number-of-pings-per-type.html) + +# getMaximumNumberOfPingsPerType + +`open fun getMaximumNumberOfPingsPerType(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +Get the maximum number of pings that will be stored (for upload). + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/get-minimum-events-for-upload.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/get-minimum-events-for-upload.md new file mode 100644 index 00000000000..a180b004cc2 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/get-minimum-events-for-upload.md @@ -0,0 +1,12 @@ +--- +title: TelemetryConfiguration.getMinimumEventsForUpload - +--- + +[org.mozilla.telemetry.config](../index.html) / [TelemetryConfiguration](index.html) / [getMinimumEventsForUpload](./get-minimum-events-for-upload.html) + +# getMinimumEventsForUpload + +`open fun getMinimumEventsForUpload(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +Get the minimum number of telemetry events that need to be fired before even trying to upload an event ping. + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/get-preferences-important-for-telemetry.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/get-preferences-important-for-telemetry.md new file mode 100644 index 00000000000..690875fa5cd --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/get-preferences-important-for-telemetry.md @@ -0,0 +1,12 @@ +--- +title: TelemetryConfiguration.getPreferencesImportantForTelemetry - +--- + +[org.mozilla.telemetry.config](../index.html) / [TelemetryConfiguration](index.html) / [getPreferencesImportantForTelemetry](./get-preferences-important-for-telemetry.html) + +# getPreferencesImportantForTelemetry + +`open fun getPreferencesImportantForTelemetry(): `[`MutableSet`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-set/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>` + +Get a list of preference keys that are important for telemetry. + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/get-read-timeout.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/get-read-timeout.md new file mode 100644 index 00000000000..eddd7a3e559 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/get-read-timeout.md @@ -0,0 +1,12 @@ +--- +title: TelemetryConfiguration.getReadTimeout - +--- + +[org.mozilla.telemetry.config](../index.html) / [TelemetryConfiguration](index.html) / [getReadTimeout](./get-read-timeout.html) + +# getReadTimeout + +`open fun getReadTimeout(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +Returns setting for read timeout. 0 return implies that the option is disabled (i.e., timeout of infinity). + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/get-server-endpoint.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/get-server-endpoint.md new file mode 100644 index 00000000000..b88bf87d5a1 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/get-server-endpoint.md @@ -0,0 +1,12 @@ +--- +title: TelemetryConfiguration.getServerEndpoint - +--- + +[org.mozilla.telemetry.config](../index.html) / [TelemetryConfiguration](index.html) / [getServerEndpoint](./get-server-endpoint.html) + +# getServerEndpoint + +`open fun getServerEndpoint(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) + +Set the server endpoint to upload telemetry pings to. + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/get-settings-provider.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/get-settings-provider.md new file mode 100644 index 00000000000..b0778724a6a --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/get-settings-provider.md @@ -0,0 +1,12 @@ +--- +title: TelemetryConfiguration.getSettingsProvider - +--- + +[org.mozilla.telemetry.config](../index.html) / [TelemetryConfiguration](index.html) / [getSettingsProvider](./get-settings-provider.html) + +# getSettingsProvider + +`open fun getSettingsProvider(): `[`SettingsProvider`](../../org.mozilla.telemetry.measurement/-settings-measurement/-settings-provider/index.html) + +Get the provider for reading app settings. + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/get-shared-preferences.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/get-shared-preferences.md new file mode 100644 index 00000000000..b38f1d7b2bf --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/get-shared-preferences.md @@ -0,0 +1,12 @@ +--- +title: TelemetryConfiguration.getSharedPreferences - +--- + +[org.mozilla.telemetry.config](../index.html) / [TelemetryConfiguration](index.html) / [getSharedPreferences](./get-shared-preferences.html) + +# getSharedPreferences + +`open fun getSharedPreferences(): SharedPreferences` + +Get shared preference for storing telemetry related data. + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/get-update-channel.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/get-update-channel.md new file mode 100644 index 00000000000..e18203eac54 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/get-update-channel.md @@ -0,0 +1,12 @@ +--- +title: TelemetryConfiguration.getUpdateChannel - +--- + +[org.mozilla.telemetry.config](../index.html) / [TelemetryConfiguration](index.html) / [getUpdateChannel](./get-update-channel.html) + +# getUpdateChannel + +`open fun getUpdateChannel(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) + +Get the update channel of the app (e.g. beta, release). This value is used as one dimension when uploading telemetry to the HTTP Edge server. + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/get-user-agent.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/get-user-agent.md new file mode 100644 index 00000000000..7d0218c2921 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/get-user-agent.md @@ -0,0 +1,12 @@ +--- +title: TelemetryConfiguration.getUserAgent - +--- + +[org.mozilla.telemetry.config](../index.html) / [TelemetryConfiguration](index.html) / [getUserAgent](./get-user-agent.html) + +# getUserAgent + +`open fun getUserAgent(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) + +Get the user agent used when communicating with the telemetry endpoint. + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/index.md new file mode 100644 index 00000000000..fdbffb46554 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/index.md @@ -0,0 +1,58 @@ +--- +title: TelemetryConfiguration - +--- + +[org.mozilla.telemetry.config](../index.html) / [TelemetryConfiguration](./index.html) + +# TelemetryConfiguration + +`open class TelemetryConfiguration` + +The TelemetryConfiguration class collects the information describing the telemetry setup of an app. There are some parts that every app needs to configure: Where should measurements store data? What servers are we actually uploading pings to? This class should provide good defaults so that in the best case it is not needed to modify the configuration. + +### Constructors + +| [<init>](-init-.html) | `TelemetryConfiguration(context: Context)` | + +### Functions + +| [getAppName](get-app-name.html) | `open fun getAppName(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Get the name of the app. This value is used as one dimension when uploading telemetry to the HTTP Edge server. | +| [getAppVersion](get-app-version.html) | `open fun getAppVersion(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Get the version of the app (e.g. 45.0.1). This value is used as one dimension when uploading telemetry to the HTTP Edge server. | +| [getBuildId](get-build-id.html) | `open fun getBuildId(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Get the build id of the app (e.g. 20150125030202). This value is used as one dimension when uploading telemetry to the HTTP Edge server. | +| [getClassLoadTimestampMillis](get-class-load-timestamp-millis.html) | `open fun getClassLoadTimestampMillis(): `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) | +| [getConnectTimeout](get-connect-timeout.html) | `open fun getConnectTimeout(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Returns setting for connect timeout (milliseconds). A value of 0 implies that the option is disabled (i.e., timeout of infinity). | +| [getContext](get-context.html) | `open fun getContext(): Context`
Application context this library is running in. | +| [getDataDirectory](get-data-directory.html) | `open fun getDataDirectory(): `[`File`](http://docs.oracle.com/javase/6/docs/api/java/io/File.html)
Get the root directory where telemetry components should store data. | +| [getInitialBackoffForUpload](get-initial-backoff-for-upload.html) | `open fun getInitialBackoffForUpload(): `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
Get the interval (in milliseconds) to wait initially after a ping upload has failed. | +| [getMaximumNumberOfEventsPerPing](get-maximum-number-of-events-per-ping.html) | `open fun getMaximumNumberOfEventsPerPing(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Get the maximum number of events per ping. | +| [getMaximumNumberOfPingUploadsPerDay](get-maximum-number-of-ping-uploads-per-day.html) | `open fun getMaximumNumberOfPingUploadsPerDay(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Get the maximum number of pings that should be uploaded per day. | +| [getMaximumNumberOfPingsPerType](get-maximum-number-of-pings-per-type.html) | `open fun getMaximumNumberOfPingsPerType(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Get the maximum number of pings that will be stored (for upload). | +| [getMinimumEventsForUpload](get-minimum-events-for-upload.html) | `open fun getMinimumEventsForUpload(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Get the minimum number of telemetry events that need to be fired before even trying to upload an event ping. | +| [getPreferencesImportantForTelemetry](get-preferences-important-for-telemetry.html) | `open fun getPreferencesImportantForTelemetry(): `[`MutableSet`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-set/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>`
Get a list of preference keys that are important for telemetry. | +| [getReadTimeout](get-read-timeout.html) | `open fun getReadTimeout(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Returns setting for read timeout. 0 return implies that the option is disabled (i.e., timeout of infinity). | +| [getServerEndpoint](get-server-endpoint.html) | `open fun getServerEndpoint(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Set the server endpoint to upload telemetry pings to. | +| [getSettingsProvider](get-settings-provider.html) | `open fun getSettingsProvider(): `[`SettingsProvider`](../../org.mozilla.telemetry.measurement/-settings-measurement/-settings-provider/index.html)
Get the provider for reading app settings. | +| [getSharedPreferences](get-shared-preferences.html) | `open fun getSharedPreferences(): SharedPreferences`
Get shared preference for storing telemetry related data. | +| [getUpdateChannel](get-update-channel.html) | `open fun getUpdateChannel(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Get the update channel of the app (e.g. beta, release). This value is used as one dimension when uploading telemetry to the HTTP Edge server. | +| [getUserAgent](get-user-agent.html) | `open fun getUserAgent(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Get the user agent used when communicating with the telemetry endpoint. | +| [isCollectionEnabled](is-collection-enabled.html) | `open fun isCollectionEnabled(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Is collecting telemetry data enabled? | +| [isUploadEnabled](is-upload-enabled.html) | `open fun isUploadEnabled(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Is uploading collected telemetry data enable? | +| [setAppName](set-app-name.html) | `open fun setAppName(appName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`TelemetryConfiguration`](./index.md)
Set the name of the app. This value is used as one dimension when uploading telemetry to the HTTP Edge server. | +| [setAppVersion](set-app-version.html) | `open fun setAppVersion(appVersion: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`TelemetryConfiguration`](./index.md)
Set the version of the app (e.g. 45.0.1). This value is used as one dimension when uploading telemetry to the HTTP Edge server. | +| [setBuildId](set-build-id.html) | `open fun setBuildId(buildId: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`TelemetryConfiguration`](./index.md)
Get the build id of the app (e.g. 20150125030202). This value is used as one dimension when uploading telemetry to the HTTP Edge server. | +| [setCollectionEnabled](set-collection-enabled.html) | `open fun setCollectionEnabled(collectionEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`TelemetryConfiguration`](./index.md)
Enable or disable collection of telemetry data. Local dev builds should disable this to avoid collecting and sending any data. | +| [setConnectTimeout](set-connect-timeout.html) | `open fun setConnectTimeout(connectTimeout: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`TelemetryConfiguration`](./index.md)
Sets a specified timeout value, in milliseconds, to be used when opening a communications link to the telemetry endpoint. If the timeout expires before the connection can be established, the ping upload will be retried at a later time. A timeout of zero is interpreted as an infinite timeout. | +| [setDataDirectory](set-data-directory.html) | `open fun setDataDirectory(dataDirectory: `[`File`](http://docs.oracle.com/javase/6/docs/api/java/io/File.html)`): `[`TelemetryConfiguration`](./index.md)
Set the root directory where telemetry components should store data. | +| [setInitialBackoffForUpload](set-initial-backoff-for-upload.html) | `open fun setInitialBackoffForUpload(initialBackoffForUpload: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`): `[`TelemetryConfiguration`](./index.md)
Set the interval (in milliseconds) to wait initially after a ping upload has failed. | +| [setMaximumNumberOfEventsPerPing](set-maximum-number-of-events-per-ping.html) | `open fun setMaximumNumberOfEventsPerPing(maximumNumberOfEventsPerPing: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`TelemetryConfiguration`](./index.md)
Set the maximum number of events per ping. If this limit is reached a ping will built and stored automatically. The number of stored and uploaded pings might be limited too. | +| [setMaximumNumberOfPingUploadsPerDay](set-maximum-number-of-ping-uploads-per-day.html) | `open fun setMaximumNumberOfPingUploadsPerDay(maximumNumberOfPingUploadsPerDay: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`TelemetryConfiguration`](./index.md)
Set the maximum number of pings uploaded per day. This limit is enforced for every type. If you have 2 ping types and set a limit of 100 pings per day then in total 200 pings per day could be uploaded. | +| [setMaximumNumberOfPingsPerType](set-maximum-number-of-pings-per-type.html) | `open fun setMaximumNumberOfPingsPerType(maximumNumberOfPingsPerType: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`TelemetryConfiguration`](./index.md)
Set the maximum number of pings that will be stored for a given ping type. If more types are in the local store then pings will be removed (oldest first). For this to happen the maximum needs to be reached without any successful upload. | +| [setMinimumEventsForUpload](set-minimum-events-for-upload.html) | `open fun setMinimumEventsForUpload(minimumEventsForUpload: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`TelemetryConfiguration`](./index.md)
Set the minimum number of telemetry events that need to be fired before even trying to upload an event ping. The default value is 3. The minimum needs to be >= 1. | +| [setPreferencesImportantForTelemetry](set-preferences-important-for-telemetry.html) | `open fun setPreferencesImportantForTelemetry(vararg preferences: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`TelemetryConfiguration`](./index.md)
Set a list of preference keys that are important for telemetry. Some measurements and pings might use this to determine what preferences should be reported. | +| [setReadTimeout](set-read-timeout.html) | `open fun setReadTimeout(readTimeout: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`TelemetryConfiguration`](./index.md)
Sets the read timeout to a specified timeout, in milliseconds. A non-zero value specifies the timeout when reading from the telemetry endpoint. If the timeout expires before there is data available for read, the ping upload will be retried later. A timeout of zero is interpreted as an infinite timeout. | +| [setServerEndpoint](set-server-endpoint.html) | `open fun setServerEndpoint(endpoint: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`TelemetryConfiguration`](./index.md)
Set the server endpoint to upload telemetry pings to. And endpoint value should include the schema and no trailing slash, e.g.: https://telemetry.example.org | +| [setSettingsProvider](set-settings-provider.html) | `open fun setSettingsProvider(settingsProvider: `[`SettingsProvider`](../../org.mozilla.telemetry.measurement/-settings-measurement/-settings-provider/index.html)`): `[`TelemetryConfiguration`](./index.md)
Set a provider for reading app settings. | +| [setUpdateChannel](set-update-channel.html) | `open fun setUpdateChannel(updateChannel: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`TelemetryConfiguration`](./index.md)
Set the update channel of the app (e.g. beta, release). This value is used as one dimension when uploading telemetry to the HTTP Edge server. | +| [setUploadEnabled](set-upload-enabled.html) | `open fun setUploadEnabled(uploadEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`TelemetryConfiguration`](./index.md)
Enable or disable the upload of collected telemetry data. This is usually set based on a user visible preference. | +| [setUserAgent](set-user-agent.html) | `open fun setUserAgent(userAgent: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`TelemetryConfiguration`](./index.md)
Set the user agent used when communicating with the telemetry endpoint. | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/is-collection-enabled.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/is-collection-enabled.md new file mode 100644 index 00000000000..3503397e4d1 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/is-collection-enabled.md @@ -0,0 +1,12 @@ +--- +title: TelemetryConfiguration.isCollectionEnabled - +--- + +[org.mozilla.telemetry.config](../index.html) / [TelemetryConfiguration](index.html) / [isCollectionEnabled](./is-collection-enabled.html) + +# isCollectionEnabled + +`open fun isCollectionEnabled(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Is collecting telemetry data enabled? + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/is-upload-enabled.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/is-upload-enabled.md new file mode 100644 index 00000000000..c19a9b0aebc --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/is-upload-enabled.md @@ -0,0 +1,12 @@ +--- +title: TelemetryConfiguration.isUploadEnabled - +--- + +[org.mozilla.telemetry.config](../index.html) / [TelemetryConfiguration](index.html) / [isUploadEnabled](./is-upload-enabled.html) + +# isUploadEnabled + +`open fun isUploadEnabled(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Is uploading collected telemetry data enable? + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/set-app-name.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/set-app-name.md new file mode 100644 index 00000000000..f6f1cac11f7 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/set-app-name.md @@ -0,0 +1,12 @@ +--- +title: TelemetryConfiguration.setAppName - +--- + +[org.mozilla.telemetry.config](../index.html) / [TelemetryConfiguration](index.html) / [setAppName](./set-app-name.html) + +# setAppName + +`open fun setAppName(appName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`TelemetryConfiguration`](index.html) + +Set the name of the app. This value is used as one dimension when uploading telemetry to the HTTP Edge server. + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/set-app-version.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/set-app-version.md new file mode 100644 index 00000000000..20834bf196d --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/set-app-version.md @@ -0,0 +1,12 @@ +--- +title: TelemetryConfiguration.setAppVersion - +--- + +[org.mozilla.telemetry.config](../index.html) / [TelemetryConfiguration](index.html) / [setAppVersion](./set-app-version.html) + +# setAppVersion + +`open fun setAppVersion(appVersion: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`TelemetryConfiguration`](index.html) + +Set the version of the app (e.g. 45.0.1). This value is used as one dimension when uploading telemetry to the HTTP Edge server. + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/set-build-id.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/set-build-id.md new file mode 100644 index 00000000000..84b85554c7f --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/set-build-id.md @@ -0,0 +1,12 @@ +--- +title: TelemetryConfiguration.setBuildId - +--- + +[org.mozilla.telemetry.config](../index.html) / [TelemetryConfiguration](index.html) / [setBuildId](./set-build-id.html) + +# setBuildId + +`open fun setBuildId(buildId: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`TelemetryConfiguration`](index.html) + +Get the build id of the app (e.g. 20150125030202). This value is used as one dimension when uploading telemetry to the HTTP Edge server. + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/set-collection-enabled.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/set-collection-enabled.md new file mode 100644 index 00000000000..fc43642bd31 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/set-collection-enabled.md @@ -0,0 +1,12 @@ +--- +title: TelemetryConfiguration.setCollectionEnabled - +--- + +[org.mozilla.telemetry.config](../index.html) / [TelemetryConfiguration](index.html) / [setCollectionEnabled](./set-collection-enabled.html) + +# setCollectionEnabled + +`open fun setCollectionEnabled(collectionEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`TelemetryConfiguration`](index.html) + +Enable or disable collection of telemetry data. Local dev builds should disable this to avoid collecting and sending any data. + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/set-connect-timeout.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/set-connect-timeout.md new file mode 100644 index 00000000000..832b4867ac4 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/set-connect-timeout.md @@ -0,0 +1,12 @@ +--- +title: TelemetryConfiguration.setConnectTimeout - +--- + +[org.mozilla.telemetry.config](../index.html) / [TelemetryConfiguration](index.html) / [setConnectTimeout](./set-connect-timeout.html) + +# setConnectTimeout + +`open fun setConnectTimeout(connectTimeout: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`TelemetryConfiguration`](index.html) + +Sets a specified timeout value, in milliseconds, to be used when opening a communications link to the telemetry endpoint. If the timeout expires before the connection can be established, the ping upload will be retried at a later time. A timeout of zero is interpreted as an infinite timeout. + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/set-data-directory.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/set-data-directory.md new file mode 100644 index 00000000000..976b8287a5e --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/set-data-directory.md @@ -0,0 +1,12 @@ +--- +title: TelemetryConfiguration.setDataDirectory - +--- + +[org.mozilla.telemetry.config](../index.html) / [TelemetryConfiguration](index.html) / [setDataDirectory](./set-data-directory.html) + +# setDataDirectory + +`open fun setDataDirectory(dataDirectory: `[`File`](http://docs.oracle.com/javase/6/docs/api/java/io/File.html)`): `[`TelemetryConfiguration`](index.html) + +Set the root directory where telemetry components should store data. + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/set-initial-backoff-for-upload.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/set-initial-backoff-for-upload.md new file mode 100644 index 00000000000..2c5283a7c54 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/set-initial-backoff-for-upload.md @@ -0,0 +1,12 @@ +--- +title: TelemetryConfiguration.setInitialBackoffForUpload - +--- + +[org.mozilla.telemetry.config](../index.html) / [TelemetryConfiguration](index.html) / [setInitialBackoffForUpload](./set-initial-backoff-for-upload.html) + +# setInitialBackoffForUpload + +`open fun setInitialBackoffForUpload(initialBackoffForUpload: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`): `[`TelemetryConfiguration`](index.html) + +Set the interval (in milliseconds) to wait initially after a ping upload has failed. + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/set-maximum-number-of-events-per-ping.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/set-maximum-number-of-events-per-ping.md new file mode 100644 index 00000000000..4d45906f403 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/set-maximum-number-of-events-per-ping.md @@ -0,0 +1,12 @@ +--- +title: TelemetryConfiguration.setMaximumNumberOfEventsPerPing - +--- + +[org.mozilla.telemetry.config](../index.html) / [TelemetryConfiguration](index.html) / [setMaximumNumberOfEventsPerPing](./set-maximum-number-of-events-per-ping.html) + +# setMaximumNumberOfEventsPerPing + +`open fun setMaximumNumberOfEventsPerPing(maximumNumberOfEventsPerPing: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`TelemetryConfiguration`](index.html) + +Set the maximum number of events per ping. If this limit is reached a ping will built and stored automatically. The number of stored and uploaded pings might be limited too. + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/set-maximum-number-of-ping-uploads-per-day.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/set-maximum-number-of-ping-uploads-per-day.md new file mode 100644 index 00000000000..5b73210a547 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/set-maximum-number-of-ping-uploads-per-day.md @@ -0,0 +1,12 @@ +--- +title: TelemetryConfiguration.setMaximumNumberOfPingUploadsPerDay - +--- + +[org.mozilla.telemetry.config](../index.html) / [TelemetryConfiguration](index.html) / [setMaximumNumberOfPingUploadsPerDay](./set-maximum-number-of-ping-uploads-per-day.html) + +# setMaximumNumberOfPingUploadsPerDay + +`open fun setMaximumNumberOfPingUploadsPerDay(maximumNumberOfPingUploadsPerDay: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`TelemetryConfiguration`](index.html) + +Set the maximum number of pings uploaded per day. This limit is enforced for every type. If you have 2 ping types and set a limit of 100 pings per day then in total 200 pings per day could be uploaded. + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/set-maximum-number-of-pings-per-type.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/set-maximum-number-of-pings-per-type.md new file mode 100644 index 00000000000..500e2a6ee72 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/set-maximum-number-of-pings-per-type.md @@ -0,0 +1,12 @@ +--- +title: TelemetryConfiguration.setMaximumNumberOfPingsPerType - +--- + +[org.mozilla.telemetry.config](../index.html) / [TelemetryConfiguration](index.html) / [setMaximumNumberOfPingsPerType](./set-maximum-number-of-pings-per-type.html) + +# setMaximumNumberOfPingsPerType + +`open fun setMaximumNumberOfPingsPerType(maximumNumberOfPingsPerType: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`TelemetryConfiguration`](index.html) + +Set the maximum number of pings that will be stored for a given ping type. If more types are in the local store then pings will be removed (oldest first). For this to happen the maximum needs to be reached without any successful upload. + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/set-minimum-events-for-upload.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/set-minimum-events-for-upload.md new file mode 100644 index 00000000000..2c5f16416fb --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/set-minimum-events-for-upload.md @@ -0,0 +1,12 @@ +--- +title: TelemetryConfiguration.setMinimumEventsForUpload - +--- + +[org.mozilla.telemetry.config](../index.html) / [TelemetryConfiguration](index.html) / [setMinimumEventsForUpload](./set-minimum-events-for-upload.html) + +# setMinimumEventsForUpload + +`open fun setMinimumEventsForUpload(minimumEventsForUpload: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`TelemetryConfiguration`](index.html) + +Set the minimum number of telemetry events that need to be fired before even trying to upload an event ping. The default value is 3. The minimum needs to be >= 1. + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/set-preferences-important-for-telemetry.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/set-preferences-important-for-telemetry.md new file mode 100644 index 00000000000..556612e6518 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/set-preferences-important-for-telemetry.md @@ -0,0 +1,12 @@ +--- +title: TelemetryConfiguration.setPreferencesImportantForTelemetry - +--- + +[org.mozilla.telemetry.config](../index.html) / [TelemetryConfiguration](index.html) / [setPreferencesImportantForTelemetry](./set-preferences-important-for-telemetry.html) + +# setPreferencesImportantForTelemetry + +`open fun setPreferencesImportantForTelemetry(vararg preferences: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`TelemetryConfiguration`](index.html) + +Set a list of preference keys that are important for telemetry. Some measurements and pings might use this to determine what preferences should be reported. + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/set-read-timeout.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/set-read-timeout.md new file mode 100644 index 00000000000..4c158bac412 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/set-read-timeout.md @@ -0,0 +1,12 @@ +--- +title: TelemetryConfiguration.setReadTimeout - +--- + +[org.mozilla.telemetry.config](../index.html) / [TelemetryConfiguration](index.html) / [setReadTimeout](./set-read-timeout.html) + +# setReadTimeout + +`open fun setReadTimeout(readTimeout: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`TelemetryConfiguration`](index.html) + +Sets the read timeout to a specified timeout, in milliseconds. A non-zero value specifies the timeout when reading from the telemetry endpoint. If the timeout expires before there is data available for read, the ping upload will be retried later. A timeout of zero is interpreted as an infinite timeout. + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/set-server-endpoint.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/set-server-endpoint.md new file mode 100644 index 00000000000..2d878baaacb --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/set-server-endpoint.md @@ -0,0 +1,12 @@ +--- +title: TelemetryConfiguration.setServerEndpoint - +--- + +[org.mozilla.telemetry.config](../index.html) / [TelemetryConfiguration](index.html) / [setServerEndpoint](./set-server-endpoint.html) + +# setServerEndpoint + +`open fun setServerEndpoint(endpoint: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`TelemetryConfiguration`](index.html) + +Set the server endpoint to upload telemetry pings to. And endpoint value should include the schema and no trailing slash, e.g.: https://telemetry.example.org + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/set-settings-provider.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/set-settings-provider.md new file mode 100644 index 00000000000..32fa0062d8a --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/set-settings-provider.md @@ -0,0 +1,12 @@ +--- +title: TelemetryConfiguration.setSettingsProvider - +--- + +[org.mozilla.telemetry.config](../index.html) / [TelemetryConfiguration](index.html) / [setSettingsProvider](./set-settings-provider.html) + +# setSettingsProvider + +`open fun setSettingsProvider(settingsProvider: `[`SettingsProvider`](../../org.mozilla.telemetry.measurement/-settings-measurement/-settings-provider/index.html)`): `[`TelemetryConfiguration`](index.html) + +Set a provider for reading app settings. + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/set-update-channel.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/set-update-channel.md new file mode 100644 index 00000000000..0e3fd3e70c7 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/set-update-channel.md @@ -0,0 +1,12 @@ +--- +title: TelemetryConfiguration.setUpdateChannel - +--- + +[org.mozilla.telemetry.config](../index.html) / [TelemetryConfiguration](index.html) / [setUpdateChannel](./set-update-channel.html) + +# setUpdateChannel + +`open fun setUpdateChannel(updateChannel: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`TelemetryConfiguration`](index.html) + +Set the update channel of the app (e.g. beta, release). This value is used as one dimension when uploading telemetry to the HTTP Edge server. + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/set-upload-enabled.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/set-upload-enabled.md new file mode 100644 index 00000000000..4b7046f5b9f --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/set-upload-enabled.md @@ -0,0 +1,12 @@ +--- +title: TelemetryConfiguration.setUploadEnabled - +--- + +[org.mozilla.telemetry.config](../index.html) / [TelemetryConfiguration](index.html) / [setUploadEnabled](./set-upload-enabled.html) + +# setUploadEnabled + +`open fun setUploadEnabled(uploadEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`TelemetryConfiguration`](index.html) + +Enable or disable the upload of collected telemetry data. This is usually set based on a user visible preference. + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/set-user-agent.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/set-user-agent.md new file mode 100644 index 00000000000..e717b852b32 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/-telemetry-configuration/set-user-agent.md @@ -0,0 +1,12 @@ +--- +title: TelemetryConfiguration.setUserAgent - +--- + +[org.mozilla.telemetry.config](../index.html) / [TelemetryConfiguration](index.html) / [setUserAgent](./set-user-agent.html) + +# setUserAgent + +`open fun setUserAgent(userAgent: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`TelemetryConfiguration`](index.html) + +Set the user agent used when communicating with the telemetry endpoint. + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/index.md new file mode 100644 index 00000000000..67cd658b53f --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.config/index.md @@ -0,0 +1,12 @@ +--- +title: org.mozilla.telemetry.config - +--- + +[org.mozilla.telemetry.config](./index.html) + +## Package org.mozilla.telemetry.config + +### Types + +| [TelemetryConfiguration](-telemetry-configuration/index.html) | `open class TelemetryConfiguration`
The TelemetryConfiguration class collects the information describing the telemetry setup of an app. There are some parts that every app needs to configure: Where should measurements store data? What servers are we actually uploading pings to? This class should provide good defaults so that in the best case it is not needed to modify the configuration. | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.event/-telemetry-event/create.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.event/-telemetry-event/create.md new file mode 100644 index 00000000000..457a8a5896c --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.event/-telemetry-event/create.md @@ -0,0 +1,31 @@ +--- +title: TelemetryEvent.create - +--- + +[org.mozilla.telemetry.event](../index.html) / [TelemetryEvent](index.html) / [create](./create.html) + +# create + +`@CheckResult open static fun create(@NonNull category: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, @NonNull method: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, @Nullable object: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?): `[`TelemetryEvent`](index.html) + +Create a new event with mandatory category, method and object. + +### Parameters + +`category` - identifier. The category is a group name for events and helps to avoid name conflicts. + +`method` - identifier. This describes the type of event that occured, e.g. click, keydown or focus. + +`object` - identifier. This is the object the event occured on, e.g. reload_button or urlbar.`@CheckResult open static fun create(@NonNull category: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, @NonNull method: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, @Nullable object: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?, value: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`TelemetryEvent`](index.html) + +Create a new event with mandatory category, method, object and value. + +### Parameters + +`category` - identifier. The category is a group name for events and helps to avoid name conflicts. + +`method` - identifier. This describes the type of event that occured, e.g. click, keydown or focus. + +`object` - identifier. This is the object the event occured on, e.g. reload_button or urlbar. + +`value` - This is a user defined value, providing context for the event. \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.event/-telemetry-event/extra.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.event/-telemetry-event/extra.md new file mode 100644 index 00000000000..a35908f0abd --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.event/-telemetry-event/extra.md @@ -0,0 +1,9 @@ +--- +title: TelemetryEvent.extra - +--- + +[org.mozilla.telemetry.event](../index.html) / [TelemetryEvent](index.html) / [extra](./extra.html) + +# extra + +`open fun extra(key: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, value: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`TelemetryEvent`](index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.event/-telemetry-event/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.event/-telemetry-event/index.md new file mode 100644 index 00000000000..0f1cd1632d9 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.event/-telemetry-event/index.md @@ -0,0 +1,19 @@ +--- +title: TelemetryEvent - +--- + +[org.mozilla.telemetry.event](../index.html) / [TelemetryEvent](./index.html) + +# TelemetryEvent + +`open class TelemetryEvent` + +TelemetryEvent specifies a common events data format, which allows for broader, shared usage of data processing tools. + +### Functions + +| [create](create.html) | `open static fun create(category: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, method: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, object: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?): `[`TelemetryEvent`](./index.md)
Create a new event with mandatory category, method and object.`open static fun create(category: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, method: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, object: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?, value: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`TelemetryEvent`](./index.md)
Create a new event with mandatory category, method, object and value. | +| [extra](extra.html) | `open fun extra(key: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, value: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`TelemetryEvent`](./index.md) | +| [queue](queue.html) | `open fun queue(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Queue this event to be sent with the next event ping. | +| [toJSON](to-j-s-o-n.html) | `open fun toJSON(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Create a JSON representation of this event for storing and sending it. | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.event/-telemetry-event/queue.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.event/-telemetry-event/queue.md new file mode 100644 index 00000000000..25bbd076fcf --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.event/-telemetry-event/queue.md @@ -0,0 +1,12 @@ +--- +title: TelemetryEvent.queue - +--- + +[org.mozilla.telemetry.event](../index.html) / [TelemetryEvent](index.html) / [queue](./queue.html) + +# queue + +`open fun queue(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Queue this event to be sent with the next event ping. + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.event/-telemetry-event/to-j-s-o-n.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.event/-telemetry-event/to-j-s-o-n.md new file mode 100644 index 00000000000..4147440964d --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.event/-telemetry-event/to-j-s-o-n.md @@ -0,0 +1,12 @@ +--- +title: TelemetryEvent.toJSON - +--- + +[org.mozilla.telemetry.event](../index.html) / [TelemetryEvent](index.html) / [toJSON](./to-j-s-o-n.html) + +# toJSON + +`open fun toJSON(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) + +Create a JSON representation of this event for storing and sending it. + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.event/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.event/index.md new file mode 100644 index 00000000000..d07c4d5484b --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.event/index.md @@ -0,0 +1,12 @@ +--- +title: org.mozilla.telemetry.event - +--- + +[org.mozilla.telemetry.event](./index.html) + +## Package org.mozilla.telemetry.event + +### Types + +| [TelemetryEvent](-telemetry-event/index.html) | `open class TelemetryEvent`
TelemetryEvent specifies a common events data format, which allows for broader, shared usage of data processing tools. | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-arch-measurement/-init-.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-arch-measurement/-init-.md new file mode 100644 index 00000000000..8952f6041cd --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-arch-measurement/-init-.md @@ -0,0 +1,9 @@ +--- +title: ArchMeasurement. - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [ArchMeasurement](index.html) / [<init>](./-init-.html) + +# <init> + +`ArchMeasurement()` \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-arch-measurement/flush.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-arch-measurement/flush.md new file mode 100644 index 00000000000..9f7a3b937ba --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-arch-measurement/flush.md @@ -0,0 +1,12 @@ +--- +title: ArchMeasurement.flush - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [ArchMeasurement](index.html) / [flush](./flush.html) + +# flush + +`open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) + +Overrides [TelemetryMeasurement.flush](../-telemetry-measurement/flush.html) + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-arch-measurement/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-arch-measurement/index.md new file mode 100644 index 00000000000..d3ea454c565 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-arch-measurement/index.md @@ -0,0 +1,22 @@ +--- +title: ArchMeasurement - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [ArchMeasurement](./index.html) + +# ArchMeasurement + +`open class ArchMeasurement : `[`TelemetryMeasurement`](../-telemetry-measurement/index.html) + +### Constructors + +| [<init>](-init-.html) | `ArchMeasurement()` | + +### Functions + +| [flush](flush.html) | `open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) | + +### Inherited Functions + +| [getFieldName](../-telemetry-measurement/get-field-name.html) | `open fun getFieldName(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-client-id-measurement/-init-.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-client-id-measurement/-init-.md new file mode 100644 index 00000000000..a97aaf52ee1 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-client-id-measurement/-init-.md @@ -0,0 +1,9 @@ +--- +title: ClientIdMeasurement. - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [ClientIdMeasurement](index.html) / [<init>](./-init-.html) + +# <init> + +`ClientIdMeasurement(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.html)`)` \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-client-id-measurement/flush.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-client-id-measurement/flush.md new file mode 100644 index 00000000000..70d24656bc2 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-client-id-measurement/flush.md @@ -0,0 +1,12 @@ +--- +title: ClientIdMeasurement.flush - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [ClientIdMeasurement](index.html) / [flush](./flush.html) + +# flush + +`open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) + +Overrides [TelemetryMeasurement.flush](../-telemetry-measurement/flush.html) + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-client-id-measurement/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-client-id-measurement/index.md new file mode 100644 index 00000000000..b2a22d36d6d --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-client-id-measurement/index.md @@ -0,0 +1,24 @@ +--- +title: ClientIdMeasurement - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [ClientIdMeasurement](./index.html) + +# ClientIdMeasurement + +`open class ClientIdMeasurement : `[`TelemetryMeasurement`](../-telemetry-measurement/index.html) + +A unique, randomly generated UUID for this client. + +### Constructors + +| [<init>](-init-.html) | `ClientIdMeasurement(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.html)`)` | + +### Functions + +| [flush](flush.html) | `open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) | + +### Inherited Functions + +| [getFieldName](../-telemetry-measurement/get-field-name.html) | `open fun getFieldName(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-created-date-measurement-new/-init-.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-created-date-measurement-new/-init-.md new file mode 100644 index 00000000000..2429b6494c2 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-created-date-measurement-new/-init-.md @@ -0,0 +1,9 @@ +--- +title: CreatedDateMeasurementNew. - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [CreatedDateMeasurementNew](index.html) / [<init>](./-init-.html) + +# <init> + +`CreatedDateMeasurementNew()` \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-created-date-measurement-new/flush.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-created-date-measurement-new/flush.md new file mode 100644 index 00000000000..f3df5cac5e3 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-created-date-measurement-new/flush.md @@ -0,0 +1,12 @@ +--- +title: CreatedDateMeasurementNew.flush - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [CreatedDateMeasurementNew](index.html) / [flush](./flush.html) + +# flush + +`open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) + +Overrides [TelemetryMeasurement.flush](../-telemetry-measurement/flush.html) + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-created-date-measurement-new/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-created-date-measurement-new/index.md new file mode 100644 index 00000000000..3772708a644 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-created-date-measurement-new/index.md @@ -0,0 +1,24 @@ +--- +title: CreatedDateMeasurementNew - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [CreatedDateMeasurementNew](./index.html) + +# CreatedDateMeasurementNew + +`open class CreatedDateMeasurementNew : `[`TelemetryMeasurement`](../-telemetry-measurement/index.html) + +The field 'created' from CreatedDateMeasurement will be deprecated for the `createdDate` field + +### Constructors + +| [<init>](-init-.html) | `CreatedDateMeasurementNew()` | + +### Functions + +| [flush](flush.html) | `open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) | + +### Inherited Functions + +| [getFieldName](../-telemetry-measurement/get-field-name.html) | `open fun getFieldName(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-created-date-measurement/-init-.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-created-date-measurement/-init-.md new file mode 100644 index 00000000000..c0b593a90bb --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-created-date-measurement/-init-.md @@ -0,0 +1,9 @@ +--- +title: CreatedDateMeasurement. - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [CreatedDateMeasurement](index.html) / [<init>](./-init-.html) + +# <init> + +`CreatedDateMeasurement()` \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-created-date-measurement/flush.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-created-date-measurement/flush.md new file mode 100644 index 00000000000..a009956db56 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-created-date-measurement/flush.md @@ -0,0 +1,12 @@ +--- +title: CreatedDateMeasurement.flush - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [CreatedDateMeasurement](index.html) / [flush](./flush.html) + +# flush + +`open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) + +Overrides [TelemetryMeasurement.flush](../-telemetry-measurement/flush.html) + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-created-date-measurement/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-created-date-measurement/index.md new file mode 100644 index 00000000000..8ef1123bff6 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-created-date-measurement/index.md @@ -0,0 +1,22 @@ +--- +title: CreatedDateMeasurement - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [CreatedDateMeasurement](./index.html) + +# CreatedDateMeasurement + +`open class CreatedDateMeasurement : `[`TelemetryMeasurement`](../-telemetry-measurement/index.html) + +### Constructors + +| [<init>](-init-.html) | `CreatedDateMeasurement()` | + +### Functions + +| [flush](flush.html) | `open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) | + +### Inherited Functions + +| [getFieldName](../-telemetry-measurement/get-field-name.html) | `open fun getFieldName(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-created-timestamp-measurement-new/-init-.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-created-timestamp-measurement-new/-init-.md new file mode 100644 index 00000000000..9986e4fd5b3 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-created-timestamp-measurement-new/-init-.md @@ -0,0 +1,9 @@ +--- +title: CreatedTimestampMeasurementNew. - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [CreatedTimestampMeasurementNew](index.html) / [<init>](./-init-.html) + +# <init> + +`CreatedTimestampMeasurementNew()` \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-created-timestamp-measurement-new/flush.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-created-timestamp-measurement-new/flush.md new file mode 100644 index 00000000000..92405b99d33 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-created-timestamp-measurement-new/flush.md @@ -0,0 +1,12 @@ +--- +title: CreatedTimestampMeasurementNew.flush - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [CreatedTimestampMeasurementNew](index.html) / [flush](./flush.html) + +# flush + +`open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) + +Overrides [TelemetryMeasurement.flush](../-telemetry-measurement/flush.html) + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-created-timestamp-measurement-new/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-created-timestamp-measurement-new/index.md new file mode 100644 index 00000000000..731e5b86243 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-created-timestamp-measurement-new/index.md @@ -0,0 +1,24 @@ +--- +title: CreatedTimestampMeasurementNew - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [CreatedTimestampMeasurementNew](./index.html) + +# CreatedTimestampMeasurementNew + +`open class CreatedTimestampMeasurementNew : `[`TelemetryMeasurement`](../-telemetry-measurement/index.html) + +The field 'created' from CreatedTimestampMeasurement will be deprecated for the `createdTimestamp` field + +### Constructors + +| [<init>](-init-.html) | `CreatedTimestampMeasurementNew()` | + +### Functions + +| [flush](flush.html) | `open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) | + +### Inherited Functions + +| [getFieldName](../-telemetry-measurement/get-field-name.html) | `open fun getFieldName(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-created-timestamp-measurement/-init-.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-created-timestamp-measurement/-init-.md new file mode 100644 index 00000000000..2f9c26bf1d0 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-created-timestamp-measurement/-init-.md @@ -0,0 +1,9 @@ +--- +title: CreatedTimestampMeasurement. - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [CreatedTimestampMeasurement](index.html) / [<init>](./-init-.html) + +# <init> + +`CreatedTimestampMeasurement()` \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-created-timestamp-measurement/flush.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-created-timestamp-measurement/flush.md new file mode 100644 index 00000000000..49e59c4d276 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-created-timestamp-measurement/flush.md @@ -0,0 +1,12 @@ +--- +title: CreatedTimestampMeasurement.flush - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [CreatedTimestampMeasurement](index.html) / [flush](./flush.html) + +# flush + +`open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) + +Overrides [TelemetryMeasurement.flush](../-telemetry-measurement/flush.html) + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-created-timestamp-measurement/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-created-timestamp-measurement/index.md new file mode 100644 index 00000000000..012aaa376b7 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-created-timestamp-measurement/index.md @@ -0,0 +1,22 @@ +--- +title: CreatedTimestampMeasurement - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [CreatedTimestampMeasurement](./index.html) + +# CreatedTimestampMeasurement + +`open class CreatedTimestampMeasurement : `[`TelemetryMeasurement`](../-telemetry-measurement/index.html) + +### Constructors + +| [<init>](-init-.html) | `CreatedTimestampMeasurement()` | + +### Functions + +| [flush](flush.html) | `open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) | + +### Inherited Functions + +| [getFieldName](../-telemetry-measurement/get-field-name.html) | `open fun getFieldName(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-default-search-measurement/-default-search-engine-provider/get-default-search-engine-identifier.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-default-search-measurement/-default-search-engine-provider/get-default-search-engine-identifier.md new file mode 100644 index 00000000000..508713366fe --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-default-search-measurement/-default-search-engine-provider/get-default-search-engine-identifier.md @@ -0,0 +1,9 @@ +--- +title: DefaultSearchMeasurement.DefaultSearchEngineProvider.getDefaultSearchEngineIdentifier - +--- + +[org.mozilla.telemetry.measurement](../../index.html) / [DefaultSearchMeasurement](../index.html) / [DefaultSearchEngineProvider](index.html) / [getDefaultSearchEngineIdentifier](./get-default-search-engine-identifier.html) + +# getDefaultSearchEngineIdentifier + +`abstract fun getDefaultSearchEngineIdentifier(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-default-search-measurement/-default-search-engine-provider/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-default-search-measurement/-default-search-engine-provider/index.md new file mode 100644 index 00000000000..07342e48e55 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-default-search-measurement/-default-search-engine-provider/index.md @@ -0,0 +1,14 @@ +--- +title: DefaultSearchMeasurement.DefaultSearchEngineProvider - +--- + +[org.mozilla.telemetry.measurement](../../index.html) / [DefaultSearchMeasurement](../index.html) / [DefaultSearchEngineProvider](./index.html) + +# DefaultSearchEngineProvider + +`interface DefaultSearchEngineProvider` + +### Functions + +| [getDefaultSearchEngineIdentifier](get-default-search-engine-identifier.html) | `abstract fun getDefaultSearchEngineIdentifier(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-default-search-measurement/-init-.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-default-search-measurement/-init-.md new file mode 100644 index 00000000000..bbfd7e0c64c --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-default-search-measurement/-init-.md @@ -0,0 +1,9 @@ +--- +title: DefaultSearchMeasurement. - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [DefaultSearchMeasurement](index.html) / [<init>](./-init-.html) + +# <init> + +`DefaultSearchMeasurement()` \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-default-search-measurement/flush.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-default-search-measurement/flush.md new file mode 100644 index 00000000000..4efdf474cfe --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-default-search-measurement/flush.md @@ -0,0 +1,12 @@ +--- +title: DefaultSearchMeasurement.flush - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [DefaultSearchMeasurement](index.html) / [flush](./flush.html) + +# flush + +`open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) + +Overrides [TelemetryMeasurement.flush](../-telemetry-measurement/flush.html) + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-default-search-measurement/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-default-search-measurement/index.md new file mode 100644 index 00000000000..5c9ceb47d2c --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-default-search-measurement/index.md @@ -0,0 +1,27 @@ +--- +title: DefaultSearchMeasurement - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [DefaultSearchMeasurement](./index.html) + +# DefaultSearchMeasurement + +`open class DefaultSearchMeasurement : `[`TelemetryMeasurement`](../-telemetry-measurement/index.html) + +### Types + +| [DefaultSearchEngineProvider](-default-search-engine-provider/index.html) | `interface DefaultSearchEngineProvider` | + +### Constructors + +| [<init>](-init-.html) | `DefaultSearchMeasurement()` | + +### Functions + +| [flush](flush.html) | `open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) | +| [setDefaultSearchEngineProvider](set-default-search-engine-provider.html) | `open fun setDefaultSearchEngineProvider(provider: `[`DefaultSearchEngineProvider`](-default-search-engine-provider/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | + +### Inherited Functions + +| [getFieldName](../-telemetry-measurement/get-field-name.html) | `open fun getFieldName(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-default-search-measurement/set-default-search-engine-provider.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-default-search-measurement/set-default-search-engine-provider.md new file mode 100644 index 00000000000..eef0ac65003 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-default-search-measurement/set-default-search-engine-provider.md @@ -0,0 +1,9 @@ +--- +title: DefaultSearchMeasurement.setDefaultSearchEngineProvider - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [DefaultSearchMeasurement](index.html) / [setDefaultSearchEngineProvider](./set-default-search-engine-provider.html) + +# setDefaultSearchEngineProvider + +`open fun setDefaultSearchEngineProvider(provider: `[`DefaultSearchEngineProvider`](-default-search-engine-provider/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-device-measurement/-init-.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-device-measurement/-init-.md new file mode 100644 index 00000000000..5eb33867ac6 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-device-measurement/-init-.md @@ -0,0 +1,9 @@ +--- +title: DeviceMeasurement. - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [DeviceMeasurement](index.html) / [<init>](./-init-.html) + +# <init> + +`DeviceMeasurement()` \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-device-measurement/flush.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-device-measurement/flush.md new file mode 100644 index 00000000000..a1d3492e151 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-device-measurement/flush.md @@ -0,0 +1,12 @@ +--- +title: DeviceMeasurement.flush - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [DeviceMeasurement](index.html) / [flush](./flush.html) + +# flush + +`open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) + +Overrides [TelemetryMeasurement.flush](../-telemetry-measurement/flush.html) + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-device-measurement/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-device-measurement/index.md new file mode 100644 index 00000000000..863291a41b2 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-device-measurement/index.md @@ -0,0 +1,22 @@ +--- +title: DeviceMeasurement - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [DeviceMeasurement](./index.html) + +# DeviceMeasurement + +`open class DeviceMeasurement : `[`TelemetryMeasurement`](../-telemetry-measurement/index.html) + +### Constructors + +| [<init>](-init-.html) | `DeviceMeasurement()` | + +### Functions + +| [flush](flush.html) | `open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) | + +### Inherited Functions + +| [getFieldName](../-telemetry-measurement/get-field-name.html) | `open fun getFieldName(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-events-measurement/-init-.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-events-measurement/-init-.md new file mode 100644 index 00000000000..2cfd3fc303c --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-events-measurement/-init-.md @@ -0,0 +1,9 @@ +--- +title: EventsMeasurement. - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [EventsMeasurement](index.html) / [<init>](./-init-.html) + +# <init> + +`EventsMeasurement(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.html)`)` \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-events-measurement/add.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-events-measurement/add.md new file mode 100644 index 00000000000..794794bc301 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-events-measurement/add.md @@ -0,0 +1,9 @@ +--- +title: EventsMeasurement.add - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [EventsMeasurement](index.html) / [add](./add.html) + +# add + +`open fun add(event: `[`TelemetryEvent`](../../org.mozilla.telemetry.event/-telemetry-event/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-events-measurement/flush.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-events-measurement/flush.md new file mode 100644 index 00000000000..00a109e8f5a --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-events-measurement/flush.md @@ -0,0 +1,12 @@ +--- +title: EventsMeasurement.flush - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [EventsMeasurement](index.html) / [flush](./flush.html) + +# flush + +`open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) + +Overrides [TelemetryMeasurement.flush](../-telemetry-measurement/flush.html) + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-events-measurement/get-event-count.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-events-measurement/get-event-count.md new file mode 100644 index 00000000000..8378c4ed246 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-events-measurement/get-event-count.md @@ -0,0 +1,9 @@ +--- +title: EventsMeasurement.getEventCount - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [EventsMeasurement](index.html) / [getEventCount](./get-event-count.html) + +# getEventCount + +`open fun getEventCount(): `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-events-measurement/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-events-measurement/index.md new file mode 100644 index 00000000000..979ebe7b0ff --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-events-measurement/index.md @@ -0,0 +1,24 @@ +--- +title: EventsMeasurement - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [EventsMeasurement](./index.html) + +# EventsMeasurement + +`open class EventsMeasurement : `[`TelemetryMeasurement`](../-telemetry-measurement/index.html) + +### Constructors + +| [<init>](-init-.html) | `EventsMeasurement(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.html)`)` | + +### Functions + +| [add](add.html) | `open fun add(event: `[`TelemetryEvent`](../../org.mozilla.telemetry.event/-telemetry-event/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [flush](flush.html) | `open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) | +| [getEventCount](get-event-count.html) | `open fun getEventCount(): `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) | + +### Inherited Functions + +| [getFieldName](../-telemetry-measurement/get-field-name.html) | `open fun getFieldName(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-experiments-measurement/-init-.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-experiments-measurement/-init-.md new file mode 100644 index 00000000000..1891660e106 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-experiments-measurement/-init-.md @@ -0,0 +1,9 @@ +--- +title: ExperimentsMeasurement. - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [ExperimentsMeasurement](index.html) / [<init>](./-init-.html) + +# <init> + +`ExperimentsMeasurement()` \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-experiments-measurement/flush.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-experiments-measurement/flush.md new file mode 100644 index 00000000000..17117e97bad --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-experiments-measurement/flush.md @@ -0,0 +1,12 @@ +--- +title: ExperimentsMeasurement.flush - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [ExperimentsMeasurement](index.html) / [flush](./flush.html) + +# flush + +`open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) + +Overrides [TelemetryMeasurement.flush](../-telemetry-measurement/flush.html) + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-experiments-measurement/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-experiments-measurement/index.md new file mode 100644 index 00000000000..99da5c166f4 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-experiments-measurement/index.md @@ -0,0 +1,23 @@ +--- +title: ExperimentsMeasurement - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [ExperimentsMeasurement](./index.html) + +# ExperimentsMeasurement + +`open class ExperimentsMeasurement : `[`TelemetryMeasurement`](../-telemetry-measurement/index.html) + +### Constructors + +| [<init>](-init-.html) | `ExperimentsMeasurement()` | + +### Functions + +| [flush](flush.html) | `open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) | +| [setActiveExperiments](set-active-experiments.html) | `open fun setActiveExperiments(activeExperimentsIds: `[`MutableList`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-list/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | + +### Inherited Functions + +| [getFieldName](../-telemetry-measurement/get-field-name.html) | `open fun getFieldName(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-experiments-measurement/set-active-experiments.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-experiments-measurement/set-active-experiments.md new file mode 100644 index 00000000000..a613a97f59f --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-experiments-measurement/set-active-experiments.md @@ -0,0 +1,9 @@ +--- +title: ExperimentsMeasurement.setActiveExperiments - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [ExperimentsMeasurement](index.html) / [setActiveExperiments](./set-active-experiments.html) + +# setActiveExperiments + +`open fun setActiveExperiments(activeExperimentsIds: `[`MutableList`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-list/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-first-run-profile-date-measurement/-init-.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-first-run-profile-date-measurement/-init-.md new file mode 100644 index 00000000000..b618c8242fe --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-first-run-profile-date-measurement/-init-.md @@ -0,0 +1,9 @@ +--- +title: FirstRunProfileDateMeasurement. - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [FirstRunProfileDateMeasurement](index.html) / [<init>](./-init-.html) + +# <init> + +`FirstRunProfileDateMeasurement(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.html)`)` \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-first-run-profile-date-measurement/flush.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-first-run-profile-date-measurement/flush.md new file mode 100644 index 00000000000..08455b14b59 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-first-run-profile-date-measurement/flush.md @@ -0,0 +1,12 @@ +--- +title: FirstRunProfileDateMeasurement.flush - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [FirstRunProfileDateMeasurement](index.html) / [flush](./flush.html) + +# flush + +`open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) + +Overrides [TelemetryMeasurement.flush](../-telemetry-measurement/flush.html) + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-first-run-profile-date-measurement/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-first-run-profile-date-measurement/index.md new file mode 100644 index 00000000000..1d4a9085acc --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-first-run-profile-date-measurement/index.md @@ -0,0 +1,24 @@ +--- +title: FirstRunProfileDateMeasurement - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [FirstRunProfileDateMeasurement](./index.html) + +# FirstRunProfileDateMeasurement + +`open class FirstRunProfileDateMeasurement : `[`TelemetryMeasurement`](../-telemetry-measurement/index.html) + +This measurement will save the timestamp of the first time it was instantiated and report this as profile creation date. + +### Constructors + +| [<init>](-init-.html) | `FirstRunProfileDateMeasurement(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.html)`)` | + +### Functions + +| [flush](flush.html) | `open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) | + +### Inherited Functions + +| [getFieldName](../-telemetry-measurement/get-field-name.html) | `open fun getFieldName(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-locale-measurement/-init-.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-locale-measurement/-init-.md new file mode 100644 index 00000000000..f624177ecb9 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-locale-measurement/-init-.md @@ -0,0 +1,9 @@ +--- +title: LocaleMeasurement. - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [LocaleMeasurement](index.html) / [<init>](./-init-.html) + +# <init> + +`LocaleMeasurement()` \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-locale-measurement/flush.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-locale-measurement/flush.md new file mode 100644 index 00000000000..206e1a7c0e3 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-locale-measurement/flush.md @@ -0,0 +1,12 @@ +--- +title: LocaleMeasurement.flush - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [LocaleMeasurement](index.html) / [flush](./flush.html) + +# flush + +`open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) + +Overrides [TelemetryMeasurement.flush](../-telemetry-measurement/flush.html) + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-locale-measurement/get-language-tag.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-locale-measurement/get-language-tag.md new file mode 100644 index 00000000000..cd11e30f3ad --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-locale-measurement/get-language-tag.md @@ -0,0 +1,15 @@ +--- +title: LocaleMeasurement.getLanguageTag - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [LocaleMeasurement](index.html) / [getLanguageTag](./get-language-tag.html) + +# getLanguageTag + +`open fun getLanguageTag(locale: `[`Locale`](http://docs.oracle.com/javase/6/docs/api/java/util/Locale.html)`): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) + +Gecko uses locale codes like "es-ES", whereas a Java Locale stringifies as "es_ES". This method approximates the Java 7 method `Locale#toLanguageTag()`. + +**Return** +a locale string suitable for passing to Gecko. + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-locale-measurement/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-locale-measurement/index.md new file mode 100644 index 00000000000..d313d0075ab --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-locale-measurement/index.md @@ -0,0 +1,23 @@ +--- +title: LocaleMeasurement - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [LocaleMeasurement](./index.html) + +# LocaleMeasurement + +`open class LocaleMeasurement : `[`TelemetryMeasurement`](../-telemetry-measurement/index.html) + +### Constructors + +| [<init>](-init-.html) | `LocaleMeasurement()` | + +### Functions + +| [flush](flush.html) | `open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) | +| [getLanguageTag](get-language-tag.html) | `open fun getLanguageTag(locale: `[`Locale`](http://docs.oracle.com/javase/6/docs/api/java/util/Locale.html)`): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Gecko uses locale codes like "es-ES", whereas a Java Locale stringifies as "es_ES". This method approximates the Java 7 method `Locale#toLanguageTag()`. | + +### Inherited Functions + +| [getFieldName](../-telemetry-measurement/get-field-name.html) | `open fun getFieldName(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-metrics-measurement/-init-.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-metrics-measurement/-init-.md new file mode 100644 index 00000000000..1f7829cea98 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-metrics-measurement/-init-.md @@ -0,0 +1,9 @@ +--- +title: MetricsMeasurement. - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [MetricsMeasurement](index.html) / [<init>](./-init-.html) + +# <init> + +`MetricsMeasurement(snapshot: JSONObject)` \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-metrics-measurement/flush.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-metrics-measurement/flush.md new file mode 100644 index 00000000000..7265c57bf2a --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-metrics-measurement/flush.md @@ -0,0 +1,12 @@ +--- +title: MetricsMeasurement.flush - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [MetricsMeasurement](index.html) / [flush](./flush.html) + +# flush + +`open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) + +Overrides [TelemetryMeasurement.flush](../-telemetry-measurement/flush.html) + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-metrics-measurement/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-metrics-measurement/index.md new file mode 100644 index 00000000000..b0fa5f04cdc --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-metrics-measurement/index.md @@ -0,0 +1,22 @@ +--- +title: MetricsMeasurement - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [MetricsMeasurement](./index.html) + +# MetricsMeasurement + +`open class MetricsMeasurement : `[`TelemetryMeasurement`](../-telemetry-measurement/index.html) + +### Constructors + +| [<init>](-init-.html) | `MetricsMeasurement(snapshot: JSONObject)` | + +### Functions + +| [flush](flush.html) | `open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) | + +### Inherited Functions + +| [getFieldName](../-telemetry-measurement/get-field-name.html) | `open fun getFieldName(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-operating-system-measurement/-init-.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-operating-system-measurement/-init-.md new file mode 100644 index 00000000000..ff7aa9b78d7 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-operating-system-measurement/-init-.md @@ -0,0 +1,9 @@ +--- +title: OperatingSystemMeasurement. - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [OperatingSystemMeasurement](index.html) / [<init>](./-init-.html) + +# <init> + +`OperatingSystemMeasurement()` \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-operating-system-measurement/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-operating-system-measurement/index.md new file mode 100644 index 00000000000..9487d5472af --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-operating-system-measurement/index.md @@ -0,0 +1,18 @@ +--- +title: OperatingSystemMeasurement - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [OperatingSystemMeasurement](./index.html) + +# OperatingSystemMeasurement + +`open class OperatingSystemMeasurement : `[`StaticMeasurement`](../-static-measurement/index.html) + +### Constructors + +| [<init>](-init-.html) | `OperatingSystemMeasurement()` | + +### Inherited Functions + +| [flush](../-static-measurement/flush.html) | `open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-operating-system-version-measurement/-init-.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-operating-system-version-measurement/-init-.md new file mode 100644 index 00000000000..58d04773185 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-operating-system-version-measurement/-init-.md @@ -0,0 +1,9 @@ +--- +title: OperatingSystemVersionMeasurement. - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [OperatingSystemVersionMeasurement](index.html) / [<init>](./-init-.html) + +# <init> + +`OperatingSystemVersionMeasurement()` \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-operating-system-version-measurement/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-operating-system-version-measurement/index.md new file mode 100644 index 00000000000..561ef22e9e0 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-operating-system-version-measurement/index.md @@ -0,0 +1,18 @@ +--- +title: OperatingSystemVersionMeasurement - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [OperatingSystemVersionMeasurement](./index.html) + +# OperatingSystemVersionMeasurement + +`open class OperatingSystemVersionMeasurement : `[`StaticMeasurement`](../-static-measurement/index.html) + +### Constructors + +| [<init>](-init-.html) | `OperatingSystemVersionMeasurement()` | + +### Inherited Functions + +| [flush](../-static-measurement/flush.html) | `open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-process-start-timestamp-measurement/-init-.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-process-start-timestamp-measurement/-init-.md new file mode 100644 index 00000000000..bc18f95a639 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-process-start-timestamp-measurement/-init-.md @@ -0,0 +1,9 @@ +--- +title: ProcessStartTimestampMeasurement. - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [ProcessStartTimestampMeasurement](index.html) / [<init>](./-init-.html) + +# <init> + +`ProcessStartTimestampMeasurement(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.html)`)` \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-process-start-timestamp-measurement/flush.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-process-start-timestamp-measurement/flush.md new file mode 100644 index 00000000000..d79f31ac765 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-process-start-timestamp-measurement/flush.md @@ -0,0 +1,12 @@ +--- +title: ProcessStartTimestampMeasurement.flush - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [ProcessStartTimestampMeasurement](index.html) / [flush](./flush.html) + +# flush + +`open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) + +Overrides [TelemetryMeasurement.flush](../-telemetry-measurement/flush.html) + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-process-start-timestamp-measurement/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-process-start-timestamp-measurement/index.md new file mode 100644 index 00000000000..d3db16fee1b --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-process-start-timestamp-measurement/index.md @@ -0,0 +1,22 @@ +--- +title: ProcessStartTimestampMeasurement - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [ProcessStartTimestampMeasurement](./index.html) + +# ProcessStartTimestampMeasurement + +`open class ProcessStartTimestampMeasurement : `[`TelemetryMeasurement`](../-telemetry-measurement/index.html) + +### Constructors + +| [<init>](-init-.html) | `ProcessStartTimestampMeasurement(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.html)`)` | + +### Functions + +| [flush](flush.html) | `open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) | + +### Inherited Functions + +| [getFieldName](../-telemetry-measurement/get-field-name.html) | `open fun getFieldName(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-searches-measurement/-init-.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-searches-measurement/-init-.md new file mode 100644 index 00000000000..0615950a2ca --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-searches-measurement/-init-.md @@ -0,0 +1,9 @@ +--- +title: SearchesMeasurement. - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [SearchesMeasurement](index.html) / [<init>](./-init-.html) + +# <init> + +`SearchesMeasurement(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.html)`)` \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-searches-measurement/-l-o-c-a-t-i-o-n_-a-c-t-i-o-n-b-a-r.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-searches-measurement/-l-o-c-a-t-i-o-n_-a-c-t-i-o-n-b-a-r.md new file mode 100644 index 00000000000..8e34b3af3f4 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-searches-measurement/-l-o-c-a-t-i-o-n_-a-c-t-i-o-n-b-a-r.md @@ -0,0 +1,9 @@ +--- +title: SearchesMeasurement.LOCATION_ACTIONBAR - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [SearchesMeasurement](index.html) / [LOCATION_ACTIONBAR](./-l-o-c-a-t-i-o-n_-a-c-t-i-o-n-b-a-r.html) + +# LOCATION_ACTIONBAR + +`static val LOCATION_ACTIONBAR: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-searches-measurement/-l-o-c-a-t-i-o-n_-l-i-s-t-i-t-e-m.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-searches-measurement/-l-o-c-a-t-i-o-n_-l-i-s-t-i-t-e-m.md new file mode 100644 index 00000000000..49c0b32efcf --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-searches-measurement/-l-o-c-a-t-i-o-n_-l-i-s-t-i-t-e-m.md @@ -0,0 +1,9 @@ +--- +title: SearchesMeasurement.LOCATION_LISTITEM - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [SearchesMeasurement](index.html) / [LOCATION_LISTITEM](./-l-o-c-a-t-i-o-n_-l-i-s-t-i-t-e-m.html) + +# LOCATION_LISTITEM + +`static val LOCATION_LISTITEM: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-searches-measurement/-l-o-c-a-t-i-o-n_-s-u-g-g-e-s-t-i-o-n.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-searches-measurement/-l-o-c-a-t-i-o-n_-s-u-g-g-e-s-t-i-o-n.md new file mode 100644 index 00000000000..ed79259e5b4 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-searches-measurement/-l-o-c-a-t-i-o-n_-s-u-g-g-e-s-t-i-o-n.md @@ -0,0 +1,9 @@ +--- +title: SearchesMeasurement.LOCATION_SUGGESTION - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [SearchesMeasurement](index.html) / [LOCATION_SUGGESTION](./-l-o-c-a-t-i-o-n_-s-u-g-g-e-s-t-i-o-n.html) + +# LOCATION_SUGGESTION + +`static val LOCATION_SUGGESTION: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-searches-measurement/flush.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-searches-measurement/flush.md new file mode 100644 index 00000000000..9916f7b0a42 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-searches-measurement/flush.md @@ -0,0 +1,12 @@ +--- +title: SearchesMeasurement.flush - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [SearchesMeasurement](index.html) / [flush](./flush.html) + +# flush + +`open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) + +Overrides [TelemetryMeasurement.flush](../-telemetry-measurement/flush.html) + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-searches-measurement/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-searches-measurement/index.md new file mode 100644 index 00000000000..a1181155559 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-searches-measurement/index.md @@ -0,0 +1,31 @@ +--- +title: SearchesMeasurement - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [SearchesMeasurement](./index.html) + +# SearchesMeasurement + +`open class SearchesMeasurement : `[`TelemetryMeasurement`](../-telemetry-measurement/index.html) + +A TelemetryMeasurement implementation to count the number of times a user has searched with a specific engine from a specific location. + +### Constructors + +| [<init>](-init-.html) | `SearchesMeasurement(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.html)`)` | + +### Properties + +| [LOCATION_ACTIONBAR](-l-o-c-a-t-i-o-n_-a-c-t-i-o-n-b-a-r.html) | `static val LOCATION_ACTIONBAR: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [LOCATION_LISTITEM](-l-o-c-a-t-i-o-n_-l-i-s-t-i-t-e-m.html) | `static val LOCATION_LISTITEM: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [LOCATION_SUGGESTION](-l-o-c-a-t-i-o-n_-s-u-g-g-e-s-t-i-o-n.html) | `static val LOCATION_SUGGESTION: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + +### Functions + +| [flush](flush.html) | `open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) | +| [recordSearch](record-search.html) | `open fun recordSearch(location: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, identifier: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Record a search for the given location and search engine identifier. | + +### Inherited Functions + +| [getFieldName](../-telemetry-measurement/get-field-name.html) | `open fun getFieldName(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-searches-measurement/record-search.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-searches-measurement/record-search.md new file mode 100644 index 00000000000..ff20ddb91a9 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-searches-measurement/record-search.md @@ -0,0 +1,17 @@ +--- +title: SearchesMeasurement.recordSearch - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [SearchesMeasurement](index.html) / [recordSearch](./record-search.html) + +# recordSearch + +`open fun recordSearch(@NonNull location: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, @NonNull identifier: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Record a search for the given location and search engine identifier. + +### Parameters + +`location` - where search was started. + +`identifier` - of the used search engine. \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-sequence-measurement/-init-.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-sequence-measurement/-init-.md new file mode 100644 index 00000000000..19ba51fadef --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-sequence-measurement/-init-.md @@ -0,0 +1,9 @@ +--- +title: SequenceMeasurement. - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [SequenceMeasurement](index.html) / [<init>](./-init-.html) + +# <init> + +`SequenceMeasurement(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.html)`, ping: `[`TelemetryPingBuilder`](../../org.mozilla.telemetry.ping/-telemetry-ping-builder/index.html)`)` \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-sequence-measurement/flush.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-sequence-measurement/flush.md new file mode 100644 index 00000000000..d2f22919f44 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-sequence-measurement/flush.md @@ -0,0 +1,12 @@ +--- +title: SequenceMeasurement.flush - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [SequenceMeasurement](index.html) / [flush](./flush.html) + +# flush + +`open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) + +Overrides [TelemetryMeasurement.flush](../-telemetry-measurement/flush.html) + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-sequence-measurement/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-sequence-measurement/index.md new file mode 100644 index 00000000000..56ddde41ebe --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-sequence-measurement/index.md @@ -0,0 +1,22 @@ +--- +title: SequenceMeasurement - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [SequenceMeasurement](./index.html) + +# SequenceMeasurement + +`open class SequenceMeasurement : `[`TelemetryMeasurement`](../-telemetry-measurement/index.html) + +### Constructors + +| [<init>](-init-.html) | `SequenceMeasurement(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.html)`, ping: `[`TelemetryPingBuilder`](../../org.mozilla.telemetry.ping/-telemetry-ping-builder/index.html)`)` | + +### Functions + +| [flush](flush.html) | `open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) | + +### Inherited Functions + +| [getFieldName](../-telemetry-measurement/get-field-name.html) | `open fun getFieldName(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-session-count-measurement/-init-.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-session-count-measurement/-init-.md new file mode 100644 index 00000000000..51450bcdc3c --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-session-count-measurement/-init-.md @@ -0,0 +1,9 @@ +--- +title: SessionCountMeasurement. - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [SessionCountMeasurement](index.html) / [<init>](./-init-.html) + +# <init> + +`SessionCountMeasurement(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.html)`)` \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-session-count-measurement/count-session.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-session-count-measurement/count-session.md new file mode 100644 index 00000000000..d77b0cd498d --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-session-count-measurement/count-session.md @@ -0,0 +1,9 @@ +--- +title: SessionCountMeasurement.countSession - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [SessionCountMeasurement](index.html) / [countSession](./count-session.html) + +# countSession + +`open fun countSession(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-session-count-measurement/flush.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-session-count-measurement/flush.md new file mode 100644 index 00000000000..cdf94b0b902 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-session-count-measurement/flush.md @@ -0,0 +1,12 @@ +--- +title: SessionCountMeasurement.flush - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [SessionCountMeasurement](index.html) / [flush](./flush.html) + +# flush + +`open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) + +Overrides [TelemetryMeasurement.flush](../-telemetry-measurement/flush.html) + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-session-count-measurement/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-session-count-measurement/index.md new file mode 100644 index 00000000000..b9217b5b0ca --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-session-count-measurement/index.md @@ -0,0 +1,23 @@ +--- +title: SessionCountMeasurement - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [SessionCountMeasurement](./index.html) + +# SessionCountMeasurement + +`open class SessionCountMeasurement : `[`TelemetryMeasurement`](../-telemetry-measurement/index.html) + +### Constructors + +| [<init>](-init-.html) | `SessionCountMeasurement(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.html)`)` | + +### Functions + +| [countSession](count-session.html) | `open fun countSession(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [flush](flush.html) | `open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) | + +### Inherited Functions + +| [getFieldName](../-telemetry-measurement/get-field-name.html) | `open fun getFieldName(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-session-duration-measurement/-init-.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-session-duration-measurement/-init-.md new file mode 100644 index 00000000000..69431ec63e0 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-session-duration-measurement/-init-.md @@ -0,0 +1,9 @@ +--- +title: SessionDurationMeasurement. - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [SessionDurationMeasurement](index.html) / [<init>](./-init-.html) + +# <init> + +`SessionDurationMeasurement(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.html)`)` \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-session-duration-measurement/flush.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-session-duration-measurement/flush.md new file mode 100644 index 00000000000..3957e6e72ef --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-session-duration-measurement/flush.md @@ -0,0 +1,12 @@ +--- +title: SessionDurationMeasurement.flush - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [SessionDurationMeasurement](index.html) / [flush](./flush.html) + +# flush + +`open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) + +Overrides [TelemetryMeasurement.flush](../-telemetry-measurement/flush.html) + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-session-duration-measurement/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-session-duration-measurement/index.md new file mode 100644 index 00000000000..9e4b42760ca --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-session-duration-measurement/index.md @@ -0,0 +1,24 @@ +--- +title: SessionDurationMeasurement - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [SessionDurationMeasurement](./index.html) + +# SessionDurationMeasurement + +`open class SessionDurationMeasurement : `[`TelemetryMeasurement`](../-telemetry-measurement/index.html) + +### Constructors + +| [<init>](-init-.html) | `SessionDurationMeasurement(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.html)`)` | + +### Functions + +| [flush](flush.html) | `open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) | +| [recordSessionEnd](record-session-end.html) | `open fun recordSessionEnd(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [recordSessionStart](record-session-start.html) | `open fun recordSessionStart(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | + +### Inherited Functions + +| [getFieldName](../-telemetry-measurement/get-field-name.html) | `open fun getFieldName(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-session-duration-measurement/record-session-end.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-session-duration-measurement/record-session-end.md new file mode 100644 index 00000000000..97f3665ac9e --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-session-duration-measurement/record-session-end.md @@ -0,0 +1,9 @@ +--- +title: SessionDurationMeasurement.recordSessionEnd - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [SessionDurationMeasurement](index.html) / [recordSessionEnd](./record-session-end.html) + +# recordSessionEnd + +`open fun recordSessionEnd(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-session-duration-measurement/record-session-start.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-session-duration-measurement/record-session-start.md new file mode 100644 index 00000000000..493f6fb4b9d --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-session-duration-measurement/record-session-start.md @@ -0,0 +1,9 @@ +--- +title: SessionDurationMeasurement.recordSessionStart - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [SessionDurationMeasurement](index.html) / [recordSessionStart](./record-session-start.html) + +# recordSessionStart + +`open fun recordSessionStart(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-settings-measurement/-init-.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-settings-measurement/-init-.md new file mode 100644 index 00000000000..c22da79ba5c --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-settings-measurement/-init-.md @@ -0,0 +1,9 @@ +--- +title: SettingsMeasurement. - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [SettingsMeasurement](index.html) / [<init>](./-init-.html) + +# <init> + +`SettingsMeasurement(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.html)`)` \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-settings-measurement/-settings-provider/contains-key.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-settings-measurement/-settings-provider/contains-key.md new file mode 100644 index 00000000000..25d1cbef6a4 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-settings-measurement/-settings-provider/contains-key.md @@ -0,0 +1,12 @@ +--- +title: SettingsMeasurement.SettingsProvider.containsKey - +--- + +[org.mozilla.telemetry.measurement](../../index.html) / [SettingsMeasurement](../index.html) / [SettingsProvider](index.html) / [containsKey](./contains-key.html) + +# containsKey + +`abstract fun containsKey(key: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Returns true if a settings value is available for the given key. + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-settings-measurement/-settings-provider/get-value.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-settings-measurement/-settings-provider/get-value.md new file mode 100644 index 00000000000..3c6da04ccac --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-settings-measurement/-settings-provider/get-value.md @@ -0,0 +1,12 @@ +--- +title: SettingsMeasurement.SettingsProvider.getValue - +--- + +[org.mozilla.telemetry.measurement](../../index.html) / [SettingsMeasurement](../index.html) / [SettingsProvider](index.html) / [getValue](./get-value.html) + +# getValue + +`abstract fun getValue(key: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) + +Get the setting value for the given key. + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-settings-measurement/-settings-provider/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-settings-measurement/-settings-provider/index.md new file mode 100644 index 00000000000..7ef41f20ac2 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-settings-measurement/-settings-provider/index.md @@ -0,0 +1,23 @@ +--- +title: SettingsMeasurement.SettingsProvider - +--- + +[org.mozilla.telemetry.measurement](../../index.html) / [SettingsMeasurement](../index.html) / [SettingsProvider](./index.html) + +# SettingsProvider + +`interface SettingsProvider` + +A generic interface for implementations that can provide settings values. + +### Functions + +| [containsKey](contains-key.html) | `abstract fun containsKey(key: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Returns true if a settings value is available for the given key. | +| [getValue](get-value.html) | `abstract fun getValue(key: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)
Get the setting value for the given key. | +| [release](release.html) | `abstract fun release(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Notify the provider that we finished reading from it and that it can release resources now. | +| [update](update.html) | `abstract fun update(configuration: `[`TelemetryConfiguration`](../../../org.mozilla.telemetry.config/-telemetry-configuration/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Notify this provider that we are going to read values from it. Some providers might need to perform some actions to be able to provide a fresh set of values. | + +### Inheritors + +| [SharedPreferenceSettingsProvider](../-shared-preference-settings-provider/index.html) | `open class SharedPreferenceSettingsProvider : `[`SettingsProvider`](./index.md)
Setting provider implementation that reads values from SharedPreferences. | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-settings-measurement/-settings-provider/release.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-settings-measurement/-settings-provider/release.md new file mode 100644 index 00000000000..0e0287e1b02 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-settings-measurement/-settings-provider/release.md @@ -0,0 +1,12 @@ +--- +title: SettingsMeasurement.SettingsProvider.release - +--- + +[org.mozilla.telemetry.measurement](../../index.html) / [SettingsMeasurement](../index.html) / [SettingsProvider](index.html) / [release](./release.html) + +# release + +`abstract fun release(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Notify the provider that we finished reading from it and that it can release resources now. + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-settings-measurement/-settings-provider/update.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-settings-measurement/-settings-provider/update.md new file mode 100644 index 00000000000..86cb759f987 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-settings-measurement/-settings-provider/update.md @@ -0,0 +1,12 @@ +--- +title: SettingsMeasurement.SettingsProvider.update - +--- + +[org.mozilla.telemetry.measurement](../../index.html) / [SettingsMeasurement](../index.html) / [SettingsProvider](index.html) / [update](./update.html) + +# update + +`abstract fun update(configuration: `[`TelemetryConfiguration`](../../../org.mozilla.telemetry.config/-telemetry-configuration/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Notify this provider that we are going to read values from it. Some providers might need to perform some actions to be able to provide a fresh set of values. + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-settings-measurement/-shared-preference-settings-provider/-init-.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-settings-measurement/-shared-preference-settings-provider/-init-.md new file mode 100644 index 00000000000..df30a5f314c --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-settings-measurement/-shared-preference-settings-provider/-init-.md @@ -0,0 +1,12 @@ +--- +title: SettingsMeasurement.SharedPreferenceSettingsProvider. - +--- + +[org.mozilla.telemetry.measurement](../../index.html) / [SettingsMeasurement](../index.html) / [SharedPreferenceSettingsProvider](index.html) / [<init>](./-init-.html) + +# <init> + +`SharedPreferenceSettingsProvider()` + +Setting provider implementation that reads values from SharedPreferences. + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-settings-measurement/-shared-preference-settings-provider/contains-key.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-settings-measurement/-shared-preference-settings-provider/contains-key.md new file mode 100644 index 00000000000..d06abedbe6a --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-settings-measurement/-shared-preference-settings-provider/contains-key.md @@ -0,0 +1,12 @@ +--- +title: SettingsMeasurement.SharedPreferenceSettingsProvider.containsKey - +--- + +[org.mozilla.telemetry.measurement](../../index.html) / [SettingsMeasurement](../index.html) / [SharedPreferenceSettingsProvider](index.html) / [containsKey](./contains-key.html) + +# containsKey + +`open fun containsKey(key: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Overrides [SettingsProvider.containsKey](../-settings-provider/contains-key.html) + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-settings-measurement/-shared-preference-settings-provider/get-value.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-settings-measurement/-shared-preference-settings-provider/get-value.md new file mode 100644 index 00000000000..9198a089bbe --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-settings-measurement/-shared-preference-settings-provider/get-value.md @@ -0,0 +1,12 @@ +--- +title: SettingsMeasurement.SharedPreferenceSettingsProvider.getValue - +--- + +[org.mozilla.telemetry.measurement](../../index.html) / [SettingsMeasurement](../index.html) / [SharedPreferenceSettingsProvider](index.html) / [getValue](./get-value.html) + +# getValue + +`open fun getValue(key: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) + +Overrides [SettingsProvider.getValue](../-settings-provider/get-value.html) + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-settings-measurement/-shared-preference-settings-provider/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-settings-measurement/-shared-preference-settings-provider/index.md new file mode 100644 index 00000000000..482a556e07f --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-settings-measurement/-shared-preference-settings-provider/index.md @@ -0,0 +1,23 @@ +--- +title: SettingsMeasurement.SharedPreferenceSettingsProvider - +--- + +[org.mozilla.telemetry.measurement](../../index.html) / [SettingsMeasurement](../index.html) / [SharedPreferenceSettingsProvider](./index.html) + +# SharedPreferenceSettingsProvider + +`open class SharedPreferenceSettingsProvider : `[`SettingsProvider`](../-settings-provider/index.html) + +Setting provider implementation that reads values from SharedPreferences. + +### Constructors + +| [<init>](-init-.html) | `SharedPreferenceSettingsProvider()`
Setting provider implementation that reads values from SharedPreferences. | + +### Functions + +| [containsKey](contains-key.html) | `open fun containsKey(key: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [getValue](get-value.html) | `open fun getValue(key: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) | +| [release](release.html) | `open fun release(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [update](update.html) | `open fun update(configuration: `[`TelemetryConfiguration`](../../../org.mozilla.telemetry.config/-telemetry-configuration/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-settings-measurement/-shared-preference-settings-provider/release.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-settings-measurement/-shared-preference-settings-provider/release.md new file mode 100644 index 00000000000..96f5c67eae2 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-settings-measurement/-shared-preference-settings-provider/release.md @@ -0,0 +1,12 @@ +--- +title: SettingsMeasurement.SharedPreferenceSettingsProvider.release - +--- + +[org.mozilla.telemetry.measurement](../../index.html) / [SettingsMeasurement](../index.html) / [SharedPreferenceSettingsProvider](index.html) / [release](./release.html) + +# release + +`open fun release(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Overrides [SettingsProvider.release](../-settings-provider/release.html) + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-settings-measurement/-shared-preference-settings-provider/update.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-settings-measurement/-shared-preference-settings-provider/update.md new file mode 100644 index 00000000000..4907d50ccde --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-settings-measurement/-shared-preference-settings-provider/update.md @@ -0,0 +1,12 @@ +--- +title: SettingsMeasurement.SharedPreferenceSettingsProvider.update - +--- + +[org.mozilla.telemetry.measurement](../../index.html) / [SettingsMeasurement](../index.html) / [SharedPreferenceSettingsProvider](index.html) / [update](./update.html) + +# update + +`open fun update(configuration: `[`TelemetryConfiguration`](../../../org.mozilla.telemetry.config/-telemetry-configuration/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Overrides [SettingsProvider.update](../-settings-provider/update.html) + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-settings-measurement/flush.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-settings-measurement/flush.md new file mode 100644 index 00000000000..8701539356a --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-settings-measurement/flush.md @@ -0,0 +1,12 @@ +--- +title: SettingsMeasurement.flush - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [SettingsMeasurement](index.html) / [flush](./flush.html) + +# flush + +`open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) + +Overrides [TelemetryMeasurement.flush](../-telemetry-measurement/flush.html) + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-settings-measurement/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-settings-measurement/index.md new file mode 100644 index 00000000000..47431e74b64 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-settings-measurement/index.md @@ -0,0 +1,27 @@ +--- +title: SettingsMeasurement - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [SettingsMeasurement](./index.html) + +# SettingsMeasurement + +`open class SettingsMeasurement : `[`TelemetryMeasurement`](../-telemetry-measurement/index.html) + +### Types + +| [SettingsProvider](-settings-provider/index.html) | `interface SettingsProvider`
A generic interface for implementations that can provide settings values. | +| [SharedPreferenceSettingsProvider](-shared-preference-settings-provider/index.html) | `open class SharedPreferenceSettingsProvider : `[`SettingsProvider`](-settings-provider/index.html)
Setting provider implementation that reads values from SharedPreferences. | + +### Constructors + +| [<init>](-init-.html) | `SettingsMeasurement(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.html)`)` | + +### Functions + +| [flush](flush.html) | `open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) | + +### Inherited Functions + +| [getFieldName](../-telemetry-measurement/get-field-name.html) | `open fun getFieldName(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-static-measurement/-init-.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-static-measurement/-init-.md new file mode 100644 index 00000000000..fe150358840 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-static-measurement/-init-.md @@ -0,0 +1,9 @@ +--- +title: StaticMeasurement. - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [StaticMeasurement](index.html) / [<init>](./-init-.html) + +# <init> + +`StaticMeasurement(fieldName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, value: `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`)` \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-static-measurement/flush.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-static-measurement/flush.md new file mode 100644 index 00000000000..539455fac56 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-static-measurement/flush.md @@ -0,0 +1,12 @@ +--- +title: StaticMeasurement.flush - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [StaticMeasurement](index.html) / [flush](./flush.html) + +# flush + +`open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) + +Overrides [TelemetryMeasurement.flush](../-telemetry-measurement/flush.html) + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-static-measurement/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-static-measurement/index.md new file mode 100644 index 00000000000..5495bc0aa43 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-static-measurement/index.md @@ -0,0 +1,28 @@ +--- +title: StaticMeasurement - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [StaticMeasurement](./index.html) + +# StaticMeasurement + +`open class StaticMeasurement : `[`TelemetryMeasurement`](../-telemetry-measurement/index.html) + +### Constructors + +| [<init>](-init-.html) | `StaticMeasurement(fieldName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, value: `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`)` | + +### Functions + +| [flush](flush.html) | `open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) | + +### Inherited Functions + +| [getFieldName](../-telemetry-measurement/get-field-name.html) | `open fun getFieldName(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + +### Inheritors + +| [OperatingSystemMeasurement](../-operating-system-measurement/index.html) | `open class OperatingSystemMeasurement : `[`StaticMeasurement`](./index.md) | +| [OperatingSystemVersionMeasurement](../-operating-system-version-measurement/index.html) | `open class OperatingSystemVersionMeasurement : `[`StaticMeasurement`](./index.md) | +| [VersionMeasurement](../-version-measurement/index.html) | `open class VersionMeasurement : `[`StaticMeasurement`](./index.md) | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-telemetry-measurement/-init-.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-telemetry-measurement/-init-.md new file mode 100644 index 00000000000..281e7b46c62 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-telemetry-measurement/-init-.md @@ -0,0 +1,9 @@ +--- +title: TelemetryMeasurement. - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [TelemetryMeasurement](index.html) / [<init>](./-init-.html) + +# <init> + +`TelemetryMeasurement(fieldName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)` \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-telemetry-measurement/flush.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-telemetry-measurement/flush.md new file mode 100644 index 00000000000..4b60d1675ee --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-telemetry-measurement/flush.md @@ -0,0 +1,12 @@ +--- +title: TelemetryMeasurement.flush - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [TelemetryMeasurement](index.html) / [flush](./flush.html) + +# flush + +`abstract fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) + +Flush this measurement in order for serializing a ping. Calling this method should create an Object representing the current state of this measurement. Optionally this measurement might be reset. For example a TelemetryMeasurement implementation for the OS version of the device might just return a String like "7.0.1". However a TelemetryMeasurement implementation for counting the usage of search engines might return a HashMap mapping search engine names to search counts. Additionally those counts will be reset after flushing. + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-telemetry-measurement/get-field-name.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-telemetry-measurement/get-field-name.md new file mode 100644 index 00000000000..3f0dc0447e2 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-telemetry-measurement/get-field-name.md @@ -0,0 +1,9 @@ +--- +title: TelemetryMeasurement.getFieldName - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [TelemetryMeasurement](index.html) / [getFieldName](./get-field-name.html) + +# getFieldName + +`open fun getFieldName(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-telemetry-measurement/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-telemetry-measurement/index.md new file mode 100644 index 00000000000..e32aa881afa --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-telemetry-measurement/index.md @@ -0,0 +1,43 @@ +--- +title: TelemetryMeasurement - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [TelemetryMeasurement](./index.html) + +# TelemetryMeasurement + +`abstract class TelemetryMeasurement` + +### Constructors + +| [<init>](-init-.html) | `TelemetryMeasurement(fieldName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)` | + +### Functions + +| [flush](flush.html) | `abstract fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)
Flush this measurement in order for serializing a ping. Calling this method should create an Object representing the current state of this measurement. Optionally this measurement might be reset. For example a TelemetryMeasurement implementation for the OS version of the device might just return a String like "7.0.1". However a TelemetryMeasurement implementation for counting the usage of search engines might return a HashMap mapping search engine names to search counts. Additionally those counts will be reset after flushing. | +| [getFieldName](get-field-name.html) | `open fun getFieldName(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + +### Inheritors + +| [ArchMeasurement](../-arch-measurement/index.html) | `open class ArchMeasurement : `[`TelemetryMeasurement`](./index.md) | +| [ClientIdMeasurement](../-client-id-measurement/index.html) | `open class ClientIdMeasurement : `[`TelemetryMeasurement`](./index.md)
A unique, randomly generated UUID for this client. | +| [CreatedDateMeasurement](../-created-date-measurement/index.html) | `open class CreatedDateMeasurement : `[`TelemetryMeasurement`](./index.md) | +| [CreatedDateMeasurementNew](../-created-date-measurement-new/index.html) | `open class CreatedDateMeasurementNew : `[`TelemetryMeasurement`](./index.md)
The field 'created' from CreatedDateMeasurement will be deprecated for the `createdDate` field | +| [CreatedTimestampMeasurement](../-created-timestamp-measurement/index.html) | `open class CreatedTimestampMeasurement : `[`TelemetryMeasurement`](./index.md) | +| [CreatedTimestampMeasurementNew](../-created-timestamp-measurement-new/index.html) | `open class CreatedTimestampMeasurementNew : `[`TelemetryMeasurement`](./index.md)
The field 'created' from CreatedTimestampMeasurement will be deprecated for the `createdTimestamp` field | +| [DefaultSearchMeasurement](../-default-search-measurement/index.html) | `open class DefaultSearchMeasurement : `[`TelemetryMeasurement`](./index.md) | +| [DeviceMeasurement](../-device-measurement/index.html) | `open class DeviceMeasurement : `[`TelemetryMeasurement`](./index.md) | +| [EventsMeasurement](../-events-measurement/index.html) | `open class EventsMeasurement : `[`TelemetryMeasurement`](./index.md) | +| [ExperimentsMeasurement](../-experiments-measurement/index.html) | `open class ExperimentsMeasurement : `[`TelemetryMeasurement`](./index.md) | +| [FirstRunProfileDateMeasurement](../-first-run-profile-date-measurement/index.html) | `open class FirstRunProfileDateMeasurement : `[`TelemetryMeasurement`](./index.md)
This measurement will save the timestamp of the first time it was instantiated and report this as profile creation date. | +| [LocaleMeasurement](../-locale-measurement/index.html) | `open class LocaleMeasurement : `[`TelemetryMeasurement`](./index.md) | +| [MetricsMeasurement](../-metrics-measurement/index.html) | `open class MetricsMeasurement : `[`TelemetryMeasurement`](./index.md) | +| [ProcessStartTimestampMeasurement](../-process-start-timestamp-measurement/index.html) | `open class ProcessStartTimestampMeasurement : `[`TelemetryMeasurement`](./index.md) | +| [SearchesMeasurement](../-searches-measurement/index.html) | `open class SearchesMeasurement : `[`TelemetryMeasurement`](./index.md)
A TelemetryMeasurement implementation to count the number of times a user has searched with a specific engine from a specific location. | +| [SequenceMeasurement](../-sequence-measurement/index.html) | `open class SequenceMeasurement : `[`TelemetryMeasurement`](./index.md) | +| [SessionCountMeasurement](../-session-count-measurement/index.html) | `open class SessionCountMeasurement : `[`TelemetryMeasurement`](./index.md) | +| [SessionDurationMeasurement](../-session-duration-measurement/index.html) | `open class SessionDurationMeasurement : `[`TelemetryMeasurement`](./index.md) | +| [SettingsMeasurement](../-settings-measurement/index.html) | `open class SettingsMeasurement : `[`TelemetryMeasurement`](./index.md) | +| [StaticMeasurement](../-static-measurement/index.html) | `open class StaticMeasurement : `[`TelemetryMeasurement`](./index.md) | +| [TimezoneOffsetMeasurement](../-timezone-offset-measurement/index.html) | `open class TimezoneOffsetMeasurement : `[`TelemetryMeasurement`](./index.md) | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-timezone-offset-measurement/-init-.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-timezone-offset-measurement/-init-.md new file mode 100644 index 00000000000..34c50c75ac3 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-timezone-offset-measurement/-init-.md @@ -0,0 +1,9 @@ +--- +title: TimezoneOffsetMeasurement. - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [TimezoneOffsetMeasurement](index.html) / [<init>](./-init-.html) + +# <init> + +`TimezoneOffsetMeasurement()` \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-timezone-offset-measurement/flush.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-timezone-offset-measurement/flush.md new file mode 100644 index 00000000000..dc9f3ea5c2f --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-timezone-offset-measurement/flush.md @@ -0,0 +1,12 @@ +--- +title: TimezoneOffsetMeasurement.flush - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [TimezoneOffsetMeasurement](index.html) / [flush](./flush.html) + +# flush + +`open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) + +Overrides [TelemetryMeasurement.flush](../-telemetry-measurement/flush.html) + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-timezone-offset-measurement/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-timezone-offset-measurement/index.md new file mode 100644 index 00000000000..01db75d8d93 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-timezone-offset-measurement/index.md @@ -0,0 +1,22 @@ +--- +title: TimezoneOffsetMeasurement - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [TimezoneOffsetMeasurement](./index.html) + +# TimezoneOffsetMeasurement + +`open class TimezoneOffsetMeasurement : `[`TelemetryMeasurement`](../-telemetry-measurement/index.html) + +### Constructors + +| [<init>](-init-.html) | `TimezoneOffsetMeasurement()` | + +### Functions + +| [flush](flush.html) | `open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) | + +### Inherited Functions + +| [getFieldName](../-telemetry-measurement/get-field-name.html) | `open fun getFieldName(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-version-measurement/-init-.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-version-measurement/-init-.md new file mode 100644 index 00000000000..670cfaa562a --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-version-measurement/-init-.md @@ -0,0 +1,9 @@ +--- +title: VersionMeasurement. - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [VersionMeasurement](index.html) / [<init>](./-init-.html) + +# <init> + +`VersionMeasurement(version: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-version-measurement/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-version-measurement/index.md new file mode 100644 index 00000000000..35bb807eb69 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/-version-measurement/index.md @@ -0,0 +1,18 @@ +--- +title: VersionMeasurement - +--- + +[org.mozilla.telemetry.measurement](../index.html) / [VersionMeasurement](./index.html) + +# VersionMeasurement + +`open class VersionMeasurement : `[`StaticMeasurement`](../-static-measurement/index.html) + +### Constructors + +| [<init>](-init-.html) | `VersionMeasurement(version: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` | + +### Inherited Functions + +| [flush](../-static-measurement/flush.html) | `open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/index.md new file mode 100644 index 00000000000..cc08af67d4c --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.measurement/index.md @@ -0,0 +1,36 @@ +--- +title: org.mozilla.telemetry.measurement - +--- + +[org.mozilla.telemetry.measurement](./index.html) + +## Package org.mozilla.telemetry.measurement + +### Types + +| [ArchMeasurement](-arch-measurement/index.html) | `open class ArchMeasurement : `[`TelemetryMeasurement`](-telemetry-measurement/index.html) | +| [ClientIdMeasurement](-client-id-measurement/index.html) | `open class ClientIdMeasurement : `[`TelemetryMeasurement`](-telemetry-measurement/index.html)
A unique, randomly generated UUID for this client. | +| [CreatedDateMeasurement](-created-date-measurement/index.html) | `open class CreatedDateMeasurement : `[`TelemetryMeasurement`](-telemetry-measurement/index.html) | +| [CreatedDateMeasurementNew](-created-date-measurement-new/index.html) | `open class CreatedDateMeasurementNew : `[`TelemetryMeasurement`](-telemetry-measurement/index.html)
The field 'created' from CreatedDateMeasurement will be deprecated for the `createdDate` field | +| [CreatedTimestampMeasurement](-created-timestamp-measurement/index.html) | `open class CreatedTimestampMeasurement : `[`TelemetryMeasurement`](-telemetry-measurement/index.html) | +| [CreatedTimestampMeasurementNew](-created-timestamp-measurement-new/index.html) | `open class CreatedTimestampMeasurementNew : `[`TelemetryMeasurement`](-telemetry-measurement/index.html)
The field 'created' from CreatedTimestampMeasurement will be deprecated for the `createdTimestamp` field | +| [DefaultSearchMeasurement](-default-search-measurement/index.html) | `open class DefaultSearchMeasurement : `[`TelemetryMeasurement`](-telemetry-measurement/index.html) | +| [DeviceMeasurement](-device-measurement/index.html) | `open class DeviceMeasurement : `[`TelemetryMeasurement`](-telemetry-measurement/index.html) | +| [EventsMeasurement](-events-measurement/index.html) | `open class EventsMeasurement : `[`TelemetryMeasurement`](-telemetry-measurement/index.html) | +| [ExperimentsMeasurement](-experiments-measurement/index.html) | `open class ExperimentsMeasurement : `[`TelemetryMeasurement`](-telemetry-measurement/index.html) | +| [FirstRunProfileDateMeasurement](-first-run-profile-date-measurement/index.html) | `open class FirstRunProfileDateMeasurement : `[`TelemetryMeasurement`](-telemetry-measurement/index.html)
This measurement will save the timestamp of the first time it was instantiated and report this as profile creation date. | +| [LocaleMeasurement](-locale-measurement/index.html) | `open class LocaleMeasurement : `[`TelemetryMeasurement`](-telemetry-measurement/index.html) | +| [MetricsMeasurement](-metrics-measurement/index.html) | `open class MetricsMeasurement : `[`TelemetryMeasurement`](-telemetry-measurement/index.html) | +| [OperatingSystemMeasurement](-operating-system-measurement/index.html) | `open class OperatingSystemMeasurement : `[`StaticMeasurement`](-static-measurement/index.html) | +| [OperatingSystemVersionMeasurement](-operating-system-version-measurement/index.html) | `open class OperatingSystemVersionMeasurement : `[`StaticMeasurement`](-static-measurement/index.html) | +| [ProcessStartTimestampMeasurement](-process-start-timestamp-measurement/index.html) | `open class ProcessStartTimestampMeasurement : `[`TelemetryMeasurement`](-telemetry-measurement/index.html) | +| [SearchesMeasurement](-searches-measurement/index.html) | `open class SearchesMeasurement : `[`TelemetryMeasurement`](-telemetry-measurement/index.html)
A TelemetryMeasurement implementation to count the number of times a user has searched with a specific engine from a specific location. | +| [SequenceMeasurement](-sequence-measurement/index.html) | `open class SequenceMeasurement : `[`TelemetryMeasurement`](-telemetry-measurement/index.html) | +| [SessionCountMeasurement](-session-count-measurement/index.html) | `open class SessionCountMeasurement : `[`TelemetryMeasurement`](-telemetry-measurement/index.html) | +| [SessionDurationMeasurement](-session-duration-measurement/index.html) | `open class SessionDurationMeasurement : `[`TelemetryMeasurement`](-telemetry-measurement/index.html) | +| [SettingsMeasurement](-settings-measurement/index.html) | `open class SettingsMeasurement : `[`TelemetryMeasurement`](-telemetry-measurement/index.html) | +| [StaticMeasurement](-static-measurement/index.html) | `open class StaticMeasurement : `[`TelemetryMeasurement`](-telemetry-measurement/index.html) | +| [TelemetryMeasurement](-telemetry-measurement/index.html) | `abstract class TelemetryMeasurement` | +| [TimezoneOffsetMeasurement](-timezone-offset-measurement/index.html) | `open class TimezoneOffsetMeasurement : `[`TelemetryMeasurement`](-telemetry-measurement/index.html) | +| [VersionMeasurement](-version-measurement/index.html) | `open class VersionMeasurement : `[`StaticMeasurement`](-static-measurement/index.html) | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.net/-debug-log-client/-init-.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.net/-debug-log-client/-init-.md new file mode 100644 index 00000000000..a7ac66d27ac --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.net/-debug-log-client/-init-.md @@ -0,0 +1,13 @@ +--- +title: DebugLogClient. - +--- + +[org.mozilla.telemetry.net](../index.html) / [DebugLogClient](index.html) / [<init>](./-init-.html) + +# <init> + +`DebugLogClient(tag: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)` + +This client just prints pings to logcat instead of uploading them. Therefore this client is only +useful for debugging purposes. + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.net/-debug-log-client/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.net/-debug-log-client/index.md new file mode 100644 index 00000000000..7802a6a4039 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.net/-debug-log-client/index.md @@ -0,0 +1,21 @@ +--- +title: DebugLogClient - +--- + +[org.mozilla.telemetry.net](../index.html) / [DebugLogClient](./index.html) + +# DebugLogClient + +`class DebugLogClient : `[`TelemetryClient`](../-telemetry-client/index.html) + +This client just prints pings to logcat instead of uploading them. Therefore this client is only +useful for debugging purposes. + +### Constructors + +| [<init>](-init-.html) | `DebugLogClient(tag: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)`
This client just prints pings to logcat instead of uploading them. Therefore this client is only useful for debugging purposes. | + +### Functions + +| [uploadPing](upload-ping.html) | `fun uploadPing(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.html)`, path: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, serializedPing: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.net/-debug-log-client/upload-ping.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.net/-debug-log-client/upload-ping.md new file mode 100644 index 00000000000..6d0c1936dee --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.net/-debug-log-client/upload-ping.md @@ -0,0 +1,12 @@ +--- +title: DebugLogClient.uploadPing - +--- + +[org.mozilla.telemetry.net](../index.html) / [DebugLogClient](index.html) / [uploadPing](./upload-ping.html) + +# uploadPing + +`fun uploadPing(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.html)`, path: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, serializedPing: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Overrides [TelemetryClient.uploadPing](../-telemetry-client/upload-ping.html) + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.net/-http-u-r-l-connection-telemetry-client/-init-.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.net/-http-u-r-l-connection-telemetry-client/-init-.md new file mode 100644 index 00000000000..0409cde2386 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.net/-http-u-r-l-connection-telemetry-client/-init-.md @@ -0,0 +1,9 @@ +--- +title: HttpURLConnectionTelemetryClient. - +--- + +[org.mozilla.telemetry.net](../index.html) / [HttpURLConnectionTelemetryClient](index.html) / [<init>](./-init-.html) + +# <init> + +`HttpURLConnectionTelemetryClient()` \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.net/-http-u-r-l-connection-telemetry-client/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.net/-http-u-r-l-connection-telemetry-client/index.md new file mode 100644 index 00000000000..35e82b427b9 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.net/-http-u-r-l-connection-telemetry-client/index.md @@ -0,0 +1,18 @@ +--- +title: HttpURLConnectionTelemetryClient - +--- + +[org.mozilla.telemetry.net](../index.html) / [HttpURLConnectionTelemetryClient](./index.html) + +# HttpURLConnectionTelemetryClient + +`open class HttpURLConnectionTelemetryClient : `[`TelemetryClient`](../-telemetry-client/index.html) + +### Constructors + +| [<init>](-init-.html) | `HttpURLConnectionTelemetryClient()` | + +### Functions + +| [uploadPing](upload-ping.html) | `open fun uploadPing(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.html)`, path: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, serializedPing: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.net/-http-u-r-l-connection-telemetry-client/upload-ping.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.net/-http-u-r-l-connection-telemetry-client/upload-ping.md new file mode 100644 index 00000000000..7fd776eca4f --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.net/-http-u-r-l-connection-telemetry-client/upload-ping.md @@ -0,0 +1,12 @@ +--- +title: HttpURLConnectionTelemetryClient.uploadPing - +--- + +[org.mozilla.telemetry.net](../index.html) / [HttpURLConnectionTelemetryClient](index.html) / [uploadPing](./upload-ping.html) + +# uploadPing + +`open fun uploadPing(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.html)`, path: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, serializedPing: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Overrides [TelemetryClient.uploadPing](../-telemetry-client/upload-ping.html) + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.net/-telemetry-client/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.net/-telemetry-client/index.md new file mode 100644 index 00000000000..52303898988 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.net/-telemetry-client/index.md @@ -0,0 +1,19 @@ +--- +title: TelemetryClient - +--- + +[org.mozilla.telemetry.net](../index.html) / [TelemetryClient](./index.html) + +# TelemetryClient + +`interface TelemetryClient` + +### Functions + +| [uploadPing](upload-ping.html) | `abstract fun uploadPing(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.html)`, path: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, serializedPing: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | + +### Inheritors + +| [DebugLogClient](../-debug-log-client/index.html) | `class DebugLogClient : `[`TelemetryClient`](./index.md)
This client just prints pings to logcat instead of uploading them. Therefore this client is only useful for debugging purposes. | +| [HttpURLConnectionTelemetryClient](../-http-u-r-l-connection-telemetry-client/index.html) | `open class HttpURLConnectionTelemetryClient : `[`TelemetryClient`](./index.md) | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.net/-telemetry-client/upload-ping.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.net/-telemetry-client/upload-ping.md new file mode 100644 index 00000000000..ac2090a0ff2 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.net/-telemetry-client/upload-ping.md @@ -0,0 +1,9 @@ +--- +title: TelemetryClient.uploadPing - +--- + +[org.mozilla.telemetry.net](../index.html) / [TelemetryClient](index.html) / [uploadPing](./upload-ping.html) + +# uploadPing + +`abstract fun uploadPing(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.html)`, path: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, serializedPing: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.net/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.net/index.md new file mode 100644 index 00000000000..119ac2b04d7 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.net/index.md @@ -0,0 +1,14 @@ +--- +title: org.mozilla.telemetry.net - +--- + +[org.mozilla.telemetry.net](./index.html) + +## Package org.mozilla.telemetry.net + +### Types + +| [DebugLogClient](-debug-log-client/index.html) | `class DebugLogClient : `[`TelemetryClient`](-telemetry-client/index.html)
This client just prints pings to logcat instead of uploading them. Therefore this client is only useful for debugging purposes. | +| [HttpURLConnectionTelemetryClient](-http-u-r-l-connection-telemetry-client/index.html) | `open class HttpURLConnectionTelemetryClient : `[`TelemetryClient`](-telemetry-client/index.html) | +| [TelemetryClient](-telemetry-client/index.html) | `interface TelemetryClient` | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-core-ping-builder/-init-.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-core-ping-builder/-init-.md new file mode 100644 index 00000000000..1a6bfabba4d --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-core-ping-builder/-init-.md @@ -0,0 +1,9 @@ +--- +title: TelemetryCorePingBuilder. - +--- + +[org.mozilla.telemetry.ping](../index.html) / [TelemetryCorePingBuilder](index.html) / [<init>](./-init-.html) + +# <init> + +`TelemetryCorePingBuilder(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.html)`)` \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-core-ping-builder/-t-y-p-e.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-core-ping-builder/-t-y-p-e.md new file mode 100644 index 00000000000..b3bbf47487c --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-core-ping-builder/-t-y-p-e.md @@ -0,0 +1,9 @@ +--- +title: TelemetryCorePingBuilder.TYPE - +--- + +[org.mozilla.telemetry.ping](../index.html) / [TelemetryCorePingBuilder](index.html) / [TYPE](./-t-y-p-e.html) + +# TYPE + +`static val TYPE: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-core-ping-builder/get-default-search-measurement.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-core-ping-builder/get-default-search-measurement.md new file mode 100644 index 00000000000..8679bb7c811 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-core-ping-builder/get-default-search-measurement.md @@ -0,0 +1,9 @@ +--- +title: TelemetryCorePingBuilder.getDefaultSearchMeasurement - +--- + +[org.mozilla.telemetry.ping](../index.html) / [TelemetryCorePingBuilder](index.html) / [getDefaultSearchMeasurement](./get-default-search-measurement.html) + +# getDefaultSearchMeasurement + +`open fun getDefaultSearchMeasurement(): `[`DefaultSearchMeasurement`](../../org.mozilla.telemetry.measurement/-default-search-measurement/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-core-ping-builder/get-experiments-measurement.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-core-ping-builder/get-experiments-measurement.md new file mode 100644 index 00000000000..d85f501faef --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-core-ping-builder/get-experiments-measurement.md @@ -0,0 +1,9 @@ +--- +title: TelemetryCorePingBuilder.getExperimentsMeasurement - +--- + +[org.mozilla.telemetry.ping](../index.html) / [TelemetryCorePingBuilder](index.html) / [getExperimentsMeasurement](./get-experiments-measurement.html) + +# getExperimentsMeasurement + +`open fun getExperimentsMeasurement(): `[`ExperimentsMeasurement`](../../org.mozilla.telemetry.measurement/-experiments-measurement/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-core-ping-builder/get-searches-measurement.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-core-ping-builder/get-searches-measurement.md new file mode 100644 index 00000000000..9e75ce76102 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-core-ping-builder/get-searches-measurement.md @@ -0,0 +1,9 @@ +--- +title: TelemetryCorePingBuilder.getSearchesMeasurement - +--- + +[org.mozilla.telemetry.ping](../index.html) / [TelemetryCorePingBuilder](index.html) / [getSearchesMeasurement](./get-searches-measurement.html) + +# getSearchesMeasurement + +`open fun getSearchesMeasurement(): `[`SearchesMeasurement`](../../org.mozilla.telemetry.measurement/-searches-measurement/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-core-ping-builder/get-session-count-measurement.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-core-ping-builder/get-session-count-measurement.md new file mode 100644 index 00000000000..1f9ce121d3d --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-core-ping-builder/get-session-count-measurement.md @@ -0,0 +1,9 @@ +--- +title: TelemetryCorePingBuilder.getSessionCountMeasurement - +--- + +[org.mozilla.telemetry.ping](../index.html) / [TelemetryCorePingBuilder](index.html) / [getSessionCountMeasurement](./get-session-count-measurement.html) + +# getSessionCountMeasurement + +`open fun getSessionCountMeasurement(): `[`SessionCountMeasurement`](../../org.mozilla.telemetry.measurement/-session-count-measurement/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-core-ping-builder/get-session-duration-measurement.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-core-ping-builder/get-session-duration-measurement.md new file mode 100644 index 00000000000..44a376b7411 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-core-ping-builder/get-session-duration-measurement.md @@ -0,0 +1,9 @@ +--- +title: TelemetryCorePingBuilder.getSessionDurationMeasurement - +--- + +[org.mozilla.telemetry.ping](../index.html) / [TelemetryCorePingBuilder](index.html) / [getSessionDurationMeasurement](./get-session-duration-measurement.html) + +# getSessionDurationMeasurement + +`open fun getSessionDurationMeasurement(): `[`SessionDurationMeasurement`](../../org.mozilla.telemetry.measurement/-session-duration-measurement/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-core-ping-builder/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-core-ping-builder/index.md new file mode 100644 index 00000000000..0e9c243081b --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-core-ping-builder/index.md @@ -0,0 +1,36 @@ +--- +title: TelemetryCorePingBuilder - +--- + +[org.mozilla.telemetry.ping](../index.html) / [TelemetryCorePingBuilder](./index.html) + +# TelemetryCorePingBuilder + +`open class TelemetryCorePingBuilder : `[`TelemetryPingBuilder`](../-telemetry-ping-builder/index.html) + +This mobile-specific ping is intended to provide the most critical data in a concise format, allowing for frequent uploads. Since this ping is used to measure retention, it should be sent each time the app is opened. https://gecko.readthedocs.io/en/latest/toolkit/components/telemetry/telemetry/data/core-ping.html + +### Constructors + +| [<init>](-init-.html) | `TelemetryCorePingBuilder(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.html)`)` | + +### Properties + +| [TYPE](-t-y-p-e.html) | `static val TYPE: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + +### Functions + +| [getDefaultSearchMeasurement](get-default-search-measurement.html) | `open fun getDefaultSearchMeasurement(): `[`DefaultSearchMeasurement`](../../org.mozilla.telemetry.measurement/-default-search-measurement/index.html) | +| [getExperimentsMeasurement](get-experiments-measurement.html) | `open fun getExperimentsMeasurement(): `[`ExperimentsMeasurement`](../../org.mozilla.telemetry.measurement/-experiments-measurement/index.html) | +| [getSearchesMeasurement](get-searches-measurement.html) | `open fun getSearchesMeasurement(): `[`SearchesMeasurement`](../../org.mozilla.telemetry.measurement/-searches-measurement/index.html) | +| [getSessionCountMeasurement](get-session-count-measurement.html) | `open fun getSessionCountMeasurement(): `[`SessionCountMeasurement`](../../org.mozilla.telemetry.measurement/-session-count-measurement/index.html) | +| [getSessionDurationMeasurement](get-session-duration-measurement.html) | `open fun getSessionDurationMeasurement(): `[`SessionDurationMeasurement`](../../org.mozilla.telemetry.measurement/-session-duration-measurement/index.html) | + +### Inherited Functions + +| [build](../-telemetry-ping-builder/build.html) | `open fun build(): `[`TelemetryPing`](../-telemetry-ping/index.html) | +| [canBuild](../-telemetry-ping-builder/can-build.html) | `open fun canBuild(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [generateDocumentId](../-telemetry-ping-builder/generate-document-id.html) | `open fun generateDocumentId(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [getConfiguration](../-telemetry-ping-builder/get-configuration.html) | `open fun getConfiguration(): `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.html) | +| [getType](../-telemetry-ping-builder/get-type.html) | `open fun getType(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-event-ping-builder/-init-.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-event-ping-builder/-init-.md new file mode 100644 index 00000000000..181d2cfcec5 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-event-ping-builder/-init-.md @@ -0,0 +1,9 @@ +--- +title: TelemetryEventPingBuilder. - +--- + +[org.mozilla.telemetry.ping](../index.html) / [TelemetryEventPingBuilder](index.html) / [<init>](./-init-.html) + +# <init> + +`TelemetryEventPingBuilder(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.html)`)` \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-event-ping-builder/-t-y-p-e.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-event-ping-builder/-t-y-p-e.md new file mode 100644 index 00000000000..a155498d2bd --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-event-ping-builder/-t-y-p-e.md @@ -0,0 +1,9 @@ +--- +title: TelemetryEventPingBuilder.TYPE - +--- + +[org.mozilla.telemetry.ping](../index.html) / [TelemetryEventPingBuilder](index.html) / [TYPE](./-t-y-p-e.html) + +# TYPE + +`static val TYPE: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-event-ping-builder/can-build.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-event-ping-builder/can-build.md new file mode 100644 index 00000000000..37d5dccd5ec --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-event-ping-builder/can-build.md @@ -0,0 +1,12 @@ +--- +title: TelemetryEventPingBuilder.canBuild - +--- + +[org.mozilla.telemetry.ping](../index.html) / [TelemetryEventPingBuilder](index.html) / [canBuild](./can-build.html) + +# canBuild + +`open fun canBuild(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Overrides [TelemetryPingBuilder.canBuild](../-telemetry-ping-builder/can-build.html) + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-event-ping-builder/get-events-measurement.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-event-ping-builder/get-events-measurement.md new file mode 100644 index 00000000000..8d9ff950a55 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-event-ping-builder/get-events-measurement.md @@ -0,0 +1,9 @@ +--- +title: TelemetryEventPingBuilder.getEventsMeasurement - +--- + +[org.mozilla.telemetry.ping](../index.html) / [TelemetryEventPingBuilder](index.html) / [getEventsMeasurement](./get-events-measurement.html) + +# getEventsMeasurement + +`open fun getEventsMeasurement(): `[`EventsMeasurement`](../../org.mozilla.telemetry.measurement/-events-measurement/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-event-ping-builder/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-event-ping-builder/index.md new file mode 100644 index 00000000000..0ddbb9c654a --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-event-ping-builder/index.md @@ -0,0 +1,32 @@ +--- +title: TelemetryEventPingBuilder - +--- + +[org.mozilla.telemetry.ping](../index.html) / [TelemetryEventPingBuilder](./index.html) + +# TelemetryEventPingBuilder + +`open class TelemetryEventPingBuilder : `[`TelemetryPingBuilder`](../-telemetry-ping-builder/index.html) + +A telemetry ping builder for pings of type "focus-event". + +### Constructors + +| [<init>](-init-.html) | `TelemetryEventPingBuilder(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.html)`)` | + +### Properties + +| [TYPE](-t-y-p-e.html) | `static val TYPE: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + +### Functions + +| [canBuild](can-build.html) | `open fun canBuild(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [getEventsMeasurement](get-events-measurement.html) | `open fun getEventsMeasurement(): `[`EventsMeasurement`](../../org.mozilla.telemetry.measurement/-events-measurement/index.html) | + +### Inherited Functions + +| [build](../-telemetry-ping-builder/build.html) | `open fun build(): `[`TelemetryPing`](../-telemetry-ping/index.html) | +| [generateDocumentId](../-telemetry-ping-builder/generate-document-id.html) | `open fun generateDocumentId(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [getConfiguration](../-telemetry-ping-builder/get-configuration.html) | `open fun getConfiguration(): `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.html) | +| [getType](../-telemetry-ping-builder/get-type.html) | `open fun getType(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-mobile-event-ping-builder/-init-.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-mobile-event-ping-builder/-init-.md new file mode 100644 index 00000000000..64f2c571949 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-mobile-event-ping-builder/-init-.md @@ -0,0 +1,9 @@ +--- +title: TelemetryMobileEventPingBuilder. - +--- + +[org.mozilla.telemetry.ping](../index.html) / [TelemetryMobileEventPingBuilder](index.html) / [<init>](./-init-.html) + +# <init> + +`TelemetryMobileEventPingBuilder(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.html)`)` \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-mobile-event-ping-builder/-t-y-p-e.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-mobile-event-ping-builder/-t-y-p-e.md new file mode 100644 index 00000000000..c40bdf986e9 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-mobile-event-ping-builder/-t-y-p-e.md @@ -0,0 +1,9 @@ +--- +title: TelemetryMobileEventPingBuilder.TYPE - +--- + +[org.mozilla.telemetry.ping](../index.html) / [TelemetryMobileEventPingBuilder](index.html) / [TYPE](./-t-y-p-e.html) + +# TYPE + +`static val TYPE: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-mobile-event-ping-builder/can-build.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-mobile-event-ping-builder/can-build.md new file mode 100644 index 00000000000..f44657788d3 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-mobile-event-ping-builder/can-build.md @@ -0,0 +1,12 @@ +--- +title: TelemetryMobileEventPingBuilder.canBuild - +--- + +[org.mozilla.telemetry.ping](../index.html) / [TelemetryMobileEventPingBuilder](index.html) / [canBuild](./can-build.html) + +# canBuild + +`open fun canBuild(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Overrides [TelemetryPingBuilder.canBuild](../-telemetry-ping-builder/can-build.html) + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-mobile-event-ping-builder/get-events-measurement.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-mobile-event-ping-builder/get-events-measurement.md new file mode 100644 index 00000000000..d712f949854 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-mobile-event-ping-builder/get-events-measurement.md @@ -0,0 +1,9 @@ +--- +title: TelemetryMobileEventPingBuilder.getEventsMeasurement - +--- + +[org.mozilla.telemetry.ping](../index.html) / [TelemetryMobileEventPingBuilder](index.html) / [getEventsMeasurement](./get-events-measurement.html) + +# getEventsMeasurement + +`open fun getEventsMeasurement(): `[`EventsMeasurement`](../../org.mozilla.telemetry.measurement/-events-measurement/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-mobile-event-ping-builder/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-mobile-event-ping-builder/index.md new file mode 100644 index 00000000000..a3fa0716a88 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-mobile-event-ping-builder/index.md @@ -0,0 +1,32 @@ +--- +title: TelemetryMobileEventPingBuilder - +--- + +[org.mozilla.telemetry.ping](../index.html) / [TelemetryMobileEventPingBuilder](./index.html) + +# TelemetryMobileEventPingBuilder + +`open class TelemetryMobileEventPingBuilder : `[`TelemetryPingBuilder`](../-telemetry-ping-builder/index.html) + +A telemetry ping builder for events of type "mobile-event". See the schema for more details: https://github.com/mozilla-services/mozilla-pipeline-schemas/blob/master/schemas/telemetry/mobile-event/mobile-event.1.schema.json + +### Constructors + +| [<init>](-init-.html) | `TelemetryMobileEventPingBuilder(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.html)`)` | + +### Properties + +| [TYPE](-t-y-p-e.html) | `static val TYPE: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + +### Functions + +| [canBuild](can-build.html) | `open fun canBuild(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [getEventsMeasurement](get-events-measurement.html) | `open fun getEventsMeasurement(): `[`EventsMeasurement`](../../org.mozilla.telemetry.measurement/-events-measurement/index.html) | + +### Inherited Functions + +| [build](../-telemetry-ping-builder/build.html) | `open fun build(): `[`TelemetryPing`](../-telemetry-ping/index.html) | +| [generateDocumentId](../-telemetry-ping-builder/generate-document-id.html) | `open fun generateDocumentId(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [getConfiguration](../-telemetry-ping-builder/get-configuration.html) | `open fun getConfiguration(): `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.html) | +| [getType](../-telemetry-ping-builder/get-type.html) | `open fun getType(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-mobile-metrics-ping-builder/-init-.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-mobile-metrics-ping-builder/-init-.md new file mode 100644 index 00000000000..2c50a899769 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-mobile-metrics-ping-builder/-init-.md @@ -0,0 +1,9 @@ +--- +title: TelemetryMobileMetricsPingBuilder. - +--- + +[org.mozilla.telemetry.ping](../index.html) / [TelemetryMobileMetricsPingBuilder](index.html) / [<init>](./-init-.html) + +# <init> + +`TelemetryMobileMetricsPingBuilder(snapshots: JSONObject, configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.html)`)` \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-mobile-metrics-ping-builder/-t-y-p-e.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-mobile-metrics-ping-builder/-t-y-p-e.md new file mode 100644 index 00000000000..764199115ef --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-mobile-metrics-ping-builder/-t-y-p-e.md @@ -0,0 +1,9 @@ +--- +title: TelemetryMobileMetricsPingBuilder.TYPE - +--- + +[org.mozilla.telemetry.ping](../index.html) / [TelemetryMobileMetricsPingBuilder](index.html) / [TYPE](./-t-y-p-e.html) + +# TYPE + +`static val TYPE: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-mobile-metrics-ping-builder/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-mobile-metrics-ping-builder/index.md new file mode 100644 index 00000000000..9020f3a2cde --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-mobile-metrics-ping-builder/index.md @@ -0,0 +1,28 @@ +--- +title: TelemetryMobileMetricsPingBuilder - +--- + +[org.mozilla.telemetry.ping](../index.html) / [TelemetryMobileMetricsPingBuilder](./index.html) + +# TelemetryMobileMetricsPingBuilder + +`open class TelemetryMobileMetricsPingBuilder : `[`TelemetryPingBuilder`](../-telemetry-ping-builder/index.html) + +A telemetry ping builder for events of type "mobile-metrics". See the schema for more details: https://github.com/mozilla-services/mozilla-pipeline-schemas/blob/master/schemas/telemetry/mobile-metrics/mobile-metrics.1.schema.json + +### Constructors + +| [<init>](-init-.html) | `TelemetryMobileMetricsPingBuilder(snapshots: JSONObject, configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.html)`)` | + +### Properties + +| [TYPE](-t-y-p-e.html) | `static val TYPE: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + +### Inherited Functions + +| [build](../-telemetry-ping-builder/build.html) | `open fun build(): `[`TelemetryPing`](../-telemetry-ping/index.html) | +| [canBuild](../-telemetry-ping-builder/can-build.html) | `open fun canBuild(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [generateDocumentId](../-telemetry-ping-builder/generate-document-id.html) | `open fun generateDocumentId(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [getConfiguration](../-telemetry-ping-builder/get-configuration.html) | `open fun getConfiguration(): `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.html) | +| [getType](../-telemetry-ping-builder/get-type.html) | `open fun getType(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-ping-builder/-init-.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-ping-builder/-init-.md new file mode 100644 index 00000000000..eb4d57663c6 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-ping-builder/-init-.md @@ -0,0 +1,9 @@ +--- +title: TelemetryPingBuilder. - +--- + +[org.mozilla.telemetry.ping](../index.html) / [TelemetryPingBuilder](index.html) / [<init>](./-init-.html) + +# <init> + +`TelemetryPingBuilder(@NonNull configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.html)`, @NonNull type: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, version: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-ping-builder/build.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-ping-builder/build.md new file mode 100644 index 00000000000..a82413465c0 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-ping-builder/build.md @@ -0,0 +1,9 @@ +--- +title: TelemetryPingBuilder.build - +--- + +[org.mozilla.telemetry.ping](../index.html) / [TelemetryPingBuilder](index.html) / [build](./build.html) + +# build + +`open fun build(): `[`TelemetryPing`](../-telemetry-ping/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-ping-builder/can-build.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-ping-builder/can-build.md new file mode 100644 index 00000000000..ebf0383e821 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-ping-builder/can-build.md @@ -0,0 +1,9 @@ +--- +title: TelemetryPingBuilder.canBuild - +--- + +[org.mozilla.telemetry.ping](../index.html) / [TelemetryPingBuilder](index.html) / [canBuild](./can-build.html) + +# canBuild + +`open fun canBuild(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-ping-builder/generate-document-id.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-ping-builder/generate-document-id.md new file mode 100644 index 00000000000..2d45c69e8c3 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-ping-builder/generate-document-id.md @@ -0,0 +1,9 @@ +--- +title: TelemetryPingBuilder.generateDocumentId - +--- + +[org.mozilla.telemetry.ping](../index.html) / [TelemetryPingBuilder](index.html) / [generateDocumentId](./generate-document-id.html) + +# generateDocumentId + +`open fun generateDocumentId(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-ping-builder/get-configuration.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-ping-builder/get-configuration.md new file mode 100644 index 00000000000..f0402e4078d --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-ping-builder/get-configuration.md @@ -0,0 +1,9 @@ +--- +title: TelemetryPingBuilder.getConfiguration - +--- + +[org.mozilla.telemetry.ping](../index.html) / [TelemetryPingBuilder](index.html) / [getConfiguration](./get-configuration.html) + +# getConfiguration + +`open fun getConfiguration(): `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-ping-builder/get-type.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-ping-builder/get-type.md new file mode 100644 index 00000000000..c54fa4a040a --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-ping-builder/get-type.md @@ -0,0 +1,9 @@ +--- +title: TelemetryPingBuilder.getType - +--- + +[org.mozilla.telemetry.ping](../index.html) / [TelemetryPingBuilder](index.html) / [getType](./get-type.html) + +# getType + +`@NonNull open fun getType(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-ping-builder/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-ping-builder/index.md new file mode 100644 index 00000000000..b73bcc2f77b --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-ping-builder/index.md @@ -0,0 +1,29 @@ +--- +title: TelemetryPingBuilder - +--- + +[org.mozilla.telemetry.ping](../index.html) / [TelemetryPingBuilder](./index.html) + +# TelemetryPingBuilder + +`abstract class TelemetryPingBuilder` + +### Constructors + +| [<init>](-init-.html) | `TelemetryPingBuilder(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.html)`, type: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, version: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` | + +### Functions + +| [build](build.html) | `open fun build(): `[`TelemetryPing`](../-telemetry-ping/index.html) | +| [canBuild](can-build.html) | `open fun canBuild(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [generateDocumentId](generate-document-id.html) | `open fun generateDocumentId(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [getConfiguration](get-configuration.html) | `open fun getConfiguration(): `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.html) | +| [getType](get-type.html) | `open fun getType(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + +### Inheritors + +| [TelemetryCorePingBuilder](../-telemetry-core-ping-builder/index.html) | `open class TelemetryCorePingBuilder : `[`TelemetryPingBuilder`](./index.md)
This mobile-specific ping is intended to provide the most critical data in a concise format, allowing for frequent uploads. Since this ping is used to measure retention, it should be sent each time the app is opened. https://gecko.readthedocs.io/en/latest/toolkit/components/telemetry/telemetry/data/core-ping.html | +| [TelemetryEventPingBuilder](../-telemetry-event-ping-builder/index.html) | `open class TelemetryEventPingBuilder : `[`TelemetryPingBuilder`](./index.md)
A telemetry ping builder for pings of type "focus-event". | +| [TelemetryMobileEventPingBuilder](../-telemetry-mobile-event-ping-builder/index.html) | `open class TelemetryMobileEventPingBuilder : `[`TelemetryPingBuilder`](./index.md)
A telemetry ping builder for events of type "mobile-event". See the schema for more details: https://github.com/mozilla-services/mozilla-pipeline-schemas/blob/master/schemas/telemetry/mobile-event/mobile-event.1.schema.json | +| [TelemetryMobileMetricsPingBuilder](../-telemetry-mobile-metrics-ping-builder/index.html) | `open class TelemetryMobileMetricsPingBuilder : `[`TelemetryPingBuilder`](./index.md)
A telemetry ping builder for events of type "mobile-metrics". See the schema for more details: https://github.com/mozilla-services/mozilla-pipeline-schemas/blob/master/schemas/telemetry/mobile-metrics/mobile-metrics.1.schema.json | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-ping/get-document-id.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-ping/get-document-id.md new file mode 100644 index 00000000000..7acab86f2c1 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-ping/get-document-id.md @@ -0,0 +1,9 @@ +--- +title: TelemetryPing.getDocumentId - +--- + +[org.mozilla.telemetry.ping](../index.html) / [TelemetryPing](index.html) / [getDocumentId](./get-document-id.html) + +# getDocumentId + +`open fun getDocumentId(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-ping/get-measurement-results.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-ping/get-measurement-results.md new file mode 100644 index 00000000000..a154d1064ca --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-ping/get-measurement-results.md @@ -0,0 +1,9 @@ +--- +title: TelemetryPing.getMeasurementResults - +--- + +[org.mozilla.telemetry.ping](../index.html) / [TelemetryPing](index.html) / [getMeasurementResults](./get-measurement-results.html) + +# getMeasurementResults + +`open fun getMeasurementResults(): `[`MutableMap`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-map/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`>` \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-ping/get-type.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-ping/get-type.md new file mode 100644 index 00000000000..958cc2bcf7b --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-ping/get-type.md @@ -0,0 +1,9 @@ +--- +title: TelemetryPing.getType - +--- + +[org.mozilla.telemetry.ping](../index.html) / [TelemetryPing](index.html) / [getType](./get-type.html) + +# getType + +`open fun getType(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-ping/get-upload-path.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-ping/get-upload-path.md new file mode 100644 index 00000000000..8928f7770a1 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-ping/get-upload-path.md @@ -0,0 +1,9 @@ +--- +title: TelemetryPing.getUploadPath - +--- + +[org.mozilla.telemetry.ping](../index.html) / [TelemetryPing](index.html) / [getUploadPath](./get-upload-path.html) + +# getUploadPath + +`open fun getUploadPath(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-ping/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-ping/index.md new file mode 100644 index 00000000000..9b5df603e2c --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/-telemetry-ping/index.md @@ -0,0 +1,17 @@ +--- +title: TelemetryPing - +--- + +[org.mozilla.telemetry.ping](../index.html) / [TelemetryPing](./index.html) + +# TelemetryPing + +`open class TelemetryPing` + +### Functions + +| [getDocumentId](get-document-id.html) | `open fun getDocumentId(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [getMeasurementResults](get-measurement-results.html) | `open fun getMeasurementResults(): `[`MutableMap`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-map/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`>` | +| [getType](get-type.html) | `open fun getType(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [getUploadPath](get-upload-path.html) | `open fun getUploadPath(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/index.md new file mode 100644 index 00000000000..ec54a6d9a10 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.ping/index.md @@ -0,0 +1,17 @@ +--- +title: org.mozilla.telemetry.ping - +--- + +[org.mozilla.telemetry.ping](./index.html) + +## Package org.mozilla.telemetry.ping + +### Types + +| [TelemetryCorePingBuilder](-telemetry-core-ping-builder/index.html) | `open class TelemetryCorePingBuilder : `[`TelemetryPingBuilder`](-telemetry-ping-builder/index.html)
This mobile-specific ping is intended to provide the most critical data in a concise format, allowing for frequent uploads. Since this ping is used to measure retention, it should be sent each time the app is opened. https://gecko.readthedocs.io/en/latest/toolkit/components/telemetry/telemetry/data/core-ping.html | +| [TelemetryEventPingBuilder](-telemetry-event-ping-builder/index.html) | `open class TelemetryEventPingBuilder : `[`TelemetryPingBuilder`](-telemetry-ping-builder/index.html)
A telemetry ping builder for pings of type "focus-event". | +| [TelemetryMobileEventPingBuilder](-telemetry-mobile-event-ping-builder/index.html) | `open class TelemetryMobileEventPingBuilder : `[`TelemetryPingBuilder`](-telemetry-ping-builder/index.html)
A telemetry ping builder for events of type "mobile-event". See the schema for more details: https://github.com/mozilla-services/mozilla-pipeline-schemas/blob/master/schemas/telemetry/mobile-event/mobile-event.1.schema.json | +| [TelemetryMobileMetricsPingBuilder](-telemetry-mobile-metrics-ping-builder/index.html) | `open class TelemetryMobileMetricsPingBuilder : `[`TelemetryPingBuilder`](-telemetry-ping-builder/index.html)
A telemetry ping builder for events of type "mobile-metrics". See the schema for more details: https://github.com/mozilla-services/mozilla-pipeline-schemas/blob/master/schemas/telemetry/mobile-metrics/mobile-metrics.1.schema.json | +| [TelemetryPing](-telemetry-ping/index.html) | `open class TelemetryPing` | +| [TelemetryPingBuilder](-telemetry-ping-builder/index.html) | `abstract class TelemetryPingBuilder` | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.schedule.jobscheduler/-job-scheduler-telemetry-scheduler/-init-.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.schedule.jobscheduler/-job-scheduler-telemetry-scheduler/-init-.md new file mode 100644 index 00000000000..47db7866272 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.schedule.jobscheduler/-job-scheduler-telemetry-scheduler/-init-.md @@ -0,0 +1,12 @@ +--- +title: JobSchedulerTelemetryScheduler. - +--- + +[org.mozilla.telemetry.schedule.jobscheduler](../index.html) / [JobSchedulerTelemetryScheduler](index.html) / [<init>](./-init-.html) + +# <init> + +`JobSchedulerTelemetryScheduler()` + +TelemetryScheduler implementation that uses Android's JobScheduler API to schedule ping uploads. + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.schedule.jobscheduler/-job-scheduler-telemetry-scheduler/-j-o-b_-i-d.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.schedule.jobscheduler/-job-scheduler-telemetry-scheduler/-j-o-b_-i-d.md new file mode 100644 index 00000000000..a3acd7d21cc --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.schedule.jobscheduler/-job-scheduler-telemetry-scheduler/-j-o-b_-i-d.md @@ -0,0 +1,9 @@ +--- +title: JobSchedulerTelemetryScheduler.JOB_ID - +--- + +[org.mozilla.telemetry.schedule.jobscheduler](../index.html) / [JobSchedulerTelemetryScheduler](index.html) / [JOB_ID](./-j-o-b_-i-d.html) + +# JOB_ID + +`static val JOB_ID: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.schedule.jobscheduler/-job-scheduler-telemetry-scheduler/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.schedule.jobscheduler/-job-scheduler-telemetry-scheduler/index.md new file mode 100644 index 00000000000..cc19e63d02a --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.schedule.jobscheduler/-job-scheduler-telemetry-scheduler/index.md @@ -0,0 +1,24 @@ +--- +title: JobSchedulerTelemetryScheduler - +--- + +[org.mozilla.telemetry.schedule.jobscheduler](../index.html) / [JobSchedulerTelemetryScheduler](./index.html) + +# JobSchedulerTelemetryScheduler + +`open class JobSchedulerTelemetryScheduler : `[`TelemetryScheduler`](../../org.mozilla.telemetry.schedule/-telemetry-scheduler/index.html) + +TelemetryScheduler implementation that uses Android's JobScheduler API to schedule ping uploads. + +### Constructors + +| [<init>](-init-.html) | `JobSchedulerTelemetryScheduler()`
TelemetryScheduler implementation that uses Android's JobScheduler API to schedule ping uploads. | + +### Properties + +| [JOB_ID](-j-o-b_-i-d.html) | `static val JOB_ID: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | + +### Functions + +| [scheduleUpload](schedule-upload.html) | `open fun scheduleUpload(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.schedule.jobscheduler/-job-scheduler-telemetry-scheduler/schedule-upload.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.schedule.jobscheduler/-job-scheduler-telemetry-scheduler/schedule-upload.md new file mode 100644 index 00000000000..0a7b0c439bc --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.schedule.jobscheduler/-job-scheduler-telemetry-scheduler/schedule-upload.md @@ -0,0 +1,12 @@ +--- +title: JobSchedulerTelemetryScheduler.scheduleUpload - +--- + +[org.mozilla.telemetry.schedule.jobscheduler](../index.html) / [JobSchedulerTelemetryScheduler](index.html) / [scheduleUpload](./schedule-upload.html) + +# scheduleUpload + +`open fun scheduleUpload(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Overrides [TelemetryScheduler.scheduleUpload](../../org.mozilla.telemetry.schedule/-telemetry-scheduler/schedule-upload.html) + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.schedule.jobscheduler/-telemetry-job-service/-init-.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.schedule.jobscheduler/-telemetry-job-service/-init-.md new file mode 100644 index 00000000000..5793869a508 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.schedule.jobscheduler/-telemetry-job-service/-init-.md @@ -0,0 +1,9 @@ +--- +title: TelemetryJobService. - +--- + +[org.mozilla.telemetry.schedule.jobscheduler](../index.html) / [TelemetryJobService](index.html) / [<init>](./-init-.html) + +# <init> + +`TelemetryJobService()` \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.schedule.jobscheduler/-telemetry-job-service/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.schedule.jobscheduler/-telemetry-job-service/index.md new file mode 100644 index 00000000000..d9dcf6c9084 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.schedule.jobscheduler/-telemetry-job-service/index.md @@ -0,0 +1,20 @@ +--- +title: TelemetryJobService - +--- + +[org.mozilla.telemetry.schedule.jobscheduler](../index.html) / [TelemetryJobService](./index.html) + +# TelemetryJobService + +`open class TelemetryJobService : JobService` + +### Constructors + +| [<init>](-init-.html) | `TelemetryJobService()` | + +### Functions + +| [onStartJob](on-start-job.html) | `open fun onStartJob(params: JobParameters): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [onStopJob](on-stop-job.html) | `open fun onStopJob(params: JobParameters): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [uploadPingsInBackground](upload-pings-in-background.html) | `open fun uploadPingsInBackground(task: AsyncTask<`[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`, `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`, `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`>, parameters: JobParameters): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.schedule.jobscheduler/-telemetry-job-service/on-start-job.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.schedule.jobscheduler/-telemetry-job-service/on-start-job.md new file mode 100644 index 00000000000..853057a08d5 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.schedule.jobscheduler/-telemetry-job-service/on-start-job.md @@ -0,0 +1,9 @@ +--- +title: TelemetryJobService.onStartJob - +--- + +[org.mozilla.telemetry.schedule.jobscheduler](../index.html) / [TelemetryJobService](index.html) / [onStartJob](./on-start-job.html) + +# onStartJob + +`open fun onStartJob(params: JobParameters): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.schedule.jobscheduler/-telemetry-job-service/on-stop-job.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.schedule.jobscheduler/-telemetry-job-service/on-stop-job.md new file mode 100644 index 00000000000..28547d3cdd4 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.schedule.jobscheduler/-telemetry-job-service/on-stop-job.md @@ -0,0 +1,9 @@ +--- +title: TelemetryJobService.onStopJob - +--- + +[org.mozilla.telemetry.schedule.jobscheduler](../index.html) / [TelemetryJobService](index.html) / [onStopJob](./on-stop-job.html) + +# onStopJob + +`open fun onStopJob(params: JobParameters): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.schedule.jobscheduler/-telemetry-job-service/upload-pings-in-background.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.schedule.jobscheduler/-telemetry-job-service/upload-pings-in-background.md new file mode 100644 index 00000000000..0c4a940165f --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.schedule.jobscheduler/-telemetry-job-service/upload-pings-in-background.md @@ -0,0 +1,9 @@ +--- +title: TelemetryJobService.uploadPingsInBackground - +--- + +[org.mozilla.telemetry.schedule.jobscheduler](../index.html) / [TelemetryJobService](index.html) / [uploadPingsInBackground](./upload-pings-in-background.html) + +# uploadPingsInBackground + +`open fun uploadPingsInBackground(task: AsyncTask<`[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`, `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`, `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`>, parameters: JobParameters): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.schedule.jobscheduler/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.schedule.jobscheduler/index.md new file mode 100644 index 00000000000..2dbb302308f --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.schedule.jobscheduler/index.md @@ -0,0 +1,13 @@ +--- +title: org.mozilla.telemetry.schedule.jobscheduler - +--- + +[org.mozilla.telemetry.schedule.jobscheduler](./index.html) + +## Package org.mozilla.telemetry.schedule.jobscheduler + +### Types + +| [JobSchedulerTelemetryScheduler](-job-scheduler-telemetry-scheduler/index.html) | `open class JobSchedulerTelemetryScheduler : `[`TelemetryScheduler`](../org.mozilla.telemetry.schedule/-telemetry-scheduler/index.html)
TelemetryScheduler implementation that uses Android's JobScheduler API to schedule ping uploads. | +| [TelemetryJobService](-telemetry-job-service/index.html) | `open class TelemetryJobService : JobService` | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.schedule/-telemetry-scheduler/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.schedule/-telemetry-scheduler/index.md new file mode 100644 index 00000000000..3bf025fcb82 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.schedule/-telemetry-scheduler/index.md @@ -0,0 +1,18 @@ +--- +title: TelemetryScheduler - +--- + +[org.mozilla.telemetry.schedule](../index.html) / [TelemetryScheduler](./index.html) + +# TelemetryScheduler + +`interface TelemetryScheduler` + +### Functions + +| [scheduleUpload](schedule-upload.html) | `abstract fun scheduleUpload(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | + +### Inheritors + +| [JobSchedulerTelemetryScheduler](../../org.mozilla.telemetry.schedule.jobscheduler/-job-scheduler-telemetry-scheduler/index.html) | `open class JobSchedulerTelemetryScheduler : `[`TelemetryScheduler`](./index.md)
TelemetryScheduler implementation that uses Android's JobScheduler API to schedule ping uploads. | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.schedule/-telemetry-scheduler/schedule-upload.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.schedule/-telemetry-scheduler/schedule-upload.md new file mode 100644 index 00000000000..b0917a7bd5f --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.schedule/-telemetry-scheduler/schedule-upload.md @@ -0,0 +1,9 @@ +--- +title: TelemetryScheduler.scheduleUpload - +--- + +[org.mozilla.telemetry.schedule](../index.html) / [TelemetryScheduler](index.html) / [scheduleUpload](./schedule-upload.html) + +# scheduleUpload + +`abstract fun scheduleUpload(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.schedule/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.schedule/index.md new file mode 100644 index 00000000000..7eefc9142c9 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.schedule/index.md @@ -0,0 +1,12 @@ +--- +title: org.mozilla.telemetry.schedule - +--- + +[org.mozilla.telemetry.schedule](./index.html) + +## Package org.mozilla.telemetry.schedule + +### Types + +| [TelemetryScheduler](-telemetry-scheduler/index.html) | `interface TelemetryScheduler` | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.serialize/-j-s-o-n-ping-serializer/-init-.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.serialize/-j-s-o-n-ping-serializer/-init-.md new file mode 100644 index 00000000000..6c170198dc1 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.serialize/-j-s-o-n-ping-serializer/-init-.md @@ -0,0 +1,12 @@ +--- +title: JSONPingSerializer. - +--- + +[org.mozilla.telemetry.serialize](../index.html) / [JSONPingSerializer](index.html) / [<init>](./-init-.html) + +# <init> + +`JSONPingSerializer()` + +TelemetryPingSerializer that uses the org.json library provided by the Android system. + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.serialize/-j-s-o-n-ping-serializer/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.serialize/-j-s-o-n-ping-serializer/index.md new file mode 100644 index 00000000000..edd5dca1268 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.serialize/-j-s-o-n-ping-serializer/index.md @@ -0,0 +1,20 @@ +--- +title: JSONPingSerializer - +--- + +[org.mozilla.telemetry.serialize](../index.html) / [JSONPingSerializer](./index.html) + +# JSONPingSerializer + +`open class JSONPingSerializer : `[`TelemetryPingSerializer`](../-telemetry-ping-serializer/index.html) + +TelemetryPingSerializer that uses the org.json library provided by the Android system. + +### Constructors + +| [<init>](-init-.html) | `JSONPingSerializer()`
TelemetryPingSerializer that uses the org.json library provided by the Android system. | + +### Functions + +| [serialize](serialize.html) | `open fun serialize(ping: `[`TelemetryPing`](../../org.mozilla.telemetry.ping/-telemetry-ping/index.html)`): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.serialize/-j-s-o-n-ping-serializer/serialize.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.serialize/-j-s-o-n-ping-serializer/serialize.md new file mode 100644 index 00000000000..fa620afa0c4 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.serialize/-j-s-o-n-ping-serializer/serialize.md @@ -0,0 +1,12 @@ +--- +title: JSONPingSerializer.serialize - +--- + +[org.mozilla.telemetry.serialize](../index.html) / [JSONPingSerializer](index.html) / [serialize](./serialize.html) + +# serialize + +`open fun serialize(ping: `[`TelemetryPing`](../../org.mozilla.telemetry.ping/-telemetry-ping/index.html)`): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) + +Overrides [TelemetryPingSerializer.serialize](../-telemetry-ping-serializer/serialize.html) + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.serialize/-telemetry-ping-serializer/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.serialize/-telemetry-ping-serializer/index.md new file mode 100644 index 00000000000..8af70e2971f --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.serialize/-telemetry-ping-serializer/index.md @@ -0,0 +1,18 @@ +--- +title: TelemetryPingSerializer - +--- + +[org.mozilla.telemetry.serialize](../index.html) / [TelemetryPingSerializer](./index.html) + +# TelemetryPingSerializer + +`interface TelemetryPingSerializer` + +### Functions + +| [serialize](serialize.html) | `abstract fun serialize(ping: `[`TelemetryPing`](../../org.mozilla.telemetry.ping/-telemetry-ping/index.html)`): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + +### Inheritors + +| [JSONPingSerializer](../-j-s-o-n-ping-serializer/index.html) | `open class JSONPingSerializer : `[`TelemetryPingSerializer`](./index.md)
TelemetryPingSerializer that uses the org.json library provided by the Android system. | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.serialize/-telemetry-ping-serializer/serialize.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.serialize/-telemetry-ping-serializer/serialize.md new file mode 100644 index 00000000000..d2e9f66bbb5 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.serialize/-telemetry-ping-serializer/serialize.md @@ -0,0 +1,9 @@ +--- +title: TelemetryPingSerializer.serialize - +--- + +[org.mozilla.telemetry.serialize](../index.html) / [TelemetryPingSerializer](index.html) / [serialize](./serialize.html) + +# serialize + +`abstract fun serialize(ping: `[`TelemetryPing`](../../org.mozilla.telemetry.ping/-telemetry-ping/index.html)`): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.serialize/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.serialize/index.md new file mode 100644 index 00000000000..2dbb085da7c --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.serialize/index.md @@ -0,0 +1,13 @@ +--- +title: org.mozilla.telemetry.serialize - +--- + +[org.mozilla.telemetry.serialize](./index.html) + +## Package org.mozilla.telemetry.serialize + +### Types + +| [JSONPingSerializer](-j-s-o-n-ping-serializer/index.html) | `open class JSONPingSerializer : `[`TelemetryPingSerializer`](-telemetry-ping-serializer/index.html)
TelemetryPingSerializer that uses the org.json library provided by the Android system. | +| [TelemetryPingSerializer](-telemetry-ping-serializer/index.html) | `interface TelemetryPingSerializer` | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.storage/-file-telemetry-storage/-init-.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.storage/-file-telemetry-storage/-init-.md new file mode 100644 index 00000000000..460abd5fa8f --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.storage/-file-telemetry-storage/-init-.md @@ -0,0 +1,9 @@ +--- +title: FileTelemetryStorage. - +--- + +[org.mozilla.telemetry.storage](../index.html) / [FileTelemetryStorage](index.html) / [<init>](./-init-.html) + +# <init> + +`FileTelemetryStorage(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.html)`, serializer: `[`TelemetryPingSerializer`](../../org.mozilla.telemetry.serialize/-telemetry-ping-serializer/index.html)`)` \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.storage/-file-telemetry-storage/count-stored-pings.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.storage/-file-telemetry-storage/count-stored-pings.md new file mode 100644 index 00000000000..4969e008ee0 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.storage/-file-telemetry-storage/count-stored-pings.md @@ -0,0 +1,12 @@ +--- +title: FileTelemetryStorage.countStoredPings - +--- + +[org.mozilla.telemetry.storage](../index.html) / [FileTelemetryStorage](index.html) / [countStoredPings](./count-stored-pings.html) + +# countStoredPings + +`open fun countStoredPings(pingType: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +Overrides [TelemetryStorage.countStoredPings](../-telemetry-storage/count-stored-pings.html) + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.storage/-file-telemetry-storage/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.storage/-file-telemetry-storage/index.md new file mode 100644 index 00000000000..dd49e6ec2c3 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.storage/-file-telemetry-storage/index.md @@ -0,0 +1,22 @@ +--- +title: FileTelemetryStorage - +--- + +[org.mozilla.telemetry.storage](../index.html) / [FileTelemetryStorage](./index.html) + +# FileTelemetryStorage + +`open class FileTelemetryStorage : `[`TelemetryStorage`](../-telemetry-storage/index.html) + +TelemetryStorage implementation that stores pings as files on disk. + +### Constructors + +| [<init>](-init-.html) | `FileTelemetryStorage(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.html)`, serializer: `[`TelemetryPingSerializer`](../../org.mozilla.telemetry.serialize/-telemetry-ping-serializer/index.html)`)` | + +### Functions + +| [countStoredPings](count-stored-pings.html) | `open fun countStoredPings(pingType: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [process](process.html) | `open fun process(pingType: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, callback: `[`TelemetryStorageCallback`](../-telemetry-storage/-telemetry-storage-callback/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [store](store.html) | `open fun store(ping: `[`TelemetryPing`](../../org.mozilla.telemetry.ping/-telemetry-ping/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.storage/-file-telemetry-storage/process.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.storage/-file-telemetry-storage/process.md new file mode 100644 index 00000000000..a42f4e602c1 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.storage/-file-telemetry-storage/process.md @@ -0,0 +1,12 @@ +--- +title: FileTelemetryStorage.process - +--- + +[org.mozilla.telemetry.storage](../index.html) / [FileTelemetryStorage](index.html) / [process](./process.html) + +# process + +`open fun process(pingType: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, callback: `[`TelemetryStorageCallback`](../-telemetry-storage/-telemetry-storage-callback/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Overrides [TelemetryStorage.process](../-telemetry-storage/process.html) + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.storage/-file-telemetry-storage/store.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.storage/-file-telemetry-storage/store.md new file mode 100644 index 00000000000..5b54b4c20e2 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.storage/-file-telemetry-storage/store.md @@ -0,0 +1,12 @@ +--- +title: FileTelemetryStorage.store - +--- + +[org.mozilla.telemetry.storage](../index.html) / [FileTelemetryStorage](index.html) / [store](./store.html) + +# store + +`open fun store(ping: `[`TelemetryPing`](../../org.mozilla.telemetry.ping/-telemetry-ping/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Overrides [TelemetryStorage.store](../-telemetry-storage/store.html) + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.storage/-telemetry-storage/-telemetry-storage-callback/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.storage/-telemetry-storage/-telemetry-storage-callback/index.md new file mode 100644 index 00000000000..773e4d17259 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.storage/-telemetry-storage/-telemetry-storage-callback/index.md @@ -0,0 +1,14 @@ +--- +title: TelemetryStorage.TelemetryStorageCallback - +--- + +[org.mozilla.telemetry.storage](../../index.html) / [TelemetryStorage](../index.html) / [TelemetryStorageCallback](./index.html) + +# TelemetryStorageCallback + +`interface TelemetryStorageCallback` + +### Functions + +| [onTelemetryPingLoaded](on-telemetry-ping-loaded.html) | `abstract fun onTelemetryPingLoaded(path: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, serializedPing: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.storage/-telemetry-storage/-telemetry-storage-callback/on-telemetry-ping-loaded.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.storage/-telemetry-storage/-telemetry-storage-callback/on-telemetry-ping-loaded.md new file mode 100644 index 00000000000..3516044b2ab --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.storage/-telemetry-storage/-telemetry-storage-callback/on-telemetry-ping-loaded.md @@ -0,0 +1,9 @@ +--- +title: TelemetryStorage.TelemetryStorageCallback.onTelemetryPingLoaded - +--- + +[org.mozilla.telemetry.storage](../../index.html) / [TelemetryStorage](../index.html) / [TelemetryStorageCallback](index.html) / [onTelemetryPingLoaded](./on-telemetry-ping-loaded.html) + +# onTelemetryPingLoaded + +`abstract fun onTelemetryPingLoaded(path: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, serializedPing: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.storage/-telemetry-storage/count-stored-pings.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.storage/-telemetry-storage/count-stored-pings.md new file mode 100644 index 00000000000..219edfe8ace --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.storage/-telemetry-storage/count-stored-pings.md @@ -0,0 +1,9 @@ +--- +title: TelemetryStorage.countStoredPings - +--- + +[org.mozilla.telemetry.storage](../index.html) / [TelemetryStorage](index.html) / [countStoredPings](./count-stored-pings.html) + +# countStoredPings + +`abstract fun countStoredPings(pingType: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.storage/-telemetry-storage/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.storage/-telemetry-storage/index.md new file mode 100644 index 00000000000..19cc21f1204 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.storage/-telemetry-storage/index.md @@ -0,0 +1,24 @@ +--- +title: TelemetryStorage - +--- + +[org.mozilla.telemetry.storage](../index.html) / [TelemetryStorage](./index.html) + +# TelemetryStorage + +`interface TelemetryStorage` + +### Types + +| [TelemetryStorageCallback](-telemetry-storage-callback/index.html) | `interface TelemetryStorageCallback` | + +### Functions + +| [countStoredPings](count-stored-pings.html) | `abstract fun countStoredPings(pingType: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [process](process.html) | `abstract fun process(pingType: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, callback: `[`TelemetryStorageCallback`](-telemetry-storage-callback/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [store](store.html) | `abstract fun store(ping: `[`TelemetryPing`](../../org.mozilla.telemetry.ping/-telemetry-ping/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | + +### Inheritors + +| [FileTelemetryStorage](../-file-telemetry-storage/index.html) | `open class FileTelemetryStorage : `[`TelemetryStorage`](./index.md)
TelemetryStorage implementation that stores pings as files on disk. | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.storage/-telemetry-storage/process.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.storage/-telemetry-storage/process.md new file mode 100644 index 00000000000..60046d12d63 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.storage/-telemetry-storage/process.md @@ -0,0 +1,9 @@ +--- +title: TelemetryStorage.process - +--- + +[org.mozilla.telemetry.storage](../index.html) / [TelemetryStorage](index.html) / [process](./process.html) + +# process + +`abstract fun process(pingType: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, callback: `[`TelemetryStorageCallback`](-telemetry-storage-callback/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.storage/-telemetry-storage/store.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.storage/-telemetry-storage/store.md new file mode 100644 index 00000000000..7f083f57053 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.storage/-telemetry-storage/store.md @@ -0,0 +1,9 @@ +--- +title: TelemetryStorage.store - +--- + +[org.mozilla.telemetry.storage](../index.html) / [TelemetryStorage](index.html) / [store](./store.html) + +# store + +`abstract fun store(ping: `[`TelemetryPing`](../../org.mozilla.telemetry.ping/-telemetry-ping/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.storage/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.storage/index.md new file mode 100644 index 00000000000..b5be8052a5b --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.storage/index.md @@ -0,0 +1,13 @@ +--- +title: org.mozilla.telemetry.storage - +--- + +[org.mozilla.telemetry.storage](./index.html) + +## Package org.mozilla.telemetry.storage + +### Types + +| [FileTelemetryStorage](-file-telemetry-storage/index.html) | `open class FileTelemetryStorage : `[`TelemetryStorage`](-telemetry-storage/index.html)
TelemetryStorage implementation that stores pings as files on disk. | +| [TelemetryStorage](-telemetry-storage/index.html) | `interface TelemetryStorage` | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.util/-context-utils/-init-.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.util/-context-utils/-init-.md new file mode 100644 index 00000000000..93747cf6f9e --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.util/-context-utils/-init-.md @@ -0,0 +1,9 @@ +--- +title: ContextUtils. - +--- + +[org.mozilla.telemetry.util](../index.html) / [ContextUtils](index.html) / [<init>](./-init-.html) + +# <init> + +`ContextUtils()` \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.util/-context-utils/get-app-name.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.util/-context-utils/get-app-name.md new file mode 100644 index 00000000000..0f9a6d3004a --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.util/-context-utils/get-app-name.md @@ -0,0 +1,9 @@ +--- +title: ContextUtils.getAppName - +--- + +[org.mozilla.telemetry.util](../index.html) / [ContextUtils](index.html) / [getAppName](./get-app-name.html) + +# getAppName + +`open static fun getAppName(context: Context): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.util/-context-utils/get-version-code.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.util/-context-utils/get-version-code.md new file mode 100644 index 00000000000..c05f3472a5e --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.util/-context-utils/get-version-code.md @@ -0,0 +1,9 @@ +--- +title: ContextUtils.getVersionCode - +--- + +[org.mozilla.telemetry.util](../index.html) / [ContextUtils](index.html) / [getVersionCode](./get-version-code.html) + +# getVersionCode + +`open static fun getVersionCode(context: Context): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.util/-context-utils/get-version-name.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.util/-context-utils/get-version-name.md new file mode 100644 index 00000000000..e0a3e358791 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.util/-context-utils/get-version-name.md @@ -0,0 +1,9 @@ +--- +title: ContextUtils.getVersionName - +--- + +[org.mozilla.telemetry.util](../index.html) / [ContextUtils](index.html) / [getVersionName](./get-version-name.html) + +# getVersionName + +`open static fun getVersionName(context: Context): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.util/-context-utils/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.util/-context-utils/index.md new file mode 100644 index 00000000000..66864c3fc6d --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.util/-context-utils/index.md @@ -0,0 +1,20 @@ +--- +title: ContextUtils - +--- + +[org.mozilla.telemetry.util](../index.html) / [ContextUtils](./index.html) + +# ContextUtils + +`open class ContextUtils` + +### Constructors + +| [<init>](-init-.html) | `ContextUtils()` | + +### Functions + +| [getAppName](get-app-name.html) | `open static fun getAppName(context: Context): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [getVersionCode](get-version-code.html) | `open static fun getVersionCode(context: Context): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [getVersionName](get-version-name.html) | `open static fun getVersionName(context: Context): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.util/-file-utils/-file-last-modified-comparator/-init-.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.util/-file-utils/-file-last-modified-comparator/-init-.md new file mode 100644 index 00000000000..1300aa86c14 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.util/-file-utils/-file-last-modified-comparator/-init-.md @@ -0,0 +1,9 @@ +--- +title: FileUtils.FileLastModifiedComparator. - +--- + +[org.mozilla.telemetry.util](../../index.html) / [FileUtils](../index.html) / [FileLastModifiedComparator](index.html) / [<init>](./-init-.html) + +# <init> + +`FileLastModifiedComparator()` \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.util/-file-utils/-file-last-modified-comparator/compare.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.util/-file-utils/-file-last-modified-comparator/compare.md new file mode 100644 index 00000000000..fc54f148eb5 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.util/-file-utils/-file-last-modified-comparator/compare.md @@ -0,0 +1,9 @@ +--- +title: FileUtils.FileLastModifiedComparator.compare - +--- + +[org.mozilla.telemetry.util](../../index.html) / [FileUtils](../index.html) / [FileLastModifiedComparator](index.html) / [compare](./compare.html) + +# compare + +`open fun compare(lhs: `[`File`](http://docs.oracle.com/javase/6/docs/api/java/io/File.html)`, rhs: `[`File`](http://docs.oracle.com/javase/6/docs/api/java/io/File.html)`): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.util/-file-utils/-file-last-modified-comparator/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.util/-file-utils/-file-last-modified-comparator/index.md new file mode 100644 index 00000000000..6d1f623a5c5 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.util/-file-utils/-file-last-modified-comparator/index.md @@ -0,0 +1,18 @@ +--- +title: FileUtils.FileLastModifiedComparator - +--- + +[org.mozilla.telemetry.util](../../index.html) / [FileUtils](../index.html) / [FileLastModifiedComparator](./index.html) + +# FileLastModifiedComparator + +`open class FileLastModifiedComparator : `[`Comparator`](http://docs.oracle.com/javase/6/docs/api/java/util/Comparator.html)`<`[`File`](http://docs.oracle.com/javase/6/docs/api/java/io/File.html)`>` + +### Constructors + +| [<init>](-init-.html) | `FileLastModifiedComparator()` | + +### Functions + +| [compare](compare.html) | `open fun compare(lhs: `[`File`](http://docs.oracle.com/javase/6/docs/api/java/io/File.html)`, rhs: `[`File`](http://docs.oracle.com/javase/6/docs/api/java/io/File.html)`): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.util/-file-utils/-filename-regex-filter/-init-.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.util/-file-utils/-filename-regex-filter/-init-.md new file mode 100644 index 00000000000..1914155506a --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.util/-file-utils/-filename-regex-filter/-init-.md @@ -0,0 +1,9 @@ +--- +title: FileUtils.FilenameRegexFilter. - +--- + +[org.mozilla.telemetry.util](../../index.html) / [FileUtils](../index.html) / [FilenameRegexFilter](index.html) / [<init>](./-init-.html) + +# <init> + +`FilenameRegexFilter(pattern: `[`Pattern`](http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html)`)` \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.util/-file-utils/-filename-regex-filter/accept.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.util/-file-utils/-filename-regex-filter/accept.md new file mode 100644 index 00000000000..7b1892025a4 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.util/-file-utils/-filename-regex-filter/accept.md @@ -0,0 +1,9 @@ +--- +title: FileUtils.FilenameRegexFilter.accept - +--- + +[org.mozilla.telemetry.util](../../index.html) / [FileUtils](../index.html) / [FilenameRegexFilter](index.html) / [accept](./accept.html) + +# accept + +`open fun accept(dir: `[`File`](http://docs.oracle.com/javase/6/docs/api/java/io/File.html)`, filename: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.util/-file-utils/-filename-regex-filter/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.util/-file-utils/-filename-regex-filter/index.md new file mode 100644 index 00000000000..e250d3fb76a --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.util/-file-utils/-filename-regex-filter/index.md @@ -0,0 +1,18 @@ +--- +title: FileUtils.FilenameRegexFilter - +--- + +[org.mozilla.telemetry.util](../../index.html) / [FileUtils](../index.html) / [FilenameRegexFilter](./index.html) + +# FilenameRegexFilter + +`open class FilenameRegexFilter : `[`FilenameFilter`](http://docs.oracle.com/javase/6/docs/api/java/io/FilenameFilter.html) + +### Constructors + +| [<init>](-init-.html) | `FilenameRegexFilter(pattern: `[`Pattern`](http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html)`)` | + +### Functions + +| [accept](accept.html) | `open fun accept(dir: `[`File`](http://docs.oracle.com/javase/6/docs/api/java/io/File.html)`, filename: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.util/-file-utils/-init-.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.util/-file-utils/-init-.md new file mode 100644 index 00000000000..b7bf7413dd9 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.util/-file-utils/-init-.md @@ -0,0 +1,9 @@ +--- +title: FileUtils. - +--- + +[org.mozilla.telemetry.util](../index.html) / [FileUtils](index.html) / [<init>](./-init-.html) + +# <init> + +`FileUtils()` \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.util/-file-utils/assert-directory.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.util/-file-utils/assert-directory.md new file mode 100644 index 00000000000..0094d664fbf --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.util/-file-utils/assert-directory.md @@ -0,0 +1,9 @@ +--- +title: FileUtils.assertDirectory - +--- + +[org.mozilla.telemetry.util](../index.html) / [FileUtils](index.html) / [assertDirectory](./assert-directory.html) + +# assertDirectory + +`open static fun assertDirectory(directory: `[`File`](http://docs.oracle.com/javase/6/docs/api/java/io/File.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.util/-file-utils/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.util/-file-utils/index.md new file mode 100644 index 00000000000..9a95f254327 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.util/-file-utils/index.md @@ -0,0 +1,23 @@ +--- +title: FileUtils - +--- + +[org.mozilla.telemetry.util](../index.html) / [FileUtils](./index.html) + +# FileUtils + +`open class FileUtils` + +### Types + +| [FileLastModifiedComparator](-file-last-modified-comparator/index.html) | `open class FileLastModifiedComparator : `[`Comparator`](http://docs.oracle.com/javase/6/docs/api/java/util/Comparator.html)`<`[`File`](http://docs.oracle.com/javase/6/docs/api/java/io/File.html)`>` | +| [FilenameRegexFilter](-filename-regex-filter/index.html) | `open class FilenameRegexFilter : `[`FilenameFilter`](http://docs.oracle.com/javase/6/docs/api/java/io/FilenameFilter.html) | + +### Constructors + +| [<init>](-init-.html) | `FileUtils()` | + +### Functions + +| [assertDirectory](assert-directory.html) | `open static fun assertDirectory(directory: `[`File`](http://docs.oracle.com/javase/6/docs/api/java/io/File.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.util/-i-o-utils/-init-.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.util/-i-o-utils/-init-.md new file mode 100644 index 00000000000..063be09f79a --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.util/-i-o-utils/-init-.md @@ -0,0 +1,9 @@ +--- +title: IOUtils. - +--- + +[org.mozilla.telemetry.util](../index.html) / [IOUtils](index.html) / [<init>](./-init-.html) + +# <init> + +`IOUtils()` \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.util/-i-o-utils/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.util/-i-o-utils/index.md new file mode 100644 index 00000000000..aa3cf219ccf --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.util/-i-o-utils/index.md @@ -0,0 +1,18 @@ +--- +title: IOUtils - +--- + +[org.mozilla.telemetry.util](../index.html) / [IOUtils](./index.html) + +# IOUtils + +`open class IOUtils` + +### Constructors + +| [<init>](-init-.html) | `IOUtils()` | + +### Functions + +| [safeClose](safe-close.html) | `open static fun safeClose(stream: `[`Closeable`](http://docs.oracle.com/javase/6/docs/api/java/io/Closeable.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.util/-i-o-utils/safe-close.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.util/-i-o-utils/safe-close.md new file mode 100644 index 00000000000..9f10b4ed622 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.util/-i-o-utils/safe-close.md @@ -0,0 +1,9 @@ +--- +title: IOUtils.safeClose - +--- + +[org.mozilla.telemetry.util](../index.html) / [IOUtils](index.html) / [safeClose](./safe-close.html) + +# safeClose + +`open static fun safeClose(stream: `[`Closeable`](http://docs.oracle.com/javase/6/docs/api/java/io/Closeable.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.util/-string-utils/-init-.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.util/-string-utils/-init-.md new file mode 100644 index 00000000000..442f6b9e360 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.util/-string-utils/-init-.md @@ -0,0 +1,9 @@ +--- +title: StringUtils. - +--- + +[org.mozilla.telemetry.util](../index.html) / [StringUtils](index.html) / [<init>](./-init-.html) + +# <init> + +`StringUtils()` \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.util/-string-utils/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.util/-string-utils/index.md new file mode 100644 index 00000000000..5f49a86fe02 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.util/-string-utils/index.md @@ -0,0 +1,18 @@ +--- +title: StringUtils - +--- + +[org.mozilla.telemetry.util](../index.html) / [StringUtils](./index.html) + +# StringUtils + +`open class StringUtils` + +### Constructors + +| [<init>](-init-.html) | `StringUtils()` | + +### Functions + +| [safeSubstring](safe-substring.html) | `open static fun safeSubstring(str: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, start: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, end: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.util/-string-utils/safe-substring.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.util/-string-utils/safe-substring.md new file mode 100644 index 00000000000..27bd27502cc --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.util/-string-utils/safe-substring.md @@ -0,0 +1,9 @@ +--- +title: StringUtils.safeSubstring - +--- + +[org.mozilla.telemetry.util](../index.html) / [StringUtils](index.html) / [safeSubstring](./safe-substring.html) + +# safeSubstring + +`open static fun safeSubstring(@NonNull str: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, start: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, end: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry.util/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.util/index.md new file mode 100644 index 00000000000..c127e39cd6f --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry.util/index.md @@ -0,0 +1,15 @@ +--- +title: org.mozilla.telemetry.util - +--- + +[org.mozilla.telemetry.util](./index.html) + +## Package org.mozilla.telemetry.util + +### Types + +| [ContextUtils](-context-utils/index.html) | `open class ContextUtils` | +| [FileUtils](-file-utils/index.html) | `open class FileUtils` | +| [IOUtils](-i-o-utils/index.html) | `open class IOUtils` | +| [StringUtils](-string-utils/index.html) | `open class StringUtils` | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry/-telemetry-holder/-init-.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry/-telemetry-holder/-init-.md new file mode 100644 index 00000000000..8b8807a8acb --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry/-telemetry-holder/-init-.md @@ -0,0 +1,12 @@ +--- +title: TelemetryHolder. - +--- + +[org.mozilla.telemetry](../index.html) / [TelemetryHolder](index.html) / [<init>](./-init-.html) + +# <init> + +`TelemetryHolder()` + +Holder of a static reference to the Telemetry instance. This is required for background services that somehow need to get access to the configuration and storage. This is not particular nice. Hopefully we can replace this with something better. + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry/-telemetry-holder/get.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry/-telemetry-holder/get.md new file mode 100644 index 00000000000..a02cfc23254 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry/-telemetry-holder/get.md @@ -0,0 +1,9 @@ +--- +title: TelemetryHolder.get - +--- + +[org.mozilla.telemetry](../index.html) / [TelemetryHolder](index.html) / [get](./get.html) + +# get + +`open static fun get(): `[`Telemetry`](../-telemetry/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry/-telemetry-holder/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry/-telemetry-holder/index.md new file mode 100644 index 00000000000..77f5bfffcb0 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry/-telemetry-holder/index.md @@ -0,0 +1,21 @@ +--- +title: TelemetryHolder - +--- + +[org.mozilla.telemetry](../index.html) / [TelemetryHolder](./index.html) + +# TelemetryHolder + +`open class TelemetryHolder` + +Holder of a static reference to the Telemetry instance. This is required for background services that somehow need to get access to the configuration and storage. This is not particular nice. Hopefully we can replace this with something better. + +### Constructors + +| [<init>](-init-.html) | `TelemetryHolder()`
Holder of a static reference to the Telemetry instance. This is required for background services that somehow need to get access to the configuration and storage. This is not particular nice. Hopefully we can replace this with something better. | + +### Functions + +| [get](get.html) | `open static fun get(): `[`Telemetry`](../-telemetry/index.html) | +| [set](set.html) | `open static fun set(telemetry: `[`Telemetry`](../-telemetry/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry/-telemetry-holder/set.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry/-telemetry-holder/set.md new file mode 100644 index 00000000000..4f9b8f9596f --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry/-telemetry-holder/set.md @@ -0,0 +1,9 @@ +--- +title: TelemetryHolder.set - +--- + +[org.mozilla.telemetry](../index.html) / [TelemetryHolder](index.html) / [set](./set.html) + +# set + +`open static fun set(telemetry: `[`Telemetry`](../-telemetry/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry/-telemetry/-init-.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry/-telemetry/-init-.md new file mode 100644 index 00000000000..d7562b0158d --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry/-telemetry/-init-.md @@ -0,0 +1,9 @@ +--- +title: Telemetry. - +--- + +[org.mozilla.telemetry](../index.html) / [Telemetry](index.html) / [<init>](./-init-.html) + +# <init> + +`Telemetry(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.html)`, storage: `[`TelemetryStorage`](../../org.mozilla.telemetry.storage/-telemetry-storage/index.html)`, client: `[`TelemetryClient`](../../org.mozilla.telemetry.net/-telemetry-client/index.html)`, scheduler: `[`TelemetryScheduler`](../../org.mozilla.telemetry.schedule/-telemetry-scheduler/index.html)`)` \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry/-telemetry/add-ping-builder.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry/-telemetry/add-ping-builder.md new file mode 100644 index 00000000000..4eb012b097c --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry/-telemetry/add-ping-builder.md @@ -0,0 +1,9 @@ +--- +title: Telemetry.addPingBuilder - +--- + +[org.mozilla.telemetry](../index.html) / [Telemetry](index.html) / [addPingBuilder](./add-ping-builder.html) + +# addPingBuilder + +`open fun addPingBuilder(builder: `[`TelemetryPingBuilder`](../../org.mozilla.telemetry.ping/-telemetry-ping-builder/index.html)`): `[`Telemetry`](index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry/-telemetry/get-builders.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry/-telemetry/get-builders.md new file mode 100644 index 00000000000..d2161bfa9d3 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry/-telemetry/get-builders.md @@ -0,0 +1,9 @@ +--- +title: Telemetry.getBuilders - +--- + +[org.mozilla.telemetry](../index.html) / [Telemetry](index.html) / [getBuilders](./get-builders.html) + +# getBuilders + +`open fun getBuilders(): `[`MutableCollection`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-collection/index.html)`<`[`TelemetryPingBuilder`](../../org.mozilla.telemetry.ping/-telemetry-ping-builder/index.html)`>` \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry/-telemetry/get-client.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry/-telemetry/get-client.md new file mode 100644 index 00000000000..ed00c051b90 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry/-telemetry/get-client.md @@ -0,0 +1,9 @@ +--- +title: Telemetry.getClient - +--- + +[org.mozilla.telemetry](../index.html) / [Telemetry](index.html) / [getClient](./get-client.html) + +# getClient + +`open fun getClient(): `[`TelemetryClient`](../../org.mozilla.telemetry.net/-telemetry-client/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry/-telemetry/get-configuration.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry/-telemetry/get-configuration.md new file mode 100644 index 00000000000..a55b4ccd314 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry/-telemetry/get-configuration.md @@ -0,0 +1,9 @@ +--- +title: Telemetry.getConfiguration - +--- + +[org.mozilla.telemetry](../index.html) / [Telemetry](index.html) / [getConfiguration](./get-configuration.html) + +# getConfiguration + +`open fun getConfiguration(): `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry/-telemetry/get-storage.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry/-telemetry/get-storage.md new file mode 100644 index 00000000000..ee0945d8211 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry/-telemetry/get-storage.md @@ -0,0 +1,9 @@ +--- +title: Telemetry.getStorage - +--- + +[org.mozilla.telemetry](../index.html) / [Telemetry](index.html) / [getStorage](./get-storage.html) + +# getStorage + +`open fun getStorage(): `[`TelemetryStorage`](../../org.mozilla.telemetry.storage/-telemetry-storage/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry/-telemetry/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry/-telemetry/index.md new file mode 100644 index 00000000000..831951a52fa --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry/-telemetry/index.md @@ -0,0 +1,30 @@ +--- +title: Telemetry - +--- + +[org.mozilla.telemetry](../index.html) / [Telemetry](./index.html) + +# Telemetry + +`open class Telemetry` + +### Constructors + +| [<init>](-init-.html) | `Telemetry(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.html)`, storage: `[`TelemetryStorage`](../../org.mozilla.telemetry.storage/-telemetry-storage/index.html)`, client: `[`TelemetryClient`](../../org.mozilla.telemetry.net/-telemetry-client/index.html)`, scheduler: `[`TelemetryScheduler`](../../org.mozilla.telemetry.schedule/-telemetry-scheduler/index.html)`)` | + +### Functions + +| [addPingBuilder](add-ping-builder.html) | `open fun addPingBuilder(builder: `[`TelemetryPingBuilder`](../../org.mozilla.telemetry.ping/-telemetry-ping-builder/index.html)`): `[`Telemetry`](./index.md) | +| [getBuilders](get-builders.html) | `open fun getBuilders(): `[`MutableCollection`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-collection/index.html)`<`[`TelemetryPingBuilder`](../../org.mozilla.telemetry.ping/-telemetry-ping-builder/index.html)`>` | +| [getClient](get-client.html) | `open fun getClient(): `[`TelemetryClient`](../../org.mozilla.telemetry.net/-telemetry-client/index.html) | +| [getConfiguration](get-configuration.html) | `open fun getConfiguration(): `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.html) | +| [getStorage](get-storage.html) | `open fun getStorage(): `[`TelemetryStorage`](../../org.mozilla.telemetry.storage/-telemetry-storage/index.html) | +| [queueEvent](queue-event.html) | `open fun queueEvent(event: `[`TelemetryEvent`](../../org.mozilla.telemetry.event/-telemetry-event/index.html)`): `[`Telemetry`](./index.md) | +| [queuePing](queue-ping.html) | `open fun queuePing(pingType: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Telemetry`](./index.md) | +| [recordActiveExperiments](record-active-experiments.html) | `open fun recordActiveExperiments(activeExperimentsIds: `[`MutableList`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-list/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>): `[`Telemetry`](./index.md)
Records the list of active experiments | +| [recordSearch](record-search.html) | `open fun recordSearch(location: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, identifier: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Telemetry`](./index.md)
Record a search for the given location and search engine identifier. Common location values used by Fennec and Focus: actionbar: the user types in the url bar and hits enter to use the default search engine listitem: the user selects a search engine from the list of secondary search engines at the bottom of the screen suggestion: the user clicks on a search suggestion or, in the case that suggestions are disabled, the row corresponding with the main engine | +| [recordSessionEnd](record-session-end.html) | `open fun recordSessionEnd(): `[`Telemetry`](./index.md) | +| [recordSessionStart](record-session-start.html) | `open fun recordSessionStart(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [scheduleUpload](schedule-upload.html) | `open fun scheduleUpload(): `[`Telemetry`](./index.md) | +| [setDefaultSearchProvider](set-default-search-provider.html) | `open fun setDefaultSearchProvider(provider: `[`DefaultSearchEngineProvider`](../../org.mozilla.telemetry.measurement/-default-search-measurement/-default-search-engine-provider/index.html)`): `[`Telemetry`](./index.md) | + diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry/-telemetry/queue-event.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry/-telemetry/queue-event.md new file mode 100644 index 00000000000..92e3ff64cdc --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry/-telemetry/queue-event.md @@ -0,0 +1,9 @@ +--- +title: Telemetry.queueEvent - +--- + +[org.mozilla.telemetry](../index.html) / [Telemetry](index.html) / [queueEvent](./queue-event.html) + +# queueEvent + +`open fun queueEvent(event: `[`TelemetryEvent`](../../org.mozilla.telemetry.event/-telemetry-event/index.html)`): `[`Telemetry`](index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry/-telemetry/queue-ping.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry/-telemetry/queue-ping.md new file mode 100644 index 00000000000..d2299ba788d --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry/-telemetry/queue-ping.md @@ -0,0 +1,9 @@ +--- +title: Telemetry.queuePing - +--- + +[org.mozilla.telemetry](../index.html) / [Telemetry](index.html) / [queuePing](./queue-ping.html) + +# queuePing + +`open fun queuePing(pingType: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Telemetry`](index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry/-telemetry/record-active-experiments.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry/-telemetry/record-active-experiments.md new file mode 100644 index 00000000000..8ac1512e883 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry/-telemetry/record-active-experiments.md @@ -0,0 +1,15 @@ +--- +title: Telemetry.recordActiveExperiments - +--- + +[org.mozilla.telemetry](../index.html) / [Telemetry](index.html) / [recordActiveExperiments](./record-active-experiments.html) + +# recordActiveExperiments + +`open fun recordActiveExperiments(activeExperimentsIds: `[`MutableList`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-list/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>): `[`Telemetry`](index.html) + +Records the list of active experiments + +### Parameters + +`activeExperimentsIds` - list of active experiments ids \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry/-telemetry/record-search.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry/-telemetry/record-search.md new file mode 100644 index 00000000000..90e230211b3 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry/-telemetry/record-search.md @@ -0,0 +1,17 @@ +--- +title: Telemetry.recordSearch - +--- + +[org.mozilla.telemetry](../index.html) / [Telemetry](index.html) / [recordSearch](./record-search.html) + +# recordSearch + +`open fun recordSearch(@NonNull location: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, @NonNull identifier: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Telemetry`](index.html) + +Record a search for the given location and search engine identifier. Common location values used by Fennec and Focus: actionbar: the user types in the url bar and hits enter to use the default search engine listitem: the user selects a search engine from the list of secondary search engines at the bottom of the screen suggestion: the user clicks on a search suggestion or, in the case that suggestions are disabled, the row corresponding with the main engine + +### Parameters + +`location` - where search was started. + +`identifier` - of the used search engine. \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry/-telemetry/record-session-end.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry/-telemetry/record-session-end.md new file mode 100644 index 00000000000..77b073e235f --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry/-telemetry/record-session-end.md @@ -0,0 +1,9 @@ +--- +title: Telemetry.recordSessionEnd - +--- + +[org.mozilla.telemetry](../index.html) / [Telemetry](index.html) / [recordSessionEnd](./record-session-end.html) + +# recordSessionEnd + +`open fun recordSessionEnd(): `[`Telemetry`](index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry/-telemetry/record-session-start.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry/-telemetry/record-session-start.md new file mode 100644 index 00000000000..10e88b522fe --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry/-telemetry/record-session-start.md @@ -0,0 +1,9 @@ +--- +title: Telemetry.recordSessionStart - +--- + +[org.mozilla.telemetry](../index.html) / [Telemetry](index.html) / [recordSessionStart](./record-session-start.html) + +# recordSessionStart + +`open fun recordSessionStart(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry/-telemetry/schedule-upload.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry/-telemetry/schedule-upload.md new file mode 100644 index 00000000000..72a83643d8c --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry/-telemetry/schedule-upload.md @@ -0,0 +1,9 @@ +--- +title: Telemetry.scheduleUpload - +--- + +[org.mozilla.telemetry](../index.html) / [Telemetry](index.html) / [scheduleUpload](./schedule-upload.html) + +# scheduleUpload + +`open fun scheduleUpload(): `[`Telemetry`](index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry/-telemetry/set-default-search-provider.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry/-telemetry/set-default-search-provider.md new file mode 100644 index 00000000000..5bee2d10ece --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry/-telemetry/set-default-search-provider.md @@ -0,0 +1,9 @@ +--- +title: Telemetry.setDefaultSearchProvider - +--- + +[org.mozilla.telemetry](../index.html) / [Telemetry](index.html) / [setDefaultSearchProvider](./set-default-search-provider.html) + +# setDefaultSearchProvider + +`open fun setDefaultSearchProvider(provider: `[`DefaultSearchEngineProvider`](../../org.mozilla.telemetry.measurement/-default-search-measurement/-default-search-engine-provider/index.html)`): `[`Telemetry`](index.html) \ No newline at end of file diff --git a/docs/api/0.21/service-telemetry/org.mozilla.telemetry/index.md b/docs/api/0.21/service-telemetry/org.mozilla.telemetry/index.md new file mode 100644 index 00000000000..e90708c9e03 --- /dev/null +++ b/docs/api/0.21/service-telemetry/org.mozilla.telemetry/index.md @@ -0,0 +1,13 @@ +--- +title: org.mozilla.telemetry - +--- + +[org.mozilla.telemetry](./index.html) + +## Package org.mozilla.telemetry + +### Types + +| [Telemetry](-telemetry/index.html) | `open class Telemetry` | +| [TelemetryHolder](-telemetry-holder/index.html) | `open class TelemetryHolder`
Holder of a static reference to the Telemetry instance. This is required for background services that somehow need to get access to the configuration and storage. This is not particular nice. Hopefully we can replace this with something better. | + diff --git a/docs/api/0.21/service-telemetry/package-list b/docs/api/0.21/service-telemetry/package-list new file mode 100644 index 00000000000..5ef1779f02c --- /dev/null +++ b/docs/api/0.21/service-telemetry/package-list @@ -0,0 +1,14 @@ +$dokka.format:jekyll +$dokka.linkExtension:html + +org.mozilla.telemetry +org.mozilla.telemetry.config +org.mozilla.telemetry.event +org.mozilla.telemetry.measurement +org.mozilla.telemetry.net +org.mozilla.telemetry.ping +org.mozilla.telemetry.schedule +org.mozilla.telemetry.schedule.jobscheduler +org.mozilla.telemetry.serialize +org.mozilla.telemetry.storage +org.mozilla.telemetry.util diff --git a/docs/api/0.21/support-base/alltypes/index.md b/docs/api/0.21/support-base/alltypes/index.md new file mode 100644 index 00000000000..a2ff5db2fbf --- /dev/null +++ b/docs/api/0.21/support-base/alltypes/index.md @@ -0,0 +1,14 @@ +--- +title: alltypes - +--- + +### All Types + +| [mozilla.components.support.base.log.sink.AndroidLogSink](../mozilla.components.support.base.log.sink/-android-log-sink/index.html) | LogSink implementation that writes to Android's log. | +| [mozilla.components.support.base.observer.Consumable](../mozilla.components.support.base.observer/-consumable/index.html) | A generic wrapper for values that can get consumed. | +| [mozilla.components.support.base.log.Log](../mozilla.components.support.base.log/-log/index.html) | API for logging messages and exceptions. | +| [mozilla.components.support.base.log.sink.LogSink](../mozilla.components.support.base.log.sink/-log-sink/index.html) | | +| [mozilla.components.support.base.log.logger.Logger](../mozilla.components.support.base.log.logger/-logger/index.html) | A wrapper for the Log object providing a more convenient API for logging. | +| [mozilla.components.support.base.observer.Observable](../mozilla.components.support.base.observer/-observable/index.html) | Interface for observables. This interface is implemented by ObserverRegistry so that classes that want to be observable can implement the interface by delegation: | +| [mozilla.components.support.base.observer.ObserverRegistry](../mozilla.components.support.base.observer/-observer-registry/index.html) | A helper for classes that want to get observed. This class keeps track of registered observers and can automatically unregister observers if a LifecycleOwner is provided. | + diff --git a/docs/api/0.21/support-base/index.md b/docs/api/0.21/support-base/index.md new file mode 100644 index 00000000000..80b81d33da0 --- /dev/null +++ b/docs/api/0.21/support-base/index.md @@ -0,0 +1,14 @@ +--- +title: +--- + +### Packages + +| [mozilla.components.support.base.log](mozilla.components.support.base.log/index.html) | | +| [mozilla.components.support.base.log.logger](mozilla.components.support.base.log.logger/index.html) | | +| [mozilla.components.support.base.log.sink](mozilla.components.support.base.log.sink/index.html) | | +| [mozilla.components.support.base.observer](mozilla.components.support.base.observer/index.html) | | + +### Index + +[All Types](alltypes/index.html) \ No newline at end of file diff --git a/docs/api/0.21/support-base/mozilla.components.support.base.log.logger/-logger/-init-.md b/docs/api/0.21/support-base/mozilla.components.support.base.log.logger/-logger/-init-.md new file mode 100644 index 00000000000..7ff5acc30ed --- /dev/null +++ b/docs/api/0.21/support-base/mozilla.components.support.base.log.logger/-logger/-init-.md @@ -0,0 +1,15 @@ +--- +title: Logger. - +--- + +[mozilla.components.support.base.log.logger](../index.html) / [Logger](index.html) / [<init>](./-init-.html) + +# <init> + +`Logger(tag: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null)` + +A wrapper for the Log object providing a more convenient API for logging. + +### Parameters + +`tag` - The tag to be used for log messages send via this logger. \ No newline at end of file diff --git a/docs/api/0.21/support-base/mozilla.components.support.base.log.logger/-logger/debug.md b/docs/api/0.21/support-base/mozilla.components.support.base.log.logger/-logger/debug.md new file mode 100644 index 00000000000..e4dba9b605c --- /dev/null +++ b/docs/api/0.21/support-base/mozilla.components.support.base.log.logger/-logger/debug.md @@ -0,0 +1,13 @@ +--- +title: Logger.debug - +--- + +[mozilla.components.support.base.log.logger](../index.html) / [Logger](index.html) / [debug](./debug.html) + +# debug + +`fun debug(message: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, throwable: `[`Throwable`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)`? = null): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) +`fun debug(message: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, throwable: `[`Throwable`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)`? = null): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Send a DEBUG log message. + diff --git a/docs/api/0.21/support-base/mozilla.components.support.base.log.logger/-logger/error.md b/docs/api/0.21/support-base/mozilla.components.support.base.log.logger/-logger/error.md new file mode 100644 index 00000000000..dedd5951b1a --- /dev/null +++ b/docs/api/0.21/support-base/mozilla.components.support.base.log.logger/-logger/error.md @@ -0,0 +1,13 @@ +--- +title: Logger.error - +--- + +[mozilla.components.support.base.log.logger](../index.html) / [Logger](index.html) / [error](./error.html) + +# error + +`fun error(message: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, throwable: `[`Throwable`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)`? = null): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) +`fun error(message: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, throwable: `[`Throwable`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)`? = null): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Send a ERROR log message. + diff --git a/docs/api/0.21/support-base/mozilla.components.support.base.log.logger/-logger/index.md b/docs/api/0.21/support-base/mozilla.components.support.base.log.logger/-logger/index.md new file mode 100644 index 00000000000..bf63af339b6 --- /dev/null +++ b/docs/api/0.21/support-base/mozilla.components.support.base.log.logger/-logger/index.md @@ -0,0 +1,36 @@ +--- +title: Logger - +--- + +[mozilla.components.support.base.log.logger](../index.html) / [Logger](./index.html) + +# Logger + +`class Logger` + +A wrapper for the Log object providing a more convenient API for logging. + +### Parameters + +`tag` - The tag to be used for log messages send via this logger. + +### Constructors + +| [<init>](-init-.html) | `Logger(tag: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null)`
A wrapper for the Log object providing a more convenient API for logging. | + +### Functions + +| [debug](debug.html) | `fun debug(message: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, throwable: `[`Throwable`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)`? = null): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Send a DEBUG log message. | +| [error](error.html) | `fun error(message: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, throwable: `[`Throwable`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)`? = null): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Send a ERROR log message. | +| [info](info.html) | `fun info(message: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, throwable: `[`Throwable`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)`? = null): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Send a INFO log message. | +| [measure](measure.html) | `fun measure(message: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, block: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Measure the time it takes to execute the provided block and print a log message before and after executing the block. | +| [warn](warn.html) | `fun warn(message: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, throwable: `[`Throwable`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)`? = null): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Send a WARN log message. | + +### Companion Object Functions + +| [debug](debug.html) | `fun debug(message: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, throwable: `[`Throwable`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)`? = null): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Send a DEBUG log message. | +| [error](error.html) | `fun error(message: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, throwable: `[`Throwable`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)`? = null): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Send a ERROR log message. | +| [info](info.html) | `fun info(message: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, throwable: `[`Throwable`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)`? = null): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Send a INFO log message. | +| [measure](measure.html) | `fun measure(message: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, block: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Measure the time it takes to execute the provided block and print a log message before and after executing the block. | +| [warn](warn.html) | `fun warn(message: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, throwable: `[`Throwable`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)`? = null): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Send a WARN log message. | + diff --git a/docs/api/0.21/support-base/mozilla.components.support.base.log.logger/-logger/info.md b/docs/api/0.21/support-base/mozilla.components.support.base.log.logger/-logger/info.md new file mode 100644 index 00000000000..2eee9f5ff93 --- /dev/null +++ b/docs/api/0.21/support-base/mozilla.components.support.base.log.logger/-logger/info.md @@ -0,0 +1,13 @@ +--- +title: Logger.info - +--- + +[mozilla.components.support.base.log.logger](../index.html) / [Logger](index.html) / [info](./info.html) + +# info + +`fun info(message: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, throwable: `[`Throwable`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)`? = null): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) +`fun info(message: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, throwable: `[`Throwable`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)`? = null): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Send a INFO log message. + diff --git a/docs/api/0.21/support-base/mozilla.components.support.base.log.logger/-logger/measure.md b/docs/api/0.21/support-base/mozilla.components.support.base.log.logger/-logger/measure.md new file mode 100644 index 00000000000..82d0a2e88ea --- /dev/null +++ b/docs/api/0.21/support-base/mozilla.components.support.base.log.logger/-logger/measure.md @@ -0,0 +1,19 @@ +--- +title: Logger.measure - +--- + +[mozilla.components.support.base.log.logger](../index.html) / [Logger](index.html) / [measure](./measure.html) + +# measure + +`fun measure(message: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, block: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) +`fun measure(message: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, block: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Measure the time it takes to execute the provided block and print a log message before and +after executing the block. + +Example log message: +⇢ doSomething() +[..](#) +⇠ doSomething() [12ms](#) + diff --git a/docs/api/0.21/support-base/mozilla.components.support.base.log.logger/-logger/warn.md b/docs/api/0.21/support-base/mozilla.components.support.base.log.logger/-logger/warn.md new file mode 100644 index 00000000000..8e7f7b0910f --- /dev/null +++ b/docs/api/0.21/support-base/mozilla.components.support.base.log.logger/-logger/warn.md @@ -0,0 +1,13 @@ +--- +title: Logger.warn - +--- + +[mozilla.components.support.base.log.logger](../index.html) / [Logger](index.html) / [warn](./warn.html) + +# warn + +`fun warn(message: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, throwable: `[`Throwable`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)`? = null): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) +`fun warn(message: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, throwable: `[`Throwable`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)`? = null): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Send a WARN log message. + diff --git a/docs/api/0.21/support-base/mozilla.components.support.base.log.logger/index.md b/docs/api/0.21/support-base/mozilla.components.support.base.log.logger/index.md new file mode 100644 index 00000000000..82623427bcc --- /dev/null +++ b/docs/api/0.21/support-base/mozilla.components.support.base.log.logger/index.md @@ -0,0 +1,12 @@ +--- +title: mozilla.components.support.base.log.logger - +--- + +[mozilla.components.support.base.log.logger](./index.html) + +## Package mozilla.components.support.base.log.logger + +### Types + +| [Logger](-logger/index.html) | `class Logger`
A wrapper for the Log object providing a more convenient API for logging. | + diff --git a/docs/api/0.21/support-base/mozilla.components.support.base.log.sink/-android-log-sink/-init-.md b/docs/api/0.21/support-base/mozilla.components.support.base.log.sink/-android-log-sink/-init-.md new file mode 100644 index 00000000000..cafa44cc609 --- /dev/null +++ b/docs/api/0.21/support-base/mozilla.components.support.base.log.sink/-android-log-sink/-init-.md @@ -0,0 +1,15 @@ +--- +title: AndroidLogSink. - +--- + +[mozilla.components.support.base.log.sink](../index.html) / [AndroidLogSink](index.html) / [<init>](./-init-.html) + +# <init> + +`AndroidLogSink(defaultTag: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = "App")` + +LogSink implementation that writes to Android's log. + +### Parameters + +`defaultTag` - A default tag that should be used for all logging calls without tag. \ No newline at end of file diff --git a/docs/api/0.21/support-base/mozilla.components.support.base.log.sink/-android-log-sink/index.md b/docs/api/0.21/support-base/mozilla.components.support.base.log.sink/-android-log-sink/index.md new file mode 100644 index 00000000000..d28b07f9a80 --- /dev/null +++ b/docs/api/0.21/support-base/mozilla.components.support.base.log.sink/-android-log-sink/index.md @@ -0,0 +1,24 @@ +--- +title: AndroidLogSink - +--- + +[mozilla.components.support.base.log.sink](../index.html) / [AndroidLogSink](./index.html) + +# AndroidLogSink + +`class AndroidLogSink : `[`LogSink`](../-log-sink/index.html) + +LogSink implementation that writes to Android's log. + +### Parameters + +`defaultTag` - A default tag that should be used for all logging calls without tag. + +### Constructors + +| [<init>](-init-.html) | `AndroidLogSink(defaultTag: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = "App")`
LogSink implementation that writes to Android's log. | + +### Functions + +| [log](log.html) | `fun log(priority: `[`Priority`](../../mozilla.components.support.base.log/-log/-priority/index.html)`, tag: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?, throwable: `[`Throwable`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)`?, message: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Low-level logging call. | + diff --git a/docs/api/0.21/support-base/mozilla.components.support.base.log.sink/-android-log-sink/log.md b/docs/api/0.21/support-base/mozilla.components.support.base.log.sink/-android-log-sink/log.md new file mode 100644 index 00000000000..9633311d22c --- /dev/null +++ b/docs/api/0.21/support-base/mozilla.components.support.base.log.sink/-android-log-sink/log.md @@ -0,0 +1,14 @@ +--- +title: AndroidLogSink.log - +--- + +[mozilla.components.support.base.log.sink](../index.html) / [AndroidLogSink](index.html) / [log](./log.html) + +# log + +`fun log(priority: `[`Priority`](../../mozilla.components.support.base.log/-log/-priority/index.html)`, tag: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?, throwable: `[`Throwable`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)`?, message: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Overrides [LogSink.log](../-log-sink/log.html) + +Low-level logging call. + diff --git a/docs/api/0.21/support-base/mozilla.components.support.base.log.sink/-log-sink/index.md b/docs/api/0.21/support-base/mozilla.components.support.base.log.sink/-log-sink/index.md new file mode 100644 index 00000000000..ea1c7ae9222 --- /dev/null +++ b/docs/api/0.21/support-base/mozilla.components.support.base.log.sink/-log-sink/index.md @@ -0,0 +1,18 @@ +--- +title: LogSink - +--- + +[mozilla.components.support.base.log.sink](../index.html) / [LogSink](./index.html) + +# LogSink + +`interface LogSink` + +### Functions + +| [log](log.html) | `abstract fun log(priority: `[`Priority`](../../mozilla.components.support.base.log/-log/-priority/index.html)` = Log.Priority.DEBUG, tag: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, throwable: `[`Throwable`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)`? = null, message: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | + +### Inheritors + +| [AndroidLogSink](../-android-log-sink/index.html) | `class AndroidLogSink : `[`LogSink`](./index.md)
LogSink implementation that writes to Android's log. | + diff --git a/docs/api/0.21/support-base/mozilla.components.support.base.log.sink/-log-sink/log.md b/docs/api/0.21/support-base/mozilla.components.support.base.log.sink/-log-sink/log.md new file mode 100644 index 00000000000..df87012dce9 --- /dev/null +++ b/docs/api/0.21/support-base/mozilla.components.support.base.log.sink/-log-sink/log.md @@ -0,0 +1,9 @@ +--- +title: LogSink.log - +--- + +[mozilla.components.support.base.log.sink](../index.html) / [LogSink](index.html) / [log](./log.html) + +# log + +`abstract fun log(priority: `[`Priority`](../../mozilla.components.support.base.log/-log/-priority/index.html)` = Log.Priority.DEBUG, tag: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, throwable: `[`Throwable`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)`? = null, message: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/support-base/mozilla.components.support.base.log.sink/index.md b/docs/api/0.21/support-base/mozilla.components.support.base.log.sink/index.md new file mode 100644 index 00000000000..fa0c1839760 --- /dev/null +++ b/docs/api/0.21/support-base/mozilla.components.support.base.log.sink/index.md @@ -0,0 +1,13 @@ +--- +title: mozilla.components.support.base.log.sink - +--- + +[mozilla.components.support.base.log.sink](./index.html) + +## Package mozilla.components.support.base.log.sink + +### Types + +| [AndroidLogSink](-android-log-sink/index.html) | `class AndroidLogSink : `[`LogSink`](-log-sink/index.html)
LogSink implementation that writes to Android's log. | +| [LogSink](-log-sink/index.html) | `interface LogSink` | + diff --git a/docs/api/0.21/support-base/mozilla.components.support.base.observer/-consumable/consume-by.md b/docs/api/0.21/support-base/mozilla.components.support.base.observer/-consumable/consume-by.md new file mode 100644 index 00000000000..a43c7348ea0 --- /dev/null +++ b/docs/api/0.21/support-base/mozilla.components.support.base.observer/-consumable/consume-by.md @@ -0,0 +1,13 @@ +--- +title: Consumable.consumeBy - +--- + +[mozilla.components.support.base.observer](../index.html) / [Consumable](index.html) / [consumeBy](./consume-by.html) + +# consumeBy + +`@Synchronized fun consumeBy(consumers: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<(`[`T`](index.html#T)`) -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`>): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Invokes the given list of lambdas and marks the value as consumed if at least one lambda +returned true. + diff --git a/docs/api/0.21/support-base/mozilla.components.support.base.observer/-consumable/consume.md b/docs/api/0.21/support-base/mozilla.components.support.base.observer/-consumable/consume.md new file mode 100644 index 00000000000..38957a2bd07 --- /dev/null +++ b/docs/api/0.21/support-base/mozilla.components.support.base.observer/-consumable/consume.md @@ -0,0 +1,12 @@ +--- +title: Consumable.consume - +--- + +[mozilla.components.support.base.observer](../index.html) / [Consumable](index.html) / [consume](./consume.html) + +# consume + +`@Synchronized fun consume(consumer: (value: `[`T`](index.html#T)`) -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Invokes the given lambda and marks the value as consumed if the lambda returns true. + diff --git a/docs/api/0.21/support-base/mozilla.components.support.base.observer/-consumable/empty.md b/docs/api/0.21/support-base/mozilla.components.support.base.observer/-consumable/empty.md new file mode 100644 index 00000000000..bc362b7a94e --- /dev/null +++ b/docs/api/0.21/support-base/mozilla.components.support.base.observer/-consumable/empty.md @@ -0,0 +1,12 @@ +--- +title: Consumable.empty - +--- + +[mozilla.components.support.base.observer](../index.html) / [Consumable](index.html) / [empty](./empty.html) + +# empty + +`fun empty(): `[`Consumable`](index.html)`<`[`T`](empty.html#T)`>` + +Returns an empty Consumable with not value as if it was consumed already. + diff --git a/docs/api/0.21/support-base/mozilla.components.support.base.observer/-consumable/from.md b/docs/api/0.21/support-base/mozilla.components.support.base.observer/-consumable/from.md new file mode 100644 index 00000000000..e13f720f356 --- /dev/null +++ b/docs/api/0.21/support-base/mozilla.components.support.base.observer/-consumable/from.md @@ -0,0 +1,12 @@ +--- +title: Consumable.from - +--- + +[mozilla.components.support.base.observer](../index.html) / [Consumable](index.html) / [from](./from.html) + +# from + +`fun from(value: `[`T`](from.html#T)`): `[`Consumable`](index.html)`<`[`T`](from.html#T)`>` + +Create a new Consumable wrapping the given value. + diff --git a/docs/api/0.21/support-base/mozilla.components.support.base.observer/-consumable/index.md b/docs/api/0.21/support-base/mozilla.components.support.base.observer/-consumable/index.md new file mode 100644 index 00000000000..eb03d1999ae --- /dev/null +++ b/docs/api/0.21/support-base/mozilla.components.support.base.observer/-consumable/index.md @@ -0,0 +1,23 @@ +--- +title: Consumable - +--- + +[mozilla.components.support.base.observer](../index.html) / [Consumable](./index.html) + +# Consumable + +`class Consumable` + +A generic wrapper for values that can get consumed. + +### Functions + +| [consume](consume.html) | `fun consume(consumer: (value: `[`T`](index.html#T)`) -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Invokes the given lambda and marks the value as consumed if the lambda returns true. | +| [consumeBy](consume-by.html) | `fun consumeBy(consumers: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<(`[`T`](index.html#T)`) -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`>): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Invokes the given list of lambdas and marks the value as consumed if at least one lambda returned true. | +| [isConsumed](is-consumed.html) | `fun isConsumed(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Returns whether the value was consumed. | + +### Companion Object Functions + +| [empty](empty.html) | `fun empty(): `[`Consumable`](./index.md)`<`[`T`](empty.html#T)`>`
Returns an empty Consumable with not value as if it was consumed already. | +| [from](from.html) | `fun from(value: `[`T`](from.html#T)`): `[`Consumable`](./index.md)`<`[`T`](from.html#T)`>`
Create a new Consumable wrapping the given value. | + diff --git a/docs/api/0.21/support-base/mozilla.components.support.base.observer/-consumable/is-consumed.md b/docs/api/0.21/support-base/mozilla.components.support.base.observer/-consumable/is-consumed.md new file mode 100644 index 00000000000..c3d14878f87 --- /dev/null +++ b/docs/api/0.21/support-base/mozilla.components.support.base.observer/-consumable/is-consumed.md @@ -0,0 +1,12 @@ +--- +title: Consumable.isConsumed - +--- + +[mozilla.components.support.base.observer](../index.html) / [Consumable](index.html) / [isConsumed](./is-consumed.html) + +# isConsumed + +`@Synchronized fun isConsumed(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Returns whether the value was consumed. + diff --git a/docs/api/0.21/support-base/mozilla.components.support.base.observer/-observable/index.md b/docs/api/0.21/support-base/mozilla.components.support.base.observer/-observable/index.md new file mode 100644 index 00000000000..5f0e2e7c85e --- /dev/null +++ b/docs/api/0.21/support-base/mozilla.components.support.base.observer/-observable/index.md @@ -0,0 +1,31 @@ +--- +title: Observable - +--- + +[mozilla.components.support.base.observer](../index.html) / [Observable](./index.html) + +# Observable + +`interface Observable` + +Interface for observables. This interface is implemented by ObserverRegistry so that classes that +want to be observable can implement the interface by delegation: + +``` + class MyObservableClass : Observable by registry { + ... + } +``` + +### Functions + +| [notifyObservers](notify-observers.html) | `abstract fun notifyObservers(block: `[`T`](index.html#T)`.() -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Notify all registered observers about a change. | +| [register](register.html) | `abstract fun register(observer: `[`T`](index.html#T)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
`abstract fun register(observer: `[`T`](index.html#T)`, owner: LifecycleOwner): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
`abstract fun register(observer: `[`T`](index.html#T)`, view: View): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Registers an observer to get notified about changes. | +| [unregister](unregister.html) | `abstract fun unregister(observer: `[`T`](index.html#T)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Unregisters an observer. | +| [unregisterObservers](unregister-observers.html) | `abstract fun unregisterObservers(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Unregisters all observers. | +| [wrapConsumers](wrap-consumers.html) | `abstract fun wrapConsumers(block: `[`T`](index.html#T)`.(`[`R`](wrap-consumers.html#R)`) -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<(`[`R`](wrap-consumers.html#R)`) -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`>`
Returns a list of lambdas wrapping a consuming method of an observer. | + +### Inheritors + +| [ObserverRegistry](../-observer-registry/index.html) | `class ObserverRegistry : `[`Observable`](./index.md)`<`[`T`](../-observer-registry/index.html#T)`>`
A helper for classes that want to get observed. This class keeps track of registered observers and can automatically unregister observers if a LifecycleOwner is provided. | + diff --git a/docs/api/0.21/support-base/mozilla.components.support.base.observer/-observable/notify-observers.md b/docs/api/0.21/support-base/mozilla.components.support.base.observer/-observable/notify-observers.md new file mode 100644 index 00000000000..3418b69d9b7 --- /dev/null +++ b/docs/api/0.21/support-base/mozilla.components.support.base.observer/-observable/notify-observers.md @@ -0,0 +1,12 @@ +--- +title: Observable.notifyObservers - +--- + +[mozilla.components.support.base.observer](../index.html) / [Observable](index.html) / [notifyObservers](./notify-observers.html) + +# notifyObservers + +`abstract fun notifyObservers(block: `[`T`](index.html#T)`.() -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Notify all registered observers about a change. + diff --git a/docs/api/0.21/support-base/mozilla.components.support.base.observer/-observable/register.md b/docs/api/0.21/support-base/mozilla.components.support.base.observer/-observable/register.md new file mode 100644 index 00000000000..a85f507a75c --- /dev/null +++ b/docs/api/0.21/support-base/mozilla.components.support.base.observer/-observable/register.md @@ -0,0 +1,25 @@ +--- +title: Observable.register - +--- + +[mozilla.components.support.base.observer](../index.html) / [Observable](index.html) / [register](./register.html) + +# register + +`abstract fun register(observer: `[`T`](index.html#T)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Registers an observer to get notified about changes. + +`abstract fun register(observer: `[`T`](index.html#T)`, owner: LifecycleOwner): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Registers an observer to get notified about changes. + +The observer will automatically unsubscribe if the lifecycle of the provided LifecycleOwner +becomes DESTROYED. + +`abstract fun register(observer: `[`T`](index.html#T)`, view: View): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Registers an observer to get notified about changes. + +The observer will automatically unsubscribe if the provided view gets detached. + diff --git a/docs/api/0.21/support-base/mozilla.components.support.base.observer/-observable/unregister-observers.md b/docs/api/0.21/support-base/mozilla.components.support.base.observer/-observable/unregister-observers.md new file mode 100644 index 00000000000..22fa20a235f --- /dev/null +++ b/docs/api/0.21/support-base/mozilla.components.support.base.observer/-observable/unregister-observers.md @@ -0,0 +1,12 @@ +--- +title: Observable.unregisterObservers - +--- + +[mozilla.components.support.base.observer](../index.html) / [Observable](index.html) / [unregisterObservers](./unregister-observers.html) + +# unregisterObservers + +`abstract fun unregisterObservers(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Unregisters all observers. + diff --git a/docs/api/0.21/support-base/mozilla.components.support.base.observer/-observable/unregister.md b/docs/api/0.21/support-base/mozilla.components.support.base.observer/-observable/unregister.md new file mode 100644 index 00000000000..f849275988a --- /dev/null +++ b/docs/api/0.21/support-base/mozilla.components.support.base.observer/-observable/unregister.md @@ -0,0 +1,12 @@ +--- +title: Observable.unregister - +--- + +[mozilla.components.support.base.observer](../index.html) / [Observable](index.html) / [unregister](./unregister.html) + +# unregister + +`abstract fun unregister(observer: `[`T`](index.html#T)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Unregisters an observer. + diff --git a/docs/api/0.21/support-base/mozilla.components.support.base.observer/-observable/wrap-consumers.md b/docs/api/0.21/support-base/mozilla.components.support.base.observer/-observable/wrap-consumers.md new file mode 100644 index 00000000000..a0e8080b34d --- /dev/null +++ b/docs/api/0.21/support-base/mozilla.components.support.base.observer/-observable/wrap-consumers.md @@ -0,0 +1,12 @@ +--- +title: Observable.wrapConsumers - +--- + +[mozilla.components.support.base.observer](../index.html) / [Observable](index.html) / [wrapConsumers](./wrap-consumers.html) + +# wrapConsumers + +`abstract fun wrapConsumers(block: `[`T`](index.html#T)`.(`[`R`](wrap-consumers.html#R)`) -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<(`[`R`](wrap-consumers.html#R)`) -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`>` + +Returns a list of lambdas wrapping a consuming method of an observer. + diff --git a/docs/api/0.21/support-base/mozilla.components.support.base.observer/-observer-registry/-init-.md b/docs/api/0.21/support-base/mozilla.components.support.base.observer/-observer-registry/-init-.md new file mode 100644 index 00000000000..81394433d4f --- /dev/null +++ b/docs/api/0.21/support-base/mozilla.components.support.base.observer/-observer-registry/-init-.md @@ -0,0 +1,13 @@ +--- +title: ObserverRegistry. - +--- + +[mozilla.components.support.base.observer](../index.html) / [ObserverRegistry](index.html) / [<init>](./-init-.html) + +# <init> + +`ObserverRegistry()` + +A helper for classes that want to get observed. This class keeps track of registered observers +and can automatically unregister observers if a LifecycleOwner is provided. + diff --git a/docs/api/0.21/support-base/mozilla.components.support.base.observer/-observer-registry/index.md b/docs/api/0.21/support-base/mozilla.components.support.base.observer/-observer-registry/index.md new file mode 100644 index 00000000000..17716ec5858 --- /dev/null +++ b/docs/api/0.21/support-base/mozilla.components.support.base.observer/-observer-registry/index.md @@ -0,0 +1,25 @@ +--- +title: ObserverRegistry - +--- + +[mozilla.components.support.base.observer](../index.html) / [ObserverRegistry](./index.html) + +# ObserverRegistry + +`class ObserverRegistry : `[`Observable`](../-observable/index.html)`<`[`T`](index.html#T)`>` + +A helper for classes that want to get observed. This class keeps track of registered observers +and can automatically unregister observers if a LifecycleOwner is provided. + +### Constructors + +| [<init>](-init-.html) | `ObserverRegistry()`
A helper for classes that want to get observed. This class keeps track of registered observers and can automatically unregister observers if a LifecycleOwner is provided. | + +### Functions + +| [notifyObservers](notify-observers.html) | `fun notifyObservers(block: `[`T`](index.html#T)`.() -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Notify all registered observers about a change. | +| [register](register.html) | `fun register(observer: `[`T`](index.html#T)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
`fun register(observer: `[`T`](index.html#T)`, owner: LifecycleOwner): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
`fun register(observer: `[`T`](index.html#T)`, view: View): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Registers an observer to get notified about changes. | +| [unregister](unregister.html) | `fun unregister(observer: `[`T`](index.html#T)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Unregisters an observer. | +| [unregisterObservers](unregister-observers.html) | `fun unregisterObservers(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Unregisters all observers. | +| [wrapConsumers](wrap-consumers.html) | `fun wrapConsumers(block: `[`T`](index.html#T)`.(`[`V`](wrap-consumers.html#V)`) -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<(`[`V`](wrap-consumers.html#V)`) -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`>`
Returns a list of lambdas wrapping a consuming method of an observer. | + diff --git a/docs/api/0.21/support-base/mozilla.components.support.base.observer/-observer-registry/notify-observers.md b/docs/api/0.21/support-base/mozilla.components.support.base.observer/-observer-registry/notify-observers.md new file mode 100644 index 00000000000..3942e6329cc --- /dev/null +++ b/docs/api/0.21/support-base/mozilla.components.support.base.observer/-observer-registry/notify-observers.md @@ -0,0 +1,14 @@ +--- +title: ObserverRegistry.notifyObservers - +--- + +[mozilla.components.support.base.observer](../index.html) / [ObserverRegistry](index.html) / [notifyObservers](./notify-observers.html) + +# notifyObservers + +`fun notifyObservers(block: `[`T`](index.html#T)`.() -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Overrides [Observable.notifyObservers](../-observable/notify-observers.html) + +Notify all registered observers about a change. + diff --git a/docs/api/0.21/support-base/mozilla.components.support.base.observer/-observer-registry/register.md b/docs/api/0.21/support-base/mozilla.components.support.base.observer/-observer-registry/register.md new file mode 100644 index 00000000000..3d5d252464e --- /dev/null +++ b/docs/api/0.21/support-base/mozilla.components.support.base.observer/-observer-registry/register.md @@ -0,0 +1,31 @@ +--- +title: ObserverRegistry.register - +--- + +[mozilla.components.support.base.observer](../index.html) / [ObserverRegistry](index.html) / [register](./register.html) + +# register + +`fun register(observer: `[`T`](index.html#T)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Overrides [Observable.register](../-observable/register.html) + +Registers an observer to get notified about changes. + +`fun register(observer: `[`T`](index.html#T)`, owner: LifecycleOwner): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Overrides [Observable.register](../-observable/register.html) + +Registers an observer to get notified about changes. + +The observer will automatically unsubscribe if the lifecycle of the provided LifecycleOwner +becomes DESTROYED. + +`fun register(observer: `[`T`](index.html#T)`, view: View): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Overrides [Observable.register](../-observable/register.html) + +Registers an observer to get notified about changes. + +The observer will automatically unsubscribe if the provided view gets detached. + diff --git a/docs/api/0.21/support-base/mozilla.components.support.base.observer/-observer-registry/unregister-observers.md b/docs/api/0.21/support-base/mozilla.components.support.base.observer/-observer-registry/unregister-observers.md new file mode 100644 index 00000000000..256e2352325 --- /dev/null +++ b/docs/api/0.21/support-base/mozilla.components.support.base.observer/-observer-registry/unregister-observers.md @@ -0,0 +1,14 @@ +--- +title: ObserverRegistry.unregisterObservers - +--- + +[mozilla.components.support.base.observer](../index.html) / [ObserverRegistry](index.html) / [unregisterObservers](./unregister-observers.html) + +# unregisterObservers + +`fun unregisterObservers(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Overrides [Observable.unregisterObservers](../-observable/unregister-observers.html) + +Unregisters all observers. + diff --git a/docs/api/0.21/support-base/mozilla.components.support.base.observer/-observer-registry/unregister.md b/docs/api/0.21/support-base/mozilla.components.support.base.observer/-observer-registry/unregister.md new file mode 100644 index 00000000000..5a54c9b451e --- /dev/null +++ b/docs/api/0.21/support-base/mozilla.components.support.base.observer/-observer-registry/unregister.md @@ -0,0 +1,14 @@ +--- +title: ObserverRegistry.unregister - +--- + +[mozilla.components.support.base.observer](../index.html) / [ObserverRegistry](index.html) / [unregister](./unregister.html) + +# unregister + +`fun unregister(observer: `[`T`](index.html#T)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Overrides [Observable.unregister](../-observable/unregister.html) + +Unregisters an observer. + diff --git a/docs/api/0.21/support-base/mozilla.components.support.base.observer/-observer-registry/wrap-consumers.md b/docs/api/0.21/support-base/mozilla.components.support.base.observer/-observer-registry/wrap-consumers.md new file mode 100644 index 00000000000..c9528beb440 --- /dev/null +++ b/docs/api/0.21/support-base/mozilla.components.support.base.observer/-observer-registry/wrap-consumers.md @@ -0,0 +1,14 @@ +--- +title: ObserverRegistry.wrapConsumers - +--- + +[mozilla.components.support.base.observer](../index.html) / [ObserverRegistry](index.html) / [wrapConsumers](./wrap-consumers.html) + +# wrapConsumers + +`fun wrapConsumers(block: `[`T`](index.html#T)`.(`[`V`](wrap-consumers.html#V)`) -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<(`[`V`](wrap-consumers.html#V)`) -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`>` + +Overrides [Observable.wrapConsumers](../-observable/wrap-consumers.html) + +Returns a list of lambdas wrapping a consuming method of an observer. + diff --git a/docs/api/0.21/support-base/mozilla.components.support.base.observer/index.md b/docs/api/0.21/support-base/mozilla.components.support.base.observer/index.md new file mode 100644 index 00000000000..0448f9d9195 --- /dev/null +++ b/docs/api/0.21/support-base/mozilla.components.support.base.observer/index.md @@ -0,0 +1,14 @@ +--- +title: mozilla.components.support.base.observer - +--- + +[mozilla.components.support.base.observer](./index.html) + +## Package mozilla.components.support.base.observer + +### Types + +| [Consumable](-consumable/index.html) | `class Consumable`
A generic wrapper for values that can get consumed. | +| [Observable](-observable/index.html) | `interface Observable`
Interface for observables. This interface is implemented by ObserverRegistry so that classes that want to be observable can implement the interface by delegation: | +| [ObserverRegistry](-observer-registry/index.html) | `class ObserverRegistry : `[`Observable`](-observable/index.html)`<`[`T`](-observer-registry/index.html#T)`>`
A helper for classes that want to get observed. This class keeps track of registered observers and can automatically unregister observers if a LifecycleOwner is provided. | + diff --git a/docs/api/0.21/support-base/package-list b/docs/api/0.21/support-base/package-list new file mode 100644 index 00000000000..14b79983a71 --- /dev/null +++ b/docs/api/0.21/support-base/package-list @@ -0,0 +1,7 @@ +$dokka.format:jekyll +$dokka.linkExtension:html + +mozilla.components.support.base.log +mozilla.components.support.base.log.logger +mozilla.components.support.base.log.sink +mozilla.components.support.base.observer diff --git a/docs/api/0.21/support-ktx/alltypes/index.md b/docs/api/0.21/support-ktx/alltypes/index.md new file mode 100644 index 00000000000..0ad95dc3064 --- /dev/null +++ b/docs/api/0.21/support-ktx/alltypes/index.md @@ -0,0 +1,18 @@ +--- +title: alltypes - +--- + +### All Types + +| [android.content.res.AssetManager](../mozilla.components.support.ktx.android.content.res/android.content.res.-asset-manager/index.html) (extensions in package mozilla.components.support.ktx.android.content.res) | | +| [android.graphics.Bitmap](../mozilla.components.support.ktx.android.graphics/android.graphics.-bitmap/index.html) (extensions in package mozilla.components.support.ktx.android.graphics) | | +| [kotlin.Char](../mozilla.components.support.ktx.kotlin/kotlin.-char/index.html) (extensions in package mozilla.components.support.ktx.kotlin) | | +| [android.content.Context](../mozilla.components.support.ktx.android.content/android.content.-context/index.html) (extensions in package mozilla.components.support.ktx.android.content) | | +| [android.graphics.drawable.Drawable](../mozilla.components.support.ktx.android.graphics.drawable/android.graphics.drawable.-drawable/index.html) (extensions in package mozilla.components.support.ktx.android.graphics.drawable) | | +| [org.json.JSONArray](../mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-array/index.html) (extensions in package mozilla.components.support.ktx.android.org.json) | | +| [org.json.JSONObject](../mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-object/index.html) (extensions in package mozilla.components.support.ktx.android.org.json) | | +| [kotlin.collections.Map](../mozilla.components.support.ktx.kotlin/kotlin.collections.-map/index.html) (extensions in package mozilla.components.support.ktx.kotlin) | | +| [kotlin.String](../mozilla.components.support.ktx.kotlin/kotlin.-string/index.html) (extensions in package mozilla.components.support.ktx.kotlin) | | +| [android.view.View](../mozilla.components.support.ktx.android.view/android.view.-view/index.html) (extensions in package mozilla.components.support.ktx.android.view) | | +| [android.view.ViewGroup](../mozilla.components.support.ktx.android.view/android.view.-view-group/index.html) (extensions in package mozilla.components.support.ktx.android.view) | | + diff --git a/docs/api/0.21/support-ktx/index.md b/docs/api/0.21/support-ktx/index.md new file mode 100644 index 00000000000..9c92946fe35 --- /dev/null +++ b/docs/api/0.21/support-ktx/index.md @@ -0,0 +1,17 @@ +--- +title: +--- + +### Packages + +| [mozilla.components.support.ktx.android.content](mozilla.components.support.ktx.android.content/index.html) | | +| [mozilla.components.support.ktx.android.content.res](mozilla.components.support.ktx.android.content.res/index.html) | | +| [mozilla.components.support.ktx.android.graphics](mozilla.components.support.ktx.android.graphics/index.html) | | +| [mozilla.components.support.ktx.android.graphics.drawable](mozilla.components.support.ktx.android.graphics.drawable/index.html) | | +| [mozilla.components.support.ktx.android.org.json](mozilla.components.support.ktx.android.org.json/index.html) | | +| [mozilla.components.support.ktx.android.view](mozilla.components.support.ktx.android.view/index.html) | | +| [mozilla.components.support.ktx.kotlin](mozilla.components.support.ktx.kotlin/index.html) | | + +### Index + +[All Types](alltypes/index.html) \ No newline at end of file diff --git a/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.content.res/android.content.res.-asset-manager/index.md b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.content.res/android.content.res.-asset-manager/index.md new file mode 100644 index 00000000000..5922dfdae13 --- /dev/null +++ b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.content.res/android.content.res.-asset-manager/index.md @@ -0,0 +1,10 @@ +--- +title: mozilla.components.support.ktx.android.content.res.android.content.res.AssetManager - +--- + +[mozilla.components.support.ktx.android.content.res](../index.html) / [android.content.res.AssetManager](./index.html) + +### Extensions for android.content.res.AssetManager + +| [readJSONObject](read-j-s-o-n-object.html) | `fun AssetManager.readJSONObject(fileName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): JSONObject`
Read a file from the "assets" and create a a JSONObject from its content. | + diff --git a/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.content.res/android.content.res.-asset-manager/read-j-s-o-n-object.md b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.content.res/android.content.res.-asset-manager/read-j-s-o-n-object.md new file mode 100644 index 00000000000..f00b2de3f85 --- /dev/null +++ b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.content.res/android.content.res.-asset-manager/read-j-s-o-n-object.md @@ -0,0 +1,16 @@ +--- +title: readJSONObject - +--- + +[mozilla.components.support.ktx.android.content.res](../index.html) / [android.content.res.AssetManager](index.html) / [readJSONObject](./read-j-s-o-n-object.html) + +# readJSONObject + +`fun AssetManager.readJSONObject(fileName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): JSONObject` + +Read a file from the "assets" and create a a JSONObject from its content. + +### Parameters + +`fileName` - The name of the asset to open. This name can be + hierarchical. \ No newline at end of file diff --git a/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.content.res/index.md b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.content.res/index.md new file mode 100644 index 00000000000..aad2e5bc94a --- /dev/null +++ b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.content.res/index.md @@ -0,0 +1,12 @@ +--- +title: mozilla.components.support.ktx.android.content.res - +--- + +[mozilla.components.support.ktx.android.content.res](./index.html) + +## Package mozilla.components.support.ktx.android.content.res + +### Extensions for External Classes + +| [android.content.res.AssetManager](android.content.res.-asset-manager/index.html) | | + diff --git a/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.content/android.content.-context/app-version-name.md b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.content/android.content.-context/app-version-name.md new file mode 100644 index 00000000000..e0604e70b1a --- /dev/null +++ b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.content/android.content.-context/app-version-name.md @@ -0,0 +1,13 @@ +--- +title: appVersionName - +--- + +[mozilla.components.support.ktx.android.content](../index.html) / [android.content.Context](index.html) / [appVersionName](./app-version-name.html) + +# appVersionName + +`val Context.appVersionName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` + +The (visible) version name of the application, as specified by the tag's versionName +attribute. E.g. "2.0". + diff --git a/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.content/android.content.-context/index.md b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.content/android.content.-context/index.md new file mode 100644 index 00000000000..f1b202ee5f1 --- /dev/null +++ b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.content/android.content.-context/index.md @@ -0,0 +1,11 @@ +--- +title: mozilla.components.support.ktx.android.content.android.content.Context - +--- + +[mozilla.components.support.ktx.android.content](../index.html) / [android.content.Context](./index.html) + +### Extensions for android.content.Context + +| [appVersionName](app-version-name.html) | `val Context.appVersionName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
The (visible) version name of the application, as specified by the tag's versionName attribute. E.g. "2.0". | +| [systemService](system-service.html) | `fun Context.systemService(name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`T`](system-service.html#T)
Returns the handle to a system-level service by name. | + diff --git a/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.content/android.content.-context/system-service.md b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.content/android.content.-context/system-service.md new file mode 100644 index 00000000000..fb1b550334f --- /dev/null +++ b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.content/android.content.-context/system-service.md @@ -0,0 +1,12 @@ +--- +title: systemService - +--- + +[mozilla.components.support.ktx.android.content](../index.html) / [android.content.Context](index.html) / [systemService](./system-service.html) + +# systemService + +`inline fun Context.systemService(name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`T`](system-service.html#T) + +Returns the handle to a system-level service by name. + diff --git a/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.content/index.md b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.content/index.md new file mode 100644 index 00000000000..c2f96a3c5cc --- /dev/null +++ b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.content/index.md @@ -0,0 +1,12 @@ +--- +title: mozilla.components.support.ktx.android.content - +--- + +[mozilla.components.support.ktx.android.content](./index.html) + +## Package mozilla.components.support.ktx.android.content + +### Extensions for External Classes + +| [android.content.Context](android.content.-context/index.html) | | + diff --git a/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.graphics.drawable/android.graphics.drawable.-drawable/index.md b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.graphics.drawable/android.graphics.drawable.-drawable/index.md new file mode 100644 index 00000000000..61c18b506dc --- /dev/null +++ b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.graphics.drawable/android.graphics.drawable.-drawable/index.md @@ -0,0 +1,10 @@ +--- +title: mozilla.components.support.ktx.android.graphics.drawable.android.graphics.drawable.Drawable - +--- + +[mozilla.components.support.ktx.android.graphics.drawable](../index.html) / [android.graphics.drawable.Drawable](./index.html) + +### Extensions for android.graphics.drawable.Drawable + +| [toBitmap](to-bitmap.html) | `fun Drawable.toBitmap(bitmapConfig: Config = Bitmap.Config.ARGB_4444): Bitmap`
Converts a Drawable to Bitmap. via https://stackoverflow.com/a/46018816/2219998. | + diff --git a/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.graphics.drawable/android.graphics.drawable.-drawable/to-bitmap.md b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.graphics.drawable/android.graphics.drawable.-drawable/to-bitmap.md new file mode 100644 index 00000000000..dc769933f26 --- /dev/null +++ b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.graphics.drawable/android.graphics.drawable.-drawable/to-bitmap.md @@ -0,0 +1,12 @@ +--- +title: toBitmap - +--- + +[mozilla.components.support.ktx.android.graphics.drawable](../index.html) / [android.graphics.drawable.Drawable](index.html) / [toBitmap](./to-bitmap.html) + +# toBitmap + +`@JvmOverloads fun Drawable.toBitmap(bitmapConfig: Config = Bitmap.Config.ARGB_4444): Bitmap` + +Converts a Drawable to Bitmap. via https://stackoverflow.com/a/46018816/2219998. + diff --git a/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.graphics.drawable/index.md b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.graphics.drawable/index.md new file mode 100644 index 00000000000..6379a681c21 --- /dev/null +++ b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.graphics.drawable/index.md @@ -0,0 +1,12 @@ +--- +title: mozilla.components.support.ktx.android.graphics.drawable - +--- + +[mozilla.components.support.ktx.android.graphics.drawable](./index.html) + +## Package mozilla.components.support.ktx.android.graphics.drawable + +### Extensions for External Classes + +| [android.graphics.drawable.Drawable](android.graphics.drawable.-drawable/index.html) | | + diff --git a/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.graphics/android.graphics.-bitmap/index.md b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.graphics/android.graphics.-bitmap/index.md new file mode 100644 index 00000000000..cafb91a26fe --- /dev/null +++ b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.graphics/android.graphics.-bitmap/index.md @@ -0,0 +1,10 @@ +--- +title: mozilla.components.support.ktx.android.graphics.android.graphics.Bitmap - +--- + +[mozilla.components.support.ktx.android.graphics](../index.html) / [android.graphics.Bitmap](./index.html) + +### Extensions for android.graphics.Bitmap + +| [toDataUri](to-data-uri.html) | `fun Bitmap.toDataUri(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Transform bitmap into base64 encoded data uri (PNG). | + diff --git a/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.graphics/android.graphics.-bitmap/to-data-uri.md b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.graphics/android.graphics.-bitmap/to-data-uri.md new file mode 100644 index 00000000000..51d17eb59d1 --- /dev/null +++ b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.graphics/android.graphics.-bitmap/to-data-uri.md @@ -0,0 +1,12 @@ +--- +title: toDataUri - +--- + +[mozilla.components.support.ktx.android.graphics](../index.html) / [android.graphics.Bitmap](index.html) / [toDataUri](./to-data-uri.html) + +# toDataUri + +`fun Bitmap.toDataUri(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) + +Transform bitmap into base64 encoded data uri (PNG). + diff --git a/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.graphics/index.md b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.graphics/index.md new file mode 100644 index 00000000000..687a419bf9c --- /dev/null +++ b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.graphics/index.md @@ -0,0 +1,12 @@ +--- +title: mozilla.components.support.ktx.android.graphics - +--- + +[mozilla.components.support.ktx.android.graphics](./index.html) + +## Package mozilla.components.support.ktx.android.graphics + +### Extensions for External Classes + +| [android.graphics.Bitmap](android.graphics.-bitmap/index.html) | | + diff --git a/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.org.json/index.md b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.org.json/index.md new file mode 100644 index 00000000000..9542275f2a0 --- /dev/null +++ b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.org.json/index.md @@ -0,0 +1,13 @@ +--- +title: mozilla.components.support.ktx.android.org.json - +--- + +[mozilla.components.support.ktx.android.org.json](./index.html) + +## Package mozilla.components.support.ktx.android.org.json + +### Extensions for External Classes + +| [org.json.JSONArray](org.json.-j-s-o-n-array/index.html) | | +| [org.json.JSONObject](org.json.-j-s-o-n-object/index.html) | | + diff --git a/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-array/as-sequence.md b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-array/as-sequence.md new file mode 100644 index 00000000000..811f1b1cd6d --- /dev/null +++ b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-array/as-sequence.md @@ -0,0 +1,9 @@ +--- +title: asSequence - +--- + +[mozilla.components.support.ktx.android.org.json](../index.html) / [org.json.JSONArray](index.html) / [asSequence](./as-sequence.html) + +# asSequence + +`fun JSONArray.asSequence(): `[`Sequence`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.sequences/-sequence/index.html)`<`[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`>` \ No newline at end of file diff --git a/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-array/index.md b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-array/index.md new file mode 100644 index 00000000000..d9449662940 --- /dev/null +++ b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-array/index.md @@ -0,0 +1,11 @@ +--- +title: mozilla.components.support.ktx.android.org.json.org.json.JSONArray - +--- + +[mozilla.components.support.ktx.android.org.json](../index.html) / [org.json.JSONArray](./index.html) + +### Extensions for org.json.JSONArray + +| [asSequence](as-sequence.html) | `fun JSONArray.asSequence(): `[`Sequence`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.sequences/-sequence/index.html)`<`[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`>` | +| [toList](to-list.html) | `fun JSONArray?.toList(): `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`T`](to-list.html#T)`>`
Convenience method to convert a JSONArray into a List | + diff --git a/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-array/to-list.md b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-array/to-list.md new file mode 100644 index 00000000000..e1ecf7b80d9 --- /dev/null +++ b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-array/to-list.md @@ -0,0 +1,15 @@ +--- +title: toList - +--- + +[mozilla.components.support.ktx.android.org.json](../index.html) / [org.json.JSONArray](index.html) / [toList](./to-list.html) + +# toList + +`fun JSONArray?.toList(): `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`T`](to-list.html#T)`>` + +Convenience method to convert a JSONArray into a List + +**Return** +list with the JSONArray values, or an empty list if the JSONArray was null + diff --git a/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-object/index.md b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-object/index.md new file mode 100644 index 00000000000..f0e4cb2259c --- /dev/null +++ b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-object/index.md @@ -0,0 +1,14 @@ +--- +title: mozilla.components.support.ktx.android.org.json.org.json.JSONObject - +--- + +[mozilla.components.support.ktx.android.org.json](../index.html) / [org.json.JSONObject](./index.html) + +### Extensions for org.json.JSONObject + +| [putIfNotNull](put-if-not-null.html) | `fun JSONObject.putIfNotNull(key: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, value: `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`?): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Puts the specified value under the key if it's not null | +| [sortKeys](sort-keys.html) | `fun JSONObject.sortKeys(): JSONObject`
Sorts the keys of a JSONObject (and all of its child JSONObjects) alphabetically | +| [tryGetInt](try-get-int.html) | `fun JSONObject.tryGetInt(key: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`?`
Returns the value mapped by {@code key} if it exists, and if the value returned is not null. If it's null, it returns null | +| [tryGetLong](try-get-long.html) | `fun JSONObject.tryGetLong(key: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`?`
Returns the value mapped by {@code key} if it exists, and if the value returned is not null. If it's null, it returns null | +| [tryGetString](try-get-string.html) | `fun JSONObject.tryGetString(key: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
Returns the value mapped by {@code key} if it exists, and if the value returned is not null. If it's null, it returns null | + diff --git a/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-object/put-if-not-null.md b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-object/put-if-not-null.md new file mode 100644 index 00000000000..d900643838e --- /dev/null +++ b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-object/put-if-not-null.md @@ -0,0 +1,12 @@ +--- +title: putIfNotNull - +--- + +[mozilla.components.support.ktx.android.org.json](../index.html) / [org.json.JSONObject](index.html) / [putIfNotNull](./put-if-not-null.html) + +# putIfNotNull + +`fun JSONObject.putIfNotNull(key: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, value: `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`?): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Puts the specified value under the key if it's not null + diff --git a/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-object/sort-keys.md b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-object/sort-keys.md new file mode 100644 index 00000000000..4de70d46da6 --- /dev/null +++ b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-object/sort-keys.md @@ -0,0 +1,12 @@ +--- +title: sortKeys - +--- + +[mozilla.components.support.ktx.android.org.json](../index.html) / [org.json.JSONObject](index.html) / [sortKeys](./sort-keys.html) + +# sortKeys + +`fun JSONObject.sortKeys(): JSONObject` + +Sorts the keys of a JSONObject (and all of its child JSONObjects) alphabetically + diff --git a/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-object/try-get-int.md b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-object/try-get-int.md new file mode 100644 index 00000000000..64db30c37e1 --- /dev/null +++ b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-object/try-get-int.md @@ -0,0 +1,13 @@ +--- +title: tryGetInt - +--- + +[mozilla.components.support.ktx.android.org.json](../index.html) / [org.json.JSONObject](index.html) / [tryGetInt](./try-get-int.html) + +# tryGetInt + +`fun JSONObject.tryGetInt(key: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`?` + +Returns the value mapped by {@code key} if it exists, and +if the value returned is not null. If it's null, it returns null + diff --git a/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-object/try-get-long.md b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-object/try-get-long.md new file mode 100644 index 00000000000..0c598e360e2 --- /dev/null +++ b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-object/try-get-long.md @@ -0,0 +1,13 @@ +--- +title: tryGetLong - +--- + +[mozilla.components.support.ktx.android.org.json](../index.html) / [org.json.JSONObject](index.html) / [tryGetLong](./try-get-long.html) + +# tryGetLong + +`fun JSONObject.tryGetLong(key: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`?` + +Returns the value mapped by {@code key} if it exists, and +if the value returned is not null. If it's null, it returns null + diff --git a/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-object/try-get-string.md b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-object/try-get-string.md new file mode 100644 index 00000000000..47640aafee2 --- /dev/null +++ b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-object/try-get-string.md @@ -0,0 +1,13 @@ +--- +title: tryGetString - +--- + +[mozilla.components.support.ktx.android.org.json](../index.html) / [org.json.JSONObject](index.html) / [tryGetString](./try-get-string.html) + +# tryGetString + +`fun JSONObject.tryGetString(key: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` + +Returns the value mapped by {@code key} if it exists, and +if the value returned is not null. If it's null, it returns null + diff --git a/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.view/android.view.-view-group/for-each.md b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.view/android.view.-view-group/for-each.md new file mode 100644 index 00000000000..00fa629c0fd --- /dev/null +++ b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.view/android.view.-view-group/for-each.md @@ -0,0 +1,12 @@ +--- +title: forEach - +--- + +[mozilla.components.support.ktx.android.view](../index.html) / [android.view.ViewGroup](index.html) / [forEach](./for-each.html) + +# forEach + +`fun ViewGroup.forEach(action: (View) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Performs the given action on each View in this ViewGroup. + diff --git a/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.view/android.view.-view-group/index.md b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.view/android.view.-view-group/index.md new file mode 100644 index 00000000000..93b4126fd59 --- /dev/null +++ b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.view/android.view.-view-group/index.md @@ -0,0 +1,10 @@ +--- +title: mozilla.components.support.ktx.android.view.android.view.ViewGroup - +--- + +[mozilla.components.support.ktx.android.view](../index.html) / [android.view.ViewGroup](./index.html) + +### Extensions for android.view.ViewGroup + +| [forEach](for-each.html) | `fun ViewGroup.forEach(action: (View) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Performs the given action on each View in this ViewGroup. | + diff --git a/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.view/android.view.-view/dp.md b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.view/android.view.-view/dp.md new file mode 100644 index 00000000000..71432a7ebd3 --- /dev/null +++ b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.view/android.view.-view/dp.md @@ -0,0 +1,12 @@ +--- +title: dp - +--- + +[mozilla.components.support.ktx.android.view](../index.html) / [android.view.View](index.html) / [dp](./dp.html) + +# dp + +`fun View.dp(pixels: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +Converts a value in density independent pixels (dp) to the actual pixel values for the display. + diff --git a/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.view/android.view.-view/hide-keyboard.md b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.view/android.view.-view/hide-keyboard.md new file mode 100644 index 00000000000..d98a11db408 --- /dev/null +++ b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.view/android.view.-view/hide-keyboard.md @@ -0,0 +1,12 @@ +--- +title: hideKeyboard - +--- + +[mozilla.components.support.ktx.android.view](../index.html) / [android.view.View](index.html) / [hideKeyboard](./hide-keyboard.html) + +# hideKeyboard + +`fun View.hideKeyboard(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Hides the soft input window. + diff --git a/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.view/android.view.-view/index.md b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.view/android.view.-view/index.md new file mode 100644 index 00000000000..5cfd08b0f4c --- /dev/null +++ b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.view/android.view.-view/index.md @@ -0,0 +1,18 @@ +--- +title: mozilla.components.support.ktx.android.view.android.view.View - +--- + +[mozilla.components.support.ktx.android.view](../index.html) / [android.view.View](./index.html) + +### Extensions for android.view.View + +| [dp](dp.html) | `fun View.dp(pixels: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Converts a value in density independent pixels (dp) to the actual pixel values for the display. | +| [hideKeyboard](hide-keyboard.html) | `fun View.hideKeyboard(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Hides the soft input window. | +| [isGone](is-gone.html) | `fun View.isGone(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Returns true if this view's visibility is set to View.GONE. | +| [isInvisible](is-invisible.html) | `fun View.isInvisible(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Returns true if this view's visibility is set to View.INVISIBLE. | +| [isLTR](is-l-t-r.html) | `val View.isLTR: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Is the horizontal layout direction of this view from Left to Right? | +| [isRTL](is-r-t-l.html) | `val View.isRTL: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Is the horizontal layout direction of this view from Right to Left? | +| [isVisible](is-visible.html) | `fun View.isVisible(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Returns true if this view's visibility is set to View.VISIBLE. | +| [layoutDirection](layout-direction.html) | `val View.layoutDirection: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
The resolved layout direction for this view. | +| [showKeyboard](show-keyboard.html) | `fun View.showKeyboard(flags: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = InputMethodManager.SHOW_IMPLICIT): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Tries to focus this view and show the soft input window for it. | + diff --git a/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.view/android.view.-view/is-gone.md b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.view/android.view.-view/is-gone.md new file mode 100644 index 00000000000..7ec1dca262d --- /dev/null +++ b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.view/android.view.-view/is-gone.md @@ -0,0 +1,12 @@ +--- +title: isGone - +--- + +[mozilla.components.support.ktx.android.view](../index.html) / [android.view.View](index.html) / [isGone](./is-gone.html) + +# isGone + +`fun View.isGone(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Returns true if this view's visibility is set to View.GONE. + diff --git a/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.view/android.view.-view/is-invisible.md b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.view/android.view.-view/is-invisible.md new file mode 100644 index 00000000000..2d40ea62be1 --- /dev/null +++ b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.view/android.view.-view/is-invisible.md @@ -0,0 +1,12 @@ +--- +title: isInvisible - +--- + +[mozilla.components.support.ktx.android.view](../index.html) / [android.view.View](index.html) / [isInvisible](./is-invisible.html) + +# isInvisible + +`fun View.isInvisible(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Returns true if this view's visibility is set to View.INVISIBLE. + diff --git a/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.view/android.view.-view/is-l-t-r.md b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.view/android.view.-view/is-l-t-r.md new file mode 100644 index 00000000000..533216743c0 --- /dev/null +++ b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.view/android.view.-view/is-l-t-r.md @@ -0,0 +1,12 @@ +--- +title: isLTR - +--- + +[mozilla.components.support.ktx.android.view](../index.html) / [android.view.View](index.html) / [isLTR](./is-l-t-r.html) + +# isLTR + +`val View.isLTR: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Is the horizontal layout direction of this view from Left to Right? + diff --git a/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.view/android.view.-view/is-r-t-l.md b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.view/android.view.-view/is-r-t-l.md new file mode 100644 index 00000000000..f6788428692 --- /dev/null +++ b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.view/android.view.-view/is-r-t-l.md @@ -0,0 +1,12 @@ +--- +title: isRTL - +--- + +[mozilla.components.support.ktx.android.view](../index.html) / [android.view.View](index.html) / [isRTL](./is-r-t-l.html) + +# isRTL + +`val View.isRTL: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Is the horizontal layout direction of this view from Right to Left? + diff --git a/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.view/android.view.-view/is-visible.md b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.view/android.view.-view/is-visible.md new file mode 100644 index 00000000000..64a1a54e884 --- /dev/null +++ b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.view/android.view.-view/is-visible.md @@ -0,0 +1,12 @@ +--- +title: isVisible - +--- + +[mozilla.components.support.ktx.android.view](../index.html) / [android.view.View](index.html) / [isVisible](./is-visible.html) + +# isVisible + +`fun View.isVisible(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Returns true if this view's visibility is set to View.VISIBLE. + diff --git a/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.view/android.view.-view/layout-direction.md b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.view/android.view.-view/layout-direction.md new file mode 100644 index 00000000000..66e0e41c0fd --- /dev/null +++ b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.view/android.view.-view/layout-direction.md @@ -0,0 +1,16 @@ +--- +title: layoutDirection - +--- + +[mozilla.components.support.ktx.android.view](../index.html) / [android.view.View](index.html) / [layoutDirection](./layout-direction.html) + +# layoutDirection + +`val View.layoutDirection: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +The resolved layout direction for this view. + +**Return** +{@link #LAYOUT_DIRECTION_RTL} if the layout direction is RTL or returns +{@link #LAYOUT_DIRECTION_LTR} if the layout direction is not RTL. + diff --git a/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.view/android.view.-view/show-keyboard.md b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.view/android.view.-view/show-keyboard.md new file mode 100644 index 00000000000..9610cafa7f1 --- /dev/null +++ b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.view/android.view.-view/show-keyboard.md @@ -0,0 +1,16 @@ +--- +title: showKeyboard - +--- + +[mozilla.components.support.ktx.android.view](../index.html) / [android.view.View](index.html) / [showKeyboard](./show-keyboard.html) + +# showKeyboard + +`fun View.showKeyboard(flags: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = InputMethodManager.SHOW_IMPLICIT): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Tries to focus this view and show the soft input window for it. + +### Parameters + +`flags` - Provides additional operating flags to be used with InputMethodManager.showSoftInput(). +Currently may be 0, SHOW_IMPLICIT or SHOW_FORCED. \ No newline at end of file diff --git a/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.view/index.md b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.view/index.md new file mode 100644 index 00000000000..f090b926dce --- /dev/null +++ b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.android.view/index.md @@ -0,0 +1,13 @@ +--- +title: mozilla.components.support.ktx.android.view - +--- + +[mozilla.components.support.ktx.android.view](./index.html) + +## Package mozilla.components.support.ktx.android.view + +### Extensions for External Classes + +| [android.view.View](android.view.-view/index.html) | | +| [android.view.ViewGroup](android.view.-view-group/index.html) | | + diff --git a/docs/api/0.21/support-ktx/mozilla.components.support.ktx.kotlin/index.md b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.kotlin/index.md new file mode 100644 index 00000000000..7f3858401f5 --- /dev/null +++ b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.kotlin/index.md @@ -0,0 +1,14 @@ +--- +title: mozilla.components.support.ktx.kotlin - +--- + +[mozilla.components.support.ktx.kotlin](./index.html) + +## Package mozilla.components.support.ktx.kotlin + +### Extensions for External Classes + +| [kotlin.Char](kotlin.-char/index.html) | | +| [kotlin.String](kotlin.-string/index.html) | | +| [kotlin.collections.Map](kotlin.collections.-map/index.html) | | + diff --git a/docs/api/0.21/support-ktx/mozilla.components.support.ktx.kotlin/kotlin.-char/-e-l-l-i-p-s-i-s.md b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.kotlin/kotlin.-char/-e-l-l-i-p-s-i-s.md new file mode 100644 index 00000000000..9df6c157559 --- /dev/null +++ b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.kotlin/kotlin.-char/-e-l-l-i-p-s-i-s.md @@ -0,0 +1,13 @@ +--- +title: mozilla.components.support.ktx.kotlin.kotlin.Char.ELLIPSIS - +--- + +[mozilla.components.support.ktx.kotlin](../index.html) / [kotlin.Char](index.html) / [ELLIPSIS](./-e-l-l-i-p-s-i-s.html) + +# ELLIPSIS + +`val `[`Char.Companion`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char/-companion/index.html)`.ELLIPSIS: `[`Char`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char/index.html) + +A series of dots (typically three, such as "…") that usually indicates an intentional omission of +a word, sentence, or whole section from a text without altering its original meaning. + diff --git a/docs/api/0.21/support-ktx/mozilla.components.support.ktx.kotlin/kotlin.-char/index.md b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.kotlin/kotlin.-char/index.md new file mode 100644 index 00000000000..6eae5db3607 --- /dev/null +++ b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.kotlin/kotlin.-char/index.md @@ -0,0 +1,10 @@ +--- +title: mozilla.components.support.ktx.kotlin.kotlin.Char - +--- + +[mozilla.components.support.ktx.kotlin](../index.html) / [kotlin.Char](./index.html) + +### Extensions for kotlin.Char + +| [ELLIPSIS](-e-l-l-i-p-s-i-s.html) | `val `[`Char.Companion`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char/-companion/index.html)`.ELLIPSIS: `[`Char`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char/index.html)
A series of dots (typically three, such as "…") that usually indicates an intentional omission of a word, sentence, or whole section from a text without altering its original meaning. | + diff --git a/docs/api/0.21/support-ktx/mozilla.components.support.ktx.kotlin/kotlin.-string/index.md b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.kotlin/kotlin.-string/index.md new file mode 100644 index 00000000000..9008c0457e6 --- /dev/null +++ b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.kotlin/kotlin.-string/index.md @@ -0,0 +1,14 @@ +--- +title: mozilla.components.support.ktx.kotlin.kotlin.String - +--- + +[mozilla.components.support.ktx.kotlin](../index.html) / [kotlin.String](./index.html) + +### Extensions for kotlin.String + +| [isEmail](is-email.html) | `fun `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`.isEmail(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [isGeoLocation](is-geo-location.html) | `fun `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`.isGeoLocation(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [isPhone](is-phone.html) | `fun `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`.isPhone(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [isUrl](is-url.html) | `fun `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`.isUrl(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Checks if this String is a URL. | +| [toNormalizedUrl](to-normalized-url.html) | `fun `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`.toNormalizedUrl(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Normalizes a URL String. | + diff --git a/docs/api/0.21/support-ktx/mozilla.components.support.ktx.kotlin/kotlin.-string/is-email.md b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.kotlin/kotlin.-string/is-email.md new file mode 100644 index 00000000000..8dc271a2a7a --- /dev/null +++ b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.kotlin/kotlin.-string/is-email.md @@ -0,0 +1,9 @@ +--- +title: isEmail - +--- + +[mozilla.components.support.ktx.kotlin](../index.html) / [kotlin.String](index.html) / [isEmail](./is-email.html) + +# isEmail + +`fun `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`.isEmail(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) \ No newline at end of file diff --git a/docs/api/0.21/support-ktx/mozilla.components.support.ktx.kotlin/kotlin.-string/is-geo-location.md b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.kotlin/kotlin.-string/is-geo-location.md new file mode 100644 index 00000000000..c908a8fc0a3 --- /dev/null +++ b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.kotlin/kotlin.-string/is-geo-location.md @@ -0,0 +1,9 @@ +--- +title: isGeoLocation - +--- + +[mozilla.components.support.ktx.kotlin](../index.html) / [kotlin.String](index.html) / [isGeoLocation](./is-geo-location.html) + +# isGeoLocation + +`fun `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`.isGeoLocation(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) \ No newline at end of file diff --git a/docs/api/0.21/support-ktx/mozilla.components.support.ktx.kotlin/kotlin.-string/is-phone.md b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.kotlin/kotlin.-string/is-phone.md new file mode 100644 index 00000000000..ea8ab66a33b --- /dev/null +++ b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.kotlin/kotlin.-string/is-phone.md @@ -0,0 +1,9 @@ +--- +title: isPhone - +--- + +[mozilla.components.support.ktx.kotlin](../index.html) / [kotlin.String](index.html) / [isPhone](./is-phone.html) + +# isPhone + +`fun `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`.isPhone(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) \ No newline at end of file diff --git a/docs/api/0.21/support-ktx/mozilla.components.support.ktx.kotlin/kotlin.-string/is-url.md b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.kotlin/kotlin.-string/is-url.md new file mode 100644 index 00000000000..1348c9e99b4 --- /dev/null +++ b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.kotlin/kotlin.-string/is-url.md @@ -0,0 +1,12 @@ +--- +title: isUrl - +--- + +[mozilla.components.support.ktx.kotlin](../index.html) / [kotlin.String](index.html) / [isUrl](./is-url.html) + +# isUrl + +`fun `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`.isUrl(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Checks if this String is a URL. + diff --git a/docs/api/0.21/support-ktx/mozilla.components.support.ktx.kotlin/kotlin.-string/to-normalized-url.md b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.kotlin/kotlin.-string/to-normalized-url.md new file mode 100644 index 00000000000..f6201a10474 --- /dev/null +++ b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.kotlin/kotlin.-string/to-normalized-url.md @@ -0,0 +1,12 @@ +--- +title: toNormalizedUrl - +--- + +[mozilla.components.support.ktx.kotlin](../index.html) / [kotlin.String](index.html) / [toNormalizedUrl](./to-normalized-url.html) + +# toNormalizedUrl + +`fun `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`.toNormalizedUrl(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) + +Normalizes a URL String. + diff --git a/docs/api/0.21/support-ktx/mozilla.components.support.ktx.kotlin/kotlin.collections.-map/index.md b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.kotlin/kotlin.collections.-map/index.md new file mode 100644 index 00000000000..b44b67125c6 --- /dev/null +++ b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.kotlin/kotlin.collections.-map/index.md @@ -0,0 +1,10 @@ +--- +title: mozilla.components.support.ktx.kotlin.kotlin.collections.Map - +--- + +[mozilla.components.support.ktx.kotlin](../index.html) / [kotlin.collections.Map](./index.html) + +### Extensions for kotlin.collections.Map + +| [toBundle](to-bundle.html) | `fun `[`Map`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html)`<`[`K`](to-bundle.html#K)`, `[`V`](to-bundle.html#V)`>.toBundle(): Bundle`
Converts a Map to a Bundle | + diff --git a/docs/api/0.21/support-ktx/mozilla.components.support.ktx.kotlin/kotlin.collections.-map/to-bundle.md b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.kotlin/kotlin.collections.-map/to-bundle.md new file mode 100644 index 00000000000..bb583b99735 --- /dev/null +++ b/docs/api/0.21/support-ktx/mozilla.components.support.ktx.kotlin/kotlin.collections.-map/to-bundle.md @@ -0,0 +1,12 @@ +--- +title: toBundle - +--- + +[mozilla.components.support.ktx.kotlin](../index.html) / [kotlin.collections.Map](index.html) / [toBundle](./to-bundle.html) + +# toBundle + +`fun `[`Map`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html)`<`[`K`](to-bundle.html#K)`, `[`V`](to-bundle.html#V)`>.toBundle(): Bundle` + +Converts a Map to a Bundle + diff --git a/docs/api/0.21/support-ktx/package-list b/docs/api/0.21/support-ktx/package-list new file mode 100644 index 00000000000..0c7dd781537 --- /dev/null +++ b/docs/api/0.21/support-ktx/package-list @@ -0,0 +1,38 @@ +$dokka.format:jekyll +$dokka.linkExtension:html +$dokka.location:mozilla.components.support.ktx.android.content$appVersionName#android.content.Contextmozilla.components.support.ktx.android.content/android.content.-context/app-version-name.html +$dokka.location:mozilla.components.support.ktx.android.content$systemService(android.content.Context, kotlin.String)mozilla.components.support.ktx.android.content/android.content.-context/system-service.html +$dokka.location:mozilla.components.support.ktx.android.content.res$readJSONObject(android.content.res.AssetManager, kotlin.String)mozilla.components.support.ktx.android.content.res/android.content.res.-asset-manager/read-j-s-o-n-object.html +$dokka.location:mozilla.components.support.ktx.android.graphics$toDataUri(android.graphics.Bitmap)mozilla.components.support.ktx.android.graphics/android.graphics.-bitmap/to-data-uri.html +$dokka.location:mozilla.components.support.ktx.android.graphics.drawable$toBitmap(android.graphics.drawable.Drawable, android.graphics.Bitmap.Config)mozilla.components.support.ktx.android.graphics.drawable/android.graphics.drawable.-drawable/to-bitmap.html +$dokka.location:mozilla.components.support.ktx.android.org.json$asSequence(org.json.JSONArray)mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-array/as-sequence.html +$dokka.location:mozilla.components.support.ktx.android.org.json$putIfNotNull(org.json.JSONObject, kotlin.String, kotlin.Any)mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-object/put-if-not-null.html +$dokka.location:mozilla.components.support.ktx.android.org.json$sortKeys(org.json.JSONObject)mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-object/sort-keys.html +$dokka.location:mozilla.components.support.ktx.android.org.json$toList(org.json.JSONArray)mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-array/to-list.html +$dokka.location:mozilla.components.support.ktx.android.org.json$tryGetInt(org.json.JSONObject, kotlin.String)mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-object/try-get-int.html +$dokka.location:mozilla.components.support.ktx.android.org.json$tryGetLong(org.json.JSONObject, kotlin.String)mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-object/try-get-long.html +$dokka.location:mozilla.components.support.ktx.android.org.json$tryGetString(org.json.JSONObject, kotlin.String)mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-object/try-get-string.html +$dokka.location:mozilla.components.support.ktx.android.view$dp(android.view.View, kotlin.Int)mozilla.components.support.ktx.android.view/android.view.-view/dp.html +$dokka.location:mozilla.components.support.ktx.android.view$forEach(android.view.ViewGroup, kotlin.Function1((android.view.View, kotlin.Unit)))mozilla.components.support.ktx.android.view/android.view.-view-group/for-each.html +$dokka.location:mozilla.components.support.ktx.android.view$hideKeyboard(android.view.View)mozilla.components.support.ktx.android.view/android.view.-view/hide-keyboard.html +$dokka.location:mozilla.components.support.ktx.android.view$isGone(android.view.View)mozilla.components.support.ktx.android.view/android.view.-view/is-gone.html +$dokka.location:mozilla.components.support.ktx.android.view$isInvisible(android.view.View)mozilla.components.support.ktx.android.view/android.view.-view/is-invisible.html +$dokka.location:mozilla.components.support.ktx.android.view$isLTR#android.view.Viewmozilla.components.support.ktx.android.view/android.view.-view/is-l-t-r.html +$dokka.location:mozilla.components.support.ktx.android.view$isRTL#android.view.Viewmozilla.components.support.ktx.android.view/android.view.-view/is-r-t-l.html +$dokka.location:mozilla.components.support.ktx.android.view$isVisible(android.view.View)mozilla.components.support.ktx.android.view/android.view.-view/is-visible.html +$dokka.location:mozilla.components.support.ktx.android.view$layoutDirection#android.view.Viewmozilla.components.support.ktx.android.view/android.view.-view/layout-direction.html +$dokka.location:mozilla.components.support.ktx.android.view$showKeyboard(android.view.View, kotlin.Int)mozilla.components.support.ktx.android.view/android.view.-view/show-keyboard.html +$dokka.location:mozilla.components.support.ktx.kotlin$ELLIPSIS#kotlin.Char.Companionmozilla.components.support.ktx.kotlin/kotlin.-char/-e-l-l-i-p-s-i-s.html +$dokka.location:mozilla.components.support.ktx.kotlin$isEmail(kotlin.String)mozilla.components.support.ktx.kotlin/kotlin.-string/is-email.html +$dokka.location:mozilla.components.support.ktx.kotlin$isGeoLocation(kotlin.String)mozilla.components.support.ktx.kotlin/kotlin.-string/is-geo-location.html +$dokka.location:mozilla.components.support.ktx.kotlin$isPhone(kotlin.String)mozilla.components.support.ktx.kotlin/kotlin.-string/is-phone.html +$dokka.location:mozilla.components.support.ktx.kotlin$isUrl(kotlin.String)mozilla.components.support.ktx.kotlin/kotlin.-string/is-url.html +$dokka.location:mozilla.components.support.ktx.kotlin$toBundle(kotlin.collections.Map((mozilla.components.support.ktx.kotlin.toBundle.K, mozilla.components.support.ktx.kotlin.toBundle.V)))mozilla.components.support.ktx.kotlin/kotlin.collections.-map/to-bundle.html +$dokka.location:mozilla.components.support.ktx.kotlin$toNormalizedUrl(kotlin.String)mozilla.components.support.ktx.kotlin/kotlin.-string/to-normalized-url.html +mozilla.components.support.ktx.android.content +mozilla.components.support.ktx.android.content.res +mozilla.components.support.ktx.android.graphics +mozilla.components.support.ktx.android.graphics.drawable +mozilla.components.support.ktx.android.org.json +mozilla.components.support.ktx.android.view +mozilla.components.support.ktx.kotlin diff --git a/docs/api/0.21/support-test/alltypes.md b/docs/api/0.21/support-test/alltypes.md new file mode 100644 index 00000000000..14435075dbb --- /dev/null +++ b/docs/api/0.21/support-test/alltypes.md @@ -0,0 +1,6 @@ +--- +title: alltypes - +--- + +### All Types + diff --git a/docs/api/0.21/support-test/index.md b/docs/api/0.21/support-test/index.md new file mode 100644 index 00000000000..9a8cac908be --- /dev/null +++ b/docs/api/0.21/support-test/index.md @@ -0,0 +1,11 @@ +--- +title: +--- + +### Packages + +| [mozilla.components.support.test](mozilla.components.support.test/index.html) | | + +### Index + +[All Types](alltypes.html) \ No newline at end of file diff --git a/docs/api/0.21/support-test/mozilla.components.support.test/any.md b/docs/api/0.21/support-test/mozilla.components.support.test/any.md new file mode 100644 index 00000000000..746bf4b9586 --- /dev/null +++ b/docs/api/0.21/support-test/mozilla.components.support.test/any.md @@ -0,0 +1,14 @@ +--- +title: any - +--- + +[mozilla.components.support.test](index.html) / [any](./any.html) + +# any + +`fun any(): `[`T`](any.html#T) + +Mockito matcher that matches anything, including nulls and varargs. + +(The version from Mockito doesn't work correctly with Kotlin code.) + diff --git a/docs/api/0.21/support-test/mozilla.components.support.test/eq.md b/docs/api/0.21/support-test/mozilla.components.support.test/eq.md new file mode 100644 index 00000000000..4aea650f06d --- /dev/null +++ b/docs/api/0.21/support-test/mozilla.components.support.test/eq.md @@ -0,0 +1,14 @@ +--- +title: eq - +--- + +[mozilla.components.support.test](index.html) / [eq](./eq.html) + +# eq + +`fun eq(value: `[`T`](eq.html#T)`): `[`T`](eq.html#T) + +Mockito matcher that matches if the argument is the same as the provided value. + +(The version from Mockito doesn't work correctly with Kotlin code.) + diff --git a/docs/api/0.21/support-test/mozilla.components.support.test/expect-exception.md b/docs/api/0.21/support-test/mozilla.components.support.test/expect-exception.md new file mode 100644 index 00000000000..25d53aafc09 --- /dev/null +++ b/docs/api/0.21/support-test/mozilla.components.support.test/expect-exception.md @@ -0,0 +1,12 @@ +--- +title: expectException - +--- + +[mozilla.components.support.test](index.html) / [expectException](./expect-exception.html) + +# expectException + +`inline fun expectException(clazz: `[`KClass`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.html)`<`[`T`](expect-exception.html#T)`>, block: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Expect [block](expect-exception.html#mozilla.components.support.test$expectException(kotlin.reflect.KClass((mozilla.components.support.test.expectException.T)), kotlin.Function0((kotlin.Unit)))/block) to throw an exception. Otherwise fail the test (junit). + diff --git a/docs/api/0.21/support-test/mozilla.components.support.test/index.md b/docs/api/0.21/support-test/mozilla.components.support.test/index.md new file mode 100644 index 00000000000..bb3998b5432 --- /dev/null +++ b/docs/api/0.21/support-test/mozilla.components.support.test/index.md @@ -0,0 +1,15 @@ +--- +title: mozilla.components.support.test - +--- + +[mozilla.components.support.test](./index.html) + +## Package mozilla.components.support.test + +### Functions + +| [any](any.html) | `fun any(): `[`T`](any.html#T)
Mockito matcher that matches anything, including nulls and varargs. | +| [eq](eq.html) | `fun eq(value: `[`T`](eq.html#T)`): `[`T`](eq.html#T)
Mockito matcher that matches if the argument is the same as the provided value. | +| [expectException](expect-exception.html) | `fun expectException(clazz: `[`KClass`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.html)`<`[`T`](expect-exception.html#T)`>, block: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Expect [block](expect-exception.html#mozilla.components.support.test$expectException(kotlin.reflect.KClass((mozilla.components.support.test.expectException.T)), kotlin.Function0((kotlin.Unit)))/block) to throw an exception. Otherwise fail the test (junit). | +| [mock](mock.html) | `fun mock(): `[`T`](mock.html#T)
Dynamically create a mock object. This method is helpful when creating mocks of classes using generics. | + diff --git a/docs/api/0.21/support-test/mozilla.components.support.test/mock.md b/docs/api/0.21/support-test/mozilla.components.support.test/mock.md new file mode 100644 index 00000000000..a9ffaf5b3a4 --- /dev/null +++ b/docs/api/0.21/support-test/mozilla.components.support.test/mock.md @@ -0,0 +1,19 @@ +--- +title: mock - +--- + +[mozilla.components.support.test](index.html) / [mock](./mock.html) + +# mock + +`inline fun mock(): `[`T`](mock.html#T) + +Dynamically create a mock object. This method is helpful when creating mocks of classes +using generics. + +Instead of: +val foo = Mockito.mock(....Class of Bar?...) + +You can just use: +val foo: Bar = mock() + diff --git a/docs/api/0.21/support-test/package-list b/docs/api/0.21/support-test/package-list new file mode 100644 index 00000000000..a51db4b0b0d --- /dev/null +++ b/docs/api/0.21/support-test/package-list @@ -0,0 +1,4 @@ +$dokka.format:jekyll +$dokka.linkExtension:html + +mozilla.components.support.test diff --git a/docs/api/0.21/support-utils/alltypes/index.md b/docs/api/0.21/support-utils/alltypes/index.md new file mode 100644 index 00000000000..b71b96960ec --- /dev/null +++ b/docs/api/0.21/support-utils/alltypes/index.md @@ -0,0 +1,15 @@ +--- +title: alltypes - +--- + +### All Types + +| [mozilla.components.support.utils.ColorUtils](../mozilla.components.support.utils/-color-utils/index.html) | | +| [mozilla.components.support.utils.DownloadUtils](../mozilla.components.support.utils/-download-utils/index.html) | | +| [mozilla.components.support.utils.DrawableUtils](../mozilla.components.support.utils/-drawable-utils/index.html) | | +| [mozilla.components.support.utils.SafeBundle](../mozilla.components.support.utils/-safe-bundle/index.html) | See SafeIntent for more background: applications can put garbage values into Bundles. This is primarily experienced when there's garbage in the Intent's Bundle. However that Bundle can contain further bundles, and we need to handle those defensively too. | +| [mozilla.components.support.utils.SafeIntent](../mozilla.components.support.utils/-safe-intent/index.html) | External applications can pass values into Intents that can cause us to crash: in defense, we wrap [Intent](#) and catch the exceptions they may force us to throw. See bug 1090385 for more. | +| [mozilla.components.support.utils.StatusBarUtils](../mozilla.components.support.utils/-status-bar-utils/index.html) | | +| [mozilla.components.support.utils.ThreadUtils](../mozilla.components.support.utils/-thread-utils/index.html) | | +| [mozilla.components.support.utils.WebURLFinder](../mozilla.components.support.utils/-web-u-r-l-finder/index.html) | Regular expressions used in this class are taken from Android's Patterns.java. We brought them in to standardize URL matching across Android versions, instead of relying on Android version-dependent built-ins that can vary across Android versions. The original code can be found here: http://androidxref.com/8.0.0_r4/xref/frameworks/base/core/java/android/util/Patterns.java | + diff --git a/docs/api/0.21/support-utils/index.md b/docs/api/0.21/support-utils/index.md new file mode 100644 index 00000000000..9e896a3dadc --- /dev/null +++ b/docs/api/0.21/support-utils/index.md @@ -0,0 +1,11 @@ +--- +title: +--- + +### Packages + +| [mozilla.components.support.utils](mozilla.components.support.utils/index.html) | | + +### Index + +[All Types](alltypes/index.html) \ No newline at end of file diff --git a/docs/api/0.21/support-utils/mozilla.components.support.utils/-color-utils/get-readable-text-color.md b/docs/api/0.21/support-utils/mozilla.components.support.utils/-color-utils/get-readable-text-color.md new file mode 100644 index 00000000000..706a78e1723 --- /dev/null +++ b/docs/api/0.21/support-utils/mozilla.components.support.utils/-color-utils/get-readable-text-color.md @@ -0,0 +1,12 @@ +--- +title: ColorUtils.getReadableTextColor - +--- + +[mozilla.components.support.utils](../index.html) / [ColorUtils](index.html) / [getReadableTextColor](./get-readable-text-color.html) + +# getReadableTextColor + +`@JvmStatic fun getReadableTextColor(backgroundColor: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +Get text color (white or black) that is readable on top of the provided background color. + diff --git a/docs/api/0.21/support-utils/mozilla.components.support.utils/-color-utils/index.md b/docs/api/0.21/support-utils/mozilla.components.support.utils/-color-utils/index.md new file mode 100644 index 00000000000..ddde2c6e446 --- /dev/null +++ b/docs/api/0.21/support-utils/mozilla.components.support.utils/-color-utils/index.md @@ -0,0 +1,14 @@ +--- +title: ColorUtils - +--- + +[mozilla.components.support.utils](../index.html) / [ColorUtils](./index.html) + +# ColorUtils + +`object ColorUtils` + +### Functions + +| [getReadableTextColor](get-readable-text-color.html) | `fun getReadableTextColor(backgroundColor: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Get text color (white or black) that is readable on top of the provided background color. | + diff --git a/docs/api/0.21/support-utils/mozilla.components.support.utils/-download-utils/guess-file-name.md b/docs/api/0.21/support-utils/mozilla.components.support.utils/-download-utils/guess-file-name.md new file mode 100644 index 00000000000..11d34d58113 --- /dev/null +++ b/docs/api/0.21/support-utils/mozilla.components.support.utils/-download-utils/guess-file-name.md @@ -0,0 +1,15 @@ +--- +title: DownloadUtils.guessFileName - +--- + +[mozilla.components.support.utils](../index.html) / [DownloadUtils](index.html) / [guessFileName](./guess-file-name.html) + +# guessFileName + +`@JvmStatic fun guessFileName(contentDisposition: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?, url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?, mimeType: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) + +Guess the name of the file that should be downloaded. + +This method is largely identical to [android.webkit.URLUtil.guessFileName](#) +which unfortunately does not implement RfC 5987. + diff --git a/docs/api/0.21/support-utils/mozilla.components.support.utils/-download-utils/index.md b/docs/api/0.21/support-utils/mozilla.components.support.utils/-download-utils/index.md new file mode 100644 index 00000000000..54c054f1c1d --- /dev/null +++ b/docs/api/0.21/support-utils/mozilla.components.support.utils/-download-utils/index.md @@ -0,0 +1,14 @@ +--- +title: DownloadUtils - +--- + +[mozilla.components.support.utils](../index.html) / [DownloadUtils](./index.html) + +# DownloadUtils + +`object DownloadUtils` + +### Functions + +| [guessFileName](guess-file-name.html) | `fun guessFileName(contentDisposition: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?, url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?, mimeType: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Guess the name of the file that should be downloaded. | + diff --git a/docs/api/0.21/support-utils/mozilla.components.support.utils/-drawable-utils/index.md b/docs/api/0.21/support-utils/mozilla.components.support.utils/-drawable-utils/index.md new file mode 100644 index 00000000000..fe66ce8bba3 --- /dev/null +++ b/docs/api/0.21/support-utils/mozilla.components.support.utils/-drawable-utils/index.md @@ -0,0 +1,14 @@ +--- +title: DrawableUtils - +--- + +[mozilla.components.support.utils](../index.html) / [DrawableUtils](./index.html) + +# DrawableUtils + +`object DrawableUtils` + +### Functions + +| [loadAndTintDrawable](load-and-tint-drawable.html) | `fun loadAndTintDrawable(context: Context, resourceId: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, color: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): Drawable`
Return a tinted drawable object associated with a particular resource ID. | + diff --git a/docs/api/0.21/support-utils/mozilla.components.support.utils/-drawable-utils/load-and-tint-drawable.md b/docs/api/0.21/support-utils/mozilla.components.support.utils/-drawable-utils/load-and-tint-drawable.md new file mode 100644 index 00000000000..3ee9aa178b8 --- /dev/null +++ b/docs/api/0.21/support-utils/mozilla.components.support.utils/-drawable-utils/load-and-tint-drawable.md @@ -0,0 +1,12 @@ +--- +title: DrawableUtils.loadAndTintDrawable - +--- + +[mozilla.components.support.utils](../index.html) / [DrawableUtils](index.html) / [loadAndTintDrawable](./load-and-tint-drawable.html) + +# loadAndTintDrawable + +`fun loadAndTintDrawable(context: Context, @DrawableRes resourceId: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, color: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): Drawable` + +Return a tinted drawable object associated with a particular resource ID. + diff --git a/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-bundle/-init-.md b/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-bundle/-init-.md new file mode 100644 index 00000000000..6248c72e06a --- /dev/null +++ b/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-bundle/-init-.md @@ -0,0 +1,16 @@ +--- +title: SafeBundle. - +--- + +[mozilla.components.support.utils](../index.html) / [SafeBundle](index.html) / [<init>](./-init-.html) + +# <init> + +`SafeBundle(bundle: Bundle)` + +See SafeIntent for more background: applications can put garbage values into Bundles. This is primarily +experienced when there's garbage in the Intent's Bundle. However that Bundle can contain further bundles, +and we need to handle those defensively too. + +See bug 1090385 for more. + diff --git a/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-bundle/get-parcelable.md b/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-bundle/get-parcelable.md new file mode 100644 index 00000000000..ec3b4483c35 --- /dev/null +++ b/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-bundle/get-parcelable.md @@ -0,0 +1,9 @@ +--- +title: SafeBundle.getParcelable - +--- + +[mozilla.components.support.utils](../index.html) / [SafeBundle](index.html) / [getParcelable](./get-parcelable.html) + +# getParcelable + +`fun getParcelable(name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`T`](get-parcelable.html#T)`?` \ No newline at end of file diff --git a/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-bundle/get-string.md b/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-bundle/get-string.md new file mode 100644 index 00000000000..6666602061a --- /dev/null +++ b/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-bundle/get-string.md @@ -0,0 +1,9 @@ +--- +title: SafeBundle.getString - +--- + +[mozilla.components.support.utils](../index.html) / [SafeBundle](index.html) / [getString](./get-string.html) + +# getString + +`fun getString(name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` \ No newline at end of file diff --git a/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-bundle/index.md b/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-bundle/index.md new file mode 100644 index 00000000000..dfa8cbd76e1 --- /dev/null +++ b/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-bundle/index.md @@ -0,0 +1,25 @@ +--- +title: SafeBundle - +--- + +[mozilla.components.support.utils](../index.html) / [SafeBundle](./index.html) + +# SafeBundle + +`class SafeBundle` + +See SafeIntent for more background: applications can put garbage values into Bundles. This is primarily +experienced when there's garbage in the Intent's Bundle. However that Bundle can contain further bundles, +and we need to handle those defensively too. + +See bug 1090385 for more. + +### Constructors + +| [<init>](-init-.html) | `SafeBundle(bundle: Bundle)`
See SafeIntent for more background: applications can put garbage values into Bundles. This is primarily experienced when there's garbage in the Intent's Bundle. However that Bundle can contain further bundles, and we need to handle those defensively too. | + +### Functions + +| [getParcelable](get-parcelable.html) | `fun getParcelable(name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`T`](get-parcelable.html#T)`?` | +| [getString](get-string.html) | `fun getString(name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` | + diff --git a/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-intent/-init-.md b/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-intent/-init-.md new file mode 100644 index 00000000000..acb9d6e3257 --- /dev/null +++ b/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-intent/-init-.md @@ -0,0 +1,14 @@ +--- +title: SafeIntent. - +--- + +[mozilla.components.support.utils](../index.html) / [SafeIntent](index.html) / [<init>](./-init-.html) + +# <init> + +`SafeIntent(unsafe: Intent)` + +External applications can pass values into Intents that can cause us to crash: in defense, +we wrap [Intent](#) and catch the exceptions they may force us to throw. See bug 1090385 +for more. + diff --git a/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-intent/action.md b/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-intent/action.md new file mode 100644 index 00000000000..ab58b9f4712 --- /dev/null +++ b/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-intent/action.md @@ -0,0 +1,9 @@ +--- +title: SafeIntent.action - +--- + +[mozilla.components.support.utils](../index.html) / [SafeIntent](index.html) / [action](./action.html) + +# action + +`val action: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` \ No newline at end of file diff --git a/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-intent/categories.md b/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-intent/categories.md new file mode 100644 index 00000000000..cfe348af404 --- /dev/null +++ b/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-intent/categories.md @@ -0,0 +1,9 @@ +--- +title: SafeIntent.categories - +--- + +[mozilla.components.support.utils](../index.html) / [SafeIntent](index.html) / [categories](./categories.html) + +# categories + +`val categories: `[`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)`>?` \ No newline at end of file diff --git a/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-intent/data-string.md b/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-intent/data-string.md new file mode 100644 index 00000000000..b0652094c0d --- /dev/null +++ b/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-intent/data-string.md @@ -0,0 +1,9 @@ +--- +title: SafeIntent.dataString - +--- + +[mozilla.components.support.utils](../index.html) / [SafeIntent](index.html) / [dataString](./data-string.html) + +# dataString + +`val dataString: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` \ No newline at end of file diff --git a/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-intent/data.md b/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-intent/data.md new file mode 100644 index 00000000000..4df4f5c6920 --- /dev/null +++ b/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-intent/data.md @@ -0,0 +1,9 @@ +--- +title: SafeIntent.data - +--- + +[mozilla.components.support.utils](../index.html) / [SafeIntent](index.html) / [data](./data.html) + +# data + +`val data: Uri?` \ No newline at end of file diff --git a/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-intent/extras.md b/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-intent/extras.md new file mode 100644 index 00000000000..9c7abb94693 --- /dev/null +++ b/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-intent/extras.md @@ -0,0 +1,9 @@ +--- +title: SafeIntent.extras - +--- + +[mozilla.components.support.utils](../index.html) / [SafeIntent](index.html) / [extras](./extras.html) + +# extras + +`val extras: Bundle?` \ No newline at end of file diff --git a/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-intent/flags.md b/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-intent/flags.md new file mode 100644 index 00000000000..911ecf914c1 --- /dev/null +++ b/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-intent/flags.md @@ -0,0 +1,9 @@ +--- +title: SafeIntent.flags - +--- + +[mozilla.components.support.utils](../index.html) / [SafeIntent](index.html) / [flags](./flags.html) + +# flags + +`val flags: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) \ No newline at end of file diff --git a/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-intent/get-boolean-extra.md b/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-intent/get-boolean-extra.md new file mode 100644 index 00000000000..9f8ef48f402 --- /dev/null +++ b/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-intent/get-boolean-extra.md @@ -0,0 +1,9 @@ +--- +title: SafeIntent.getBooleanExtra - +--- + +[mozilla.components.support.utils](../index.html) / [SafeIntent](index.html) / [getBooleanExtra](./get-boolean-extra.html) + +# getBooleanExtra + +`fun getBooleanExtra(name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, defaultValue: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) \ No newline at end of file diff --git a/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-intent/get-bundle-extra.md b/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-intent/get-bundle-extra.md new file mode 100644 index 00000000000..c0e16e855bd --- /dev/null +++ b/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-intent/get-bundle-extra.md @@ -0,0 +1,9 @@ +--- +title: SafeIntent.getBundleExtra - +--- + +[mozilla.components.support.utils](../index.html) / [SafeIntent](index.html) / [getBundleExtra](./get-bundle-extra.html) + +# getBundleExtra + +`fun getBundleExtra(name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`SafeBundle`](../-safe-bundle/index.html)`?` \ No newline at end of file diff --git a/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-intent/get-char-sequence-extra.md b/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-intent/get-char-sequence-extra.md new file mode 100644 index 00000000000..f111c9d9935 --- /dev/null +++ b/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-intent/get-char-sequence-extra.md @@ -0,0 +1,9 @@ +--- +title: SafeIntent.getCharSequenceExtra - +--- + +[mozilla.components.support.utils](../index.html) / [SafeIntent](index.html) / [getCharSequenceExtra](./get-char-sequence-extra.html) + +# getCharSequenceExtra + +`fun getCharSequenceExtra(name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`CharSequence`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char-sequence/index.html)`?` \ No newline at end of file diff --git a/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-intent/get-int-extra.md b/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-intent/get-int-extra.md new file mode 100644 index 00000000000..9bc2bec273d --- /dev/null +++ b/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-intent/get-int-extra.md @@ -0,0 +1,9 @@ +--- +title: SafeIntent.getIntExtra - +--- + +[mozilla.components.support.utils](../index.html) / [SafeIntent](index.html) / [getIntExtra](./get-int-extra.html) + +# getIntExtra + +`fun getIntExtra(name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, defaultValue: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) \ No newline at end of file diff --git a/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-intent/get-parcelable-array-list-extra.md b/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-intent/get-parcelable-array-list-extra.md new file mode 100644 index 00000000000..3eae54b78c2 --- /dev/null +++ b/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-intent/get-parcelable-array-list-extra.md @@ -0,0 +1,9 @@ +--- +title: SafeIntent.getParcelableArrayListExtra - +--- + +[mozilla.components.support.utils](../index.html) / [SafeIntent](index.html) / [getParcelableArrayListExtra](./get-parcelable-array-list-extra.html) + +# getParcelableArrayListExtra + +`fun getParcelableArrayListExtra(name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`ArrayList`](http://docs.oracle.com/javase/6/docs/api/java/util/ArrayList.html)`<`[`T`](get-parcelable-array-list-extra.html#T)`>?` \ No newline at end of file diff --git a/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-intent/get-parcelable-extra.md b/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-intent/get-parcelable-extra.md new file mode 100644 index 00000000000..7afcc28e343 --- /dev/null +++ b/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-intent/get-parcelable-extra.md @@ -0,0 +1,9 @@ +--- +title: SafeIntent.getParcelableExtra - +--- + +[mozilla.components.support.utils](../index.html) / [SafeIntent](index.html) / [getParcelableExtra](./get-parcelable-extra.html) + +# getParcelableExtra + +`fun getParcelableExtra(name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`T`](get-parcelable-extra.html#T)`?` \ No newline at end of file diff --git a/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-intent/get-string-array-list-extra.md b/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-intent/get-string-array-list-extra.md new file mode 100644 index 00000000000..7daffecc3ef --- /dev/null +++ b/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-intent/get-string-array-list-extra.md @@ -0,0 +1,9 @@ +--- +title: SafeIntent.getStringArrayListExtra - +--- + +[mozilla.components.support.utils](../index.html) / [SafeIntent](index.html) / [getStringArrayListExtra](./get-string-array-list-extra.html) + +# getStringArrayListExtra + +`fun getStringArrayListExtra(name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`ArrayList`](http://docs.oracle.com/javase/6/docs/api/java/util/ArrayList.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>?` \ No newline at end of file diff --git a/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-intent/get-string-extra.md b/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-intent/get-string-extra.md new file mode 100644 index 00000000000..d0d0677510b --- /dev/null +++ b/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-intent/get-string-extra.md @@ -0,0 +1,9 @@ +--- +title: SafeIntent.getStringExtra - +--- + +[mozilla.components.support.utils](../index.html) / [SafeIntent](index.html) / [getStringExtra](./get-string-extra.html) + +# getStringExtra + +`fun getStringExtra(name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` \ No newline at end of file diff --git a/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-intent/has-extra.md b/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-intent/has-extra.md new file mode 100644 index 00000000000..6be542b78c6 --- /dev/null +++ b/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-intent/has-extra.md @@ -0,0 +1,9 @@ +--- +title: SafeIntent.hasExtra - +--- + +[mozilla.components.support.utils](../index.html) / [SafeIntent](index.html) / [hasExtra](./has-extra.html) + +# hasExtra + +`fun hasExtra(name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) \ No newline at end of file diff --git a/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-intent/index.md b/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-intent/index.md new file mode 100644 index 00000000000..92a6cea0ecb --- /dev/null +++ b/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-intent/index.md @@ -0,0 +1,41 @@ +--- +title: SafeIntent - +--- + +[mozilla.components.support.utils](../index.html) / [SafeIntent](./index.html) + +# SafeIntent + +`class SafeIntent` + +External applications can pass values into Intents that can cause us to crash: in defense, +we wrap [Intent](#) and catch the exceptions they may force us to throw. See bug 1090385 +for more. + +### Constructors + +| [<init>](-init-.html) | `SafeIntent(unsafe: Intent)`
External applications can pass values into Intents that can cause us to crash: in defense, we wrap [Intent](#) and catch the exceptions they may force us to throw. See bug 1090385 for more. | + +### Properties + +| [action](action.html) | `val action: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` | +| [categories](categories.html) | `val categories: `[`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)`>?` | +| [data](data.html) | `val data: Uri?` | +| [dataString](data-string.html) | `val dataString: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` | +| [extras](extras.html) | `val extras: Bundle?` | +| [flags](flags.html) | `val flags: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [isLauncherIntent](is-launcher-intent.html) | `val isLauncherIntent: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [unsafe](unsafe.html) | `val unsafe: Intent` | + +### Functions + +| [getBooleanExtra](get-boolean-extra.html) | `fun getBooleanExtra(name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, defaultValue: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [getBundleExtra](get-bundle-extra.html) | `fun getBundleExtra(name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`SafeBundle`](../-safe-bundle/index.html)`?` | +| [getCharSequenceExtra](get-char-sequence-extra.html) | `fun getCharSequenceExtra(name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`CharSequence`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char-sequence/index.html)`?` | +| [getIntExtra](get-int-extra.html) | `fun getIntExtra(name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, defaultValue: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [getParcelableArrayListExtra](get-parcelable-array-list-extra.html) | `fun getParcelableArrayListExtra(name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`ArrayList`](http://docs.oracle.com/javase/6/docs/api/java/util/ArrayList.html)`<`[`T`](get-parcelable-array-list-extra.html#T)`>?` | +| [getParcelableExtra](get-parcelable-extra.html) | `fun getParcelableExtra(name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`T`](get-parcelable-extra.html#T)`?` | +| [getStringArrayListExtra](get-string-array-list-extra.html) | `fun getStringArrayListExtra(name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`ArrayList`](http://docs.oracle.com/javase/6/docs/api/java/util/ArrayList.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>?` | +| [getStringExtra](get-string-extra.html) | `fun getStringExtra(name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` | +| [hasExtra](has-extra.html) | `fun hasExtra(name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | + diff --git a/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-intent/is-launcher-intent.md b/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-intent/is-launcher-intent.md new file mode 100644 index 00000000000..fc232839fa1 --- /dev/null +++ b/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-intent/is-launcher-intent.md @@ -0,0 +1,9 @@ +--- +title: SafeIntent.isLauncherIntent - +--- + +[mozilla.components.support.utils](../index.html) / [SafeIntent](index.html) / [isLauncherIntent](./is-launcher-intent.html) + +# isLauncherIntent + +`val isLauncherIntent: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) \ No newline at end of file diff --git a/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-intent/unsafe.md b/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-intent/unsafe.md new file mode 100644 index 00000000000..e03fd21345e --- /dev/null +++ b/docs/api/0.21/support-utils/mozilla.components.support.utils/-safe-intent/unsafe.md @@ -0,0 +1,9 @@ +--- +title: SafeIntent.unsafe - +--- + +[mozilla.components.support.utils](../index.html) / [SafeIntent](index.html) / [unsafe](./unsafe.html) + +# unsafe + +`val unsafe: Intent` \ No newline at end of file diff --git a/docs/api/0.21/support-utils/mozilla.components.support.utils/-status-bar-utils/get-status-bar-height.md b/docs/api/0.21/support-utils/mozilla.components.support.utils/-status-bar-utils/get-status-bar-height.md new file mode 100644 index 00000000000..cb95b5ebede --- /dev/null +++ b/docs/api/0.21/support-utils/mozilla.components.support.utils/-status-bar-utils/get-status-bar-height.md @@ -0,0 +1,12 @@ +--- +title: StatusBarUtils.getStatusBarHeight - +--- + +[mozilla.components.support.utils](../index.html) / [StatusBarUtils](index.html) / [getStatusBarHeight](./get-status-bar-height.html) + +# getStatusBarHeight + +`fun getStatusBarHeight(view: View, block: (`[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Determine the height of the status bar asynchronously. + diff --git a/docs/api/0.21/support-utils/mozilla.components.support.utils/-status-bar-utils/index.md b/docs/api/0.21/support-utils/mozilla.components.support.utils/-status-bar-utils/index.md new file mode 100644 index 00000000000..fca47b308ca --- /dev/null +++ b/docs/api/0.21/support-utils/mozilla.components.support.utils/-status-bar-utils/index.md @@ -0,0 +1,14 @@ +--- +title: StatusBarUtils - +--- + +[mozilla.components.support.utils](../index.html) / [StatusBarUtils](./index.html) + +# StatusBarUtils + +`object StatusBarUtils` + +### Functions + +| [getStatusBarHeight](get-status-bar-height.html) | `fun getStatusBarHeight(view: View, block: (`[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Determine the height of the status bar asynchronously. | + diff --git a/docs/api/0.21/support-utils/mozilla.components.support.utils/-thread-utils/assert-on-ui-thread.md b/docs/api/0.21/support-utils/mozilla.components.support.utils/-thread-utils/assert-on-ui-thread.md new file mode 100644 index 00000000000..491858411b2 --- /dev/null +++ b/docs/api/0.21/support-utils/mozilla.components.support.utils/-thread-utils/assert-on-ui-thread.md @@ -0,0 +1,9 @@ +--- +title: ThreadUtils.assertOnUiThread - +--- + +[mozilla.components.support.utils](../index.html) / [ThreadUtils](index.html) / [assertOnUiThread](./assert-on-ui-thread.html) + +# assertOnUiThread + +`fun assertOnUiThread(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/support-utils/mozilla.components.support.utils/-thread-utils/index.md b/docs/api/0.21/support-utils/mozilla.components.support.utils/-thread-utils/index.md new file mode 100644 index 00000000000..5245819ac27 --- /dev/null +++ b/docs/api/0.21/support-utils/mozilla.components.support.utils/-thread-utils/index.md @@ -0,0 +1,17 @@ +--- +title: ThreadUtils - +--- + +[mozilla.components.support.utils](../index.html) / [ThreadUtils](./index.html) + +# ThreadUtils + +`object ThreadUtils` + +### Functions + +| [assertOnUiThread](assert-on-ui-thread.html) | `fun assertOnUiThread(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [postToBackgroundThread](post-to-background-thread.html) | `fun postToBackgroundThread(runnable: `[`Runnable`](http://docs.oracle.com/javase/6/docs/api/java/lang/Runnable.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [postToMainThread](post-to-main-thread.html) | `fun postToMainThread(runnable: `[`Runnable`](http://docs.oracle.com/javase/6/docs/api/java/lang/Runnable.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [postToMainThreadDelayed](post-to-main-thread-delayed.html) | `fun postToMainThreadDelayed(runnable: `[`Runnable`](http://docs.oracle.com/javase/6/docs/api/java/lang/Runnable.html)`, delayMillis: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | + diff --git a/docs/api/0.21/support-utils/mozilla.components.support.utils/-thread-utils/post-to-background-thread.md b/docs/api/0.21/support-utils/mozilla.components.support.utils/-thread-utils/post-to-background-thread.md new file mode 100644 index 00000000000..40dd3ad611c --- /dev/null +++ b/docs/api/0.21/support-utils/mozilla.components.support.utils/-thread-utils/post-to-background-thread.md @@ -0,0 +1,9 @@ +--- +title: ThreadUtils.postToBackgroundThread - +--- + +[mozilla.components.support.utils](../index.html) / [ThreadUtils](index.html) / [postToBackgroundThread](./post-to-background-thread.html) + +# postToBackgroundThread + +`fun postToBackgroundThread(runnable: `[`Runnable`](http://docs.oracle.com/javase/6/docs/api/java/lang/Runnable.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/support-utils/mozilla.components.support.utils/-thread-utils/post-to-main-thread-delayed.md b/docs/api/0.21/support-utils/mozilla.components.support.utils/-thread-utils/post-to-main-thread-delayed.md new file mode 100644 index 00000000000..dac2620a714 --- /dev/null +++ b/docs/api/0.21/support-utils/mozilla.components.support.utils/-thread-utils/post-to-main-thread-delayed.md @@ -0,0 +1,9 @@ +--- +title: ThreadUtils.postToMainThreadDelayed - +--- + +[mozilla.components.support.utils](../index.html) / [ThreadUtils](index.html) / [postToMainThreadDelayed](./post-to-main-thread-delayed.html) + +# postToMainThreadDelayed + +`fun postToMainThreadDelayed(runnable: `[`Runnable`](http://docs.oracle.com/javase/6/docs/api/java/lang/Runnable.html)`, delayMillis: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/support-utils/mozilla.components.support.utils/-thread-utils/post-to-main-thread.md b/docs/api/0.21/support-utils/mozilla.components.support.utils/-thread-utils/post-to-main-thread.md new file mode 100644 index 00000000000..332cad2aff5 --- /dev/null +++ b/docs/api/0.21/support-utils/mozilla.components.support.utils/-thread-utils/post-to-main-thread.md @@ -0,0 +1,9 @@ +--- +title: ThreadUtils.postToMainThread - +--- + +[mozilla.components.support.utils](../index.html) / [ThreadUtils](index.html) / [postToMainThread](./post-to-main-thread.html) + +# postToMainThread + +`fun postToMainThread(runnable: `[`Runnable`](http://docs.oracle.com/javase/6/docs/api/java/lang/Runnable.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/support-utils/mozilla.components.support.utils/-web-u-r-l-finder/-init-.md b/docs/api/0.21/support-utils/mozilla.components.support.utils/-web-u-r-l-finder/-init-.md new file mode 100644 index 00000000000..340c7b9310c --- /dev/null +++ b/docs/api/0.21/support-utils/mozilla.components.support.utils/-web-u-r-l-finder/-init-.md @@ -0,0 +1,9 @@ +--- +title: WebURLFinder. - +--- + +[mozilla.components.support.utils](../index.html) / [WebURLFinder](index.html) / [<init>](./-init-.html) + +# <init> + +`WebURLFinder(string: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?)` \ No newline at end of file diff --git a/docs/api/0.21/support-utils/mozilla.components.support.utils/-web-u-r-l-finder/best-web-u-r-l.md b/docs/api/0.21/support-utils/mozilla.components.support.utils/-web-u-r-l-finder/best-web-u-r-l.md new file mode 100644 index 00000000000..d20bb52594d --- /dev/null +++ b/docs/api/0.21/support-utils/mozilla.components.support.utils/-web-u-r-l-finder/best-web-u-r-l.md @@ -0,0 +1,18 @@ +--- +title: WebURLFinder.bestWebURL - +--- + +[mozilla.components.support.utils](../index.html) / [WebURLFinder](index.html) / [bestWebURL](./best-web-u-r-l.html) + +# bestWebURL + +`fun bestWebURL(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` + +Return best Web URL. + +"Best" means a Web URL with a scheme, and failing that, a Web URL without a +scheme. + +**Return** +a Web URL or `null`. + diff --git a/docs/api/0.21/support-utils/mozilla.components.support.utils/-web-u-r-l-finder/index.md b/docs/api/0.21/support-utils/mozilla.components.support.utils/-web-u-r-l-finder/index.md new file mode 100644 index 00000000000..dadefeac613 --- /dev/null +++ b/docs/api/0.21/support-utils/mozilla.components.support.utils/-web-u-r-l-finder/index.md @@ -0,0 +1,24 @@ +--- +title: WebURLFinder - +--- + +[mozilla.components.support.utils](../index.html) / [WebURLFinder](./index.html) + +# WebURLFinder + +`class WebURLFinder` + +Regular expressions used in this class are taken from Android's Patterns.java. +We brought them in to standardize URL matching across Android versions, instead of relying +on Android version-dependent built-ins that can vary across Android versions. +The original code can be found here: +http://androidxref.com/8.0.0_r4/xref/frameworks/base/core/java/android/util/Patterns.java + +### Constructors + +| [<init>](-init-.html) | `WebURLFinder(string: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?)` | + +### Functions + +| [bestWebURL](best-web-u-r-l.html) | `fun bestWebURL(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
Return best Web URL. | + diff --git a/docs/api/0.21/support-utils/mozilla.components.support.utils/index.md b/docs/api/0.21/support-utils/mozilla.components.support.utils/index.md new file mode 100644 index 00000000000..27cbbb96fae --- /dev/null +++ b/docs/api/0.21/support-utils/mozilla.components.support.utils/index.md @@ -0,0 +1,19 @@ +--- +title: mozilla.components.support.utils - +--- + +[mozilla.components.support.utils](./index.html) + +## Package mozilla.components.support.utils + +### Types + +| [ColorUtils](-color-utils/index.html) | `object ColorUtils` | +| [DownloadUtils](-download-utils/index.html) | `object DownloadUtils` | +| [DrawableUtils](-drawable-utils/index.html) | `object DrawableUtils` | +| [SafeBundle](-safe-bundle/index.html) | `class SafeBundle`
See SafeIntent for more background: applications can put garbage values into Bundles. This is primarily experienced when there's garbage in the Intent's Bundle. However that Bundle can contain further bundles, and we need to handle those defensively too. | +| [SafeIntent](-safe-intent/index.html) | `class SafeIntent`
External applications can pass values into Intents that can cause us to crash: in defense, we wrap [Intent](#) and catch the exceptions they may force us to throw. See bug 1090385 for more. | +| [StatusBarUtils](-status-bar-utils/index.html) | `object StatusBarUtils` | +| [ThreadUtils](-thread-utils/index.html) | `object ThreadUtils` | +| [WebURLFinder](-web-u-r-l-finder/index.html) | `class WebURLFinder`
Regular expressions used in this class are taken from Android's Patterns.java. We brought them in to standardize URL matching across Android versions, instead of relying on Android version-dependent built-ins that can vary across Android versions. The original code can be found here: http://androidxref.com/8.0.0_r4/xref/frameworks/base/core/java/android/util/Patterns.java | + diff --git a/docs/api/0.21/support-utils/package-list b/docs/api/0.21/support-utils/package-list new file mode 100644 index 00000000000..a264c99dc74 --- /dev/null +++ b/docs/api/0.21/support-utils/package-list @@ -0,0 +1,4 @@ +$dokka.format:jekyll +$dokka.linkExtension:html + +mozilla.components.support.utils diff --git a/docs/api/0.21/ui-autocomplete/alltypes/index.md b/docs/api/0.21/ui-autocomplete/alltypes/index.md new file mode 100644 index 00000000000..02a9f7aa6ea --- /dev/null +++ b/docs/api/0.21/ui-autocomplete/alltypes/index.md @@ -0,0 +1,16 @@ +--- +title: alltypes - +--- + +### All Types + +| [mozilla.components.ui.autocomplete.InlineAutocompleteEditText](../mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/index.html) | A UI edit text component which supports inline autocompletion. | +| [mozilla.components.ui.autocomplete.OnCommitListener](../mozilla.components.ui.autocomplete/-on-commit-listener.html) | | +| [mozilla.components.ui.autocomplete.OnFilterListener](../mozilla.components.ui.autocomplete/-on-filter-listener.html) | | +| [mozilla.components.ui.autocomplete.OnKeyPreImeListener](../mozilla.components.ui.autocomplete/-on-key-pre-ime-listener.html) | | +| [mozilla.components.ui.autocomplete.OnSearchStateChangeListener](../mozilla.components.ui.autocomplete/-on-search-state-change-listener.html) | | +| [mozilla.components.ui.autocomplete.OnSelectionChangedListener](../mozilla.components.ui.autocomplete/-on-selection-changed-listener.html) | | +| [mozilla.components.ui.autocomplete.OnTextChangeListener](../mozilla.components.ui.autocomplete/-on-text-change-listener.html) | | +| [mozilla.components.ui.autocomplete.OnWindowsFocusChangeListener](../mozilla.components.ui.autocomplete/-on-windows-focus-change-listener.html) | | +| [mozilla.components.ui.autocomplete.TextFormatter](../mozilla.components.ui.autocomplete/-text-formatter.html) | | + diff --git a/docs/api/0.21/ui-autocomplete/index.md b/docs/api/0.21/ui-autocomplete/index.md new file mode 100644 index 00000000000..f5c233b93fb --- /dev/null +++ b/docs/api/0.21/ui-autocomplete/index.md @@ -0,0 +1,11 @@ +--- +title: +--- + +### Packages + +| [mozilla.components.ui.autocomplete](mozilla.components.ui.autocomplete/index.html) | | + +### Index + +[All Types](alltypes/index.html) \ No newline at end of file diff --git a/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-a-u-t-o-c-o-m-p-l-e-t-e_-s-p-a-n.md b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-a-u-t-o-c-o-m-p-l-e-t-e_-s-p-a-n.md new file mode 100644 index 00000000000..57abe02956a --- /dev/null +++ b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-a-u-t-o-c-o-m-p-l-e-t-e_-s-p-a-n.md @@ -0,0 +1,9 @@ +--- +title: InlineAutocompleteEditText.AUTOCOMPLETE_SPAN - +--- + +[mozilla.components.ui.autocomplete](../index.html) / [InlineAutocompleteEditText](index.html) / [AUTOCOMPLETE_SPAN](./-a-u-t-o-c-o-m-p-l-e-t-e_-s-p-a-n.html) + +# AUTOCOMPLETE_SPAN + +`val AUTOCOMPLETE_SPAN: Concrete` \ No newline at end of file diff --git a/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-autocomplete-result/-init-.md b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-autocomplete-result/-init-.md new file mode 100644 index 00000000000..43b594e6568 --- /dev/null +++ b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-autocomplete-result/-init-.md @@ -0,0 +1,9 @@ +--- +title: InlineAutocompleteEditText.AutocompleteResult. - +--- + +[mozilla.components.ui.autocomplete](../../index.html) / [InlineAutocompleteEditText](../index.html) / [AutocompleteResult](index.html) / [<init>](./-init-.html) + +# <init> + +`AutocompleteResult(text: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, source: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, totalItems: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, textFormatter: `[`TextFormatter`](../../-text-formatter.html)`? = null)` \ No newline at end of file diff --git a/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-autocomplete-result/empty-result.md b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-autocomplete-result/empty-result.md new file mode 100644 index 00000000000..be24454954a --- /dev/null +++ b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-autocomplete-result/empty-result.md @@ -0,0 +1,9 @@ +--- +title: InlineAutocompleteEditText.AutocompleteResult.emptyResult - +--- + +[mozilla.components.ui.autocomplete](../../index.html) / [InlineAutocompleteEditText](../index.html) / [AutocompleteResult](index.html) / [emptyResult](./empty-result.html) + +# emptyResult + +`fun emptyResult(): `[`AutocompleteResult`](index.html) \ No newline at end of file diff --git a/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-autocomplete-result/formatted-text.md b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-autocomplete-result/formatted-text.md new file mode 100644 index 00000000000..37da28d3b43 --- /dev/null +++ b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-autocomplete-result/formatted-text.md @@ -0,0 +1,9 @@ +--- +title: InlineAutocompleteEditText.AutocompleteResult.formattedText - +--- + +[mozilla.components.ui.autocomplete](../../index.html) / [InlineAutocompleteEditText](../index.html) / [AutocompleteResult](index.html) / [formattedText](./formatted-text.html) + +# formattedText + +`val formattedText: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) \ No newline at end of file diff --git a/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-autocomplete-result/index.md b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-autocomplete-result/index.md new file mode 100644 index 00000000000..c98c95c1e15 --- /dev/null +++ b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-autocomplete-result/index.md @@ -0,0 +1,31 @@ +--- +title: InlineAutocompleteEditText.AutocompleteResult - +--- + +[mozilla.components.ui.autocomplete](../../index.html) / [InlineAutocompleteEditText](../index.html) / [AutocompleteResult](./index.html) + +# AutocompleteResult + +`data class AutocompleteResult` + +### Constructors + +| [<init>](-init-.html) | `AutocompleteResult(text: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, source: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, totalItems: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, textFormatter: `[`TextFormatter`](../../-text-formatter.html)`? = null)` | + +### Properties + +| [formattedText](formatted-text.html) | `val formattedText: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [isEmpty](is-empty.html) | `val isEmpty: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [length](length.html) | `val length: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [source](source.html) | `val source: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [text](text.html) | `val text: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [totalItems](total-items.html) | `val totalItems: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | + +### Functions + +| [startsWith](starts-with.html) | `fun startsWith(text: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | + +### Companion Object Functions + +| [emptyResult](empty-result.html) | `fun emptyResult(): `[`AutocompleteResult`](./index.md) | + diff --git a/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-autocomplete-result/is-empty.md b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-autocomplete-result/is-empty.md new file mode 100644 index 00000000000..bd2235a5ce2 --- /dev/null +++ b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-autocomplete-result/is-empty.md @@ -0,0 +1,9 @@ +--- +title: InlineAutocompleteEditText.AutocompleteResult.isEmpty - +--- + +[mozilla.components.ui.autocomplete](../../index.html) / [InlineAutocompleteEditText](../index.html) / [AutocompleteResult](index.html) / [isEmpty](./is-empty.html) + +# isEmpty + +`val isEmpty: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) \ No newline at end of file diff --git a/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-autocomplete-result/length.md b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-autocomplete-result/length.md new file mode 100644 index 00000000000..c7f47cd891d --- /dev/null +++ b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-autocomplete-result/length.md @@ -0,0 +1,9 @@ +--- +title: InlineAutocompleteEditText.AutocompleteResult.length - +--- + +[mozilla.components.ui.autocomplete](../../index.html) / [InlineAutocompleteEditText](../index.html) / [AutocompleteResult](index.html) / [length](./length.html) + +# length + +`val length: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) \ No newline at end of file diff --git a/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-autocomplete-result/source.md b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-autocomplete-result/source.md new file mode 100644 index 00000000000..102653466d7 --- /dev/null +++ b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-autocomplete-result/source.md @@ -0,0 +1,9 @@ +--- +title: InlineAutocompleteEditText.AutocompleteResult.source - +--- + +[mozilla.components.ui.autocomplete](../../index.html) / [InlineAutocompleteEditText](../index.html) / [AutocompleteResult](index.html) / [source](./source.html) + +# source + +`val source: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) \ No newline at end of file diff --git a/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-autocomplete-result/starts-with.md b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-autocomplete-result/starts-with.md new file mode 100644 index 00000000000..d3d32249085 --- /dev/null +++ b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-autocomplete-result/starts-with.md @@ -0,0 +1,9 @@ +--- +title: InlineAutocompleteEditText.AutocompleteResult.startsWith - +--- + +[mozilla.components.ui.autocomplete](../../index.html) / [InlineAutocompleteEditText](../index.html) / [AutocompleteResult](index.html) / [startsWith](./starts-with.html) + +# startsWith + +`fun startsWith(text: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) \ No newline at end of file diff --git a/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-autocomplete-result/text.md b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-autocomplete-result/text.md new file mode 100644 index 00000000000..16e7a1c6624 --- /dev/null +++ b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-autocomplete-result/text.md @@ -0,0 +1,9 @@ +--- +title: InlineAutocompleteEditText.AutocompleteResult.text - +--- + +[mozilla.components.ui.autocomplete](../../index.html) / [InlineAutocompleteEditText](../index.html) / [AutocompleteResult](index.html) / [text](./text.html) + +# text + +`val text: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) \ No newline at end of file diff --git a/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-autocomplete-result/total-items.md b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-autocomplete-result/total-items.md new file mode 100644 index 00000000000..84753690527 --- /dev/null +++ b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-autocomplete-result/total-items.md @@ -0,0 +1,9 @@ +--- +title: InlineAutocompleteEditText.AutocompleteResult.totalItems - +--- + +[mozilla.components.ui.autocomplete](../../index.html) / [InlineAutocompleteEditText](../index.html) / [AutocompleteResult](index.html) / [totalItems](./total-items.html) + +# totalItems + +`val totalItems: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) \ No newline at end of file diff --git a/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-d-e-f-a-u-l-t_-a-u-t-o-c-o-m-p-l-e-t-e_-b-a-c-k-g-r-o-u-n-d_-c-o-l-o-r.md b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-d-e-f-a-u-l-t_-a-u-t-o-c-o-m-p-l-e-t-e_-b-a-c-k-g-r-o-u-n-d_-c-o-l-o-r.md new file mode 100644 index 00000000000..0f07712c3b7 --- /dev/null +++ b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-d-e-f-a-u-l-t_-a-u-t-o-c-o-m-p-l-e-t-e_-b-a-c-k-g-r-o-u-n-d_-c-o-l-o-r.md @@ -0,0 +1,9 @@ +--- +title: InlineAutocompleteEditText.DEFAULT_AUTOCOMPLETE_BACKGROUND_COLOR - +--- + +[mozilla.components.ui.autocomplete](../index.html) / [InlineAutocompleteEditText](index.html) / [DEFAULT_AUTOCOMPLETE_BACKGROUND_COLOR](./-d-e-f-a-u-l-t_-a-u-t-o-c-o-m-p-l-e-t-e_-b-a-c-k-g-r-o-u-n-d_-c-o-l-o-r.html) + +# DEFAULT_AUTOCOMPLETE_BACKGROUND_COLOR + +`val DEFAULT_AUTOCOMPLETE_BACKGROUND_COLOR: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) \ No newline at end of file diff --git a/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-init-.md b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-init-.md new file mode 100644 index 00000000000..195d25026a1 --- /dev/null +++ b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-init-.md @@ -0,0 +1,30 @@ +--- +title: InlineAutocompleteEditText. - +--- + +[mozilla.components.ui.autocomplete](../index.html) / [InlineAutocompleteEditText](index.html) / [<init>](./-init-.html) + +# <init> + +`InlineAutocompleteEditText(ctx: Context, attrs: AttributeSet? = null, defStyleAttr: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = R.attr.editTextStyle)` + +A UI edit text component which supports inline autocompletion. + +The background color of autocomplete spans can be configured using +the custom autocompleteBackgroundColor attribute e.g. +app:autocompleteBackgroundColor="#ffffff". + +A filter listener (see [setOnFilterListener](set-on-filter-listener.html)) needs to be attached to +provide autocomplete results. It will be invoked when the input +text changes. The listener gets direct access to this component (via its view +parameter), so it can call {@link applyAutocompleteResult} in return. + +A commit listener (see [setOnCommitListener](set-on-commit-listener.html)) can be attached which is +invoked when the user selected the result i.e. is done editing. + +Various other listeners can be attached to enhance default behaviour e.g. +[setOnSelectionChangedListener](set-on-selection-changed-listener.html) and [setOnWindowsFocusChangeListener](set-on-windows-focus-change-listener.html) which +will be invoked in response to [onSelectionChanged](on-selection-changed.html) and [onWindowFocusChanged](on-window-focus-changed.html) +respectively (see also [setOnTextChangeListener](set-on-text-change-listener.html), +[setOnSelectionChangedListener](set-on-selection-changed-listener.html), and [setOnWindowsFocusChangeListener](set-on-windows-focus-change-listener.html)). + diff --git a/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/apply-autocomplete-result.md b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/apply-autocomplete-result.md new file mode 100644 index 00000000000..25b84e36484 --- /dev/null +++ b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/apply-autocomplete-result.md @@ -0,0 +1,16 @@ +--- +title: InlineAutocompleteEditText.applyAutocompleteResult - +--- + +[mozilla.components.ui.autocomplete](../index.html) / [InlineAutocompleteEditText](index.html) / [applyAutocompleteResult](./apply-autocomplete-result.html) + +# applyAutocompleteResult + +`fun applyAutocompleteResult(result: `[`AutocompleteResult`](-autocomplete-result/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Applies the provided result by updating the current autocomplete +text and selection, if any. + +### Parameters + +`result` - the [AutocompleteResult](-autocomplete-result/index.html) to apply \ No newline at end of file diff --git a/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/autocomplete-result.md b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/autocomplete-result.md new file mode 100644 index 00000000000..e56f2270609 --- /dev/null +++ b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/autocomplete-result.md @@ -0,0 +1,9 @@ +--- +title: InlineAutocompleteEditText.autocompleteResult - +--- + +[mozilla.components.ui.autocomplete](../index.html) / [InlineAutocompleteEditText](index.html) / [autocompleteResult](./autocomplete-result.html) + +# autocompleteResult + +`var autocompleteResult: `[`AutocompleteResult`](-autocomplete-result/index.html) \ No newline at end of file diff --git a/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/ctx.md b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/ctx.md new file mode 100644 index 00000000000..69421505928 --- /dev/null +++ b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/ctx.md @@ -0,0 +1,9 @@ +--- +title: InlineAutocompleteEditText.ctx - +--- + +[mozilla.components.ui.autocomplete](../index.html) / [InlineAutocompleteEditText](index.html) / [ctx](./ctx.html) + +# ctx + +`val ctx: Context` \ No newline at end of file diff --git a/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/index.md b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/index.md new file mode 100644 index 00000000000..5a95c123ed9 --- /dev/null +++ b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/index.md @@ -0,0 +1,70 @@ +--- +title: InlineAutocompleteEditText - +--- + +[mozilla.components.ui.autocomplete](../index.html) / [InlineAutocompleteEditText](./index.html) + +# InlineAutocompleteEditText + +`open class InlineAutocompleteEditText : AppCompatEditText` + +A UI edit text component which supports inline autocompletion. + +The background color of autocomplete spans can be configured using +the custom autocompleteBackgroundColor attribute e.g. +app:autocompleteBackgroundColor="#ffffff". + +A filter listener (see [setOnFilterListener](set-on-filter-listener.html)) needs to be attached to +provide autocomplete results. It will be invoked when the input +text changes. The listener gets direct access to this component (via its view +parameter), so it can call {@link applyAutocompleteResult} in return. + +A commit listener (see [setOnCommitListener](set-on-commit-listener.html)) can be attached which is +invoked when the user selected the result i.e. is done editing. + +Various other listeners can be attached to enhance default behaviour e.g. +[setOnSelectionChangedListener](set-on-selection-changed-listener.html) and [setOnWindowsFocusChangeListener](set-on-windows-focus-change-listener.html) which +will be invoked in response to [onSelectionChanged](on-selection-changed.html) and [onWindowFocusChanged](on-window-focus-changed.html) +respectively (see also [setOnTextChangeListener](set-on-text-change-listener.html), +[setOnSelectionChangedListener](set-on-selection-changed-listener.html), and [setOnWindowsFocusChangeListener](set-on-windows-focus-change-listener.html)). + +### Types + +| [AutocompleteResult](-autocomplete-result/index.html) | `data class AutocompleteResult` | + +### Constructors + +| [<init>](-init-.html) | `InlineAutocompleteEditText(ctx: Context, attrs: AttributeSet? = null, defStyleAttr: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = R.attr.editTextStyle)`
A UI edit text component which supports inline autocompletion. | + +### Properties + +| [autocompleteResult](autocomplete-result.html) | `var autocompleteResult: `[`AutocompleteResult`](-autocomplete-result/index.html) | +| [ctx](ctx.html) | `val ctx: Context` | +| [nonAutocompleteText](non-autocomplete-text.html) | `val nonAutocompleteText: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [originalText](original-text.html) | `val originalText: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + +### Functions + +| [applyAutocompleteResult](apply-autocomplete-result.html) | `fun applyAutocompleteResult(result: `[`AutocompleteResult`](-autocomplete-result/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Applies the provided result by updating the current autocomplete text and selection, if any. | +| [onAttachedToWindow](on-attached-to-window.html) | `open fun onAttachedToWindow(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onCreateInputConnection](on-create-input-connection.html) | `open fun onCreateInputConnection(outAttrs: EditorInfo): InputConnection?`
Code to handle deleting autocomplete first when backspacing. If there is no autocomplete text, both removeAutocomplete() and commitAutocomplete() are no-ops and return false. Therefore we can use them here without checking explicitly if we have autocomplete text or not. | +| [onFocusChanged](on-focus-changed.html) | `open fun onFocusChanged(gainFocus: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`, direction: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, previouslyFocusedRect: Rect?): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onKeyPreIme](on-key-pre-ime.html) | `open fun onKeyPreIme(keyCode: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, event: KeyEvent): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [onSelectionChanged](on-selection-changed.html) | `open fun onSelectionChanged(selStart: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, selEnd: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onTouchEvent](on-touch-event.html) | `open fun onTouchEvent(event: MotionEvent): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [onWindowFocusChanged](on-window-focus-changed.html) | `open fun onWindowFocusChanged(hasFocus: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [sendAccessibilityEventUnchecked](send-accessibility-event-unchecked.html) | `open fun sendAccessibilityEventUnchecked(event: AccessibilityEvent): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [setOnCommitListener](set-on-commit-listener.html) | `fun setOnCommitListener(l: `[`OnCommitListener`](../-on-commit-listener.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [setOnFilterListener](set-on-filter-listener.html) | `fun setOnFilterListener(l: `[`OnFilterListener`](../-on-filter-listener.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [setOnKeyPreImeListener](set-on-key-pre-ime-listener.html) | `fun setOnKeyPreImeListener(l: `[`OnKeyPreImeListener`](../-on-key-pre-ime-listener.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [setOnSearchStateChangeListener](set-on-search-state-change-listener.html) | `fun setOnSearchStateChangeListener(l: `[`OnSearchStateChangeListener`](../-on-search-state-change-listener.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [setOnSelectionChangedListener](set-on-selection-changed-listener.html) | `fun setOnSelectionChangedListener(l: `[`OnSelectionChangedListener`](../-on-selection-changed-listener.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [setOnTextChangeListener](set-on-text-change-listener.html) | `fun setOnTextChangeListener(l: `[`OnTextChangeListener`](../-on-text-change-listener.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [setOnWindowsFocusChangeListener](set-on-windows-focus-change-listener.html) | `fun setOnWindowsFocusChangeListener(l: `[`OnWindowsFocusChangeListener`](../-on-windows-focus-change-listener.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [setText](set-text.html) | `open fun setText(text: `[`CharSequence`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char-sequence/index.html)`?, type: BufferType): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | + +### Companion Object Properties + +| [AUTOCOMPLETE_SPAN](-a-u-t-o-c-o-m-p-l-e-t-e_-s-p-a-n.html) | `val AUTOCOMPLETE_SPAN: Concrete` | +| [DEFAULT_AUTOCOMPLETE_BACKGROUND_COLOR](-d-e-f-a-u-l-t_-a-u-t-o-c-o-m-p-l-e-t-e_-b-a-c-k-g-r-o-u-n-d_-c-o-l-o-r.html) | `val DEFAULT_AUTOCOMPLETE_BACKGROUND_COLOR: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | + diff --git a/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/non-autocomplete-text.md b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/non-autocomplete-text.md new file mode 100644 index 00000000000..85eb63ee146 --- /dev/null +++ b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/non-autocomplete-text.md @@ -0,0 +1,9 @@ +--- +title: InlineAutocompleteEditText.nonAutocompleteText - +--- + +[mozilla.components.ui.autocomplete](../index.html) / [InlineAutocompleteEditText](index.html) / [nonAutocompleteText](./non-autocomplete-text.html) + +# nonAutocompleteText + +`val nonAutocompleteText: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) \ No newline at end of file diff --git a/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/on-attached-to-window.md b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/on-attached-to-window.md new file mode 100644 index 00000000000..34a95b328de --- /dev/null +++ b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/on-attached-to-window.md @@ -0,0 +1,9 @@ +--- +title: InlineAutocompleteEditText.onAttachedToWindow - +--- + +[mozilla.components.ui.autocomplete](../index.html) / [InlineAutocompleteEditText](index.html) / [onAttachedToWindow](./on-attached-to-window.html) + +# onAttachedToWindow + +`open fun onAttachedToWindow(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/on-create-input-connection.md b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/on-create-input-connection.md new file mode 100644 index 00000000000..a5810f2d384 --- /dev/null +++ b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/on-create-input-connection.md @@ -0,0 +1,17 @@ +--- +title: InlineAutocompleteEditText.onCreateInputConnection - +--- + +[mozilla.components.ui.autocomplete](../index.html) / [InlineAutocompleteEditText](index.html) / [onCreateInputConnection](./on-create-input-connection.html) + +# onCreateInputConnection + +`open fun onCreateInputConnection(outAttrs: EditorInfo): InputConnection?` + +Code to handle deleting autocomplete first when backspacing. +If there is no autocomplete text, both removeAutocomplete() and commitAutocomplete() +are no-ops and return false. Therefore we can use them here without checking explicitly +if we have autocomplete text or not. + +Also turns off text prediction for private mode tabs. + diff --git a/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/on-focus-changed.md b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/on-focus-changed.md new file mode 100644 index 00000000000..a2994bf3556 --- /dev/null +++ b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/on-focus-changed.md @@ -0,0 +1,9 @@ +--- +title: InlineAutocompleteEditText.onFocusChanged - +--- + +[mozilla.components.ui.autocomplete](../index.html) / [InlineAutocompleteEditText](index.html) / [onFocusChanged](./on-focus-changed.html) + +# onFocusChanged + +`open fun onFocusChanged(gainFocus: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`, direction: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, previouslyFocusedRect: Rect?): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/on-key-pre-ime.md b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/on-key-pre-ime.md new file mode 100644 index 00000000000..96fd069b845 --- /dev/null +++ b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/on-key-pre-ime.md @@ -0,0 +1,9 @@ +--- +title: InlineAutocompleteEditText.onKeyPreIme - +--- + +[mozilla.components.ui.autocomplete](../index.html) / [InlineAutocompleteEditText](index.html) / [onKeyPreIme](./on-key-pre-ime.html) + +# onKeyPreIme + +`open fun onKeyPreIme(keyCode: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, event: KeyEvent): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) \ No newline at end of file diff --git a/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/on-selection-changed.md b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/on-selection-changed.md new file mode 100644 index 00000000000..da25536dac8 --- /dev/null +++ b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/on-selection-changed.md @@ -0,0 +1,9 @@ +--- +title: InlineAutocompleteEditText.onSelectionChanged - +--- + +[mozilla.components.ui.autocomplete](../index.html) / [InlineAutocompleteEditText](index.html) / [onSelectionChanged](./on-selection-changed.html) + +# onSelectionChanged + +`open fun onSelectionChanged(selStart: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, selEnd: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/on-touch-event.md b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/on-touch-event.md new file mode 100644 index 00000000000..ca94b9f911e --- /dev/null +++ b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/on-touch-event.md @@ -0,0 +1,9 @@ +--- +title: InlineAutocompleteEditText.onTouchEvent - +--- + +[mozilla.components.ui.autocomplete](../index.html) / [InlineAutocompleteEditText](index.html) / [onTouchEvent](./on-touch-event.html) + +# onTouchEvent + +`open fun onTouchEvent(event: MotionEvent): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) \ No newline at end of file diff --git a/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/on-window-focus-changed.md b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/on-window-focus-changed.md new file mode 100644 index 00000000000..5a1ad84f2a8 --- /dev/null +++ b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/on-window-focus-changed.md @@ -0,0 +1,9 @@ +--- +title: InlineAutocompleteEditText.onWindowFocusChanged - +--- + +[mozilla.components.ui.autocomplete](../index.html) / [InlineAutocompleteEditText](index.html) / [onWindowFocusChanged](./on-window-focus-changed.html) + +# onWindowFocusChanged + +`open fun onWindowFocusChanged(hasFocus: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/original-text.md b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/original-text.md new file mode 100644 index 00000000000..3e0da0a6a05 --- /dev/null +++ b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/original-text.md @@ -0,0 +1,9 @@ +--- +title: InlineAutocompleteEditText.originalText - +--- + +[mozilla.components.ui.autocomplete](../index.html) / [InlineAutocompleteEditText](index.html) / [originalText](./original-text.html) + +# originalText + +`val originalText: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) \ No newline at end of file diff --git a/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/send-accessibility-event-unchecked.md b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/send-accessibility-event-unchecked.md new file mode 100644 index 00000000000..41b030732ca --- /dev/null +++ b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/send-accessibility-event-unchecked.md @@ -0,0 +1,9 @@ +--- +title: InlineAutocompleteEditText.sendAccessibilityEventUnchecked - +--- + +[mozilla.components.ui.autocomplete](../index.html) / [InlineAutocompleteEditText](index.html) / [sendAccessibilityEventUnchecked](./send-accessibility-event-unchecked.html) + +# sendAccessibilityEventUnchecked + +`open fun sendAccessibilityEventUnchecked(event: AccessibilityEvent): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/set-on-commit-listener.md b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/set-on-commit-listener.md new file mode 100644 index 00000000000..dbff051266e --- /dev/null +++ b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/set-on-commit-listener.md @@ -0,0 +1,9 @@ +--- +title: InlineAutocompleteEditText.setOnCommitListener - +--- + +[mozilla.components.ui.autocomplete](../index.html) / [InlineAutocompleteEditText](index.html) / [setOnCommitListener](./set-on-commit-listener.html) + +# setOnCommitListener + +`fun setOnCommitListener(l: `[`OnCommitListener`](../-on-commit-listener.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/set-on-filter-listener.md b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/set-on-filter-listener.md new file mode 100644 index 00000000000..d13e5f28cd6 --- /dev/null +++ b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/set-on-filter-listener.md @@ -0,0 +1,9 @@ +--- +title: InlineAutocompleteEditText.setOnFilterListener - +--- + +[mozilla.components.ui.autocomplete](../index.html) / [InlineAutocompleteEditText](index.html) / [setOnFilterListener](./set-on-filter-listener.html) + +# setOnFilterListener + +`fun setOnFilterListener(l: `[`OnFilterListener`](../-on-filter-listener.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/set-on-key-pre-ime-listener.md b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/set-on-key-pre-ime-listener.md new file mode 100644 index 00000000000..ff80a943fe9 --- /dev/null +++ b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/set-on-key-pre-ime-listener.md @@ -0,0 +1,9 @@ +--- +title: InlineAutocompleteEditText.setOnKeyPreImeListener - +--- + +[mozilla.components.ui.autocomplete](../index.html) / [InlineAutocompleteEditText](index.html) / [setOnKeyPreImeListener](./set-on-key-pre-ime-listener.html) + +# setOnKeyPreImeListener + +`fun setOnKeyPreImeListener(l: `[`OnKeyPreImeListener`](../-on-key-pre-ime-listener.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/set-on-search-state-change-listener.md b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/set-on-search-state-change-listener.md new file mode 100644 index 00000000000..b3e6e7675e8 --- /dev/null +++ b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/set-on-search-state-change-listener.md @@ -0,0 +1,9 @@ +--- +title: InlineAutocompleteEditText.setOnSearchStateChangeListener - +--- + +[mozilla.components.ui.autocomplete](../index.html) / [InlineAutocompleteEditText](index.html) / [setOnSearchStateChangeListener](./set-on-search-state-change-listener.html) + +# setOnSearchStateChangeListener + +`fun setOnSearchStateChangeListener(l: `[`OnSearchStateChangeListener`](../-on-search-state-change-listener.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/set-on-selection-changed-listener.md b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/set-on-selection-changed-listener.md new file mode 100644 index 00000000000..5cf5d0a3d49 --- /dev/null +++ b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/set-on-selection-changed-listener.md @@ -0,0 +1,9 @@ +--- +title: InlineAutocompleteEditText.setOnSelectionChangedListener - +--- + +[mozilla.components.ui.autocomplete](../index.html) / [InlineAutocompleteEditText](index.html) / [setOnSelectionChangedListener](./set-on-selection-changed-listener.html) + +# setOnSelectionChangedListener + +`fun setOnSelectionChangedListener(l: `[`OnSelectionChangedListener`](../-on-selection-changed-listener.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/set-on-text-change-listener.md b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/set-on-text-change-listener.md new file mode 100644 index 00000000000..f7f3de4afd9 --- /dev/null +++ b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/set-on-text-change-listener.md @@ -0,0 +1,9 @@ +--- +title: InlineAutocompleteEditText.setOnTextChangeListener - +--- + +[mozilla.components.ui.autocomplete](../index.html) / [InlineAutocompleteEditText](index.html) / [setOnTextChangeListener](./set-on-text-change-listener.html) + +# setOnTextChangeListener + +`fun setOnTextChangeListener(l: `[`OnTextChangeListener`](../-on-text-change-listener.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/set-on-windows-focus-change-listener.md b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/set-on-windows-focus-change-listener.md new file mode 100644 index 00000000000..c51e4f15d91 --- /dev/null +++ b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/set-on-windows-focus-change-listener.md @@ -0,0 +1,9 @@ +--- +title: InlineAutocompleteEditText.setOnWindowsFocusChangeListener - +--- + +[mozilla.components.ui.autocomplete](../index.html) / [InlineAutocompleteEditText](index.html) / [setOnWindowsFocusChangeListener](./set-on-windows-focus-change-listener.html) + +# setOnWindowsFocusChangeListener + +`fun setOnWindowsFocusChangeListener(l: `[`OnWindowsFocusChangeListener`](../-on-windows-focus-change-listener.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/set-text.md b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/set-text.md new file mode 100644 index 00000000000..85fea0a0b05 --- /dev/null +++ b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/set-text.md @@ -0,0 +1,9 @@ +--- +title: InlineAutocompleteEditText.setText - +--- + +[mozilla.components.ui.autocomplete](../index.html) / [InlineAutocompleteEditText](index.html) / [setText](./set-text.html) + +# setText + +`open fun setText(text: `[`CharSequence`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char-sequence/index.html)`?, type: BufferType): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-on-commit-listener.md b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-on-commit-listener.md new file mode 100644 index 00000000000..131aace6d82 --- /dev/null +++ b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-on-commit-listener.md @@ -0,0 +1,9 @@ +--- +title: OnCommitListener - +--- + +[mozilla.components.ui.autocomplete](index.html) / [OnCommitListener](./-on-commit-listener.html) + +# OnCommitListener + +`typealias OnCommitListener = () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-on-filter-listener.md b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-on-filter-listener.md new file mode 100644 index 00000000000..3c091d70c6f --- /dev/null +++ b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-on-filter-listener.md @@ -0,0 +1,9 @@ +--- +title: OnFilterListener - +--- + +[mozilla.components.ui.autocomplete](index.html) / [OnFilterListener](./-on-filter-listener.html) + +# OnFilterListener + +`typealias OnFilterListener = (`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, `[`InlineAutocompleteEditText`](-inline-autocomplete-edit-text/index.html)`?) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-on-key-pre-ime-listener.md b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-on-key-pre-ime-listener.md new file mode 100644 index 00000000000..8f1920a168a --- /dev/null +++ b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-on-key-pre-ime-listener.md @@ -0,0 +1,9 @@ +--- +title: OnKeyPreImeListener - +--- + +[mozilla.components.ui.autocomplete](index.html) / [OnKeyPreImeListener](./-on-key-pre-ime-listener.html) + +# OnKeyPreImeListener + +`typealias OnKeyPreImeListener = (View, `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, KeyEvent) -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) \ No newline at end of file diff --git a/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-on-search-state-change-listener.md b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-on-search-state-change-listener.md new file mode 100644 index 00000000000..b3e35df8793 --- /dev/null +++ b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-on-search-state-change-listener.md @@ -0,0 +1,9 @@ +--- +title: OnSearchStateChangeListener - +--- + +[mozilla.components.ui.autocomplete](index.html) / [OnSearchStateChangeListener](./-on-search-state-change-listener.html) + +# OnSearchStateChangeListener + +`typealias OnSearchStateChangeListener = (`[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-on-selection-changed-listener.md b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-on-selection-changed-listener.md new file mode 100644 index 00000000000..a842aa32b14 --- /dev/null +++ b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-on-selection-changed-listener.md @@ -0,0 +1,9 @@ +--- +title: OnSelectionChangedListener - +--- + +[mozilla.components.ui.autocomplete](index.html) / [OnSelectionChangedListener](./-on-selection-changed-listener.html) + +# OnSelectionChangedListener + +`typealias OnSelectionChangedListener = (`[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-on-text-change-listener.md b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-on-text-change-listener.md new file mode 100644 index 00000000000..79b520b07d7 --- /dev/null +++ b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-on-text-change-listener.md @@ -0,0 +1,9 @@ +--- +title: OnTextChangeListener - +--- + +[mozilla.components.ui.autocomplete](index.html) / [OnTextChangeListener](./-on-text-change-listener.html) + +# OnTextChangeListener + +`typealias OnTextChangeListener = (`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-on-windows-focus-change-listener.md b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-on-windows-focus-change-listener.md new file mode 100644 index 00000000000..1da0d5da45d --- /dev/null +++ b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-on-windows-focus-change-listener.md @@ -0,0 +1,9 @@ +--- +title: OnWindowsFocusChangeListener - +--- + +[mozilla.components.ui.autocomplete](index.html) / [OnWindowsFocusChangeListener](./-on-windows-focus-change-listener.html) + +# OnWindowsFocusChangeListener + +`typealias OnWindowsFocusChangeListener = (`[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-text-formatter.md b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-text-formatter.md new file mode 100644 index 00000000000..4bcf71a7136 --- /dev/null +++ b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/-text-formatter.md @@ -0,0 +1,9 @@ +--- +title: TextFormatter - +--- + +[mozilla.components.ui.autocomplete](index.html) / [TextFormatter](./-text-formatter.html) + +# TextFormatter + +`typealias TextFormatter = (`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`) -> `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) \ No newline at end of file diff --git a/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/index.md b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/index.md new file mode 100644 index 00000000000..40803d1fa05 --- /dev/null +++ b/docs/api/0.21/ui-autocomplete/mozilla.components.ui.autocomplete/index.md @@ -0,0 +1,23 @@ +--- +title: mozilla.components.ui.autocomplete - +--- + +[mozilla.components.ui.autocomplete](./index.html) + +## Package mozilla.components.ui.autocomplete + +### Types + +| [InlineAutocompleteEditText](-inline-autocomplete-edit-text/index.html) | `open class InlineAutocompleteEditText : AppCompatEditText`
A UI edit text component which supports inline autocompletion. | + +### Type Aliases + +| [OnCommitListener](-on-commit-listener.html) | `typealias OnCommitListener = () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [OnFilterListener](-on-filter-listener.html) | `typealias OnFilterListener = (`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, `[`InlineAutocompleteEditText`](-inline-autocomplete-edit-text/index.html)`?) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [OnKeyPreImeListener](-on-key-pre-ime-listener.html) | `typealias OnKeyPreImeListener = (View, `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, KeyEvent) -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [OnSearchStateChangeListener](-on-search-state-change-listener.html) | `typealias OnSearchStateChangeListener = (`[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [OnSelectionChangedListener](-on-selection-changed-listener.html) | `typealias OnSelectionChangedListener = (`[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [OnTextChangeListener](-on-text-change-listener.html) | `typealias OnTextChangeListener = (`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [OnWindowsFocusChangeListener](-on-windows-focus-change-listener.html) | `typealias OnWindowsFocusChangeListener = (`[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [TextFormatter](-text-formatter.html) | `typealias TextFormatter = (`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`) -> `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + diff --git a/docs/api/0.21/ui-autocomplete/package-list b/docs/api/0.21/ui-autocomplete/package-list new file mode 100644 index 00000000000..e784c2ca3d4 --- /dev/null +++ b/docs/api/0.21/ui-autocomplete/package-list @@ -0,0 +1,4 @@ +$dokka.format:jekyll +$dokka.linkExtension:html + +mozilla.components.ui.autocomplete diff --git a/docs/api/0.21/ui-progress/alltypes/index.md b/docs/api/0.21/ui-progress/alltypes/index.md new file mode 100644 index 00000000000..074a041dcf5 --- /dev/null +++ b/docs/api/0.21/ui-progress/alltypes/index.md @@ -0,0 +1,8 @@ +--- +title: alltypes - +--- + +### All Types + +| [mozilla.components.ui.progress.AnimatedProgressBar](../mozilla.components.ui.progress/-animated-progress-bar/index.html) | An animated progress bar following the Photon Design System. | + diff --git a/docs/api/0.21/ui-progress/index.md b/docs/api/0.21/ui-progress/index.md new file mode 100644 index 00000000000..377980100d2 --- /dev/null +++ b/docs/api/0.21/ui-progress/index.md @@ -0,0 +1,11 @@ +--- +title: +--- + +### Packages + +| [mozilla.components.ui.progress](mozilla.components.ui.progress/index.html) | | + +### Index + +[All Types](alltypes/index.html) \ No newline at end of file diff --git a/docs/api/0.21/ui-progress/mozilla.components.ui.progress/-animated-progress-bar/-init-.md b/docs/api/0.21/ui-progress/mozilla.components.ui.progress/-animated-progress-bar/-init-.md new file mode 100644 index 00000000000..955c67118e8 --- /dev/null +++ b/docs/api/0.21/ui-progress/mozilla.components.ui.progress/-animated-progress-bar/-init-.md @@ -0,0 +1,12 @@ +--- +title: AnimatedProgressBar. - +--- + +[mozilla.components.ui.progress](../index.html) / [AnimatedProgressBar](index.html) / [<init>](./-init-.html) + +# <init> + +`AnimatedProgressBar(context: Context, attrs: AttributeSet? = null, defStyleAttr: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = 0)` + +An animated progress bar following the Photon Design System. + diff --git a/docs/api/0.21/ui-progress/mozilla.components.ui.progress/-animated-progress-bar/index.md b/docs/api/0.21/ui-progress/mozilla.components.ui.progress/-animated-progress-bar/index.md new file mode 100644 index 00000000000..f569701fdb9 --- /dev/null +++ b/docs/api/0.21/ui-progress/mozilla.components.ui.progress/-animated-progress-bar/index.md @@ -0,0 +1,22 @@ +--- +title: AnimatedProgressBar - +--- + +[mozilla.components.ui.progress](../index.html) / [AnimatedProgressBar](./index.html) + +# AnimatedProgressBar + +`class AnimatedProgressBar : ProgressBar` + +An animated progress bar following the Photon Design System. + +### Constructors + +| [<init>](-init-.html) | `AnimatedProgressBar(context: Context, attrs: AttributeSet? = null, defStyleAttr: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = 0)`
An animated progress bar following the Photon Design System. | + +### Functions + +| [onDraw](on-draw.html) | `fun onDraw(canvas: Canvas): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [setProgress](set-progress.html) | `fun setProgress(progress: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Sets the current progress to the specified value. | +| [setVisibility](set-visibility.html) | `fun setVisibility(value: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Set the visibility state of this view. | + diff --git a/docs/api/0.21/ui-progress/mozilla.components.ui.progress/-animated-progress-bar/on-draw.md b/docs/api/0.21/ui-progress/mozilla.components.ui.progress/-animated-progress-bar/on-draw.md new file mode 100644 index 00000000000..f8ca942c3d5 --- /dev/null +++ b/docs/api/0.21/ui-progress/mozilla.components.ui.progress/-animated-progress-bar/on-draw.md @@ -0,0 +1,9 @@ +--- +title: AnimatedProgressBar.onDraw - +--- + +[mozilla.components.ui.progress](../index.html) / [AnimatedProgressBar](index.html) / [onDraw](./on-draw.html) + +# onDraw + +`protected fun onDraw(canvas: Canvas): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/ui-progress/mozilla.components.ui.progress/-animated-progress-bar/set-progress.md b/docs/api/0.21/ui-progress/mozilla.components.ui.progress/-animated-progress-bar/set-progress.md new file mode 100644 index 00000000000..4875a25c689 --- /dev/null +++ b/docs/api/0.21/ui-progress/mozilla.components.ui.progress/-animated-progress-bar/set-progress.md @@ -0,0 +1,12 @@ +--- +title: AnimatedProgressBar.setProgress - +--- + +[mozilla.components.ui.progress](../index.html) / [AnimatedProgressBar](index.html) / [setProgress](./set-progress.html) + +# setProgress + +`fun setProgress(progress: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Sets the current progress to the specified value. + diff --git a/docs/api/0.21/ui-progress/mozilla.components.ui.progress/-animated-progress-bar/set-visibility.md b/docs/api/0.21/ui-progress/mozilla.components.ui.progress/-animated-progress-bar/set-visibility.md new file mode 100644 index 00000000000..ed5635e11a6 --- /dev/null +++ b/docs/api/0.21/ui-progress/mozilla.components.ui.progress/-animated-progress-bar/set-visibility.md @@ -0,0 +1,12 @@ +--- +title: AnimatedProgressBar.setVisibility - +--- + +[mozilla.components.ui.progress](../index.html) / [AnimatedProgressBar](index.html) / [setVisibility](./set-visibility.html) + +# setVisibility + +`fun setVisibility(value: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) + +Set the visibility state of this view. + diff --git a/docs/api/0.21/ui-progress/mozilla.components.ui.progress/index.md b/docs/api/0.21/ui-progress/mozilla.components.ui.progress/index.md new file mode 100644 index 00000000000..a078e0a92a0 --- /dev/null +++ b/docs/api/0.21/ui-progress/mozilla.components.ui.progress/index.md @@ -0,0 +1,12 @@ +--- +title: mozilla.components.ui.progress - +--- + +[mozilla.components.ui.progress](./index.html) + +## Package mozilla.components.ui.progress + +### Types + +| [AnimatedProgressBar](-animated-progress-bar/index.html) | `class AnimatedProgressBar : ProgressBar`
An animated progress bar following the Photon Design System. | + diff --git a/docs/api/0.21/ui-progress/package-list b/docs/api/0.21/ui-progress/package-list new file mode 100644 index 00000000000..9a24dd80eed --- /dev/null +++ b/docs/api/0.21/ui-progress/package-list @@ -0,0 +1,4 @@ +$dokka.format:jekyll +$dokka.linkExtension:html + +mozilla.components.ui.progress diff --git a/docs/api/0.21/ui-tabcounter/alltypes/index.md b/docs/api/0.21/ui-tabcounter/alltypes/index.md new file mode 100644 index 00000000000..489dcb4b981 --- /dev/null +++ b/docs/api/0.21/ui-tabcounter/alltypes/index.md @@ -0,0 +1,8 @@ +--- +title: alltypes - +--- + +### All Types + +| [org.mozilla.components.ui.tabcounter.TabCounter](../org.mozilla.components.ui.tabcounter/-tab-counter/index.html) | | + diff --git a/docs/api/0.21/ui-tabcounter/index.md b/docs/api/0.21/ui-tabcounter/index.md new file mode 100644 index 00000000000..ce9614b1205 --- /dev/null +++ b/docs/api/0.21/ui-tabcounter/index.md @@ -0,0 +1,11 @@ +--- +title: +--- + +### Packages + +| [org.mozilla.components.ui.tabcounter](org.mozilla.components.ui.tabcounter/index.html) | | + +### Index + +[All Types](alltypes/index.html) \ No newline at end of file diff --git a/docs/api/0.21/ui-tabcounter/org.mozilla.components.ui.tabcounter/-tab-counter/-init-.md b/docs/api/0.21/ui-tabcounter/org.mozilla.components.ui.tabcounter/-tab-counter/-init-.md new file mode 100644 index 00000000000..ef98637cc35 --- /dev/null +++ b/docs/api/0.21/ui-tabcounter/org.mozilla.components.ui.tabcounter/-tab-counter/-init-.md @@ -0,0 +1,9 @@ +--- +title: TabCounter. - +--- + +[org.mozilla.components.ui.tabcounter](../index.html) / [TabCounter](index.html) / [<init>](./-init-.html) + +# <init> + +`TabCounter(context: Context, attrs: AttributeSet? = null, defStyle: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = 0)` \ No newline at end of file diff --git a/docs/api/0.21/ui-tabcounter/org.mozilla.components.ui.tabcounter/-tab-counter/get-text.md b/docs/api/0.21/ui-tabcounter/org.mozilla.components.ui.tabcounter/-tab-counter/get-text.md new file mode 100644 index 00000000000..365a84ff413 --- /dev/null +++ b/docs/api/0.21/ui-tabcounter/org.mozilla.components.ui.tabcounter/-tab-counter/get-text.md @@ -0,0 +1,9 @@ +--- +title: TabCounter.getText - +--- + +[org.mozilla.components.ui.tabcounter](../index.html) / [TabCounter](index.html) / [getText](./get-text.html) + +# getText + +`fun getText(): `[`CharSequence`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char-sequence/index.html) \ No newline at end of file diff --git a/docs/api/0.21/ui-tabcounter/org.mozilla.components.ui.tabcounter/-tab-counter/index.md b/docs/api/0.21/ui-tabcounter/org.mozilla.components.ui.tabcounter/-tab-counter/index.md new file mode 100644 index 00000000000..374e4ba6594 --- /dev/null +++ b/docs/api/0.21/ui-tabcounter/org.mozilla.components.ui.tabcounter/-tab-counter/index.md @@ -0,0 +1,20 @@ +--- +title: TabCounter - +--- + +[org.mozilla.components.ui.tabcounter](../index.html) / [TabCounter](./index.html) + +# TabCounter + +`class TabCounter : RelativeLayout` + +### Constructors + +| [<init>](-init-.html) | `TabCounter(context: Context, attrs: AttributeSet? = null, defStyle: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = 0)` | + +### Functions + +| [getText](get-text.html) | `fun getText(): `[`CharSequence`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char-sequence/index.html) | +| [setCount](set-count.html) | `fun setCount(count: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [setCountWithAnimation](set-count-with-animation.html) | `fun setCountWithAnimation(count: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | + diff --git a/docs/api/0.21/ui-tabcounter/org.mozilla.components.ui.tabcounter/-tab-counter/set-count-with-animation.md b/docs/api/0.21/ui-tabcounter/org.mozilla.components.ui.tabcounter/-tab-counter/set-count-with-animation.md new file mode 100644 index 00000000000..4b73c0c92a4 --- /dev/null +++ b/docs/api/0.21/ui-tabcounter/org.mozilla.components.ui.tabcounter/-tab-counter/set-count-with-animation.md @@ -0,0 +1,9 @@ +--- +title: TabCounter.setCountWithAnimation - +--- + +[org.mozilla.components.ui.tabcounter](../index.html) / [TabCounter](index.html) / [setCountWithAnimation](./set-count-with-animation.html) + +# setCountWithAnimation + +`fun setCountWithAnimation(count: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/ui-tabcounter/org.mozilla.components.ui.tabcounter/-tab-counter/set-count.md b/docs/api/0.21/ui-tabcounter/org.mozilla.components.ui.tabcounter/-tab-counter/set-count.md new file mode 100644 index 00000000000..bcdd87f98e0 --- /dev/null +++ b/docs/api/0.21/ui-tabcounter/org.mozilla.components.ui.tabcounter/-tab-counter/set-count.md @@ -0,0 +1,9 @@ +--- +title: TabCounter.setCount - +--- + +[org.mozilla.components.ui.tabcounter](../index.html) / [TabCounter](index.html) / [setCount](./set-count.html) + +# setCount + +`fun setCount(count: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) \ No newline at end of file diff --git a/docs/api/0.21/ui-tabcounter/org.mozilla.components.ui.tabcounter/index.md b/docs/api/0.21/ui-tabcounter/org.mozilla.components.ui.tabcounter/index.md new file mode 100644 index 00000000000..42b5f52b9ee --- /dev/null +++ b/docs/api/0.21/ui-tabcounter/org.mozilla.components.ui.tabcounter/index.md @@ -0,0 +1,12 @@ +--- +title: org.mozilla.components.ui.tabcounter - +--- + +[org.mozilla.components.ui.tabcounter](./index.html) + +## Package org.mozilla.components.ui.tabcounter + +### Types + +| [TabCounter](-tab-counter/index.html) | `class TabCounter : RelativeLayout` | + diff --git a/docs/api/0.21/ui-tabcounter/package-list b/docs/api/0.21/ui-tabcounter/package-list new file mode 100644 index 00000000000..25e656d55be --- /dev/null +++ b/docs/api/0.21/ui-tabcounter/package-list @@ -0,0 +1,4 @@ +$dokka.format:jekyll +$dokka.linkExtension:html + +org.mozilla.components.ui.tabcounter diff --git a/docs/reference.md b/docs/reference.md index ea6f8c3c0f8..8c240717658 100644 --- a/docs/reference.md +++ b/docs/reference.md @@ -5,6 +5,7 @@ permalink: /reference/ --- +## [0.21](../api/0.21/index) ## [0.20](../api/0.20/index) ## [0.19.1](../api/0.19.1/index) ## [0.19](../api/0.19/index)